From 0a521716ce922d1e191d42952f6a7569105c77f6 Mon Sep 17 00:00:00 2001 From: Sudarshan Soma <48428602+sudarshan12s@users.noreply.github.com> Date: Wed, 9 Apr 2025 01:39:37 +0530 Subject: [PATCH] Add Semantic definitions for Oracle Database (#1911) Co-authored-by: Liudmila Molkova --- .chloggen/add_oracledb_semconv.yaml | 23 +++++ docs/database/README.md | 1 + docs/database/oracledb.md | 116 ++++++++++++++++++++++++ model/database/spans.yaml | 43 +++++++++ templates/registry/markdown/weaver.yaml | 1 + 5 files changed, 184 insertions(+) create mode 100644 .chloggen/add_oracledb_semconv.yaml create mode 100644 docs/database/oracledb.md diff --git a/.chloggen/add_oracledb_semconv.yaml b/.chloggen/add_oracledb_semconv.yaml new file mode 100644 index 000000000..94bbe995c --- /dev/null +++ b/.chloggen/add_oracledb_semconv.yaml @@ -0,0 +1,23 @@ +# Use this changelog template to create an entry for release notes. +# +# If your change doesn't affect end users you should instead start +# your pull request title with [chore] or use the "Skip Changelog" label. + +# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' +change_type: new_component + +# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db) +component: db + +# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). +note: Adding semantic conventions for `oracledb` instrumentations. + +# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. +# The values here must be integers. +issues: [2612] + +# (Optional) One or more lines of additional information to render under the primary note. +# These lines will be padded with 2 spaces and then inserted directly into the document. +# Use pipe (|) for multiline entries. +subtext: + Oracle Database semantic conventions. diff --git a/docs/database/README.md b/docs/database/README.md index c45cc751a..604d756ad 100644 --- a/docs/database/README.md +++ b/docs/database/README.md @@ -50,6 +50,7 @@ Technology specific semantic conventions are defined for the following databases * [HBase](hbase.md): Semantic Conventions for *HBase*. * [MongoDB](mongodb.md): Semantic Conventions for *MongoDB*. * [Microsoft SQL Server](mssql.md): Semantic Conventions for *Microsoft SQL Server*. +* [Oracle Database](oracledb.md): Semantic Conventions for *Oracle Database*. * [Redis](redis.md): Semantic Conventions for *Redis*. * [SQL](sql.md): Semantic Conventions for *SQL* databases. diff --git a/docs/database/oracledb.md b/docs/database/oracledb.md new file mode 100644 index 000000000..8dfdd4fdd --- /dev/null +++ b/docs/database/oracledb.md @@ -0,0 +1,116 @@ + + +# Semantic conventions for Oracle Database + +**Status**: [Development][DocumentStatus] + + + +- [Spans](#spans) +- [Metrics](#metrics) + + + +The Semantic Conventions for *Oracle Database* extend and override the [Database Semantic Conventions](README.md). + +## Spans + +Spans representing calls to Oracle Database adhere to the general [Semantic Conventions for Database Client Spans](database-spans.md). + +`db.system.name` MUST be set to `"oracle.db"` and SHOULD be provided **at span creation time**. + +The following table outlines the span attributes applicable to Oracle Database. + + + + + + + + +| 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, 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. | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | +| [`db.response.status_code`](/docs/attributes-registry/db.md) | string | [Oracle Database error number](https://docs.oracle.com/en/error-help/db/) recorded as a string. [2] | `ORA-02813`; `ORA-02613` | `Conditionally Required` If response has ended with warning or an error. | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | +| [`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. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| [`server.port`](/docs/attributes-registry/server.md) | int | Server port number. [4] | `80`; `8080`; `443` | `Conditionally Required` [5] | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| [`db.operation.batch.size`](/docs/attributes-registry/db.md) | int | The number of queries included in a batch operation. [6] | `2`; `3`; `4` | `Recommended` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | +| [`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] | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | +| [`db.query.text`](/docs/attributes-registry/db.md) | string | The database query being executed. [9] | `SELECT * FROM wuser_table where username = :mykey` | `Recommended` [10] | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | +| [`db.response.returned_rows`](/docs/attributes-registry/db.md) | int | Number of rows returned by the operation. | `10`; `30`; `1000` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) | +| [`db.stored_procedure.name`](/docs/attributes-registry/db.md) | string | The name of a stored procedure within the database. [11] | `GetCustomer` | `Recommended` [12] | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | +| [`server.address`](/docs/attributes-registry/server.md) | string | Name of the database host. [13] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | `Recommended` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| [`db.operation.parameter.`](/docs/attributes-registry/db.md) | string | A database operation parameter, with `` being the parameter name, and the attribute value being a string representation of the parameter value. [14] | `someval`; `55` | `Opt-In` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | + +**[1] `db.namespace`:** `db.namespace` SHOULD be set to the combination of instance name, database name and +service name following the `{instance_name}|{database_name}|{service_name}` pattern. +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](https://wikipedia.org/wiki/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.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](../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`](../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. + +**[10] `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`](../database/database-spans.md#sanitization-of-dbquerytext). Parameterized query text MUST also NOT be collected by default unless explicitly configured. The query parameter values themselves are opt-in, see [`db.operation.parameter.`](../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.operation.parameter`:** If a parameter has no name and instead is referenced only by index, then `` SHOULD be the 0-based index. +If `db.query.text` is also captured, then `db.operation.parameter.` SHOULD match up with the parameterized placeholders present in `db.query.text`. +`db.operation.parameter.` 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.namespace`](/docs/attributes-registry/db.md) +* [`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. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | + + + + + + +## Metrics + +Oracle Database driver instrumentation SHOULD collect metrics according to the general +[Semantic Conventions for Database Client Metrics](database-metrics.md). + +`db.system.name` MUST be set to `"oracle.db"`. + +[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status diff --git a/model/database/spans.yaml b/model/database/spans.yaml index ac87ea55e..176594fc8 100644 --- a/model/database/spans.yaml +++ b/model/database/spans.yaml @@ -852,3 +852,46 @@ groups: - ref: azure.cosmosdb.operation.contacted_regions requirement_level: conditionally_required: If available. + - id: span.db.oracledb.client + type: span + stability: development + extends: span.db.sql.client + span_kind: client + brief: > + Attributes for Oracle Database + attributes: + - ref: db.namespace + sampling_relevant: true + brief: > + The database associated with the connection, qualified by the instance name, + database name and service name. + note: | + `db.namespace` SHOULD be set to the combination of instance name, database name and + service name following the `{instance_name}|{database_name}|{service_name}` pattern. + For CDB architecture, database name would be pdb name. For Non-CDB, it would be + `DB_NAME` parameter. + examples: ["ORCL1\\|PDB1\\|db_high.adb.oraclecloud.com", "ORCL1\\|DB1\\|db_low.adb.oraclecloud.com", "ORCL1\\|DB1\\|order-processing-service"] + - ref: db.response.status_code + brief: > + [Oracle Database error number](https://docs.oracle.com/en/error-help/db/) recorded as a string. + note: > + Oracle Database error codes are vendor specific error codes and don't follow [SQLSTATE](https://wikipedia.org/wiki/SQLSTATE) + conventions. All Oracle Database error codes SHOULD be considered errors. + examples: ["ORA-02813", "ORA-02613"] + - ref: db.query.text + sampling_relevant: true + brief: > + The database query being executed. + requirement_level: + recommended: > + 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`](../database/database-spans.md#sanitization-of-dbquerytext). + Parameterized query text MUST also NOT be collected by default unless explicitly configured. + The query parameter values themselves are opt-in, + see [`db.operation.parameter.`](../attributes-registry/db.md)). + note: > + For sanitization see [Sanitization of `db.query.text`](../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. + examples: ["SELECT * FROM wuser_table where username = :mykey"] diff --git a/templates/registry/markdown/weaver.yaml b/templates/registry/markdown/weaver.yaml index c5440dcf0..40fb76c07 100644 --- a/templates/registry/markdown/weaver.yaml +++ b/templates/registry/markdown/weaver.yaml @@ -29,6 +29,7 @@ acronyms: - NodeJS - OCI - OpenTracing + - OracleDB - OS - OTel - RabbitMQ