Duct Simple Logger

A simple logging library for the Duct framework that's fully compatible with Integrant.

Installation

Add the following dependency to your deps.edn file:

org.duct-framework/logger.simple {:mvn/version "0.4.5"}

Or to your Leiningen project file:

[org.duct-framework/logger.simple "0.4.5"]

Usage

You can use the :duct.logger/simple logger to output logging events. This key derives from :duct/logger.

{:duct.logger/simple {:appenders [{:type :stdout}]}
 :example/hello-world {:logger #ig/ref :duct/logger}}

The logger uses the protocol from the duct.logger library:

(ns example
  (:require [duct.logger :as logger]
            [integrant.core :as ig]))

(defmethod ig/init-key ::hello-world [_ {:keys [logger]}]
  (logger/info logger ::hello-world))

The logger should have one or more appenders added to the :appenders key in the option map. These appenders are responsible for sending the logs to some output, and there's two types available:

• :stdout - logs get sent to STDOUT
• :file - logs get appended to a file

Appenders are specified as maps, and the :type key determines the type.

STDOUT logger

The STDOUT logger prints to STDOUT and supports the following options:

• :levels - a set of log levels (or :all) to limit the appender to
• :brief? - whether to omit timestamps and levels (defaults to false)

File logger

The :file appender appends logs to a file, and takes the following options:

• :levels - a set of log levels (or :all) to limit the appender to
• :path - the path of the log file

Fine-tuning

There are a number of other options for fine-tuning the logger:

• :buffer-size - the size of the logging ring buffer (default: 1024)
• :polling-rate - the delay in ms between each poll (default: 5)
• :poll-chunk-size - the max no. of logs to process each poll (default: 8)
• :shutdown-delay - the delay in ms before shutting down (default: 100)
• :shutdown-timeout - the time to wait in ms for shutdown (default: 1000)

License

Copyright © 2024 James Reeves

Distributed under the Eclipse Public License either version 1.0 or (at your option) any later version.