Merge DB connection-level and call-level attributes (#780)

Co-authored-by: Joao Grassi <[email protected]>
open-telemetry · Mar 1, 2024 · 58c2705 · 58c2705
1 parent 9e90894
commit 58c2705
Show file tree

Hide file tree

Showing 16 changed files with 106 additions and 134 deletions.
diff --git a/.chloggen/780.yaml b/.chloggen/780.yaml
@@ -0,0 +1,4 @@
+change_type: enhancement
+component: db
+note: Merge DB connection-level and call-level attributes tables
+issues: [780]
diff --git a/docs/database/cassandra.md b/docs/database/cassandra.md
@@ -12,9 +12,9 @@ described on this page.
 
 `db.system` MUST be set to `"cassandra"`.
 
-## Call-level attributes
+## Attributes
 
-<!-- semconv db.cassandra(full,tag=call-level-tech-specific-cassandra) -->
+<!-- semconv db.cassandra(full,tag=tech-specific) -->
 | Attribute  | Type | Description  | Examples  | Requirement Level |
 |---|---|---|---|---|
 | [`db.cassandra.consistency_level`](../attributes-registry/db.md) | 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` | Recommended |

diff --git a/docs/database/cosmosdb.md b/docs/database/cosmosdb.md
@@ -11,13 +11,13 @@ extend and override the [Database Semantic Conventions](database-spans.md)
 that describe common database operations attributes in addition to the Semantic Conventions
 described on this page.
 
-## Call-level attributes
+## Attributes
 
 `db.system` MUST be set to `"cosmosdb"`.
 
 Cosmos DB instrumentation includes call-level (public API) surface spans and network spans. Depending on the connection mode (Gateway or Direct), network-level spans may also be created.
 
-<!-- semconv db.cosmosdb(full,tag=call-level-tech-specific) -->
+<!-- semconv db.cosmosdb(full,tag=tech-specific) -->
 | Attribute  | Type | Description  | Examples  | Requirement Level |
 |---|---|---|---|---|
 | [`db.cosmosdb.client_id`](../attributes-registry/db.md) | string | Unique Cosmos client instance id. | `3ba4827d-4422-483f-b59f-85b74211c11d` | Recommended |

diff --git a/docs/database/couchdb.md b/docs/database/couchdb.md
@@ -12,9 +12,9 @@ described on this page.
 
 `db.system` MUST be set to `"couchdb"`.
 
-## Call-level attributes
+## Attributes
 
-<!-- semconv db.couchdb(full,tag=call-level-tech-specific) -->
+<!-- semconv db.couchdb(full,tag=tech-specific) -->
 | Attribute  | Type | Description  | Examples  | Requirement Level |
 |---|---|---|---|---|
 | [`db.operation`](../attributes-registry/db.md) | string | The HTTP method + the target REST route. [1] | `GET /{db}/{docid}` | Conditionally Required: If `db.statement` is not applicable. |

diff --git a/docs/database/database-metrics.md b/docs/database/database-metrics.md
@@ -52,7 +52,7 @@ This metric is [required][MetricRequired].
 <!-- semconv metric.db.client.connections.usage(full) -->
 | Attribute  | Type | Description  | Examples  | Requirement Level |
 |---|---|---|---|---|
-| `pool.name` | string | The name of the connection pool; unique within the instrumented application. In case the connection pool implementation doesn't provide a name, then the [db.connection_string](/docs/database/database-spans.md#connection-level-attributes) should be used | `myDataSource` | Required |
+| `pool.name` | string | The name of the connection pool; unique within the instrumented application. In case the connection pool implementation doesn't provide a name, then the [db.connection_string](/docs/database/database-spans.md#common-attributes) should be used | `myDataSource` | Required |
 | `state` | string | The state of a connection in the pool | `idle` | Required |
 
 `state` MUST be one of the following:
@@ -75,7 +75,7 @@ This metric is [recommended][MetricRecommended].
 <!-- semconv metric.db.client.connections.idle.max(full) -->
 | Attribute  | Type | Description  | Examples  | Requirement Level |
 |---|---|---|---|---|
-| `pool.name` | string | The name of the connection pool; unique within the instrumented application. In case the connection pool implementation doesn't provide a name, then the [db.connection_string](/docs/database/database-spans.md#connection-level-attributes) should be used | `myDataSource` | Required |
+| `pool.name` | string | The name of the connection pool; unique within the instrumented application. In case the connection pool implementation doesn't provide a name, then the [db.connection_string](/docs/database/database-spans.md#common-attributes) should be used | `myDataSource` | Required |
 <!-- endsemconv -->
 
 ### Metric: `db.client.connections.idle.min`
@@ -91,7 +91,7 @@ This metric is [recommended][MetricRecommended].
 <!-- semconv metric.db.client.connections.idle.min(full) -->
 | Attribute  | Type | Description  | Examples  | Requirement Level |
 |---|---|---|---|---|
-| `pool.name` | string | The name of the connection pool; unique within the instrumented application. In case the connection pool implementation doesn't provide a name, then the [db.connection_string](/docs/database/database-spans.md#connection-level-attributes) should be used | `myDataSource` | Required |
+| `pool.name` | string | The name of the connection pool; unique within the instrumented application. In case the connection pool implementation doesn't provide a name, then the [db.connection_string](/docs/database/database-spans.md#common-attributes) should be used | `myDataSource` | Required |
 <!-- endsemconv -->
 
 ### Metric: `db.client.connections.max`
@@ -107,7 +107,7 @@ This metric is [recommended][MetricRecommended].
 <!-- semconv metric.db.client.connections.max(full) -->
 | Attribute  | Type | Description  | Examples  | Requirement Level |
 |---|---|---|---|---|
-| `pool.name` | string | The name of the connection pool; unique within the instrumented application. In case the connection pool implementation doesn't provide a name, then the [db.connection_string](/docs/database/database-spans.md#connection-level-attributes) should be used | `myDataSource` | Required |
+| `pool.name` | string | The name of the connection pool; unique within the instrumented application. In case the connection pool implementation doesn't provide a name, then the [db.connection_string](/docs/database/database-spans.md#common-attributes) should be used | `myDataSource` | Required |
 <!-- endsemconv -->
 
 ### Metric: `db.client.connections.pending_requests`
@@ -123,7 +123,7 @@ This metric is [recommended][MetricRecommended].
 <!-- semconv metric.db.client.connections.pending_requests(full) -->
 | Attribute  | Type | Description  | Examples  | Requirement Level |
 |---|---|---|---|---|
-| `pool.name` | string | The name of the connection pool; unique within the instrumented application. In case the connection pool implementation doesn't provide a name, then the [db.connection_string](/docs/database/database-spans.md#connection-level-attributes) should be used | `myDataSource` | Required |
+| `pool.name` | string | The name of the connection pool; unique within the instrumented application. In case the connection pool implementation doesn't provide a name, then the [db.connection_string](/docs/database/database-spans.md#common-attributes) should be used | `myDataSource` | Required |
 <!-- endsemconv -->
 
 ### Metric: `db.client.connections.timeouts`
@@ -139,7 +139,7 @@ This metric is [recommended][MetricRecommended].
 <!-- semconv metric.db.client.connections.timeouts(full) -->
 | Attribute  | Type | Description  | Examples  | Requirement Level |
 |---|---|---|---|---|
-| `pool.name` | string | The name of the connection pool; unique within the instrumented application. In case the connection pool implementation doesn't provide a name, then the [db.connection_string](/docs/database/database-spans.md#connection-level-attributes) should be used | `myDataSource` | Required |
+| `pool.name` | string | The name of the connection pool; unique within the instrumented application. In case the connection pool implementation doesn't provide a name, then the [db.connection_string](/docs/database/database-spans.md#common-attributes) should be used | `myDataSource` | Required |
 <!-- endsemconv -->
 
 ### Metric: `db.client.connections.create_time`
@@ -155,7 +155,7 @@ This metric is [recommended][MetricRecommended].
 <!-- semconv metric.db.client.connections.create_time(full) -->
 | Attribute  | Type | Description  | Examples  | Requirement Level |
 |---|---|---|---|---|
-| `pool.name` | string | The name of the connection pool; unique within the instrumented application. In case the connection pool implementation doesn't provide a name, then the [db.connection_string](/docs/database/database-spans.md#connection-level-attributes) should be used | `myDataSource` | Required |
+| `pool.name` | string | The name of the connection pool; unique within the instrumented application. In case the connection pool implementation doesn't provide a name, then the [db.connection_string](/docs/database/database-spans.md#common-attributes) should be used | `myDataSource` | Required |
 <!-- endsemconv -->
 
 ### Metric: `db.client.connections.wait_time`
@@ -171,7 +171,7 @@ This metric is [recommended][MetricRecommended].
 <!-- semconv metric.db.client.connections.wait_time(full) -->
 | Attribute  | Type | Description  | Examples  | Requirement Level |
 |---|---|---|---|---|
-| `pool.name` | string | The name of the connection pool; unique within the instrumented application. In case the connection pool implementation doesn't provide a name, then the [db.connection_string](/docs/database/database-spans.md#connection-level-attributes) should be used | `myDataSource` | Required |
+| `pool.name` | string | The name of the connection pool; unique within the instrumented application. In case the connection pool implementation doesn't provide a name, then the [db.connection_string](/docs/database/database-spans.md#common-attributes) should be used | `myDataSource` | Required |
 <!-- endsemconv -->
 
 ### Metric: `db.client.connections.use_time`
@@ -187,7 +187,7 @@ This metric is [recommended][MetricRecommended].
 <!-- semconv metric.db.client.connections.use_time(full) -->
 | Attribute  | Type | Description  | Examples  | Requirement Level |
 |---|---|---|---|---|
-| `pool.name` | string | The name of the connection pool; unique within the instrumented application. In case the connection pool implementation doesn't provide a name, then the [db.connection_string](/docs/database/database-spans.md#connection-level-attributes) should be used | `myDataSource` | Required |
+| `pool.name` | string | The name of the connection pool; unique within the instrumented application. In case the connection pool implementation doesn't provide a name, then the [db.connection_string](/docs/database/database-spans.md#common-attributes) should be used | `myDataSource` | Required |
 <!-- endsemconv -->
 
 [DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/tree/v1.26.0/specification/document-status.md