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 ad05f1d8d3
Clarify db.query.parameter is string representation (#1165) 
Co-authored-by: Joao Grassi <5938087+joaopgrassi@users.noreply.github.com>
 		2024-06-25 11:40:10 +00:00
..
README.md [chore] Use document status link to otel.io instead of versioned spec (#1093) 2024-06-03 13:33:39 +02:00
cassandra.md Clarify db.query.parameter is string representation (#1165) 2024-06-25 11:40:10 +00:00
cosmosdb.md Clarify db.query.parameter is string representation (#1165) 2024-06-25 11:40:10 +00:00
couchdb.md [chore] Remove the workaround to drop inherited note (#1092) 2024-06-03 21:22:04 +00:00
database-metrics.md Clean up database systems (#1120) 2024-06-07 13:04:54 -07:00
database-spans.md Clarify db.query.parameter is string representation (#1165) 2024-06-25 11:40:10 +00:00
dynamodb.md Clean up database systems (#1120) 2024-06-07 13:04:54 -07:00
elasticsearch.md Define sanitization for db.query.text (#1100) 2024-06-24 07:23:59 -07:00
hbase.md [chore] Use document status link to otel.io instead of versioned spec (#1093) 2024-06-03 13:33:39 +02:00
mongodb.md [chore] Remove the workaround to drop inherited note (#1092) 2024-06-03 21:22:04 +00:00
mssql.md Clarify db.query.parameter is string representation (#1165) 2024-06-25 11:40:10 +00:00
redis.md Clarify db.query.parameter is string representation (#1165) 2024-06-25 11:40:10 +00:00
sql.md Clarify db.query.parameter is string representation (#1165) 2024-06-25 11:40:10 +00:00

README.md

Semantic Conventions for Database Calls and Systems

Status: Experimental

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 until a transition plan to the (future) stable semantic conventions has been published. Conventions include, but are not limited to, attributes, metric and span names, and unit of measure.

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:

  • AWS DynamoDB: Semantic Conventions for AWS DynamoDB.
  • Cassandra: Semantic Conventions for Cassandra.
  • Cosmos DB: Semantic Conventions for Microsoft Cosmos DB.
  • CouchDB: Semantic Conventions for CouchDB.
  • Elasticsearch: Semantic Conventions for Elasticsearch.
  • HBase: Semantic Conventions for HBase.
  • MongoDB: Semantic Conventions for MongoDB.
  • MSSQL: Semantic Conventions for MSSQL.
  • Redis: Semantic Conventions for Redis.
  • SQL: Semantic Conventions for SQL databases.