*force*

Overrides the default rules for choosing between logging directly or via an
agent. Defaults to nil. See log* for details.

*logger-factory*

An instance satisfying the clojure.tools.logging.impl/LoggerFactory protocol,
which allows uniform access to an underlying logging implementation.

The default value will be obtained by invoking a no-arg function named by the
"clojure.tools.logging.factory" system property, or if unset, by invoking
clojure.tools.logging.impl/find-factory.

After loading, this var can be programmatically changed to a different
LoggerFactory implementation via binding or alter-var-root.

See the various factory functions in clojure.tools.logger.impl.

*logging-agent*

The default agent used for performing logging when direct logging is
disabled. See log* for details.

*tx-agent-levels*

The set of levels that will require using an agent when logging from within a
running transaction. Defaults to #{:info :warn}. See log* for details.

debug

Usage: (debug message & more)
       (debug throwable message & more)

Debug level logging using print-style args.
Use the 'logging.readable' namespace to avoid wrapping args in pr-str.

debugf

Usage: (debugf fmt & fmt-args)
       (debugf throwable fmt & fmt-args)

Debug level logging using format.
Use the 'logging.readable' namespace to avoid wrapping args in pr-str.

enabled?

Usage: (enabled? level)
       (enabled? level logger-ns)

Returns true if the specific logging level is enabled.  Use of this macro
should only be necessary if one needs to execute alternate code paths beyond
whether the log should be written to.

error

Usage: (error message & more)
       (error throwable message & more)

Error level logging using print-style args.
Use the 'logging.readable' namespace to avoid wrapping args in pr-str.

errorf

Usage: (errorf fmt & fmt-args)
       (errorf throwable fmt & fmt-args)

Error level logging using format.
Use the 'logging.readable' namespace to avoid wrapping args in pr-str.

fatal

Usage: (fatal message & more)
       (fatal throwable message & more)

Fatal level logging using print-style args.
Use the 'logging.readable' namespace to avoid wrapping args in pr-str.

fatalf

Usage: (fatalf fmt & fmt-args)
       (fatalf throwable fmt & fmt-args)

Fatal level logging using format.
Use the 'logging.readable' namespace to avoid wrapping args in pr-str.

info

Usage: (info message & more)
       (info throwable message & more)

Info level logging using print-style args.
Use the 'logging.readable' namespace to avoid wrapping args in pr-str.

infof

Usage: (infof fmt & fmt-args)
       (infof throwable fmt & fmt-args)

Info level logging using format.
Use the 'logging.readable' namespace to avoid wrapping args in pr-str.

log

Usage: (log level message)
       (log level throwable message)
       (log logger-ns level throwable message)
       (log logger-factory logger-ns level throwable message)

Evaluates and logs a message only if the specified level is enabled. See log*
for more details.

log*

Usage: (log* logger level throwable message)

Attempts to log a message, either directly or via an agent; does not check if
the level is enabled.

For performance reasons, an agent will only be used when invoked within a
running transaction, and only for logging levels specified by
*tx-agent-levels*. This allows those entries to only be written once the
transaction commits, and are discarded if it is retried or aborted.  As
corollary, other levels (e.g., :debug, :error) will be written even from
failed transactions though at the cost of repeat messages during retries.

One can override the above by setting *force* to :direct or :agent; all
subsequent writes will be direct or via an agent, respectively.

log-capture!

Usage: (log-capture! logger-ns)
       (log-capture! logger-ns out-level err-level)

Captures System.out and System.err, piping all writes of those streams to
the log. If unspecified, levels default to :info and :error, respectively.
The specified logger-ns value will be used to namespace all log entries.

Note: use with-logs to redirect output of *out* or *err*.

Warning: if the logging implementation is configured to output to System.out
(as is the default with java.util.logging) then using this function will
result in StackOverflowException when writing to the log.

log-stream

Usage: (log-stream level logger-ns)

Creates a PrintStream that will output to the log at the specified level.

log-uncapture!

Usage: (log-uncapture!)

Restores System.out and System.err to their original values.

logf

Usage: (logf level fmt & fmt-args)
       (logf level throwable fmt & fmt-args)

Logs a message using a format string and args. Can optionally take a
throwable as its second arg. See level-specific macros, e.g., debugf.
Use the 'logging.readable' namespace to avoid wrapping args in pr-str.

logp

Usage: (logp level message & more)
       (logp level throwable message & more)

Logs a message using print style args. Can optionally take a throwable as its
second arg. See level-specific macros, e.g., debug.
Use the 'logging.readable' namespace to avoid wrapping args in pr-str.

spy

Usage: (spy expr)
       (spy level expr)

Evaluates expr and may write the form and its result to the log. Returns the
result of expr. Defaults to :debug log level.

spyf

Usage: (spyf fmt expr)
       (spyf level fmt expr)

Evaluates expr and may write (format fmt result) to the log. Returns the
result of expr. Defaults to :debug log level.
Use the 'logging.readable' namespace to avoid wrapping args in pr-str.

trace

Usage: (trace message & more)
       (trace throwable message & more)

Trace level logging using print-style args.
Use the 'logging.readable' namespace to avoid wrapping args in pr-str.

tracef

Usage: (tracef fmt & fmt-args)
       (tracef throwable fmt & fmt-args)

Trace level logging using format.
Use the 'logging.readable' namespace to avoid wrapping args in pr-str.

warn

Usage: (warn message & more)
       (warn throwable message & more)

Warn level logging using print-style args.
Use the 'logging.readable' namespace to avoid wrapping args in pr-str.

warnf

Usage: (warnf fmt & fmt-args)
       (warnf throwable fmt & fmt-args)

Warn level logging using format.
Use the 'logging.readable' namespace to avoid wrapping args in pr-str.

with-logs

Usage: (with-logs logger-ns & body)
       (with-logs [logger-ns out-level err-level] & body)

Evaluates exprs in a context in which *out* and *err* write to the log. The
specified logger-ns value will be used to namespace all log entries.

By default *out* and *err* write to :info and :error, respectively.

Logger

The protocol through which the core api will interact with an underlying logging
implementation.  Implementations should at least support the six standard
logging levels if they wish to work from the level-specific macros.

Usage: (enabled? logger level)

Check if a particular level is enabled for the given Logger.

Usage: (write! logger level throwable message)

Writes a log message to the given Logger.

LoggerFactory

The protocol through which the core api will obtain an instance satisfying Logger
as well as providing information about the particular implementation being used.
Implementations should be bound to *logger-factory* in order to be picked up by
this library.

Usage: (get-logger factory logger-ns)

Returns an implementation-specific Logger by namespace.

Usage: (name factory)

Returns some text identifying the underlying implementation.

cl-factory

Usage: (cl-factory)

Returns a Commons Logging-based implementation of the LoggerFactory protocol, or
nil if not available.

class-found?

Usage: (class-found? name)

Returns true if the Class associated with the given classname can be found
using the context ClassLoader for the current thread.

disabled-logger

A Logger that is not enabled and does nothing on write.

disabled-logger-factory

A LoggerFactory that always provides the disabled-logger.

find-factory

Usage: (find-factory)

Returns the first non-nil value from slf4j-factory, cl-factory,
log4j2-factory, log4j-factory, and jul-factory.

jul-factory

Usage: (jul-factory)

Returns a java.util.logging-based implementation of the LoggerFactory protocol,
or nil if not available.

log4j-factory

Usage: (log4j-factory)

Returns a Log4j-based implementation of the LoggerFactory protocol, or nil if
not available.

log4j2-factory

Usage: (log4j2-factory)

Returns a Log4j2-based implementation of the LoggerFactory protocol, or nil if
not available.

slf4j-factory

Usage: (slf4j-factory)

Returns a SLF4J-based implementation of the LoggerFactory protocol, or nil if
not available.

debug

Usage: (debug message & more)
       (debug throwable message & more)

Debug level logging using print-style args. See logp for details.

debugf

Usage: (debugf fmt & fmt-args)
       (debugf throwable fmt & fmt-args)

Debug level logging using format. See logf for details.

error

Usage: (error message & more)
       (error throwable message & more)

Error level logging using print-style args. See logp for details.

errorf

Usage: (errorf fmt & fmt-args)
       (errorf throwable fmt & fmt-args)

Error level logging using format. See logf for details.

fatal

Usage: (fatal message & more)
       (fatal throwable message & more)

Fatal level logging using print-style args. See logp for details.

fatalf

Usage: (fatalf fmt & fmt-args)
       (fatalf throwable fmt & fmt-args)

Fatal level logging using format. See logf for details.

info

Usage: (info message & more)
       (info throwable message & more)

Info level logging using print-style args. See logp for details.

infof

Usage: (infof fmt & fmt-args)
       (infof throwable fmt & fmt-args)

Info level logging using format. See logf for details.

logf

Usage: (logf level fmt & fmt-args)
       (logf level throwable fmt & fmt-args)

Logs a message using a format string and args, where all format args will be
printed readably, as if wrapped in pr-str. Can optionally take a throwable as
its second arg. See level-specific macros, e.g., debugf.

logp

Usage: (logp level message & more)
       (logp level throwable message & more)

Logs a message using print style args, where message args that are not
literal strings will be printed readably, as if wrapped in pr-str. Can
optionally take a throwable as its second arg. See level-specific macros,
e.g., debug.

spyf

Usage: (spyf fmt expr)
       (spyf level fmt expr)

Evaluates expr and may write (logf level fmt result) to the log. Returns the
result of expr. Defaults to :debug log level.

trace

Usage: (trace message & more)
       (trace throwable message & more)

Trace level logging using print-style args. See logp for details.

tracef

Usage: (tracef fmt & fmt-args)
       (tracef throwable fmt & fmt-args)

Trace level logging using format. See logf for details.

warn

Usage: (warn message & more)
       (warn throwable message & more)

Warn level logging using print-style args. See logp for details.

warnf

Usage: (warnf fmt & fmt-args)
       (warnf throwable fmt & fmt-args)

Warn level logging using format. See logf for details.

StatefulLog

Usage: (append! this logger-ns level throwable message)

Returns this log with a new log entry appended.

Usage: (entries this)

Returns a vector of the entries in this log, oldest first.

LogEntry

*stateful-log*

The instance of StatefulLog used by with-log. By default unbound.

->LogEntry

Usage: (->LogEntry logger-ns level throwable message)

Positional factory function for class clojure.tools.logging.test.LogEntry.

atomic-log

Usage: (atomic-log log-entry-fn)

Returns a StatefulLog, appending to an atom the result of invoking
log-entry-fn with the same args as append!

logged?

Usage: (logged? logger-ns level message)
       (logged? logger-ns level throwable message)

Returns true if the log contains matching entries. See match-logger-ns?,
match-level?, match-throwable?, and match-message? for the default matching
behavior applied to the given args.

Must be invoked within a context where *stateful-log* is bound to an instance
of StatefulLog containing MatchableLogEntry items (e.g., inside with-log).

logger-factory

Usage: (logger-factory stateful-log enabled-pred)

Returns a LoggerFactory that will append log entries to stateful-log. Levels
are enabled when (enabled-pred logger-ns level) is true.

map->LogEntry

Usage: (map->LogEntry m#)

Factory function for class clojure.tools.logging.test.LogEntry, taking a map of keywords to field values.

match-level?

No usage documentation available

Returns true if expected matches the actual level. Used by
LogEntry/matches? implementation.

Dispatches on the types of expected and actual.

Provided methods' dispatch values and matching:
  :default      if equal
  [Fn Object]   if (f actual) is logically true
  [Set Object]  if set contains actual

match-logger-ns?

No usage documentation available

Returns true if expected matches the actual namespace. Used by
LogEntry/matches? implementation.

Dispatches on the types of expected and actual.

Provided methods' dispatch values and matching:
  :default            if equal
  [Fn Object]         if (f actual) is logically true
  [String Namespace]  if string equals namespace's string
  [Symbol Namespace]  if symbol equals namespace's symbol

match-message?

No usage documentation available

Returns true if expected matches the actual message. Used by
LogEntry/matches? implementation.

Dispatches on the types of expected and actual.

Provided methods' dispatch values and matching:
  :default          if equal
  [Fn Object]       if (f actual) is logically true
  [Pattern String]  if pattern matches actual

match-throwable?

No usage documentation available

Returns true if expected matches the actual throwable. Used by
LogEntry/matches? implementation.

Dispatches on the types of expected and actual. If expected is a vector, will
instead use a vector of the contained types.

Provided methods' dispatch values and matching:
  :default                     if equal
  [Fn Object]                  if (f actual) is logically true
  [Class Object]               if actual is an instance of Class
  [[Class String] Throwable]   ... and if string equals exception message
  [[Class Pattern] Throwable]  ... and if pattern matches exception message

matches

Usage: (matches logger-ns level message)
       (matches logger-ns level throwable message)

Returns matching log entries, otherwise nil. See match-logger-ns?,
match-level?, match-throwable?, and match-message? for the default matching
behavior applied to the given args.

Must be invoked within a context where *stateful-log* is bound to an instance
of StatefulLog containing MatchableLogEntry items (e.g., inside with-log).

the-log

Usage: (the-log)

Returns the vector of current log entries.

Must be invoked within a context where *stateful-log* is bound to an instance
of StatefulLog containing MatchableLogEntry items (e.g., inside with-log).