Liking cljdoc? Tell your friends :D

fx.observability.telemetry

Non-intrusive event taps, interceptors, and telemetry sink routing for fx effect pipelines.

Non-intrusive event taps, interceptors, and telemetry sink routing for fx effect pipelines.
raw docstring

emit-telemetry!clj/s

(emit-telemetry! context-or-sinks event)

Dispatches a telemetry-event map to all registered sinks in context-or-sinks.

Dispatches a `telemetry-event` map to all registered sinks in `context-or-sinks`.
raw docstring

tap-telemetry-event>clj/s

(tap-telemetry-event> event-type)
(tap-telemetry-event> event-type-or-prev data-or-type)
(tap-telemetry-event> prev-effect event-type data)

Emits a custom one-shot telemetry event map to registered telemetry sinks in context.

Example: (-> (fx/succeed> {:status :ready}) (fx.observability.telemetry/tap-telemetry-event> :service/ready {:details "Initialized"}))

Emits a custom one-shot telemetry event map to registered telemetry sinks in context.

Example:
  (-> (fx/succeed> {:status :ready})
      (fx.observability.telemetry/tap-telemetry-event> :service/ready {:details "Initialized"}))
raw docstring

tap-telemetry>clj/s

(tap-telemetry> event-type eff)
(tap-telemetry> event-type-or-prev eff-or-type meta-or-eff)
(tap-telemetry> prev-effect event-type eff meta-data)

Observes execution of effect, emitting structured telemetry events with timing and outcome status to registered sinks without altering values or failure channels.

Example: (fx.observability.telemetry/tap-telemetry> :http/request {:route "/items"} (fetch-items>))

Observes execution of `effect`, emitting structured telemetry events with timing
and outcome status to registered sinks without altering values or failure channels.

Example:
  (fx.observability.telemetry/tap-telemetry> :http/request {:route "/items"} (fetch-items>))
raw docstring

telemetry-sink-layer>clj/s

(telemetry-sink-layer> sink-fn)
(telemetry-sink-layer> sink-fn & more-sinks)

Creates a Layer providing :fx.observability/telemetry-sinks.

Creates a Layer providing `:fx.observability/telemetry-sinks`.
raw docstring

with-telemetry-sink>clj/s

(with-telemetry-sink> sink-fn-or-eff eff-or-sink-fn)
(with-telemetry-sink> prev-effect sink-fn target-eff)

Registers a telemetry sink-fn (fn [event-map] ...) scoped to effect.

Example: (fx.observability.telemetry/with-telemetry-sink> (fn [e] (prn e)) (work>))

Registers a telemetry `sink-fn` `(fn [event-map] ...)` scoped to `effect`.

Example:
  (fx.observability.telemetry/with-telemetry-sink> (fn [e] (prn e)) (work>))
raw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close