Author: ihabunek
Date: Sun Jun 19 21:35:19 2011
New Revision: 1137452
URL: http://svn.apache.org/viewvc?rev=1137452&view=rev
Log:
LOG4PHP-110: Added mongodb appender documentation to the site.
Modified:
logging/log4php/trunk/src/site/apt/docs/appender/appender.apt
Modified: logging/log4php/trunk/src/site/apt/docs/appender/appender.apt
URL:
http://svn.apache.org/viewvc/logging/log4php/trunk/src/site/apt/docs/appender/appender.apt?rev=1137452&r1=1137451&r2=1137452&view=diff
==============================================================================
--- logging/log4php/trunk/src/site/apt/docs/appender/appender.apt (original)
+++ logging/log4php/trunk/src/site/apt/docs/appender/appender.apt Sun Jun 19
21:35:19 2011
@@ -115,6 +115,8 @@ $logger->info("Log this.");
*------------------------------+--------------+
| {{LoggerAppenderMailEvent}} | Sends the log via email. Each log entry is
sent in individual emails.
*------------------------------+--------------+
+| {{LoggerAppenderMongoDB}} | MongoDB.
+*------------------------------+--------------+
| {{LoggerAppenderNull}} | Ignores all log events.
*------------------------------+--------------+
| {{LoggerAppenderPDO}} | Database.
@@ -406,6 +408,53 @@ log4php.appender.default.subject = log4p
+--
+** {LoggerAppenderMongoDB}
+
+ The LoggerAppenderMongoDB appends log events to a mongoDB instance.
+
+ {{{http://www.mongodb.org/}MongoDB}} is a scalable, high-performance, open
source, document-oriented database.
+
+
+*** Configurable parameters
+
+*-------------------+--------------*--------------------+------------------------+
+|| Parameter || Required || Default value || Description
+*-------------------+--------------*--------------------+------------------------+
+| host | No | mongodb://localhost| Server on which
mongodb instance is located.
+*-------------------+--------------*--------------------+------------------------+
+| port | No | 27017 | Port on which the
instance is bound.
+*-------------------+--------------*--------------------+------------------------+
+| databaseName | No | log4php_mongodb | Name of the database
to which to log.
+*-------------------+--------------*--------------------+------------------------+
+| collectionName | No | logs | Name of the
collection within the given database.
+*-------------------+--------------*--------------------+------------------------+
+| username | No | - | Username used to
connect to the database.
+*-------------------+--------------*--------------------+------------------------+
+| password | No | - | Password used to
connect to the database.
+*-------------------+--------------*--------------------+------------------------+
+
+*** Examples
+
+ Configuration via XML file:
+
++--
+<appender name="default" class="LoggerAppenderMongoDB">
+ <param name="host" value="mongodb://myhost.com" />
+ <param name="username" value="logger" />
+ <param name="password" value="secret" />
+</appender>
++--
+
+ Configuration via ini file:
+
++--
+log4php.appender.default = LoggerAppenderMongoDB
+log4php.appender.default.host = mongodb://myhost.com
+log4php.appender.default.username = logger
+log4php.appender.default.password = secret
++--
+
+
** {LoggerAppenderNull}
The LoggerAppenderNull appender ignores all log events.
