# Database - [Generic Database Attributes](#generic-database-attributes) - [Cassandra Attributes](#cassandra-attributes) - [CosmosDB Attributes](#cosmosdb-attributes) - [Elasticsearch Attributes](#elasticsearch-attributes) - [MSSQL Attributes](#mssql-attributes) - [Redis Attributes](#redis-attributes) - [Deprecated DB Attributes](#deprecated-db-attributes) - [Deprecated DB Metrics Attributes](#deprecated-db-metrics-attributes) ## Generic Database Attributes | Attribute | Type | Description | Examples | Stability | |---|---|---|---|---| | `db.client.connections.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 `server.address` and `server.port` attributes formatted as `server.address:server.port`. | `myDataSource` |  | | `db.client.connections.state` | string | The state of a connection in the pool | `idle` |  | | `db.collection.name` | string | The name of a collection (table, container) within the database. [1] | `public.users`; `customers` |  | | `db.instance.id` | string | An identifier (address, unique name, or any other identifier) of the database instance that is executing queries or mutations on the current connection. This is useful in cases where the database is running in a clustered environment and the instrumentation is able to record the node executing the query. The client may obtain this value in databases like MySQL using queries like `select @@hostname`. | `mysql-e26b99z.example.com` |  | | `db.name` | string | This attribute is used to report the name of the database being accessed. For commands that switch the database, this should be set to the target database (even if the command fails). [2] | `customers`; `main` |  | | `db.operation.name` | string | The name of the operation or command being executed. | `findAndModify`; `HMSET`; `SELECT` |  | | `db.query.parameter.` | string | The query parameters used in `db.query.text`, with `` being the parameter name, and the attribute value being the parameter value. [3] | `someval`; `55` |  | | `db.query.text` | string | The database query being executed. | `SELECT * FROM wuser_table where username = ?`; `SET mykey "WuValue"` |  | | `db.system` | string | An identifier for the database management system (DBMS) product being used. See below for a list of well-known identifiers. | `other_sql` |  | **[1]:** If the collection name is parsed from the query, it SHOULD match the value provided in the query and may be qualified with the schema and database name. **[2]:** In some SQL databases, the database name to be used is called "schema name". In case there are multiple layers that could be considered for database name (e.g. Oracle instance name and schema name), the database name to be used is the more specific layer (e.g. Oracle schema name). **[3]:** Query parameters should only be captured when `db.query.text` is parameterized with placeholders. If a parameter has no name and instead is referenced only by index, then `` SHOULD be the 0-based index. `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 |  | | `used` | used |  | `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 | |---|---|---| | `other_sql` | Some other SQL database. Fallback only. See notes. |  | | `mssql` | Microsoft SQL Server |  | | `mssqlcompact` | Microsoft SQL Server Compact |  | | `mysql` | MySQL |  | | `oracle` | Oracle Database |  | | `db2` | IBM Db2 |  | | `postgresql` | PostgreSQL |  | | `redshift` | Amazon Redshift |  | | `hive` | Apache Hive |  | | `cloudscape` | Cloudscape |  | | `hsqldb` | HyperSQL DataBase |  | | `progress` | Progress Database |  | | `maxdb` | SAP MaxDB |  | | `hanadb` | SAP HANA |  | | `ingres` | Ingres |  | | `firstsql` | FirstSQL |  | | `edb` | EnterpriseDB |  | | `cache` | InterSystems Caché |  | | `adabas` | Adabas (Adaptable Database System) |  | | `firebird` | Firebird |  | | `derby` | Apache Derby |  | | `filemaker` | FileMaker |  | | `informix` | Informix |  | | `instantdb` | InstantDB |  | | `interbase` | InterBase |  | | `mariadb` | MariaDB |  | | `netezza` | Netezza |  | | `pervasive` | Pervasive PSQL |  | | `pointbase` | PointBase |  | | `sqlite` | SQLite |  | | `sybase` | Sybase |  | | `teradata` | Teradata |  | | `vertica` | Vertica |  | | `h2` | H2 |  | | `coldfusion` | ColdFusion IMQ |  | | `cassandra` | Apache Cassandra |  | | `hbase` | Apache HBase |  | | `mongodb` | MongoDB |  | | `redis` | Redis |  | | `couchbase` | Couchbase |  | | `couchdb` | CouchDB |  | | `cosmosdb` | Microsoft Azure Cosmos DB |  | | `dynamodb` | Amazon DynamoDB |  | | `neo4j` | Neo4j |  | | `geode` | Apache Geode |  | | `elasticsearch` | Elasticsearch |  | | `memcached` | Memcached |  | | `cockroachdb` | CockroachDB |  | | `opensearch` | OpenSearch |  | | `clickhouse` | ClickHouse |  | | `spanner` | Cloud Spanner |  | | `trino` | Trino |  | ## Cassandra Attributes | Attribute | Type | Description | Examples | Stability | |---|---|---|---|---| | `db.cassandra.consistency_level` | string | The consistency level of the query. Based on consistency values from [CQL](https://docs.datastax.com/en/cassandra-oss/3.0/cassandra/dml/dmlConfigConsistency.html). | `all` |  | | `db.cassandra.coordinator.dc` | string | The data center of the coordinating node for a query. | `us-west-2` |  | | `db.cassandra.coordinator.id` | string | The ID of the coordinating node for a query. | `be13faa2-8574-4d71-926d-27f16cf8a7af` |  | | `db.cassandra.idempotence` | boolean | Whether or not the query is idempotent. | |  | | `db.cassandra.page_size` | int | The fetch size used for paging, i.e. how many rows will be returned at once. | `5000` |  | | `db.cassandra.speculative_execution_count` | int | The number of times a query was speculatively executed. Not set or `0` if the query was not executed speculatively. | `0`; `2` |  | `db.cassandra.consistency_level` MUST be one of the following: | Value | Description | Stability | |---|---|---| | `all` | all |  | | `each_quorum` | each_quorum |  | | `quorum` | quorum |  | | `local_quorum` | local_quorum |  | | `one` | one |  | | `two` | two |  | | `three` | three |  | | `local_one` | local_one |  | | `any` | any |  | | `serial` | serial |  | | `local_serial` | local_serial |  | ## CosmosDB Attributes | Attribute | Type | Description | Examples | Stability | |---|---|---|---|---| | `db.cosmosdb.client_id` | string | Unique Cosmos client instance id. | `3ba4827d-4422-483f-b59f-85b74211c11d` |  | | `db.cosmosdb.connection_mode` | string | Cosmos client connection mode. | `gateway` |  | | `db.cosmosdb.operation_type` | string | CosmosDB Operation Type. | `Invalid` |  | | `db.cosmosdb.request_charge` | double | RU consumed for that operation | `46.18`; `1.0` |  | | `db.cosmosdb.request_content_length` | int | Request payload size in bytes | |  | | `db.cosmosdb.status_code` | int | Cosmos DB status code. | `200`; `201` |  | | `db.cosmosdb.sub_status_code` | int | Cosmos DB sub status code. | `1000`; `1002` |  | `db.cosmosdb.connection_mode` MUST be one of the following: | Value | Description | Stability | |---|---|---| | `gateway` | Gateway (HTTP) connections mode |  | | `direct` | Direct connection. |  | `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 | |---|---|---| | `Invalid` | invalid |  | | `Create` | create |  | | `Patch` | patch |  | | `Read` | read |  | | `ReadFeed` | read_feed |  | | `Delete` | delete |  | | `Replace` | replace |  | | `Execute` | execute |  | | `Query` | query |  | | `Head` | head |  | | `HeadFeed` | head_feed |  | | `Upsert` | upsert |  | | `Batch` | batch |  | | `QueryPlan` | query_plan |  | | `ExecuteJavaScript` | execute_javascript |  | ## Elasticsearch Attributes | Attribute | Type | Description | Examples | Stability | |---|---|---|---|---| | `db.elasticsearch.cluster.name` | string | Represents the identifier of an Elasticsearch cluster. | `e9106fc68e3044f0b1475b04bf4ffd5f` |  | | `db.elasticsearch.path_parts.` | string | A dynamic value in the url path. [1] | `db.elasticsearch.path_parts.index=test-index`; `db.elasticsearch.path_parts.doc_id=123` |  | **[1]:** Many Elasticsearch url paths allow dynamic values. These SHOULD be recorded in span attributes in the format `db.elasticsearch.path_parts.`, where `` is the url path part name. The implementation SHOULD reference the [elasticsearch schema](https://raw.githubusercontent.com/elastic/elasticsearch-specification/main/output/schema/schema.json) in order to map the path part values to their names. ## MSSQL Attributes | Attribute | Type | Description | Examples | Stability | |---|---|---|---|---| | `db.mssql.instance_name` | string | The Microsoft SQL Server [instance name](https://docs.microsoft.com/sql/connect/jdbc/building-the-connection-url?view=sql-server-ver15) connecting to. This name is used to determine the port of a named instance. [1] | `MSSQLSERVER` |  | **[1]:** If setting a `db.mssql.instance_name`, `server.port` is no longer required (but still recommended if non-standard). ## Redis Attributes | Attribute | Type | Description | Examples | Stability | |---|---|---|---|---| | `db.redis.database_index` | int | The index of the database being accessed as used in the [`SELECT` command](https://redis.io/commands/select), provided as an integer. To be used instead of the generic `db.name` attribute. | `0`; `1`; `15` |  | ## Deprecated DB Attributes | Attribute | Type | Description | Examples | Stability | |---|---|---|---|---| | `db.cassandra.table` | string | Deprecated, use `db.collection.name` instead. | `mytable` | 
Replaced by `db.collection.name`. | | `db.connection_string` | string | Deprecated, use `server.address`, `server.port` attributes instead. | `Server=(localdb)\v11.0;Integrated Security=true;` | 
"Replaced by `server.address` and `server.port`." | | `db.cosmosdb.container` | string | Deprecated, use `db.collection.name` instead. | `mytable` | 
Replaced by `db.collection.name`. | | `db.elasticsearch.node.name` | string | Deprecated, use `db.instance.id` instead. | `instance-0000000001` | 
Replaced by `db.instance.id`. | | `db.jdbc.driver_classname` | string | Removed, no replacement at this time. | `org.postgresql.Driver`; `com.microsoft.sqlserver.jdbc.SQLServerDriver` | 
Removed as not used. | | `db.mongodb.collection` | string | Deprecated, use `db.collection.name` instead. | `mytable` | 
Replaced by `db.collection.name`. | | `db.operation` | string | Deprecated, use `db.operation.name` instead. | `findAndModify`; `HMSET`; `SELECT` | 
Replaced by `db.operation.name`. | | `db.sql.table` | string | Deprecated, use `db.collection.name` instead. | `mytable` | 
Replaced by `db.collection.name`. | | `db.statement` | string | The database statement being executed. | `SELECT * FROM wuser_table`; `SET mykey "WuValue"` | 
Replaced by `db.query.text`. | | `db.user` | string | Deprecated, no replacement at this time. | `readonly_user`; `reporting_user` | 
No replacement at this time. | ## Deprecated DB Metrics Attributes | Attribute | Type | Description | Examples | Stability | |---|---|---|---|---| | `pool.name` | string | Deprecated, use `db.client.connections.pool.name` instead. | `myDataSource` | 
Replaced by `db.client.connections.pool.name`. | | `state` | string | Deprecated, use `db.client.connections.state` instead. | `idle` | 
Replaced by `db.client.connections.state`. | `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 |  | | `used` | used |  |