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
Liudmila Molkova 7ab7a384e3
Render template attribute name consistently in the table and notes (#2193) 		2025-05-01 01:21:08 +00:00
..
README.md [chore] allow category-specific values in OTEL_SEMCONV_STABILITY_OPT_IN (#2158) 2025-04-22 18:05:57 +00:00
cassandra.md Render template attribute name consistently in the table and notes (#2193) 2025-05-01 01:21:08 +00:00
cosmosdb.md Render template attribute name consistently in the table and notes (#2193) 2025-05-01 01:21:08 +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 Add bare minimum Entity Association capabilities - Apply to System + Process semconv (#2123) 2025-04-28 16:28:37 +00:00
database-spans.md Render template attribute name consistently in the table and notes (#2193) 2025-05-01 01:21: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 Render template attribute name consistently in the table and notes (#2193) 2025-05-01 01:21:08 +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 Render template attribute name consistently in the table and notes (#2193) 2025-05-01 01:21:08 +00:00
oracledb.md Render template attribute name consistently in the table and notes (#2193) 2025-05-01 01:21:08 +00:00
postgresql.md Render template attribute name consistently in the table and notes (#2193) 2025-05-01 01:21:08 +00:00
redis.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
sql-server.md Render template attribute name consistently in the table and notes (#2193) 2025-05-01 01:21:08 +00:00
sql.md Render template attribute name consistently in the table and notes (#2193) 2025-05-01 01:21:08 +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 until the database semantic conventions are marked stable. 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 the 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 new, stable database conventions, and stop emitting the old experimental database conventions that the instrumentation emitted previously.
    • database/dup - emit both the old and the stable database conventions, allowing for a seamless transition.
    • 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) the existing major version for at least six months after it starts emitting both sets of conventions.
  • SHOULD drop the environment variable in the next major version.

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: