feedback

Author: norareidy

source/monitoring-logging.txt

@@ -18,4 +18,6 @@ Monitoring and Logging
 - :ref:`Cluster Monitoring <php-cluster-monitoring>`: Monitor changes
   in your cluster configuration
 - :ref:`Logging <php-logging>`: Configure logging to receive messages
-  about {+library-short+} events
+  about {+library-short+} events
+- :ref:`Change Streams <php-change-streams>`: Monitor data changes in 
+  your application

source/monitoring-logging/logging.txt

@@ -26,100 +26,62 @@ information about database operations, server connections, errors,
 and other events that occur while your application runs.
 
 The {+library-short+} supports `Psr\\Log\\LoggerInterface
-<https://www.php-fig.org/psr/psr-3/#3-psrlogloggerinterface>`__, a PSR-3
+<https://www.php-fig.org/psr/psr-3>`__, a PSR-3
 logger interface that configures your application to receive log messages.
 You can register one or more ``Psr\Log\LoggerInterface`` objects to
 send messages to the logger. The {+library-short+} is built on top of
-``libmongoc`` and the {+extension-short+}, so the logger receives event notifications
+the MongoDB C driver and the {+extension-short+}, so the logger receives event notifications
 from both components.
 
-Register a Logger
+Configure Logging
 -----------------
 
 To configure your application to receive messages about driver events,
 create a logger class that implements the ``Psr\Log\LoggerInterface``
 interface. Then, use the ``MongoDB\add_logger()`` function to register
 your logger.
 
-Each log message includes the following information:
+After registering a logger, the {+library-short+} generates log messages
+as array values that resemble the following sample message:
 
-- Log level: Indicates the severity of the message. To view a list of 
-  possible levels, see `PSR\\Log\\LogLevel <https://www.php-fig.org/psr/psr-3/#5-psrlogloglevel>`__.
-- Message: Describes the logged event.
-- Domain string: Specifies the driver component that emitted the log message.
+.. code-block:: php
+   :copyable: false
+
+   [0] => Array
+       (
+          [0] => debug
+          [1] => Created client with hash: ...
+          [2] => PHONGO
+       )
+
+The sample log message includes the following information:
+
+- Log level: Indicates the severity of the message. The ``debug`` level corresponds to
+  standard driver activities. To view a list of possible levels, see `PSR\\Log\\LogLevel <https://www.php-fig.org/psr/psr-3/#5-psrlogloglevel>`__.
+- Message: Describes the logged event, which signals the creation of a new client.
+- Domain string: Specifies the driver component that emitted the log message. The
+  ``PHONGO`` domain indicates that the {+extension-short+} generated the event.
+
+Example
+~~~~~~~
 
 To implement ``Psr\Log\LoggerInterface``, you can create a class that
 extends the ``Psr\Log\AbstractLogger`` class. ``AbstractLogger`` implements
 ``LoggerInterface`` and a generic ``log()`` method, which receives log
 messages at each severity level.
 
-Example
-~~~~~~~
-
 This example performs the following actions:
 
 - Creates a logger called ``MyLogger`` that extends the ``AbstractLogger`` class
   and records the log level, description, and domain of each event
 - Registers the logger
-- Creates a client that connects to a CosmosDB cluster
 - Prints each log message
 
-.. io-code-block::
-   :copyable:
-
-   .. input:: /includes/monitoring-logging/logging.php
-      :start-after: start-register-logger
-      :end-before: end-register-logger
-      :language: php
-      :dedent:
-
-   .. output::
-      :visible: false
-
-      Array
-      (
-          [0] => Array
-              (
-                  [0] => debug
-                  [1] => Connection string: 'mongodb://a.mongo.cosmos.azure.com:19555/'
-                  [2] => PHONGO
-              )
-          [1] => Array
-              (
-                  [0] => debug
-                  [1] => Creating Manager, phongo-1.21.0[stable] - mongoc-1.30.1(bundled), libbson-1.30.1(bundled), php-8.4.4
-                  [2] => PHONGO
-              )
-          [2] => Array
-              (
-                  [0] => debug
-                  [1] => Setting driver handshake data: { name: 'ext-mongodb:PHP / PHPLIB ', version: '1.21.0 / 1.21.1 ', platform: 'PHP 8.4.4 ' }
-                  [2] => PHONGO
-              )
-          [3] => Array
-              (
-                  [0] => info
-                  [1] => You appear to be connected to a CosmosDB cluster. For more information regarding feature compatibility and support please visit https://www.mongodb.com/supportability/cosmosdb
-                  [2] => mongoc
-              )
-          [4] => Array
-              (
-                  [0] => debug
-                  [1] => Created client with hash: a:4:{s:3:"pid";i:61731;s:3:"uri";s:41:"mongodb://a.mongo.cosmos.azure.com:19555/";s:7:"options";a:0:{}s:13:"driverOptions";a:1:{s:6:"driver";a:2:{s:4:"name";s:6:"PHPLIB";s:7:"version";s:6:"1.21.1";}}}
-                  [2] => PHONGO
-              )
-          [5] => Array
-              (
-                  [0] => debug
-                  [1] => Stored persistent client with hash: a:4:{s:3:"pid";i:61731;s:3:"uri";s:41:"mongodb://a.mongo.cosmos.azure.com:19555/";s:7:"options";a:0:{}s:13:"driverOptions";a:1:{s:6:"driver";a:2:{s:4:"name";s:6:"PHPLIB";s:7:"version";s:6:"1.21.1";}}}
-                  [2] => PHONGO
-              )
-      )
-
-The preceding output includes log messages with a ``debug`` severity level, which
-describe normal driver activities. It also includes a message about the CosmosDB
-connection with an ``info`` level that describes a noteworthy but non-urgent
-event.
+.. literalinclude:: /includes/monitoring-logging/logging.php
+   :language: php
+   :start-after: start-register-logger
+   :end-before: end-register-logger
+   :dedent:
 
 Write Custom Log Messages
 -------------------------
@@ -189,7 +151,6 @@ following API documentation:
 
 - :phpmethod:`MongoDB\add_logger()`
 - :phpmethod:`MongoDB\remove_logger()`
-
-To learn more about C driver logging behavior, see `Logging
+To learn more about how the underlying C driver generates log messages, see `Logging
 <https://mongoc.org/libmongoc/current/logging.html>`__ in the ``libmongoc``
 API documentation.