Telemere 1.0.0-beta11
Released under the Eclipse Public License - v 1.0
Structured telemetry library for Clojure/Script.
Installation
To install, add the following dependency to your project or build file:
[com.taoensso/telemere "1.0.0-beta11"]
Namespaces
taoensso.telemere
Structured telemetry for Clojure/Script applications.
Public variables and functions:
- *ctx*
- *middleware*
- add-handler!
- catch->error!
- chance
- check-intakes
- comp-middleware
- default-ctx
- error!
- error-signal?
- event!
- format-signal-fn
- get-env
- get-filters
- get-handlers
- get-min-level
- handler:console
- handler:file
- help:filters
- help:handlers
- help:signal-content
- help:signal-creators
- help:signal-filters
- help:signal-flow
- help:signal-handlers
- help:signal-options
- level-aliases
- log!
- msg-skip
- msg-splice
- newline
- pr-signal-fn
- rate-limiter
- remove-handler!
- set-ctx!
- set-id-filter!
- set-kind-filter!
- set-middleware!
- set-min-level!
- set-ns-filter!
- set-var-root!
- shut-down-handlers!
- signal!
- spy!
- streams->reset!
- streams->telemere!
- trace!
- uncaught->error!
- uncaught->handler!
- update-var-root!
- with-ctx
- with-ctx+
- with-err->telemere
- with-handler
- with-handler+
- with-id-filter
- with-kind-filter
- with-middleware
- with-min-level
- with-ns-filter
- with-out->telemere
- with-signal
- with-signals
- with-streams->telemere
- without-filters
taoensso.telemere.open-telemetry
OpenTelemetry handler using `opentelemetry-java`, +Telemere 1.0.0-beta12 Telemere 1.0.0-beta12
Released under the Eclipse Public License - v 1.0
Structured telemetry library for Clojure/Script.
Installation
To install, add the following dependency to your project or build file:
[com.taoensso/telemere "1.0.0-beta12"]Namespaces
taoensso.telemere
Structured telemetry for Clojure/Script applications.Public variables and functions:
- *ctx*
- *middleware*
- add-handler!
- catch->error!
- chance
- check-intakes
- comp-middleware
- default-ctx
- default-handler-dispatch-opts
- error!
- error-signal?
- event!
- format-signal-fn
- get-env
- get-filters
- get-handlers
- get-min-level
- handler:console
- handler:file
- help:filters
- help:handlers
- help:signal-content
- help:signal-creators
- help:signal-filters
- help:signal-flow
- help:signal-handlers
- help:signal-options
- level-aliases
- log!
- msg-skip
- msg-splice
- newline
- pr-signal-fn
- rate-limiter
- remove-handler!
- set-ctx!
- set-id-filter!
- set-kind-filter!
- set-middleware!
- set-min-level!
- set-ns-filter!
- set-var-root!
- shut-down-handlers!
- signal!
- spy!
- streams->reset!
- streams->telemere!
- trace!
- uncaught->error!
- uncaught->handler!
- update-var-root!
- with-ctx
- with-ctx+
- with-err->telemere
- with-handler
- with-handler+
- with-id-filter
- with-kind-filter
- with-middleware
- with-min-level
- with-ns-filter
- with-out->telemere
- with-signal
- with-signals
- with-streams->telemere
- without-filters
taoensso.telemere.open-telemetry
OpenTelemetry handler using `opentelemetry-java`, Ref. <https://github.com/open-telemetry/opentelemetry-java>.Public variables and functions:
taoensso.telemere.postal
Email handler using `postal`, Ref. <https://github.com/drewr/postal>.Public variables and functions:
taoensso.telemere.slack
Slack handler using `clj-slack`, Ref. <https://github.com/julienXX/clj-slack>Public variables and functions:
taoensso.telemere.streams
Intake support for standard stream/s -> Telemere.Public variables and functions:
taoensso.telemere.timbre
Main Timbre macros, reimplemented on top of Telemere. diff --git a/index.cljs.html b/index.cljs.html index d6e6a3f..3b9ecc7 100644 --- a/index.cljs.html +++ b/index.cljs.html @@ -1,4 +1,4 @@ -Telemere 1.0.0-beta11 Telemere 1.0.0-beta11
Released under the Eclipse Public License - v 1.0
Structured telemetry library for Clojure/Script.
Installation
To install, add the following dependency to your project or build file:
[com.taoensso/telemere "1.0.0-beta11"]Namespaces
taoensso.telemere
Structured telemetry for Clojure/Script applications.Public variables and functions:
- *ctx*
- *middleware*
- add-handler!
- catch->error!
- chance
- comp-middleware
- default-ctx
- error!
- error-signal?
- event!
- format-signal-fn
- get-env
- get-filters
- get-handlers
- get-min-level
- handler:console
- handler:console-raw
- help:filters
- help:handlers
- help:signal-content
- help:signal-creators
- help:signal-filters
- help:signal-flow
- help:signal-handlers
- help:signal-options
- level-aliases
- log!
- msg-skip
- msg-splice
- newline
- pr-signal-fn
- rate-limiter
- remove-handler!
- set-ctx!
- set-id-filter!
- set-kind-filter!
- set-middleware!
- set-min-level!
- set-ns-filter!
- set-var-root!
- shut-down-handlers!
- signal!
- spy!
- trace!
- uncaught->error!
- update-var-root!
- with-ctx
- with-ctx+
- with-err->telemere
- with-handler
- with-handler+
- with-id-filter
- with-kind-filter
- with-middleware
- with-min-level
- with-ns-filter
- with-out->telemere
- with-signal
- with-signals
- with-streams->telemere
- without-filters
taoensso.telemere.timbre
Main Timbre macros, reimplemented on top of Telemere. +Telemere 1.0.0-beta12 \ No newline at end of file diff --git a/index.html b/index.html index 3a01730..f946763 100644 --- a/index.html +++ b/index.html @@ -1,3 +1,3 @@ -Telemere 1.0.0-beta12
Released under the Eclipse Public License - v 1.0
Structured telemetry library for Clojure/Script.
Installation
To install, add the following dependency to your project or build file:
[com.taoensso/telemere "1.0.0-beta12"]Namespaces
taoensso.telemere
Structured telemetry for Clojure/Script applications.Public variables and functions:
- *ctx*
- *middleware*
- add-handler!
- catch->error!
- chance
- comp-middleware
- default-ctx
- default-handler-dispatch-opts
- error!
- error-signal?
- event!
- format-signal-fn
- get-env
- get-filters
- get-handlers
- get-min-level
- handler:console
- handler:console-raw
- help:filters
- help:handlers
- help:signal-content
- help:signal-creators
- help:signal-filters
- help:signal-flow
- help:signal-handlers
- help:signal-options
- level-aliases
- log!
- msg-skip
- msg-splice
- newline
- pr-signal-fn
- rate-limiter
- remove-handler!
- set-ctx!
- set-id-filter!
- set-kind-filter!
- set-middleware!
- set-min-level!
- set-ns-filter!
- set-var-root!
- shut-down-handlers!
- signal!
- spy!
- trace!
- uncaught->error!
- update-var-root!
- with-ctx
- with-ctx+
- with-err->telemere
- with-handler
- with-handler+
- with-id-filter
- with-kind-filter
- with-middleware
- with-min-level
- with-ns-filter
- with-out->telemere
- with-signal
- with-signals
- with-streams->telemere
- without-filters
taoensso.telemere.timbre
Main Timbre macros, reimplemented on top of Telemere. Intended to help ease migration from Timbre to Telemere.Public variables and functions:
taoensso.telemere.utils
Misc utils useful for Telemere handlers, middleware, etc.Public variables and functions:
Telemere 1.0.0-beta11 \ No newline at end of file +Telemere 1.0.0-beta11
Released under the Eclipse Public License - v 1.0
Structured telemetry library for Clojure/Script.
Installation
To install, add the following dependency to your project or build file:
[com.taoensso/telemere "1.0.0-beta11"]Platforms
This project includes code for multiple platforms, please choose a platform to view its documentation:
Telemere 1.0.0-beta12 \ No newline at end of file diff --git a/taoensso.telemere.cljs.html b/taoensso.telemere.cljs.html index b5d72ad..a748283 100644 --- a/taoensso.telemere.cljs.html +++ b/taoensso.telemere.cljs.html @@ -1,6 +1,6 @@ -Telemere 1.0.0-beta12
Released under the Eclipse Public License - v 1.0
Structured telemetry library for Clojure/Script.
Installation
To install, add the following dependency to your project or build file:
[com.taoensso/telemere "1.0.0-beta12"]Platforms
This project includes code for multiple platforms, please choose a platform to view its documentation:
taoensso.telemere documentation taoensso.telemere
Structured telemetry for Clojure/Script applications. +taoensso.telemere documentation taoensso.telemere
Structured telemetry for Clojure/Script applications. See the GitHub page (esp. Wiki) for info on motivation and design: <https://www.taoensso.com/telemere>*ctx*
dynamic
clj
cljs
Dynamic context: arbitrary user-level state attached as `:ctx` to all signals. @@ -25,12 +25,12 @@ Modify root (base) value using `set-middleware!`.error!
macro
clj
cljs
(error! error)(error! id error)(error! {:as opts, :keys [elidable? location inst uid middleware sample-rate kind ns id level when rate-limit ctx parent trace? do let data msg error & kvs]} error)"Error" signal creator, emphasizing error + id. +See `get-env` for details.error!
macro
clj
cljs
(error! error)(error! id error)(error! {:as opts, :keys [elidable? location inst uid middleware sample-rate kind ns id level when rate-limit ctx parent trace? do let data msg error & kvs]} error)"Error" signal creator, emphasizing error + id. API: [error] [id-or-opts error] => given error (unconditional) Default kind: `:error` @@ -840,8 +841,14 @@ See also `set-var-root!`.with-err->telemere
macro
clj
cljs
(with-err->telemere form)(with-err->telemere opts form)Executes form with `*err*` bound to flush to Telemere signals with given opts.with-handler
macro
clj
cljs
(with-handler handler-id handler-fn dispatch-opts form)Executes form with ONLY the given handler-fn registered. -Useful for tests/debugging. See also `with-handler+`.with-handler+
macro
clj
cljs
(with-handler+ handler-id handler-fn dispatch-opts form)Executes form with the given handler-fn registered. -Useful for tests/debugging. See also `with-handler`.with-id-filter
macro
clj
cljs
(with-id-filter id-filter form)Executes form with given signal call id filter in effect. +Useful for tests/debugging. + +See `add-handler!` for info on `dispatch-opts`. +See also `with-handler+`.with-handler+
macro
clj
cljs
(with-handler+ handler-id handler-fn dispatch-opts form)Executes form with the given handler-fn registered. +Useful for tests/debugging. + +See `add-handler!` for info on `dispatch-opts`. +See also `with-handler`.with-id-filter
macro
clj
cljs
(with-id-filter id-filter form)Executes form with given signal call id filter in effect. See `set-id-filter!` for details.with-kind-filter
macro
clj
cljs
(with-kind-filter kind-filter form)Executes form with given signal call kind filter in effect. See `set-kind-filter!` for details.with-middleware
macro
clj
cljs
(with-middleware ?middleware-fn form)Evaluates given form with given `*middleware*` value. See `*middleware*` for details.with-min-level
macro
clj
cljs
(with-min-level min-level form)(with-min-level kind min-level form)(with-min-level kind ns-filter min-level form)Executes form with given minimum signal call level in effect. diff --git a/taoensso.telemere.html b/taoensso.telemere.html index 5d927a0..4a2dc38 100644 --- a/taoensso.telemere.html +++ b/taoensso.telemere.html @@ -1,6 +1,6 @@ -taoensso.telemere documentation taoensso.telemere
Structured telemetry for Clojure/Script applications. +taoensso.telemere documentation taoensso.telemere
Structured telemetry for Clojure/Script applications. See the GitHub page (esp. Wiki) for info on motivation and design: <https://www.taoensso.com/telemere>*ctx*
dynamic
clj
cljs
Dynamic context: arbitrary user-level state attached as `:ctx` to all signals. @@ -25,12 +25,12 @@ Modify root (base) value using `set-middleware!`.error!
macro
clj
cljs
(error! error)(error! id error)(error! {:as opts, :keys [elidable? location inst uid middleware sample-rate kind ns id level when rate-limit ctx parent trace? do let data msg error & kvs]} error)"Error" signal creator, emphasizing error + id. +See `get-env` for details.default-handler-dispatch-opts
clj
cljs
Default `add-handler!` dispatch options. +See `add-handler!` docstring for details.error!
macro
clj
cljs
(error! error)(error! id error)(error! {:as opts, :keys [elidable? location inst uid middleware sample-rate kind ns id level when rate-limit ctx parent trace? do let data msg error & kvs]} error)"Error" signal creator, emphasizing error + id. API: [error] [id-or-opts error] => given error (unconditional) Default kind: `:error` @@ -302,7 +304,7 @@ TIP!: Use the {:return :explain} option in tests or at the REPL to verify/inspec resulting config value, config source, and specific search order of prop/env/res ids.get-handlers
clj
cljs
(get-handlers)Returns ?{<handler-id> {:keys [dispatch-opts handler-fn]}} for all registered signal handlers.get-min-level
clj
cljs
(get-min-level)(get-min-level kind)(get-min-level kind ns)Returns current ?{:keys [compile-time runtime]} minimum levels. -handler:console
clj
cljs
(handler:console)(handler:console {:keys [output-fn stream], :or {output-fn (utils/format-signal-fn)}})Experimental, subject to change. +handler:console
clj
cljs
(handler:console)(handler:console {:keys [stream output-fn], :or {stream :auto, output-fn (utils/format-signal-fn)}})Experimental, subject to change. Returns a (fn handler [signal]) that: - Takes a Telemere signal (map). @@ -836,7 +838,7 @@ Examples: - {:allow <spec> :deny <spec>} with specs as above. If present, `:allow` spec MUST match, AND If present, `:deny` spec MUST NOT match.set-var-root!
macro
clj
cljs
added in Encore v3.75.0 (2024-01-29)
(set-var-root! var-sym root-val)Sets root binding (value) of the var identified by given symbol, and returns -the new value. Cross-platform. See also `update-var-root!`.shut-down-handlers!
clj
cljs
(shut-down-handlers!)(shut-down-handlers! timeout-msecs__8469__auto__)Shuts down all registered signal handlers in parallel, and returns +the new value. Cross-platform. See also `update-var-root!`.shut-down-handlers!
clj
cljs
(shut-down-handlers!)Shuts down all registered signal handlers in parallel, and returns ?{<handler-id> {:keys [okay error]}}. Future calls to handlers will no-op. @@ -984,8 +986,14 @@ See also `set-var-root!`.with-err->telemere
macro
clj
cljs
(with-err->telemere form)(with-err->telemere opts form)Executes form with `*err*` bound to flush to Telemere signals with given opts.with-handler
macro
clj
cljs
(with-handler handler-id handler-fn dispatch-opts form)Executes form with ONLY the given handler-fn registered. -Useful for tests/debugging. See also `with-handler+`.with-handler+
macro
clj
cljs
(with-handler+ handler-id handler-fn dispatch-opts form)Executes form with the given handler-fn registered. -Useful for tests/debugging. See also `with-handler`.with-id-filter
macro
clj
cljs
(with-id-filter id-filter form)Executes form with given signal call id filter in effect. +Useful for tests/debugging. + +See `add-handler!` for info on `dispatch-opts`. +See also `with-handler+`.with-handler+
macro
clj
cljs
(with-handler+ handler-id handler-fn dispatch-opts form)Executes form with the given handler-fn registered. +Useful for tests/debugging. + +See `add-handler!` for info on `dispatch-opts`. +See also `with-handler`.with-id-filter
macro
clj
cljs
(with-id-filter id-filter form)Executes form with given signal call id filter in effect. See `set-id-filter!` for details.with-kind-filter
macro
clj
cljs
(with-kind-filter kind-filter form)Executes form with given signal call kind filter in effect. See `set-kind-filter!` for details.with-middleware
macro
clj
cljs
(with-middleware ?middleware-fn form)Evaluates given form with given `*middleware*` value. See `*middleware*` for details.with-min-level
macro
clj
cljs
(with-min-level min-level form)(with-min-level kind min-level form)(with-min-level kind ns-filter min-level form)Executes form with given minimum signal call level in effect. diff --git a/taoensso.telemere.open-telemetry.html b/taoensso.telemere.open-telemetry.html index c58b052..9acdc97 100644 --- a/taoensso.telemere.open-telemetry.html +++ b/taoensso.telemere.open-telemetry.html @@ -1,6 +1,6 @@ -taoensso.telemere.open-telemetry documentation taoensso.telemere.open-telemetry
OpenTelemetry handler using `opentelemetry-java`, +taoensso.telemere.open-telemetry documentation taoensso.telemere.open-telemetry
OpenTelemetry handler using `opentelemetry-java`, Ref. <https://github.com/open-telemetry/opentelemetry-java>.default-logger-provider
clj
(default-logger-provider)Experimental, subject to change. Feedback welcome! Returns `io.opentelemetry.api.logs.LoggerProvider` via: diff --git a/taoensso.telemere.postal.html b/taoensso.telemere.postal.html index 7567840..9a85358 100644 --- a/taoensso.telemere.postal.html +++ b/taoensso.telemere.postal.html @@ -1,6 +1,6 @@ -taoensso.telemere.postal documentation taoensso.telemere.postal
Email handler using `postal`, +taoensso.telemere.postal documentation taoensso.telemere.postal
Email handler using `postal`, Ref. <https://github.com/drewr/postal>.default-dispatch-opts
clj
handler:postal
clj
(handler:postal {:keys [conn-opts msg-opts subject-fn body-fn], :or {subject-fn (signal-subject-fn), body-fn (utils/format-signal-fn)}})Experimental, subject to change. Needs `postal`, Ref. <https://github.com/drewr/postal>. diff --git a/taoensso.telemere.slack.html b/taoensso.telemere.slack.html index ec2550a..e781148 100644 --- a/taoensso.telemere.slack.html +++ b/taoensso.telemere.slack.html @@ -1,6 +1,6 @@ -taoensso.telemere.slack documentation taoensso.telemere.slack
Slack handler using `clj-slack`, +taoensso.telemere.slack documentation taoensso.telemere.slack
Slack handler using `clj-slack`, Ref. <https://github.com/julienXX/clj-slack>default-dispatch-opts
clj
handler:slack
clj
(handler:slack {:keys [conn-opts post-opts output-fn], :or {conn-opts {:api-url "https://slack.com/api", :token nil}, post-opts {:channel-id nil, :username nil}, output-fn (utils/format-signal-fn)}})Experimental, subject to change. Needs `clj-slack`, Ref. <https://github.com/julienXX/clj-slack>. diff --git a/taoensso.telemere.sockets.html b/taoensso.telemere.sockets.html index 8988b56..407f423 100644 --- a/taoensso.telemere.sockets.html +++ b/taoensso.telemere.sockets.html @@ -1,6 +1,6 @@ -taoensso.telemere.sockets documentation taoensso.telemere.sockets
Basic TCP/UDP socket handlers. +taoensso.telemere.sockets documentation taoensso.telemere.sockets
Basic TCP/UDP socket handlers.handler:tcp-socket
clj
(handler:tcp-socket {:keys [socket-opts output-fn], :or {output-fn (utils/format-signal-fn)}})Experimental, subject to change. Returns a (fn handler [signal]) that: diff --git a/taoensso.telemere.streams.html b/taoensso.telemere.streams.html index bf91e1b..7db2199 100644 --- a/taoensso.telemere.streams.html +++ b/taoensso.telemere.streams.html @@ -1,6 +1,6 @@ -taoensso.telemere.streams documentation taoensso.telemere.streams
Intake support for standard stream/s -> Telemere. +taoensso.telemere.streams documentation taoensso.telemere.streams
Intake support for standard stream/s -> Telemere.check-err-intake
clj
(check-err-intake)Returns {:keys [sending->telemere? telemere-receiving?]}.check-out-intake
clj
(check-out-intake)Returns {:keys [sending->telemere? telemere-receiving?]}.streams->reset!
clj
(streams->reset!)Experimental, subject to change. diff --git a/taoensso.telemere.timbre.cljs.html b/taoensso.telemere.timbre.cljs.html index 8e60c6d..4161b06 100644 --- a/taoensso.telemere.timbre.cljs.html +++ b/taoensso.telemere.timbre.cljs.html @@ -1,6 +1,6 @@ -taoensso.telemere.timbre documentation taoensso.telemere.timbre
Main Timbre macros, reimplemented on top of Telemere. +taoensso.telemere.timbre documentation \ No newline at end of file diff --git a/taoensso.telemere.timbre.html b/taoensso.telemere.timbre.html index 7044820..f3809af 100644 --- a/taoensso.telemere.timbre.html +++ b/taoensso.telemere.timbre.html @@ -1,6 +1,6 @@ -taoensso.telemere.timbre
Main Timbre macros, reimplemented on top of Telemere. Intended to help ease migration from Timbre to Telemere.taoensso.telemere.timbre documentation taoensso.telemere.timbre
Main Timbre macros, reimplemented on top of Telemere. +taoensso.telemere.timbre documentation taoensso.telemere.timbre
Main Timbre macros, reimplemented on top of Telemere. Intended to help ease migration from Timbre to Telemere.debug
macro
clj
(debug & args)Prefer `telemere/log!`, etc.debugf
macro
clj
(debugf & args)Prefer `telemere/log!`, etc.error
macro
clj
(error & args)Prefer `telemere/log!`, etc. diff --git a/taoensso.telemere.tools-logging.html b/taoensso.telemere.tools-logging.html index 3f23754..3956809 100644 --- a/taoensso.telemere.tools-logging.html +++ b/taoensso.telemere.tools-logging.html @@ -1,6 +1,6 @@ -taoensso.telemere.tools-logging documentation taoensso.telemere.tools-logging
Intake support for `clojure.tools.logging` -> Telemere. +taoensso.telemere.tools-logging documentation taoensso.telemere.tools-logging
Intake support for `clojure.tools.logging` -> Telemere. Telemere will attempt to load this ns automatically when possible.check-intake
clj
(check-intake)Returns {:keys [present? sending->telemere? telemere-receiving?]}.tools-logging->telemere!
clj
(tools-logging->telemere!)Configures `clojure.tools.logging` to use Telemere as its logging implementation. diff --git a/taoensso.telemere.utils.cljs.html b/taoensso.telemere.utils.cljs.html index 1a1b924..faf2732 100644 --- a/taoensso.telemere.utils.cljs.html +++ b/taoensso.telemere.utils.cljs.html @@ -1,6 +1,6 @@ -taoensso.telemere.utils documentation taoensso.telemere.utils
Misc utils useful for Telemere handlers, middleware, etc. +taoensso.telemere.utils documentation taoensso.telemere.utils
Misc utils useful for Telemere handlers, middleware, etc.error-signal?
clj
cljs
(error-signal? signal)Experimental, subject to change. Returns true iff given signal has an `:error` value, or a `:kind` or `:level` that indicates that it's an error.format-error-fn
clj
cljs
(format-error-fn)(format-error-fn {:as _opts})Experimental, subject to change. diff --git a/taoensso.telemere.utils.html b/taoensso.telemere.utils.html index 87fb042..2e028b6 100644 --- a/taoensso.telemere.utils.html +++ b/taoensso.telemere.utils.html @@ -1,6 +1,6 @@ -taoensso.telemere.utils documentation taoensso.telemere.utils
Misc utils useful for Telemere handlers, middleware, etc. +taoensso.telemere.utils documentation taoensso.telemere.utils
Misc utils useful for Telemere handlers, middleware, etc.error-signal?
clj
cljs
(error-signal? signal)Experimental, subject to change. Returns true iff given signal has an `:error` value, or a `:kind` or `:level` that indicates that it's an error.file-writer
clj
(file-writer {:keys [file append?], :or {append? true}})Experimental, subject to change.