2.6 KiB
Semantic Conventions for MSSQL
Status: Experimental
The Semantic Conventions for the Microsoft SQL Server extend and override the Database Semantic Conventions that describe common database operations attributes in addition to the Semantic Conventions described on this page.
db.system MUST be set to "mssql".
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] |
|
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. [5] | MSSQLSERVER |
Recommended |
|
[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.
[5]: If setting a db.mssql.instance_name, server.port is no longer required (but still recommended if non-standard).