DRIVERS-719 OpenTelementry specification

source/index.md

@@ -36,6 +36,7 @@
 - [MongoDB Handshake](mongodb-handshake/handshake.md)
 - [OCSP Support](ocsp-support/ocsp-support.md)
 - [OP_MSG](message/OP_MSG.md)
+- [OpenTelemetry](open-telemetry/open-telemetry.md)
 - [Performance Benchmarking](benchmarking/benchmarking.md)
 - [Polling SRV Records for mongos Discovery](polling-srv-records-for-mongos-discovery/polling-srv-records-for-mongos-discovery.md)
 - [Read and Write Concern](read-write-concern/read-write-concern.md)

source/open-telemetry/tests/README.md

@@ -0,0 +1,34 @@
+# OpenTelemetry Tests
+
+______________________________________________________________________
+
+## Testing
+
+### Automated Tests
+
+The YAML and JSON files in this directory are platform-independent tests meant to exercise a driver's implementation of
+the OpenTelemetry specification. These tests utilize the
+[Unified Test Format](../../unified-test-format/unified-test-format.md).
+
+For each test, create a MongoClient, configure it to enable tracing.
+
+```yaml
+createEntities:
+  - client:
+      id: client0
+      observeTracingMessages:
+        enableCommandPayload: true
+```
+
+These tests require the ability to collect tracing [spans](../open-telemetry.md#span) data in a structured form as
+described in the
+[Unified Test Format specification.expectTracingMessages](../../unified-test-format/unified-test-format.md#expectTracingMessages).
+For example the Java driver uses [Micrometer](https://jira.mongodb.org/browse/JAVA-5732) to collect tracing spans.
+
+```yaml
+expectTracingMessages:
+  client: client0
+  ignoreExtraSpans: false
+  spans:
+   ...
+```

source/open-telemetry/tests/cursor/cursor.json

@@ -0,0 +1,300 @@
+{
+  "description": "cursor retrieval",
+  "schemaVersion": "1.26",
+  "createEntities": [
+    {
+      "client": {
+        "id": "client0",
+        "useMultipleMongoses": false,
+        "observeTracingMessages": {
+          "enableCommandPayload": true
+        }
+      }
+    },
+    {
+      "database": {
+        "id": "database0",
+        "client": "client0",
+        "databaseName": "cursor"
+      }
+    },
+    {
+      "collection": {
+        "id": "collection0",
+        "database": "database0",
+        "collectionName": "test"
+      }
+    }
+  ],
+  "initialData": [
+    {
+      "collectionName": "test",
+      "databaseName": "cursor",
+      "documents": [
+        {
+          "_id": 1
+        },
+        {
+          "_id": 2
+        },
+        {
+          "_id": 3
+        },
+        {
+          "_id": 4
+        },
+        {
+          "_id": 5
+        },
+        {
+          "_id": 6
+        }
+      ]
+    }
+  ],
+  "tests": [
+    {
+      "description": "find with a cursor",
+      "operations": [
+        {
+          "name": "find",
+          "object": "collection0",
+          "arguments": {
+            "filter": {
+              "_id": {
+                "$gt": 1
+              }
+            },
+            "batchSize": 2
+          },
+          "expectResult": [
+            {
+              "_id": 2
+            },
+            {
+              "_id": 3
+            },
+            {
+              "_id": 4
+            },
+            {
+              "_id": 5
+            },
+            {
+              "_id": 6
+            }
+          ]
+        }
+      ],
+      "expectTracingMessages": {
+        "client": "client0",
+        "ignoreExtraSpans": false,
+        "spans": [
+          {
+            "name": "find cursor.test",
+            "tags": {
+              "db.system": "mongodb",
+              "db.namespace": "cursor",
+              "db.collection.name": "test",
+              "db.operation.name": "find",
+              "db.operation.summary": "find cursor.test"
+            },
+            "nested": [
+              {
+                "name": "command find",
+                "tags": {
+                  "db.system": "mongodb",
+                  "db.namespace": "cursor",
+                  "db.collection.name": "cursor.$cmd",
+                  "db.command.name": "find",
+                  "network.transport": "tcp",
+                  "db.mongodb.cursor_id": {
+                    "$$exists": false
+                  },
+                  "db.response.status_code": {
+                    "$$exists": false
+                  },
+                  "exception.message": {
+                    "$$exists": false
+                  },
+                  "exception.type": {
+                    "$$exists": false
+                  },
+                  "exception.stacktrace": {
+                    "$$exists": false
+                  },
+                  "server.address": {
+                    "$$type": "string"
+                  },
+                  "server.port": {
+                    "$$type": [
+                      "int",
+                      "long"
+                    ]
+                  },
+                  "server.type": {
+                    "$$type": "string"
+                  },
+                  "db.query.summary": "find",
+                  "db.query.text": {
+                    "$$matchAsDocument": {
+                      "$$matchAsRoot": {
+                        "find": "test",
+                        "filter": {
+                          "_id": {
+                            "$gt": 1
+                          }
+                        },
+                        "batchSize": 2
+                      }
+                    }
+                  },
+                  "db.mongodb.server_connection_id": {
+                    "$$type": [
+                      "int",
+                      "long"
+                    ]
+                  },
+                  "db.mongodb.driver_connection_id": {
+                    "$$type": [
+                      "int",
+                      "long"
+                    ]
+                  }
+                }
+              },
+              {
+                "name": "command getMore",
+                "tags": {
+                  "db.system": "mongodb",
+                  "db.namespace": "cursor",
+                  "db.collection.name": "cursor.$cmd",
+                  "db.command.name": "getMore",
+                  "network.transport": "tcp",
+                  "db.mongodb.cursor_id": {
+                    "$$type": [
+                      "int",
+                      "long"
+                    ]
+                  },
+                  "db.response.status_code": {
+                    "$$exists": false
+                  },
+                  "exception.message": {
+                    "$$exists": false
+                  },
+                  "exception.type": {
+                    "$$exists": false
+                  },
+                  "exception.stacktrace": {
+                    "$$exists": false
+                  },
+                  "server.address": {
+                    "$$type": "string"
+                  },
+                  "server.port": {
+                    "$$type": [
+                      "int",
+                      "long"
+                    ]
+                  },
+                  "server.type": {
+                    "$$type": "string"
+                  },
+                  "db.query.summary": "getMore",
+                  "db.query.text": {
+                    "$$matchAsDocument": {
+                      "$$matchAsRoot": {
+                        "getMore": {
+                          "$$type": "long"
+                        },
+                        "collection": "test",
+                        "batchSize": 2
+                      }
+                    }
+                  },
+                  "db.mongodb.server_connection_id": {
+                    "$$type": [
+                      "int",
+                      "long"
+                    ]
+                  },
+                  "db.mongodb.driver_connection_id": {
+                    "$$type": [
+                      "int",
+                      "long"
+                    ]
+                  }
+                }
+              },
+              {
+                "name": "command getMore",
+                "tags": {
+                  "db.system": "mongodb",
+                  "db.namespace": "cursor",
+                  "db.collection.name": "cursor.$cmd",
+                  "db.command.name": "getMore",
+                  "network.transport": "tcp",
+                  "db.mongodb.cursor_id": {
+                    "$$type": [
+                      "int",
+                      "long"
+                    ]
+                  },
+                  "db.response.status_code": {
+                    "$$exists": false
+                  },
+                  "exception.message": {
+                    "$$exists": false
+                  },
+                  "exception.type": {
+                    "$$exists": false
+                  },
+                  "exception.stacktrace": {
+                    "$$exists": false
+                  },
+                  "server.address": {
+                    "$$type": "string"
+                  },
+                  "server.port": {
+                    "$$type": [
+                      "int",
+                      "long"
+                    ]
+                  },
+                  "server.type": {
+                    "$$type": "string"
+                  },
+                  "db.query.summary": "getMore",
+                  "db.query.text": {
+                    "$$matchAsDocument": {
+                      "$$matchAsRoot": {
+                        "getMore": {
+                          "$$type": "long"
+                        },
+                        "collection": "test",
+                        "batchSize": 2
+                      }
+                    }
+                  },
+                  "db.mongodb.server_connection_id": {
+                    "$$type": [
+                      "int",
+                      "long"
+                    ]
+                  },
+                  "db.mongodb.driver_connection_id": {
+                    "$$type": [
+                      "int",
+                      "long"
+                    ]
+                  }
+                }
+              }
+            ]
+          }
+        ]
+      }
+    }
+  ]
+}