From 49431a2af651c9eee5dd2bd79b57a733d009c5b1 Mon Sep 17 00:00:00 2001 From: Peter Taoussanis Date: Wed, 4 Dec 2013 16:49:19 +0700 Subject: [PATCH] v3.0.0-RC2 --- index.html | 6 +++--- taoensso.timbre.appenders.carmine.html | 4 ++-- taoensso.timbre.appenders.postal.html | 4 ++-- taoensso.timbre.appenders.rotor.html | 2 +- taoensso.timbre.html | 29 ++++++++++++++++---------- taoensso.timbre.profiling.html | 2 +- taoensso.timbre.tools.logging.html | 2 +- taoensso.timbre.utils.html | 2 +- 8 files changed, 29 insertions(+), 22 deletions(-) diff --git a/index.html b/index.html index 1ab4f58..42b1757 100644 --- a/index.html +++ b/index.html @@ -1,7 +1,7 @@ -Timbre 3.0.0-RC1 API documentation

Timbre 3.0.0-RC1 API documentation

Clojure logging & profiling library

taoensso.timbre

Simple, flexible, all-Clojure logging. No XML!
-

Public variables and functions:

taoensso.timbre.appenders.carmine

Carmine (Redis) appender. Requires https://github.com/ptaoussanis/carmine.
-

Public variables and functions:

taoensso.timbre.appenders.postal

Email appender. Requires https://github.com/drewr/postal.
+Timbre 3.0.0-RC2 API documentation
Timbre 3.0.0-RC2 API documentation
Clojure logging & profiling library
taoensso.timbre
Simple, flexible, all-Clojure logging. No XML!
+
Public variables and functions:
taoensso.timbre.appenders.carmine
Carmine (Redis) appender. Requires https://github.com/ptaoussanis/carmine.
+
Public variables and functions:
taoensso.timbre.appenders.postal
Email appender. Requires https://github.com/drewr/postal.
 
Public variables and functions:
taoensso.timbre.appenders.rotor
Public variables and functions:
taoensso.timbre.profiling
Logging profiler for Timbre, adapted from clojure.contrib.profile.
 
Public variables and functions:
taoensso.timbre.tools.logging
clojure.tools.logging.impl/Logger implementation
 
Public variables and functions:
taoensso.timbre.utils
Public variables and functions:

\ No newline at end of file
diff --git a/taoensso.timbre.appenders.carmine.html b/taoensso.timbre.appenders.carmine.html
index f60b342..5e2ab39 100644
--- a/taoensso.timbre.appenders.carmine.html
+++ b/taoensso.timbre.appenders.carmine.html
@@ -1,6 +1,6 @@
 
-taoensso.timbre.appenders.carmine documentation
taoensso.timbre.appenders.carmine documentation
Carmine (Redis) appender. Requires https://github.com/ptaoussanis/carmine.
-
default-entry-hash-fn
(default-entry-hash-fn {:keys [hostname ns args], :as apfn-args})
default-keyfn
(default-keyfn level)
make-carmine-appender
(make-carmine-appender & [appender-opts {:keys [conn keyfn entry-hash-fn nentries-by-level], :or {keyfn default-keyfn, entry-hash-fn default-entry-hash-fn, nentries-by-level {:trace 50, :debug 50, :info 50, :warn 100, :error 100, :fatal 100, :report 100}}}])
Alpha - subject to change!
+taoensso.timbre.appenders.carmine documentation
taoensso.timbre.appenders.carmine documentation
Carmine (Redis) appender. Requires https://github.com/ptaoussanis/carmine.
+
default-keyfn
(default-keyfn level)
make-carmine-appender
(make-carmine-appender & [appender-opts {:keys [conn keyfn args-hash-fn nentries-by-level], :or {keyfn default-keyfn, args-hash-fn timbre/default-args-hash-fn, nentries-by-level {:trace 50, :debug 50, :info 50, :warn 100, :error 100, :fatal 100, :report 100}}}])
Alpha - subject to change!
 Returns a Carmine Redis appender:
  * All raw logging args are preserved in serialized form (even Throwables!).
  * Only the most recent instance of each unique entry is kept (hash fn used
diff --git a/taoensso.timbre.appenders.postal.html b/taoensso.timbre.appenders.postal.html
index e6204bd..9ecbde9 100644
--- a/taoensso.timbre.appenders.postal.html
+++ b/taoensso.timbre.appenders.postal.html
@@ -1,6 +1,6 @@
 
-taoensso.timbre.appenders.postal documentation
taoensso.timbre.appenders.postal documentation
Email appender. Requires https://github.com/drewr/postal.
-
make-postal-appender
(make-postal-appender & [appender-opts {:keys [postal-config subject-len], :or {subject-len 150}}])
Returns a Postal email appender.
+taoensso.timbre.appenders.postal documentation
taoensso.timbre.appenders.postal documentation
Email appender. Requires https://github.com/drewr/postal.
+
make-postal-appender
(make-postal-appender & [appender-opts {:keys [postal-config subject-len body-fn], :or {subject-len 150, body-fn (fn [output] [{:type "text/plain; charset=utf-8", :content output}])}}])
Returns a Postal email appender.
 A Postal config map can be provided here as an argument, or as a :postal key
 in :shared-appender-config.
 
diff --git a/taoensso.timbre.appenders.rotor.html b/taoensso.timbre.appenders.rotor.html
index c339ca6..34ec365 100644
--- a/taoensso.timbre.appenders.rotor.html
+++ b/taoensso.timbre.appenders.rotor.html
@@ -1,2 +1,2 @@
 
-taoensso.timbre.appenders.rotor documentation
taoensso.timbre.appenders.rotor documentation
appender-fn
(appender-fn {:keys [ap-config prefix throwable message]})
rotor-appender

\ No newline at end of file
+taoensso.timbre.appenders.rotor documentation
taoensso.timbre.appenders.rotor documentation
appender-fn
(appender-fn {:keys [ap-config prefix throwable message]})
rotor-appender

\ No newline at end of file
diff --git a/taoensso.timbre.html b/taoensso.timbre.html
index 632927b..5913ac2 100644
--- a/taoensso.timbre.html
+++ b/taoensso.timbre.html
@@ -1,10 +1,16 @@
 
-taoensso.timbre documentation
taoensso.timbre documentation
Simple, flexible, all-Clojure logging. No XML!
-
*level-dynamic*
color-str
(color-str color & xs)
compile-config
Returns {:appenders-juxt {<level> <wrapped-juxt or nil>}
-:ns-filter      (fn relevant-ns? [ns])}.
config
debug
macro
(debug & message)(debug throwable & message)
Logs at :debug level using print-style args.
+taoensso.timbre documentation
taoensso.timbre documentation
Simple, flexible, all-Clojure logging. No XML!
+
*level-dynamic*
color-str
(color-str color & xs)
compile-config
Implementation detail.
+Returns {:appenders-juxt {<level> <wrapped-juxt or nil>}
+         :ns-filter      (fn relevant-ns? [ns])}.
config
debug
macro
(debug & message)(debug throwable & message)
Logs at :debug level using print-style args.
 
debugf
macro
(debugf fmt & fmt-args)(debugf throwable fmt & fmt-args)
Logs at :debug level using format-style args.
-
default-err
default-out
error
macro
(error & message)(error throwable & message)
Logs at :error level using print-style args.
-
error-level?
(error-level? level)
errorf
macro
(errorf fmt & fmt-args)(errorf throwable fmt & fmt-args)
Logs at :error level using format-style args.
+
default-args-hash-fn
(default-args-hash-fn {:keys [hostname ns args], :as apfn-args})
Alpha - subject to change!!
+Returns a hash identifier for given appender arguments in such a way that
+(= (hash args-A) (hash args-B)) iff arguments A and B are "the same" by
+some reasonable-in-the-general-case definition for logging arguments.
+
+Useful in the context of rate limiting, deduplicating appenders, etc.
default-err
default-fmt-output-fn
(default-fmt-output-fn {:keys [level throwable message timestamp hostname ns]} & [{:keys [nofonts?], :as appender-fmt-output-opts}])
default-out
error
macro
(error & message)(error throwable & message)
Logs at :error level using print-style args.
+
errorf
macro
(errorf fmt & fmt-args)(errorf throwable fmt & fmt-args)
Logs at :error level using format-style args.
 
example-config
APPENDERS
    An appender is a map with keys:
     :doc             ; (Optional) string.
@@ -14,6 +20,7 @@
     :rate-limit      ; (Optional) [ncalls-limit window-ms].
     :fmt-output-opts ; (Optional) extra opts passed to `fmt-output-fn`.
     :fn              ; (fn [appender-args-map]), with keys described below.
+    :args-hash-fn    ; Experimental. Used by rate-limiter, etc.
 
    An appender's fn takes a single map with keys:
     :level         ; Keyword.
@@ -47,14 +54,14 @@ See also `set-config!`, `merge-config!`, `set-level!`.
infof
macro
(infof fmt & fmt-args)(infof throwable fmt & fmt-args)
Logs at :info level using format-style args.
 
level-atom
level-compile-time
Constant, compile-time logging level determined by the `TIMBRE_LOG_LEVEL`
 environment variable. When set, overrules dynamically-configurable logging
-level as a performance optimization (e.g. for use in performance sensitive
-production environments).
level-sufficient?
(level-sufficient? level)
levels-ordered
log
macro
(log level & message)(log level throwable & message)(log config level & message)(log config level throwable & message)
Logs using print-style args. Takes optional logging config (defaults to
+level as a performance optimization.
level-sufficient?
(level-sufficient? level config)
Precendence: compile-time > dynamic > config > atom.
+
levels-ordered
levels-scored
log
macro
(log level & message)(log level throwable & message)(log config level & message)(log config level throwable & message)
Logs using print-style args. Takes optional logging config (defaults to
 `timbre/@config`.)
log*
macro
(log* base-appender-args msg-type level & log-args)(log* base-appender-args msg-type config level & log-args)
Implementation detail.
 
log-and-rethrow-errors
macro
(log-and-rethrow-errors & body)
log-errors
macro
(log-errors & body)
logf
macro
(logf level fmt & fmt-args)(logf level throwable fmt & fmt-args)(logf config level fmt & fmt-args)(logf config level throwable fmt & fmt-args)
Logs using format-style args. Takes optional logging config (defaults to
-`timbre/@config`.)
logged-future
macro
(logged-future & body)
logging-enabled?
macro
(logging-enabled? level & [config])
Returns true iff current logging level is sufficient and current namespace
-unfiltered. The namespace test is runtime, the logging-level test compile-time
-iff a compile-time logging level was specified.
logp
macro
(logp level & message)(logp level throwable & message)
DEPRECATED: Use `log` instead.
-
merge-config!
(merge-config! & maps)
red
DEPRECATED: Use `color-str` instead.
+`timbre/@config`.)
logged-future
macro
(logged-future & body)
logging-enabled?
(logging-enabled? level)
For 3rd-party utils, etc.
+
logp
macro
(logp level & message)(logp level throwable & message)
DEPRECATED: Use `log` instead.
+
make-timestamp-fn
(make-timestamp-fn pattern locale)
Returns a unary fn that formats instants using given pattern string and an
+optional Locale.
merge-config!
(merge-config! & maps)
ns-unfiltered?
(ns-unfiltered? config & [ns])
red
DEPRECATED: Use `color-str` instead.
 
refer-timbre
(refer-timbre)
Shorthand for:
 (require
   '[taoensso.timbre :as timbre
diff --git a/taoensso.timbre.profiling.html b/taoensso.timbre.profiling.html
index 138b4ea..2e9c22b 100644
--- a/taoensso.timbre.profiling.html
+++ b/taoensso.timbre.profiling.html
@@ -1,5 +1,5 @@
 
-taoensso.timbre.profiling documentation
taoensso.timbre.profiling documentation
Logging profiler for Timbre, adapted from clojure.contrib.profile.
+taoensso.timbre.profiling documentation
taoensso.timbre.profiling documentation
Logging profiler for Timbre, adapted from clojure.contrib.profile.
 
*pdata*
{::pname [time1 time2 ...]}
 
defnp
macro
(defnp name doc-string? attr-map? [params] prepost-map? body)
Like `defn` but wraps body in `p` macro.
 
format-pdata
(format-pdata stats & [sort-field])
p
macro
(p name & body)
pdata-stats
(pdata-stats pdata)
{::pname [time1 time2 ...] ...} => {::pname {:min <min-time> ...} ...}
diff --git a/taoensso.timbre.tools.logging.html b/taoensso.timbre.tools.logging.html
index 7cd38fd..b0cbb08 100644
--- a/taoensso.timbre.tools.logging.html
+++ b/taoensso.timbre.tools.logging.html
@@ -1,5 +1,5 @@
 
-taoensso.timbre.tools.logging documentation
taoensso.timbre.tools.logging documentation
clojure.tools.logging.impl/Logger implementation
+taoensso.timbre.tools.logging documentation
taoensso.timbre.tools.logging documentation
clojure.tools.logging.impl/Logger implementation
 
->Logger
(->Logger logger-ns)
Positional factory function for class taoensso.timbre.tools.logging.Logger.
 
->LoggerFactory
(->LoggerFactory)
Positional factory function for class taoensso.timbre.tools.logging.LoggerFactory.
 
use-timbre
(use-timbre)

\ No newline at end of file
diff --git a/taoensso.timbre.utils.html b/taoensso.timbre.utils.html
index e69e032..00b9fc2 100644
--- a/taoensso.timbre.utils.html
+++ b/taoensso.timbre.utils.html
@@ -1,5 +1,5 @@
 
-taoensso.timbre.utils documentation
taoensso.timbre.utils documentation
defonce*
macro
(defonce* name expr)
Like `clojure.core/defonce` but supports optional docstring and attributes
+taoensso.timbre.utils documentation
taoensso.timbre.utils documentation
defonce*
macro
(defonce* name expr)
Like `clojure.core/defonce` but supports optional docstring and attributes
 map for name symbol.
fq-keyword
macro
(fq-keyword name)
Returns namespaced keyword for given name.
 
memoize-ttl
(memoize-ttl ttl-ms f)
Low-overhead, common-case `memoize*`.
 
merge-deep
merge-deep-with
(merge-deep-with f & maps)
Like `merge-with` but merges maps recursively, applying the given fn