Semantic conventions for Oracle Database

Status: Development

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

Spans

Status:

Spans representing calls to a Oracle SQL Database adhere to the general Semantic Conventions for Database Client Spans.

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

Span kind SHOULD be CLIENT.

Span status SHOULD follow the Recording Errors document.

Attribute	Type	Description	Examples	Requirement Level	Stability
db.namespace	string	The database associated with the connection, qualified by the instance name, database name and service name. [1]	ORCL1|PDB1|db_high.adb.oraclecloud.com; ORCL1|DB1|db_low.adb.oraclecloud.com; ORCL1|DB1|order-processing-service	Conditionally Required If available without an additional network call.
db.response.status_code	string	Oracle Database error number recorded as a string. [2]	ORA-02813; ORA-02613	Conditionally Required If response has ended with warning or an error.
error.type	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	int	Server port number. [4]	80; 8080; 443	Conditionally Required [5]
db.collection.name	string	The name of a collection (table, container) within the database. [6]	public.users; customers	Recommended [7]
db.operation.batch.size	int	The number of queries included in a batch operation. [8]	2; 3; 4	Recommended
db.operation.name	string	The name of the operation or command being executed. [9]	EXECUTE; INSERT	Recommended [10]
db.query.summary	string	Low cardinality summary of a database query. [11]	SELECT wuser_table; INSERT shipping_details SELECT orders; get user by id	Recommended [12]
db.query.text	string	The database query being executed. [13]	SELECT * FROM wuser_table where username = :mykey	Recommended [14]
db.stored_procedure.name	string	The name of a stored procedure within the database. [15]	GetCustomer	Recommended [16]
server.address	string	Name of the database host. [17]	example.com; 10.1.2.80; /tmp/my.sock	Recommended
db.query.parameter.<key>	string	A database query parameter, with <key> being the parameter name, and the attribute value being a string representation of the parameter value. [18]	someval; 55	Opt-In
db.response.returned_rows	int	Number of rows returned by the operation.	10; 30; 1000	Opt-In

[1] db.namespace: db.namespace SHOULD be set to the combination of instance name, database name and service name following the {service_name}|{database_name}|{instance_name} pattern. Any missing components (and their associated separators) SHOULD be omitted.

For CDB architecture, database name would be pdb name. For Non-CDB, it would be DB_NAME parameter.

[2] db.response.status_code: Oracle Database error codes are vendor specific error codes and don’t follow SQLSTATE conventions. All Oracle Database error codes SHOULD be considered errors.

[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.collection.name: The collection name SHOULD NOT be extracted from db.query.text.

[7] db.collection.name: If the operation is executed via a higher-level API that does not support multiple collection names.

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

[9] db.operation.name: The operation name SHOULD NOT be extracted from db.query.text.

[10] db.operation.name: If the operation is executed via a higher-level API that does not support multiple operation names.

[11] db.query.summary: The query summary 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.

[12] db.query.summary: if available through instrumentation hooks or if the instrumentation supports generating a query summary.

[13] db.query.text: 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.

[14] db.query.text: Non-parameterized query text SHOULD NOT be collected by default unless explicitly configured and sanitized to exclude sensitive data, e.g. by redacting all literal values present in the query text. See Sanitization of db.query.text. Parameterized query text MUST also NOT be collected by default unless explicitly configured. The query parameter values themselves are opt-in, see db.query.parameter.<key>).

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

[16] db.stored_procedure.name: If operation applies to a specific stored procedure.

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

[18] db.query.parameter.<key>: 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.

Examples:

• For a query SELECT * FROM users where username = %s with the parameter "jdoe", the attribute db.query.parameter.0 SHOULD be set to "jdoe".

• For a query "SELECT * FROM users WHERE username = %(username)s; with parameter username = "jdoe", the attribute db.query.parameter.username SHOULD be set to "jdoe".

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

• db.namespace
• db.query.summary
• db.query.text
• server.address
• server.port

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.

Metrics

Oracle Database driver instrumentation SHOULD collect metrics according to the general Semantic Conventions for Database Client Metrics.

db.system.name MUST be set to "oracle.db".