Skip to content

Commit 61132ad

Browse files
sincejunetrask
andauthored
[db] rename db.system to db.system.name for metrics and update values (#1917)
Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>
1 parent 46a6a15 commit 61132ad

11 files changed

+32
-10
lines changed

.chloggen/rename-db-metric-name.yaml

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Use this changelog template to create an entry for release notes.
2+
#
3+
# If your change doesn't affect end users you should instead start
4+
# your pull request title with [chore] or use the "Skip Changelog" label.
5+
6+
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
7+
change_type: breaking
8+
9+
# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db)
10+
component: db
11+
12+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
13+
note: Rename `db.system` to `db.system.name` in database metrics, and update the values to be consistent with database spans.
14+
15+
# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
16+
# The values here must be integers.
17+
issues: [1581]
18+
19+
# (Optional) One or more lines of additional information to render under the primary note.
20+
# These lines will be padded with 2 spaces and then inserted directly into the document.
21+
# Use pipe (|) for multiline entries.
22+
subtext:

docs/database/cassandra.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,6 @@ and SHOULD be provided **at span creation time** (if provided at all):
160160
Cassandra client instrumentations SHOULD collect metrics according to the general
161161
[Semantic Conventions for Database Client Metrics](database-metrics.md).
162162

163-
`db.system` MUST be set to `"cassandra"`.
163+
`db.system.name` MUST be set to `"cassandra"`.
164164

165165
[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status

docs/database/couchdb.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,6 @@ and SHOULD be provided **at span creation time** (if provided at all):
8484
CouchDB client instrumentations SHOULD collect metrics according to the general
8585
[Semantic Conventions for Database Client Metrics](database-metrics.md).
8686

87-
`db.system` MUST be set to `"couchdb"`.
87+
`db.system.name` MUST be set to `"couchdb"`.
8888

8989
[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status

docs/database/dynamodb.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -593,6 +593,6 @@ The following table outlines the span attributes applicable to DynamoDB.
593593
AWS DynamoDB client instrumentations SHOULD collect metrics according to the general
594594
[Semantic Conventions for Database Client Metrics](database-metrics.md).
595595

596-
`db.system` MUST be set to `"dynamodb"`.
596+
`db.system.name` MUST be set to `"aws.dynamodb"`.
597597

598598
[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status

docs/database/elasticsearch.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,6 @@ and SHOULD be provided **at span creation time** (if provided at all):
182182
Elasticsearch client instrumentations SHOULD collect metrics according to the general
183183
[Semantic Conventions for Database Client Metrics](database-metrics.md).
184184

185-
`db.system` MUST be set to `"elasticsearch"`.
185+
`db.system.name` MUST be set to `"elasticsearch"`.
186186

187187
[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status

docs/database/hbase.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,6 @@ and SHOULD be provided **at span creation time** (if provided at all):
100100
HBase client instrumentations SHOULD collect metrics according to the general
101101
[Semantic Conventions for Database Client Metrics](database-metrics.md).
102102

103-
`db.system` MUST be set to `"hbase"`.
103+
`db.system.name` MUST be set to `"hbase"`.
104104

105105
[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status

docs/database/mariadb.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,6 @@ and SHOULD be provided **at span creation time** (if provided at all):
111111
MariaDB client instrumentations SHOULD collect metrics according to the general
112112
[Semantic Conventions for Database Client Metrics](database-metrics.md).
113113

114-
`db.system` MUST be set to `"mariadb"`.
114+
`db.system.name` MUST be set to `"mariadb"`.
115115

116116
[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status

docs/database/mongodb.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,6 @@ and SHOULD be provided **at span creation time** (if provided at all):
114114
MongoDB client instrumentations SHOULD collect metrics according to the general
115115
[Semantic Conventions for Database Client Metrics](database-metrics.md).
116116

117-
`db.system` MUST be set to `"mongodb"`.
117+
`db.system.name` MUST be set to `"mongodb"`.
118118

119119
[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status

docs/database/mssql.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,6 @@ and SHOULD be provided **at span creation time** (if provided at all):
114114
Microsoft SQL Server client instrumentations SHOULD collect metrics according to the general
115115
[Semantic Conventions for Database Client Metrics](database-metrics.md).
116116

117-
`db.system` MUST be set to `"mssql"`.
117+
`db.system.name` MUST be set to `"microsoft.sql_server"`.
118118

119119
[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status

docs/database/mysql.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,6 @@ and SHOULD be provided **at span creation time** (if provided at all):
109109
MySQL client instrumentations SHOULD collect metrics according to the general
110110
[Semantic Conventions for Database Client Metrics](database-metrics.md).
111111

112-
`db.system` MUST be set to `"mysql"`.
112+
`db.system.name` MUST be set to `"mysql"`.
113113

114114
[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status

docs/database/postgresql.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,6 @@ and SHOULD be provided **at span creation time** (if provided at all):
116116
PostgreSQL client instrumentations SHOULD collect metrics according to the general
117117
[Semantic Conventions for Database Client Metrics](database-metrics.md).
118118

119-
`db.system` MUST be set to `"postgresql"`.
119+
`db.system.name` MUST be set to `"postgresql"`.
120120

121121
[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status

0 commit comments

Comments
 (0)