mirror of
https://github.com/taoensso/telemere.git
synced 2025-12-16 17:41:12 +00:00
Compare commits
12 commits
3ea81df34f
...
e95937401d
| Author | SHA1 | Date | |
|---|---|---|---|
|
e95937401d | ||
|
|
13d16d9378 | ||
|
|
3366b2b040 | ||
|
|
61f3dd7287 | ||
|
|
cc680b06f5 | ||
|
|
47af80319d | ||
|
|
b56e1c4529 | ||
|
|
8a3ae14f45 | ||
|
|
917b1b408e | ||
|
|
125e006753 | ||
|
|
f7006f31fe | ||
|
|
c6a71652d7 |
12 changed files with 136 additions and 117 deletions
|
|
@ -1,6 +1,7 @@
|
|||
This project uses [**Break Versioning**](https://www.taoensso.com/break-versioning).
|
||||
|
||||
---
|
||||
|
||||
# `v1.1.0` (2025-08-22)
|
||||
|
||||
## 📦 Dependencies
|
||||
|
|
@ -12,6 +13,8 @@ Available on Clojars:
|
|||
|
||||
This project uses [Break Versioning](https://www.taoensso.com/break-versioning).
|
||||
|
||||
## Release notes
|
||||
|
||||
This is a **maintenance release** that fixes a few minor issues, improves docs, and adds some extra API flexibility. It should be a safe upgrade for all users of v1.x.
|
||||
|
||||
Please **report any unexpected problems** on [GitHub](https://github.com/taoensso/telemere/issues) or the [Slack channel](https://www.taoensso.com/telemere/slack) 🙏 - [Peter Taoussanis](https://www.taoensso.com)
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<a href="https://www.taoensso.com/clojure" title="More stuff by @ptaoussanis at www.taoensso.com"><img src="https://www.taoensso.com/open-source.png" alt="Taoensso open source" width="340"/></a>
|
||||
[**API**][cljdoc] | [**Wiki**][GitHub wiki] | [Slack channel][] | Latest release: [v1.1.0](../../releases/tag/v1.1.0) (2025-08-22)
|
||||
[**API**][cljdoc] | [**Wiki**][GitHub wiki] | [Slack][] | Latest release: [v1.1.0](../../releases/tag/v1.1.0) (2025-08-22)
|
||||
|
||||
[![Clj tests][Clj tests SVG]][Clj tests URL]
|
||||
[![Cljs tests][Cljs tests SVG]][Cljs tests URL]
|
||||
|
|
@ -314,7 +314,7 @@ See [here](../../wiki/8-Community) for community resources.
|
|||
- [Wiki][GitHub wiki] (getting started, usage, etc.)
|
||||
- API reference via [cljdoc][cljdoc]
|
||||
- Extensive [internal help](#internal-help) (no need to leave your IDE)
|
||||
- Support via [Slack channel][] or [GitHub issues][]
|
||||
- Support via [Slack][] or [GitHub issues][]
|
||||
- [General observability tips](../../wiki/7-Tips) (advice on building and maintaining observable Clojure/Script systems, and getting the most out of Telemere)
|
||||
|
||||
## Funding
|
||||
|
|
@ -331,7 +331,7 @@ Licensed under [EPL 1.0](LICENSE.txt) (same as Clojure).
|
|||
[GitHub releases]: ../../releases
|
||||
[GitHub issues]: ../../issues
|
||||
[GitHub wiki]: ../../wiki
|
||||
[Slack channel]: https://www.taoensso.com/telemere/slack
|
||||
[Slack]: https://www.taoensso.com/telemere/slack
|
||||
|
||||
[Peter Taoussanis]: https://www.taoensso.com
|
||||
[sponsor]: https://www.taoensso.com/sponsor
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
Before Width: | Height: | Size: 384 KiB After Width: | Height: | Size: 340 KiB |
Binary file not shown.
|
|
@ -1,4 +1,4 @@
|
|||
(defproject com.taoensso/telemere "1.1.0"
|
||||
(defproject com.taoensso/telemere "1.2.0-SNAPSHOT"
|
||||
:author "Peter Taoussanis <https://www.taoensso.com>"
|
||||
:description "Structured logs and telemetry for Clojure/Script"
|
||||
:url "https://www.taoensso.com/telemere"
|
||||
|
|
@ -50,7 +50,7 @@
|
|||
[org.clojure/test.check "1.1.1"]
|
||||
[org.clojure/tools.logging "1.3.0"]
|
||||
[org.slf4j/slf4j-api "2.0.17"]
|
||||
[com.taoensso/telemere-slf4j "1.1.0"]
|
||||
[com.taoensso/telemere-slf4j "1.2.0-SNAPSHOT"]
|
||||
#_[org.slf4j/slf4j-simple "2.0.16"]
|
||||
#_[org.slf4j/slf4j-nop "2.0.16"]
|
||||
#_[io.github.paintparty/bling "0.4.2"]
|
||||
|
|
|
|||
|
|
@ -9,12 +9,12 @@ All options are available for all signal creator calls:
|
|||
Defaults to `:auto` for tracing signals, and nil otherwise
|
||||
|
||||
`:msg` --------- Arb app-level ?message to incl. in signal: str or vec of strs to join (with `\space`), may be a delay
|
||||
`:data` -------- Arb app-level ?data to incl. in signal: usu. a map
|
||||
`:data` -------- Arb app-level ?data to incl. in signal: usu. a map, LAZY! [3]
|
||||
`:error` ------- Arb app-level ?error to incl. in signal: platform error [2]
|
||||
|
||||
`:run` --------- ?form to execute UNCONDITIONALLY; will incl. `:run-val` in signal
|
||||
`:do` ---------- ?form to execute conditionally (iff signal allowed), before establishing `:let` ?binding
|
||||
`:let` --------- ?bindings to establish conditionally (iff signal allowed), BEFORE evaluating `:data` and `:msg` (useful!)
|
||||
`:do` ---------- ?form to execute conditionally (iff signal allowed) and LAZILY [3], before establishing `:let` ?binding
|
||||
`:let` --------- ?bindings to establish conditionally (iff signal allowed) and LAZILY [3], BEFORE evaluating `:data` and `:msg` (useful!)
|
||||
|
||||
`:parent` ------ Custom ?{:keys [id uid]} to override auto (dynamic) parent signal tracing info
|
||||
`:root` -------- Custom ?{:keys [id uid]} to override auto (dynamic) root signal tracing info
|
||||
|
|
@ -26,7 +26,7 @@ All options are available for all signal creator calls:
|
|||
|
||||
`:elidable?` --- Should signal be subject to compile-time elision? (default true)
|
||||
`:allow?` ------ Custom override for usual runtime filtering (true => ALWAYS create signal)
|
||||
`:trace?` ------ Should tracing be enabled for `:run` form?
|
||||
`:trace?` ------ Should tracing be enabled for this signal? (default true iff `:run` provided or OpenTelemetry tracing enabled)
|
||||
|
||||
`:sample` ------ Sample ?rate ∈ℝ[0,1] for random signal sampling (0.75 => allow 75% of signals, nil => allow all)
|
||||
`:when` -------- Arb ?form; when present, form must return truthy to allow signal
|
||||
|
|
@ -37,9 +37,13 @@ All options are available for all signal creator calls:
|
|||
|
||||
<kvs> ---------- Other arb app-level ?kvs to incl. in signal. Typically NOT included in
|
||||
handler output, so a great way to provide custom data/opts for use
|
||||
(only) by custom transforms/handlers.
|
||||
(only) by custom transforms/handlers. LAZY! [3]
|
||||
|
||||
If anything is unclear, please ping me (@ptaoussanis) so that I can improve these docs!
|
||||
|
||||
[1] `java.time.Instant` or `js/Date`
|
||||
[2] `java.lang.Throwable` or `js/Error`
|
||||
[3] Most Telemere signal content is evaluated CONDITIONALLY (iff signal allowed),
|
||||
LAZILY (when signal is created), and on the HANDLING THREAD (not logging thread).
|
||||
This allows efficient filtering, better control+monitoring of back pressure,
|
||||
conditional effects, etc. Ref. <https://www.taoensso.com/telemere/flow> for visual!
|
||||
|
|
|
|||
|
|
@ -38,7 +38,10 @@
|
|||
(def enabled:otel-tracing?
|
||||
"Documented at `taoensso.telemere/otel-tracing?`."
|
||||
(enc/get-env {:as :bool, :default present:otel?}
|
||||
:taoensso.telemere/otel-tracing<.platform>))))
|
||||
:taoensso.telemere/otel-tracing<.platform>))
|
||||
|
||||
(def enabled:incl-host-info? "Include `:host` info in signals by default?" (enc/get-env {:as :bool, :default true} :taoensso.telemere/incl-host-info))
|
||||
(def enabled:incl-thread-info? "Include `:thread` info in signals by default?" (enc/get-env {:as :bool, :default true} :taoensso.telemere/incl-thread-info))))
|
||||
|
||||
(def uid-kind
|
||||
"Documented at `taoensso.telemere/*uid-fn*`."
|
||||
|
|
@ -170,8 +173,8 @@
|
|||
(defn default-trace-msg
|
||||
[form value error nsecs]
|
||||
(if error
|
||||
(str form " !> " (truss/ex-type error))
|
||||
(str form " => " value)))
|
||||
(str (if (nil? form) "nil" form) " !> " (truss/ex-type error))
|
||||
(str (if (nil? form) "nil" form) " => " (if (nil? value) "nil" value))))
|
||||
|
||||
(comment
|
||||
(default-trace-msg "(+ 1 2)" 3 nil 12345)
|
||||
|
|
@ -524,14 +527,16 @@
|
|||
clj? (not cljs?)
|
||||
|
||||
opts (merge {:kind :generic, :level :info} base-opts opts)
|
||||
{run-form :run} opts
|
||||
|
||||
run-form? (contains? opts :run)
|
||||
run-form (get opts :run)
|
||||
|
||||
ns-form* (get opts :ns :auto)
|
||||
ns-form (auto-> ns-form* (str *ns*))
|
||||
|
||||
show-run-val (get opts :run-val '_run-val)
|
||||
show-run-form
|
||||
(when run-form
|
||||
(when run-form?
|
||||
(get opts :run-form
|
||||
(if (and
|
||||
(enc/list-form? run-form)
|
||||
|
|
@ -564,16 +569,19 @@
|
|||
id-form :id
|
||||
level-form :level} opts
|
||||
|
||||
trace? (get opts :trace? (boolean run-form))
|
||||
otel? (get opts :otel? (and clj? present:otel?)) ; Undocumented
|
||||
otel-tracing? (and otel? enabled:otel-tracing?)
|
||||
|
||||
trace? (get opts :trace? (or run-form? otel-tracing?))
|
||||
_
|
||||
(when-not (contains? #{true false nil} trace?)
|
||||
(truss/ex-info!
|
||||
(str "Signal needs compile-time `:trace?` value at "
|
||||
(sigs/format-callsite ns-form coords))))
|
||||
|
||||
host-form (auto-> (get opts :host :auto) (when clj? `(enc/host-info)))
|
||||
thread-form (auto-> (get opts :thread :auto) (when clj? `(enc/thread-info)))
|
||||
inst-form (auto-> (get opts :inst :auto) `(enc/now-inst*))
|
||||
host-form (auto-> (get opts :host :auto) (when (and clj? enabled:incl-host-info?) `(enc/host-info)))
|
||||
thread-form (auto-> (get opts :thread :auto) (when (and clj? enabled:incl-thread-info?) `(enc/thread-info)))
|
||||
inst-form (auto-> (get opts :inst :auto) `(enc/now-inst*))
|
||||
|
||||
parent-form (get opts :parent `*trace-parent*)
|
||||
root-form0 (get opts :root `*trace-root*)
|
||||
|
|
@ -607,9 +615,9 @@
|
|||
(dissoc opts
|
||||
:elidable? :coords :inst :uid :xfn :xfn+ :kvs+,
|
||||
:sample :ns :kind :id :level :filter :when #_:limit #_:limit-by,
|
||||
:ctx :ctx+ :parent #_:trace?, :do :let :data :msg :error,
|
||||
:ctx :ctx+ :parent :trace?, :do :let :data :msg :error,
|
||||
:run :run-form :run-val, :elide? :allow? #_:callsite-id,
|
||||
:host :thread :otel/context))]
|
||||
:host :thread :otel? :otel/context))]
|
||||
|
||||
(if-let [kvs+ (get opts :kvs+)] ; Undocumented
|
||||
(if base
|
||||
|
|
@ -619,7 +627,7 @@
|
|||
|
||||
_ ; Compile-time validation
|
||||
(do
|
||||
(when (and run-form error-form) ; Ambiguous source of error
|
||||
(when (and run-form? error-form) ; Ambiguous source of error
|
||||
(truss/ex-info!
|
||||
(str "Signal cannot have both `:run` and `:error` opts at "
|
||||
(sigs/format-callsite ns-form coords))))
|
||||
|
|
@ -631,7 +639,7 @@
|
|||
|
||||
signal-form
|
||||
(let [record-form
|
||||
(let [clause [(if run-form :run :no-run) (if clj? :clj :cljs)]]
|
||||
(let [clause [(if run-form? :run :no-run) (if clj? :clj :cljs)]]
|
||||
(case clause
|
||||
[:run :clj ] `(Signal. 1 ~'__inst ~'__uid, ~'__ns ~coords ~host-form ~'__thread ~'__otel-context1, ~sample-form, ~'__kind ~'__id ~'__level, ~ctx-form ~parent-form ~'__root1, ~data-form ~kvs-form ~'_msg_, ~'_run-err '~show-run-form ~show-run-val ~'_end-inst ~'_run-nsecs)
|
||||
[:run :cljs] `(Signal. 1 ~'__inst ~'__uid, ~'__ns ~coords ~sample-form, ~'__kind ~'__id ~'__level, ~ctx-form ~parent-form ~'__root1, ~data-form ~kvs-form ~'_msg_, ~'_run-err '~show-run-form ~show-run-val ~'_end-inst ~'_run-nsecs)
|
||||
|
|
@ -642,7 +650,7 @@
|
|||
(sigs/format-callsite ns-form coords)))))
|
||||
|
||||
record-form
|
||||
(if-not run-form
|
||||
(if-not run-form?
|
||||
record-form
|
||||
`(let [~(with-meta '_run-result {:tag `RunResult}) ~'__run-result
|
||||
~'_run-nsecs (.-run-nsecs ~'_run-result)
|
||||
|
|
@ -674,8 +682,8 @@
|
|||
(do signal#)))))
|
||||
|
||||
;; Trade-off: avoid double `run-form` expansion
|
||||
run-fn-form (when run-form `(fn [] ~run-form))
|
||||
run-form* (when run-form `(~'__run-fn-form))
|
||||
run-fn-form (when run-form? `(fn [] ~run-form))
|
||||
run-form* (when run-form? `(~'__run-fn-form))
|
||||
|
||||
into-let-form
|
||||
(enc/cond!
|
||||
|
|
@ -684,19 +692,19 @@
|
|||
~'__uid ~(auto-> uid-form `(taoensso.telemere/*uid-fn* (if ~'__root0 false true)))
|
||||
~'__root1 ~'__root0 ; Retain, but don't establish
|
||||
~'__run-result
|
||||
~(when run-form
|
||||
~(when run-form?
|
||||
`(let [t0# (enc/now-nano*)]
|
||||
(truss/try*
|
||||
(do (RunResult. ~run-form* nil (- (enc/now-nano*) t0#)))
|
||||
(catch :all t# (RunResult. nil t# (- (enc/now-nano*) t0#))))))]
|
||||
|
||||
;; Trace without OpenTelemetry
|
||||
(or cljs? (not enabled:otel-tracing?))
|
||||
(or cljs? (not otel-tracing?))
|
||||
`[~'__otel-context1 nil
|
||||
~'__uid ~(auto-> uid-form `(taoensso.telemere/*uid-fn* (if ~'__root0 false true)))
|
||||
~'__root1 (or ~'__root0 ~(when trace? `{:id ~'__id, :uid ~'__uid}))
|
||||
~'__run-result
|
||||
~(when run-form
|
||||
~(when run-form?
|
||||
`(binding [*trace-root* ~'__root1
|
||||
*trace-parent* {:id ~'__id, :uid ~'__uid}]
|
||||
(let [t0# (enc/now-nano*)]
|
||||
|
|
@ -705,9 +713,9 @@
|
|||
(catch :all t# (RunResult. nil t# (- (enc/now-nano*) t0#)))))))]
|
||||
|
||||
;; Trace with OpenTelemetry
|
||||
(and clj? enabled:otel-tracing?)
|
||||
(and clj? otel-tracing?)
|
||||
`[~'__otel-context0 ~(get opts :otel/context `(otel-context)) ; Context
|
||||
~'__otel-context1 ~(if run-form `(otel-context+span ~'__id ~'__inst ~'__otel-context0 ~(get opts :otel/span-kind)) ~'__otel-context0)
|
||||
~'__otel-context1 ~(if run-form? `(otel-context+span ~'__id ~'__inst ~'__otel-context0 ~(get opts :otel/span-kind)) `~'__otel-context0)
|
||||
~'__uid ~(auto-> uid-form `(or (otel-span-id ~'__otel-context1) (com.taoensso.encore.Ids/genHexId16)))
|
||||
~'__root1
|
||||
(or ~'__root0
|
||||
|
|
@ -715,7 +723,7 @@
|
|||
`{:id ~'__id, :uid (or (otel-trace-id ~'__otel-context1) (com.taoensso.encore.Ids/genHexId32))}))
|
||||
|
||||
~'__run-result
|
||||
~(when run-form
|
||||
~(when run-form?
|
||||
`(binding [*otel-context* ~'__otel-context1
|
||||
*trace-root* ~'__root1
|
||||
*trace-parent* {:id ~'__id, :uid ~'__uid}]
|
||||
|
|
|
|||
|
|
@ -219,15 +219,15 @@
|
|||
|
||||
(if (or common-attrs trace-attrs)
|
||||
(let [ab (Attributes/builder)]
|
||||
(when-let [ns (get signal :ns)] (.put ab "ns" (str ns)))
|
||||
(when-let [line (get signal :line)] (.put ab "line" (long line)))
|
||||
(when-let [ns (get signal :ns)] (.put ab "ns" (str ns)))
|
||||
(when-let [line (enc/get-in* signal [:coords 0])] (.put ab "line" (long line)))
|
||||
(when-let [attrs common-attrs] (put-attrs! ab attrs))
|
||||
(when-let [attrs trace-attrs] (put-attrs! ab attrs))
|
||||
(.build ab))
|
||||
|
||||
;; Common case
|
||||
(when-let [ns (get signal :ns)]
|
||||
(if-let [line (get signal :line)]
|
||||
(when-let [ns (get signal :ns)]
|
||||
(if-let [line (enc/get-in* signal [:coords 0])]
|
||||
(Attributes/of ak-ns ns, ak-line (long line))
|
||||
(Attributes/of ak-ns ns)))))))
|
||||
|
||||
|
|
|
|||
|
|
@ -35,21 +35,21 @@
|
|||
(enc/format* pattern vargs)
|
||||
(enc/str-join " " (map arg-str) vargs)))]
|
||||
|
||||
[error msg {:vargs vargs}])
|
||||
[error msg vargs])
|
||||
|
||||
(let [md (if (and (map? v0) (get (meta v0) :meta)) v0 nil)
|
||||
error (get md :err)
|
||||
error (get md :err)
|
||||
md (dissoc md :err)
|
||||
vargs (if md (enc/vrest vargs) vargs)
|
||||
pattern (if format-msg? (let [[v0] vargs] v0) nil)
|
||||
vargs (if format-msg? (enc/vrest vargs) vargs)
|
||||
vargs (if md (enc/vrest vargs) vargs)
|
||||
pattern (if format-msg? (let [[v0] vargs] v0) nil)
|
||||
vargs (if format-msg? (enc/vrest vargs) vargs)
|
||||
msg
|
||||
(delay
|
||||
(if format-msg?
|
||||
(enc/format* pattern vargs)
|
||||
(enc/str-join " " (map arg-str) vargs)))]
|
||||
|
||||
[error msg (when-not (empty? vargs) {:vargs vargs})])))))
|
||||
[error msg (when-not (empty? vargs) vargs)])))))
|
||||
|
||||
(comment
|
||||
(parse-vargs true [ "hello %s" "stu"])
|
||||
|
|
@ -63,13 +63,13 @@
|
|||
[level format-msg? vargs]
|
||||
(truss/keep-callsite
|
||||
`(when (impl/signal-allowed? {:kind :log, :level ~level, :id shim-id})
|
||||
(let [[error# msg# data#] (parse-vargs ~format-msg? ~vargs)]
|
||||
(let [[error# msg# vargs#] (parse-vargs ~format-msg? ~vargs)]
|
||||
(tel/log!
|
||||
{:allow? true
|
||||
:level ~level
|
||||
:id shim-id
|
||||
:error error#
|
||||
:data data#}
|
||||
{:allow? true
|
||||
:level ~level
|
||||
:id shim-id
|
||||
:error error#
|
||||
:timbre/vargs vargs#}
|
||||
msg#)
|
||||
nil)))))
|
||||
|
||||
|
|
@ -190,8 +190,11 @@
|
|||
:min-level nil
|
||||
:fn
|
||||
(fn [data]
|
||||
(let [{:keys [instant level context ?err output_
|
||||
?ns-str ?file ?line ?column]} data]
|
||||
(let [{:keys [instant level context msg-type vargs
|
||||
?ns-str ?file ?line ?column]} data
|
||||
|
||||
format-msg? (enc/identical-kw? msg-type :f)
|
||||
[error msg vargs] (parse-vargs format-msg? vargs)]
|
||||
|
||||
(taoensso.telemere/signal!
|
||||
{:kind :timbre
|
||||
|
|
@ -200,9 +203,10 @@
|
|||
:ctx+ context
|
||||
|
||||
:ns ?ns-str
|
||||
:file ?file
|
||||
:line ?line
|
||||
:column ?column
|
||||
:coords (when ?line [?line ?column])
|
||||
:file ?file ; Non-standard, goes to kvs
|
||||
|
||||
:error ?err
|
||||
:msg (force output_)})))})
|
||||
:error error
|
||||
:msg (when msg-type msg)
|
||||
|
||||
:timbre/vargs vargs})))})
|
||||
|
|
|
|||
|
|
@ -447,10 +447,10 @@
|
|||
(let [sv (with-sig (sig! {:level :info, :parent {:uid :uid1, :foo :bar}}))] (is (sm? sv {:parent {:id :submap/nx :uid :uid1, :foo :bar}}) "Manual `:parent/uid`"))
|
||||
(let [sv (with-sig (sig! {:level :info, :root {:id :id1, :foo :bar}}))] (is (sm? sv {:root {:id :id1 :uid :submap/nx, :foo :bar}}) "Manual `:root/id`"))
|
||||
(let [sv (with-sig (sig! {:level :info, :root {:uid :uid1, :foo :bar}}))] (is (sm? sv {:root {:id :submap/nx :uid :uid1, :foo :bar}}) "Manual `:root/uid`"))
|
||||
(let [sv (with-sig (sig! {:level :info})) ] (is (sm? sv {:uid nil})))
|
||||
(let [sv (with-sig (sig! {:level :info, :otel? false})) ] (is (sm? sv {:uid nil})))
|
||||
(let [sv (with-sig (sig! {:level :info, :uid :auto})) ] (is (sm? sv {:uid string?})))
|
||||
(let [sv (binding [tel/*uid-fn* (fn [_] "my-uid")]
|
||||
(with-sig (sig! {:level :info, :uid :auto}))) ] (is (sm? sv {:uid "my-uid"})))])
|
||||
(with-sig (sig! {:level :info, :uid :auto, :otel? false}))) ] (is (sm? sv {:uid "my-uid"})))])
|
||||
|
||||
(testing "Auto parent/root"
|
||||
[(testing "Tracing disabled"
|
||||
|
|
@ -594,12 +594,13 @@
|
|||
(let [{rv :value, [sv] :signals} (with-sigs (tel/log!? {:allow? false} "msg")) ] [(is (= rv nil)) (is (nil? sv))])])
|
||||
|
||||
(testing "trace!" ; ?id + run => unconditional run result (value or throw)
|
||||
[(let [{rv :value, [sv] :signals} (with-sigs (tel/trace! (+ 1 2))) ] [(is (= rv 3)) (is (sm? sv {:kind :trace, :coords coords?, :level :info, :id nil, :msg_ "(+ 1 2) => 3"}))])
|
||||
(let [{rv :value, [sv] :signals} (with-sigs (tel/trace! {:msg nil} (+ 1 2))) ] [(is (= rv 3)) (is (sm? sv {:kind :trace, :coords coords?, :level :info, :id nil, :msg_ nil}))])
|
||||
(let [{rv :value, [sv] :signals} (with-sigs (tel/trace! :id1 (+ 1 2))) ] [(is (= rv 3)) (is (sm? sv {:kind :trace, :coords coords?, :level :info, :id :id1}))])
|
||||
(let [{rv :value, [sv] :signals} (with-sigs (tel/trace! {:id :id1} (+ 1 2))) ] [(is (= rv 3)) (is (sm? sv {:kind :trace, :coords coords?, :level :info, :id :id1}))])
|
||||
(let [{rv :value, [sv] :signals} (with-sigs (tel/trace! {:id :id1, :run (+ 1 2)}))] [(is (= rv 3)) (is (sm? sv {:kind :trace, :coords coords?, :level :info, :id :id1}))])
|
||||
(let [{re :error, [sv] :signals} (with-sigs (tel/trace! :id1 (ex1!))) ] [(is (ex1? re)) (is (sm? sv {:kind :trace, :coords coords?, :level :info, :id :id1, :error ex1,
|
||||
[(let [{rv :value, [sv] :signals} (with-sigs (tel/trace! nil)) ] [(is (= rv nil)) (is (sm? sv {:kind :trace, :coords coords?, :level :info, :id nil, :msg_ "nil => nil"}))])
|
||||
(let [{rv :value, [sv] :signals} (with-sigs (tel/trace! (+ 1 2))) ] [(is (= rv 3)) (is (sm? sv {:kind :trace, :coords coords?, :level :info, :id nil, :msg_ "(+ 1 2) => 3"}))])
|
||||
(let [{rv :value, [sv] :signals} (with-sigs (tel/trace! {:msg nil} (+ 1 2))) ] [(is (= rv 3)) (is (sm? sv {:kind :trace, :coords coords?, :level :info, :id nil, :msg_ nil}))])
|
||||
(let [{rv :value, [sv] :signals} (with-sigs (tel/trace! :id1 (+ 1 2))) ] [(is (= rv 3)) (is (sm? sv {:kind :trace, :coords coords?, :level :info, :id :id1}))])
|
||||
(let [{rv :value, [sv] :signals} (with-sigs (tel/trace! {:id :id1} (+ 1 2))) ] [(is (= rv 3)) (is (sm? sv {:kind :trace, :coords coords?, :level :info, :id :id1}))])
|
||||
(let [{rv :value, [sv] :signals} (with-sigs (tel/trace! {:id :id1, :run (+ 1 2)}))] [(is (= rv 3)) (is (sm? sv {:kind :trace, :coords coords?, :level :info, :id :id1}))])
|
||||
(let [{re :error, [sv] :signals} (with-sigs (tel/trace! :id1 (ex1!))) ] [(is (ex1? re)) (is (sm? sv {:kind :trace, :coords coords?, :level :info, :id :id1, :error ex1,
|
||||
:msg_ #?(:clj "(ex1!) !> clojure.lang.ExceptionInfo"
|
||||
:cljs "(ex1!) !> cljs.core/ExceptionInfo")}))])
|
||||
(let [{rv :value, [sv] :signals} (with-sigs (tel/trace! {:allow? false} (+ 1 2)))] [(is (= rv 3)) (is (nil? sv))])
|
||||
|
|
@ -726,7 +727,7 @@
|
|||
(is (sm? (with-sig (-> (.atWarn sl) (.log "Hello"))) {:level :warn, :ns "my.class", :kind :slf4j, :msg_ "Hello", :inst enc/inst?}) "Fluent API: warn basics")])
|
||||
|
||||
(testing "Message formatting"
|
||||
(let [msgp "x={},y={}", expected {:msg_ "x=1,y=2", :data {:slf4j/args ["1" "2"]}}]
|
||||
(let [msgp "x={},y={}", expected {:msg_ "x=1,y=2", :slf4j/args (fn [objs] (= (vec objs) ["1" "2"]))}]
|
||||
[(is (sm? (with-sig (.info sl msgp "1" "2")) expected) "Legacy API: formatted message, raw args")
|
||||
(is (sm? (with-sig (-> (.atInfo sl) (.setMessage msgp) (.addArgument "1") (.addArgument "2") (.log))) expected) "Fluent API: formatted message, raw args")]))
|
||||
|
||||
|
|
@ -737,8 +738,8 @@
|
|||
m2 (#'slf4j/est-marker! "M2")
|
||||
cm (#'slf4j/est-marker! "Compound" "M1" "M2")]
|
||||
|
||||
[(is (sm? (with-sig (.info sl cm "Hello")) {:data {:slf4j/marker-names #{"Compound" "M1" "M2"}}}) "Legacy API: markers")
|
||||
(is (sm? (with-sig (-> (.atInfo sl) (.addMarker m1) (.addMarker cm) (.log))) {:data {:slf4j/marker-names #{"Compound" "M1" "M2"}}}) "Fluent API: markers")]))
|
||||
[(is (sm? (with-sig (.info sl cm "Hello")) {:slf4j/markers #{"Compound" "M1" "M2"}}) "Legacy API: markers")
|
||||
(is (sm? (with-sig (-> (.atInfo sl) (.addMarker m1) (.addMarker cm) (.log))) {:slf4j/markers #{"Compound" "M1" "M2"}}) "Fluent API: markers")]))
|
||||
|
||||
(testing "Errors"
|
||||
[(is (sm? (with-sig (.warn sl "An error" ^Throwable ex1)) {:level :warn, :error ex1}) "Legacy API: errors")
|
||||
|
|
@ -753,15 +754,15 @@
|
|||
;;;; Timbre shim
|
||||
|
||||
(deftest _timbre-shim
|
||||
[(is (sm? (with-sig (timbre/log :warn "x1" nil "x2")) {:kind :log, :level :warn, :id timbre/shim-id, :msg_ "x1 nil x2", :data {:vargs ["x1" nil "x2"]}, :ns string?}))
|
||||
(is (sm? (with-sig (timbre/info "x1" nil "x2")) {:kind :log, :level :info, :id timbre/shim-id, :msg_ "x1 nil x2", :data {:vargs ["x1" nil "x2"]}, :ns string?}))
|
||||
(is (sm? (with-sig (timbre/error "x1" nil "x2")) {:kind :log, :level :error, :id timbre/shim-id, :msg_ "x1 nil x2", :data {:vargs ["x1" nil "x2"]}, :ns string?}))
|
||||
[(is (sm? (with-sig (timbre/log :warn "x1" nil "x2")) {:kind :log, :level :warn, :id timbre/shim-id, :msg_ "x1 nil x2", :timbre/vargs ["x1" nil "x2"], :ns string?}))
|
||||
(is (sm? (with-sig (timbre/info "x1" nil "x2")) {:kind :log, :level :info, :id timbre/shim-id, :msg_ "x1 nil x2", :timbre/vargs ["x1" nil "x2"], :ns string?}))
|
||||
(is (sm? (with-sig (timbre/error "x1" nil "x2")) {:kind :log, :level :error, :id timbre/shim-id, :msg_ "x1 nil x2", :timbre/vargs ["x1" nil "x2"], :ns string?}))
|
||||
|
||||
(is (sm? (with-sig (timbre/logf :warn "%s %s %s" "x1" nil "x2")) {:kind :log, :level :warn, :id timbre/shim-id, :msg_ "x1 nil x2", :data {:vargs ["x1" nil "x2"]}, :ns string?}))
|
||||
(is (sm? (with-sig (timbre/infof "%s %s %s" "x1" nil "x2")) {:kind :log, :level :info, :id timbre/shim-id, :msg_ "x1 nil x2", :data {:vargs ["x1" nil "x2"]}, :ns string?}))
|
||||
(is (sm? (with-sig (timbre/errorf "%s %s %s" "x1" nil "x2")) {:kind :log, :level :error, :id timbre/shim-id, :msg_ "x1 nil x2", :data {:vargs ["x1" nil "x2"]}, :ns string?}))
|
||||
(is (sm? (with-sig (timbre/logf :warn "%s %s %s" "x1" nil "x2")) {:kind :log, :level :warn, :id timbre/shim-id, :msg_ "x1 nil x2", :timbre/vargs ["x1" nil "x2"], :ns string?}))
|
||||
(is (sm? (with-sig (timbre/infof "%s %s %s" "x1" nil "x2")) {:kind :log, :level :info, :id timbre/shim-id, :msg_ "x1 nil x2", :timbre/vargs ["x1" nil "x2"], :ns string?}))
|
||||
(is (sm? (with-sig (timbre/errorf "%s %s %s" "x1" nil "x2")) {:kind :log, :level :error, :id timbre/shim-id, :msg_ "x1 nil x2", :timbre/vargs ["x1" nil "x2"], :ns string?}))
|
||||
|
||||
(is (sm? (with-sig (timbre/info ex1 "x1" "x2")) {:kind :log, :level :info, :error ex1, :msg_ "x1 x2", :data {:vargs ["x1" "x2"]}}) "First-arg error")
|
||||
(is (sm? (with-sig (timbre/info ex1 "x1" "x2")) {:kind :log, :level :info, :error ex1, :msg_ "x1 x2", :timbre/vargs ["x1" "x2"]}) "First-arg error")
|
||||
|
||||
(is (sm? (with-sig (timbre/spy :info "my-name" (+ 1 2))) {:kind :spy, :level :info, :id timbre/shim-id, :msg_ "my-name => 3", :ns string?}))
|
||||
(is (sm? (tel/with-min-level :debug (with-sig (timbre/spy (+ 1 2)))) {:kind :spy, :level :debug, :id timbre/shim-id, :msg_ "(+ 1 2) => 3", :ns string?}))
|
||||
|
|
@ -881,7 +882,7 @@
|
|||
(is (= ((tel/pr-signal-fn {:pr-fn (fn [_] "str")}) sig) (str "str" utils/newline))))]))
|
||||
|
||||
(testing "format-signal-fn"
|
||||
(let [sig (with-sig :raw :trap (tel/event! ::ev-id {:inst t1, :msg ["a" "b"]}))]
|
||||
(let [sig (with-sig :raw :trap (tel/event! ::ev-id {:inst t1, :msg ["a" "b"], :otel? false}))]
|
||||
[(is (enc/str-starts-with? ((tel/format-signal-fn) sig ) "2024-01-01T01:01:01.110Z INFO EVENT"))
|
||||
(is (enc/str-ends-with? ((tel/format-signal-fn) (dissoc sig :host)) "::ev-id a b\n"))]))])])
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
(defproject com.taoensso/telemere-slf4j "1.1.0"
|
||||
(defproject com.taoensso/telemere-slf4j "1.2.0-SNAPSHOT"
|
||||
:author "Peter Taoussanis <https://www.taoensso.com>"
|
||||
:description "Telemere backend/provider for SLF4J API v2"
|
||||
:url "https://www.taoensso.com/telemere"
|
||||
|
|
@ -18,7 +18,7 @@
|
|||
{:dependencies
|
||||
[[org.clojure/clojure "1.12.1"]
|
||||
[org.slf4j/slf4j-api "2.0.17"]
|
||||
[com.taoensso/telemere "1.1.0"]]}
|
||||
[com.taoensso/telemere "1.2.0-SNAPSHOT"]]}
|
||||
|
||||
:dev
|
||||
{:plugins
|
||||
|
|
|
|||
|
|
@ -63,13 +63,13 @@
|
|||
|
||||
(comment [(est-marker! "a1" "a2") (get-marker "a1") (= (get-marker "a1") (get-marker "a1"))])
|
||||
|
||||
(def ^:private marker-names
|
||||
(def ^:private get-marker-names
|
||||
"Returns #{<MarkerName>}. Cached => assumes markers NOT modified after creation."
|
||||
;; We use `BasicMarkerFactory` so:
|
||||
;; 1. Our markers are just labels (no other content besides their name).
|
||||
;; 2. Markers with the same name are identical (enabling caching).
|
||||
(enc/fmemoize
|
||||
(fn marker-names [marker-or-markers]
|
||||
(fn get-marker-names [marker-or-markers]
|
||||
(if (instance? org.slf4j.Marker marker-or-markers)
|
||||
|
||||
;; Single marker
|
||||
|
|
@ -79,15 +79,15 @@
|
|||
(if-not (.hasReferences m)
|
||||
acc
|
||||
(enc/reduce-iterator!
|
||||
(fn [acc ^org.slf4j.Marker in]
|
||||
(if-not (.hasReferences in)
|
||||
(conj acc (.getName in))
|
||||
(into acc (marker-names in))))
|
||||
(fn [acc ^org.slf4j.Marker in]
|
||||
(if-not (.hasReferences in)
|
||||
(conj acc (.getName in))
|
||||
(into acc (get-marker-names in))))
|
||||
acc (.iterator m))))
|
||||
|
||||
;; Vector of markers
|
||||
(reduce
|
||||
(fn [acc in] (into acc (marker-names in)))
|
||||
(fn [acc in] (into acc (get-marker-names in)))
|
||||
#{} (truss/have vector? marker-or-markers))))))
|
||||
|
||||
(comment
|
||||
|
|
@ -97,9 +97,9 @@
|
|||
ms [m1 m2]]
|
||||
|
||||
(enc/qb 1e6 ; [45.52 47.48 44.85]
|
||||
(marker-names m1)
|
||||
(marker-names cm)
|
||||
(marker-names ms))))
|
||||
(get-marker-names m1)
|
||||
(get-marker-names cm)
|
||||
(get-marker-names ms))))
|
||||
|
||||
;;;; Interop fns (called by `TelemereLogger`)
|
||||
|
||||
|
|
@ -132,11 +132,10 @@
|
|||
(org.slf4j.helpers.MessageFormatter/basicArrayFormat
|
||||
msg-pattern args))
|
||||
|
||||
:data
|
||||
(enc/assoc-some nil
|
||||
:slf4j/marker-names marker-names
|
||||
:slf4j/args (when args (vec args))
|
||||
:slf4j/kvs kvs)})
|
||||
:slf4j/args args ; Object[]
|
||||
:slf4j/markers marker-names ; Usu. used for routing, filtering, xfns, etc.
|
||||
:data (when kvs {:slf4j/kvs kvs})})
|
||||
|
||||
nil)
|
||||
|
||||
(defn- log!
|
||||
|
|
@ -144,24 +143,24 @@
|
|||
|
||||
;; Modern "fluent" API calls
|
||||
([logger-name ^org.slf4j.event.LoggingEvent event]
|
||||
(let [inst (or (when-let [ts (.getTimeStamp event)] (java.time.Instant/ofEpochMilli ts)) (enc/now-inst*))
|
||||
level (.getLevel event)
|
||||
error (.getThrowable event)
|
||||
msg-pattern (.getMessage event)
|
||||
args (when-let [args (.getArgumentArray event)] args)
|
||||
markers (when-let [markers (.getMarkers event)] (marker-names (vec markers)))
|
||||
kvs (when-let [kvps (.getKeyValuePairs event)]
|
||||
(reduce
|
||||
(fn [acc ^org.slf4j.event.KeyValuePair kvp]
|
||||
(assoc acc (.-key kvp) (.-value kvp)))
|
||||
nil kvps))]
|
||||
(let [inst (or (when-let [ts (.getTimeStamp event)] (java.time.Instant/ofEpochMilli ts)) (enc/now-inst*))
|
||||
level (.getLevel event)
|
||||
error (.getThrowable event)
|
||||
msg-pattern (.getMessage event)
|
||||
args (when-let [args (.getArgumentArray event)] args)
|
||||
marker-names (when-let [markers (.getMarkers event)] (get-marker-names (vec markers)))
|
||||
kvs (when-let [kvps (.getKeyValuePairs event)]
|
||||
(reduce
|
||||
(fn [acc ^org.slf4j.event.KeyValuePair kvp]
|
||||
(assoc acc (.-key kvp) (.-value kvp)))
|
||||
nil kvps))]
|
||||
|
||||
(when-debug (println [:slf4j/fluent-log-call (sig-level level) logger-name]))
|
||||
(normalized-log! logger-name level inst error msg-pattern args markers kvs)))
|
||||
(normalized-log! logger-name level inst error msg-pattern args marker-names kvs)))
|
||||
|
||||
;; Legacy API calls
|
||||
([logger-name ^org.slf4j.event.Level level error msg-pattern args marker]
|
||||
(let [marker-names (when marker (marker-names marker))]
|
||||
(let [marker-names (when marker (get-marker-names marker))]
|
||||
(when-debug (println [:slf4j/legacy-log-call (sig-level level) logger-name]))
|
||||
(normalized-log! logger-name level (enc/now-inst*) error msg-pattern args marker-names nil))))
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue