DOCSP-46689: Monitoring

Author: mcmorisi

source/includes/monitoring/monitoring.py

@@ -0,0 +1,27 @@
+from pymongo import MongoClient
+from pymongo.monitoring import CommandListener, CommandSucceededEvent, ServerListener, \
+    ConnectionPoolListener, ServerHeartbeatStartedEvent, \
+    ConnectionCreatedEvent
+
+# start-monitoring
+class MyCommandListener(CommandListener):
+    def succeeded(self, event: CommandSucceededEvent):
+        print(f"Command {event.command_name} succeeded")
+
+    # Other event method implementations here
+
+class MyServerListener(ServerListener):
+    def heartbeat_started(self, event: ServerHeartbeatStartedEvent):
+        print(f"Heartbeat started on server with id: {event.connection_id}")
+
+    # Other event method implementations here
+
+class MyPoolListener(ConnectionPoolListener):
+    def connection_created(self, event: ConnectionCreatedEvent):
+        print(f"Connection {event.connection_id} created")
+
+    # Other event method implementations here
+
+listeners = [MyCommandListener(), MyServerListener(), MyPoolListener()]
+client = MongoClient("<connection URI>", event_listeners=listeners)
+# end-monitoring

source/monitoring.txt

@@ -68,4 +68,31 @@ For a copmlete list of events the driver emits, see the
 Listening for Events
 --------------------
 
-To monitor an event, you must 
+To monitor an event, you must pass an event listener to your application's ``MongoClient``.
+The following steps describe how to create monitor your application using an event listener:
+
+1. Create a class that inherits from one of the event listener base classes
+   provided by {+driver-short+}. The base class you choose depends on the type of event
+   you want to monitor. For example, to monitor command events, create a class
+   that inherits from ``CommandListener``.
+#. Implement the methods of the base class that correpond to the events you want to monitor.
+#. Pass an instance of your class to the ``MongoClient`` constructor.
+
+The following code implements a ``CommandListener`` to listen for command events, a
+``ServerListener`` to listen for SDAM events, and a ``ConnectionPoolListener`` to listen for
+connection pool events:
+
+.. literalinclude:: /includes/monitoring/monitoring.py
+   :language: python
+   :start-after: start-monitoring
+   :end-before: end-monitoring
+   :copyable: true
+
+API Documentation
+-----------------
+
+To learn more about the methods and classes used to monitor events in the driver, see the
+following API documentation:
+
+- `pymongo.monitoring <{+api-root+}pymongo/monitoring.html>`__
+- `MongoClient <{+api-root+}pymongo/mongo_client.html#pymongo.mongo_client.MongoClient>`__