diff --git a/index.html b/index.html index 5329b0c2..44095a9e 100644 --- a/index.html +++ b/index.html @@ -1,6 +1,6 @@ -Timbre 6.2.0

Project

Namespaces

Timbre 6.2.0

Released under the Eclipse Public License 1.0

Pure Clojure/Script logging library.

Installation

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

[com.taoensso/timbre "6.2.0"]

Namespaces

taoensso.timbre

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

Public variables and functions:

taoensso.timbre.appenders.carmine

Carmine (Redis) appender.
+Timbre 6.2.1
Project
Namespaces
Timbre 6.2.1
Released under the Eclipse Public License 1.0
Pure Clojure/Script logging library.
Installation
To install, add the following dependency to your project or build file:
[com.taoensso/timbre "6.2.1"]
Namespaces
taoensso.timbre
Simple, flexible logging for Clojure/Script. 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.community.congomongo
MongoDB appender. Requires https://github.com/aboekhoff/congomongo.
Public variables and functions:
taoensso.timbre.appenders.community.franzy
Franzy (Kafka) appender.
 Requires Franzy (https://github.com/ymilky/franzy.
Public variables and functions:
taoensso.timbre.appenders.community.gelf
Appender that sends GELF messages to a centralized logging server
 (e.g. Graylog). Requires https://github.com/Graylog2/gelfclient.
Public variables and functions:
taoensso.timbre.appenders.community.irclj
IRC appender. Requires https://github.com/flatland/irclj.
Public variables and functions:
taoensso.timbre.appenders.community.logstash
Appender that sends output to Logstash.
diff --git a/taoensso.timbre.appenders.carmine.html b/taoensso.timbre.appenders.carmine.html
index 2e7a7f40..a7244d3f 100644
--- a/taoensso.timbre.appenders.carmine.html
+++ b/taoensso.timbre.appenders.carmine.html
@@ -1,6 +1,6 @@
 
-taoensso.timbre.appenders.carmine documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.carmine
Carmine (Redis) appender.
+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.
 
 Returns a Carmine Redis appender:
@@ -10,7 +10,7 @@
   * Resulting log is just a Clojure value: a vector of log entries (maps).
 
 See also `query-entries`.
default-entry-fn
(default-entry-fn data)
(fn [data])-><db-entry>
-
default-keyfn
(default-keyfn level)
default-nentries-by-level
make-carmine-appender
(make-carmine-appender & [appender-merge opts])
DEPRECATED. Please use `carmine-appender` instead.
+
default-keyfn
(default-keyfn level)
default-nentries-by-level
make-carmine-appender
deprecated
(make-carmine-appender & [appender-merge opts])
DEPRECATED. Please use `carmine-appender` instead.
 
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.

\ No newline at end of file
diff --git a/taoensso.timbre.appenders.community.congomongo.html b/taoensso.timbre.appenders.community.congomongo.html
index a18ca398..c44ebd40 100644
--- a/taoensso.timbre.appenders.community.congomongo.html
+++ b/taoensso.timbre.appenders.community.congomongo.html
@@ -1,6 +1,6 @@
 
-taoensso.timbre.appenders.community.congomongo documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.community.congomongo
MongoDB appender. Requires https://github.com/aboekhoff/congomongo.
+taoensso.timbre.appenders.community.congomongo documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.community.congomongo
MongoDB appender. Requires https://github.com/aboekhoff/congomongo.
 
congomongo-appender
(congomongo-appender config)
Returns a congomongo MongoDB appender.
 (congomongo-appender
   {:db "logs"
diff --git a/taoensso.timbre.appenders.community.franzy.html b/taoensso.timbre.appenders.community.franzy.html
index 87198c4c..27b9eb13 100644
--- a/taoensso.timbre.appenders.community.franzy.html
+++ b/taoensso.timbre.appenders.community.franzy.html
@@ -1,6 +1,6 @@
 
-taoensso.timbre.appenders.community.franzy documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.community.franzy
Franzy (Kafka) appender.
+taoensso.timbre.appenders.community.franzy documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.community.franzy
Franzy (Kafka) appender.
 Requires Franzy (https://github.com/ymilky/franzy.
franzy-appender
(franzy-appender {:keys [topic entry-fn], :or {entry-fn default-entry-fn}, :as config})
Returns a Franzy (Kafka) appender:
 (franzy-appender
   {:topic "test-topic"
diff --git a/taoensso.timbre.appenders.community.gelf.html b/taoensso.timbre.appenders.community.gelf.html
index b46fce7a..1a0c0579 100644
--- a/taoensso.timbre.appenders.community.gelf.html
+++ b/taoensso.timbre.appenders.community.gelf.html
@@ -1,6 +1,6 @@
 
-taoensso.timbre.appenders.community.gelf documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.community.gelf
Appender that sends GELF messages to a centralized logging server
+taoensso.timbre.appenders.community.gelf documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.community.gelf
Appender that sends GELF messages to a centralized logging server
 (e.g. Graylog). Requires https://github.com/Graylog2/gelfclient.
data->gelf-message
(data->gelf-message data)
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.community.irclj.html b/taoensso.timbre.appenders.community.irclj.html
index b6a03db1..6ee71961 100644
--- a/taoensso.timbre.appenders.community.irclj.html
+++ b/taoensso.timbre.appenders.community.irclj.html
@@ -1,6 +1,6 @@
 
-taoensso.timbre.appenders.community.irclj documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.community.irclj
IRC appender. Requires https://github.com/flatland/irclj.
+taoensso.timbre.appenders.community.irclj documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.community.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"
diff --git a/taoensso.timbre.appenders.community.logstash.html b/taoensso.timbre.appenders.community.logstash.html
index a3d56011..2b89400c 100644
--- a/taoensso.timbre.appenders.community.logstash.html
+++ b/taoensso.timbre.appenders.community.logstash.html
@@ -1,6 +1,6 @@
 
-taoensso.timbre.appenders.community.logstash documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.community.logstash
Appender that sends output to Logstash.
+taoensso.timbre.appenders.community.logstash documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.community.logstash
Appender that sends output to Logstash.
 Requires Cheshire (https://github.com/dakrone/cheshire).
connect
(connect host port)
connection-ok?
(connection-ok? [sock out])
data->json-stream
(data->json-stream data writer opts)
iso-format
logstash-appender
(logstash-appender host port & [opts])
Returns a Logstash appender, which will send each event in JSON
 format to the logstash server at `host:port`. Additionally `opts`
 may be a map with `:pr-stracktrace` mapped to a function taking an
diff --git a/taoensso.timbre.appenders.community.postgresql.html b/taoensso.timbre.appenders.community.postgresql.html
index af11fa72..39dfa8c0 100644
--- a/taoensso.timbre.appenders.community.postgresql.html
+++ b/taoensso.timbre.appenders.community.postgresql.html
@@ -1,6 +1,6 @@
 
-taoensso.timbre.appenders.community.postgresql documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.community.postgresql
JDBC PostgreSQL database appender.
+taoensso.timbre.appenders.community.postgresql documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.community.postgresql
JDBC PostgreSQL database appender.
 Requires https://github.com/clojure/java.jdbc,
          https://github.com/swaldman/c3p0.
conn
connect
(connect config)
default-pool-spec
ensure-conn
(ensure-conn config)
log-message
(log-message config data)
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.community.rolling.html b/taoensso.timbre.appenders.community.rolling.html
index fd766738..8cc27de7 100644
--- a/taoensso.timbre.appenders.community.rolling.html
+++ b/taoensso.timbre.appenders.community.rolling.html
@@ -1,7 +1,7 @@
 
-taoensso.timbre.appenders.community.rolling documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.community.rolling
Rolling file appender.
-
make-rolling-appender
(make-rolling-appender & [appender-merge opts])
DEPRECATED. Please use `rolling-appender` instead.
+taoensso.timbre.appenders.community.rolling documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.community.rolling
Rolling file appender.
+
make-rolling-appender
deprecated
(make-rolling-appender & [appender-merge opts])
DEPRECATED. Please use `rolling-appender` instead.
 
rolling-appender
(rolling-appender & [{:keys [path pattern], :or {path "./timbre-rolling.log", pattern :daily}}])
Returns a Rolling file appender. Opts:
 :path    - logfile path.
 :pattern - frequency of rotation, e/o {:daily :weekly :monthly}.

\ No newline at end of file
diff --git a/taoensso.timbre.appenders.community.rotor.html b/taoensso.timbre.appenders.community.rotor.html
index c47165ad..83b05a17 100644
--- a/taoensso.timbre.appenders.community.rotor.html
+++ b/taoensso.timbre.appenders.community.rotor.html
@@ -1,6 +1,6 @@
 
-taoensso.timbre.appenders.community.rotor documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.community.rotor
Rotating file appender.
+taoensso.timbre.appenders.community.rotor documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.community.rotor
Rotating file appender.
 
make-rotor-appender
(make-rotor-appender & [appender-merge opts])
DEPRECATED. Please use `rotor-appender` instead.
 
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.
 

\ No newline at end of file
diff --git a/taoensso.timbre.appenders.community.sentry.html b/taoensso.timbre.appenders.community.sentry.html
index 22841e5b..a7bfa337 100644
--- a/taoensso.timbre.appenders.community.sentry.html
+++ b/taoensso.timbre.appenders.community.sentry.html
@@ -1,6 +1,6 @@
 
-taoensso.timbre.appenders.community.sentry documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.community.sentry
Sentry appender. Requires https://github.com/sethtrain/raven-clj.
+taoensso.timbre.appenders.community.sentry documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.community.sentry
Sentry appender. Requires https://github.com/sethtrain/raven-clj.
 
sentry-appender
(sentry-appender dsn & [opts])
Returns a raven-clj Sentry appender.
 
 Requires the DSN (e.g. "https://<key>:<secret>@sentry.io/<project>")
diff --git a/taoensso.timbre.appenders.community.server-socket.html b/taoensso.timbre.appenders.community.server-socket.html
index 3aeac130..22f1ee47 100644
--- a/taoensso.timbre.appenders.community.server-socket.html
+++ b/taoensso.timbre.appenders.community.server-socket.html
@@ -1,6 +1,6 @@
 
-taoensso.timbre.appenders.community.server-socket documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.community.server-socket
TCP socket appender.
-Requires https://github.com/technomancy/server-socket.
conn
connect
(connect {:keys [port listen-addr]})
ensure-conn
(ensure-conn socket-config)
listener-fun
(listener-fun in out)
make-socket-appender
(make-socket-appender & [appender-merge opts])
DEPRECATED. Please use `server-socket-appender` instead.
+taoensso.timbre.appenders.community.server-socket documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.community.server-socket
TCP socket appender.
+Requires https://github.com/technomancy/server-socket.
conn
connect
(connect {:keys [port listen-addr]})
ensure-conn
(ensure-conn socket-config)
listener-fun
(listener-fun in out)
make-socket-appender
deprecated
(make-socket-appender & [appender-merge opts])
DEPRECATED. Please use `server-socket-appender` instead.
 
on-thread-daemon
(on-thread-daemon f)
server-socket-appender
(server-socket-appender & [socket-config])
Returns a TCP socket appender.
 (socket-appender {:listener-addr :all :port 9000})

\ No newline at end of file
diff --git a/taoensso.timbre.appenders.community.slack.html b/taoensso.timbre.appenders.community.slack.html
index 1bcfb6ca..07633404 100644
--- a/taoensso.timbre.appenders.community.slack.html
+++ b/taoensso.timbre.appenders.community.slack.html
@@ -1,6 +1,6 @@
 
-taoensso.timbre.appenders.community.slack documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.community.slack
Slack appender. Requires https://github.com/julienXX/clj-slack.
+taoensso.timbre.appenders.community.slack documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.community.slack
Slack appender. 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.community.syslog-appender.html b/taoensso.timbre.appenders.community.syslog-appender.html
index 5a835b1e..b95438a4 100644
--- a/taoensso.timbre.appenders.community.syslog-appender.html
+++ b/taoensso.timbre.appenders.community.syslog-appender.html
@@ -1,6 +1,6 @@
 
-taoensso.timbre.appenders.community.syslog-appender documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.community.syslog-appender
Requires https://github.com/java-native-access/jna
+taoensso.timbre.appenders.community.syslog-appender documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.community.syslog-appender
Requires https://github.com/java-native-access/jna
 
syslog-appender
(syslog-appender config)
Returns a syslog appender. All parameters are optional.
 (journald-appender
   {:ident "my-app"
diff --git a/taoensso.timbre.appenders.community.udp-socket.html b/taoensso.timbre.appenders.community.udp-socket.html
index 44b2c67d..68f7953c 100644
--- a/taoensso.timbre.appenders.community.udp-socket.html
+++ b/taoensso.timbre.appenders.community.udp-socket.html
@@ -1,5 +1,5 @@
 
-taoensso.timbre.appenders.community.udp-socket documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.community.udp-socket
udp-appender
(udp-appender {:keys [host port]})
Returns a UDP socket appender, which sends each event
+taoensso.timbre.appenders.community.udp-socket documentation
Project
Namespaces
Public Vars
taoensso.timbre.appenders.community.udp-socket
udp-appender
(udp-appender {:keys [host port]})
Returns a UDP socket appender, which sends each event
 at the datagram socket designated by `host` and `port`.
 Due to the limitations of UDP, truncates output to 512 bytes.

\ No newline at end of file
diff --git a/taoensso.timbre.appenders.core.html b/taoensso.timbre.appenders.core.html
index e0b8a2ed..13d02745 100644
--- a/taoensso.timbre.appenders.core.html
+++ b/taoensso.timbre.appenders.core.html
@@ -1,6 +1,6 @@
 
-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.
 
diff --git a/taoensso.timbre.appenders.example.html b/taoensso.timbre.appenders.example.html
index 9fc66ff7..e7c5c625 100644
--- a/taoensso.timbre.appenders.example.html
+++ b/taoensso.timbre.appenders.example.html
@@ -1,6 +1,6 @@
 
-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 *dependency-free* community appenders welcome!
diff --git a/taoensso.timbre.appenders.postal.html b/taoensso.timbre.appenders.postal.html
index 8f4d1eb1..8ec56dfa 100644
--- a/taoensso.timbre.appenders.postal.html
+++ b/taoensso.timbre.appenders.postal.html
@@ -1,12 +1,12 @@
 
-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.
 
default-body-fn
(default-body-fn {:keys [max-len]} output-str)
Given an `output-str`, returns an appropriate Postal email body.
 
default-subject-fn
(default-subject-fn {:keys [max-len]} output-str)
Given an `output-str`, returns an appropriate email subject string:
 - Take only the first line
 - Trim it
 - Simplify whitespace
-- Never exceed `max-subject-len` characters.
make-postal-appender
(make-postal-appender & [appender-merge opts])
DEPRECATED. Please use `postal-appender` instead.
+- Never exceed `max-subject-len` characters.
make-postal-appender
deprecated
(make-postal-appender & [appender-merge opts])
DEPRECATED. Please use `postal-appender` instead.
 
postal-appender
(postal-appender postal-config & [{:keys [subject-len body-len subject-fn body-fn], :or {subject-len 150, subject-fn (partial default-subject-fn {:max-len (enc/as-?int subject-len)}), body-fn (partial default-body-fn {:max-len (enc/as-?int body-len)})}}])
Returns a Postal email appender.
 (postal-appender
   ^{:host "mail.isp.net" :user "jsmith" :pass "sekrat!!1"}
diff --git a/taoensso.timbre.html b/taoensso.timbre.html
index 12012333..8f70be80 100644
--- a/taoensso.timbre.html
+++ b/taoensso.timbre.html
@@ -1,6 +1,6 @@
 
-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
This config map controls all Timbre behaviour including:
   - When to log (via min-level and namespace filtering)
   - How  to log (which appenders to use, etc.)
diff --git a/taoensso.timbre.tools.logging.html b/taoensso.timbre.tools.logging.html
index e38ae4db..354d8c84 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