open-telemetry
/
semantic-conventions
mirror of https://github.com/open-telemetry/semantic-conventions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
semantic-conventions/docs/database
History
Trask Stalnaker 7f6471212c
Clarify `db.query.summary` for stored procedures (#2218) 
Co-authored-by: Alan West <3676547+alanwest@users.noreply.github.com>
 		2025-05-02 19:28:08 +00:00
..
README.md Improve wording of OTEL_SEMCONV_STABILITY_OPT_IN for database semconv (#2210) 2025-05-02 14:35:28 +00:00
cassandra.md Add an option to generate db.query.summary from operation/target, restrict its usage for non-query databases (#2206) 2025-05-02 05:07:20 +00:00
cosmosdb.md Add an option to generate db.query.summary from operation/target, restrict its usage for non-query databases (#2206) 2025-05-02 05:07:20 +00:00
couchdb.md Add span rendering template and clean up span briefs and notes (#1505) 2025-04-09 09:32:28 -07:00
database-metrics.md Improve wording of OTEL_SEMCONV_STABILITY_OPT_IN for database semconv (#2210) 2025-05-02 14:35:28 +00:00
database-spans.md Clarify `db.query.summary` for stored procedures (#2218) 2025-05-02 19:28:08 +00:00
dynamodb.md Add span rendering template and clean up span briefs and notes (#1505) 2025-04-09 09:32:28 -07:00
elasticsearch.md Render template attribute name consistently in the table and notes (#2193) 2025-05-01 01:21:08 +00:00
hbase.md Make db.operation.name required where it's available, clarify what to do with multiple layers (#2200) 2025-04-30 17:19:49 +00:00
mariadb.md Make `db.response.returned_rows` opt-in on `release_candidate` spans (#2211) 2025-05-02 14:35:00 +00:00
mongodb.md Make db.operation.name required where it's available, clarify what to do with multiple layers (#2200) 2025-04-30 17:19:49 +00:00
mysql.md Make `db.response.returned_rows` opt-in on `release_candidate` spans (#2211) 2025-05-02 14:35:00 +00:00
oracledb.md Make `db.response.returned_rows` opt-in on `release_candidate` spans (#2211) 2025-05-02 14:35:00 +00:00
postgresql.md Make `db.response.returned_rows` opt-in on `release_candidate` spans (#2211) 2025-05-02 14:35:00 +00:00
redis.md Add `db.stored_procedure.name` to the general span conventions (#2205) 2025-05-01 15:07:56 +00:00
sql-server.md Make `db.response.returned_rows` opt-in on `release_candidate` spans (#2211) 2025-05-02 14:35:00 +00:00
sql.md Make `db.response.returned_rows` opt-in on `release_candidate` spans (#2211) 2025-05-02 14:35:00 +00:00

README.md

Semantic conventions for database calls and systems

Status: Mixed

This document defines semantic conventions for database client spans as well as database metrics and logs.

Warning

Existing database instrumentations that are using v1.24.0 of this document (or prior):

  • SHOULD NOT change the version of the database conventions that they emit by default in their existing major version. Conventions include (but are not limited to) attributes, metric and span names, and unit of measure.
  • SHOULD introduce an environment variable OTEL_SEMCONV_STABILITY_OPT_IN in their existing major version as a comma-separated list of category-specific values (e.g., http, databases, messaging). The list of values includes:
    • database - emit the stable database conventions, and stop emitting the experimental database conventions that the instrumentation emitted previously.
    • database/dup - emit both the experimental and stable database conventions, allowing for a phased rollout of the stable semantic conventions.
    • The default behavior (in the absence of one of these values) is to continue emitting whatever version of the old experimental database conventions the instrumentation was emitting previously.
    • Note: database/dup has higher precedence than database in case both values are present
  • SHOULD maintain (security patching at a minimum) their existing major version for at least six months after it starts emitting both sets of conventions.
  • MAY drop the environment variable in their next major version and emit only the stable database conventions.

Semantic conventions for database operations are defined for the following signals:

  • DB Spans: Semantic Conventions for database client spans.
  • DB Metrics: Semantic Conventions for database operation metrics.

Technology specific semantic conventions are defined for the following databases: