diff --git a/.chloggen/3753.yaml b/.chloggen/3753.yaml new file mode 100644 index 0000000000..32277f6c01 --- /dev/null +++ b/.chloggen/3753.yaml @@ -0,0 +1,5 @@ +change_type: enhancement +component: db +note: Promote Oracle Database connection attributes to release candidate so the + RC `db.oracledb.client` span does not reference lower-stability attributes. +issues: [3753] diff --git a/docs/db/oracledb.md b/docs/db/oracledb.md index e7d0deff4b..88f7d1cbf4 100644 --- a/docs/db/oracledb.md +++ b/docs/db/oracledb.md @@ -48,11 +48,11 @@ Spans representing calls to a Oracle SQL Database adhere to the general [Semanti | [`db.query.summary`](/docs/registry/attributes/db.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` [11] | string | Low cardinality summary of a database query. [12] | `SELECT wuser_table`; `INSERT shipping_details SELECT orders`; `get user by id` | | [`db.query.text`](/docs/registry/attributes/db.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` [13] | string | The database query being executed. [14] | `SELECT * FROM wuser_table where username = :mykey` | | [`db.stored_procedure.name`](/docs/registry/attributes/db.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` [15] | string | The name of a stored procedure within the database. [16] | `GetCustomer` | -| [`oracle.db.domain`](/docs/registry/attributes/oracledb.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The database domain associated with the connection. [17] | `example.com`; `corp.internal`; `prod.db.local` | -| [`oracle.db.instance.name`](/docs/registry/attributes/oracledb.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The instance name associated with the connection in an Oracle Real Application Clusters environment. [18] | `ORCL1`; `ORCL2`; `ORCL3` | -| [`oracle.db.name`](/docs/registry/attributes/oracledb.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The database name associated with the connection. [19] | `ORCL1`; `FREE` | -| [`oracle.db.pdb`](/docs/registry/attributes/oracledb.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The pluggable database (PDB) name associated with the connection. [20] | `PDB1`; `FREEPDB` | -| [`oracle.db.service`](/docs/registry/attributes/oracledb.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The service name currently associated with the database connection. [21] | `order-processing-service`; `db_low.adb.oraclecloud.com`; `db_high.adb.oraclecloud.com` | +| [`oracle.db.domain`](/docs/registry/attributes/oracledb.md) | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | `Recommended` | string | The database domain associated with the connection. [17] | `example.com`; `corp.internal`; `prod.db.local` | +| [`oracle.db.instance.name`](/docs/registry/attributes/oracledb.md) | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | `Recommended` | string | The instance name associated with the connection in an Oracle Real Application Clusters environment. [18] | `ORCL1`; `ORCL2`; `ORCL3` | +| [`oracle.db.name`](/docs/registry/attributes/oracledb.md) | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | `Recommended` | string | The database name associated with the connection. [19] | `ORCL1`; `FREE` | +| [`oracle.db.pdb`](/docs/registry/attributes/oracledb.md) | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | `Recommended` | string | The pluggable database (PDB) name associated with the connection. [20] | `PDB1`; `FREEPDB` | +| [`oracle.db.service`](/docs/registry/attributes/oracledb.md) | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | `Recommended` | string | The service name currently associated with the database connection. [21] | `order-processing-service`; `db_low.adb.oraclecloud.com`; `db_high.adb.oraclecloud.com` | | [`server.address`](/docs/registry/attributes/server.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` | string | Name of the database host. [22] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | | [`db.query.parameter.`](/docs/registry/attributes/db.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Opt-In` | string | A database query parameter, with `` being the parameter name, and the attribute value being a string representation of the parameter value. [23] | `someval`; `55` | | [`db.response.returned_rows`](/docs/registry/attributes/db.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Opt-In` | int | Number of rows returned by the operation. [24] | `10`; `30`; `1000` | diff --git a/docs/registry/attributes/oracledb.md b/docs/registry/attributes/oracledb.md index 0c8c986fb6..e4cd29e1b4 100644 --- a/docs/registry/attributes/oracledb.md +++ b/docs/registry/attributes/oracledb.md @@ -11,11 +11,11 @@ This section defines attributes for Oracle Database. | Key | Stability | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | -| `oracle.db.domain` | ![Development](https://img.shields.io/badge/-development-blue) | string | The database domain associated with the connection. [1] | `example.com`; `corp.internal`; `prod.db.local` | -| `oracle.db.instance.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | The instance name associated with the connection in an Oracle Real Application Clusters environment. [2] | `ORCL1`; `ORCL2`; `ORCL3` | -| `oracle.db.name` | ![Development](https://img.shields.io/badge/-development-blue) | string | The database name associated with the connection. [3] | `ORCL1`; `FREE` | -| `oracle.db.pdb` | ![Development](https://img.shields.io/badge/-development-blue) | string | The pluggable database (PDB) name associated with the connection. [4] | `PDB1`; `FREEPDB` | -| `oracle.db.service` | ![Development](https://img.shields.io/badge/-development-blue) | string | The service name currently associated with the database connection. [5] | `order-processing-service`; `db_low.adb.oraclecloud.com`; `db_high.adb.oraclecloud.com` | +| `oracle.db.domain` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | string | The database domain associated with the connection. [1] | `example.com`; `corp.internal`; `prod.db.local` | +| `oracle.db.instance.name` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | string | The instance name associated with the connection in an Oracle Real Application Clusters environment. [2] | `ORCL1`; `ORCL2`; `ORCL3` | +| `oracle.db.name` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | string | The database name associated with the connection. [3] | `ORCL1`; `FREE` | +| `oracle.db.pdb` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | string | The pluggable database (PDB) name associated with the connection. [4] | `PDB1`; `FREEPDB` | +| `oracle.db.service` | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) | string | The service name currently associated with the database connection. [5] | `order-processing-service`; `db_low.adb.oraclecloud.com`; `db_high.adb.oraclecloud.com` | **[1] `oracle.db.domain`:** This attribute SHOULD be set to the value of the `DB_DOMAIN` initialization parameter, as exposed in `v$parameter`. `DB_DOMAIN` defines the domain portion of the global diff --git a/model/oracledb/registry.yaml b/model/oracledb/registry.yaml index c5a20721c5..e1387fb3ef 100644 --- a/model/oracledb/registry.yaml +++ b/model/oracledb/registry.yaml @@ -8,7 +8,7 @@ groups: attributes: - id: oracle.db.name type: string - stability: development + stability: release_candidate brief: > The database name associated with the connection. note: | @@ -16,7 +16,7 @@ groups: examples: ["ORCL1", "FREE"] - id: oracle.db.domain type: string - stability: development + stability: release_candidate brief: > The database domain associated with the connection. note: | @@ -28,7 +28,7 @@ groups: examples: ["example.com", "corp.internal", "prod.db.local"] - id: oracle.db.instance.name type: string - stability: development + stability: release_candidate brief: > The instance name associated with the connection in an Oracle Real Application Clusters environment. note: | @@ -38,7 +38,7 @@ groups: examples: ["ORCL1", "ORCL2", "ORCL3"] - id: oracle.db.pdb type: string - stability: development + stability: release_candidate brief: > The pluggable database (PDB) name associated with the connection. note: | @@ -49,7 +49,7 @@ groups: examples: ["PDB1", "FREEPDB"] - id: oracle.db.service type: string - stability: development + stability: release_candidate brief: > The service name currently associated with the database connection. note: | diff --git a/policies/group_stability.rego b/policies/group_stability.rego index 638618fe6b..8ff609218b 100644 --- a/policies/group_stability.rego +++ b/policies/group_stability.rego @@ -25,8 +25,6 @@ deny contains group_stability_violation(description, group.id, name) if { "entity.service", # TODO: https://github.com/open-telemetry/semantic-conventions/issues/1616 "metric.dotnet.process.cpu.time", - # TODO: https://github.com/open-telemetry/semantic-conventions/issues/3753 - "span.db.oracledb.client", } not exceptions[group.id]