logging-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ihabu...@apache.org
Subject git commit: LOG4PHP-207: Mongo appender documentation update.
Date Mon, 18 Mar 2013 17:52:26 GMT
Updated Branches:
  refs/heads/docs b73c0c5eb -> b73da80ab


LOG4PHP-207: Mongo appender documentation update.

Signed-off-by: Vladimir Gorej <gorej@codescale.net>
Signed-off-by: Ivan Habunek <ihabunek@apache.org>


Project: http://git-wip-us.apache.org/repos/asf/logging-log4php/repo
Commit: http://git-wip-us.apache.org/repos/asf/logging-log4php/commit/b73da80a
Tree: http://git-wip-us.apache.org/repos/asf/logging-log4php/tree/b73da80a
Diff: http://git-wip-us.apache.org/repos/asf/logging-log4php/diff/b73da80a

Branch: refs/heads/docs
Commit: b73da80ab21e9ca9a4afad5dcc2f23b3703ae3ef
Parents: b73c0c5
Author: Vladimir Gorej <gorej@codescale.net>
Authored: Mon Mar 18 18:12:18 2013 +0100
Committer: Ivan Habunek <ihabunek@apache.org>
Committed: Mon Mar 18 18:51:54 2013 +0100

----------------------------------------------------------------------
 docs/appenders/mongodb.rst |   69 ++++++++++++++++++++++++++++----------
 1 files changed, 51 insertions(+), 18 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/logging-log4php/blob/b73da80a/docs/appenders/mongodb.rst
----------------------------------------------------------------------
diff --git a/docs/appenders/mongodb.rst b/docs/appenders/mongodb.rst
index e6ea3d6..c0b0458 100644
--- a/docs/appenders/mongodb.rst
+++ b/docs/appenders/mongodb.rst
@@ -16,22 +16,55 @@ Parameters
 ----------
 The following parameters are available:
 
-+--------------+---------+----------+---------------------+-----------------------------------------------+
-| Parameter    | Type    | Required | Default             | Description                 
                 |
-+==============+=========+==========+=====================+===============================================+
-| host         | string  | No       | mongodb://localhost | Server on which mongodb instance
is located.  |
-+--------------+---------+----------+---------------------+-----------------------------------------------+
-| port         | integer | No       | 27017               | Port on which the instance is
bound.          |
-+--------------+---------+----------+---------------------+-----------------------------------------------+
-| databaseName | string  | No       | log4php_mongodb     | Name of the database to which
to log.         |
-+--------------+---------+----------+---------------------+-----------------------------------------------+
-| username     | string  | No       |                     | Username used to connect to the
database.     |
-+--------------+---------+----------+---------------------+-----------------------------------------------+
-| password     | string  | No       |                     | Password used to connect to the
database.     |
-+--------------+---------+----------+---------------------+-----------------------------------------------+
-| timeout      | integer | No       | 3000                | For how long the driver should
try to connect |
-|              |         |          |                     | to the database (in milliseconds).
           |
-+--------------+---------+----------+---------------------+-----------------------------------------------+
+Note: additional parameters supported by the driver can be supplied by **connectionString**
+
++------------------------+---------+----------+---------------------+-----------------------------------------------+
+| Parameter              | Type    | Required | Default             | Description       
                           |
++========================+=========+==========+=====================+===============================================+
+| connectionString       | string  | No       |                     | Connection string defining
one or multiple    |
+|                        |         |          |                     | hosts.            
                           |
++------------------------+---------+----------+---------------------+-----------------------------------------------+
+| host                   | string  | No       | localhost           | Server on which mongodb
instance is located.  |
++------------------------+---------+----------+---------------------+-----------------------------------------------+
+| port                   | integer | No       | 27017               | Port on which the instance
is bound.          |
++------------------------+---------+----------+---------------------+-----------------------------------------------+
+| databaseName           | string  | No       | log4php_mongodb     | Name of the database
to which to log.         |
++------------------------+---------+----------+---------------------+-----------------------------------------------+
+| collectionName         | string  | No       | logs                | Name of the collection
to which to log.       |
++------------------------+---------+----------+---------------------+-----------------------------------------------+
+| username               | string  | No       |                     | Username used to connect
to the database.     |
++------------------------+---------+----------+---------------------+-----------------------------------------------+
+| password               | string  | No       |                     | Password used to connect
to the database.     |
++------------------------+---------+----------+---------------------+-----------------------------------------------+
+| timeout                | integer | No       | 3000                | **DEPRECATED** For
how long the driver should |
+|                        |         |          |                     | try to connect to the
database                |
+|                        |         |          |                     | (in milliseconds).
Use connectionTimeout      |
+|                        |         |          |                     | instead           
                           |
++------------------------+---------+----------+---------------------+-----------------------------------------------+
+| connectionTimeout      | integer | No       |                     | How long a connection
can take to be opened   |
+|                        |         |          |                     | before timing out.
                         |
++------------------------+---------+----------+---------------------+-----------------------------------------------+
+| socketTimeout          | integer | No       |                     | How long a send or
receive on a socket can    |
+|                        |         |          |                     | take before timing
out.                       |
++------------------------+---------+----------+---------------------+-----------------------------------------------+
+| capped                 | boolean | No       | false               | Whether the collection
should be a fixed size.|
++------------------------+---------+----------+---------------------+-----------------------------------------------+
+| cappedMax              | integer | No       | 1000                | Maximum number of elements
to store.          |
++------------------------+---------+----------+---------------------+-----------------------------------------------+
+| cappedSize             | integer | No       | 1000000             | Size of capped collection
in bytes.           |
++------------------------+---------+----------+---------------------+-----------------------------------------------+
+| writeConcern           | string  | No       | 1                   | Controls how many nodes
must acknowledge the  |
+|                        |         |          |                     | write instruction before
the driver continues.|
++------------------------+---------+----------+---------------------+-----------------------------------------------+
+| writeConcernJournaled  | boolean | No       | false               | The write will be acknowledged
by primary and |
+|                        |         |          |                     | the journal flushed
to disk.                  |
++------------------------+---------+----------+---------------------+-----------------------------------------------+
+| writeConcernTimeout    | integer | No       | 3000                | Controls how many milliseconds
the server     |
+|                        |         |          |                     | waits for the write
concern to be satisfied.  |
++------------------------+---------+----------+---------------------+-----------------------------------------------+
+| replicaSet             | string  | No       |                     | The name of the replica
set to connect to.    |
+|                        |         |          |                     | Primary will be automatically
determined.     |
++------------------------+---------+----------+---------------------+-----------------------------------------------+
 
 .. versionadded:: 2.2.0
     The ``timeout`` parameter.
@@ -48,7 +81,7 @@ database.
 
         <configuration xmlns="http://logging.apache.org/log4php/">
             <appender name="default" class="LoggerAppenderMongoDB">
-                <param name="host" value="mongodb://example.com" />
+                <param name="host" value="example.com" />
                 <param name="username" value="logger" />
                 <param name="password" value="secret" />
             </appender>
@@ -65,7 +98,7 @@ database.
                 'default' => array(
                     'class' => 'LoggerAppenderMongoDB',
                     'params' => array(
-                        'host' => 'mongodb://example.com',
+                        'host' => 'example.com',
                         'username' => 'logger',
                         'password' => 'secret',
                     ),


Mime
View raw message