Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Trask Stalnaker <[email protected]>
  • Loading branch information
lmolkova and trask authored Oct 17, 2024
1 parent 9760554 commit 78cce84
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions docs/database/database-spans.md
Original file line number Diff line number Diff line change
Expand Up @@ -313,14 +313,12 @@ which SHOULD have low-cardinality and SHOULD NOT contain any dynamic or sensitiv
> might reach hundreds of lines.
>
> The `db.query.summary` is intended to provide a less granular grouping key that
> can be used as a span name or a metric attribute in common cases. It SHOULD
> only contain information that has a significant impact on the query, database,
> or application performance.
> can be used as a span name or a metric attribute in common cases.
Instrumentations that support query parsing SHOULD generate a query summary when
one is not readily available from other sources.

The summary SHOULD preserve the following parts of query in the order they were provided:
The summary SHOULD preserve the following parts of a query in the order they were provided:

- operations such as SQL SELECT, INSERT, UPDATE, DELETE, and other commands
- operation targets such as collections and database names
Expand Down Expand Up @@ -398,8 +396,8 @@ or other attributes, it SHOULD match the value used in the `db.query.summary`.
the corresponding `db.query.summary` is `SELECT "songs list" 'artists'`.
Semantic conventions for individual database systems or specialized instrumentations
MAY specify a different `db.query.summary` format as long as produced summary remains
relatively short and its cardinality remains low comparing to the `db.query.text`.
MAY specify a different `db.query.summary` format as long as the produced summary remains
relatively short and its cardinality remains low compared to `db.query.text`.
## Semantic Conventions for specific database technologies
Expand Down

0 comments on commit 78cce84

Please sign in to comment.