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

[mod] Rename signal field: :extra-kvs -> :kvs

Browse source
This commit is contained in:
Peter Taoussanis 2024-04-10 19:34:22 +02:00
parent b56f7c4908
commit 5f98e7304f
6 changed files with 27 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -29,7 +29,7 @@ Default keys:
`:sample-rate` - ?rate ∈ℝ[0,1] for combined call AND handler sampling (0.75 => allow 75% of signals, nil => allow all)
<extra-kvs> - Arb user-level ?kvs given to signal call
<kvs> - Arb other user-level ?kvs given to signal call
If anything is unclear, please ping me (@ptaoussanis) so that I can improve these docs!

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

@ -25,7 +25,7 @@ Signal options (shared by `signal!`, `event!`, ...):
`:middleware` - ?[(fn [signal])=>modified-signal ...] call middleware
`:trace?` - Should tracing be enabled for `:run` form?
<extra-kvs> - Arb user-level ?kvs to incl. in signal
<kvs> - Arb other user-level ?kvs to incl. in signal
If anything is unclear, please ping me (@ptaoussanis) so that I can improve these docs!

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

@ -143,22 +143,22 @@
"exception.stacktrace" (when trace (#'utils/format-clj-stacktrace trace)))
"exception.data" data))
extra-kvs (get signal :extra-kvs)
kvs (get signal :kvs)
attr-kvs
(when extra-attrs-key
(when-let [kvs (get signal extra-attrs-key)]
(not-empty kvs)))
extra-kvs
kvs
(if attr-kvs
(dissoc extra-kvs extra-attrs-key)
(do extra-kvs))
(dissoc kvs extra-attrs-key)
(do kvs))
attrs-map
(-> attrs-map
(merge-prefix-map "ctx" (get signal :ctx))
(merge-prefix-map "data" (get signal :data))
(merge-prefix-map "kvs" (get signal :extra-kvs))
(merge-prefix-map "kvs" (get signal :kvs))
(enc/fast-merge attr-kvs) ; Unprefixed, undocumented
)]

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

@ -213,7 +213,7 @@
location ns line column file,
sample-rate, kind id level, ctx parent,
data msg_ error run-form run-val,
end-inst run-nsecs extra-kvs]
end-inst run-nsecs kvs]
Object (toString [sig] (str "#" `Signal (into {} sig))))
@ -348,7 +348,7 @@
[inst uid,
location ns line column file,
sample-rate, kind id level, ctx parent,
extra-kvs data msg_,
kvs data msg_,
run-form run-result error]
(let [signal
@ -370,15 +370,15 @@
sample-rate, kind id level, ctx parent,
data msg_,
run-err run-form run-val,
end-inst run-nsecs extra-kvs))
end-inst run-nsecs kvs))
(Signal. 1 inst uid,
location ns line column file,
sample-rate, kind id level, ctx parent,
data msg_, error nil nil nil nil extra-kvs))]
data msg_, error nil nil nil nil kvs))]
(if extra-kvs
(reduce-kv assoc signal extra-kvs)
(if kvs
(reduce-kv assoc signal kvs)
(do signal))))
(comment
@ -401,7 +401,7 @@
[#_defaults #_elide? #_allow? #_expansion-id, ; Undocumented
elidable? location inst uid middleware,
sample-rate kind ns id level when rate-limit,
ctx parent trace?, do let data msg error run & extra-kvs]}])
ctx parent trace?, do let data msg error run & kvs]}])
:event! ; [id] [id level-or-opts] => allowed?
'([id ]
@ -411,7 +411,7 @@
[#_defaults #_elide? #_allow? #_expansion-id,
elidable? location inst uid middleware,
sample-rate kind ns id level when rate-limit,
ctx parent trace?, do let data msg error #_run & extra-kvs]}])
ctx parent trace?, do let data msg error #_run & kvs]}])
:log! ; [msg] [level-or-opts msg] => allowed?
'([ msg]
@ -420,7 +420,7 @@
[#_defaults #_elide? #_allow? #_expansion-id,
elidable? location inst uid middleware,
sample-rate kind ns id level when rate-limit,
ctx parent trace?, do let data msg error #_run & extra-kvs]}
ctx parent trace?, do let data msg error #_run & kvs]}
msg])
:error! ; [error] [id-or-opts error] => given error
@ -430,7 +430,7 @@
[#_defaults #_elide? #_allow? #_expansion-id,
elidable? location inst uid middleware,
sample-rate kind ns id level when rate-limit,
ctx parent trace?, do let data msg error #_run & extra-kvs]}
ctx parent trace?, do let data msg error #_run & kvs]}
error])
(:trace! :spy!) ; [form] [id-or-opts form] => run result (value or throw)
@ -440,7 +440,7 @@
[#_defaults #_elide? #_allow? #_expansion-id,
elidable? location inst uid middleware,
sample-rate kind ns id level when rate-limit,
ctx parent trace?, do let data msg error run & extra-kvs]}
ctx parent trace?, do let data msg error run & kvs]}
form])
:catch->error! ; [form] [id-or-opts form] => run result (value or throw)
@ -450,7 +450,7 @@
[#_defaults #_elide? #_allow? #_expansion-id, rethrow? catch-val,
elidable? location inst uid middleware,
sample-rate kind ns id level when rate-limit,
ctx parent trace?, do let data msg error #_run & extra-kvs]}
ctx parent trace?, do let data msg error #_run & kvs]}
form])
:uncaught->error! ; [] [id-or-opts] => nil
@ -460,7 +460,7 @@
[#_defaults #_elide? #_allow? #_expansion-id,
elidable? location inst uid middleware,
sample-rate kind ns id level when rate-limit,
ctx parent trace?, do let data msg error #_run & extra-kvs]}])
ctx parent trace?, do let data msg error #_run & kvs]}])
(enc/unexpected-arg! macro-id))))
@ -572,7 +572,7 @@
ctx-form (get opts :ctx `taoensso.telemere/*ctx*)
parent-form (get opts :parent (when trace? `taoensso.telemere.impl/*trace-parent*))
extra-kvs-form
kvs-form
(not-empty
(dissoc opts
:elidable? :location :inst :uid :middleware,
@ -595,7 +595,7 @@
(new-signal ~'__inst ~'__uid
~location ~'__ns ~line-form ~column-form ~file-form,
~sample-rate-form, ~'__kind ~'__id ~'__level, ~ctx-form ~parent-form,
~extra-kvs-form ~data-form ~msg-form,
~kvs-form ~data-form ~msg-form,
'~run-form ~'__run-result ~error-form))))
run-fn-form (when run-form `(fn [] (~run-form)))]

8
src/taoensso/telemere/utils.cljc
View file

@ -127,7 +127,7 @@
"Experimental, subject to change.
Returns minimal signal map, removing:
- Keys with nil values, and
- Keys with redundant values (`:extra-kvs`, `:location`, `:file`).
- Keys with redundant values (`:kvs`, `:location`, `:file`).
Useful when serializing signals to edn/JSON/etc."
[signal]
@ -136,7 +136,7 @@
(if (nil? v)
m
(case k
(:extra-kvs :location :file) m
(:kvs :location :file) m
(assoc m k v))))
nil signal))
@ -355,12 +355,12 @@
err-stop (str newline ">>> error >>>")]
(fn a-signal-content-handler [signal hf vf]
(let [{:keys [uid parent data extra-kvs ctx sample-rate]} signal]
(let [{:keys [uid parent data kvs ctx sample-rate]} signal]
(when sample-rate (hf "sample: " (vf sample-rate)))
(when uid (hf " uid: " (vf uid)))
(when parent (hf "parent: " (vf parent)))
(when data (hf " data: " (vf data)))
(when extra-kvs (hf " kvs: " (vf extra-kvs)))
(when kvs (hf " kvs: " (vf kvs)))
(when ctx (hf " ctx: " (vf ctx))))
(let [{:keys [run-form error]} signal]

2
test/taoensso/telemere_tests.cljc
View file

@ -118,7 +118,7 @@
(testing "Support arb extra user kvs"
(let [sv (with-sig (sig! {:level :info, :my-k1 "v1", :my-k2 "v2"}))]
(is (sm? sv {:level :info, :my-k1 "v1", :my-k2 "v2"
:extra-kvs {:my-k1 "v1", :my-k2 "v2"}}))))
:kvs {:my-k1 "v1", :my-k2 "v2"}}))))
(testing "`:msg` basics"
(let [c (enc/counter)