[fix] Fix environment val docs

taoensso · Jan 13, 2025 · db26a5d · db26a5d
1 parent 413cce8
commit db26a5d
Show file tree

Hide file tree

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

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

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