From b56f7c4908a208ab7b7d3777671d0149bf6302cc Mon Sep 17 00:00:00 2001 From: Peter Taoussanis Date: Wed, 10 Apr 2024 19:31:13 +0200 Subject: [PATCH] [nop] Misc housekeeping --- project.clj | 4 +-- resources/signal-docstrings/error!.txt | 3 ++- resources/signal-docstrings/event!.txt | 2 +- resources/signal-docstrings/log!.txt | 2 +- resources/signal-docstrings/signal!.txt | 2 +- .../{signal-handling.txt => signal-flow.txt} | 2 +- .../signal-docstrings/signal-formatters.txt | 6 +++++ .../signal-docstrings/signal-options.txt | 2 +- resources/signal-docstrings/spy!.txt | 2 +- resources/signal-docstrings/trace!.txt | 2 +- shadow-cljs.edn | 2 +- src/taoensso/telemere.cljc | 25 ++++++++----------- .../telemere/handlers/open_telemetry.clj | 4 +-- src/taoensso/telemere/impl.cljc | 8 +++--- 14 files changed, 34 insertions(+), 32 deletions(-) rename resources/signal-docstrings/{signal-handling.txt => signal-flow.txt} (87%) create mode 100644 resources/signal-docstrings/signal-formatters.txt diff --git a/project.clj b/project.clj index 0f4944a..8169581 100644 --- a/project.clj +++ b/project.clj @@ -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"] diff --git a/resources/signal-docstrings/error!.txt b/resources/signal-docstrings/error!.txt index eafc4ab..11e24d6 100644 --- a/resources/signal-docstrings/error!.txt +++ b/resources/signal-docstrings/error!.txt @@ -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 diff --git a/resources/signal-docstrings/event!.txt b/resources/signal-docstrings/event!.txt index 5cce496..7840875 100644 --- a/resources/signal-docstrings/event!.txt +++ b/resources/signal-docstrings/event!.txt @@ -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 diff --git a/resources/signal-docstrings/log!.txt b/resources/signal-docstrings/log!.txt index d0374c9..857a3d2 100644 --- a/resources/signal-docstrings/log!.txt +++ b/resources/signal-docstrings/log!.txt @@ -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 diff --git a/resources/signal-docstrings/signal!.txt b/resources/signal-docstrings/signal!.txt index 5649acb..edab493 100644 --- a/resources/signal-docstrings/signal!.txt +++ b/resources/signal-docstrings/signal!.txt @@ -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 diff --git a/resources/signal-docstrings/signal-handling.txt b/resources/signal-docstrings/signal-flow.txt similarity index 87% rename from resources/signal-docstrings/signal-handling.txt rename to resources/signal-docstrings/signal-flow.txt index 37b431b..3c70dd6 100644 --- a/resources/signal-docstrings/signal-handling.txt +++ b/resources/signal-docstrings/signal-flow.txt @@ -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. + - On signal flow, see: Ref. If anything is unclear, please ping me (@ptaoussanis) so that I can improve these docs! diff --git a/resources/signal-docstrings/signal-formatters.txt b/resources/signal-docstrings/signal-formatters.txt new file mode 100644 index 0000000..66f0226 --- /dev/null +++ b/resources/signal-docstrings/signal-formatters.txt @@ -0,0 +1,6 @@ +Common signal formatters include: + (utils/format-signal-str->fn) {}) ; For human-readable string output (default) + (utils/format-signal->edn-fn) {}) ; For edn output + (utils/format-signal->json-fn {}) ; For JSON output + + See relevant docstrings for details. diff --git a/resources/signal-docstrings/signal-options.txt b/resources/signal-docstrings/signal-options.txt index c2ed48a..8881ce8 100644 --- a/resources/signal-docstrings/signal-options.txt +++ b/resources/signal-docstrings/signal-options.txt @@ -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? diff --git a/resources/signal-docstrings/spy!.txt b/resources/signal-docstrings/spy!.txt index e61f7b4..2e05447 100644 --- a/resources/signal-docstrings/spy!.txt +++ b/resources/signal-docstrings/spy!.txt @@ -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 diff --git a/resources/signal-docstrings/trace!.txt b/resources/signal-docstrings/trace!.txt index a98f3e0..5eb5211 100644 --- a/resources/signal-docstrings/trace!.txt +++ b/resources/signal-docstrings/trace!.txt @@ -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 diff --git a/shadow-cljs.edn b/shadow-cljs.edn index 4f86e85..b19ed77 100644 --- a/shadow-cljs.edn +++ b/shadow-cljs.edn @@ -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"]] diff --git a/src/taoensso/telemere.cljc b/src/taoensso/telemere.cljc index 96fb84d..28c2531 100644 --- a/src/taoensso/telemere.cljc +++ b/src/taoensso/telemere.cljc @@ -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-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) {}) ; For human-readable string output (default) - (utils/format-signal->edn-fn) {}) ; For edn output - (utils/format-signal->json-fn {}) ; For JSON output - - See relevant docstrings for details." - "See docstring") - (enc/defaliases #?(:default handlers:console/handler:console) #?(:cljs handlers:console/handler:console-raw) diff --git a/src/taoensso/telemere/handlers/open_telemetry.clj b/src/taoensso/telemere/handlers/open_telemetry.clj index 0918124..8f3bd01 100644 --- a/src/taoensso/telemere/handlers/open_telemetry.clj +++ b/src/taoensso/telemere/handlers/open_telemetry.clj @@ -35,7 +35,7 @@ (def ^String attr-name "Returns cached OpenTelemetry-style name: `:foo/bar-baz` -> \"foo_bar_baz\", etc. - Ref. " + Ref. ." (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. ." [extra-attrs-key signal] (let [attrs-map diff --git a/src/taoensso/telemere/impl.cljc b/src/taoensso/telemere/impl.cljc index 7ded386..2db4434 100644 --- a/src/taoensso/telemere/impl.cljc +++ b/src/taoensso/telemere/impl.cljc @@ -534,8 +534,8 @@ {:macro-form &form :macro-env &env :sf-arity 4 - :ct-sig-filter ct-sig-filter - :rt-sig-filter `*rt-sig-filter*} + :ct-sig-filter ct-sig-filter + :*rt-sig-filter* `*rt-sig-filter*} opts)] (if elide? @@ -663,8 +663,8 @@ {:macro-form &form :macro-env &env :sf-arity 4 - :ct-sig-filter ct-sig-filter - :rt-sig-filter `*rt-sig-filter*} + :ct-sig-filter ct-sig-filter + :*rt-sig-filter* `*rt-sig-filter*} opts)] (and (not elide?) allow?))))