From 615b534b56f360f6b32c16c283e13e20a9bb4f57 Mon Sep 17 00:00:00 2001
From: Arif Amirani <arif.a@directi.com>
Date: Thu, 12 Jan 2012 15:00:34 +0530
Subject: [PATCH] Added README for gelf appender

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/README.md b/README.md
index 9453a70..7213794 100644
--- a/README.md
+++ b/README.md
@@ -220,6 +220,24 @@ This was mainly created for [cluster](https://github.com/LearnBoost/cluster), bu
       .listen(3000);
 </pre>
 
+## gelf logger
+
+A gelf logger has been added to log4js, by [arifamirani](https://github.com/arifamirani). This allows log4js to log to [GELF](http://www.graylog2.org/about/gelf) compatible servers such as [Graylog](http://www.graylog2.org/). This is currently configuration based and needs the following configuration to be added to log4j.json. For example:
+
+<pre>
+    {
+        "appenders": [  
+            {
+                "type": "gelf",
+                "host": "logs.mydomain.com", //defaults to localhost
+                "hostname":"mrs-dev", //defaults to the value returned by os.hostname()
+                "port": "12201", //defaults to 12201
+                "facility": "myapp" //defaults to nodejs-server
+            }
+        }
+    }
+</pre>
+
 ## author (of this node version)
 
 Gareth Jones (csausdev - gareth.jones@sensis.com.au)