luciano/telemere
1
0
Fork 0
mirror of https://github.com/taoensso/telemere.git synced 2025-12-17 01:51:10 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

[fix] Fix environment val docs

Browse source
This commit is contained in:
Peter Taoussanis 2025-01-13 23:25:58 +01:00
parent 413cce87c3
commit db26a5d683
3 changed files with 23 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
projects/main/resources/signal-docstrings/environmental-config.txt
View file

@ -4,24 +4,24 @@ environment variables, or classpath resources.
Environmental filter config includes: Environmental filter config includes:
Kind filter: Kind filter:
JVM property: `taoensso.telemere.rt-kind-filter` 1. JVM property: `taoensso.telemere.rt-kind-filter`
Env variable: `TAOENSSO_TELEMERE_RT_KIND_FILTER` 2. Env variable: `TAOENSSO_TELEMERE_RT_KIND_FILTER`
Classpath resource: `taoensso.telemere.rt-kind-filter` 3. Classpath resource: `taoensso.telemere.rt-kind-filter`
Namespace filter: Namespace filter:
JVM property: `taoensso.telemere.rt-ns-filter` 1. JVM property: `taoensso.telemere.rt-ns-filter`
Env variable: `TAOENSSO_TELEMERE_RT_NS_FILTER` 2. Env variable: `TAOENSSO_TELEMERE_RT_NS_FILTER`
Classpath resource: `taoensso.telemere.rt-ns-filter` 3. Classpath resource: `taoensso.telemere.rt-ns-filter`
Id filter: Id filter:
JVM property: `taoensso.telemere.rt-id-filter` 1. JVM property: `taoensso.telemere.rt-id-filter`
Env variable: `TAOENSSO_TELEMERE_RT_ID_FILTER` 2. Env variable: `TAOENSSO_TELEMERE_RT_ID_FILTER`
Classpath resource: `taoensso.telemere.rt-id-filter` 3. Classpath resource: `taoensso.telemere.rt-id-filter`
Minimum level: Minimum level:
JVM property: `taoensso.telemere.rt-min-level` 1. JVM property: `taoensso.telemere.rt-min-level`
Env variable: `TAOENSSO_TELEMERE_RT_MIN_LEVEL` 2. Env variable: `TAOENSSO_TELEMERE_RT_MIN_LEVEL`
Classpath resource: `taoensso.telemere.rt-min-level` 3. Classpath resource: `taoensso.telemere.rt-min-level`
Values are edn, examples: Values are edn, examples:
@ -39,10 +39,8 @@ Tips:
- The above ids will affect both Clj AND Cljs. - The above ids will affect both Clj AND Cljs.
For platform-specific filters, use For platform-specific filters, use
".clj.edn" / "_CLJ_EDN" or ".clj" / "_CLJ" or
".cljs.edn" / "_CLJS_EDN" suffixes instead. ".cljs" / "_CLJS" suffixes instead.
- Optional ".edn" / "_EDN" suffixes may be added for clarity.
- To get the right edn syntax, first set your runtime filters using the - To get the right edn syntax, first set your runtime filters using the
standard utils (`set-min-level!`, etc.). Then call `get-filters` and standard utils (`set-min-level!`, etc.). Then call `get-filters` and

12
projects/main/src/taoensso/telemere.cljc
View file

@ -95,9 +95,9 @@
more entropy and so are usually longer (e.g. 32 vs 16 hex chars). more entropy and so are usually longer (e.g. 32 vs 16 hex chars).
Override default by setting one of the following: Override default by setting one of the following:
JVM property: `taoensso.telemere/uid-fn` 1. JVM property: `taoensso.telemere.uid-kind`
Env variable: `TAOENSSO_TELEMERE_UID_FN` 2. Env variable: `TAOENSSO_TELEMERE_UID_KIND`
Classpath resource: `taoensso.telemere/uid-fn` 3. Classpath resource: `taoensso.telemere.uid-kind`
Possible (compile-time) values include: Possible (compile-time) values include:
`:uuid` - UUID string (Cljs) or `java.util.UUID` (Clj) `:uuid` - UUID string (Cljs) or `java.util.UUID` (Clj)
@ -133,9 +133,9 @@
2. Telemere and OpenTelemetry WILL recognize each other's spans. 2. Telemere and OpenTelemetry WILL recognize each other's spans.
Override default by setting one of the following to \"true\" or \"false\": Override default by setting one of the following to \"true\" or \"false\":
JVM property: `taoensso.telemere.otel-tracing` 1. JVM property: `taoensso.telemere.otel-tracing`
Env variable: `TAOENSSO_TELEMERE_otel-tracing` 2. Env variable: `TAOENSSO_TELEMERE_OTEL_TRACING`
Classpath resource: `taoensso.telemere.otel-tracing` 3. Classpath resource: `taoensso.telemere.otel-tracing`
See also: `otel-default-providers_`, `*otel-tracer*`, See also: `otel-default-providers_`, `*otel-tracer*`,
`taoensso.telemere.open-telemere/handler:open-telemetry`. `taoensso.telemere.open-telemere/handler:open-telemetry`.

6
projects/main/src/taoensso/telemere/tools_logging.clj
View file

@ -45,9 +45,9 @@
implementation (backend). implementation (backend).
Called automatically if one of the following is \"true\": Called automatically if one of the following is \"true\":
JVM property: `clojure.tools.logging.to-telemere` 1. JVM property: `clojure.tools.logging.to-telemere`
Env variable: `CLOJURE_TOOLS_LOGGING_TO_TELEMERE` 2. Env variable: `CLOJURE_TOOLS_LOGGING_TO_TELEMERE`
Classpath resource: `clojure.tools.logging.to-telemere`" 3. Classpath resource: `clojure.tools.logging.to-telemere`"
[] []
(impl/signal! (impl/signal!
{:kind :event {:kind :event