Add Semantic definitions for Oracle Database #1911
+247
−0
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 semnatic 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| <!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. --> | ||
| <!-- see templates/registry/markdown/attribute_namespace.md.j2 --> | ||
|
|
||
| # Oracledb | ||
|
|
||
| ## Oracle Database Attributes | ||
|
|
||
| This section defines attributes for Oracle Database. | ||
|
|
||
| | Attribute | Type | Description | Examples | Stability | | ||
| |---|---|---|---|---| | ||
| | <a id="oracledb-implicit-release" href="#oracledb-implicit-release">`oracledb.implicit_release`</a> | boolean | Boolean flag Indicating if the internal connection is released back to pool or not after executing a query. | `true` |  | | ||
| | <a id="oracledb-instance" href="#oracledb-instance">`oracledb.instance`</a> | string | The name of the Oracle Database instance. | `ORCL1` |  | | ||
| | <a id="oracledb-pdb-name" href="#oracledb-pdb-name">`oracledb.pdb_name`</a> | string | The name of the pluggable database (PDB) the connection is using. | `PDB1` |  | | ||
| | <a id="oracledb-pool-increment" href="#oracledb-pool-increment">`oracledb.pool.increment`</a> | int | The number of connections added when the pool needs to expand. | `5` |  | | ||
| | <a id="oracledb-pool-max" href="#oracledb-pool-max">`oracledb.pool.max`</a> | int | The maximum number of connections that can be open in the pool. | `30` |  | | ||
| | <a id="oracledb-pool-min" href="#oracledb-pool-min">`oracledb.pool.min`</a> | int | The minimum number of connections that the pool maintains. | `10` |  | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| <!--- Hugo front matter used to generate the website version of this page: | ||
| linkTitle: Oracle Database | ||
| ---> | ||
|
|
||
| # Semantic conventions for Oracle Database | ||
|
|
||
| **Status**: [Release Candidate][DocumentStatus] | ||
|
|
||
| <!-- toc --> | ||
|
|
||
| - [Spans](#spans) | ||
| - [Metrics](#metrics) | ||
|
|
||
| <!-- tocstop --> | ||
|
|
||
| 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. | ||
|
|
||
| <!-- semconv span.db.oracledb.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 --> | ||
|
|
||
| | 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 service name associated with the connection. [1] | `db_high.adb.oraclecloud.com`; `db_low.adb.oraclecloud.com` | `Conditionally Required` If available without an additional network call. |  | | ||
| | [`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. | `ORA-02813`; `ORA-024459` | `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. [2] | `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. [3] | `1521`; `1522`; | `Conditionally Required` [4] |  | | ||
| | [`db.operation.batch.size`](/docs/attributes-registry/db.md) | int | The number of queries included in a batch operation. [5] | `2`; `3`; `4` | `Recommended` |  | | ||
| | [`db.query.summary`](/docs/attributes-registry/db.md) | string | Low cardinality representation of a database query text. [6] | `SELECT wuser_table`; `INSERT shipping_details SELECT orders`; `get user by id` | `Recommended` [7] |  | | ||
| | [`db.query.text`](/docs/attributes-registry/db.md) | string | The database query being executed. [8] | `VARIABLE mykey VARCHAR2(50) = 'some_val'`; `SELECT * FROM wuser_table where username = :mykey`; | `Recommended` [9] |  | | ||
| | [`db.response.returned_rows`](/docs/attributes-registry/db.md) | int | Number of rows returned by the operation. | `10`; `30`; `1000` | `Recommended` |  | | ||
| | [`server.address`](/docs/attributes-registry/server.md) | string | Name of the database host. [10] | `example.com`; `10.1.2.80`; | `Recommended` |  | | ||
| | [`db.operation.parameter.<key>`](/docs/attributes-registry/db.md) | string | A database operation parameter, with `<key>` being the parameter name, and the attribute value being a string representation of the parameter value. [11] | `someval`; `55` | `Opt-In` |  | | ||
| | [`oracledb.pool.min`](/docs/attributes-registry/oracledb.md) | int | This read-only property is a number which specifies the minimum number of connections a connection pool maintains, even when there is no activity to the target database. | `0`; `3`; `4` | `Recommended` |  | | ||
| | [`oracledb.pool.max`](/docs/attributes-registry/oracledb.md) | int | This read-only property is a number which specifies the maximum number of connections that can be open in the connection pool. | `2`; `30`; `70` | `Recommended` |  | | ||
| | [`oracledb.pool.incr`](/docs/attributes-registry/oracledb.md) | int | This read-only property is a number which specifies the number of connections that are opened whenever a connection request exceeds the number of currently open connections. | `2`; `10`; `15` | `Recommended` |  | | ||
| | [`oracledb.bind.values`](/docs/attributes-registry/oracledb.md) | string[] | Array of bind values passed to parameterized queries. | `['43', 'scott', 'true'` | `Recommended` |  | | ||
| | [`oracledb.instance`](/docs/attributes-registry/oracledb.md) | string | Oracle Database Instance. | `ORCL1`; `ORCL2`; | `Recommended` |  | | ||
| | [`oracledb.pdbname`](/docs/attributes-registry/oracledb.md) | string | Pluggable Database (PDB) name in a Multitenant Container Database (CDB) environment. | `PDB1`; `PDB2`; | `Recommended` |  | | ||
| | [`oracledb.implicit_release`](/docs/attributes-registry/oracledb.md) | boolean | Indicates if the internal connection is released back to pool or not after executing a query. | `true` | `Recommended` |  | | ||
|
|
||
| **[1] `db.namespace`:** `db.namespace` SHOULD be set to the service name used to connect to the database. | ||
|
|
||
| Instrumentation SHOULD document if `db.namespace` reflects the service name 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] `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. | ||
|
|
||
| **[3] `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. | ||
|
|
||
| **[4] `server.port`:** If using a port other than the default port for this DBMS and if `server.address` is set. | ||
|
|
||
| **[5] `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`. | ||
|
|
||
| **[6] `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. | ||
| A 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. | ||
|
|
||
| **[7] `db.query.summary`:** if readily available or if instrumentation supports query summarization. | ||
|
|
||
| **[8] `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. | ||
| 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. | ||
|
|
||
| **[9] `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.<key>`](../attributes-registry/db.md). | ||
|
|
||
| **[10] `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. | ||
|
|
||
| **[11] `db.operation.parameter`:** If a parameter has no name and instead is referenced only by index, then `<key>` SHOULD be the 0-based index. | ||
| If `db.query.text` is also captured, then `db.operation.parameter.<key>` SHOULD match up with the parameterized placeholders present in `db.query.text`. | ||
|
|
||
| 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. |  | | ||
|
|
||
| <!-- markdownlint-restore --> | ||
| <!-- prettier-ignore-end --> | ||
| <!-- END AUTOGENERATED TEXT --> | ||
| <!-- endsemconv --> | ||
|
|
||
| ## 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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| groups: | ||
| - id: registry.oracledb | ||
| type: attribute_group | ||
| display_name: Oracle Database Attributes | ||
| brief: > | ||
| This section defines attributes for Oracle Database. | ||
| attributes: | ||
| - id: oracledb.implicit_release | ||
|
There was a problem hiding this comment. we avoid adding attributes without referencing them on the spans, metrics, events, resources, etc. Otherwise, let's postpone adding this and other attributes until we're ready to define signals they should be set on. There was a problem hiding this comment. Yes this attribute node-oracledb @6.7.0 onwards has code to add this information passed to OT module to add it in span. I added the attribute in There was a problem hiding this comment. system-specific attribute namespace needs to match the There was a problem hiding this comment. Yes modified similarly changed other attributes. |
||
| type: boolean | ||
| stability: development | ||
| brief: > | ||
| Boolean flag Indicating if the internal connection is released back to pool or not after executing a query. | ||
| examples: [true] | ||
| - id: oracledb.instance | ||
| type: string | ||
| stability: development | ||
| brief: The name of the Oracle Database instance. | ||
| examples: "ORCL1" | ||
| - id: oracledb.pdb_name | ||
| type: string | ||
| stability: development | ||
| brief: > | ||
| The name of the pluggable database (PDB) the connection is using. | ||
| examples: "PDB1" | ||
| - id: oracledb.pool.increment | ||
| type: int | ||
| stability: development | ||
| brief: > | ||
| The number of connections added when the pool needs to expand. | ||
| examples: 5 | ||
| - id: oracledb.pool.max | ||
|
There was a problem hiding this comment. please check out DB connection pool metrics - https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/database-metrics.md#connection-pools and check if anything oracle-specific is necessary. There was a problem hiding this comment. Thanks for the link. I removed I was adding these parameters in span when application creates a pool with the pool configuration (max, min ,..). I think the standard talks about this attribute to be included in metrics as |
||
| type: int | ||
| stability: development | ||
| brief: > | ||
| The maximum number of connections that can be open in the pool. | ||
| examples: 30 | ||
| - id: oracledb.pool.min | ||
| type: int | ||
| stability: development | ||
| brief: > | ||
| The minimum number of connections that the pool maintains. | ||
| examples: 10 | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
please add acronym
OracleDBtosemantic-conventions/templates/registry/markdown/weaver.yaml
Line 8 in d3bff0d
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
changed
OracledbtoOracleDBindocs/attributes-registry/README.md.Also added
Oracledbin semantic-conventions/templates/registry/markdown/weaver.yaml