semconv.com

db.query.summary

Stablestringas of v1.44.0

Low cardinality summary of a database query.

The query summary 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 instrumentation hooks or other means. If it is not available, instrumentations that support query parsing SHOULD generate a summary following Generating query summary section.

For batch operations, if the individual operations are known to have the same query summary then that query summary SHOULD be used prepended by BATCH , otherwise db.query.summary SHOULD be BATCH or some other database system specific term if more applicable.

Examples

Used by

metrics (2)

  • db.client.operation.duration
  • db.client.response.returned_rows

spans (8)

  • span.db.cassandra.client
  • span.db.client
  • span.db.mariadb.client
  • span.db.mysql.client
  • span.db.oracledb.client
  • span.db.postgresql.client
  • span.db.sql_server.client
  • span.db.sql.client

* required on that signal.

History

  1. v1.33.0stability

    Promoted to stable.

  2. v1.30.0

    Already present at v1.30.0, the oldest release tracked here (release_candidate).

Definition sourceRegistry docsJSON