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

Consistent naming: db.system to db.system.name, namespace constants, remove db from system-specific names #1734

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ body:
- area:aws
- area:azure
- area:browser
- area:cassandra
- area:cicd
- area:client
- area:cloud
Expand All @@ -41,6 +42,7 @@ body:
- area:disk
- area:dns
- area:dotnet
- area:elasticsearch
- area:error
- area:exception
- area:faas
Expand Down
2 changes: 2 additions & 0 deletions .github/ISSUE_TEMPLATE/change_proposal.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ body:
- area:aws
- area:azure
- area:browser
- area:cassandra
- area:cicd
- area:client
- area:cloud
Expand All @@ -33,6 +34,7 @@ body:
- area:disk
- area:dns
- area:dotnet
- area:elasticsearch
- area:error
- area:exception
- area:faas
Expand Down
2 changes: 2 additions & 0 deletions .github/ISSUE_TEMPLATE/new-conventions.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ body:
- area:aws
- area:azure
- area:browser
- area:cassandra
- area:cicd
- area:client
- area:cloud
Expand All @@ -42,6 +43,7 @@ body:
- area:disk
- area:dns
- area:dotnet
- area:elasticsearch
- area:error
- area:exception
- area:faas
Expand Down
2 changes: 2 additions & 0 deletions docs/attributes-registry/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ Currently, the following namespaces exist:
- [AWS](aws.md)
- [Azure](azure.md)
- [Browser](browser.md)
- [Cassandra](cassandra.md)
- [CICD](cicd.md)
- [Client](client.md)
- [Cloud](cloud.md)
Expand All @@ -53,6 +54,7 @@ Currently, the following namespaces exist:
- [Disk](disk.md)
- [DNS](dns.md)
- [Dotnet](dotnet.md)
- [Elasticsearch](elasticsearch.md)
- [Enduser](enduser.md)
- [Error](error.md)
- [Event](event.md)
Expand Down
44 changes: 42 additions & 2 deletions docs/attributes-registry/azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,51 @@

# Azure

## Azure SDK Attributes
- [Azure Client Library Attributes](#azure-client-library-attributes)
- [Azure Cosmos DB Attributes](#azure-cosmos-db-attributes)

This document defines generic attributes for Azure SDK.
## Azure Client Library Attributes

This document defines generic attributes used by Azure Client Libraries.

| Attribute | Type | Description | Examples | Stability |
|---|---|---|---|---|
| <a id="az-client-id" href="#az-client-id">`az.client.id`</a> | string | The unique identifier of the client instance. | `3ba4827d-4422-483f-b59f-85b74211c11d`; `storage-client-1` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| <a id="az-namespace" href="#az-namespace">`az.namespace`</a> | 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) |
| <a id="az-service-request-id" href="#az-service-request-id">`az.service_request_id`</a> | 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) |

## Azure Cosmos DB Attributes

This group defines attributes for Azure Cosmos DB.

| Attribute | Type | Description | Examples | Stability |
|---|---|---|---|---|
| <a id="az-cosmosdb-connection-mode" href="#az-cosmosdb-connection-mode">`az.cosmosdb.connection.mode`</a> | string | Cosmos client connection mode. | `gateway`; `direct` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| <a id="az-cosmosdb-consistency-level" href="#az-cosmosdb-consistency-level">`az.cosmosdb.consistency.level`</a> | string | Account or request [consistency level](https://learn.microsoft.com/azure/cosmos-db/consistency-levels). | `Eventual`; `ConsistentPrefix`; `BoundedStaleness`; `Strong`; `Session` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| <a id="az-cosmosdb-request-charge" href="#az-cosmosdb-request-charge">`az.cosmosdb.request.charge`</a> | double | Request units consumed for the operation. | `46.18`; `1.0` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| <a id="az-cosmosdb-request-content-length" href="#az-cosmosdb-request-content-length">`az.cosmosdb.request.content_length`</a> | int | Request payload size in bytes. | | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| <a id="az-cosmosdb-request-regions-contacted" href="#az-cosmosdb-request-regions-contacted">`az.cosmosdb.request.regions_contacted`</a> | string[] | List of regions contacted during operation in the order that they were contacted. If there is more than one region listed, it indicates that the operation was performed on multiple regions i.e. cross-regional call. [1] | `["North Central US", "Australia East", "Australia Southeast"]` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| <a id="az-cosmosdb-response-sub-status-code" href="#az-cosmosdb-response-sub-status-code">`az.cosmosdb.response.sub_status_code`</a> | int | Cosmos DB sub status code. | `1000`; `1002` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

**[1] `az.cosmosdb.request.regions_contacted`:** Region name matches the format of `displayName` in [Azure Location API](https://learn.microsoft.com/rest/api/subscription/subscriptions/list-locations?view=rest-subscription-2021-10-01&tabs=HTTP#location)

---

`az.cosmosdb.connection.mode` 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 |
|---|---|---|
| `direct` | Direct connection. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `gateway` | Gateway (HTTP) connection. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

---

`az.cosmosdb.consistency.level` 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 |
|---|---|---|
| `BoundedStaleness` | bounded_staleness | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `ConsistentPrefix` | consistent_prefix | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `Eventual` | eventual | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `Session` | session | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `Strong` | strong | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
38 changes: 38 additions & 0 deletions docs/attributes-registry/cassandra.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<!--- Hugo front matter used to generate the website version of this page:
--->

<!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/attribute_namespace.md.j2 -->

# Cassandra

## Cassandra Attributes

This group defines attributes for Cassandra.

| Attribute | Type | Description | Examples | Stability |
|---|---|---|---|---|
| <a id="cassandra-consistency-level" href="#cassandra-consistency-level">`cassandra.consistency.level`</a> | string | The consistency level of the query. Based on consistency values from [CQL](https://docs.datastax.com/en/cassandra-oss/3.0/cassandra/dml/dmlConfigConsistency.html). | `all`; `each_quorum`; `quorum` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| <a id="cassandra-coordinator-dc" href="#cassandra-coordinator-dc">`cassandra.coordinator.dc`</a> | string | The data center of the coordinating node for a query. | `us-west-2` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| <a id="cassandra-coordinator-id" href="#cassandra-coordinator-id">`cassandra.coordinator.id`</a> | string | The ID of the coordinating node for a query. | `be13faa2-8574-4d71-926d-27f16cf8a7af` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| <a id="cassandra-idempotence" href="#cassandra-idempotence">`cassandra.idempotence`</a> | boolean | Whether or not the query is idempotent. | | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| <a id="cassandra-page-size" href="#cassandra-page-size">`cassandra.page_size`</a> | int | The fetch size used for paging, i.e. how many rows will be returned at once. | `5000` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| <a id="cassandra-speculative-execution-count" href="#cassandra-speculative-execution-count">`cassandra.speculative_execution_count`</a> | int | The number of times a query was speculatively executed. Not set or `0` if the query was not executed speculatively. | `0`; `2` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

---

`cassandra.consistency.level` 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 |
|---|---|---|
| `all` | all | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `any` | any | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `each_quorum` | each_quorum | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `local_one` | local_one | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `local_quorum` | local_quorum | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `local_serial` | local_serial | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `one` | one | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `quorum` | quorum | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `serial` | serial | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `three` | three | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `two` | two | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
Loading
Loading