Source

rotor /

Filename Size Date modified Message
src/com/postspectacular
test/timbre_filelogger
123 B
24 B
2.0 KB
385 B

rotor

A simple rotating log file appender for Clojure. Has no dependencies, but is designed to work with Timbre, a new Clojure logging library.

Leiningen coordinates

[com.postspectacular/rotor "0.1.0"]

Usage

The main rotor namespace provides a function append, which should be attached as an appender to Timbre's config map:

(ns user
  (:require
    [taoensso.timbre :as t]
    [com.postspectacular.rotor :as r]))

(t/set-config!
  [:appenders :rotor]
  {:doc "Writes to to (:path (:rotor :shared-appender-config)) file
         and creates optional backups."
   :min-level :info
   :enabled? true
   :async? false ; should be always false for rotor
   :max-message-per-msecs nil
   :fn r/append})

The appender itself can then be configured like this:

(t/set-config!
  [:shared-appender-config :rotor]
  {:path "logs/app.log" :max-size (* 512 1024) :backlog 5})

Only the :path arg is mandatory and can be a relative or absolute path (any parent dirs must be existing & writable). The :max-size and :backlog args default to the values shown above: 512KB limit and backlog of 5 files...

Once the log file's size limit has been reached, log rotation is triggered up to :backlog files. These backups are suffixed with a 3-digit index, with larger numbers indicating older age, e.g.

logs/app.log     => current log file
logs/app.log.001 => most recent log file
logs/app.log.002 => second most recent log file etc.

If the max number of files has been reached, the oldest one will be deleted. In future, there will be a suffix fn to customize the naming of archived logs.

Any IOExceptions occuring during logging will be silently ignored.

License

Copyright © 2012 Karsten Schmidt // PostSpectacular Ltd.

Distributed under the Eclipse Public License, the same as Clojure.