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

[nop] Misc housekeeping

Browse source
This commit is contained in:
Peter Taoussanis 2024-04-10 19:31:13 +02:00
parent 847781e1e8
commit b56f7c4908
14 changed files with 34 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
project.clj
View file

@ -8,7 +8,7 @@
:url "https://www.eclipse.org/legal/epl-v10.html"}
:dependencies
[[com.taoensso/encore "3.99.0"]]
[[com.taoensso/encore "3.100.0"]]
:test-paths ["test" #_"src"]
@ -44,7 +44,7 @@
[[org.clojure/test.check "1.1.1"]
[org.clojure/tools.logging "1.3.0"]
[org.slf4j/slf4j-api "2.0.12"]
[com.taoensso/slf4j-telemere "1.0.0-alpha2"]
[com.taoensso/slf4j-telemere "1.0.0-alpha4"]
;; [org.slf4j/slf4j-simple "2.0.12"]
;; [org.slf4j/slf4j-nop "2.0.12"]
[io.opentelemetry/opentelemetry-api "1.37.0"]

3
resources/signal-docstrings/error!.txt
View file

@ -24,6 +24,7 @@ Tips:
- `error` arg is a platform error (`java.lang.Throwable` or `js/Error`).
- Can conveniently be wrapped by `throw`: (throw (error! ...)).
[1] See `help:signal-handling` docstring
----------------------------------------
[1] See `help:signal-flow` docstring
[2] See `help:signal-content` docstring
[3] See `help:signal-options` docstring

2
resources/signal-docstrings/event!.txt
View file

@ -29,6 +29,6 @@ Tips:
position, and for `event!` that's the `level-or-opts` arg.
----------------------------------------
[1] See `help:signal-handling` docstring
[1] See `help:signal-flow` docstring
[2] See `help:signal-content` docstring
[3] See `help:signal-options` docstring

2
resources/signal-docstrings/log!.txt
View file

@ -29,6 +29,6 @@ Tips:
- See also `msg-splice`, `msg-skip` utils.
----------------------------------------
[1] See `help:signal-handling` docstring
[1] See `help:signal-flow` docstring
[2] See `help:signal-content` docstring
[3] See `help:signal-options` docstring

2
resources/signal-docstrings/signal!.txt
View file

@ -30,6 +30,6 @@ Tips:
- Supports the same options as other signals [3].
----------------------------------------
[1] See `help:signal-handling` docstring
[1] See `help:signal-flow` docstring
[2] See `help:signal-content` docstring
[3] See `help:signal-options` docstring

2
resources/signal-docstrings/signal-handling.txt → resources/signal-docstrings/signal-flow.txt
View file

@ -11,7 +11,7 @@ For more info:
- On call filters, see: `help:filters` docstring
- On handler filters, see: `help:handlers` docstring
- On signal flow, see: Ref. <https://tinyurl.com/telemere-signal-flowchart>
- On signal flow, see: Ref. <https://www.taoensso.com/telemere/flowchart>
If anything is unclear, please ping me (@ptaoussanis) so that I can
improve these docs!

6
resources/signal-docstrings/signal-formatters.txt Normal file
View file

@ -0,0 +1,6 @@
Common signal formatters include:
(utils/format-signal-str->fn) {<opts>}) ; For human-readable string output (default)
(utils/format-signal->edn-fn) {<opts>}) ; For edn output
(utils/format-signal->json-fn {<opts>}) ; For JSON output
See relevant docstrings for details.

2
resources/signal-docstrings/signal-options.txt
View file

@ -21,7 +21,7 @@ Signal options (shared by `signal!`, `event!`, ...):
`:elidable?` - Should signal call be subject to compile-time elision? (Default: true)
`:sample-rate` - ?rate ∈ℝ[0,1] for call sampling (0.75 => allow 75% of signals, nil => allow all)
`:when` - Arb ?form; when present, form must return truthy to allow signal
`:rate-limit` - ?spec as given to `telemere/rate-limiter`, see its docstring for details
`:rate-limit` - ?spec as given to `taoensso.telemere/rate-limiter`, see its docstring for details
`:middleware` - ?[(fn [signal])=>modified-signal ...] call middleware
`:trace?` - Should tracing be enabled for `:run` form?

2
resources/signal-docstrings/spy!.txt
View file

@ -34,6 +34,6 @@ Tips:
(catch->error! ::error-id (spy! ...)).
----------------------------------------
[1] See `help:signal-handling` docstring
[1] See `help:signal-flow` docstring
[2] See `help:signal-content` docstring
[3] See `help:signal-options` docstring

2
resources/signal-docstrings/trace!.txt
View file

@ -38,6 +38,6 @@ Tips:
common logging level of the same name.
----------------------------------------
[1] See `help:signal-handling` docstring
[1] See `help:signal-flow` docstring
[2] See `help:signal-content` docstring
[3] See `help:signal-options` docstring

2
shadow-cljs.edn
View file

@ -1,7 +1,7 @@
{;;:lein true
:source-paths ["src" "test"]
:dependencies
[[com.taoensso/encore "3.98.0-SNAPSHOT"]
[[com.taoensso/encore "3.100.0"]
[cider/cider-nrepl "0.47.0"]
[binaryage/devtools "1.0.7"]]

23
src/taoensso/telemere.cljc
View file

@ -33,7 +33,7 @@
(remove-ns 'taoensso.telemere)
(:api (enc/interns-overview)))
(enc/assert-min-encore-version [3 99 0])
(enc/assert-min-encore-version [3 100 0])
;;;; TODO
;; - Review, TODOs, missing docstrings
@ -48,8 +48,9 @@
(sigs/def-api
{:purpose "signal"
:sf-arity 4
:*sig-handlers* impl/*sig-handlers*
:*rt-sig-filter* impl/*rt-sig-filter*})
:ct-sig-filter impl/ct-sig-filter
:*rt-sig-filter* impl/*rt-sig-filter*
:*sig-handlers* impl/*sig-handlers*})
(comment
[level-aliases
@ -81,9 +82,12 @@
(comment help:filters help:handlers) ; Via Encore
(impl/defhelp help:signal-handling :signal-handling)
(impl/defhelp help:signal-content :signal-content)
(impl/defhelp help:signal-options :signal-options)
(impl/defhelp help:signal-content :signal-content)
(impl/defhelp help:signal-flow :signal-flow)
(impl/defhelp help:signal-formatters :signal-formatters)
(enc/defalias help:signal-filters help:filters)
(enc/defalias help:signal-handlers help:handlers)
;;;; Context
@ -374,15 +378,6 @@
;;;; Handlers
(enc/def* help:signal-formatters
"Common signal formatters include:
(utils/format-signal-str->fn) {<opts>}) ; For human-readable string output (default)
(utils/format-signal->edn-fn) {<opts>}) ; For edn output
(utils/format-signal->json-fn {<opts>}) ; For JSON output
See relevant docstrings for details."
"See docstring")
(enc/defaliases
#?(:default handlers:console/handler:console)
#?(:cljs handlers:console/handler:console-raw)

4
src/taoensso/telemere/handlers/open_telemetry.clj
View file

@ -35,7 +35,7 @@
(def ^String attr-name
"Returns cached OpenTelemetry-style name: `:foo/bar-baz` -> \"foo_bar_baz\", etc.
Ref. <https://opentelemetry.io/docs/specs/semconv/general/attribute-naming/>"
Ref. <https://opentelemetry.io/docs/specs/semconv/general/attribute-naming/>."
(enc/fmemoize
(fn
([prefix x] (str (attr-name prefix) "." (attr-name x))) ; For `merge-prefix-map`, etc.
@ -104,7 +104,7 @@
(comment (merge-prefix-map {} "data" {:a/b1 "v1" :a/b2 "v2" :nil nil}))
(defn signal->attrs-map
"Returns attributes map for given signal.
"Returns attributes map for given signal,
Ref. <https://opentelemetry.io/docs/specs/otel/logs/data-model/>."
[extra-attrs-key signal]
(let [attrs-map

4
src/taoensso/telemere/impl.cljc
View file

@ -535,7 +535,7 @@
:macro-env &env
:sf-arity 4
:ct-sig-filter ct-sig-filter
:rt-sig-filter `*rt-sig-filter*}
:*rt-sig-filter* `*rt-sig-filter*}
opts)]
(if elide?
@ -664,7 +664,7 @@
:macro-env &env
:sf-arity 4
:ct-sig-filter ct-sig-filter
:rt-sig-filter `*rt-sig-filter*}
:*rt-sig-filter* `*rt-sig-filter*}
opts)]
(and (not elide?) allow?))))