diff --git a/index.clj.html b/index.clj.html index 882eca2..c1a9361 100644 --- a/index.clj.html +++ b/index.clj.html @@ -1,8 +1,8 @@ -Telemere 1.0.0-beta10

Telemere 1.0.0-beta10

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-beta10"]

Namespaces

taoensso.telemere

Structured telemetry for Clojure/Script applications.

taoensso.telemere.open-telemetry

OpenTelemetry handler using `opentelemetry-java`,
+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.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.sockets

Basic TCP/UDP socket handlers.

Public variables and functions:

taoensso.telemere.tools-logging

Intake support for `clojure.tools.logging` -> Telemere.
-Telemere will attempt to load this ns automatically when possible.
\ No newline at end of file +Telemere will attempt to load this ns automatically when possible.

taoensso.telemere.utils

Misc utils useful for Telemere handlers, middleware, etc.
\ No newline at end of file diff --git a/index.cljs.html b/index.cljs.html index 5b8c68d..d6e6a3f 100644 --- a/index.cljs.html +++ b/index.cljs.html @@ -1,4 +1,4 @@ -Telemere 1.0.0-beta10

Telemere 1.0.0-beta10

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-beta10"]

Namespaces

taoensso.telemere

Structured telemetry for Clojure/Script applications.

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.
\ No newline at end of file +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.

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.
\ No newline at end of file diff --git a/index.html b/index.html index 7673bff..3a01730 100644 --- a/index.html +++ b/index.html @@ -1,3 +1,3 @@ -Telemere 1.0.0-beta10

Telemere 1.0.0-beta10

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-beta10"]

Platforms

This project includes code for multiple platforms, please choose a platform to view its documentation:

\ No newline at end of file +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"]

Platforms

This project includes code for multiple platforms, please choose a platform to view its documentation:

\ No newline at end of file diff --git a/taoensso.telemere.cljs.html b/taoensso.telemere.cljs.html index 5915ea3..b5d72ad 100644 --- a/taoensso.telemere.cljs.html +++ b/taoensso.telemere.cljs.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.
@@ -50,10 +50,10 @@ Dispatch options include:
      NB handling order may be non-sequential when `n-threads` > 1.
 
      Default:
-       {:mode :dropping, :buffer-size 1024, :n-threads 1, :daemon-threads? true}
+       {:mode :blocking, :buffer-size 1024, :n-threads 1, :daemon-threads? true}
 
-       I.e. async by default, with a buffer of size 1024 that drops new entries
-       when full.
+       I.e. async by default, with a buffer of size 1024 that blocks on new
+       entries when full.
 
      Options:
        `mode`        - Mode of operation, ∈ #{:sync :blocking :dropping :sliding}.
@@ -608,23 +608,25 @@ Useful for conditionally splicing in extra message content, etc.:
   (log!          [(when <cond> (msg-splice ["Username:" "Steve"]))])
 
     %> {:msg_ "Username: Steve"}

newline

clj

cljs

added in Encore v3.68.0 (2023-09-25)

Single system newline
-

pr-signal-fn

clj

cljs

(pr-signal-fn)(pr-signal-fn {:keys [incl-thread? incl-kvs? incl-newline? pr-fn prep-fn], :or {incl-newline? true, pr-fn :edn, prep-fn (comp error-in-signal->maps minify-signal)}})
Experimental, subject to change.
+

pr-signal-fn

clj

cljs

(pr-signal-fn)(pr-signal-fn {:keys [pr-fn incl-kvs? incl-nils? incl-newline? incl-keys], :as opts, :or {pr-fn :edn, incl-newline? true}})
Experimental, subject to change.
 Returns a (fn pr [signal]) that:
   - Takes a Telemere signal (map).
-  - Returns a machine-readable (minified) signal string.
+  - Returns a machine-readable signal ?string.
 
 Options:
   `:pr-fn`         - ∈ #{<unary-fn> :edn (default) :json (Cljs only)}
-  `:incl-thread?`  - Include signal `:thread` info?      (default false)
-  `:incl-kvs?`     - Include signal `:kvs`    info?      (default false)
-  `:incl-newline?` - Include terminating system newline? (default true)
+  `:incl-kvs?`     - Include signal's user-level kvs?        (default false)
+  `:incl-nils?`    - Include signal's keys with nil values?  (default false)
+  `:incl-newline?` - Include terminating system newline?     (default true)
+  `:incl-keys`     - Subset of signal keys to retain from those otherwise
+                     excluded by default: #{:location :kvs :file :thread}
 
 Examples:
   (pr-signal-fn {:pr-fn :edn  ...}) ; Outputs edn
   (pr-signal-fn {:pr-fn :json ...}) ; Outputs JSON (Cljs only)
 
   To output JSON for Clj, you must provide an appropriate `:pr-fn`.
-  `jsonista` is one good option, Ref. <https://github.com/metosin/jsonista>:
+  `jsonista` offers one good option, Ref. <https://github.com/metosin/jsonista>:
 
     (require '[jsonista.core :as jsonista])
     (pr-signal-fn {:pr-fn jsonista/write-value-as-string ...})
diff --git a/taoensso.telemere.html b/taoensso.telemere.html
index 5b55505..5d927a0 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.
@@ -50,10 +50,10 @@ Dispatch options include:
      NB handling order may be non-sequential when `n-threads` > 1.
 
      Default:
-       {:mode :dropping, :buffer-size 1024, :n-threads 1, :daemon-threads? true}
+       {:mode :blocking, :buffer-size 1024, :n-threads 1, :daemon-threads? true}
 
-       I.e. async by default, with a buffer of size 1024 that drops new entries
-       when full.
+       I.e. async by default, with a buffer of size 1024 that blocks on new
+       entries when full.
 
      Options:
        `mode`        - Mode of operation, ∈ #{:sync :blocking :dropping :sliding}.
@@ -736,23 +736,25 @@ Useful for conditionally splicing in extra message content, etc.:
   (log!          [(when <cond> (msg-splice ["Username:" "Steve"]))])
 
     %> {:msg_ "Username: Steve"}

newline

clj

cljs

added in Encore v3.68.0 (2023-09-25)

Single system newline
-

pr-signal-fn

clj

cljs

(pr-signal-fn)(pr-signal-fn {:keys [incl-thread? incl-kvs? incl-newline? pr-fn prep-fn], :or {incl-newline? true, pr-fn :edn, prep-fn (comp error-in-signal->maps minify-signal)}})
Experimental, subject to change.
+

pr-signal-fn

clj

cljs

(pr-signal-fn)(pr-signal-fn {:keys [pr-fn incl-kvs? incl-nils? incl-newline? incl-keys], :as opts, :or {pr-fn :edn, incl-newline? true}})
Experimental, subject to change.
 Returns a (fn pr [signal]) that:
   - Takes a Telemere signal (map).
-  - Returns a machine-readable (minified) signal string.
+  - Returns a machine-readable signal ?string.
 
 Options:
   `:pr-fn`         - ∈ #{<unary-fn> :edn (default) :json (Cljs only)}
-  `:incl-thread?`  - Include signal `:thread` info?      (default false)
-  `:incl-kvs?`     - Include signal `:kvs`    info?      (default false)
-  `:incl-newline?` - Include terminating system newline? (default true)
+  `:incl-kvs?`     - Include signal's user-level kvs?        (default false)
+  `:incl-nils?`    - Include signal's keys with nil values?  (default false)
+  `:incl-newline?` - Include terminating system newline?     (default true)
+  `:incl-keys`     - Subset of signal keys to retain from those otherwise
+                     excluded by default: #{:location :kvs :file :thread}
 
 Examples:
   (pr-signal-fn {:pr-fn :edn  ...}) ; Outputs edn
   (pr-signal-fn {:pr-fn :json ...}) ; Outputs JSON (Cljs only)
 
   To output JSON for Clj, you must provide an appropriate `:pr-fn`.
-  `jsonista` is one good option, Ref. <https://github.com/metosin/jsonista>:
+  `jsonista` offers one good option, Ref. <https://github.com/metosin/jsonista>:
 
     (require '[jsonista.core :as jsonista])
     (pr-signal-fn {:pr-fn jsonista/write-value-as-string ...})
diff --git a/taoensso.telemere.open-telemetry.html b/taoensso.telemere.open-telemetry.html
index 89c7cb0..c58b052 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 fa23cd6..7567840 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 f3ebeaa..ec2550a 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 76eca6f..8988b56 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 98bbdb8..bf91e1b 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 752fc90..8e60c6d 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

taoensso.telemere.timbre

Main Timbre macros, reimplemented on top of Telemere.
 Intended to help ease migration from Timbre to Telemere.

set-min-level!

clj

cljs

(set-min-level! min-level)
Prefer `telemere/set-min-level!`.
 

shutdown-appenders!

clj

cljs

(shutdown-appenders!)
Prefer `telemere/shut-down-handlers!`.
 
\ No newline at end of file diff --git a/taoensso.telemere.timbre.html b/taoensso.telemere.timbre.html index 3f2a5c0..7044820 100644 --- a/taoensso.telemere.timbre.html +++ b/taoensso.telemere.timbre.html @@ -1,6 +1,6 @@ -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 3b6f4cf..3f23754 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 e20887d..1a1b924 100644
--- a/taoensso.telemere.utils.cljs.html
+++ b/taoensso.telemere.utils.cljs.html
@@ -1,11 +1,7 @@
 
-taoensso.telemere.utils documentation

taoensso.telemere.utils

Misc utils useful for Telemere handlers, middleware, etc.
-

error-in-signal->maps

clj

cljs

(error-in-signal->maps signal)
Experimental, subject to change.
-Returns given signal with possible `:error` replaced by
-[{:keys [type msg data]} ...] cause chain.
-
-Useful when serializing signals to edn/JSON/etc.

error-signal?

clj

cljs

(error-signal? signal)
Experimental, subject to change.
+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.
 Returns a (fn format [error]) that:
@@ -42,45 +38,41 @@ See also `pr-signal-fn` for machine-readable output.

minify-signal

clj

cljs

(minify-signal signal)
Experimental, subject to change.
-Returns minimal signal, removing:
-  - Keys with nil values, and
-  - Keys with redundant values (`:kvs`, `:location`, `:file`).
-
-Useful when serializing signals to edn/JSON/etc.

newline

clj

cljs

added in Encore v3.68.0 (2023-09-25)

Single system newline
+NB: assumes that `js/console` exists, handler constructors should check first!

newline

clj

cljs

added in Encore v3.68.0 (2023-09-25)

Single system newline
 

pr-edn

clj

cljs

(pr-edn x)
Prints given arg to an edn string readable with `read-edn`.
 

pr-json

cljs

added in Encore v3.98.0 (2024-04-08)

(pr-json x)
Returns given Cljs argument as JSON string.
-

pr-signal-fn

clj

cljs

(pr-signal-fn)(pr-signal-fn {:keys [incl-thread? incl-kvs? incl-newline? pr-fn prep-fn], :or {incl-newline? true, pr-fn :edn, prep-fn (comp error-in-signal->maps minify-signal)}})
Experimental, subject to change.
+

pr-signal-fn

clj

cljs

(pr-signal-fn)(pr-signal-fn {:keys [pr-fn incl-kvs? incl-nils? incl-newline? incl-keys], :as opts, :or {pr-fn :edn, incl-newline? true}})
Experimental, subject to change.
 Returns a (fn pr [signal]) that:
   - Takes a Telemere signal (map).
-  - Returns a machine-readable (minified) signal string.
+  - Returns a machine-readable signal ?string.
 
 Options:
   `:pr-fn`         - ∈ #{<unary-fn> :edn (default) :json (Cljs only)}
-  `:incl-thread?`  - Include signal `:thread` info?      (default false)
-  `:incl-kvs?`     - Include signal `:kvs`    info?      (default false)
-  `:incl-newline?` - Include terminating system newline? (default true)
+  `:incl-kvs?`     - Include signal's user-level kvs?        (default false)
+  `:incl-nils?`    - Include signal's keys with nil values?  (default false)
+  `:incl-newline?` - Include terminating system newline?     (default true)
+  `:incl-keys`     - Subset of signal keys to retain from those otherwise
+                     excluded by default: #{:location :kvs :file :thread}
 
 Examples:
   (pr-signal-fn {:pr-fn :edn  ...}) ; Outputs edn
   (pr-signal-fn {:pr-fn :json ...}) ; Outputs JSON (Cljs only)
 
   To output JSON for Clj, you must provide an appropriate `:pr-fn`.
-  `jsonista` is one good option, Ref. <https://github.com/metosin/jsonista>:
+  `jsonista` offers one good option, Ref. <https://github.com/metosin/jsonista>:
 
     (require '[jsonista.core :as jsonista])
     (pr-signal-fn {:pr-fn jsonista/write-value-as-string ...})
 
-See also `format-signal-fn` for human-readable output.

remove-kvs

clj

cljs

(remove-kvs signal)
Returns given signal without user-level kvs.
-

signal-content-fn

clj

cljs

(signal-content-fn)(signal-content-fn {:keys [incl-thread? incl-kvs? raw-error? format-nsecs-fn format-error-fn], :or {format-nsecs-fn (format-nsecs-fn), format-error-fn (format-error-fn)}})
Experimental, subject to change.
+See also `format-signal-fn` for human-readable output.

signal-content-fn

clj

cljs

(signal-content-fn)(signal-content-fn {:keys [raw-error? incl-keys format-nsecs-fn format-error-fn], :or {format-nsecs-fn (format-nsecs-fn), format-error-fn (format-error-fn)}})
Experimental, subject to change.
 Returns a (fn content [signal]) that:
   - Takes a Telemere signal (map).
   - Returns a signal content ?string (incl. data, ctx, etc.).
 
 Options:
-  `:incl-thread?`    - Include signal `:thread` info? (default false)
-  `:incl-kvs?`       - Include signal `:kvs`    info? (default false)
-  `:raw-error?`      - Retain unformatted error?      (default false)
+  `:raw-error?`      - Retain unformatted error? (default false)
+  `:incl-keys`       - Subset of signal keys to retain from those
+                       otherwise excluded by default: #{:kvs :thread}
   `:format-nsecs-fn` - (fn [nanosecs]) => string.
   `:format-error-fn` - (fn [error])    => string.

signal-preamble-fn

clj

cljs

(signal-preamble-fn)(signal-preamble-fn {:keys [format-inst-fn], :or {format-inst-fn (format-inst-fn)}})
Experimental, subject to change.
 Returns a (fn preamble [signal]) that:
diff --git a/taoensso.telemere.utils.html b/taoensso.telemere.utils.html
index 3a89e15..87fb042 100644
--- a/taoensso.telemere.utils.html
+++ b/taoensso.telemere.utils.html
@@ -1,11 +1,7 @@
 
-taoensso.telemere.utils documentation

taoensso.telemere.utils

Misc utils useful for Telemere handlers, middleware, etc.
-

error-in-signal->maps

clj

cljs

(error-in-signal->maps signal)
Experimental, subject to change.
-Returns given signal with possible `:error` replaced by
-[{:keys [type msg data]} ...] cause chain.
-
-Useful when serializing signals to edn/JSON/etc.

error-signal?

clj

cljs

(error-signal? signal)
Experimental, subject to change.
+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.
 Opens the specified file and returns a stateful fn of 2 arities:
@@ -50,44 +46,40 @@ Options:
 
 See also `pr-signal-fn` for machine-readable output.

host-ip

clj

(host-ip timeout-msecs timeout-val)(host-ip)
Returns cached local host IP address string, or `timeout-val` (default "UnknownHost").
 

hostname

clj

(hostname timeout-msecs timeout-val)(hostname)
Returns cached local hostname string, or `timeout-val` (default "UnknownHost").
-

minify-signal

clj

cljs

(minify-signal signal)
Experimental, subject to change.
-Returns minimal signal, removing:
-  - Keys with nil values, and
-  - Keys with redundant values (`:kvs`, `:location`, `:file`).
-
-Useful when serializing signals to edn/JSON/etc.

newline

clj

cljs

added in Encore v3.68.0 (2023-09-25)

Single system newline
+

newline

clj

cljs

added in Encore v3.68.0 (2023-09-25)

Single system newline
 

pr-edn

clj

cljs

(pr-edn x)
Prints given arg to an edn string readable with `read-edn`.
-

pr-signal-fn

clj

cljs

(pr-signal-fn)(pr-signal-fn {:keys [incl-thread? incl-kvs? incl-newline? pr-fn prep-fn], :or {incl-newline? true, pr-fn :edn, prep-fn (comp error-in-signal->maps minify-signal)}})
Experimental, subject to change.
+

pr-signal-fn

clj

cljs

(pr-signal-fn)(pr-signal-fn {:keys [pr-fn incl-kvs? incl-nils? incl-newline? incl-keys], :as opts, :or {pr-fn :edn, incl-newline? true}})
Experimental, subject to change.
 Returns a (fn pr [signal]) that:
   - Takes a Telemere signal (map).
-  - Returns a machine-readable (minified) signal string.
+  - Returns a machine-readable signal ?string.
 
 Options:
   `:pr-fn`         - ∈ #{<unary-fn> :edn (default) :json (Cljs only)}
-  `:incl-thread?`  - Include signal `:thread` info?      (default false)
-  `:incl-kvs?`     - Include signal `:kvs`    info?      (default false)
-  `:incl-newline?` - Include terminating system newline? (default true)
+  `:incl-kvs?`     - Include signal's user-level kvs?        (default false)
+  `:incl-nils?`    - Include signal's keys with nil values?  (default false)
+  `:incl-newline?` - Include terminating system newline?     (default true)
+  `:incl-keys`     - Subset of signal keys to retain from those otherwise
+                     excluded by default: #{:location :kvs :file :thread}
 
 Examples:
   (pr-signal-fn {:pr-fn :edn  ...}) ; Outputs edn
   (pr-signal-fn {:pr-fn :json ...}) ; Outputs JSON (Cljs only)
 
   To output JSON for Clj, you must provide an appropriate `:pr-fn`.
-  `jsonista` is one good option, Ref. <https://github.com/metosin/jsonista>:
+  `jsonista` offers one good option, Ref. <https://github.com/metosin/jsonista>:
 
     (require '[jsonista.core :as jsonista])
     (pr-signal-fn {:pr-fn jsonista/write-value-as-string ...})
 
-See also `format-signal-fn` for human-readable output.

remove-kvs

clj

cljs

(remove-kvs signal)
Returns given signal without user-level kvs.
-

signal-content-fn

clj

cljs

(signal-content-fn)(signal-content-fn {:keys [incl-thread? incl-kvs? raw-error? format-nsecs-fn format-error-fn], :or {format-nsecs-fn (format-nsecs-fn), format-error-fn (format-error-fn)}})
Experimental, subject to change.
+See also `format-signal-fn` for human-readable output.

signal-content-fn

clj

cljs

(signal-content-fn)(signal-content-fn {:keys [raw-error? incl-keys format-nsecs-fn format-error-fn], :or {format-nsecs-fn (format-nsecs-fn), format-error-fn (format-error-fn)}})
Experimental, subject to change.
 Returns a (fn content [signal]) that:
   - Takes a Telemere signal (map).
   - Returns a signal content ?string (incl. data, ctx, etc.).
 
 Options:
-  `:incl-thread?`    - Include signal `:thread` info? (default false)
-  `:incl-kvs?`       - Include signal `:kvs`    info? (default false)
-  `:raw-error?`      - Retain unformatted error?      (default false)
+  `:raw-error?`      - Retain unformatted error? (default false)
+  `:incl-keys`       - Subset of signal keys to retain from those
+                       otherwise excluded by default: #{:kvs :thread}
   `:format-nsecs-fn` - (fn [nanosecs]) => string.
   `:format-error-fn` - (fn [error])    => string.

signal-preamble-fn

clj

cljs

(signal-preamble-fn)(signal-preamble-fn {:keys [format-inst-fn], :or {format-inst-fn (format-inst-fn)}})
Experimental, subject to change.
 Returns a (fn preamble [signal]) that: