diff --git a/.chloggen/rename-db-metric-name.yaml b/.chloggen/rename-db-metric-name.yaml new file mode 100644 index 0000000000..9804e4d2a5 --- /dev/null +++ b/.chloggen/rename-db-metric-name.yaml @@ -0,0 +1,22 @@ +# Use this changelog template to create an entry for release notes. +# +# If your change doesn't affect end users you should instead start +# your pull request title with [chore] or use the "Skip Changelog" label. + +# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' +change_type: breaking + +# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db) +component: db + +# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). +note: Rename `db.system` to `db.system.name` in database metrics, and update the values to be consistent with database spans. + +# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. +# The values here must be integers. +issues: [1581] + +# (Optional) One or more lines of additional information to render under the primary note. +# These lines will be padded with 2 spaces and then inserted directly into the document. +# Use pipe (|) for multiline entries. +subtext: diff --git a/docs/database/cassandra.md b/docs/database/cassandra.md index efdd7b5d99..e6b6dab7d2 100644 --- a/docs/database/cassandra.md +++ b/docs/database/cassandra.md @@ -160,6 +160,6 @@ and SHOULD be provided **at span creation time** (if provided at all): Cassandra client instrumentations SHOULD collect metrics according to the general [Semantic Conventions for Database Client Metrics](database-metrics.md). -`db.system` MUST be set to `"cassandra"`. +`db.system.name` MUST be set to `"cassandra"`. [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status diff --git a/docs/database/couchdb.md b/docs/database/couchdb.md index a78711fdd2..6fd4a11171 100644 --- a/docs/database/couchdb.md +++ b/docs/database/couchdb.md @@ -84,6 +84,6 @@ and SHOULD be provided **at span creation time** (if provided at all): CouchDB client instrumentations SHOULD collect metrics according to the general [Semantic Conventions for Database Client Metrics](database-metrics.md). -`db.system` MUST be set to `"couchdb"`. +`db.system.name` MUST be set to `"couchdb"`. [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status diff --git a/docs/database/dynamodb.md b/docs/database/dynamodb.md index 78fa4e2003..58de4fa9b2 100644 --- a/docs/database/dynamodb.md +++ b/docs/database/dynamodb.md @@ -593,6 +593,6 @@ The following table outlines the span attributes applicable to DynamoDB. AWS DynamoDB client instrumentations SHOULD collect metrics according to the general [Semantic Conventions for Database Client Metrics](database-metrics.md). -`db.system` MUST be set to `"dynamodb"`. +`db.system.name` MUST be set to `"aws.dynamodb"`. [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status diff --git a/docs/database/elasticsearch.md b/docs/database/elasticsearch.md index ee4ef1624c..c4d1a899c9 100644 --- a/docs/database/elasticsearch.md +++ b/docs/database/elasticsearch.md @@ -182,6 +182,6 @@ and SHOULD be provided **at span creation time** (if provided at all): Elasticsearch client instrumentations SHOULD collect metrics according to the general [Semantic Conventions for Database Client Metrics](database-metrics.md). -`db.system` MUST be set to `"elasticsearch"`. +`db.system.name` MUST be set to `"elasticsearch"`. [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status diff --git a/docs/database/hbase.md b/docs/database/hbase.md index 67ed51a330..4461961674 100644 --- a/docs/database/hbase.md +++ b/docs/database/hbase.md @@ -100,6 +100,6 @@ and SHOULD be provided **at span creation time** (if provided at all): HBase client instrumentations SHOULD collect metrics according to the general [Semantic Conventions for Database Client Metrics](database-metrics.md). -`db.system` MUST be set to `"hbase"`. +`db.system.name` MUST be set to `"hbase"`. [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status diff --git a/docs/database/mariadb.md b/docs/database/mariadb.md index e5313d596e..97a7afd5ff 100644 --- a/docs/database/mariadb.md +++ b/docs/database/mariadb.md @@ -111,6 +111,6 @@ and SHOULD be provided **at span creation time** (if provided at all): MariaDB client instrumentations SHOULD collect metrics according to the general [Semantic Conventions for Database Client Metrics](database-metrics.md). -`db.system` MUST be set to `"mariadb"`. +`db.system.name` MUST be set to `"mariadb"`. [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status diff --git a/docs/database/mongodb.md b/docs/database/mongodb.md index c8c3c1db89..d019a68155 100644 --- a/docs/database/mongodb.md +++ b/docs/database/mongodb.md @@ -114,6 +114,6 @@ and SHOULD be provided **at span creation time** (if provided at all): MongoDB client instrumentations SHOULD collect metrics according to the general [Semantic Conventions for Database Client Metrics](database-metrics.md). -`db.system` MUST be set to `"mongodb"`. +`db.system.name` MUST be set to `"mongodb"`. [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status diff --git a/docs/database/mssql.md b/docs/database/mssql.md index 5dd0dd1e80..015c87e2c1 100644 --- a/docs/database/mssql.md +++ b/docs/database/mssql.md @@ -114,6 +114,6 @@ and SHOULD be provided **at span creation time** (if provided at all): Microsoft SQL Server client instrumentations SHOULD collect metrics according to the general [Semantic Conventions for Database Client Metrics](database-metrics.md). -`db.system` MUST be set to `"mssql"`. +`db.system.name` MUST be set to `"microsoft.sql_server"`. [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status diff --git a/docs/database/mysql.md b/docs/database/mysql.md index 4017dcb59d..e1e428325d 100644 --- a/docs/database/mysql.md +++ b/docs/database/mysql.md @@ -109,6 +109,6 @@ and SHOULD be provided **at span creation time** (if provided at all): MySQL client instrumentations SHOULD collect metrics according to the general [Semantic Conventions for Database Client Metrics](database-metrics.md). -`db.system` MUST be set to `"mysql"`. +`db.system.name` MUST be set to `"mysql"`. [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status diff --git a/docs/database/postgresql.md b/docs/database/postgresql.md index 178c428710..0890ff2beb 100644 --- a/docs/database/postgresql.md +++ b/docs/database/postgresql.md @@ -116,6 +116,6 @@ and SHOULD be provided **at span creation time** (if provided at all): PostgreSQL client instrumentations SHOULD collect metrics according to the general [Semantic Conventions for Database Client Metrics](database-metrics.md). -`db.system` MUST be set to `"postgresql"`. +`db.system.name` MUST be set to `"postgresql"`. [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status