CDRIVER-4059 service_id on command monitoring events (#834)

Author: jmikola

src/libmongoc/doc/mongoc_apm_command_failed_get_service_id.rst

@@ -0,0 +1,26 @@
+:man_page: mongoc_apm_command_failed_get_service_id
+
+mongoc_apm_command_failed_get_service_id()
+==========================================
+
+Synopsis
+--------
+
+.. code-block:: c
+
+  const bson_oid_t *
+  mongoc_apm_command_failed_get_service_id (
+     const mongoc_apm_command_failed_t *event);
+
+Returns this event's service ID, which identifies the MongoDB service behind a
+load balancer, or ``NULL`` if not connected to a load balanced cluster.
+
+Parameters
+----------
+
+* ``event``: A :symbol:`mongoc_apm_command_failed_t`.
+
+Returns
+-------
+
+A :symbol:`bson_oid_t` that should not be modified or freed or ``NULL``.

src/libmongoc/doc/mongoc_apm_command_failed_t.rst

@@ -28,6 +28,7 @@ An event notification sent when the driver fails to execute a MongoDB command.
     mongoc_apm_command_failed_get_reply
     mongoc_apm_command_failed_get_request_id
     mongoc_apm_command_failed_get_server_id
+    mongoc_apm_command_failed_get_service_id
 
 .. seealso::
 

src/libmongoc/doc/mongoc_apm_command_started_get_service_id.rst

@@ -0,0 +1,26 @@
+:man_page: mongoc_apm_command_started_get_service_id
+
+mongoc_apm_command_started_get_service_id()
+===========================================
+
+Synopsis
+--------
+
+.. code-block:: c
+
+  const bson_oid_t *
+  mongoc_apm_command_started_get_service_id (
+     const mongoc_apm_command_started_t *event);
+
+Returns this event's service ID, which identifies the MongoDB service behind a
+load balancer, or ``NULL`` if not connected to a load balanced cluster.
+
+Parameters
+----------
+
+* ``event``: A :symbol:`mongoc_apm_command_started_t`.
+
+Returns
+-------
+
+A :symbol:`bson_oid_t` that should not be modified or freed or ``NULL``.

src/libmongoc/doc/mongoc_apm_command_started_t.rst

@@ -31,4 +31,5 @@ An event notification sent when the driver begins executing a MongoDB command.
     mongoc_apm_command_started_get_operation_id
     mongoc_apm_command_started_get_request_id
     mongoc_apm_command_started_get_server_id
+    mongoc_apm_command_started_get_service_id
 

src/libmongoc/doc/mongoc_apm_command_succeeded_get_service_id.rst

@@ -0,0 +1,26 @@
+:man_page: mongoc_apm_command_succeeded_get_service_id
+
+mongoc_apm_command_succeeded_get_service_id()
+=============================================
+
+Synopsis
+--------
+
+.. code-block:: c
+
+  const bson_oid_t *
+  mongoc_apm_command_succeeded_get_service_id (
+     const mongoc_apm_command_succeeded_t *event);
+
+Returns this event's service ID, which identifies the MongoDB service behind a
+load balancer, or ``NULL`` if not connected to a load balanced cluster.
+
+Parameters
+----------
+
+* ``event``: A :symbol:`mongoc_apm_command_succeeded_t`.
+
+Returns
+-------
+
+A :symbol:`bson_oid_t` that should not be modified or freed or ``NULL``.

src/libmongoc/doc/mongoc_apm_command_succeeded_t.rst

@@ -31,4 +31,5 @@ An event notification sent when the driver successfully executes a MongoDB comma
     mongoc_apm_command_succeeded_get_reply
     mongoc_apm_command_succeeded_get_request_id
     mongoc_apm_command_succeeded_get_server_id
+    mongoc_apm_command_succeeded_get_service_id
 

src/libmongoc/src/mongoc/mongoc-apm-private.h

@@ -55,6 +55,7 @@ struct _mongoc_apm_command_started_t {
    int64_t operation_id;
    const mongoc_host_list_t *host;
    uint32_t server_id;
+   bson_oid_t service_id;
    void *context;
 };
 
@@ -67,6 +68,7 @@ struct _mongoc_apm_command_succeeded_t {
    int64_t operation_id;
    const mongoc_host_list_t *host;
    uint32_t server_id;
+   bson_oid_t service_id;
    void *context;
 };
 
@@ -80,6 +82,7 @@ struct _mongoc_apm_command_failed_t {
    int64_t operation_id;
    const mongoc_host_list_t *host;
    uint32_t server_id;
+   bson_oid_t service_id;
    void *context;
 };
 
@@ -155,6 +158,7 @@ mongoc_apm_command_started_init (mongoc_apm_command_started_t *event,
                                  int64_t operation_id,
                                  const mongoc_host_list_t *host,
                                  uint32_t server_id,
+                                 const bson_oid_t *service_id,
                                  bool *is_redacted, /* out */
                                  void *context);
 
@@ -177,6 +181,7 @@ mongoc_apm_command_succeeded_init (mongoc_apm_command_succeeded_t *event,
                                    int64_t operation_id,
                                    const mongoc_host_list_t *host,
                                    uint32_t server_id,
+                                   const bson_oid_t *service_id,
                                    bool force_redaction,
                                    void *context);
 
@@ -193,6 +198,7 @@ mongoc_apm_command_failed_init (mongoc_apm_command_failed_t *event,
                                 int64_t operation_id,
                                 const mongoc_host_list_t *host,
                                 uint32_t server_id,
+                                const bson_oid_t *service_id,
                                 bool force_redaction,
                                 void *context);
 

src/libmongoc/src/mongoc/mongoc-apm.c

@@ -19,6 +19,8 @@
 #include "mongoc-cmd-private.h"
 #include "mongoc-handshake-private.h"
 
+static bson_oid_t kObjectIdZero = {{0}};
+
 /*
  * An Application Performance Management (APM) implementation, complying with
  * MongoDB's Command Monitoring Spec:
@@ -74,6 +76,7 @@ mongoc_apm_command_started_init (mongoc_apm_command_started_t *event,
                                  int64_t operation_id,
                                  const mongoc_host_list_t *host,
                                  uint32_t server_id,
+                                 const bson_oid_t *service_id,
                                  bool *is_redacted, /* out */
                                  void *context)
 {
@@ -129,6 +132,8 @@ mongoc_apm_command_started_init (mongoc_apm_command_started_t *event,
    event->host = host;
    event->server_id = server_id;
    event->context = context;
+
+   bson_oid_copy_unsafe (service_id, &event->service_id);
 }
 
 
@@ -159,6 +164,7 @@ mongoc_apm_command_started_init_with_cmd (mongoc_apm_command_started_t *event,
                                     cmd->operation_id,
                                     &cmd->server_stream->sd->host,
                                     cmd->server_stream->sd->id,
+                                    &cmd->server_stream->sd->service_id,
                                     is_redacted,
                                     context);
 
@@ -197,6 +203,7 @@ mongoc_apm_command_succeeded_init (mongoc_apm_command_succeeded_t *event,
                                    int64_t operation_id,
                                    const mongoc_host_list_t *host,
                                    uint32_t server_id,
+                                   const bson_oid_t *service_id,
                                    bool force_redaction,
                                    void *context)
 {
@@ -220,6 +227,8 @@ mongoc_apm_command_succeeded_init (mongoc_apm_command_succeeded_t *event,
    event->host = host;
    event->server_id = server_id;
    event->context = context;
+
+   bson_oid_copy_unsafe (service_id, &event->service_id);
 }
 
 
@@ -254,6 +263,7 @@ mongoc_apm_command_failed_init (mongoc_apm_command_failed_t *event,
                                 int64_t operation_id,
                                 const mongoc_host_list_t *host,
                                 uint32_t server_id,
+                                const bson_oid_t *service_id,
                                 bool force_redaction,
                                 void *context)
 {
@@ -278,6 +288,8 @@ mongoc_apm_command_failed_init (mongoc_apm_command_failed_t *event,
    event->host = host;
    event->server_id = server_id;
    event->context = context;
+
+   bson_oid_copy_unsafe (service_id, &event->service_id);
 }
 
 
@@ -351,6 +363,19 @@ mongoc_apm_command_started_get_server_id (
 }
 
 
+const bson_oid_t *
+mongoc_apm_command_started_get_service_id (
+   const mongoc_apm_command_started_t *event)
+{
+   if (0 == bson_oid_compare (&event->service_id, &kObjectIdZero)) {
+      /* serviceId is unset. */
+      return NULL;
+   }
+
+   return &event->service_id;
+}
+
+
 void *
 mongoc_apm_command_started_get_context (
    const mongoc_apm_command_started_t *event)
@@ -417,6 +442,19 @@ mongoc_apm_command_succeeded_get_server_id (
 }
 
 
+const bson_oid_t *
+mongoc_apm_command_succeeded_get_service_id (
+   const mongoc_apm_command_succeeded_t *event)
+{
+   if (0 == bson_oid_compare (&event->service_id, &kObjectIdZero)) {
+      /* serviceId is unset. */
+      return NULL;
+   }
+
+   return &event->service_id;
+}
+
+
 void *
 mongoc_apm_command_succeeded_get_context (
    const mongoc_apm_command_succeeded_t *event)
@@ -487,6 +525,19 @@ mongoc_apm_command_failed_get_server_id (
 }
 
 
+const bson_oid_t *
+mongoc_apm_command_failed_get_service_id (
+   const mongoc_apm_command_failed_t *event)
+{
+   if (0 == bson_oid_compare (&event->service_id, &kObjectIdZero)) {
+      /* serviceId is unset. */
+      return NULL;
+   }
+
+   return &event->service_id;
+}
+
+
 void *
 mongoc_apm_command_failed_get_context (const mongoc_apm_command_failed_t *event)
 {

src/libmongoc/src/mongoc/mongoc-apm.h

@@ -99,6 +99,9 @@ mongoc_apm_command_started_get_host (const mongoc_apm_command_started_t *event);
 MONGOC_EXPORT (uint32_t)
 mongoc_apm_command_started_get_server_id (
    const mongoc_apm_command_started_t *event);
+MONGOC_EXPORT (const bson_oid_t *)
+mongoc_apm_command_started_get_service_id (
+   const mongoc_apm_command_started_t *event);
 MONGOC_EXPORT (void *)
 mongoc_apm_command_started_get_context (
    const mongoc_apm_command_started_t *event);
@@ -126,6 +129,9 @@ mongoc_apm_command_succeeded_get_host (
 MONGOC_EXPORT (uint32_t)
 mongoc_apm_command_succeeded_get_server_id (
    const mongoc_apm_command_succeeded_t *event);
+MONGOC_EXPORT (const bson_oid_t *)
+mongoc_apm_command_succeeded_get_service_id (
+   const mongoc_apm_command_succeeded_t *event);
 MONGOC_EXPORT (void *)
 mongoc_apm_command_succeeded_get_context (
    const mongoc_apm_command_succeeded_t *event);
@@ -155,6 +161,9 @@ mongoc_apm_command_failed_get_host (const mongoc_apm_command_failed_t *event);
 MONGOC_EXPORT (uint32_t)
 mongoc_apm_command_failed_get_server_id (
    const mongoc_apm_command_failed_t *event);
+MONGOC_EXPORT (const bson_oid_t *)
+mongoc_apm_command_failed_get_service_id (
+   const mongoc_apm_command_failed_t *event);
 MONGOC_EXPORT (void *)
 mongoc_apm_command_failed_get_context (
    const mongoc_apm_command_failed_t *event);

src/libmongoc/src/mongoc/mongoc-client.c

@@ -2364,6 +2364,7 @@ _mongoc_client_monitor_op_killcursors (mongoc_cluster_t *cluster,
                                     operation_id,
                                     &server_stream->sd->host,
                                     server_stream->sd->id,
+                                    &server_stream->sd->service_id,
                                     NULL,
                                     client->apm_context);
 
@@ -2411,6 +2412,7 @@ _mongoc_client_monitor_op_killcursors_succeeded (
                                       operation_id,
                                       &server_stream->sd->host,
                                       server_stream->sd->id,
+                                      &server_stream->sd->service_id,
                                       false,
                                       client->apm_context);
 
@@ -2454,6 +2456,7 @@ _mongoc_client_monitor_op_killcursors_failed (
                                    operation_id,
                                    &server_stream->sd->host,
                                    server_stream->sd->id,
+                                   &server_stream->sd->service_id,
                                    false,
                                    client->apm_context);