DOCSP-47056: Monitoring (#260)

* DOCSP-47056: Monitoring

* fixes

* fix

* wording

* table

* widths

* SA feedback

* PV feedback

Author: norareidy

config/redirects

@@ -25,7 +25,7 @@ raw: ${prefix}/stable -> ${base}/current/
 # redirects in standardized docs
 [v1.20-*]: ${prefix}/${version}/tutorial/install-php-library/ -> ${base}/${version}/get-started/
 [v1.20-*]: ${prefix}/${version}/tutorial/connecting/ -> ${base}/${version}/connect/
-[v1.20-*]: ${prefix}/${version}/tutorial/server-selection/ -> ${base}/${version}/monitoring/cluster-monitoring/
+[v1.20-*]: ${prefix}/${version}/tutorial/server-selection/ -> ${base}/${version}/monitoring-logging/monitoring/
 [v1.20-*]: ${prefix}/${version}/tutorial/crud/ -> ${base}/${version}/read/
 [v1.20-*]: ${prefix}/${version}/tutorial/codecs/ -> ${base}/${version}/data-formats/codecs/
 [v1.20-*]: ${prefix}/${version}/tutorial/collation/ -> ${base}/${version}/
@@ -45,7 +45,7 @@ raw: ${prefix}/stable -> ${base}/current/
 # note: this mapping does not account for all of the new pages
 [*-v1.19]: ${prefix}/${version}/tutorial/install-php-library/ -> ${base}/v1.x/get-started/
 [*-v1.19]: ${prefix}/${version}/tutorial/connecting/ -> ${base}/v1.x/connect/
-[*-v1.19]: ${prefix}/${version}/tutorial/server-selection/ -> ${base}/v1.x/monitoring/cluster-monitoring/
+[*-v1.19]: ${prefix}/${version}/tutorial/server-selection/ -> ${base}/v1.x/monitoring-logging/monitoring/
 [*-v1.19]: ${prefix}/${version}/tutorial/crud/ -> ${base}/v1.x/read/
 [*-v1.19]: ${prefix}/${version}/tutorial/codecs/ -> ${base}/v1.x/data-formats/codecs/
 [*-v1.19]: ${prefix}/${version}/tutorial/collation/ -> ${base}/v1.x/
@@ -84,7 +84,7 @@ raw: ${prefix}/stable -> ${base}/current/
 [*-master]: ${prefix}/${version}/data-formats/codecs/ -> ${base}/${version}/data-formats/custom-types/codecs/
 [*-master]: ${prefix}/${version}/databases-collections/time-series/ -> ${base}/${version}/data-formats/time-series/
 [*-master]: ${prefix}/${version}/read/change-streams/ -> ${base}/${version}/monitoring-logging/change-streams/
-[*-master]: ${prefix}/${version}/monitoring/cluster-monitoring/ -> ${base}/${version}/monitoring-logging/cluster-monitoring/
+[*-master]: ${prefix}/${version}/monitoring/cluster-monitoring/ -> ${base}/${version}/monitoring-logging/monitoring/
 [*-master]: ${prefix}/${version}/compatibility/ -> ${base}/${version}/references/compatibility/
 [*-master]: ${prefix}/${version}/whats-new/ -> ${base}/${version}/references/release-notes/
 [*-master]: ${prefix}/${version}/upgrade/ -> ${base}/${version}/references/upgrade/

source/includes/monitoring/sdam.php renamed to source/includes/monitoring/monitor.php

@@ -2,21 +2,39 @@
 
 require __DIR__ . '/vendor/autoload.php';
 
-// start-mysubscriber
-class MySubscriber implements MongoDB\Driver\Monitoring\SDAMSubscriber
+// start-command-subscriber
+class MyCommandSubscriber implements MongoDB\Driver\Monitoring\CommandSubscriber
 {
-    /** @param resource $stream */
-    public function __construct(private $stream)
+    public function __construct(private $stream) {}
+
+    public function commandStarted(MongoDB\Driver\Monitoring\CommandStartedEvent $event): void
     {
+        fwrite($this->stream, sprintf(
+            'Started command #%d "%s": %s%s',
+            $event->getRequestId(),
+            $event->getCommandName(),
+            MongoDB\BSON\Document::fromPHP($event->getCommand())->toCanonicalExtendedJSON(),
+            PHP_EOL,
+        ));
     }
 
-    public function serverOpening(MongoDB\Driver\Monitoring\ServerOpeningEvent $event): void
-    {
+    public function commandSucceeded(MongoDB\Driver\Monitoring\CommandSucceededEvent $event): void {}
+    public function commandFailed(MongoDB\Driver\Monitoring\CommandFailedEvent $event): void {}
+}
+// end-command-subscriber
+
+// start-sdam-subscriber
+class MySDAMSubscriber implements MongoDB\Driver\Monitoring\SDAMSubscriber
+{
+    public function __construct(private $stream) {}
+
+    public function serverOpening(MongoDB\Driver\Monitoring\ServerOpeningEvent $event): void {
         fprintf(
             $this->stream,
             'Server opening on %s:%s\n',
             $event->getHost(),
             $event->getPort(),
+            PHP_EOL,
         );
     }
 
@@ -52,20 +70,23 @@ public function topologyOpening(MongoDB\Driver\Monitoring\TopologyOpeningEvent $
     {
     }
 }
-// end-mysubscriber
+// end-sdam-subscriber
 
 $uri = getenv('MONGODB_URI') ?: throw new RuntimeException('Set the MONGODB_URI variable to your connection URI');
 $client = new MongoDB\Client($uri);
 
 $collection = $client->db->my_coll;
 
-// start-add-sub
-$subscriber = new MySubscriber(STDERR);
-$client->addSubscriber($subscriber);
-// end-add-sub
+// start-add-subs
+$commandSub = new MyCommandSubscriber(STDERR);
+$sdamSub = new MySDAMSubscriber(STDERR);
+
+$client->addSubscriber($commandSub);
+$client->addSubscriber($sdamSub);
+// end-add-subs
 
 $collection->insertOne(['x' => 100]);
 
 // start-remove-sub
-$client->removeSubscriber($subscriber);
+$client->removeSubscriber($commandSub);
 // end-remove-sub

source/monitoring-logging.txt

@@ -8,11 +8,11 @@ Monitoring and Logging
 .. toctree::
    :caption: Monitoring categories
 
-   Cluster Monitoring </monitoring-logging/cluster-monitoring>
+   Monitoring </monitoring-logging/monitoring>
    Change Streams </monitoring-logging/change-streams>
 
 .. /monitoring/command-monitoring
 .. /monitoring/connection-monitoring
 
-- :ref:`Cluster Monitoring <php-cluster-monitoring>`: Monitor changes
-  in your cluster configuration
+- :ref:`Monitor Application Events <php-monitoring>`: Monitor changes
+  in your application