Semantic Conventions for Database Metrics

Status: Mixed

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 which is a comma-separated list of values. If 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.

Database operation

Metric: db.client.operation.duration

Status: Release Candidate

This metric is required.

When this metric is reported alongside a database operation span, the metric value SHOULD be the same as the database operation span duration.

This metric SHOULD be specified with ExplicitBucketBoundaries of [ 0.001, 0.005, 0.01, 0.05, 0.1, 0.5, 1, 5, 10 ].

NameInstrument TypeUnit (UCUM)DescriptionStability
db.client.operation.durationHistogramsDuration of database client operations. [1]Experimental

[1]: Batch operations SHOULD be recorded as a single operation.

AttributeTypeDescriptionExamplesRequirement LevelStability
db.systemstringThe database management system (DBMS) product as identified by the client instrumentation. [1]other_sql; adabas; cacheRequiredExperimental
db.collection.namestringThe name of a collection (table, container) within the database. [2]public.users; customersConditionally Required [3]Experimental
db.namespacestringThe name of the database, fully qualified within the server address and port. [4]customers; test.usersConditionally Required If available.Experimental
db.operation.namestringThe name of the operation or command being executed. [5]findAndModify; HMSET; SELECTConditionally Required [6]Experimental
db.response.status_codestringDatabase response status code. [7]102; ORA-17002; 08P01; 404Conditionally Required [8]Experimental
error.typestringDescribes a class of error the operation ended with. [9]timeout; java.net.UnknownHostException; server_certificate_invalid; 500Conditionally Required If and only if the operation failed.Stable
server.portintServer port number. [10]80; 8080; 443Conditionally Required [11]Stable
network.peer.addressstringPeer address of the database node where the operation was performed. [12]10.1.2.80; /tmp/my.sockRecommended If applicable for this database system.Stable
network.peer.portintPeer port number of the network connection.65123Recommended If and only if network.peer.address is set.Stable
server.addressstringName of the database host. [13]example.com; 10.1.2.80; /tmp/my.sockRecommendedStable

[1]: 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 is set to postgresql based on the instrumentation’s best knowledge. This attribute has stability level RELEASE CANDIDATE.

[2]: It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization. If the collection name is parsed from the query text, it SHOULD be the first collection name found in the query and it SHOULD match the value provided in the query text including any schema and database name prefix. For batch operations, if the individual operations are known to have the same collection name then that collection name SHOULD be used, otherwise db.collection.name SHOULD NOT be captured. This attribute has stability level RELEASE CANDIDATE.

[3]: If readily available. The collection name MAY be parsed from the query text, in which case it SHOULD be the first collection name in the query.

[4]: 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. This attribute has stability level RELEASE CANDIDATE.

[5]: It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization. If the operation name is parsed from the query text, it SHOULD be the first operation name found in the query. 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. This attribute has stability level RELEASE CANDIDATE.

[6]: If readily available. The operation name MAY be parsed from the query text, in which case it SHOULD be the first operation name found in the query.

[7]: 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. This attribute has stability level RELEASE CANDIDATE.

[8]: If the operation failed and status code is available.

[9]: The error.type SHOULD match the db.response.status_code returned by the database or the client library, or the canonical name of exception that occurred. When using canonical exception type name, instrumentation SHOULD do the best effort to report the most relevant type. For example, if the original exception is wrapped into a generic one, the original exception SHOULD be preferred. Instrumentations SHOULD document how error.type is populated.

[10]: When observed from the client side, and when communicating through an intermediary, server.port SHOULD represent the server port behind any intermediaries, for example proxies, if it’s available.

[11]: If using a port other than the default port for this DBMS and if server.address is set.

[12]: Semantic conventions for individual database systems SHOULD document whether network.peer.* attributes are applicable. Network peer address and port are useful when the application interacts with individual database nodes directly. If a database operation involved multiple network calls (for example retries), the address of the last contacted node SHOULD be used.

[13]: When observed from the client side, and when communicating through an intermediary, server.address SHOULD represent the server address behind any intermediaries, for example proxies, if it’s available.

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.

ValueDescriptionStability
adabasAdabas (Adaptable Database System)Experimental
cassandraApache CassandraExperimental
clickhouseClickHouseExperimental
cockroachdbCockroachDBExperimental
cosmosdbMicrosoft Azure Cosmos DBExperimental
couchbaseCouchbaseExperimental
couchdbCouchDBExperimental
db2IBM Db2Experimental
derbyApache DerbyExperimental
dynamodbAmazon DynamoDBExperimental
edbEnterpriseDBExperimental
elasticsearchElasticsearchExperimental
filemakerFileMakerExperimental
firebirdFirebirdExperimental
geodeApache GeodeExperimental
h2H2Experimental
hanadbSAP HANAExperimental
hbaseApache HBaseExperimental
hiveApache HiveExperimental
hsqldbHyperSQL DataBaseExperimental
influxdbInfluxDBExperimental
informixInformixExperimental
ingresIngresExperimental
instantdbInstantDBExperimental
interbaseInterBaseExperimental
intersystems_cacheInterSystems CachéExperimental
mariadbMariaDB (This value has stability level RELEASE CANDIDATE)Experimental
maxdbSAP MaxDBExperimental
memcachedMemcachedExperimental
mongodbMongoDBExperimental
mssqlMicrosoft SQL Server (This value has stability level RELEASE CANDIDATE)Experimental
mysqlMySQL (This value has stability level RELEASE CANDIDATE)Experimental
neo4jNeo4jExperimental
netezzaNetezzaExperimental
opensearchOpenSearchExperimental
oracleOracle DatabaseExperimental
other_sqlSome other SQL database. Fallback only. See notes.Experimental
pervasivePervasive PSQLExperimental
pointbasePointBaseExperimental
postgresqlPostgreSQL (This value has stability level RELEASE CANDIDATE)Experimental
progressProgress DatabaseExperimental
redisRedisExperimental
redshiftAmazon RedshiftExperimental
spannerCloud SpannerExperimental
sqliteSQLiteExperimental
sybaseSybaseExperimental
teradataTeradataExperimental
trinoTrinoExperimental
verticaVerticaExperimental

error.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.

ValueDescriptionStability
_OTHERA fallback error value to be used when the instrumentation doesn’t define a custom value.Stable

Experimental

Connection pools

The following metric instruments describe database client connection pool operations.

Metric: db.client.connection.count

This metric is required.

NameInstrument TypeUnit (UCUM)DescriptionStability
db.client.connection.countUpDownCounter{connection}The number of connections that are currently in state described by the state attributeExperimental
AttributeTypeDescriptionExamplesRequirement LevelStability
db.client.connection.pool.namestringThe 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.myDataSourceRequiredExperimental
db.client.connection.statestringThe state of a connection in the poolidleRequiredExperimental

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.

ValueDescriptionStability
idleidleExperimental
usedusedExperimental

Metric: db.client.connection.idle.max

This metric is recommended.

NameInstrument TypeUnit (UCUM)DescriptionStability
db.client.connection.idle.maxUpDownCounter{connection}The maximum number of idle open connections allowedExperimental
AttributeTypeDescriptionExamplesRequirement LevelStability
db.client.connection.pool.namestringThe 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.myDataSourceRequiredExperimental

Metric: db.client.connection.idle.min

This metric is recommended.

NameInstrument TypeUnit (UCUM)DescriptionStability
db.client.connection.idle.minUpDownCounter{connection}The minimum number of idle open connections allowedExperimental
AttributeTypeDescriptionExamplesRequirement LevelStability
db.client.connection.pool.namestringThe 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.myDataSourceRequiredExperimental

Metric: db.client.connection.max

This metric is recommended.

NameInstrument TypeUnit (UCUM)DescriptionStability
db.client.connection.maxUpDownCounter{connection}The maximum number of open connections allowedExperimental
AttributeTypeDescriptionExamplesRequirement LevelStability
db.client.connection.pool.namestringThe 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.myDataSourceRequiredExperimental

Metric: db.client.connection.pending_requests

This metric is recommended.

NameInstrument TypeUnit (UCUM)DescriptionStability
db.client.connection.pending_requestsUpDownCounter{request}The number of current pending requests for an open connectionExperimental
AttributeTypeDescriptionExamplesRequirement LevelStability
db.client.connection.pool.namestringThe 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.myDataSourceRequiredExperimental

Metric: db.client.connection.timeouts

This metric is recommended.

NameInstrument TypeUnit (UCUM)DescriptionStability
db.client.connection.timeoutsCounter{timeout}The number of connection timeouts that have occurred trying to obtain a connection from the poolExperimental
AttributeTypeDescriptionExamplesRequirement LevelStability
db.client.connection.pool.namestringThe 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.myDataSourceRequiredExperimental

Metric: db.client.connection.create_time

This metric is recommended.

NameInstrument TypeUnit (UCUM)DescriptionStability
db.client.connection.create_timeHistogramsThe time it took to create a new connectionExperimental
AttributeTypeDescriptionExamplesRequirement LevelStability
db.client.connection.pool.namestringThe 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.myDataSourceRequiredExperimental

Metric: db.client.connection.wait_time

This metric is recommended.

NameInstrument TypeUnit (UCUM)DescriptionStability
db.client.connection.wait_timeHistogramsThe time it took to obtain an open connection from the poolExperimental
AttributeTypeDescriptionExamplesRequirement LevelStability
db.client.connection.pool.namestringThe 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.myDataSourceRequiredExperimental

Metric: db.client.connection.use_time

This metric is recommended.

NameInstrument TypeUnit (UCUM)DescriptionStability
db.client.connection.use_timeHistogramsThe time between borrowing a connection and returning it to the poolExperimental
AttributeTypeDescriptionExamplesRequirement LevelStability
db.client.connection.pool.namestringThe 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.myDataSourceRequiredExperimental