Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CosmosDB: define applicable values for db.operation.name and add proper reference to az.namespace #1330

Merged
merged 12 commits into from
Aug 23, 2024
4 changes: 4 additions & 0 deletions .chloggen/1330.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
change_type: enhancement
component: az, db
note: Define `db.operation.name` values for Cosmos DB, declare `az.namespace` attribute and add proper reference to it.
issues: [1330]
7 changes: 4 additions & 3 deletions docs/attributes-registry/azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@

This document defines generic attributes for Azure SDK.

| Attribute | Type | Description | Examples | Stability |
| ----------------------- | ------ | ----------------------------------------------------------------------------------------------------------------- | -------------------------------------- | ---------------------------------------------------------------- |
| `az.service_request_id` | string | The unique identifier of the service request. It's generated by the Azure service and returned with the response. | `00000000-0000-0000-0000-000000000000` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| Attribute | Type | Description | Examples | Stability |
| ----------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | ---------------------------------------------------------------- |
| `az.namespace` | string | [Azure Resource Provider Namespace](https://learn.microsoft.com/azure/azure-resource-manager/management/azure-services-resource-providers) as recognized by the client. | `Microsoft.Storage`; `Microsoft.KeyVault`; `Microsoft.ServiceBus` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `az.service_request_id` | string | The unique identifier of the service request. It's generated by the Azure service and returned with the response. | `00000000-0000-0000-0000-000000000000` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
36 changes: 18 additions & 18 deletions docs/attributes-registry/db.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ This group defines attributes for Azure Cosmos DB.
| ------------------------------------ | ------ | --------------------------------- | -------------------------------------- | ---------------------------------------------------------------- |
| `db.cosmosdb.client_id` | string | Unique Cosmos client instance id. | `3ba4827d-4422-483f-b59f-85b74211c11d` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `db.cosmosdb.connection_mode` | string | Cosmos client connection mode. | `gateway`; `direct` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `db.cosmosdb.operation_type` | string | CosmosDB Operation Type. | `Invalid`; `Create`; `Patch` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `db.cosmosdb.operation_type` | string | Cosmos DB Operation Type. | `batch`; `create`; `delete` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `db.cosmosdb.request_charge` | double | RU consumed for that operation | `46.18`; `1.0` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `db.cosmosdb.request_content_length` | int | Request payload size in bytes | | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `db.cosmosdb.status_code` | int | Cosmos DB status code. | `200`; `201` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
Expand All @@ -170,23 +170,23 @@ This group defines attributes for Azure Cosmos DB.

`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 | Stability |
| ------------------- | ------------------ | ---------------------------------------------------------------- |
| `Batch` | batch | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `Create` | create | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `Delete` | delete | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `Execute` | execute | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `ExecuteJavaScript` | execute_javascript | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `Head` | head | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `HeadFeed` | head_feed | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `Invalid` | invalid | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `Patch` | patch | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `Query` | query | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `QueryPlan` | query_plan | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `Read` | read | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `ReadFeed` | read_feed | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `Replace` | replace | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `Upsert` | upsert | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| Value | Description | Stability |
| -------------------- | ------------------ | ---------------------------------------------------------------- |
| `batch` | batch | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `create` | create | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `delete` | delete | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `execute` | execute | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `execute_javascript` | execute_javascript | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `head` | head | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `head_feed` | head_feed | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `invalid` | invalid | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `patch` | patch | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `query` | query | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `query_plan` | query_plan | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `read` | read | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `read_feed` | read_feed | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `replace` | replace | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `upsert` | upsert | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

## Elasticsearch Attributes

Expand Down
Loading
Loading