mirror of https://github.com/status-im/timbre.git
Clean up appender documentation
This commit is contained in:
parent
cef5440d50
commit
7c29ce6852
45
README.md
45
README.md
|
@ -117,59 +117,40 @@ Filter logging output by namespaces:
|
|||
(timbre/set-config! [:ns-whitelist] ["some.library.core" "my-app.*"])
|
||||
```
|
||||
|
||||
### Email Appender
|
||||
### Built-in Appenders
|
||||
|
||||
To enable the standard [Postal](https://github.com/drewr/postal)-based email appender, add the Postal dependency to your `project.clj`:
|
||||
#### File Appender
|
||||
|
||||
```clojure
|
||||
[com.draines/postal "1.9.2"]
|
||||
(timbre/set-config! [:appenders :spit :enabled?] true)
|
||||
(timbre/set-config! [:shared-appender-config :spit-filename] "/path/my-file.log")
|
||||
```
|
||||
|
||||
And add the appender to your `ns` declaration:
|
||||
#### Email ([Postal](https://github.com/drewr/postal)) Appender
|
||||
|
||||
```clojure
|
||||
(:require [taoensso.timbre.appenders (postal :as postal-appender)])
|
||||
```
|
||||
;; [com.draines/postal "1.9.2"] ; Add to project.clj dependencies
|
||||
;; (:require [taoensso.timbre.appenders (postal :as postal-appender)]) ; Add to ns
|
||||
|
||||
Then adjust your Timbre config:
|
||||
|
||||
```clojure
|
||||
(timbre/set-config! [:appenders :postal] postal-appender/postal-appender)
|
||||
(timbre/set-config! [:shared-appender-config :postal]
|
||||
^{:host "mail.isp.net" :user "jsmith" :pass "sekrat!!1"}
|
||||
{:from "me@draines.com" :to "foo@example.com"})
|
||||
```
|
||||
|
||||
Rate-limit to one email per message per minute:
|
||||
|
||||
```clojure
|
||||
;; Rate-limit to one email per message per minute
|
||||
(timbre/set-config! [:appenders :postal :max-message-per-msecs] 60000)
|
||||
```
|
||||
|
||||
And make sure emails are sent asynchronously:
|
||||
|
||||
```clojure
|
||||
;; Make sure emails are sent asynchronously
|
||||
(timbre/set-config! [:appenders :postal :async?] true)
|
||||
```
|
||||
|
||||
### IRC Appender
|
||||
|
||||
To enable the standard [irclj](https://github.com/flatland/irclj)-based IRC appender, add the irclj dependency to your `project.clj`:
|
||||
#### IRC ([irclj](https://github.com/flatland/irclj)) Appender
|
||||
|
||||
```clojure
|
||||
[irclj "0.5.0-alpha2"]
|
||||
```
|
||||
;; [irclj "0.5.0-alpha2"] ; Add to project.clj dependencies
|
||||
;; (:require [taoensso.timbre.appenders (irc :as irc-appender)]) ; Add to ns
|
||||
|
||||
And add the appender to your `ns` declaration:
|
||||
|
||||
```clojure
|
||||
(:require [taoensso.timbre.appenders.irc :refer [irc-appender]])
|
||||
```
|
||||
|
||||
Then adjust your Timbre config:
|
||||
|
||||
```clojure
|
||||
(timbre/set-config! [:appenders :irc] irc-appender)
|
||||
(timbre/set-config! [:appenders :irc] irc-appender/irc-appender)
|
||||
(timbre/set-config! [:shared-appender-config :irc]
|
||||
{:host "irc.example.org"
|
||||
:port 6667
|
||||
|
|
|
@ -1,6 +1,5 @@
|
|||
(ns taoensso.timbre.appenders.irc
|
||||
"IRC appender for irclj.
|
||||
Ref: https://github.com/flatland/irclj."
|
||||
"IRC appender. Depends on https://github.com/flatland/irclj."
|
||||
{:author "Emlyn Corrin"}
|
||||
(:require [clojure.string :as str]
|
||||
[irclj.core :as irclj]
|
||||
|
|
|
@ -1,6 +1,5 @@
|
|||
(ns taoensso.timbre.appenders.postal
|
||||
"Email appender for com.draines/postal.
|
||||
Ref: https://github.com/drewr/postal."
|
||||
"Email appender. Depends on https://github.com/drewr/postal."
|
||||
{:author "Peter Taoussanis"}
|
||||
(:require [clojure.string :as str]
|
||||
[postal.core :as postal]
|
||||
|
|
Loading…
Reference in New Issue