Add README
Project: http://git-wip-us.apache.org/repos/asf/couchdb-twig/repo Commit: http://git-wip-us.apache.org/repos/asf/couchdb-twig/commit/edf6cc45 Tree: http://git-wip-us.apache.org/repos/asf/couchdb-twig/tree/edf6cc45 Diff: http://git-wip-us.apache.org/repos/asf/couchdb-twig/diff/edf6cc45 Branch: refs/heads/import Commit: edf6cc45dbacaa72795b88032343b54a5d0e2096 Parents: 998f7fe Author: Adam Kocoloski <[email protected]> Authored: Tue Mar 8 14:32:09 2011 -0500 Committer: Adam Kocoloski <[email protected]> Committed: Tue Mar 8 14:32:09 2011 -0500 ---------------------------------------------------------------------- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/couchdb-twig/blob/edf6cc45/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md new file mode 100644 index 0000000..e8de775 --- /dev/null +++ b/README.md @@ -0,0 +1,9 @@ +Twig is a SASL-compliant Erlang/OTP logger. It installs a gen_event handler in the error_logger event manager, where it consumes standard OTP reports and messages as well as events generated by twig:log/2,3,4. Log messages are written to a syslog server over UDP using the format specified in RFC 5424. + +Twig's behavior is controlled using the application environment: + +* host (undefined): the hostname of the syslog server +* port (514): the port of the syslog server +* facility (local2): syslog facility to be used +* level (info): logging threshold. Messages "above" this threshold (in syslog parlance) will be discarded. Acceptable values are debug, info, notice, warn, err, crit, alert, and emerg. +* appid ("twig"): inserted as the APPID in the syslog message
