From 14f53309229db3a4463c3ca3fa11c15e1394564b Mon Sep 17 00:00:00 2001 From: Trask Stalnaker Date: Mon, 28 Apr 2025 07:38:29 -0700 Subject: [PATCH] Improve wording of `db.collection.name` and `db.operation.name` (#2186) --- docs/attributes-registry/db.md | 6 ++++-- docs/database/cassandra.md | 3 ++- docs/database/cosmosdb.md | 3 ++- docs/database/database-metrics.md | 12 ++++++++---- docs/database/database-spans.md | 6 ++++-- model/database/registry.yaml | 6 ++++-- 6 files changed, 24 insertions(+), 12 deletions(-) diff --git a/docs/attributes-registry/db.md b/docs/attributes-registry/db.md index 94b031a6a..5934a5517 100644 --- a/docs/attributes-registry/db.md +++ b/docs/attributes-registry/db.md @@ -32,7 +32,8 @@ This group defines the attributes used to describe telemetry in the context of d without attempting to do any case normalization. The collection name SHOULD NOT be extracted from `db.query.text`, -when the database system supports cross-table queries in non-batch operations. +when the database system supports query text with multiple collections +in non-batch operations. For batch operations, if the individual operations are known to have the same collection name then that collection name SHOULD be used. @@ -47,7 +48,8 @@ It is RECOMMENDED to capture the value as provided by the application without at without attempting to do any case normalization. The operation name SHOULD NOT be extracted from `db.query.text`, -when the database system supports cross-table queries in non-batch operations. +when the database system supports query text with multiple operations +in non-batch operations. If spaces can occur in the operation name, multiple consecutive spaces SHOULD be normalized to a single space. diff --git a/docs/database/cassandra.md b/docs/database/cassandra.md index 3c12cbad1..f8ec49d37 100644 --- a/docs/database/cassandra.md +++ b/docs/database/cassandra.md @@ -75,7 +75,8 @@ It is RECOMMENDED to capture the value as provided by the application without at without attempting to do any case normalization. The operation name SHOULD NOT be extracted from `db.query.text`, -when the database system supports cross-table queries in non-batch operations. +when the database system supports query text with multiple operations +in non-batch operations. If spaces can occur in the operation name, multiple consecutive spaces SHOULD be normalized to a single space. diff --git a/docs/database/cosmosdb.md b/docs/database/cosmosdb.md index 8b3839800..4d3a73b77 100644 --- a/docs/database/cosmosdb.md +++ b/docs/database/cosmosdb.md @@ -374,7 +374,8 @@ Explaining bucket configuration: without attempting to do any case normalization. The operation name SHOULD NOT be extracted from `db.query.text`, -when the database system supports cross-table queries in non-batch operations. +when the database system supports query text with multiple operations +in non-batch operations. If spaces can occur in the operation name, multiple consecutive spaces SHOULD be normalized to a single space. diff --git a/docs/database/database-metrics.md b/docs/database/database-metrics.md index 0962e161b..158ecbf85 100644 --- a/docs/database/database-metrics.md +++ b/docs/database/database-metrics.md @@ -101,7 +101,8 @@ of `[ 0.001, 0.005, 0.01, 0.05, 0.1, 0.5, 1, 5, 10 ]`. without attempting to do any case normalization. The collection name SHOULD NOT be extracted from `db.query.text`, -when the database system supports cross-table queries in non-batch operations. +when the database system supports query text with multiple collections +in non-batch operations. For batch operations, if the individual operations are known to have the same collection name then that collection name SHOULD be used. @@ -116,7 +117,8 @@ It is RECOMMENDED to capture the value as provided by the application without at without attempting to do any case normalization. The operation name SHOULD NOT be extracted from `db.query.text`, -when the database system supports cross-table queries in non-batch operations. +when the database system supports query text with multiple operations +in non-batch operations. If spaces can occur in the operation name, multiple consecutive spaces SHOULD be normalized to a single space. @@ -279,7 +281,8 @@ Explaining bucket configuration: without attempting to do any case normalization. The collection name SHOULD NOT be extracted from `db.query.text`, -when the database system supports cross-table queries in non-batch operations. +when the database system supports query text with multiple collections +in non-batch operations. For batch operations, if the individual operations are known to have the same collection name then that collection name SHOULD be used. @@ -294,7 +297,8 @@ It is RECOMMENDED to capture the value as provided by the application without at without attempting to do any case normalization. The operation name SHOULD NOT be extracted from `db.query.text`, -when the database system supports cross-table queries in non-batch operations. +when the database system supports query text with multiple operations +in non-batch operations. If spaces can occur in the operation name, multiple consecutive spaces SHOULD be normalized to a single space. diff --git a/docs/database/database-spans.md b/docs/database/database-spans.md index 2045143e5..77c493d89 100644 --- a/docs/database/database-spans.md +++ b/docs/database/database-spans.md @@ -124,7 +124,8 @@ classify as errors. without attempting to do any case normalization. The collection name SHOULD NOT be extracted from `db.query.text`, -when the database system supports cross-table queries in non-batch operations. +when the database system supports query text with multiple collections +in non-batch operations. For batch operations, if the individual operations are known to have the same collection name then that collection name SHOULD be used. @@ -139,7 +140,8 @@ It is RECOMMENDED to capture the value as provided by the application without at without attempting to do any case normalization. The operation name SHOULD NOT be extracted from `db.query.text`, -when the database system supports cross-table queries in non-batch operations. +when the database system supports query text with multiple operations +in non-batch operations. If spaces can occur in the operation name, multiple consecutive spaces SHOULD be normalized to a single space. diff --git a/model/database/registry.yaml b/model/database/registry.yaml index 2a80c6c3f..3a8aa8a5d 100644 --- a/model/database/registry.yaml +++ b/model/database/registry.yaml @@ -14,7 +14,8 @@ groups: without attempting to do any case normalization. The collection name SHOULD NOT be extracted from `db.query.text`, - when the database system supports cross-table queries in non-batch operations. + when the database system supports query text with multiple collections + in non-batch operations. For batch operations, if the individual operations are known to have the same collection name then that collection name SHOULD be used. @@ -45,7 +46,8 @@ groups: without attempting to do any case normalization. The operation name SHOULD NOT be extracted from `db.query.text`, - when the database system supports cross-table queries in non-batch operations. + when the database system supports query text with multiple operations + in non-batch operations. If spaces can occur in the operation name, multiple consecutive spaces SHOULD be normalized to a single space.