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

[doc] [#42] Timbre shim: document different spy error handling

Browse source
This commit is contained in:
Peter Taoussanis 2024-12-31 09:45:16 +01:00
parent 3a9ffc6206
commit 1517f30abf
1 changed files with 15 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
projects/main/src/taoensso/telemere/timbre.cljc
View file

@ -99,7 +99,21 @@
#?(:clj
(defmacro spy
"Prefer `telemere/spy!`."
"Prefer `telemere/spy!`.
Note that for extra flexibility and improved interop with Open Telemetry,
this shim intentionally handles errors (forms that throw) slightly differently
to Timbre's original `spy`:
When the given `form` throws, this shim may create an ADDITIONAL signal of
`:error` kind and level. The behaviour is equivalent to:
(telemere/spy! level ; Creates 0/1 `:spy` signals with given/default (`:debug`) level
(telemere/catch->error! form)) ; Creates 0/1 `:error` signals with `:error` level
The additional signal helps to separate the success and error cases for
individual filtering and/or handling."
([ form] (enc/keep-callsite `(spy :debug nil ~form)))
([level form] (enc/keep-callsite `(spy ~level nil ~form)))
([level form-name form]