rest of apm methods

mongodb · Mar 25, 2024 · 720bdd4 · 720bdd4
1 parent 81317be
commit 720bdd4
Show file tree

Hide file tree

Showing 32 changed files with 295 additions and 244 deletions.
diff --git a/...mongoc_apm_server_opening_get_context.rst → ...mongoc_apm_server_opening_get_context.txt b/...mongoc_apm_server_opening_get_context.rst → ...mongoc_apm_server_opening_get_context.txt
@@ -1,5 +1,6 @@
-.. _mongoc_apm_server_opening_get_context
+.. _mongoc_apm_server_opening_get_context:
 
+=======================================
 mongoc_apm_server_opening_get_context()
 =======================================
 

diff --git a/...ng/mongoc_apm_server_opening_get_host.rst → ...ng/mongoc_apm_server_opening_get_host.txt b/...ng/mongoc_apm_server_opening_get_host.rst → ...ng/mongoc_apm_server_opening_get_host.txt
@@ -1,5 +1,6 @@
-.. _mongoc_apm_server_opening_get_host
+.. _mongoc_apm_server_opening_get_host:
 
+====================================
 mongoc_apm_server_opening_get_host()
 ====================================
 
@@ -8,10 +9,12 @@ Synopsis
 
 .. code-block:: c
 
-  const mongoc_host_list_t *
-  mongoc_apm_server_opening_get_host (const mongoc_apm_server_opening_t *event);
+   const mongoc_host_list_t *
+   mongoc_apm_server_opening_get_host (const mongoc_apm_server_opening_t *event);
 
-Returns this event's host. This :ref:`mongoc_host_list_t` is *not- part of a linked list, it is solely the server for this event. The data is only valid in the scope of the callback that receives this event; copy it if it will be accessed after the callback returns.
+Returns this event's host. This :ref:`mongoc_host_list_t` is *not* part of a linked list,
+it is solely the server for this event. The data is only valid in the scope of the callback
+that receives this event; copy it if it will be accessed after the callback returns.
 
 Parameters
 ----------

diff --git a/...oc_apm_server_opening_get_topology_id.rst → ...oc_apm_server_opening_get_topology_id.txt b/...oc_apm_server_opening_get_topology_id.rst → ...oc_apm_server_opening_get_topology_id.txt
@@ -1,5 +1,6 @@
-.. _mongoc_apm_server_opening_get_topology_id
+.. _mongoc_apm_server_opening_get_topology_id:
 
+===========================================
 mongoc_apm_server_opening_get_topology_id()
 ===========================================
 
@@ -8,9 +9,9 @@ Synopsis
 
 .. code-block:: c
 
-  void
-  mongoc_apm_server_opening_get_topology_id (
-     const mongoc_apm_server_opening_t *event, bson_oid_t *topology_id);
+   void
+   mongoc_apm_server_opening_get_topology_id (
+      const mongoc_apm_server_opening_t *event, bson_oid_t *topology_id);
 
 Returns this event's topology id.
 

diff --git a/...onitoring/mongoc_apm_server_opening_t.rst → ...onitoring/mongoc_apm_server_opening_t.txt b/...onitoring/mongoc_apm_server_opening_t.rst → ...onitoring/mongoc_apm_server_opening_t.txt
@@ -1,5 +1,6 @@
-.. _mongoc_apm_server_opening_t
+.. _mongoc_apm_server_opening_t:
 
+===========================
 mongoc_apm_server_opening_t
 ===========================
 
@@ -8,7 +9,8 @@ Server-opening event
 Synopsis
 --------
 
-An event notification sent when the driver adds a :ref:`mongoc_server_description_t` for a new server it was not monitoring before.
+An event notification sent when the driver adds a :ref:`mongoc_server_description_t` for a new
+server it was not monitoring before.
 
 .. seealso::
 

diff --git a/...ring/mongoc_apm_set_command_failed_cb.rst → ...ring/mongoc_apm_set_command_failed_cb.txt b/...ring/mongoc_apm_set_command_failed_cb.rst → ...ring/mongoc_apm_set_command_failed_cb.txt
@@ -1,5 +1,6 @@
-.. _mongoc_apm_set_command_failed_cb
+.. _mongoc_apm_set_command_failed_cb:
 
+==================================
 mongoc_apm_set_command_failed_cb()
 ==================================
 
@@ -8,20 +9,21 @@ Synopsis
 
 .. code-block:: c
 
-  typedef void (*mongoc_apm_command_failed_cb_t) (
-     const mongoc_apm_command_failed_t *event);
+   typedef void (*mongoc_apm_command_failed_cb_t) (
+      const mongoc_apm_command_failed_t *event);
 
-  void
-  mongoc_apm_set_command_failed_cb (mongoc_apm_callbacks_t *callbacks,
-                                    mongoc_apm_command_failed_cb_t cb);
+   void
+   mongoc_apm_set_command_failed_cb (mongoc_apm_callbacks_t *callbacks,
+                                     mongoc_apm_command_failed_cb_t cb);
 
 Receive an event notification whenever the driver fails to execute a MongoDB operation.
 
 Parameters
 ----------
 
 - ``callbacks``: A :ref:`mongoc_apm_callbacks_t`.
-- ``cb``: A function to call with a :ref:`mongoc_apm_command_failed_t` whenever a MongoDB operation fails.
+- ``cb``: A function to call with a :ref:`mongoc_apm_command_failed_t` whenever a MongoDB
+  operation fails.
 
 .. seealso::
 

diff --git a/...ing/mongoc_apm_set_command_started_cb.rst → ...ing/mongoc_apm_set_command_started_cb.txt b/...ing/mongoc_apm_set_command_started_cb.rst → ...ing/mongoc_apm_set_command_started_cb.txt
@@ -1,5 +1,6 @@
-.. _mongoc_apm_set_command_started_cb
+.. _mongoc_apm_set_command_started_cb:
 
+===================================
 mongoc_apm_set_command_started_cb()
 ===================================
 
@@ -8,20 +9,21 @@ Synopsis
 
 .. code-block:: c
 
-  typedef void (*mongoc_apm_command_started_cb_t) (
-     const mongoc_apm_command_started_t *event);
+   typedef void (*mongoc_apm_command_started_cb_t) (
+      const mongoc_apm_command_started_t *event);
 
-  void
-  mongoc_apm_set_command_started_cb (mongoc_apm_callbacks_t *callbacks,
-                                     mongoc_apm_command_started_cb_t cb);
+   void
+   mongoc_apm_set_command_started_cb (mongoc_apm_callbacks_t *callbacks,
+                                      mongoc_apm_command_started_cb_t cb);
 
 Receive an event notification whenever the driver starts a MongoDB operation.
 
 Parameters
 ----------
 
 - ``callbacks``: A :ref:`mongoc_apm_callbacks_t`.
-- ``cb``: A function to call with a :ref:`mongoc_apm_command_started_t` whenever the driver begins a MongoDB operation.
+- ``cb``: A function to call with a :ref:`mongoc_apm_command_started_t` whenever the driver
+  begins a MongoDB operation.
 
 .. seealso::
 

diff --git a/...g/mongoc_apm_set_command_succeeded_cb.rst → ...g/mongoc_apm_set_command_succeeded_cb.txt b/...g/mongoc_apm_set_command_succeeded_cb.rst → ...g/mongoc_apm_set_command_succeeded_cb.txt
@@ -1,5 +1,6 @@
-.. _mongoc_apm_set_command_succeeded_cb
+.. _mongoc_apm_set_command_succeeded_cb:
 
+=====================================
 mongoc_apm_set_command_succeeded_cb()
 =====================================
 
@@ -8,11 +9,11 @@ Synopsis
 
 .. code-block:: c
 
-  typedef void (*mongoc_apm_command_succeeded_cb_t) (
-     const mongoc_apm_command_succeeded_t *event);
+   typedef void (*mongoc_apm_command_succeeded_cb_t) (
+      const mongoc_apm_command_succeeded_t *event);
 
-  void
-  mongoc_apm_set_command_succeeded_cb (mongoc_apm_callbacks_t *callbacks,
+   void
+   mongoc_apm_set_command_succeeded_cb (mongoc_apm_callbacks_t *callbacks,
                                        mongoc_apm_command_succeeded_cb_t cb);
 
 Receive an event notification whenever the driver completes a MongoDB operation.
@@ -21,7 +22,8 @@ Parameters
 ----------
 
 - ``callbacks``: A :ref:`mongoc_apm_callbacks_t`.
-- ``cb``: A function to call with a :ref:`mongoc_apm_command_succeeded_t` whenever the driver completes a MongoDB operation.
+- ``cb``: A function to call with a :ref:`mongoc_apm_command_succeeded_t` whenever the driver
+  completes a MongoDB operation.
 
 .. seealso::
 

diff --git a/...ring/mongoc_apm_set_server_changed_cb.rst → ...ring/mongoc_apm_set_server_changed_cb.txt b/...ring/mongoc_apm_set_server_changed_cb.rst → ...ring/mongoc_apm_set_server_changed_cb.txt
@@ -1,5 +1,6 @@
-.. _mongoc_apm_set_server_changed_cb
+.. _mongoc_apm_set_server_changed_cb:
 
+==================================
 mongoc_apm_set_server_changed_cb()
 ==================================
 
@@ -8,14 +9,15 @@ Synopsis
 
 .. code-block:: c
 
-  typedef void (*mongoc_apm_server_changed_cb_t) (
-     const mongoc_apm_server_changed_t *event);
+   typedef void (*mongoc_apm_server_changed_cb_t) (
+      const mongoc_apm_server_changed_t *event);
 
-  void
-  mongoc_apm_set_server_changed_cb (mongoc_apm_callbacks_t *callbacks,
-                                    mongoc_apm_server_changed_cb_t cb);
+   void
+   mongoc_apm_set_server_changed_cb (mongoc_apm_callbacks_t *callbacks,
+                                     mongoc_apm_server_changed_cb_t cb);
 
-Receive an event notification whenever the driver observes a change in status of a server it is connected to.
+Receive an event notification whenever the driver observes a change in status of a server
+it is connected to.
 
 Parameters
 ----------

diff --git a/...oring/mongoc_apm_set_server_closed_cb.rst → ...oring/mongoc_apm_set_server_closed_cb.txt b/...oring/mongoc_apm_set_server_closed_cb.rst → ...oring/mongoc_apm_set_server_closed_cb.txt
@@ -1,5 +1,6 @@
-.. _mongoc_apm_set_server_closed_cb
+.. _mongoc_apm_set_server_closed_cb:
 
+=================================
 mongoc_apm_set_server_closed_cb()
 =================================
 
@@ -8,20 +9,22 @@ Synopsis
 
 .. code-block:: c
 
-  typedef void (*mongoc_apm_server_closed_cb_t) (
-     const mongoc_apm_server_closed_t *event);
+   typedef void (*mongoc_apm_server_closed_cb_t) (
+      const mongoc_apm_server_closed_t *event);
 
-  void
-  mongoc_apm_set_server_closed_cb (mongoc_apm_callbacks_t *callbacks,
-                                   mongoc_apm_server_closed_cb_t cb);
+   void
+   mongoc_apm_set_server_closed_cb (mongoc_apm_callbacks_t *callbacks,
+                                    mongoc_apm_server_closed_cb_t cb);
 
-Receive an event notification whenever the driver stops monitoring a server and removes its :ref:`mongoc_server_description_t`.
+Receive an event notification whenever the driver stops monitoring a server and removes
+its :ref:`mongoc_server_description_t`.
 
 Parameters
 ----------
 
 - ``callbacks``: A :ref:`mongoc_apm_callbacks_t`.
-- ``cb``: A function to call with a :ref:`mongoc_apm_server_closed_t` whenever the driver stops monitoring a server and removes its :ref:`mongoc_server_description_t`.
+- ``cb``: A function to call with a :ref:`mongoc_apm_server_closed_t` whenever the driver
+  stops monitoring a server and removes its :ref:`mongoc_server_description_t`.
 
 .. seealso::
 

diff --git a/...oc_apm_set_server_heartbeat_failed_cb.rst → ...oc_apm_set_server_heartbeat_failed_cb.txt b/...oc_apm_set_server_heartbeat_failed_cb.rst → ...oc_apm_set_server_heartbeat_failed_cb.txt
@@ -1,5 +1,6 @@
-.. _mongoc_apm_set_server_heartbeat_failed_cb
+.. _mongoc_apm_set_server_heartbeat_failed_cb:
 
+===========================================
 mongoc_apm_set_server_heartbeat_failed_cb()
 ===========================================
 
@@ -8,12 +9,12 @@ Synopsis
 
 .. code-block:: c
 
-  typedef void (*mongoc_apm_server_heartbeat_failed_cb_t) (
+   typedef void (*mongoc_apm_server_heartbeat_failed_cb_t) (
      const mongoc_apm_server_heartbeat_failed_t *event);
 
-  void
-  mongoc_apm_set_server_heartbeat_failed_cb (mongoc_apm_callbacks_t *callbacks,
-                                             mongoc_apm_server_heartbeat_failed_cb_t cb);
+   void
+   mongoc_apm_set_server_heartbeat_failed_cb (mongoc_apm_callbacks_t *callbacks,
+                                              mongoc_apm_server_heartbeat_failed_cb_t cb);
 
 Receive an event notification whenever the driver fails to send a "hello" command to check the status of a server.
 

diff --git a/...plication-performance-monitoring/mongoc_apm_set_server_heartbeat_started_cb.rst b/...plication-performance-monitoring/mongoc_apm_set_server_heartbeat_started_cb.rst
diff --git a/...bmongoc/application-performance-monitoring/mongoc_apm_set_server_heartbeat_started_cb.txt b/...bmongoc/application-performance-monitoring/mongoc_apm_set_server_heartbeat_started_cb.txt
@@ -0,0 +1,32 @@
+.. _mongoc_apm_set_server_heartbeat_started_cb:
+
+============================================
+mongoc_apm_set_server_heartbeat_started_cb()
+============================================
+
+Synopsis
+--------
+
+.. code-block:: c
+
+   typedef void (*mongoc_apm_server_heartbeat_started_cb_t) (
+      const mongoc_apm_server_heartbeat_started_t *event);
+
+   void
+   mongoc_apm_set_server_heartbeat_started_cb (mongoc_apm_callbacks_t *callbacks,
+                                               mongoc_apm_server_heartbeat_started_cb_t cb);
+
+Receive an event notification whenever the driver begins executing a "hello" command to check
+the status of a server.
+
+Parameters
+----------
+
+- ``callbacks``: A :ref:`mongoc_apm_callbacks_t`.
+- ``cb``: A function to call with a :ref:`mongoc_apm_server_heartbeat_started_t` whenever the
+  driver begins executing a "hello" command to check the status of a server.
+
+.. seealso::
+
+  | :ref:`Introduction to Application Performance Monitoring <mongoc_application_performance_monitoring>`
+
diff --git a/...ication-performance-monitoring/mongoc_apm_set_server_heartbeat_succeeded_cb.rst b/...ication-performance-monitoring/mongoc_apm_set_server_heartbeat_succeeded_cb.rst
diff --git a/...ongoc/application-performance-monitoring/mongoc_apm_set_server_heartbeat_succeeded_cb.txt b/...ongoc/application-performance-monitoring/mongoc_apm_set_server_heartbeat_succeeded_cb.txt
@@ -0,0 +1,32 @@
+.. _mongoc_apm_set_server_heartbeat_succeeded_cb:
+
+==============================================
+mongoc_apm_set_server_heartbeat_succeeded_cb()
+==============================================
+
+Synopsis
+--------
+
+.. code-block:: c
+
+   typedef void (*mongoc_apm_server_heartbeat_succeeded_cb_t) (
+      const mongoc_apm_server_heartbeat_succeeded_t *event);
+
+   void
+   mongoc_apm_set_server_heartbeat_succeeded_cb (mongoc_apm_callbacks_t *callbacks,
+                                                 mongoc_apm_server_heartbeat_succeeded_cb_t cb);
+
+Receive an event notification whenever the driver completes a "hello" command to check the
+status of a server.
+
+Parameters
+----------
+
+- ``callbacks``: A :ref:`mongoc_apm_callbacks_t`.
+- ``cb``: A function to call with a :ref:`mongoc_apm_server_heartbeat_succeeded_t` whenever the
+- driver completes a "hello" command to check the status of a server.
+
+.. seealso::
+
+  | :ref:`Introduction to Application Performance Monitoring <mongoc_application_performance_monitoring>`
+