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

[nop] Un-alias public signal-allowed?, signal! macros

Browse source
This commit is contained in:
Peter Taoussanis 2025-03-02 14:24:27 +01:00
parent 634cc53405
commit ea20f6836b
2 changed files with 83 additions and 64 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
main/src/taoensso/telemere.cljc
View file

@ -19,7 +19,7 @@
#?(:cljs #?(:cljs
(:require-macros (:require-macros
[taoensso.telemere :refer [taoensso.telemere :refer
[with-signal with-signals [with-signal with-signals signal-allowed?
signal! event! log! trace! spy! catch->error! signal! event! log! trace! spy! catch->error!
;; Via `sigs/def-api` ;; Via `sigs/def-api`
@ -64,8 +64,6 @@
impl/msg-skip impl/msg-skip
#?(:clj impl/with-signal) #?(:clj impl/with-signal)
#?(:clj impl/with-signals) #?(:clj impl/with-signals)
#?(:clj impl/signal!)
#?(:clj impl/signal-allowed?)
;; Utils ;; Utils
utils/clean-signal-fn utils/clean-signal-fn
@ -208,6 +206,44 @@
;; - catch->error! ---- ?id + run => unconditional run value or ?catch-val ;; - catch->error! ---- ?id + run => unconditional run value or ?catch-val
;; - uncaught->error! - ?id => nil ;; - uncaught->error! - ?id => nil
#?(:clj
(defn- args->opts [args]
(case (count args)
0 {}
1 (impl/valid-opts! (first args))
(apply hash-map args))))
#?(:clj
(defmacro signal-allowed?
"Returns true iff signal with given opts would meet filtering conditions:
(when (signal-allowed? {:level :warn, <...>}) (my-custom-code))
Allows you to use Telemere's rich filtering system for conditionally
executing arbitrary code. Also handy for batching multiple signals
under a single set of conditions (incl. rate-limiting, sampling, etc.):
;; Logs exactly 2 or 0 messages (never 1):
(when (signal-allowed? {:level :info, :sample-rate 0.5})
(log! {:allow? true} \"Message 1\")
(log! {:allow? true} \"Message 2\"))"
;; Used also for interop (tools.logging, SLF4J), etc.
{:arglists (impl/signal-arglists :signal-allowed?)}
[& args] `(impl/signal-allowed? ~(args->opts args))))
(comment (macroexpand '(signal-allowed? {:ns "my-ns"})))
#?(:clj
(defmacro signal!
"opts => allowed? / unconditional run result (value or throw)."
{:doc (impl/signal-docstring :signal!)
:arglists (impl/signal-arglists :signal!)}
[& args]
(enc/keep-callsite
`(impl/signal! ~(args->opts args)))))
(comment (with-signal (signal!)))
#?(:clj #?(:clj
(defn- merge-or-assoc-opts [m macro-form k v] (defn- merge-or-assoc-opts [m macro-form k v]
(let [m (assoc m :coords (truss/callsite-coords macro-form))] (let [m (assoc m :coords (truss/callsite-coords macro-form))]

105
main/src/taoensso/telemere/impl.cljc
View file

@ -389,28 +389,28 @@
(defn signal-arglists [macro-id] (defn signal-arglists [macro-id]
(case macro-id (case macro-id
:signal! ; opts => allowed? / unconditional run result (value or throw)
'( [& opts-kvs]
[{:as opts-map :keys
[#_defaults #_elide? #_allow? #_callsite-id, ; Undocumented
elidable? coords inst uid middleware middleware+,
sample-rate kind ns id level when rate-limit rate-limit-by,
ctx ctx+ parent root trace?, do let data msg error run & kvs]}])
:signal-allowed? ; opts => allowed? :signal-allowed? ; opts => allowed?
'( [& opts-kvs] '( [& opts-kvs]
[{:as opts-map :keys [{:as opts-map :keys
[#_defaults #_elide? #_allow? #_callsite-id, ; Undocumented [#_elide? #_allow? #_callsite-id, ; Undocumented
elidable? coords #_inst #_uid #_middleware #_middleware+, elidable? coords #_inst #_uid #_middleware #_middleware+,
sample-rate kind ns id level when rate-limit rate-limit-by, sample-rate kind ns id level when rate-limit rate-limit-by,
#_ctx #_ctx+ #_parent #_root #_trace?, #_do #_let #_data #_msg #_error #_run #_& #_kvs]}]) #_ctx #_ctx+ #_parent #_root #_trace?, #_do #_let #_data #_msg #_error #_run #_& #_kvs]}])
:signal! ; opts => allowed? / unconditional run result (value or throw)
'( [& opts-kvs]
[{:as opts-map :keys
[#_elide? #_allow? #_callsite-id, ; Undocumented
elidable? coords inst uid middleware middleware+,
sample-rate kind ns id level when rate-limit rate-limit-by,
ctx ctx+ parent root trace?, do let data msg error run & kvs]}])
:event! ; id + ?level => allowed? :event! ; id + ?level => allowed?
'([opts-or-id] '([opts-or-id]
[id level] [id level]
[id [id
{:as opts-map :keys {:as opts-map :keys
[#_defaults #_elide? #_allow? #_callsite-id, [#_elide? #_allow? #_callsite-id,
elidable? coords inst uid middleware middleware+, elidable? coords inst uid middleware middleware+,
sample-rate kind ns id level when rate-limit rate-limit-by, sample-rate kind ns id level when rate-limit rate-limit-by,
ctx ctx+ parent root trace?, do let data msg error #_run & kvs]}]) ctx ctx+ parent root trace?, do let data msg error #_run & kvs]}])
@ -419,7 +419,7 @@
'([opts-or-msg] '([opts-or-msg]
[level msg] [level msg]
[{:as opts-map :keys [{:as opts-map :keys
[#_defaults #_elide? #_allow? #_callsite-id, [#_elide? #_allow? #_callsite-id,
elidable? coords inst uid middleware middleware+, elidable? coords inst uid middleware middleware+,
sample-rate kind ns id level when rate-limit rate-limit-by, sample-rate kind ns id level when rate-limit rate-limit-by,
ctx ctx+ parent root trace?, do let data msg error #_run & kvs]} ctx ctx+ parent root trace?, do let data msg error #_run & kvs]}
@ -429,7 +429,7 @@
'([opts-or-run] '([opts-or-run]
[id run] [id run]
[{:as opts-map :keys [{:as opts-map :keys
[#_defaults #_elide? #_allow? #_callsite-id, [#_elide? #_allow? #_callsite-id,
elidable? coords inst uid middleware middleware+, elidable? coords inst uid middleware middleware+,
sample-rate kind ns id level when rate-limit rate-limit-by, sample-rate kind ns id level when rate-limit rate-limit-by,
ctx ctx+ parent root trace?, do let data msg error run & kvs]} ctx ctx+ parent root trace?, do let data msg error run & kvs]}
@ -439,7 +439,7 @@
'([opts-or-run] '([opts-or-run]
[level run] [level run]
[{:as opts-map :keys [{:as opts-map :keys
[#_defaults #_elide? #_allow? #_callsite-id, [#_elide? #_allow? #_callsite-id,
elidable? coords inst uid middleware middleware+, elidable? coords inst uid middleware middleware+,
sample-rate kind ns id level when rate-limit rate-limit-by, sample-rate kind ns id level when rate-limit rate-limit-by,
ctx ctx+ parent root trace?, do let data msg error run & kvs]} ctx ctx+ parent root trace?, do let data msg error run & kvs]}
@ -449,7 +449,7 @@
'([opts-or-error] '([opts-or-error]
[id error] [id error]
[{:as opts-map :keys [{:as opts-map :keys
[#_defaults #_elide? #_allow? #_callsite-id, [#_elide? #_allow? #_callsite-id,
elidable? coords inst uid middleware middleware+, elidable? coords inst uid middleware middleware+,
sample-rate kind ns id level when rate-limit rate-limit-by, sample-rate kind ns id level when rate-limit rate-limit-by,
ctx ctx+ parent root trace?, do let data msg error #_run & kvs]} ctx ctx+ parent root trace?, do let data msg error #_run & kvs]}
@ -459,7 +459,7 @@
'([opts-or-run] '([opts-or-run]
[id run] [id run]
[{:as opts-map :keys [{:as opts-map :keys
[#_defaults #_elide? #_allow? #_callsite-id, catch-val, [#_elide? #_allow? #_callsite-id, catch-val,
elidable? coords inst uid middleware middleware+, elidable? coords inst uid middleware middleware+,
sample-rate kind ns id level when rate-limit rate-limit-by, sample-rate kind ns id level when rate-limit rate-limit-by,
ctx ctx+ parent root trace?, do let data msg error #_run & kvs]} ctx ctx+ parent root trace?, do let data msg error #_run & kvs]}
@ -469,7 +469,7 @@
'([] '([]
[opts-or-id] [opts-or-id]
[{:as opts-map :keys [{:as opts-map :keys
[#_defaults #_elide? #_allow? #_callsite-id, [#_elide? #_allow? #_callsite-id,
elidable? coords inst uid middleware middleware+, elidable? coords inst uid middleware middleware+,
sample-rate kind ns id level when rate-limit rate-limit-by, sample-rate kind ns id level when rate-limit rate-limit-by,
ctx ctx+ parent root trace?, do let data msg error #_run & kvs]}]) ctx ctx+ parent root trace?, do let data msg error #_run & kvs]}])
@ -499,7 +499,7 @@
(comment (enc/qb 1e6 (inst+nsecs (enc/now-inst) 1e9))) (comment (enc/qb 1e6 (inst+nsecs (enc/now-inst) 1e9)))
#?(:clj #?(:clj
(defn- valid-opts! [x] (defn valid-opts! [x]
(if (map? x) (if (map? x)
(do x) (do x)
;; We require const map keys, but vals may require eval ;; We require const map keys, but vals may require eval
@ -508,16 +508,34 @@
#?(:clj (defn- auto-> [form auto-form] (if (= form :auto) auto-form form))) #?(:clj (defn- auto-> [form auto-form] (if (= form :auto) auto-form form)))
#?(:clj #?(:clj
(defmacro ^:public signal! (defmacro signal-allowed?
"Generic low-level signal call, also aliased in Encore." "Returns true iff signal with given opts would meet filtering conditions.
{:doc (signal-docstring :signal!) Wrapped for public API."
:arglists (signal-arglists :signal!)} [opts]
[arg1 & more] (valid-opts! opts)
(let [opts (valid-opts! (if more (apply hash-map arg1 more) arg1)) (let [opts (merge {:kind :generic, :level :info} opts)
defaults (enc/merge {:kind :generic, :level :info} (get opts :defaults)) {:keys [#_callsite-id elide? allow?]}
opts (enc/merge defaults (dissoc opts :defaults)) (sigs/filter-call
cljs? (boolean (:ns &env)) {:cljs? (boolean (:ns &env))
:sf-arity 4
:ct-call-filter ct-call-filter
:*rt-call-filter* `*rt-call-filter*}
(assoc opts
:ns (auto-> (get opts :ns :auto) (str *ns*))))]
(if elide? false `(if ~allow? true false)))))
(comment (macroexpand '(signal-allowed? {:level :info})))
#?(:clj
(defmacro signal!
"Generic low-level signal creator. Wrapped for public API."
[opts]
(valid-opts! opts)
(let [cljs? (boolean (:ns &env))
clj? (not cljs?) clj? (not cljs?)
opts (merge {:kind :generic, :level :info} opts)
{run-form :run} opts {run-form :run} opts
ns-form* (get opts :ns :auto) ns-form* (get opts :ns :auto)
@ -760,41 +778,6 @@
(sigs/with-handler *sig-handlers* "hf1" (fn hf1 [x] (println x)) {} (sigs/with-handler *sig-handlers* "hf1" (fn hf1 [x] (println x)) {}
(signal! {:level :info, :run "run"})))) (signal! {:level :info, :run "run"}))))
#?(:clj
(defmacro ^:public signal-allowed?
"Returns true iff signal with given opts would meet filtering conditions:
(when (signal-allowed? {:level :warn, <...>}) (my-custom-code))
Allows you to use Telemere's rich filtering system for conditionally
executing arbitrary code. Also handy for batching multiple signals
under a single set of conditions (incl. rate-limiting, sampling, etc.):
;; Logs exactly 2 or 0 messages (never 1):
(when (signal-allowed? {:level :info, :sample-rate 0.5})
(log! {:allow? true} \"Message 1\")
(log! {:allow? true} \"Message 2\"))"
;; Used also for interop (tools.logging, SLF4J), etc.
{:arglists (signal-arglists :signal-allowed?)}
[arg1 & more]
(let [opts (valid-opts! (if more (apply hash-map arg1 more) arg1))
defaults (get opts :defaults)
opts (merge defaults (dissoc opts :defaults))
{:keys [#_callsite-id elide? allow?]}
(sigs/filter-call
{:cljs? (boolean (:ns &env))
:sf-arity 4
:ct-call-filter ct-call-filter
:*rt-call-filter* `*rt-call-filter*}
(assoc opts :ns
(get opts :ns (str *ns*))))]
(if elide? false `(if ~allow? true false)))))
(comment (macroexpand '(signal-allowed? {:level :info})))
;;;; Interop ;;;; Interop
#?(:clj #?(:clj