diff --git a/reference/mongo/mongolog.xml b/reference/mongo/mongolog.xml
index 014c4d9a5a..d815470dd8 100644
--- a/reference/mongo/mongolog.xml
+++ b/reference/mongo/mongolog.xml
@@ -13,17 +13,8 @@
&reftitle.intro;
Logging can be used to get detailed information about what the driver is
- doing. The logging mechanism as used by MongoLog emits all log messages
- as a PHP notice. Depending on the server interface that you use,
- that means that they will either be sent to strerr (with PHP-CLI), or
- otherwise to the web server's error log. In order for log messages to
- be output by PHP their level (E_NOTICE) does need to be configured to
- be shown. That means the E_NOTICE bit needs to be part of PHP's
- error_reporting level and that display_errors is set to 1.
-
-
- Logging is turned off, by default. This class allows you to turn on
- specific levels of logging for specific parts of the driver. Some examples:
+ doing. Logging is disabled by default, but this class allows you to activate
+ specific levels of logging for various parts of the driver. Some examples:
]]>
+
+
+ By default, MongoLog emits all log messages as PHP notices. Depending
+ on the SAPI you use, messages may be sent to
+ stderr (for CLI) or the web server's
+ error log. If, after configuring MongoLog, log messages are not appearing
+ as expected, ensure that the E_NOTICE bit is included
+ in error_reporting and that
+ display_errors is on.
+
+
@@ -107,6 +109,12 @@ MongoLog::setModule(MongoLog::RS|MongoLog::POOL);
constintMongoLog::POOL
+ 1
+
+
+ const
+ int
+ MongoLog::CON2
@@ -130,13 +138,20 @@ MongoLog::setModule(MongoLog::RS|MongoLog::POOL);
Fields
- public
-
+ private
+ static
+ int
+ callback
+
+
+ private
+ staticintlevel
- public
+ private
+ staticintmodule
@@ -163,7 +178,7 @@ MongoLog::setModule(MongoLog::RS|MongoLog::POOL);
MongoLog::NONE
- Constant for turning logging off.
+ Log nothing.
@@ -171,7 +186,7 @@ MongoLog::setModule(MongoLog::RS|MongoLog::POOL);
MongoLog::ALL
- Constant for logging everything.
+ Log everything.
@@ -188,8 +203,8 @@ MongoLog::setModule(MongoLog::RS|MongoLog::POOL);
MongoLog::WARNING
- This will print log messages about somewhat exceptional but
- not-quite-exception-worthy happenings.
+ Log events that are somewhat exceptional, but not quite worthy of an
+ actual exception (e.g. recoverable connection errors).
@@ -197,8 +212,8 @@ MongoLog::setModule(MongoLog::RS|MongoLog::POOL);
MongoLog::INFO
- Logs events that may be of interest to administrators, but are not
- particularly noteworthy.
+ Log events that may be of interest to administrators, but are not
+ particularly noteworthy (e.g. option parsing, authentication steps).
@@ -206,8 +221,9 @@ MongoLog::setModule(MongoLog::RS|MongoLog::POOL);
MongoLog::FINE
- Logs most events that the driver performs. Depending on the module being
- logged, this can be extremely noisy and is primarily for debugging.
+ Log most events that the driver performs (e.g. server selection, socket
+ communication). Depending on the module being logged, this can be
+ extremely noisy and is primarily useful for debugging.
@@ -220,11 +236,20 @@ MongoLog::setModule(MongoLog::RS|MongoLog::POOL);
These constants can be used by MongoLog::setModule.
+
+ MongoLog::CON
+
+
+ Log connection activity. Creating new connections, authentication,
+ pinging, timeouts, etc.
+
+
+ MongoLog::IO
- Logs traffic to/from the database. Unless your program is trivial, this
+ Log traffic to/from the database. Unless your program is trivial, this
will create an enormous number of log messages.
@@ -233,7 +258,8 @@ MongoLog::setModule(MongoLog::RS|MongoLog::POOL);
MongoLog::PARSE
- Log server string parsing.
+ Log parsing of the connection string and options when constructing
+ MongoClient.
@@ -241,8 +267,8 @@ MongoLog::setModule(MongoLog::RS|MongoLog::POOL);
MongoLog::POOL
- Log connection pool activity. Creating new connections, reusing
- connections, and closing connections.
+ Previously used to log connection pool activity. This option is now a
+ deprecated alias of MongoLog::RS.
@@ -250,8 +276,7 @@ MongoLog::setModule(MongoLog::RS|MongoLog::POOL);
MongoLog::RS
- Log replica set activity. Failovers, pinging, chosing secondaries to
- read from, etc.
+ Log replica set activity. Failovers, read preference selection, etc.
@@ -259,8 +284,8 @@ MongoLog::setModule(MongoLog::RS|MongoLog::POOL);
MongoLog::SERVER
- Log server status changes. Detecting primary, secondary and
- duplication detection.
+ Previously used to log server status changes. This option is deprecated
+ in favor of MongoLog::RS.
@@ -268,6 +293,32 @@ MongoLog::setModule(MongoLog::RS|MongoLog::POOL);
+
+ &reftitle.changelog;
+
+
+
+
+
+ &Version;
+ &Description;
+
+
+
+
+ 1.3.0
+
+ Added MongoLog::CON and deprecated
+ MongoLog::POOL and
+ MongoLog::SERVER.
+
+
+
+
+
+
+
+
&reference.mongo.entities.mongolog;