191 lines
13 KiB
Markdown
191 lines
13 KiB
Markdown
<!--- Hugo front matter used to generate the website version of this page:
|
|
linkTitle: SQL
|
|
--->
|
|
|
|
# Semantic conventions for SQL databases client operations
|
|
|
|
**Status**: [Release Candidate][DocumentStatus]
|
|
|
|
## Spans
|
|
|
|
<!-- semconv span.db.sql.client -->
|
|
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
|
|
<!-- see templates/registry/markdown/snippet.md.j2 -->
|
|
<!-- prettier-ignore-start -->
|
|
<!-- markdownlint-capture -->
|
|
<!-- markdownlint-disable -->
|
|
|
|
**Status:** 
|
|
|
|
The SQL databases Semantic Conventions describes how common [Database Semantic Conventions](/docs/database/database-spans.md) apply to SQL databases.
|
|
|
|
The following database systems (defined in the
|
|
[`db.system.name`](/docs/database/database-spans.md#notes-and-well-known-identifiers-for-dbsystemname) set)
|
|
are known to use SQL as their primary query language:
|
|
|
|
- `actian.ingres`
|
|
- `cockroachdb`
|
|
- `derby`
|
|
- `firebirdsql`
|
|
- `h2database`
|
|
- `hsqldb`
|
|
- `ibm.db2`
|
|
- `mariadb`
|
|
- `microsoft.sql_server`
|
|
- `mysql`
|
|
- `oracle.db`
|
|
- `other_sql`
|
|
- `postgresql`
|
|
- `sap.maxdb`
|
|
- `sqlite`
|
|
- `trino`
|
|
|
|
Many other database systems support SQL and can be accessed via generic database driver such as JDBC or ODBC.
|
|
Instrumentations applied to generic SQL drivers SHOULD adhere to SQL semantic conventions.
|
|
|
|
**Span name** SHOULD follow the general [database span name convention](/docs/database/database-spans.md#name)
|
|
|
|
**Span kind** SHOULD be `CLIENT`.
|
|
|
|
**Span status** SHOULD follow the [Recording Errors](/docs/general/recording-errors.md) document.
|
|
|
|
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|
|
|---|---|---|---|---|---|
|
|
| [`db.namespace`](/docs/attributes-registry/db.md) | string | The database associated with the connection, fully qualified within the server address and port. [1] | `customers`; `test.users` | `Conditionally Required` If available without an additional network call. |  |
|
|
| [`db.response.status_code`](/docs/attributes-registry/db.md) | string | Database response code recorded as a string. [2] | `ORA-17027`; `1052`; `2201B` | `Conditionally Required` If response has ended with warning or an error. |  |
|
|
| [`error.type`](/docs/attributes-registry/error.md) | string | Describes a class of error the operation ended with. [3] | `timeout`; `java.net.UnknownHostException`; `server_certificate_invalid`; `500` | `Conditionally Required` If and only if the operation failed. |  |
|
|
| [`server.port`](/docs/attributes-registry/server.md) | int | Server port number. [4] | `80`; `8080`; `443` | `Conditionally Required` [5] |  |
|
|
| [`db.operation.batch.size`](/docs/attributes-registry/db.md) | int | The number of queries included in a batch operation. [6] | `2`; `3`; `4` | `Recommended` |  |
|
|
| [`db.query.summary`](/docs/attributes-registry/db.md) | string | Low cardinality representation of a database query text. [7] | `SELECT wuser_table`; `INSERT shipping_details SELECT orders`; `get user by id` | `Recommended` [8] |  |
|
|
| [`db.query.text`](/docs/attributes-registry/db.md) | string | The database query being executed. [9] | `SELECT * FROM wuser_table where username = ?`; `SET mykey ?` | `Recommended` [10] |  |
|
|
| [`db.response.returned_rows`](/docs/attributes-registry/db.md) | int | Number of rows returned by the operation. | `10`; `30`; `1000` | `Recommended` |  |
|
|
| [`db.stored_procedure.name`](/docs/attributes-registry/db.md) | string | The name of a stored procedure within the database. [11] | `GetCustomer` | `Recommended` [12] |  |
|
|
| [`server.address`](/docs/attributes-registry/server.md) | string | Name of the database host. [13] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | `Recommended` |  |
|
|
| [`db.query.parameter.<key>`](/docs/attributes-registry/db.md) | string | A database query parameter, with `<key>` being the parameter name, and the attribute value being a string representation of the parameter value. [14] | `someval`; `55` | `Opt-In` |  |
|
|
|
|
**[1] `db.namespace`:** If a database system has multiple namespace components (e.g. schema name and database name), 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.
|
|
|
|
Unless specified by the system-specific semantic convention, the `db.namespace` attribute matches
|
|
the name of the database being accessed.
|
|
|
|
A connection's currently associated database may change during its lifetime, e.g. from executing `USE <database>`.
|
|
|
|
If instrumentation is unable to capture the connection's currently associated database on each query
|
|
without triggering an additional query to be executed (e.g. `SELECT DATABASE()`),
|
|
then it is RECOMMENDED to fallback and use the database provided when the connection was established.
|
|
|
|
Instrumentation SHOULD document if `db.namespace` reflects the database provided when the connection was established.
|
|
|
|
It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization.
|
|
|
|
**[2] `db.response.status_code`:** SQL defines [SQLSTATE](https://wikipedia.org/wiki/SQLSTATE) as a database
|
|
return code which is adopted by some database systems like PostgreSQL.
|
|
See [PostgreSQL error codes](https://www.postgresql.org/docs/current/errcodes-appendix.html)
|
|
for the details.
|
|
|
|
Other systems like MySQL, Oracle, or MS SQL Server define vendor-specific
|
|
error codes. Database SQL drivers usually provide access to both properties.
|
|
For example, in Java, the [`SQLException`](https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html)
|
|
class reports them with `getSQLState()` and `getErrorCode()` methods.
|
|
|
|
Instrumentations SHOULD populate the `db.response.status_code` with the
|
|
the most specific code available to them.
|
|
|
|
Here's a non-exhaustive list of databases that report vendor-specific
|
|
codes with granularity higher than SQLSTATE (or don't report SQLSTATE
|
|
at all):
|
|
|
|
- [DB2 SQL codes](https://www.ibm.com/docs/db2-for-zos/12?topic=codes-sql).
|
|
- [Maria DB error codes](https://mariadb.com/kb/en/mariadb-error-code-reference/)
|
|
- [Microsoft SQL Server errors](https://docs.microsoft.com/sql/relational-databases/errors-events/database-engine-events-and-errors)
|
|
- [MySQL error codes](https://dev.mysql.com/doc/mysql-errors/9.0/en/error-reference-introduction.html)
|
|
- [Oracle error codes](https://docs.oracle.com/cd/B28359_01/server.111/b28278/toc.htm)
|
|
- [SQLite result codes](https://www.sqlite.org/rescode.html)
|
|
|
|
These systems SHOULD set the `db.response.status_code` to a
|
|
known vendor-specific error code. If only SQLSTATE is available,
|
|
it SHOULD be used.
|
|
|
|
When multiple error codes are available and specificity is unclear,
|
|
instrumentation SHOULD set the `db.response.status_code` to the
|
|
concatenated string of all codes with '/' used as a separator.
|
|
|
|
For example, generic DB instrumentation that detected an error and has
|
|
SQLSTATE `"42000"` and vendor-specific `1071` should set
|
|
`db.response.status_code` to `"42000/1071"`."
|
|
|
|
**[3] `error.type`:** The `error.type` SHOULD match the `db.response.status_code` returned by the database or the client library, or the canonical name of exception that occurred.
|
|
When using canonical exception type name, instrumentation SHOULD do the best effort to report the most relevant type. For example, if the original exception is wrapped into a generic one, the original exception SHOULD be preferred.
|
|
Instrumentations SHOULD document how `error.type` is populated.
|
|
|
|
**[4] `server.port`:** When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available.
|
|
|
|
**[5] `server.port`:** If using a port other than the default port for this DBMS and if `server.address` is set.
|
|
|
|
**[6] `db.operation.batch.size`:** Operations are only considered batches when they contain two or more operations, and so `db.operation.batch.size` SHOULD never be `1`.
|
|
|
|
**[7] `db.query.summary`:** `db.query.summary` provides static summary of the query text. It describes a class of database queries and is useful as a grouping key, especially when analyzing telemetry for database calls involving complex queries.
|
|
Summary may be available to the instrumentation through instrumentation hooks or other means. If it is not available, instrumentations that support query parsing SHOULD generate a summary following [Generating query summary](/docs/database/database-spans.md#generating-a-summary-of-the-query-text) section.
|
|
|
|
**[8] `db.query.summary`:** if readily available or if instrumentation supports query summarization.
|
|
|
|
**[9] `db.query.text`:** For sanitization see [Sanitization of `db.query.text`](/docs/database/database-spans.md#sanitization-of-dbquerytext).
|
|
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.
|
|
|
|
**[10] `db.query.text`:** Non-parameterized query text SHOULD NOT be collected by default unless there is sanitization that excludes sensitive data, e.g. by redacting all literal values present in the query text. See [Sanitization of `db.query.text`](/docs/database/database-spans.md#sanitization-of-dbquerytext).
|
|
Parameterized query text SHOULD be collected by default (the query parameter values themselves are opt-in, see [`db.query.parameter.<key>`](/docs/attributes-registry/db.md)).
|
|
|
|
**[11] `db.stored_procedure.name`:** It is RECOMMENDED to capture the value as provided by the application
|
|
without attempting to do any case normalization.
|
|
|
|
For batch operations, if the individual operations are known to have the same
|
|
stored procedure name then that stored procedure name SHOULD be used.
|
|
|
|
**[12] `db.stored_procedure.name`:** If operation represents a stored procedure execution.
|
|
|
|
**[13] `server.address`:** When observed from the client side, and when communicating through an intermediary, `server.address` SHOULD represent the server address behind any intermediaries, for example proxies, if it's available.
|
|
|
|
**[14] `db.query.parameter`:** If a query parameter has no name and instead is referenced only by index, then `<key>` SHOULD be the 0-based index.
|
|
`db.query.parameter.<key>` SHOULD match up with the parameterized placeholders present in `db.query.text`.
|
|
`db.query.parameter.<key>` SHOULD NOT be captured on batch operations.
|
|
|
|
The following attributes can be important for making sampling decisions
|
|
and SHOULD be provided **at span creation time** (if provided at all):
|
|
|
|
* [`db.query.summary`](/docs/attributes-registry/db.md)
|
|
* [`db.query.text`](/docs/attributes-registry/db.md)
|
|
* [`server.address`](/docs/attributes-registry/server.md)
|
|
* [`server.port`](/docs/attributes-registry/server.md)
|
|
|
|
---
|
|
|
|
`error.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 |
|
|
|---|---|---|
|
|
| `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. |  |
|
|
|
|
<!-- markdownlint-restore -->
|
|
<!-- prettier-ignore-end -->
|
|
<!-- END AUTOGENERATED TEXT -->
|
|
<!-- endsemconv -->
|
|
|
|
## Example
|
|
|
|
This is an example of attributes for a MySQL database span:
|
|
|
|
| Key | Value |
|
|
|:-----------------------| :----------------------------------------------------------- |
|
|
| Span name | `"SELECT orders"` |
|
|
| `db.namespace` | `"ShopDb"` |
|
|
| `db.system.name` | `"mysql"` |
|
|
| `server.address` | `"shopdb.example.com"` |
|
|
| `server.port` | `3306` |
|
|
| `db.query.text` | `"SELECT * FROM orders WHERE order_id = 'o4711'"` |
|
|
|
|
[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status
|