From cdb344edb80b9e682501003d9b3afc23b713d4a7 Mon Sep 17 00:00:00 2001 From: Peter Taoussanis Date: Wed, 10 Apr 2024 18:41:24 +0200 Subject: [PATCH] v1.0.0-alpha4 (2024-04-10) --- index.clj.html | 4 ++-- index.cljs.html | 2 +- index.html | 2 +- taoensso.telemere.cljs.html | 15 ++++++++++----- taoensso.telemere.html | 15 ++++++++++----- taoensso.telemere.timbre.cljs.html | 4 ++++ taoensso.telemere.timbre.html | 28 ++++++++++++++++++++++++++++ taoensso.telemere.utils.cljs.html | 8 ++++---- taoensso.telemere.utils.html | 6 +++--- 9 files changed, 63 insertions(+), 21 deletions(-) create mode 100644 taoensso.telemere.timbre.cljs.html create mode 100644 taoensso.telemere.timbre.html diff --git a/index.clj.html b/index.clj.html index 094c84a..809515d 100644 --- a/index.clj.html +++ b/index.clj.html @@ -1,4 +1,4 @@ -Telemere 1.0.0-alpha3

Namespaces

Telemere 1.0.0-alpha3

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

Namespaces

taoensso.telemere

Structured telemetry for Clojure/Script applications.

Public variables and functions:

taoensso.telemere.timbre-shim

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:

\ No newline at end of file +Telemere 1.0.0-alpha4

Namespaces

Telemere 1.0.0-alpha4

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

Namespaces

taoensso.telemere

Structured telemetry for Clojure/Script applications.

Public variables and functions:

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:

\ No newline at end of file diff --git a/index.cljs.html b/index.cljs.html index 50ed56f..ce61ce7 100644 --- a/index.cljs.html +++ b/index.cljs.html @@ -1,4 +1,4 @@ -Telemere 1.0.0-alpha3

Namespaces

Telemere 1.0.0-alpha3

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

Namespaces

taoensso.telemere

Structured telemetry for Clojure/Script applications.

Public variables and functions:

taoensso.telemere.timbre-shim

Main Timbre macros, reimplemented on top of Telemere.
+Telemere 1.0.0-alpha4
Namespaces
Telemere 1.0.0-alpha4
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-alpha4"]
Namespaces
taoensso.telemere
Structured telemetry for Clojure/Script applications.
Public variables and functions:
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:
    
\ No newline at end of file
diff --git a/index.html b/index.html
index 34015de..3972a89 100644
--- a/index.html
+++ b/index.html
@@ -1,3 +1,3 @@
 
-Telemere 1.0.0-alpha3
    Platforms
    Telemere 1.0.0-alpha3
    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-alpha3"]
    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-alpha4
    Platforms
    Telemere 1.0.0-alpha4
    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-alpha4"]
    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 4514bd8..88dafc9 100644
--- a/taoensso.telemere.cljs.html
+++ b/taoensso.telemere.cljs.html
@@ -1,6 +1,6 @@
 
-taoensso.telemere documentation
    Namespaces
    Public Vars
    taoensso.telemere
    Structured telemetry for Clojure/Script applications.
+taoensso.telemere documentation
    Namespaces
    Public Vars
    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.
@@ -305,9 +305,10 @@ See also:
 If anything is unclear, please ping me (@ptaoussanis) so that I can
 improve these docs!
    help:handlers
    clj
    cljs
    The handler API consists of the following:
 
-  `get-handlers`    - Returns info on currently registered handlers
-  `add-handler!`    - Used to   register handlers
-  `remove-handler!` - Used to unregister handlers
+  `get-handlers`        - Returns info on currently registered handlers
+  `add-handler!`        - Used to   register handlers
+  `remove-handler!`     - Used to unregister handlers
+  `shut-down-handlers!` - Used to shut down  handlers
 
 See the relevant docstrings for details.
 
@@ -499,7 +500,11 @@ will apply only for that signal kind.
    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!`.
    signal!
    macro
    clj
    cljs
    (signal! {: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 run & extra-kvs]})
    Low-level generic signal call.
+the new value. Cross-platform. See also `update-var-root!`.
    shut-down-handlers!
    clj
    cljs
    (shut-down-handlers!)
    Shuts down all registered signal handlers and returns
+?{<handler-id> {:keys [okay error]}}.
+
+Future calls to handlers will no-op.
+Clj only: `shut-down-handlers!` is called automatically on JVM shutdown.
    signal!
    macro
    clj
    cljs
    (signal! {: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 run & extra-kvs]})
    Low-level generic signal call.
 
 API: [opts] => depends on options [3]
 Default  kind: none (optional)
diff --git a/taoensso.telemere.html b/taoensso.telemere.html
index 358b36c..95057fb 100644
--- a/taoensso.telemere.html
+++ b/taoensso.telemere.html
@@ -1,6 +1,6 @@
 
-taoensso.telemere documentation
    Namespaces
    Public Vars
    taoensso.telemere
    Structured telemetry for Clojure/Script applications.
+taoensso.telemere documentation
    Namespaces
    Public Vars
    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.
@@ -331,9 +331,10 @@ See also:
 If anything is unclear, please ping me (@ptaoussanis) so that I can
 improve these docs!
    help:handlers
    clj
    cljs
    The handler API consists of the following:
 
-  `get-handlers`    - Returns info on currently registered handlers
-  `add-handler!`    - Used to   register handlers
-  `remove-handler!` - Used to unregister handlers
+  `get-handlers`        - Returns info on currently registered handlers
+  `add-handler!`        - Used to   register handlers
+  `remove-handler!`     - Used to unregister handlers
+  `shut-down-handlers!` - Used to shut down  handlers
 
 See the relevant docstrings for details.
 
@@ -533,7 +534,11 @@ will apply only for that signal kind.
    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!`.
    signal!
    macro
    clj
    cljs
    (signal! {: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 run & extra-kvs]})
    Low-level generic signal call.
+the new value. Cross-platform. See also `update-var-root!`.
    shut-down-handlers!
    clj
    cljs
    (shut-down-handlers!)(shut-down-handlers! timeout-msecs__9291__auto__)
    Shuts down all registered signal handlers and returns
+?{<handler-id> {:keys [okay error]}}.
+
+Future calls to handlers will no-op.
+Clj only: `shut-down-handlers!` is called automatically on JVM shutdown.
    signal!
    macro
    clj
    cljs
    (signal! {: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 run & extra-kvs]})
    Low-level generic signal call.
 
 API: [opts] => depends on options [3]
 Default  kind: none (optional)
diff --git a/taoensso.telemere.timbre.cljs.html b/taoensso.telemere.timbre.cljs.html
new file mode 100644
index 0000000..5b2496f
--- /dev/null
+++ b/taoensso.telemere.timbre.cljs.html
@@ -0,0 +1,4 @@
+
+taoensso.telemere.timbre documentation
    Namespaces
    Public Vars
      taoensso.telemere.timbre
      Main Timbre macros, reimplemented on top of Telemere.
+Intended to help ease migration from Timbre to Telemere.
      
\ No newline at end of file
diff --git a/taoensso.telemere.timbre.html b/taoensso.telemere.timbre.html
new file mode 100644
index 0000000..baf1cc0
--- /dev/null
+++ b/taoensso.telemere.timbre.html
@@ -0,0 +1,28 @@
+
+taoensso.telemere.timbre documentation
      Namespaces
      Public Vars
      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.
+
      errorf
      macro
      clj
      (errorf & args)
      Prefer `telemere/log!`, etc.
+
      fatal
      macro
      clj
      (fatal & args)
      Prefer `telemere/log!`, etc.
+
      fatalf
      macro
      clj
      (fatalf & args)
      Prefer `telemere/log!`, etc.
+
      info
      macro
      clj
      (info & args)
      Prefer `telemere/log!`, etc.
+
      infof
      macro
      clj
      (infof & args)
      Prefer `telemere/log!`, etc.
+
      log
      macro
      clj
      (log level & args)
      Prefer `telemere/log!`, etc.
+
      log-and-rethrow-errors
      macro
      clj
      (log-and-rethrow-errors & body)
      Prefer `telemere/catch->error!`.
+
      log-errors
      macro
      clj
      (log-errors & body)
      Prefer `telemere/catch->error!`.
+
      logf
      macro
      clj
      (logf level & args)
      Prefer `telemere/log!`, etc.
+
      logged-future
      macro
      clj
      (logged-future & body)
      Prefer `telemere/catch->error!`.
+
      refer-timbre
      macro
      clj
      (refer-timbre)
      (require
+'[taoensso.telemere.timbre :as timbre :refer
+  [log  trace  debug  info  warn  error  fatal  report
+   logf tracef debugf infof warnf errorf fatalf reportf
+   spy]])
      report
      macro
      clj
      (report & args)
      Prefer `telemere/log!`, etc.
+
      reportf
      macro
      clj
      (reportf & args)
      Prefer `telemere/log!`, etc.
+
      spy!
      macro
      clj
      (spy! form)(spy! level form)(spy! level form-name form)
      Prefer `telemere/spy!`.
+
      trace
      macro
      clj
      (trace & args)
      Prefer `telemere/log!`, etc.
+
      tracef
      macro
      clj
      (tracef & args)
      Prefer `telemere/log!`, etc.
+
      warn
      macro
      clj
      (warn & args)
      Prefer `telemere/log!`, etc.
+
      warnf
      macro
      clj
      (warnf & args)
      Prefer `telemere/log!`, etc.
+
      
\ No newline at end of file
diff --git a/taoensso.telemere.utils.cljs.html b/taoensso.telemere.utils.cljs.html
index 619eb14..8b22089 100644
--- a/taoensso.telemere.utils.cljs.html
+++ b/taoensso.telemere.utils.cljs.html
@@ -1,6 +1,6 @@
 
-taoensso.telemere.utils documentation
      Namespaces
      Public Vars
      taoensso.telemere.utils
      Misc utils useful for Telemere handlers, middleware, etc.
+taoensso.telemere.utils documentation
      Namespaces
      Public Vars
      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.
@@ -10,14 +10,14 @@ 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:
   - Takes a platform error (`Throwable` or `js/Error`).
-  - Returns a formatted human-readable string
      format-inst-fn
      clj
      cljs
      added in Encore vX.Y.Z (YYYY-MM-DD)
      (format-inst-fn)(format-inst-fn {:keys [formatter]})
      Experimental, subject to change without notice.
+  - Returns a formatted human-readable string
      format-inst-fn
      clj
      cljs
      added in Encore v3.98.0 (2024-04-08)
      (format-inst-fn)(format-inst-fn {:keys [formatter]})
      Experimental, subject to change without notice.
 
 Returns a (fn format [instant]) that:
   - Takes a platform instant (`java.time.Instant` or `js/Date`).
   - Returns a formatted human-readable string.
 
 Options:
-  `:zone` (Clj only) - `java.time.ZoneOffset` (defaults to UTC).
+  `:zone` (Clj only) `java.time.ZoneOffset` (defaults to UTC).
   `:formatter`
     `java.time.format.DateTimeFormatter` (Clj) or
     `goog.i18n.DateTimeFormat` (Cljs),
@@ -54,5 +54,5 @@ Returns minimal signal map, removing:
 
 Useful when serializing signals to edn/JSON/etc.
      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 vX.Y.Z (YYYY-MM-DD)
      (pr-json x)
      Returns given Cljs argument as JSON string.
+
      pr-json
      cljs
      added in Encore v3.98.0 (2024-04-08)
      (pr-json x)
      Returns given Cljs argument as JSON string.
 
      
\ No newline at end of file
diff --git a/taoensso.telemere.utils.html b/taoensso.telemere.utils.html
index 12faf75..7a8fa61 100644
--- a/taoensso.telemere.utils.html
+++ b/taoensso.telemere.utils.html
@@ -1,6 +1,6 @@
 
-taoensso.telemere.utils documentation
      Namespaces
      Public Vars
      taoensso.telemere.utils
      Misc utils useful for Telemere handlers, middleware, etc.
+taoensso.telemere.utils documentation
      Namespaces
      Public Vars
      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.
@@ -19,14 +19,14 @@ Writers MUST ALWAYS be manually closed after use!
 Useful for handlers that write to files, etc.
      format-error-fn
      clj
      cljs
      (format-error-fn)(format-error-fn {:as _opts})
      Experimental, subject to change.
 Returns a (fn format [error]) that:
   - Takes a platform error (`Throwable` or `js/Error`).
-  - Returns a formatted human-readable string
      format-inst-fn
      clj
      cljs
      added in Encore vX.Y.Z (YYYY-MM-DD)
      (format-inst-fn)(format-inst-fn {:keys [formatter zone], :or {formatter java.time.format.DateTimeFormatter/ISO_INSTANT, zone java.time.ZoneOffset/UTC}})
      Experimental, subject to change without notice.
+  - Returns a formatted human-readable string
      format-inst-fn
      clj
      cljs
      added in Encore v3.98.0 (2024-04-08)
      (format-inst-fn)(format-inst-fn {:keys [formatter zone], :or {formatter java.time.format.DateTimeFormatter/ISO_INSTANT, zone java.time.ZoneOffset/UTC}})
      Experimental, subject to change without notice.
 
 Returns a (fn format [instant]) that:
   - Takes a platform instant (`java.time.Instant` or `js/Date`).
   - Returns a formatted human-readable string.
 
 Options:
-  `:zone` (Clj only) - `java.time.ZoneOffset` (defaults to UTC).
+  `:zone` (Clj only) `java.time.ZoneOffset` (defaults to UTC).
   `:formatter`
     `java.time.format.DateTimeFormatter` (Clj) or
     `goog.i18n.DateTimeFormat` (Cljs),