Skip to content

Commit 568df1a

Browse files
sudarshan12ssudarshan12s
authored
semantic definitions for OracleDB (#1)
* - Add semantic conventions for oracle database
1 parent 3392004 commit 568df1a

File tree

5 files changed

+171
-0
lines changed

5 files changed

+171
-0
lines changed

‎.chloggen/add_oracledb_semconv.yaml

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Use this changelog template to create an entry for release notes.
2+
#
3+
# If your change doesn't affect end users you should instead start
4+
# your pull request title with [chore] or use the "Skip Changelog" label.
5+
6+
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
7+
change_type: new_component
8+
9+
# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db)
10+
component: db
11+
12+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
13+
note: Adding semnatic conventions for `oracledb` instrumentations.
14+
15+
# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
16+
# The values here must be integers.
17+
issues: [2612]
18+
19+
# (Optional) One or more lines of additional information to render under the primary note.
20+
# These lines will be padded with 2 spaces and then inserted directly into the document.
21+
# Use pipe (|) for multiline entries.
22+
subtext:
23+
Oracle Database semantic conventions.

‎docs/database/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ Technology specific semantic conventions are defined for the following databases
5050
* [HBase](hbase.md): Semantic Conventions for *HBase*.
5151
* [MongoDB](mongodb.md): Semantic Conventions for *MongoDB*.
5252
* [Microsoft SQL Server](mssql.md): Semantic Conventions for *Microsoft SQL Server*.
53+
* [Oracle Database](oracledb.md): Semantic Conventions for *Oracle Database*.
5354
* [Redis](redis.md): Semantic Conventions for *Redis*.
5455
* [SQL](sql.md): Semantic Conventions for *SQL* databases.
5556

‎docs/database/oracledb.md

+108
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
<!--- Hugo front matter used to generate the website version of this page:
2+
linkTitle: Oracle Database
3+
--->
4+
5+
# Semantic conventions for Oracle Database
6+
7+
**Status**: [Release Candidate][DocumentStatus]
8+
9+
<!-- toc -->
10+
11+
- [Spans](#spans)
12+
- [Metrics](#metrics)
13+
14+
<!-- tocstop -->
15+
16+
The Semantic Conventions for *Oracle Database* extend and override the [Database Semantic Conventions](README.md).
17+
18+
## Spans
19+
20+
Spans representing calls to Oracle Database adhere to the general [Semantic Conventions for Database Client Spans](database-spans.md).
21+
22+
`db.system.name` MUST be set to `"oracle.db"` and SHOULD be provided **at span creation time**.
23+
24+
The following table outlines the span attributes applicable to Oracle Database.
25+
26+
<!-- semconv span.db.oracledb.client -->
27+
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
28+
<!-- see templates/registry/markdown/snippet.md.j2 -->
29+
<!-- prettier-ignore-start -->
30+
<!-- markdownlint-capture -->
31+
<!-- markdownlint-disable -->
32+
33+
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
34+
|---|---|---|---|---|---|
35+
| [`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. | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) |
36+
| [`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. | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) |
37+
| [`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. | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) |
38+
| [`server.port`](/docs/attributes-registry/server.md) | int | Server port number. [3] | `1521`; `1522`; | `Conditionally Required` [4] | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
39+
| [`db.operation.batch.size`](/docs/attributes-registry/db.md) | int | The number of queries included in a batch operation. [5] | `2`; `3`; `4` | `Recommended` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) |
40+
| [`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] | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) |
41+
| [`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] | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) |
42+
| [`db.response.returned_rows`](/docs/attributes-registry/db.md) | int | Number of rows returned by the operation. | `10`; `30`; `1000` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
43+
| [`server.address`](/docs/attributes-registry/server.md) | string | Name of the database host. [10] | `example.com`; `10.1.2.80`; | `Recommended` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
44+
| [`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` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) |
45+
46+
**[1] `db.namespace`:** `db.namespace` SHOULD be set to the service name used to connect to the database.
47+
48+
Instrumentation SHOULD document if `db.namespace` reflects the service name provided when the connection was established.
49+
50+
It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization.
51+
52+
**[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.
53+
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.
54+
Instrumentations SHOULD document how `error.type` is populated.
55+
56+
**[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.
57+
58+
**[4] `server.port`:** If using a port other than the default port for this DBMS and if `server.address` is set.
59+
60+
**[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`.
61+
62+
**[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.
63+
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.
64+
65+
**[7] `db.query.summary`:** if readily available or if instrumentation supports query summarization.
66+
67+
**[8] `db.query.text`:** For sanitization see [Sanitization of `db.query.text`](../database/database-spans.md#sanitization-of-dbquerytext).
68+
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.
69+
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.
70+
71+
**[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).
72+
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).
73+
74+
**[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.
75+
76+
**[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.
77+
If `db.query.text` is also captured, then `db.operation.parameter.<key>` SHOULD match up with the parameterized placeholders present in `db.query.text`.
78+
79+
The following attributes can be important for making sampling decisions
80+
and SHOULD be provided **at span creation time** (if provided at all):
81+
82+
* [`db.namespace`](/docs/attributes-registry/db.md)
83+
* [`db.query.summary`](/docs/attributes-registry/db.md)
84+
* [`db.query.text`](/docs/attributes-registry/db.md)
85+
* [`server.address`](/docs/attributes-registry/server.md)
86+
* [`server.port`](/docs/attributes-registry/server.md)
87+
88+
---
89+
90+
`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.
91+
92+
| Value | Description | Stability |
93+
|---|---|---|
94+
| `_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) |
95+
96+
<!-- markdownlint-restore -->
97+
<!-- prettier-ignore-end -->
98+
<!-- END AUTOGENERATED TEXT -->
99+
<!-- endsemconv -->
100+
101+
## Metrics
102+
103+
Oracle Database driver instrumentation SHOULD collect metrics according to the general
104+
[Semantic Conventions for Database Client Metrics](database-metrics.md).
105+
106+
`db.system.name` MUST be set to `"oracle.db"`.
107+
108+
[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status

‎model/database/spans.yaml

+23
Original file line numberDiff line numberDiff line change
@@ -810,3 +810,26 @@ groups:
810810
- ref: azure.cosmosdb.operation.contacted_regions
811811
requirement_level:
812812
conditionally_required: If available.
813+
- id: span.db.oracledb.client
814+
type: span
815+
stability: experimental
816+
extends: span.db.sql.client
817+
span_kind: client
818+
brief: >
819+
Attributes for Oracle Database
820+
attributes:
821+
- ref: db.namespace
822+
sampling_relevant: true
823+
brief: The service name associated with the connection.
824+
note: |
825+
Instrumentation SHOULD document if `db.namespace` reflects the service name provided when the connection was established.
826+
827+
It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization.
828+
examples: ["db_high.adb.oraclecloud.com", "db_low.adb.oraclecloud.com"]
829+
- ref: db.response.status_code
830+
brief: >
831+
[Oracle Database error number](https://docs.oracle.com/en/error-help/db/) recorded as a string.
832+
note: >
833+
Oracle Database error codes are vendor specific error codes and don't follow [SQLSTATE](https://wikipedia.org/wiki/SQLSTATE)
834+
conventions. All Oracle Database error codes SHOULD be considered errors.
835+
examples: ["ORA-02813", "ORA-02613"]

‎schema-next.yaml

+16
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,22 @@ versions:
77
- rename_metrics:
88
k8s.replication_controller.desired_pods: k8s.replicationcontroller.desired_pods
99
k8s.replication_controller.available_pods: k8s.replicationcontroller.available_pods
10+
all:
11+
changes:
12+
# https://github.com/open-telemetry/semantic-conventions/pull/TODO
13+
# add semantic conventions for Oracle Database
14+
- add_attributes:
15+
db.system.name
16+
db.namespace
17+
db.response.status_code
18+
error.type
19+
server.port
20+
db.operation.batch.size
21+
db.query.summary
22+
db.query.text
23+
db.response.returned_rows
24+
server.address
25+
db.operation.parameter.<key>
1026
1.30.0:
1127
all:
1228
changes:

0 commit comments

Comments
 (0)