跳转至

数据库客户机调用的语义约定

NOTICE Semantic Conventions are moving to a new location.

No changes to this document are allowed.

Status: Experimental

Warning Existing Database instrumentations that are using v1.20.0 of this document (or prior):

  • SHOULD NOT change the version of the networking attributes that they emit until the HTTP semantic conventions are marked stable (HTTP stabilization will include stabilization of a core set of networking attributes which are also used in Database instrumentations).
  • SHOULD introduce an environment variable OTEL_SEMCONV_STABILITY_OPT_IN in the existing major version which supports the following values:
  • none - continue emitting whatever version of the old experimental database attributes the instrumentation was emitting previously. This is the default value.
  • http - emit the new, stable networking attributes, and stop emitting the old experimental networking attributes that the instrumentation emitted previously.
  • http/dup - emit both the old and the stable networking attributes, allowing for a seamless transition.
  • SHOULD maintain (security patching at a minimum) the existing major version for at least six months after it starts emitting both sets of attributes.
  • SHOULD drop the environment variable in the next major version (stable next major version SHOULD NOT be released prior to October 1, 2023).

Span kind: MUST always be CLIENT.

The span name SHOULD be set to a low cardinality value representing the statement executed on the database. It MAY be a stored procedure name (without arguments), DB statement without variable arguments, operation name, etc. Since SQL statements may have very high cardinality even without arguments, SQL spans SHOULD be named the following way, unless the statement is known to be of low cardinality: <db.operation> <db.name>.<db.sql.table>, provided that db.operation and db.sql.table are available. If db.sql.table is not available due to its semantics, the span SHOULD be named <db.operation> <db.name>. It is not recommended to attempt any client-side parsing of db.statement just to get these properties, they should only be used if the library being instrumented already provides them. When it's otherwise impossible to get any meaningful span name, db.name or the tech-specific database name MAY be used.

Connection-level attributes

These attributes will usually be the same for all operations performed over the same database connection. Some database systems may allow a connection to switch to a different db.user, for example, and other database systems may not even have the concept of a connection at all.

Attribute Type Description Examples Requirement Level
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 Required
db.connection_string string The connection string used to connect to the database. It is recommended to remove embedded credentials. Server=(localdb)\v11.0;Integrated Security=true; Recommended
db.user string Username for accessing the database. readonly_user; reporting_user Recommended
network.transport string OSI Transport Layer or Inter-process Communication method. The value SHOULD be normalized to lowercase. tcp; udp Recommended
network.type string OSI Network Layer or non-OSI equivalent. The value SHOULD be normalized to lowercase. ipv4; ipv6 Recommended
server.address string Name of the database host. example.com Conditionally Required: See alternative attributes below.
server.port int Logical server port number 80; 8080; 443 Conditionally Required: [1]
server.socket.address string Physical server IP address or Unix socket address. 10.5.3.2 See below
server.socket.port int Physical server port. 16456 Recommended: If different than server.port.

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

Additional attribute requirements: At least one of the following sets of attributes is required:

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

Notes and well-known identifiers for db.system

The list above is a non-exhaustive list of well-known identifiers to be specified for db.system.

If a value defined in this list applies to the DBMS to which the request is sent, this value MUST be used. If no value defined in this list is suitable, a custom value MUST be provided. This custom value MUST be the name of the DBMS in lowercase and without a version number to stay consistent with existing identifiers.

It is encouraged to open a PR towards this specification to add missing values to the list, especially when instrumentations for those missing databases are written. This allows multiple instrumentations for the same database to be aligned and eases analyzing for backends.

The value other_sql is intended as a fallback and MUST only be used if the DBMS is known to be SQL-compliant but the concrete product is not known to the instrumentation. If the concrete DBMS is known to the instrumentation, its specific identifier MUST be used.

Back ends could, for example, use the provided identifier to determine the appropriate SQL dialect for parsing the db.statement.

When additional attributes are added that only apply to a specific DBMS, its identifier SHOULD be used as a namespace in the attribute key as for the attributes in the sections below.

Connection-level attributes for specific technologies

Attribute Type Description Examples Requirement Level
db.jdbc.driver_classname string The fully-qualified class name of the Java Database Connectivity (JDBC) driver used to connect. org.postgresql.Driver; com.microsoft.sqlserver.jdbc.SQLServerDriver Recommended
db.mssql.instance_name string The Microsoft SQL Server instance name connecting to. This name is used to determine the port of a named instance. [1] MSSQLSERVER Recommended

[1]: If setting a db.mssql.instance_name, server.port is no longer required (but still recommended if non-standard).

Call-level attributes

These attributes may be different for each operation performed, even if the same connection is used for multiple operations. Usually only one db.name will be used per connection though.

Attribute Type Description Examples Requirement Level
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). [1] customers; main Conditionally Required: If applicable.
db.statement string The database statement being executed. SELECT * FROM wuser_table; SET mykey "WuValue" Recommended: [2]
db.operation string The name of the operation being executed, e.g. the MongoDB command name such as findAndModify, or the SQL keyword. [3] findAndModify; HMSET; SELECT Conditionally Required: If db.statement is not applicable.

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

[2]: Should be collected by default only if there is sanitization that excludes sensitive information.

[3]: When setting this to an SQL keyword, it is not recommended to attempt any client-side parsing of db.statement just to get this property, but it should be set if the operation name is provided by the library being instrumented. If the SQL statement has an ambiguous operation, or performs more than one operation, this value may be omitted.

For Redis, the value provided for db.statement SHOULD correspond to the syntax of the Redis CLI. If, for example, the [HMSET command][] is invoked, "HMSET myhash field1 'Hello' field2 'World'" would be a suitable value for db.statement.

In CouchDB, db.operation should be set to the HTTP method + the target REST route according to the API reference documentation. For example, when retrieving a document, db.operation would be set to (literally, i.e., without replacing the placeholders with concrete values): GET /{db}/{docid}.

In Cassandra, db.name SHOULD be set to the keyspace name.

In HBase, db.name SHOULD be set to the HBase namespace.

Call-level attributes for specific technologies

Attribute Type Description Examples Requirement Level
db.redis.database_index int The index of the database being accessed as used in the SELECT command, provided as an integer. To be used instead of the generic db.name attribute. 0; 1; 15 Conditionally Required: If other than the default database (0).
db.mongodb.collection string The collection being accessed within the database stated in db.name. customers; products Required
db.sql.table string The name of the primary table that the operation is acting upon, including the database name (if applicable). [1] public.users; customers Recommended

[1]: It is not recommended to attempt any client-side parsing of db.statement just to get this property, but it should be set if it is provided by the library being instrumented. If the operation is acting upon an anonymous table, or more than one table, this value MUST NOT be set.

Cassandra

Separated for clarity.

Attribute Type Description Examples Requirement Level
db.cassandra.page_size int The fetch size used for paging, i.e. how many rows will be returned at once. 5000 Recommended
db.cassandra.consistency_level string The consistency level of the query. Based on consistency values from CQL. all Recommended
db.cassandra.table string The name of the primary table that the operation is acting upon, including the keyspace name (if applicable). [1] mytable Recommended
db.cassandra.idempotence boolean Whether or not the query is idempotent. Recommended
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 Recommended
db.cassandra.coordinator.id string The ID of the coordinating node for a query. be13faa2-8574-4d71-926d-27f16cf8a7af Recommended
db.cassandra.coordinator.dc string The data center of the coordinating node for a query. us-west-2 Recommended

[1]: This mirrors the db.sql.table attribute but references cassandra rather than sql. It is not recommended to attempt any client-side parsing of db.statement just to get this property, but it should be set if it is provided by the library being instrumented. If the operation is acting upon an anonymous table, or more than one table, this value MUST NOT be set.

Microsoft Azure Cosmos DB Attributes

Cosmos DB instrumentation includes call-level (public API) surface spans and network spans. Depending on the connection mode (Gateway or Direct), network-level spans may also be created.

Attribute Type Description Examples Requirement Level
db.cosmosdb.client_id string Unique Cosmos client instance id. 3ba4827d-4422-483f-b59f-85b74211c11d Recommended
db.cosmosdb.operation_type string CosmosDB Operation Type. Invalid Conditionally Required: [1]
db.cosmosdb.connection_mode string Cosmos client connection mode. gateway Conditionally Required: if not direct (or pick gw as default)
db.cosmosdb.container string Cosmos DB container name. anystring Conditionally Required: if available
db.cosmosdb.request_content_length int Request payload size in bytes Recommended
db.cosmosdb.status_code int Cosmos DB status code. 200; 201 Conditionally Required: if response was received
db.cosmosdb.sub_status_code int Cosmos DB sub status code. 1000; 1002 Conditionally Required: [2]
db.cosmosdb.request_charge double RU consumed for that operation 46.18; 1.0 Conditionally Required: when available
user_agent.original string Full user-agent string is generated by Cosmos DB SDK [3] cosmos-netstandard-sdk/3.23.0\|3.23.1\|1\|X64\|Linux 5.4.0-1098-azure 104 18\|.NET Core 3.1.32\|S\| Recommended

[1]: when performing one of the operations in this list

[2]: when response was received and contained sub-code.

[3]: The user-agent value is generated by SDK which is a combination of
sdk_version : Current version of SDK. e.g. 'cosmos-netstandard-sdk/3.23.0'
direct_pkg_version : Direct package version used by Cosmos DB SDK. e.g. '3.23.1'
number_of_client_instances : Number of cosmos client instances created by the application. e.g. '1'
type_of_machine_architecture : Machine architecture. e.g. 'X64'
operating_system : Operating System. e.g. 'Linux 5.4.0-1098-azure 104 18'
runtime_framework : Runtime Framework. e.g. '.NET Core 3.1.32'
failover_information : Generated key to determine if region failover enabled. Format Reg-{D (Disabled discovery)}-S(application region)|L(List of preferred regions)|N(None, user did not configure it). Default value is "NS".

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

db.cosmosdb.connection_mode MUST be one of the following:

Value Description
gateway Gateway (HTTP) connections mode
direct Direct connection.

In addition to Cosmos DB attributes, all spans include az.namespace attribute representing Azure Resource Provider namespace that MUST be equal to Microsoft.DocumentDB.

Examples

MySQL

Key Value
Span name "SELECT ShopDb.orders"
db.system "mysql"
db.connection_string "Server=shopdb.example.com;Database=ShopDb;Uid=billing_user;TableCache=true;UseCompression=True;MinimumPoolSize=10;MaximumPoolSize=50;"
db.user "billing_user"
server.address "shopdb.example.com"
server.socket.address "192.0.2.12"
server.port 3306
network.transport "IP.TCP"
db.name "ShopDb"
db.statement "SELECT * FROM orders WHERE order_id = 'o4711'"
db.operation "SELECT"
db.sql.table "orders"

Redis

In this example, Redis is connected using a unix domain socket and therefore the connection string and server.address are left out. Furthermore, db.name is not specified as there is no database name in Redis and db.redis.database_index is set instead.

Key Value
Span name "HMSET myhash"
db.system "redis"
db.connection_string not set
db.user not set
server.socket.address "/tmp/redis.sock"
network.transport "Unix"
db.name not set
db.statement "HMSET myhash field1 'Hello' field2 'World"
db.operation not set
db.redis.database_index 15

MongoDB

Key Value
Span name "products.findAndModify"
db.system "mongodb"
db.connection_string not set
db.user "the_user"
server.address "mongodb0.example.com"
server.socket.address "192.0.2.14"
server.port 27017
network.transport "IP.TCP"
db.name "shopDb"
db.statement not set
db.operation "findAndModify"
db.mongodb.collection "products"

Microsoft Azure Cosmos DB

Key Value
Span name "ReadItemsAsync"
kind "internal"
az.namespace "Microsoft.DocumentDB"
db.system "cosmosdb"
db.name "database name"
db.operation "ReadItemsAsync"
server.address "account.documents.azure.com"
db.cosmosdb.client_id 3ba4827d-4422-483f-b59f-85b74211c11d
db.cosmosdb.operation_type Read
user_agent.original cosmos-netstandard-sdk/3.23.0\|3.23.1\|1\|X64\|Linux 5.4.0-1098-azure 104 18\|.NET Core 3.1.32\|S\|
db.cosmosdb.connection_mode "Direct"
db.cosmosdb.container "container name"
db.cosmosdb.request_content_length 20
db.cosmosdb.status_code 201
db.cosmosdb.sub_status_code 0
db.cosmosdb.request_charge 7.43