semantic-conventions/docs/attributes-registry/db.md

Db

• General Database Attributes
• Cassandra Attributes
• Azure Cosmos DB Attributes
• Elasticsearch Attributes
• Deprecated Database Attributes
• Deprecated Database Metrics

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
db.client.connection.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.namespace	string	The name of the database, fully qualified within the server address and port. [2]	customers; test.users
db.operation.batch.size	int	The number of queries included in a batch operation. [3]	2; 3; 4
db.operation.name	string	The name of the operation or command being executed. [4]	findAndModify; HMSET; SELECT
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. [5]	someval; 55
db.query.text	string	The database query being executed. [6]	SELECT * FROM wuser_table where username = ?; SET mykey "WuValue"
db.system	string	The database management system (DBMS) product as identified by the client instrumentation. [7]	other_sql; adabas; cache

[1]: 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.

[2]: 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]: Operations are only considered batches when they contain two or more operations, and so db.operation.batch.size SHOULD never be 1.

[4]: 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.

[5]: 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 <key> SHOULD be the 0-based index.

[6]: 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.

[7]: 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.

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
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
adabas	Adabas (Adaptable Database System)
cache	Deprecated, use intersystems_cache instead.	Replaced by intersystems_cache.
cassandra	Apache Cassandra
clickhouse	ClickHouse
cloudscape	Deprecated, use other_sql instead.	Replaced by other_sql.
cockroachdb	CockroachDB
coldfusion	Deprecated, no replacement at this time.	Removed.
cosmosdb	Microsoft Azure Cosmos DB
couchbase	Couchbase
couchdb	CouchDB
db2	IBM Db2
derby	Apache Derby
dynamodb	Amazon DynamoDB
edb	EnterpriseDB
elasticsearch	Elasticsearch
filemaker	FileMaker
firebird	Firebird
firstsql	Deprecated, use other_sql instead.	Replaced by other_sql.
geode	Apache Geode
h2	H2
hanadb	SAP HANA
hbase	Apache HBase
hive	Apache Hive
hsqldb	HyperSQL DataBase
influxdb	InfluxDB
informix	Informix
ingres	Ingres
instantdb	InstantDB
interbase	InterBase
intersystems_cache	InterSystems Caché
mariadb	MariaDB
maxdb	SAP MaxDB
memcached	Memcached
mongodb	MongoDB
mssql	Microsoft SQL Server
mssqlcompact	Deprecated, Microsoft SQL Server Compact is discontinued.	Removed, use other_sql instead.
mysql	MySQL
neo4j	Neo4j
netezza	Netezza
opensearch	OpenSearch
oracle	Oracle Database
other_sql	Some other SQL database. Fallback only. See notes.
pervasive	Pervasive PSQL
pointbase	PointBase
postgresql	PostgreSQL
progress	Progress Database
redis	Redis
redshift	Amazon Redshift
spanner	Cloud Spanner
sqlite	SQLite
sybase	Sybase
teradata	Teradata
trino	Trino
vertica	Vertica

Cassandra Attributes

This group defines attributes for Cassandra.

Attribute	Type	Description	Examples	Stability
db.cassandra.consistency_level	string	The consistency level of the query. Based on consistency values from CQL.	all; each_quorum; quorum
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 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
any	any
each_quorum	each_quorum
local_one	local_one
local_quorum	local_quorum
local_serial	local_serial
one	one
quorum	quorum
serial	serial
three	three
two	two

Azure Cosmos DB Attributes

This group defines attributes for Azure Cosmos DB.

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; direct
db.cosmosdb.operation_type	string	CosmosDB Operation Type.	Invalid; Create; Patch
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 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.
gateway	Gateway (HTTP) connections mode

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
Create	create
Delete	delete
Execute	execute
ExecuteJavaScript	execute_javascript
Head	head
HeadFeed	head_feed
Invalid	invalid
Patch	patch
Query	query
QueryPlan	query_plan
Read	read
ReadFeed	read_feed
Replace	replace
Upsert	upsert

Elasticsearch Attributes

This group defines attributes for Elasticsearch.

Attribute	Type	Description	Examples	Stability
db.elasticsearch.node.name	string	Represents the human-readable identifier of the node/instance to which a request was routed.	instance-0000000001
db.elasticsearch.path_parts.<key>	string	A dynamic value in the url path. [8]	db.elasticsearch.path_parts.index=test-index; db.elasticsearch.path_parts.doc_id=123

[8]: Many Elasticsearch url paths allow dynamic values. These SHOULD be recorded in span attributes in the format db.elasticsearch.path_parts.<key>, where <key> is the url path part name. The implementation SHOULD reference the elasticsearch schema in order to map the path part values to their names.

Deprecated Database Attributes

"Describes 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.cluster.name	string	Deprecated, use db.namespace instead.	e9106fc68e3044f0b1475b04bf4ffd5f	Replaced by db.namespace.
db.instance.id	string	Deprecated, no general replacement at this time. For Elasticsearch, use db.elasticsearch.node.name instead.	mysql-e26b99z.example.com	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	Removed as not used.
db.mongodb.collection	string	Deprecated, use db.collection.name instead.	mytable	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, no replacement at this time.
db.name	string	Deprecated, use db.namespace instead.	customers; main	Replaced by db.namespace.
db.operation	string	Deprecated, use db.operation.name instead.	findAndModify; HMSET; SELECT	Replaced by db.operation.name.
db.redis.database_index	int	Deprecated, use db.namespace instead.	0; 1; 15	Replaced by db.namespace.
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 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	Replaced by db.client.connection.pool.name.
db.client.connections.state	string	Deprecated, use db.client.connection.state instead.	idle	Replaced by db.client.connection.state.
pool.name	string	Deprecated, use db.client.connection.pool.name instead.	myDataSource	Replaced by db.client.connection.pool.name.
state	string	Deprecated, use db.client.connection.state instead.	idle	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
used	used

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