diff --git a/docs/attributes-registry/db.md b/docs/attributes-registry/db.md index 173e6f2655..1210c914b5 100644 --- a/docs/attributes-registry/db.md +++ b/docs/attributes-registry/db.md @@ -55,9 +55,19 @@ This attribute has stability level RELEASE CANDIDATE. **[3]:** Operations are only considered batches when they contain two or more operations, and so `db.operation.batch.size` SHOULD never be `1`. This attribute has stability level RELEASE CANDIDATE. -**[4]:** It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization. -A single database query may involve multiple operations. If the operation name is parsed from the query text, it SHOULD only be captured for queries that contain a single operation or when the operation name describing the whole query is available by other means (such as SQL comments). -For batch operations, if the individual operations are known to have the same operation name then that operation name SHOULD be used prepended by `BATCH `, otherwise `db.operation.name` SHOULD be `BATCH` or some other database system specific term if more applicable. +**[4]:** It is RECOMMENDED to capture the value as provided by the application +without attempting to do any case normalization. + +A single database query may involve multiple operations. If the operation +name is parsed from the query text, it SHOULD only be captured for queries that +contain a single operation or when the operation name describing the +whole query is available by other means. + +For batch operations, if the individual operations are known to have the same operation name +then that operation name SHOULD be used prepended by `BATCH `, +otherwise `db.operation.name` SHOULD be `BATCH` or some other database +system specific term if more applicable. + This attribute has stability level RELEASE CANDIDATE. **[5]:** Query parameters should only be captured when `db.query.text` is parameterized with placeholders. @@ -65,7 +75,7 @@ If a parameter has no name and instead is referenced only by index, then `` This attribute has stability level RELEASE CANDIDATE. **[6]:** `db.query.summary` provides static summary of the query text. It describes a class of database queries and is useful as a grouping key, especially when analyzing telemetry for database calls involving complex queries. -Summary may be available to the instrumentation through SQL comment, instrumentation hooks, or other means. If it is not available, instrumentations that support query parsing SHOULD generate a summary following [Generating query summary](../../docs/database/database-spans.md#generating-a-summary-of-the-quey-text) section. +Summary may be available to the instrumentation through instrumentation hooks or other means. If it is not available, instrumentations that support query parsing SHOULD generate a summary following [Generating query summary](../../docs/database/database-spans.md#generating-a-summary-of-the-quey-text) section. This attribute has stability level RELEASE CANDIDATE. **[7]:** For sanitization see [Sanitization of `db.query.text`](../../docs/database/database-spans.md#sanitization-of-dbquerytext).