semantic-conventions/docs/database/sql.md

Semantic Conventions for SQL Databases

Status: Experimental

The SQL databases Semantic Conventions extend and override the Database Semantic Conventions that describe common database operations attributes in addition to the Semantic Conventions described on this page.

Attributes

Attribute	Type	Description	Examples	Requirement Level	Stability
db.collection.name	string	The name of the SQL table that the operation is acting upon. [1]	public.users; customers	Conditionally Required [2]
db.operation.name	string	The name of the operation or command being executed. [3]	SELECT; INSERT; UPDATE; DELETE; CREATE; mystoredproc	Conditionally Required [4]

[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]: If readily available. Otherwise, if the instrumentation library parses db.query.text to capture db.collection.name, then it SHOULD be the first collection name found in the query.

[3]: This SHOULD be the SQL command such as SELECT, INSERT, UPDATE, CREATE, DROP. In the case of EXEC, this SHOULD be the stored procedure name that is being executed.

[4]: If readily available. Otherwise, if the instrumentation library parses db.query.text to capture db.operation.name, then it SHOULD be the first operation name found in the query.

Example

This is an example of attributes for a MySQL database span:

Key	Value
Span name	"SELECT ShopDb.orders"
db.system	"mysql"
server.address	"shopdb.example.com"
server.port	3306
network.peer.address	"192.0.2.12"
network.peer.port	3306
network.transport	"tcp"
db.name	"ShopDb"
db.statement	"SELECT * FROM orders WHERE order_id = 'o4711'"
db.operation	"SELECT"
db.collection.name	"orders"