Cosmos DB attributes: fixes UserAgent description (#3338)

semantic_conventions/trace/database.yaml

@@ -451,6 +451,19 @@ groups:
         requirement_level:
           conditionally_required: when performing one of the operations in this list
       - ref: user_agent.original
+        brief: 'Full user-agent string is generated by Cosmos DB SDK'
+        note: >
+          The user-agent value is generated by SDK which is a combination of<br>
+          `sdk_version` : Current version of SDK. e.g. 'cosmos-netstandard-sdk/3.23.0'<br>
+          `direct_pkg_version` : Direct package version used by Cosmos DB SDK. e.g. '3.23.1'<br>
+          `number_of_client_instances` : Number of cosmos client instances created by the application. e.g. '1'<br>
+          `type_of_machine_architecture` : Machine architecture. e.g. 'X64'<br>
+          `operating_system` : Operating System. e.g. 'Linux 5.4.0-1098-azure 104 18'<br>
+          `runtime_framework` : Runtime Framework. e.g. '.NET Core 3.1.32'<br>
+          `failover_information` : Generated key to determine if region failover enabled.
+             Format Reg-{D (Disabled discovery)}-S(application region)|L(List of preferred regions)|N(None, user did not configure it).
+             Default value is "NS".
+        examples: ['cosmos-netstandard-sdk/3.23.0\|3.23.1\|1\|X64\|Linux 5.4.0-1098-azure 104 18\|.NET Core 3.1.32\|S\|']
       - id: connection_mode
         type:
           allow_custom_values: false

specification/trace/semantic_conventions/database.md

@@ -232,12 +232,16 @@ Cosmos DB instrumentation includes call-level (public API) surface spans and net
 | `db.cosmosdb.status_code` | int | Cosmos DB status code. | `200`; `201` | Conditionally Required: if response was received |
 | `db.cosmosdb.sub_status_code` | int | Cosmos DB sub status code. | `1000`; `1002` | Conditionally Required: [2] |
 | `db.cosmosdb.request_charge` | double | RU consumed for that operation | `46.18`; `1.0` | Conditionally Required: when available |
-| `user_agent.original` | string | Value of the [HTTP User-Agent](https://www.rfc-editor.org/rfc/rfc9110.html#field.user-agent) header sent by the client. | `CERN-LineMode/2.15 libwww/2.17b3` | Recommended |
+| `user_agent.original` | string | Full user-agent string is generated by Cosmos DB SDK [3] | `cosmos-netstandard-sdk/3.23.0\|3.23.1\|1\|X64\|Linux 5.4.0-1098-azure 104 18\|.NET Core 3.1.32\|S\|` | Recommended |
 
 **[1]:** when performing one of the operations in this list
 
 **[2]:** when response was received and contained sub-code.
 
+**[3]:** The user-agent value is generated by SDK which is a combination of<br> `sdk_version` : Current version of SDK. e.g. 'cosmos-netstandard-sdk/3.23.0'<br> `direct_pkg_version` : Direct package version used by Cosmos DB SDK. e.g. '3.23.1'<br> `number_of_client_instances` : Number of cosmos client instances created by the application. e.g. '1'<br> `type_of_machine_architecture` : Machine architecture. e.g. 'X64'<br> `operating_system` : Operating System. e.g. 'Linux 5.4.0-1098-azure 104 18'<br> `runtime_framework` : Runtime Framework. e.g. '.NET Core 3.1.32'<br> `failover_information` : Generated key to determine if region failover enabled.
+   Format Reg-{D (Disabled discovery)}-S(application region)|L(List of preferred regions)|N(None, user did not configure it).
+   Default value is "NS".
+
 `db.cosmosdb.operation_type` has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
 
 | Value  | Description |
@@ -336,7 +340,7 @@ Furthermore, `db.name` is not specified as there is no database name in Redis an
 | `net.peer.name`                      |  `"account.documents.azure.com"`  |
 | `db.cosmosdb.client_id`              | `3ba4827d-4422-483f-b59f-85b74211c11d` |
 | `db.cosmosdb.operation_type`         | `Read` |
-| `user_agent.original`                | `cosmos-netstandard-sdk/3.31.2|1|X64|Linux 5.4.0-1095-azure 101 18|.NET 6.0.2|N|appname` |
+| `user_agent.original`                | `cosmos-netstandard-sdk/3.23.0\|3.23.1\|1\|X64\|Linux 5.4.0-1098-azure 104 18\|.NET Core 3.1.32\|S\|` |
 | `db.cosmosdb.connection_mode`        | `"Direct"` |
 | `db.cosmosdb.container`              | `"container name"` |
 | `db.cosmosdb.request_content_length` | `20` |