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

[doc] Drop suggested edn suffixes from env config

Browse source
This commit is contained in:
Peter Taoussanis 2024-09-06 22:41:57 +02:00
parent e4a0a41a1b
commit 974df3e152
1 changed files with 21 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -4,31 +4,31 @@ environment variables, or classpath resources.
Environmental filter config includes: Environmental filter config includes:
Kind filter: Kind filter:
JVM property: `taoensso.telemere.rt-kind-filter.edn` JVM property: `taoensso.telemere.rt-kind-filter`
Env variable: `TAOENSSO_TELEMERE_RT_KIND_FILTER_EDN` Env variable: `TAOENSSO_TELEMERE_RT_KIND_FILTER`
Classpath resource: `taoensso.telemere.rt-kind-filter.edn` Classpath resource: `taoensso.telemere.rt-kind-filter`
Namespace filter: Namespace filter:
JVM property: `taoensso.telemere.rt-ns-filter.edn` JVM property: `taoensso.telemere.rt-ns-filter`
Env variable: `TAOENSSO_TELEMERE_RT_NS_FILTER_EDN` Env variable: `TAOENSSO_TELEMERE_RT_NS_FILTER`
Classpath resource: `taoensso.telemere.rt-ns-filter.edn` Classpath resource: `taoensso.telemere.rt-ns-filter`
Id filter: Id filter:
JVM property: `taoensso.telemere.rt-id-filter.edn` JVM property: `taoensso.telemere.rt-id-filter`
Env variable: `TAOENSSO_TELEMERE_RT_ID_FILTER_EDN` Env variable: `TAOENSSO_TELEMERE_RT_ID_FILTER`
Classpath resource: `taoensso.telemere.rt-id-filter.edn` Classpath resource: `taoensso.telemere.rt-id-filter`
Minimum level: Minimum level:
JVM property: `taoensso.telemere.rt-min-level.edn` JVM property: `taoensso.telemere.rt-min-level`
Env variable: `TAOENSSO_TELEMERE_RT_MIN_LEVEL_EDN` Env variable: `TAOENSSO_TELEMERE_RT_MIN_LEVEL`
Classpath resource: `taoensso.telemere.rt-min-level.edn` Classpath resource: `taoensso.telemere.rt-min-level`
Examples: Values are edn, examples:
`taoensso.telemere.rt-min-level.edn` -> ":info" `taoensso.telemere.rt-min-level` -> ":info"
`TAOENSSO_TELEMERE_RT_NS_FILTER_EDN` -> "{:disallow \"taoensso.*\"}" `TAOENSSO_TELEMERE_RT_NS_FILTER` -> "{:disallow \"taoensso.*\"}"
`taoensso.telemere.rt-id-filter.cljs.edn` -> "#{:my-id1 :my-id2}" `taoensso.telemere.rt-id-filter.cljs` -> "#{:my-id1 :my-id2}"
`TAOENSSO_TELEMERE_RT_KIND_FILTER_CLJ_EDN` -> "nil" `TAOENSSO_TELEMERE_RT_KIND_FILTER_CLJ` -> "nil"
For other (non-filter) environmental config, see the relevant docstrings. For other (non-filter) environmental config, see the relevant docstrings.
@ -42,12 +42,11 @@ Tips:
".clj.edn" / "_CLJ_EDN" or ".clj.edn" / "_CLJ_EDN" or
".cljs.edn" / "_CLJS_EDN" suffixes instead. ".cljs.edn" / "_CLJS_EDN" suffixes instead.
- ".edn" / "_EDN" suffixes are optional. - Optional ".edn" / "_EDN" suffixes may be added for clarity.
- Config values should be edn. To get the right syntax, first set - To get the right edn syntax, first set your runtime filters using the
your runtime filters using the standard utils (`set-min-level!`, standard utils (`set-min-level!`, etc.). Then call `get-filters` and
etc.). Then call `get-filters` and serialize the relevant parts serialize the relevant parts to edn with `pr-str`.
to edn with `pr-str`.
- All environmental config uses `get-env` underneath. - All environmental config uses `get-env` underneath.
See the `get-env` docstring for more/advanced details. See the `get-env` docstring for more/advanced details.