From 7e832c3215f5a7416306d50a998c5593d0728f7c Mon Sep 17 00:00:00 2001 From: Peter Taoussanis Date: Sun, 26 Jun 2016 13:25:41 +0700 Subject: [PATCH] v4.5.0 --- index.html | 10 +-- taoensso.timbre.appenders.3rd-party.gelf.html | 2 +- ...nsso.timbre.appenders.3rd-party.irclj.html | 8 +++ ...timbre.appenders.3rd-party.postgresql.html | 2 +- ...so.timbre.appenders.3rd-party.rolling.html | 2 +- ...nsso.timbre.appenders.3rd-party.rotor.html | 2 +- ...nsso.timbre.appenders.3rd-party.slack.html | 2 +- taoensso.timbre.appenders.carmine.html | 28 ++++---- taoensso.timbre.appenders.core.html | 4 +- taoensso.timbre.appenders.example.html | 4 +- taoensso.timbre.appenders.postal.html | 4 +- taoensso.timbre.html | 68 +++++++++---------- taoensso.timbre.profiling.html | 31 ++++----- taoensso.timbre.tools.logging.html | 2 +- 14 files changed, 87 insertions(+), 82 deletions(-) create mode 100644 taoensso.timbre.appenders.3rd-party.irclj.html diff --git a/index.html b/index.html index a182dff..6a4bfc2 100644 --- a/index.html +++ b/index.html @@ -1,8 +1,10 @@ -Timbre 4.4.0

Project

Namespaces

Timbre 4.4.0

Pure Clojure/Script logging library.

Installation

To install, add the following dependency to your project or build file:

[com.taoensso/timbre "4.4.0"]

Namespaces

taoensso.timbre

Simple, flexible logging for Clojure/Script. No XML.

Public variables and functions:

taoensso.timbre.appenders.3rd-party.gelf

Appender to handle sending messages in the gelf format to a centralized
-logging server (e.g. Graylog)

Public variables and functions:

taoensso.timbre.appenders.3rd-party.postgresql

JDBC PostgreSQL database appender.
+Timbre 4.5.0
Project
Namespaces
Timbre 4.5.0
Pure Clojure/Script logging library.
Installation
To install, add the following dependency to your project or build file:
[com.taoensso/timbre "4.5.0"]
Namespaces
taoensso.timbre
Simple, flexible logging for Clojure/Script. No XML.
Public variables and functions:
taoensso.timbre.appenders.3rd-party.gelf
Appender to handle sending messages in the gelf format to a centralized
+logging server (e.g. Graylog)
Public variables and functions:
taoensso.timbre.appenders.3rd-party.irclj
IRC appender. Requires https://github.com/flatland/irclj.
Public variables and functions:
taoensso.timbre.appenders.3rd-party.postgresql
JDBC PostgreSQL database appender.
 Requires https://github.com/clojure/java.jdbc,
-         https://github.com/swaldman/c3p0
Public variables and functions:
taoensso.timbre.appenders.3rd-party.rolling
Rolling file appender.
Public variables and functions:
taoensso.timbre.appenders.3rd-party.rotor
Public variables and functions:
taoensso.timbre.appenders.3rd-party.slack
Requires https://github.com/julienXX/clj-slack
Public variables and functions:
taoensso.timbre.appenders.carmine
Carmine (Redis) appender. Requires https://github.com/ptaoussanis/carmine.
Public variables and functions:
taoensso.timbre.appenders.core
Core Timbre appenders without any special dependency requirements.
+         https://github.com/swaldman/c3p0
Public variables and functions:
taoensso.timbre.appenders.3rd-party.rolling
Rolling file appender.
Public variables and functions:
taoensso.timbre.appenders.3rd-party.rotor
Public variables and functions:
taoensso.timbre.appenders.3rd-party.slack
Requires https://github.com/julienXX/clj-slack
Public variables and functions:
taoensso.timbre.appenders.carmine
Carmine (Redis) appender.
+Requires https://github.com/ptaoussanis/carmine.
Public variables and functions:
taoensso.timbre.appenders.core
Core Timbre appenders without any special dependency requirements.
 These can be aliased into the main Timbre ns for convenience.
Public variables and functions:
taoensso.timbre.appenders.example
You can copy this namespace if you'd like a starting template for
-writing your own Timbre appender. PRs for new appenders welcome!
Public variables and functions:
taoensso.timbre.appenders.postal
Email (Postal) appender. Requires https://github.com/drewr/postal.
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:

\ No newline at end of file
+writing your own Timbre appender. PRs for new appenders welcome!
Public variables and functions:
taoensso.timbre.appenders.postal
Email (Postal) appender. Requires https://github.com/drewr/postal.
Public variables and functions:
taoensso.timbre.profiling
Simple logging profiler for Timbre. Highly optimized; supports
+sampled profiling in production.
Public variables and functions:
taoensso.timbre.tools.logging
clojure.tools.logging.impl/Logger implementation.
Public variables and functions:

\ No newline at end of file
diff --git a/taoensso.timbre.appenders.3rd-party.gelf.html b/taoensso.timbre.appenders.3rd-party.gelf.html
index b33953e..c6b6714 100644
--- a/taoensso.timbre.appenders.3rd-party.gelf.html
+++ b/taoensso.timbre.appenders.3rd-party.gelf.html
@@ -1,6 +1,6 @@
 
-taoensso.timbre.appenders.3rd-party.gelf documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.3rd-party.gelf
Appender to handle sending messages in the gelf format to a centralized
+taoensso.timbre.appenders.3rd-party.gelf documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.3rd-party.gelf
Appender to handle sending messages in the gelf format to a centralized
 logging server (e.g. Graylog)
gelf-appender
(gelf-appender gelf-server port)(gelf-appender gelf-server port protocol)
Returns a Timbre appender that sends gelf messages to a remote host. Params:
 `gelf-server` - IP address or hostname string of the remote logging server
 `port`        - TCP or UDP port on which the server listens
diff --git a/taoensso.timbre.appenders.3rd-party.irclj.html b/taoensso.timbre.appenders.3rd-party.irclj.html
new file mode 100644
index 0000000..f7ecc66
--- /dev/null
+++ b/taoensso.timbre.appenders.3rd-party.irclj.html
@@ -0,0 +1,8 @@
+
+taoensso.timbre.appenders.3rd-party.irclj documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.3rd-party.irclj
IRC appender. Requires https://github.com/flatland/irclj.
+
irclj-appender
(irclj-appender irc-config)
Returns an IRC appender.
+(irc-appender
+  {:host "irc.example.org" :port 6667 :nick "logger"
+   :name "My Logger" :chan "#logs"})
view source
make-irc-appender
(make-irc-appender & [appender-merge opts])
DEPRECATED. Please use `irclj-appender` instead.
+
view source

\ No newline at end of file
diff --git a/taoensso.timbre.appenders.3rd-party.postgresql.html b/taoensso.timbre.appenders.3rd-party.postgresql.html
index bf6c45d..72d42af 100644
--- a/taoensso.timbre.appenders.3rd-party.postgresql.html
+++ b/taoensso.timbre.appenders.3rd-party.postgresql.html
@@ -1,6 +1,6 @@
 
-taoensso.timbre.appenders.3rd-party.postgresql documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.3rd-party.postgresql
JDBC PostgreSQL database appender.
+taoensso.timbre.appenders.3rd-party.postgresql documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.3rd-party.postgresql
JDBC PostgreSQL database appender.
 Requires https://github.com/clojure/java.jdbc,
          https://github.com/swaldman/c3p0
connect
(connect config)
view source
default-pool-spec
view source
ensure-conn
(ensure-conn config)
view source
log-message
(log-message config data)
view source
pgsql-appender
(pgsql-appender db-config)
Returns a JDBC PostgreSQL appender.
 (pglog-appender {:server {:host "127.0.0.1" :port 5432}})
diff --git a/taoensso.timbre.appenders.3rd-party.rolling.html b/taoensso.timbre.appenders.3rd-party.rolling.html
index 6bfc462..b789f97 100644
--- a/taoensso.timbre.appenders.3rd-party.rolling.html
+++ b/taoensso.timbre.appenders.3rd-party.rolling.html
@@ -1,6 +1,6 @@
 
-taoensso.timbre.appenders.3rd-party.rolling documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.3rd-party.rolling
Rolling file appender.
+taoensso.timbre.appenders.3rd-party.rolling documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.3rd-party.rolling
Rolling file appender.
 
make-rolling-appender
(make-rolling-appender & [appender-merge opts])
DEPRECATED. Please use `rolling-appender` instead.
 
view source
rolling-appender
(rolling-appender & [{:keys [path pattern], :or {path "./timbre-rolling.log", pattern :daily}}])
Returns a Rolling file appender. Opts:
 :path    - logfile path.
diff --git a/taoensso.timbre.appenders.3rd-party.rotor.html b/taoensso.timbre.appenders.3rd-party.rotor.html
index b451bcd..398732f 100644
--- a/taoensso.timbre.appenders.3rd-party.rotor.html
+++ b/taoensso.timbre.appenders.3rd-party.rotor.html
@@ -1,5 +1,5 @@
 
-taoensso.timbre.appenders.3rd-party.rotor documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.3rd-party.rotor
make-rotor-appender
(make-rotor-appender & [appender-merge opts])
DEPRECATED. Please use `rotor-appender` instead.
+taoensso.timbre.appenders.3rd-party.rotor documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.3rd-party.rotor
make-rotor-appender
(make-rotor-appender & [appender-merge opts])
DEPRECATED. Please use `rotor-appender` instead.
 
view source
rotor-appender
(rotor-appender & [{:keys [path max-size backlog], :or {path "./timbre-rotor.log", max-size (* 1024 1024), backlog 5}}])
Returns a rotating file appender.
 
view source

\ No newline at end of file
diff --git a/taoensso.timbre.appenders.3rd-party.slack.html b/taoensso.timbre.appenders.3rd-party.slack.html
index cd089dc..c79d682 100644
--- a/taoensso.timbre.appenders.3rd-party.slack.html
+++ b/taoensso.timbre.appenders.3rd-party.slack.html
@@ -1,6 +1,6 @@
 
-taoensso.timbre.appenders.3rd-party.slack documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.3rd-party.slack
Requires https://github.com/julienXX/clj-slack
+taoensso.timbre.appenders.3rd-party.slack documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.3rd-party.slack
Requires https://github.com/julienXX/clj-slack
 
slack-appender
(slack-appender & [opts])
Returns Slack appender. Required params:
   `token`   - Slack API token. See: Browse apps > Custom Integrations > Bots
   `channel` - Channel ID
diff --git a/taoensso.timbre.appenders.carmine.html b/taoensso.timbre.appenders.carmine.html
index 97d11db..e7434bc 100644
--- a/taoensso.timbre.appenders.carmine.html
+++ b/taoensso.timbre.appenders.carmine.html
@@ -1,18 +1,16 @@
 
-taoensso.timbre.appenders.carmine documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.carmine
Carmine (Redis) appender. Requires https://github.com/ptaoussanis/carmine.
-
carmine-appender
(carmine-appender & [{:keys [conn-opts keyfn nentries-by-level], :or {keyfn default-keyfn, nentries-by-level {:trace 50, :debug 50, :info 50, :warn 100, :error 100, :fatal 100, :report 100}}}])
Returns a Carmine Redis appender (experimental, subject to change):
-  * All raw logging args are preserved in serialized form (even Throwables!).
-  * Only the most recent instance of each unique entry is kept (uniqueness
-    determined by data-hash-fn).
-  * Configurable number of entries to keep per logging level.
-  * Log is just a value: a vector of Clojure maps: query+manipulate with
-    standard seq fns: group-by hostname, sort/filter by ns & severity, explore
-    exception stacktraces, filter by raw arguments, etc. Datomic and `core.logic`
-    also offer interesting opportunities here.
+taoensso.timbre.appenders.carmine documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.carmine
Carmine (Redis) appender.
+Requires https://github.com/ptaoussanis/carmine.
carmine-appender
(carmine-appender & [{:keys [conn-opts keyfn entry-fn nentries-by-level], :or {keyfn default-keyfn, entry-fn default-entry-fn, nentries-by-level default-nentries-by-level}}])
Alpha, subject to change.
 
-See accompanying `query-entries` fn to return deserialized log entries.
view source
default-keyfn
(default-keyfn level)
view source
make-carmine-appender
(make-carmine-appender & [appender-merge opts])
DEPRECATED. Please use `carmine-appender` instead.
-
view source
query-entries
(query-entries conn-opts level & [n asc? keyfn])
Alpha - subject to change!
-Returns latest `n` log entries by level as an ordered vector of deserialized
-maps. Normal sequence fns can be used to query/transform entries. Datomic and
-core.logic are also useful!
view source

\ No newline at end of file
+Returns a Carmine Redis appender:
+  * All raw logging args are preserved in serialized form (even errors).
+  * Configurable number of entries to keep per logging level.
+  * Only the most recent instance of each unique entry is kept.
+  * Resulting log is just a Clojure value: a vector of log entries (maps).
+
+See also `query-entries`.
view source
default-entry-fn
(default-entry-fn data)
(fn [data])-><db-entry>
+
view source
default-keyfn
(default-keyfn level)
view source
default-nentries-by-level
view source
make-carmine-appender
(make-carmine-appender & [appender-merge opts])
DEPRECATED. Please use `carmine-appender` instead.
+
view source
query-entries
(query-entries conn-opts level & [n asc? keyfn])
Alpha, subject to change.
+Returns latest `n` log entries by level as an ordered vector of
+deserialized maps.
view source

\ No newline at end of file
diff --git a/taoensso.timbre.appenders.core.html b/taoensso.timbre.appenders.core.html
index 26e6117..b3a0e24 100644
--- a/taoensso.timbre.appenders.core.html
+++ b/taoensso.timbre.appenders.core.html
@@ -1,8 +1,8 @@
 
-taoensso.timbre.appenders.core documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.core
Core Timbre appenders without any special dependency requirements.
+taoensso.timbre.appenders.core documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.core
Core Timbre appenders without any special dependency requirements.
 These can be aliased into the main Timbre ns for convenience.
println-appender
(println-appender & [{:keys [stream], :or {stream :auto}}])
Returns a simple `println` appender for Clojure/Script.
 Use with ClojureScript requires that `cljs.core/*print-fn*` be set.
 
 :stream (clj only) - e/o #{:auto :*out* :*err* :std-err :std-out <io-stream>}.
view source
spit-appender
(spit-appender & [{:keys [fname], :or {fname "./timbre-spit.log"}}])
Returns a simple `spit` file appender for Clojure.
-
view source

\ No newline at end of file
+
view source

\ No newline at end of file
diff --git a/taoensso.timbre.appenders.example.html b/taoensso.timbre.appenders.example.html
index aa2c2a9..f32b4cf 100644
--- a/taoensso.timbre.appenders.example.html
+++ b/taoensso.timbre.appenders.example.html
@@ -1,9 +1,9 @@
 
-taoensso.timbre.appenders.example documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.example
You can copy this namespace if you'd like a starting template for
+taoensso.timbre.appenders.example documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.example
You can copy this namespace if you'd like a starting template for
 writing your own Timbre appender. PRs for new appenders welcome!
 
 TODO Please document any dependency GitHub links here, e.g.:
 Requires https://github.com/clojure/java.jdbc,
          https://github.com/swaldman/c3p0
example-appender
(example-appender & [opts])
Docstring to explain any special opts to influence appender construction,
-etc. Returns the appender map.
view source

\ No newline at end of file
+etc. Returns the appender map.
view source

\ No newline at end of file
diff --git a/taoensso.timbre.appenders.postal.html b/taoensso.timbre.appenders.postal.html
index 9dec000..fee5b78 100644
--- a/taoensso.timbre.appenders.postal.html
+++ b/taoensso.timbre.appenders.postal.html
@@ -1,8 +1,8 @@
 
-taoensso.timbre.appenders.postal documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.postal
Email (Postal) appender. Requires https://github.com/drewr/postal.
+taoensso.timbre.appenders.postal documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.postal
Email (Postal) appender. Requires https://github.com/drewr/postal.
 
make-postal-appender
(make-postal-appender & [appender-merge opts])
DEPRECATED. Please use `postal-appender` instead.
-
view source
postal-appender
(postal-appender postal-config & [{:keys [subject-len body-fn], :or {subject-len 150, body-fn (fn [output-str] [{:type "text/plain; charset=utf-8", :content output-str}])}}])
Returns a Postal email appender.
+
view source
postal-appender
(postal-appender postal-config & [{:keys [subject-len body-fn], :or {subject-len 150, body-fn (fn [output-str] [{:type "text/plain; charset=utf-8", :content output-str}])}}])
Returns a Postal email appender.
 (postal-appender
   ^{:host "mail.isp.net" :user "jsmith" :pass "sekrat!!1"}
   {:from "Bob's logger <me@draines.com>" :to "foo@example.com"})
view source

\ No newline at end of file
diff --git a/taoensso.timbre.html b/taoensso.timbre.html
index 4497050..24ae65d 100644
--- a/taoensso.timbre.html
+++ b/taoensso.timbre.html
@@ -1,77 +1,77 @@
 
-taoensso.timbre documentation
Project
Namespaces
Public Vars
taoensso.timbre
Simple, flexible logging for Clojure/Script. No XML.
+taoensso.timbre documentation
Project
Namespaces
Public Vars
taoensso.timbre
Simple, flexible logging for Clojure/Script. No XML.
 
*config*
dynamic
See `example-config` for info.
-
view source
*context*
dynamic
General-purpose dynamic logging context. Context will be included in appender
-data map at logging time.
view source
-log!
(-log! config level ?ns-str ?file ?line msg-type ?err vargs_ ?base-data)
Core low-level log fn. Implementation detail!
-
view source
-log-and-rethrow-errors
macro
(-log-and-rethrow-errors ?line & body)
view source
-log-errors
macro
(-log-errors ?line & body)
view source
-logged-future
macro
(-logged-future ?line & body)
view source
-spy
macro
(-spy ?line config level name expr)
view source
-with-elision
macro
(-with-elision level-form ns-str-form & body)
Implementation detail.
-Executes body iff given level and ns pass compile-time elision.
view source
color-str
(color-str color & xs)
view source
debug
macro
(debug & args)
view source
debugf
macro
(debugf & args)
view source
default-data-hash-fn
(default-data-hash-fn data)
Used for rate limiters, some appenders (e.g. Carmine), etc.
-Goal: (hash data-1) = (hash data-2) iff data-1 "the same" as data-2 for
-rate-limiting purposes, etc.
view source
default-err
view source
default-out
view source
default-output-fn
(default-output-fn data)(default-output-fn {:keys [no-stacktrace? stacktrace-fonts], :as opts} data)
Default (fn [data]) -> string output fn.
-You can modify default options with `(partial default-output-fn <opts-map>)`.
view source
default-timestamp-opts
Controls (:timestamp_ data)
-
view source
error
macro
(error & args)
view source
errorf
macro
(errorf & args)
view source
example-config
Example (+default) Timbre v4 config map.
+
view source
*context*
dynamic
General-purpose dynamic logging context. Context will be included in
+appender data map at logging time.
view source
-log!
(-log! config level ?ns-str ?file ?line msg-type ?err vargs_ ?base-data callsite-id)
Core low-level log fn. Implementation detail!
+
view source
-log-and-rethrow-errors
macro
(-log-and-rethrow-errors ?line & body)
view source
-log-errors
macro
(-log-errors ?line & body)
view source
-logged-future
macro
(-logged-future ?line & body)
view source
-spy
macro
(-spy ?line config level name expr)
view source
-with-elision
macro
(-with-elision level-form ns-str-form & body)
Implementation detail.
+Executes body iff given level and ns pass compile-time elision.
view source
color-str
(color-str color & xs)
view source
debug
macro
(debug & args)
view source
debugf
macro
(debugf & args)
view source
default-err
view source
default-out
view source
default-output-fn
(default-output-fn data)(default-output-fn opts data)
Default (fn [data]) -> string output fn.
+Use`(partial default-output-fn <opts-map>)` to modify default opts.
view source
default-timestamp-opts
Controls (:timestamp_ data)
+
view source
error
macro
(error & args)
view source
errorf
macro
(errorf & args)
view source
example-config
Example (+default) Timbre v4 config map.
 
 APPENDERS
   An appender is a map with keys:
     :min-level       ; Level keyword, or nil (=> no minimum level)
     :enabled?        ;
-    :async?          ; Dispatch using agent? Useful for slow appenders
+    :async?          ; Dispatch using agent? Useful for slow appenders (clj only)
     :rate-limit      ; [[ncalls-limit window-ms] <...>], or nil
     :output-fn       ; Optional override for inherited (fn [data]) -> string
-    :fn              ; (fn [data]) -> side effects, with keys described below
+    :timestamp-opts  ; Optional override for inherited {:pattern _ :locale _ :timezone _}
     :ns-whitelist    ; Optional, stacks with active config's whitelist
     :ns-blacklist    ; Optional, stacks with active config's blacklist
+    :fn              ; (fn [data]) -> side effects, with keys described below
 
   An appender's fn takes a single data map with keys:
     :config          ; Entire config map (this map, etc.)
     :appender-id     ; Id of appender currently dispatching
     :appender        ; Entire map of appender currently dispatching
-
     :instant         ; Platform date (java.util.Date or js/Date)
     :level           ; Keyword
     :error-level?    ; Is level e/o #{:error :fatal}?
-    :?ns-str         ; String, or nil
-    :?file           ; String, or nil
+    :?ns-str         ; String,  or nil
+    :?file           ; String,  or nil
     :?line           ; Integer, or nil ; Waiting on CLJ-865
-
-    :?err_           ; Delay - first-arg platform error, or nil
-    :vargs_          ; Delay - raw args vector
-    :hostname_       ; Delay - string (clj only)
-    :msg_            ; Delay - args string
-    :timestamp_      ; Delay - string
+    :?err            ; First-arg platform error, or nil
+    :vargs           ; Vector of raw args
+    :output_         ; Forceable - final formatted output string created
+                     ; by calling (output-fn <this-data-map>)
+    :msg_            ; Forceable - args as a string
+    :timestamp_      ; Forceable - string
+    :hostname_       ; Forceable - string (clj only)
     :output-fn       ; (fn [data]) -> formatted output string
                      ; (see `default-output-fn` for details)
-
     :context         ; *context* value at log time (see `with-context`)
     :profile-stats   ; From `profile` macro
 
+    **NB** - any keys not specifically documented here should be
+    considered private / subject to change without notice.
+
 MIDDLEWARE
   Middleware are simple (fn [data]) -> ?data fns (applied left->right) that
-  transform the data map dispatched to appender fns. If any middleware returns
-  nil, NO dispatching will occur (i.e. the event will be filtered).
+  transform the data map dispatched to appender fns. If any middleware
+  returns nil, NO dispatch will occur (i.e. the event will be filtered).
 
 The `example-config` source code contains further settings and details.
-See also `set-config!`, `merge-config!`, `set-level!`.
view source
fatal
macro
(fatal & args)
view source
fatalf
macro
(fatalf & args)
view source
get-env
macro
(get-env)
view source
get-hostname
view source
handle-uncaught-jvm-exceptions!
(handle-uncaught-jvm-exceptions! & [handler])
Sets JVM-global DefaultUncaughtExceptionHandler.
-
view source
info
macro
(info & args)
view source
infof
macro
(infof & args)
view source
level>=
(level>= x y)
view source
log
macro
(log level & args)
view source
log!
macro
(log! level msg-type args & [opts])
Core low-level log macro. Useful for tooling, etc.
+See also `set-config!`, `merge-config!`, `set-level!`.
view source
fatal
macro
(fatal & args)
view source
fatalf
macro
(fatalf & args)
view source
get-env
macro
(get-env)
view source
get-hostname
view source
handle-uncaught-jvm-exceptions!
(handle-uncaught-jvm-exceptions! & [handler])
Sets JVM-global DefaultUncaughtExceptionHandler.
+
view source
info
macro
(info & args)
view source
infof
macro
(infof & args)
view source
level>=
(level>= x y)
view source
log
macro
(log level & args)
view source
log!
macro
(log! level msg-type args & [opts])
Core low-level log macro. Useful for tooling, etc.
 
   * `level`    - must eval to a valid logging level
   * `msg-type` - must eval to e/o #{:p :f nil}
-  * `opts`     - ks e/o #{:config :?err :?ns-str :?file :?line
-                          :?base-data}
+  * `opts`     - ks e/o #{:config :?err :?ns-str :?file :?line :?base-data}
 
 Supports compile-time elision when compile-time const vals
-provided for `level` and/or `?ns-str`.
view source
log*
macro
(log* config level & args)
view source
log-and-rethrow-errors
macro
(log-and-rethrow-errors & body)
view source
log-env
macro
(log-env)(log-env level)(log-env level name)(log-env config level name)
view source
log-errors
macro
(log-errors & body)
view source
log?
(log? level)(log? level ?ns-str)(log? level ?ns-str config)
Runtime check: would Timbre currently log at the given logging level?
+provided for `level` and/or `?ns-str`.
view source
log*
macro
(log* config level & args)
view source
log-and-rethrow-errors
macro
(log-and-rethrow-errors & body)
view source
log-env
macro
(log-env)(log-env level)(log-env level name)(log-env config level name)
view source
log-errors
macro
(log-errors & body)
view source
log?
(log? level)(log? level ?ns-str)(log? level ?ns-str config)
Runtime check: would Timbre currently log at the given logging level?
 * `?ns-str` arg required to support ns filtering
-* `config`  arg required to support non-global config
view source
logf
macro
(logf level & args)
view source
logf*
macro
(logf* config level & args)
view source
logged-future
macro
(logged-future & body)
view source
logging-enabled?
(logging-enabled? level compile-time-ns)
view source
logp
macro
(logp & sigs)
view source
merge-config!
(merge-config! m)
view source
ordered-levels
view source
println-appender
(println-appender & [{:keys [stream], :or {stream :auto}}])
Returns a simple `println` appender for Clojure/Script.
+* `config`  arg required to support non-global config
view source
logf
macro
(logf level & args)
view source
logf*
macro
(logf* config level & args)
view source
logged-future
macro
(logged-future & body)
view source
logging-enabled?
(logging-enabled? level compile-time-ns)
view source
logp
macro
(logp & sigs)
view source
merge-config!
(merge-config! m)
view source
ordered-levels
view source
println-appender
(println-appender & [{:keys [stream], :or {stream :auto}}])
Returns a simple `println` appender for Clojure/Script.
 Use with ClojureScript requires that `cljs.core/*print-fn*` be set.
 
-:stream (clj only) - e/o #{:auto :*out* :*err* :std-err :std-out <io-stream>}.
view source
refer-timbre
(refer-timbre)
Shorthand for:
+:stream (clj only) - e/o #{:auto :*out* :*err* :std-err :std-out <io-stream>}.
view source
refer-timbre
(refer-timbre)
Shorthand for:
 (require '[taoensso.timbre :as timbre
            :refer (log  trace  debug  info  warn  error  fatal  report
                    logf tracef debugf infof warnf errorf fatalf reportf
                    spy get-env log-env)])
 (require '[taoensso.timbre.profiling :as profiling
-           :refer (pspy pspy* profile defnp p p*)])
view source
report
macro
(report & args)
view source
reportf
macro
(reportf & args)
view source
set-config!
(set-config! m)
view source
set-level!
(set-level! level)
view source
sometimes
macro
(sometimes probability & body)
Handy for sampled logging, etc.
-
view source
spit-appender
(spit-appender & [{:keys [fname], :or {fname "./timbre-spit.log"}}])
Returns a simple `spit` file appender for Clojure.
-
view source
spy
macro
(spy expr)(spy level expr)(spy level name expr)(spy config level name expr)
Evaluates named expression and logs its result. Always returns the result.
-Defaults to :debug logging level and unevaluated expression as name.
view source
stacktrace
(stacktrace err & [{:keys [stacktrace-fonts], :as opts}])
view source
str-println
(str-println & xs)
view source
swap-config!
(swap-config! f & args)
view source
trace
macro
(trace & args)
view source
tracef
macro
(tracef & args)
view source
warn
macro
(warn & args)
view source
warnf
macro
(warnf & args)
view source
with-config
macro
(with-config config & body)
view source
with-context
macro
(with-context context & body)
view source
with-default-outs
macro
(with-default-outs & body)
view source
with-level
macro
(with-level level & body)
view source
with-log-level
macro
(with-log-level level & body)
view source
with-logging-config
macro
(with-logging-config config & body)
view source
with-merged-config
macro
(with-merged-config config & body)
view source

\ No newline at end of file
+           :refer (pspy p defnp profile)])
view source
report
macro
(report & args)
view source
reportf
macro
(reportf & args)
view source
set-config!
(set-config! m)
view source
set-level!
(set-level! level)
view source
sometimes
macro
(sometimes probability & body)
Handy for sampled logging, etc.
+
view source
spit-appender
(spit-appender & [{:keys [fname], :or {fname "./timbre-spit.log"}}])
Returns a simple `spit` file appender for Clojure.
+
view source
spy
macro
(spy expr)(spy level expr)(spy level name expr)(spy config level name expr)
Evaluates named expression and logs its result. Always returns the result.
+Defaults to :debug logging level and unevaluated expression as name.
view source
stacktrace
(stacktrace err)(stacktrace err opts)
view source
str-println
(str-println & xs)
view source
swap-config!
(swap-config! f & args)
view source
trace
macro
(trace & args)
view source
tracef
macro
(tracef & args)
view source
warn
macro
(warn & args)
view source
warnf
macro
(warnf & args)
view source
with-config
macro
(with-config config & body)
view source
with-context
macro
(with-context context & body)
view source
with-default-outs
macro
(with-default-outs & body)
view source
with-level
macro
(with-level level & body)
view source
with-log-level
macro
(with-log-level level & body)
view source
with-logging-config
macro
(with-logging-config config & body)
view source
with-merged-config
macro
(with-merged-config config & body)
view source

\ No newline at end of file
diff --git a/taoensso.timbre.profiling.html b/taoensso.timbre.profiling.html
index c9ba917..74647cd 100644
--- a/taoensso.timbre.profiling.html
+++ b/taoensso.timbre.profiling.html
@@ -1,19 +1,16 @@
 
-taoensso.timbre.profiling documentation
Project
Namespaces
Public Vars
taoensso.timbre.profiling
Logging profiler for Timbre, adapted from clojure.contrib.profile.
-
*pdata*
dynamic
{::pid {:times [t1 t2 ...] ; Times awaiting merge into stats
- :ntimes _          ; (count times)
- :stats {}          ; Cumulative stats
-}}
view source
capture-time!
(capture-time! id t-elapsed)
view source
defnp
macro
(defnp name doc-string? attr-map? [params*] prepost-map? body)(defnp name doc-string? attr-map? ([params*] prepost-map? body) + attr-map?)
Like `defn` but wraps fn bodies with `p` macro.
-
view source
fn-sigs
(fn-sigs fn-name sigs)
Implementation detail.
-
view source
fnp
macro
(fnp name? [params*] prepost-map? body)(fnp name? ([params*] prepost-map? body) +)
Like `fn` but wraps fn bodies with `p` macro.
-
view source
format-stats
(format-stats stats & [sort-field])
view source
fq-keyword
macro
(fq-keyword id)
Returns namespaced keyword for given id.
-
view source
merge-times>stats!
(merge-times>stats!)(merge-times>stats! id)
view source
p
macro
(p id & body)
view source
profile
macro
(profile level id & body)
When logging is enabled, executes named body with profiling enabled. Body
-forms wrapped in (pspy) will be timed and time stats logged. Always returns
-body's result.
-
-Note that logging appenders will receive both a formatted profiling string AND
-the raw profiling stats under a special :profiling-stats key (useful for
-queryable db logging).
view source
pspy
macro
(pspy id & body)
Profile spy. When in the context of a *pdata* binding, records execution time
-of named body. Always returns the body's result.
view source
sampling-profile
macro
(sampling-profile level probability id & body)
Like `profile`, but only enables profiling with given probability.
-
view source
with-pdata
macro
(with-pdata level & body)
view source

\ No newline at end of file
+taoensso.timbre.profiling documentation
Project
Namespaces
Public Vars
taoensso.timbre.profiling
Simple logging profiler for Timbre. Highly optimized; supports
+sampled profiling in production.
->PData
(->PData m-times m-stats)
Positional factory function for class taoensso.timbre.profiling.PData.
+
view source
-capture-time!
(-capture-time! id t-elapsed)(-capture-time! pdata id t-elapsed)
view source
-compile-final-stats!
(-compile-final-stats! clock-time)
Returns {<id> <stats>}
+
view source
-fn-sigs
(-fn-sigs fn-name sigs)
view source
-format-stats
(-format-stats stats)(-format-stats stats sort-field)
view source
-new-pdata
macro
(-new-pdata)
view source
-pdata-proxy
view source
-with-pdata
macro
(-with-pdata & body)
view source
defnp
macro
(defnp name doc-string? attr-map? [params*] prepost-map? body)(defnp name doc-string? attr-map? ([params*] prepost-map? body) + attr-map?)
Like `defn` but wraps fn bodies with `p` macro.
+
view source
fnp
macro
(fnp name? [params*] prepost-map? body)(fnp name? ([params*] prepost-map? body) +)
Like `fn` but wraps fn bodies with `p` macro.
+
view source
p
macro
(p id & body)
view source
p*
Deprecated
+
view source
profile
macro
(profile level id & body)
When logging is enabled, executes named body with thread-local profiling
+enabled and logs profiling stats. Always returns body's result.
view source
profiled
macro
(profiled expr-to-profile params & body)
Experimental, subject to change!
+Low-level profiling util. Executes expr with thread-local profiling
+enabled, then executes body with `[<stats> <expr-result>]` binding, e.g:
+  (profiled "foo" [stats result] (do (println stats) result))
view source
pspy
macro
(pspy id & body)
Profile spy. When thread-local profiling is enabled, records
+execution time of named body. Always returns the body's result.
view source
pspy*
Deprecated
+
view source
sampling-profile
macro
(sampling-profile level probability id & body)
Like `profile`, but only enables profiling with given probability.
+
view source

\ No newline at end of file
diff --git a/taoensso.timbre.tools.logging.html b/taoensso.timbre.tools.logging.html
index 085ebb3..2c195c0 100644
--- a/taoensso.timbre.tools.logging.html
+++ b/taoensso.timbre.tools.logging.html
@@ -1,6 +1,6 @@
 
-taoensso.timbre.tools.logging documentation
Project
Namespaces
Public Vars
taoensso.timbre.tools.logging
clojure.tools.logging.impl/Logger implementation.
+taoensso.timbre.tools.logging documentation
Project
Namespaces
Public Vars
taoensso.timbre.tools.logging
clojure.tools.logging.impl/Logger implementation.
 
 Please note that the tools.logging API has some significant limits
 that native Timbre does not. Would strongly recommend against using