Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Readme!

  • Loading branch information...
commit af112a6dba507777d754e84ca4d351cd7d899407 1 parent 0e63d5f
@Vagabond Vagabond authored
Showing with 26 additions and 0 deletions.
  1. +26 −0 README.org
View
26 README.org
@@ -0,0 +1,26 @@
+* Overview
+ This is a syslog backend for [[https://github.com/basho/lager][Lager]]. It
+ allows you to send messages out of lager and into the local syslog daemon.
+
+* Configuration
+ Configure a Lager handler like the following:
+
+#+BEGIN_EXAMPLE
+ {lager_syslog_backend, [Identity, Facility, Level]}
+#+END_EXAMPLE
+
+ The Identity is the string to tag all messages with in syslog, usually the
+ application's name. The facility is the facility to log to (see the syslog
+ documentation for a list of these). The Level is the lager level at which the
+ backend accepts messages (eg. using 'info' would send all messages at info
+ level or above into syslog). While you can filter messages at the syslog
+ level, it will improve performance if you filter in lager instead.
+
+ Refer to Lager's documentation for futher information on configuring handlers.
+
+* Troubleshooting
+ There's not a lot to go wrong, but if you are not receiving messages, check
+ your syslog config and read its manpage for more information. OS X, in
+ particular, has a very strange default config where it drops messages below
+ the 'info' level by default.
+
Please sign in to comment.
Something went wrong with that request. Please try again.