steffan-westcott.clj-otel.api.logs.log-record — com.github.steffan-westcott/clj-otel-api 0.2.11-SNAPSHOT

Functions for emitting log records. IMPORTANT: This namespace is for use by logging libraries only. To add logging to an application or general library, use a logging library that has OpenTelemetry log signal support instead e.g. Log4j2, Timbre.

emit clj

(emit {:keys [context thread]
       :or {context (context/dyn) thread (Thread/currentThread)}
       :as opts})

Emits a log record immediately or adds to a queue of delayed emits if not initialized. See also initialize.

IMPORTANT: This function is for use by logging libraries only. To add logging to an application or general library, use a logging library that has OpenTelemetry log signal support instead e.g. Log4j2, Timbre.

Takes an option map as below. The defaults for :context and :thread may be suitable only if emit is evaluated synchronously when the log record occurs.

key	description
:logger	Either io.opentelemetry.api.logs.Logger, get-logger option map or logger name string (default: default logger, as set by set-default-logger!; if no default logger has been set, one will be set with default config).
:context	Context of the log record. If nil, use the root context (default: bound or current context).
:severity	^io.opentelemetry.api.logs.Severity or keyword :traceN, :debugN, :infoN, :warnN, :errorN, :fatalN where N is nothing or 2, 3, 4 (default: nil).
:severity-text	Short name of log record severity (default: nil).
:body	Body of log record; may be string, keyword, boolean, long, double, byte array, map or seqable coll. Body may have nested structure. Keywords and map keys are transformed to strings (default: nil).
:attributes	Map of additional attributes for the log record (default: no attributes).
:exception	Exception to attach to log record. Exception details are merged with the :attributes value (default: nil).
:thread	Thread where the log record occurred, or nil for no thread. Thread details are merged with the :attributes value (default: current thread).
:timestamp	Timestamp for when the log record occurred. Value is either an Instant or vector [amount ^TimeUnit unit] (default: nil).
:observed-timestamp	Timestamp for when the log record was observed by OpenTelemetry; may be later than :timestamp for asynchronous processing. Value is either an Instant or vector [amount ^TimeUnit unit] (default: current timestamp).
:source	Map describing source code where log record occurred. Optional keys are :fn, :line, :col and :file (default: nil).
:event-name	If not nil, a string event name. An event name identifies this log record as an event with specific structure of :body and :attributes (default: nil).

get-logger clj

(get-logger)

(get-logger {:keys [name version schema-url open-telemetry]
             :or {name (:name default-library)
                  version (:version default-library)
                  schema-url (:schema-url default-library)}})

Builds and returns a io.opentelemetry.api.logs.Logger instance. May take an option map as follows:

key	description
:name	Name of the instrumentation library, not the instrumented library e.g. "io.opentelemetry.contrib.mongodb" (default: See config.edn resource file).
:version	Instrumentation library version e.g. "1.0.0" (default: See config.edn resource file).
:schema-url	URL of OpenTelemetry schema used by this instrumentation library (default: See config.edn resource file).
:open-telemetry	OpenTelemetry instance to get logger from (default: default OpenTelemetry instance).

initialize clj

(initialize)

Process delayed emits, then ensure future emits are processed immediately.

This fn should be evaluated as soon as the default or global OpenTelemetry instance has been initialized. Emits issued beforehand are added to a queue of delayed emits.

noop-logger clj

(noop-logger)

Gets a no-op logger.

set-default-logger! clj

(set-default-logger! logger)

Sets the default io.opentelemetry.api.logs.Logger instance used when creating log records. Returns logger. See also get-logger.