Skip to content

Latest commit

 

History

History
311 lines (260 loc) · 34.3 KB

db.md

File metadata and controls

311 lines (260 loc) · 34.3 KB

DB

General Database Attributes

This group defines the attributes used to describe telemetry in the context of databases.

Attribute Type Description Examples Stability
db.client.connection.pool.name string The name of the connection pool; unique within the instrumented application. In case the connection pool implementation doesn't provide a name, instrumentation SHOULD use a combination of parameters that would make the name unique, for example, combining attributes server.address, server.port, and db.namespace, formatted as server.address:server.port/db.namespace. Instrumentations that generate connection pool name following different patterns SHOULD document it. myDataSource Development
db.client.connection.state string The state of a connection in the pool idle Development
db.collection.name string The name of a collection (table, container) within the database. [1] public.users; customers Release Candidate
db.namespace string The name of the database, fully qualified within the server address and port. [2] customers; test.users Release Candidate
db.operation.batch.size int The number of queries included in a batch operation. [3] 2; 3; 4 Release Candidate
db.operation.name string The name of the operation or command being executed. [4] findAndModify; HMSET; SELECT Release Candidate
db.operation.parameter.<key> string A database operation parameter, with <key> being the parameter name, and the attribute value being a string representation of the parameter value. [5] someval; 55 Release Candidate
db.query.summary string Low cardinality representation of a database query text. [6] SELECT wuser_table; INSERT shipping_details SELECT orders; get user by id Release Candidate
db.query.text string The database query being executed. [7] SELECT * FROM wuser_table where username = ?; SET mykey ? Release Candidate
db.response.returned_rows int Number of rows returned by the operation. 10; 30; 1000 Development
db.response.status_code string Database response status code. [8] 102; ORA-17002; 08P01; 404 Release Candidate
db.system.name string The database management system (DBMS) product as identified by the client instrumentation. [9] other_sql; softwareag.adabas; actian.ingres Release Candidate

[1] db.collection.name: It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization.

The collection name SHOULD NOT be extracted from db.query.text, when the database system supports cross-table queries in non-batch operations.

For batch operations, if the individual operations are known to have the same collection name then that collection name SHOULD be used.

[2] db.namespace: If a database system has multiple namespace components, they SHOULD be concatenated (potentially using database system specific conventions) from most general to most specific namespace component, and more specific namespaces SHOULD NOT be captured without the more general namespaces, to ensure that "startswith" queries for the more general namespaces will be valid. Semantic conventions for individual database systems SHOULD document what db.namespace means in the context of that system. It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization.

[3] db.operation.batch.size: Operations are only considered batches when they contain two or more operations, and so db.operation.batch.size SHOULD never be 1.

[4] db.operation.name: It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization.

The operation name SHOULD NOT be extracted from db.query.text, when the database system supports cross-table queries in non-batch operations.

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

[5] db.operation.parameter: If a parameter has no name and instead is referenced only by index, then <key> SHOULD be the 0-based index. If db.query.text is also captured, then db.operation.parameter.<key> SHOULD match up with the parameterized placeholders present in db.query.text.

[6] db.query.summary: db.query.summary provides static summary of the query text. It 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.

[7] db.query.text: For sanitization see Sanitization of db.query.text. For batch operations, if the individual operations are known to have the same query text then that query text SHOULD be used, otherwise all of the individual query texts SHOULD be concatenated with separator ; or some other database system specific separator if more applicable. Even though parameterized query text can potentially have sensitive data, by using a parameterized query the user is giving a strong signal that any sensitive data will be passed as parameter values, and the benefit to observability of capturing the static part of the query text by default outweighs the risk.

[8] db.response.status_code: The status code returned by the database. Usually it represents an error code, but may also represent partial success, warning, or differentiate between various types of successful outcomes. Semantic conventions for individual database systems SHOULD document what db.response.status_code means in the context of that system.

[9] db.system.name: The actual DBMS may differ from the one identified by the client. For example, when using PostgreSQL client libraries to connect to a CockroachDB, the db.system.name is set to postgresql based on the instrumentation's best knowledge.

db.client.connection.state has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value Description Stability
idle idle Development
used used Development

db.system.name has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value Description Stability
actian.ingres Actian Ingres Development
aws.dynamodb Amazon DynamoDB Development
aws.redshift Amazon Redshift Development
azure.cosmosdb Azure Cosmos DB Development
cassandra Apache Cassandra Development
clickhouse ClickHouse Development
cockroachdb CockroachDB Development
couchbase Couchbase Development
couchdb Apache CouchDB Development
derby Apache Derby Development
elasticsearch Elasticsearch Development
firebirdsql Firebird Development
gcp.spanner Google Cloud Spanner Development
geode Apache Geode Development
h2database H2 Database Development
hbase Apache HBase Development
hive Apache Hive Development
hsqldb HyperSQL Database Development
ibm.db2 IBM Db2 Development
ibm.informix IBM Informix Development
ibm.netezza IBM Netezza Development
influxdb InfluxDB Development
instantdb Instant Development
intersystems.cache InterSystems Caché Development
mariadb MariaDB Release Candidate
memcached Memcached Development
microsoft.sql_server Microsoft SQL Server Release Candidate
mongodb MongoDB Development
mysql MySQL Release Candidate
neo4j Neo4j Development
opensearch OpenSearch Development
oracle.db Oracle Database Development
other_sql Some other SQL database. Fallback only. Development
postgresql PostgreSQL Release Candidate
redis Redis Development
sap.hana SAP HANA Development
sap.maxdb SAP MaxDB Development
softwareag.adabas Adabas (Adaptable Database System) Development
sqlite SQLite Development
teradata Teradata Development
trino Trino Development

Deprecated Database Attributes

Describes deprecated database attributes.

Attribute Type Description Examples Stability
db.cassandra.consistency_level string Deprecated, use cassandra.consistency.level instead. all; each_quorum; quorum Deprecated
Replaced by cassandra.consistency.level.
db.cassandra.coordinator.dc string Deprecated, use cassandra.coordinator.dc instead. us-west-2 Deprecated
Replaced by cassandra.coordinator.dc.
db.cassandra.coordinator.id string Deprecated, use cassandra.coordinator.id instead. be13faa2-8574-4d71-926d-27f16cf8a7af Deprecated
Replaced by cassandra.coordinator.id.
db.cassandra.idempotence boolean Deprecated, use cassandra.query.idempotent instead. Deprecated
Replaced by cassandra.query.idempotent.
db.cassandra.page_size int Deprecated, use cassandra.page.size instead. 5000 Deprecated
Replaced by cassandra.page.size.
db.cassandra.speculative_execution_count int Deprecated, use cassandra.speculative_execution.count instead. 0; 2 Deprecated
Replaced by cassandra.speculative_execution.count.
db.cassandra.table string Deprecated, use db.collection.name instead. mytable Deprecated
Replaced by db.collection.name.
db.connection_string string Deprecated, use server.address, server.port attributes instead. Server=(localdb)\v11.0;Integrated Security=true; Deprecated
Replaced by server.address and server.port.
db.cosmosdb.client_id string Deprecated, use azure.client.id instead. 3ba4827d-4422-483f-b59f-85b74211c11d Deprecated
Replaced by azure.client.id.
db.cosmosdb.connection_mode string Deprecated, use azure.cosmosdb.connection.mode instead. gateway; direct Deprecated
Replaced by azure.cosmosdb.connection.mode.
db.cosmosdb.consistency_level string Deprecated, use cosmosdb.consistency.level instead. Eventual; ConsistentPrefix; BoundedStaleness; Strong; Session Deprecated
Replaced by azure.cosmosdb.consistency.level.
db.cosmosdb.container string Deprecated, use db.collection.name instead. mytable Deprecated
Replaced by db.collection.name.
db.cosmosdb.operation_type string Deprecated, no replacement at this time. batch; create; delete Deprecated
No replacement at this time.
db.cosmosdb.regions_contacted string[] Deprecated, use azure.cosmosdb.operation.contacted_regions instead. ["North Central US", "Australia East", "Australia Southeast"] Deprecated
Replaced by azure.cosmosdb.operation.contacted_regions.
db.cosmosdb.request_charge double Deprecated, use azure.cosmosdb.operation.request_charge instead. 46.18; 1.0 Deprecated
Replaced by azure.cosmosdb.operation.request_charge.
db.cosmosdb.request_content_length int Deprecated, use azure.cosmosdb.request.body.size instead. Deprecated
Replaced by azure.cosmosdb.request.body.size.
db.cosmosdb.status_code int Deprecated, use db.response.status_code instead. 200; 201 Deprecated
Replaced by db.response.status_code.
db.cosmosdb.sub_status_code int Deprecated, use azure.cosmosdb.response.sub_status_code instead. 1000; 1002 Deprecated
Replaced by azure.cosmosdb.response.sub_status_code.
db.elasticsearch.cluster.name string Deprecated, use db.namespace instead. e9106fc68e3044f0b1475b04bf4ffd5f Deprecated
Replaced by db.namespace.
db.elasticsearch.node.name string Deprecated, use elasticsearch.node.name instead. instance-0000000001 Deprecated
Replaced by elasticsearch.node.name.
db.elasticsearch.path_parts.<key> string Deprecated, use db.operation.parameter instead. db.elasticsearch.path_parts.index=test-index; db.elasticsearch.path_parts.doc_id=123 Deprecated
Replaced by db.operation.parameter.
db.instance.id string Deprecated, no general replacement at this time. For Elasticsearch, use db.elasticsearch.node.name instead. mysql-e26b99z.example.com Deprecated
Deprecated, no general replacement at this time. For Elasticsearch, use db.elasticsearch.node.name instead.
db.jdbc.driver_classname string Removed, no replacement at this time. org.postgresql.Driver; com.microsoft.sqlserver.jdbc.SQLServerDriver Deprecated
Removed as not used.
db.mongodb.collection string Deprecated, use db.collection.name instead. mytable Deprecated
Replaced by db.collection.name.
db.mssql.instance_name string Deprecated, SQL Server instance is now populated as a part of db.namespace attribute. MSSQLSERVER Deprecated
Deprecated, no replacement at this time.
db.name string Deprecated, use db.namespace instead. customers; main Deprecated
Replaced by db.namespace.
db.operation string Deprecated, use db.operation.name instead. findAndModify; HMSET; SELECT Deprecated
Replaced by db.operation.name.
db.query.parameter.<key> string A query parameter used in db.query.text, with <key> being the parameter name, and the attribute value being a string representation of the parameter value. someval; 55 Deprecated
Replaced by db.operation.parameter.
db.redis.database_index int Deprecated, use db.namespace instead. 0; 1; 15 Deprecated
Replaced by db.namespace.
db.sql.table string Deprecated, use db.collection.name instead. mytable Deprecated
Replaced by db.collection.name.
db.statement string The database statement being executed. SELECT * FROM wuser_table; SET mykey "WuValue" Deprecated
Replaced by db.query.text.
db.system string Deprecated, use db.system.name instead. other_sql; adabas; cache Deprecated
Replaced by db.system.name.
db.user string Deprecated, no replacement at this time. readonly_user; reporting_user Deprecated
No replacement at this time.

db.cassandra.consistency_level has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value Description Stability
all all Development
any any Development
each_quorum each_quorum Development
local_one local_one Development
local_quorum local_quorum Development
local_serial local_serial Development
one one Development
quorum quorum Development
serial serial Development
three three Development
two two Development

db.cosmosdb.connection_mode has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value Description Stability
direct Direct connection. Development
gateway Gateway (HTTP) connection. Development

db.cosmosdb.consistency_level has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value Description Stability
BoundedStaleness bounded_staleness Development
ConsistentPrefix consistent_prefix Development
Eventual eventual Development
Session session Development
Strong strong Development

db.cosmosdb.operation_type has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value Description Stability
batch batch Development
create create Development
delete delete Development
execute execute Development
execute_javascript execute_javascript Development
head head Development
head_feed head_feed Development
invalid invalid Development
patch patch Development
query query Development
query_plan query_plan Development
read read Development
read_feed read_feed Development
replace replace Development
upsert upsert Development

db.system has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value Description Stability
adabas Adabas (Adaptable Database System) Development
cassandra Apache Cassandra Development
clickhouse ClickHouse Development
cockroachdb CockroachDB Development
cosmosdb Microsoft Azure Cosmos DB Development
couchbase Couchbase Development
couchdb CouchDB Development
db2 IBM Db2 Development
derby Apache Derby Development
dynamodb Amazon DynamoDB Development
edb EnterpriseDB Development
elasticsearch Elasticsearch Development
filemaker FileMaker Development
firebird Firebird Development
geode Apache Geode Development
h2 H2 Development
hanadb SAP HANA Development
hbase Apache HBase Development
hive Apache Hive Development
hsqldb HyperSQL DataBase Development
influxdb InfluxDB Development
informix Informix Development
ingres Ingres Development
instantdb InstantDB Development
interbase InterBase Development
intersystems_cache InterSystems Caché Development
mariadb MariaDB (This value has stability level RELEASE CANDIDATE) Release Candidate
maxdb SAP MaxDB Development
memcached Memcached Development
mongodb MongoDB Development
mssql Microsoft SQL Server (This value has stability level RELEASE CANDIDATE) Release Candidate
mysql MySQL (This value has stability level RELEASE CANDIDATE) Release Candidate
neo4j Neo4j Development
netezza Netezza Development
opensearch OpenSearch Development
oracle Oracle Database Development
other_sql Some other SQL database. Fallback only. See notes. Development
pervasive Pervasive PSQL Development
pointbase PointBase Development
postgresql PostgreSQL (This value has stability level RELEASE CANDIDATE) Release Candidate
progress Progress Database Development
redis Redis Development
redshift Amazon Redshift Development
spanner Cloud Spanner Development
sqlite SQLite Development
sybase Sybase Development
teradata Teradata Development
trino Trino Development
vertica Vertica Development

Deprecated Database Metrics

"Describes deprecated db metrics attributes."

Attribute Type Description Examples Stability
db.client.connections.pool.name string Deprecated, use db.client.connection.pool.name instead. myDataSource Deprecated
Replaced by db.client.connection.pool.name.
db.client.connections.state string Deprecated, use db.client.connection.state instead. idle Deprecated
Replaced by db.client.connection.state.
pool.name string Deprecated, use db.client.connection.pool.name instead. myDataSource Deprecated
Replaced by db.client.connection.pool.name.
state string Deprecated, use db.client.connection.state instead. idle Deprecated
Replaced by db.client.connection.state.

db.client.connections.state has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value Description Stability
idle idle Development
used used Development

state has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value Description Stability
idle idle Development
used used Development