Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://clojure.github.io/tools.logging/ below:

clojure.tools.logging - tools.logging 1.2.5-SNAPSHOT API documentation

Full namespace name:

Logging macros which delegate to a specific logging implementation.

A logging implementation is selected at runtime when this namespace is first
loaded. For more details, see the documentation for *logger-factory*.

If you want to test that your code emits specific log messages, see the
clojure.tools.logging.test namespace.

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

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.

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

Usage: (log-stream level logger-ns)

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

Usage: (log-uncapture!)

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

Protocols used to allow access to logging implementations.
This namespace only need be used by those providing logging
implementations to be consumed by the core api.

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.

Known implementations:

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.

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.

Known implementations:

Usage: (get-logger factory logger-ns)

Returns an implementation-specific Logger by namespace.

Usage: (name factory)

Returns some text identifying the underlying implementation.

Usage: (cl-factory)

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

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.

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

A LoggerFactory that always provides the disabled-logger.

Usage: (find-factory)

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

Usage: (jul-factory)

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

Usage: (log4j-factory)

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

Usage: (log4j2-factory)

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

Usage: (slf4j-factory)

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

Logging macros that support printing message (some) arguments as
if wrapped in pr-str, the goal being to preserve their data representation
distinct from the explanatory text. See logp and logf for details regarding
which args are treated in this manner.

Examples:

(require '[clojure.tools.logging :as log]
         '[clojure.tools.logging.readable :as logr])

(def x "bar")
                                  ; Logged as...
(log/debug "foo" x "baz")         ; foo bar baz
(logr/debug "foo" x "baz")        ; foo "bar" baz
(log/debugf "foo %s %s" x "baz")  ; foo bar baz
(logr/debugf "foo %s %s" x "baz") ; foo "bar" "baz"

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

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

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

Debug level logging using format. See logf for details.

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

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

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

Error level logging using format. See logf for details.

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

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

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

Fatal level logging using format. See logf for details.

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

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

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

Info level logging using format. See logf for details.

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.

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.

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.

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

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

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

Trace level logging using format. See logf for details.

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

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

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

Warn level logging using format. See logf for details.

Support for testing whether logging calls are made.

Usage example:
  (require '[clojure.tools.logging :as log]
           '[clojure.tools.logging.test :refer [logged? with-log])

  (with-log
    (log/info "Hello World!")
    (log/error (Exception. "Did a thing") "Error: oops")
    (logged? 'user :info #"Hello")                           ; true
    (logged? 'user :error [Throwable #"thing"] #"Error:")    ; true
    (logged? 'user :debug "Hi"))                             ; false

Known implementations:

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.

Fields:

Protocols:

Interfaces:

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

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

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

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!

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).

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.

Usage: (map->LogEntry m#)

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

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

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

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

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

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).

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).

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4