open-telemetry
/
semantic-conventions
mirror of https://github.com/open-telemetry/semantic-conventions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
semantic-conventions/docs/database/postgresql.md

13 KiB
Raw Blame History

Semantic Conventions for PostgreSQL

Status: Release Candidate

The Semantic Conventions for PostgreSQL extend and override the Database Semantic Conventions.

db.system MUST be set to "postgresql" and SHOULD be provided at span creation time.

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] users; dbo.products Conditionally Required [2] Experimental
db.namespace string The schema associated with the connection, qualified by the database name. [3] mydatabase.products; mydatabase.customers Conditionally Required If available without an additional network call. Experimental
db.operation.name string The name of the operation or command being executed. [4] SELECT; INSERT; UPDATE; DELETE; CREATE; mystoredproc Conditionally Required [5] Experimental
db.response.status_code string PostgreSQL error code. [6] 08000; 08P01 Conditionally Required If response has ended with warning or an error. Experimental
error.type string Describes a class of error the operation ended with. [7] timeout; java.net.UnknownHostException; server_certificate_invalid; 500 Conditionally Required If and only if the operation failed. Stable
server.port int Server port number. [8] 80; 8080; 443 Conditionally Required [9] Stable
db.operation.batch.size int The number of queries included in a batch operation. [10] 2; 3; 4 Recommended Experimental
db.query.summary string Low cardinality representation of a database query text. [11] SELECT wuser_table; INSERT shipping_details SELECT orders; get user by id Recommended [12] Experimental
db.query.text string The database query being executed. [13] SELECT * FROM wuser_table where username = ?; SET mykey ? Recommended [14] Experimental
db.response.returned_rows int Number of rows returned by the operation. 10; 30; 1000 Recommended Experimental
server.address string Name of the database host. [15] example.com; 10.1.2.80; /tmp/my.sock Recommended Stable
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. [16] someval; 55 Opt-In Experimental

[1]: It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization.

A single database query may involve multiple collections.

If the collection name is parsed from the query text, it SHOULD only be captured for queries that contain a single collection 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.

If the operation or query involves multiple collections, db.collection.name SHOULD NOT be captured.

This attribute has stability level RELEASE CANDIDATE.

[2]: If readily available and if a database call is performed on a single collection. The collection name MAY be parsed from the query text, in which case it SHOULD be the single collection name in the query.

[3]: db.namespace SHOULD be set to the combination of database and schema name following the {database}.{schema} pattern.

A connection's currently associated database may change during its lifetime, e.g. from executing SET search_path TO <schema>. If the search path has multiple schemas, the first schema in the search path SHOULD be used.

If instrumentation is unable to capture the connection's currently associated schema on each query without triggering an additional query to be executed (e.g. SELECT current_schema()), then it is RECOMMENDED to fallback and use the schema provided when the connection was established.

Instrumentation SHOULD document if db.namespace reflects the schema provided when the connection was established.

Instrumentation MAY use the user name when the connection was established as a stand-in for the schema name.

Instrumentation SHOULD document if db.namespace reflects the user 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.

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

[5]: If readily available and if there is a single operation name that describes the database call. The operation name MAY be parsed from the query text, in which case it SHOULD be the single operation name found in the query.

[6]: SQL defines SQLSTATE as a database return code which is adopted by some database systems like PostgreSQL. See PostgreSQL error codes 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 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):

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

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

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

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

[10]: Operations are only considered batches when they contain two or more operations, and so db.operation.batch.size SHOULD never be 1. This attribute has stability level RELEASE CANDIDATE.

[11]: 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 section. This attribute has stability level RELEASE CANDIDATE.

[12]: if readily available or if instrumentation supports query summarization.

[13]: 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. This attribute has stability level RELEASE CANDIDATE.

[14]: 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. Parameterized query text SHOULD be collected by default (the query parameter values themselves are opt-in, see db.query.parameter.<key>).

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

[16]: 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. This attribute has stability level RELEASE CANDIDATE.

The following attributes can be important for making sampling decisions and SHOULD be provided at span creation time (if provided at all):

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