Liking cljdoc? Tell your friends :D

com.kroo.epilogue

Simple Clojure logging facade for logging structured data via SLF4J 2+.

Simple Clojure logging facade for logging structured data via SLF4J 2+.
raw docstring

*context*clj

Logging context. A structured alternative to the MDC that supports default values and nested contexts. (You can still use the MDC if you like.)

Everything in here in scope of the log statement will be included in the log. Try to use fully qualified keywords to avoid naming conflicts with the core log data.

Logging context.  A structured alternative to the [MDC][] that supports
default values and nested contexts.  (You can still use the MDC if you like.)

[MDC]: https://logback.qos.ch/manual/mdc.html

Everything in here in scope of the log statement will be included in the log.
Try to use fully qualified keywords to avoid naming conflicts with the core
log data.
sourceraw docstring

debugcljmacro

(debug msg data & {:keys [cause markers logger-ns]})

Log a message and accompanying data at the :debug logging level.

The log will include anything in com.kroo.epilogue/*context* within the current dynamic scope.

data can be anything that implements the clojure.core.protocols/IKVReduce protocol, but it is recommended to log only maps to avoid confusion.

Options:

  • a throwable object as the cause,
  • a sequence of SLF4J markers (or strings/keywords), and
  • an override logger namespace (logger-ns).
Log a message and accompanying data at the `:debug` logging level.

The log will include anything in `com.kroo.epilogue/*context*` within the
current dynamic scope.

`data` can be anything that implements the `clojure.core.protocols/IKVReduce`
protocol, but it is recommended to log only maps to avoid confusion.

Options:
  - a throwable object as the `cause`,
  - a sequence of SLF4J `markers` (or strings/keywords), and
  - an override logger namespace (`logger-ns`).
sourceraw docstring

defloggingmacrocljmacro

(defloggingmacro name doc-string? attr-map? [params*] body)
(defloggingmacro name doc-string? attr-map? ([params*] body) + attr-map?)

Defines a macro that preserves the original line number and column making it suitable for logging. Otherwise behaves identically to defmacro.

Defines a macro that preserves the original line number and column making it
suitable for logging.  Otherwise behaves identically to `defmacro`.
sourceraw docstring

errorcljmacro

(error msg data & {:keys [cause markers logger-ns]})

Log a message and accompanying data at the :error logging level.

The log will include anything in com.kroo.epilogue/*context* within the current dynamic scope.

data can be anything that implements the clojure.core.protocols/IKVReduce protocol, but it is recommended to log only maps to avoid confusion.

Options:

  • a throwable object as the cause,
  • a sequence of SLF4J markers (or strings/keywords), and
  • an override logger namespace (logger-ns).
Log a message and accompanying data at the `:error` logging level.

The log will include anything in `com.kroo.epilogue/*context*` within the
current dynamic scope.

`data` can be anything that implements the `clojure.core.protocols/IKVReduce`
protocol, but it is recommended to log only maps to avoid confusion.

Options:
  - a throwable object as the `cause`,
  - a sequence of SLF4J `markers` (or strings/keywords), and
  - an override logger namespace (`logger-ns`).
sourceraw docstring

infocljmacro

(info msg data & {:keys [cause markers logger-ns]})

Log a message and accompanying data at the :info logging level.

The log will include anything in com.kroo.epilogue/*context* within the current dynamic scope.

data can be anything that implements the clojure.core.protocols/IKVReduce protocol, but it is recommended to log only maps to avoid confusion.

Options:

  • a throwable object as the cause,
  • a sequence of SLF4J markers (or strings/keywords), and
  • an override logger namespace (logger-ns).
Log a message and accompanying data at the `:info` logging level.

The log will include anything in `com.kroo.epilogue/*context*` within the
current dynamic scope.

`data` can be anything that implements the `clojure.core.protocols/IKVReduce`
protocol, but it is recommended to log only maps to avoid confusion.

Options:
  - a throwable object as the `cause`,
  - a sequence of SLF4J `markers` (or strings/keywords), and
  - an override logger namespace (`logger-ns`).
sourceraw docstring

level?clj

Hashset of accepted levels.

Hashset of accepted levels.
sourceraw docstring

logcljmacro

(log level msg data & {:keys [cause markers logger-ns]})

Logs a message and accompanying data at the specified logging level.

The log will include anything in com.kroo.epilogue/*context* within the current dynamic scope.

data can be anything that implements the clojure.core.protocols/IKVReduce protocol, but it is recommended to log only maps to avoid confusion.

Options:

  • a throwable object as the cause,
  • a sequence of SLF4J markers (or strings/keywords), and
  • an override logger namespace (logger-ns).
Logs a message and accompanying data at the specified logging level.

The log will include anything in `com.kroo.epilogue/*context*` within the
current dynamic scope.

`data` can be anything that implements the `clojure.core.protocols/IKVReduce`
protocol, but it is recommended to log only maps to avoid confusion.

Options:
  - a throwable object as the `cause`,
  - a sequence of SLF4J `markers` (or strings/keywords), and
  - an override logger namespace (`logger-ns`).
sourceraw docstring

log*clj

(log* level msg data cause markers logger-ns src)

Primitive logging function for Epilogue.

Do not use this function directly! Use the provided macros instead. Backwards compatibility is not guaranteed for this function.

Primitive logging function for Epilogue.

Do not use this function directly!  Use the provided macros instead.
Backwards compatibility is not guaranteed for this function.
sourceraw docstring

raisecljmacro

(raise msg data & {:keys [level cause markers logger-ns]})

Log and throw. Logs at :error level by default. Constructs and throws a clojure.lang.ExceptionInfo object.

Log and throw.  Logs at `:error` level by default.  Constructs and throws a
`clojure.lang.ExceptionInfo` object.
sourceraw docstring

set-default-context!clj

(set-default-context! value)

Set the default value of the logging context.

Set the default value of the logging context.
sourceraw docstring

tracecljmacro

(trace msg data & {:keys [cause markers logger-ns]})

Log a message and accompanying data at the :trace logging level.

The log will include anything in com.kroo.epilogue/*context* within the current dynamic scope.

data can be anything that implements the clojure.core.protocols/IKVReduce protocol, but it is recommended to log only maps to avoid confusion.

Options:

  • a throwable object as the cause,
  • a sequence of SLF4J markers (or strings/keywords), and
  • an override logger namespace (logger-ns).
Log a message and accompanying data at the `:trace` logging level.

The log will include anything in `com.kroo.epilogue/*context*` within the
current dynamic scope.

`data` can be anything that implements the `clojure.core.protocols/IKVReduce`
protocol, but it is recommended to log only maps to avoid confusion.

Options:
  - a throwable object as the `cause`,
  - a sequence of SLF4J `markers` (or strings/keywords), and
  - an override logger namespace (`logger-ns`).
sourceraw docstring

warncljmacro

(warn msg data & {:keys [cause markers logger-ns]})

Log a message and accompanying data at the :warn logging level.

The log will include anything in com.kroo.epilogue/*context* within the current dynamic scope.

data can be anything that implements the clojure.core.protocols/IKVReduce protocol, but it is recommended to log only maps to avoid confusion.

Options:

  • a throwable object as the cause,
  • a sequence of SLF4J markers (or strings/keywords), and
  • an override logger namespace (logger-ns).
Log a message and accompanying data at the `:warn` logging level.

The log will include anything in `com.kroo.epilogue/*context*` within the
current dynamic scope.

`data` can be anything that implements the `clojure.core.protocols/IKVReduce`
protocol, but it is recommended to log only maps to avoid confusion.

Options:
  - a throwable object as the `cause`,
  - a sequence of SLF4J `markers` (or strings/keywords), and
  - an override logger namespace (`logger-ns`).
sourceraw docstring

with-contextcljmacro

(with-context extra-context & body)

Merge extra-context onto the current logging *context*, creating a new scope around body.

Merge `extra-context` onto the current logging `*context*`, creating a new
scope around `body`.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close