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

Demo - remove root namespace from system-specific attributes and metrics #1711

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all 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
12 changes: 12 additions & 0 deletions docs/attributes-registry/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,16 @@ 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)
- [CloudEvents](cloudevents.md)
- [CloudFoundry](cloudfoundry.md)
- [Code](code.md)
- [Connect RPC](connect-rpc.md)
- [Container](container.md)
- [Cosmosdb](cosmosdb.md)
- [CPU](cpu.md)
- [Db](db.md)
- [Deployment](deployment.md)
Expand All @@ -52,9 +55,11 @@ 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)
- [Eventhubs](eventhubs.md)
- [Exception](exception.md)
- [Faas](faas.md)
- [Feature Flag](feature-flag.md)
Expand All @@ -64,29 +69,36 @@ Currently, the following namespaces exist:
- [Geo](geo.md)
- [Go](go.md)
- [GraphQL](graphql.md)
- [Grpc](grpc.md)
- [Hardware](hardware.md)
- [Heroku](heroku.md)
- [Host](host.md)
- [HTTP](http.md)
- [iOS](ios.md)
- [Jsonrpc](jsonrpc.md)
- [JVM](jvm.md)
- [K8s](k8s.md)
- [Kafka](kafka.md)
- [Linux](linux.md)
- [Log](log.md)
- [Messaging](messaging.md)
- [Network](network.md)
- [NodeJS](nodejs.md)
- [OCI](oci.md)
- [Openai](openai.md)
- [OpenTracing](opentracing.md)
- [OS](os.md)
- [OTel](otel.md)
- [Peer](peer.md)
- [Process](process.md)
- [Profile](profile.md)
- [RabbitMQ](rabbitmq.md)
- [RocketMQ](rocketmq.md)
- [RPC](rpc.md)
- [Security Rule](security-rule.md)
- [Server](server.md)
- [Service](service.md)
- [Servicebus](servicebus.md)
- [Session](session.md)
- [SignalR](signalr.md)
- [Source](source.md)
Expand Down
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) |
44 changes: 44 additions & 0 deletions docs/attributes-registry/connect-rpc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
<!--- 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 -->

# Connect RPC

## Connect RPC Attributes

This document defines attributes for Connect RPC.

| Attribute | Type | Description | Examples | Stability |
|---|---|---|---|---|
| <a id="connect-rpc-error-code" href="#connect-rpc-error-code">`connect_rpc.error_code`</a> | string | The [error codes](https://connect.build/docs/protocol/#error-codes) of the Connect request. Error codes are always string values. | `cancelled`; `unknown`; `invalid_argument` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| <a id="connect-rpc-request-metadata" href="#connect-rpc-request-metadata">`connect_rpc.request.metadata.<key>`</a> | string[] | Connect request metadata, `<key>` being the normalized Connect Metadata key (lowercase), the value being the metadata values. [1] | `rpc.request.metadata.my-custom-metadata-attribute=["1.2.3.4", "1.2.3.5"]` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| <a id="connect-rpc-response-metadata" href="#connect-rpc-response-metadata">`connect_rpc.response.metadata.<key>`</a> | string[] | Connect response metadata, `<key>` being the normalized Connect Metadata key (lowercase), the value being the metadata values. [2] | `rpc.response.metadata.my-custom-metadata-attribute=["attribute_value"]` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

**[1] `connect_rpc.request.metadata`:** Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured. Including all request metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information.

**[2] `connect_rpc.response.metadata`:** Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured. Including all response metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information.

---

`connect_rpc.error_code` 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 |
|---|---|---|
| `aborted` | aborted | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `already_exists` | already_exists | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `cancelled` | cancelled | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `data_loss` | data_loss | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `deadline_exceeded` | deadline_exceeded | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `failed_precondition` | failed_precondition | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `internal` | internal | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `invalid_argument` | invalid_argument | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `not_found` | not_found | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `out_of_range` | out_of_range | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `permission_denied` | permission_denied | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `resource_exhausted` | resource_exhausted | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `unauthenticated` | unauthenticated | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `unavailable` | unavailable | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `unimplemented` | unimplemented | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `unknown` | unknown | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
44 changes: 44 additions & 0 deletions docs/attributes-registry/cosmosdb.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
<!--- 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 -->

# Cosmosdb

## Azure Cosmos DB Attributes

This group defines attributes for Azure Cosmos DB.

| Attribute | Type | Description | Examples | Stability |
|---|---|---|---|---|
| <a id="cosmosdb-client-id" href="#cosmosdb-client-id">`cosmosdb.client_id`</a> | string | Unique Cosmos client instance id. | `3ba4827d-4422-483f-b59f-85b74211c11d` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| <a id="cosmosdb-connection-mode" href="#cosmosdb-connection-mode">`cosmosdb.connection_mode`</a> | string | Cosmos client connection mode. | `gateway`; `direct` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| <a id="cosmosdb-consistency-level" href="#cosmosdb-consistency-level">`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="cosmosdb-regions-contacted" href="#cosmosdb-regions-contacted">`cosmosdb.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="cosmosdb-request-charge" href="#cosmosdb-request-charge">`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="cosmosdb-request-content-length" href="#cosmosdb-request-content-length">`cosmosdb.request_content_length`</a> | int | Request payload size in bytes. | | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| <a id="cosmosdb-sub-status-code" href="#cosmosdb-sub-status-code">`cosmosdb.sub_status_code`</a> | int | Cosmos DB sub status code. | `1000`; `1002` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

**[1] `cosmosdb.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)

---

`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) |

---

`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) |
Loading
Loading