Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Use this changelog template to create an entry for release notes.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: enhancement

# The name of the component, or a single word describing the area of concern, (e.g. receiver/filelog)
component: receiver/oracledb

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Add transaction, lock, and recovery metrics

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
issues: [49064]

# (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: |
The new metrics are disabled by default and add no new database queries.

# If your change doesn't affect end users or the exported elements of any package,
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
# Optional: The change log or logs in which this entry should be included.
# e.g. '[user]' or '[user, api]'
# Include 'user' if the change is relevant to end users.
# Include 'api' if there is a change to a library API.
# Default: '[user]'
change_logs: [user]
62 changes: 60 additions & 2 deletions receiver/oracledbreceiver/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -409,7 +409,7 @@ Total wall-clock time spent in database calls.

| Name | Description | Values | Requirement Level | Semantic Convention |
| ---- | ----------- | ------ | ----------------- | ------------------- |
| oracledb.session.type | Class of session the database time is attributed to. | Str: ``foreground`` | Recommended | - |
| oracledb.session.type | Class of session the activity is attributed to. | Str: ``background``, ``foreground`` | Recommended | - |

### oracledb.db_block_gets

Expand Down Expand Up @@ -463,6 +463,20 @@ Fraction of executions that did not require a parse, as computed by Oracle V$SYS
| ---- | ----------- | ------ | ----------------- | ------------------- |
| oracledb.parse.type | Type of parse operation (e.g., soft). | Str: ``soft`` | Recommended | - |

### oracledb.gc.current_block.time

Cumulative time spent transferring current blocks between instances over RAC cache fusion.

| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
| s | Sum | Double | Cumulative | true | Development |

#### Attributes

| Name | Description | Values | Requirement Level | Semantic Convention |
| ---- | ----------- | ------ | ----------------- | ------------------- |
| network.io.direction | Direction of the network transfer. | Str: ``receive``, ``transmit`` | Recommended | - |

### oracledb.host.cpu.usage.rate

Host CPU consumption rate across all cores, in CPU-seconds used per second.
Expand Down Expand Up @@ -509,6 +523,20 @@ Total count of LOB (large object) I/O operations.
| ---- | ----------- | ------ | ----------------- | ------------------- |
| disk.io.direction | Direction of the storage I/O operation. | Str: ``read``, ``write`` | Recommended | - |

### oracledb.lock.time

Cumulative time spent on transaction lock activity.

| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
| s | Sum | Double | Cumulative | true | Development |

#### Attributes

| Name | Description | Values | Requirement Level | Semantic Convention |
| ---- | ----------- | ------ | ----------------- | ------------------- |
| oracledb.session.type | Class of session the activity is attributed to. | Str: ``background``, ``foreground`` | Recommended | - |

### oracledb.logons

Number of logon operations
Expand Down Expand Up @@ -697,6 +725,14 @@ Number of SELECT statements executed in parallel
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
| {queries} | Sum | Int | Cumulative | true | Development |

### oracledb.recovery.blocks

Number of blocks read during instance or media recovery.

| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
| {block} | Sum | Int | Cumulative | true | Development |

### oracledb.recycle_bin.limit

Total size of the recycle bin.
Expand Down Expand Up @@ -858,6 +894,20 @@ Fraction of the shared pool that is currently free, as computed by Oracle V$SYSM
| ---- | ----------- | ---------- | --------- |
| % | Gauge | Double | Development |

### oracledb.smon.posts

Number of times SMON was posted to perform recovery.

| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
| {post} | Sum | Int | Cumulative | true | Development |

#### Attributes

| Name | Description | Values | Requirement Level | Semantic Convention |
| ---- | ----------- | ------ | ----------------- | ------------------- |
| oracledb.smon.type | Type of recovery SMON was posted to perform. | Str: ``instance``, ``transaction`` | Recommended | - |

### oracledb.sort.operations

Total count of sort operations.
Expand Down Expand Up @@ -914,7 +964,7 @@ Bytes transferred via SQL*Net between Oracle and clients/dblinks. Sourced from v

| Name | Description | Values | Requirement Level | Semantic Convention |
| ---- | ----------- | ------ | ----------------- | ------------------- |
| network.io.direction | Direction of the SQL*Net network transfer. | Str: ``receive``, ``transmit`` | Recommended | - |
| network.io.direction | Direction of the network transfer. | Str: ``receive``, ``transmit`` | Recommended | - |
| destination.type | Type of the SQL*Net destination endpoint (client application or remote database link). | Str: ``client``, ``dblink`` | Recommended | - |

### oracledb.storage.usage
Expand Down Expand Up @@ -965,6 +1015,14 @@ Average response time per transaction.
| ---- | ----------- | ---------- | --------- |
| s | Gauge | Double | Development |

### oracledb.transaction.rollbacks

Total number of transactions rolled back.

| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
| {rollback} | Sum | Int | Cumulative | true | Development |

## Default Events

The following events are emitted by default. Each of them can be disabled by applying the following configuration:
Expand Down
35 changes: 35 additions & 0 deletions receiver/oracledbreceiver/internal/metadata/config.schema.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -262,6 +262,13 @@ $defs:
enabled:
type: boolean
default: true
oracledb.gc.current_block.time:
description: "OracledbGcCurrentBlockTimeMetricConfig provides config for the oracledb.gc.current_block.time metric."
type: object
properties:
enabled:
type: boolean
default: false
oracledb.hard_parses:
description: "OracledbHardParsesMetricConfig provides config for the oracledb.hard_parses metric."
type: object
Expand Down Expand Up @@ -306,6 +313,13 @@ $defs:
- "disk.io.direction"
default:
- "disk.io.direction"
oracledb.lock.time:
description: "OracledbLockTimeMetricConfig provides config for the oracledb.lock.time metric."
type: object
properties:
enabled:
type: boolean
default: false
oracledb.logical_reads:
description: "OracledbLogicalReadsMetricConfig provides config for the oracledb.logical_reads metric."
type: object
Expand Down Expand Up @@ -517,6 +531,13 @@ $defs:
enabled:
type: boolean
default: false
oracledb.recovery.blocks:
description: "OracledbRecoveryBlocksMetricConfig provides config for the oracledb.recovery.blocks metric."
type: object
properties:
enabled:
type: boolean
default: false
oracledb.recycle_bin.limit:
description: "OracledbRecycleBinLimitMetricConfig provides config for the oracledb.recycle_bin.limit metric."
type: object
Expand Down Expand Up @@ -637,6 +658,13 @@ $defs:
default:
- "session_type"
- "session_status"
oracledb.smon.posts:
description: "OracledbSmonPostsMetricConfig provides config for the oracledb.smon.posts metric."
type: object
properties:
enabled:
type: boolean
default: false
oracledb.sort.operations:
description: "OracledbSortOperationsMetricConfig provides config for the oracledb.sort.operations metric."
type: object
Expand Down Expand Up @@ -759,6 +787,13 @@ $defs:
enabled:
type: boolean
default: false
oracledb.transaction.rollbacks:
description: "OracledbTransactionRollbacksMetricConfig provides config for the oracledb.transaction.rollbacks metric."
type: object
properties:
enabled:
type: boolean
default: false
oracledb.transactions.limit:
description: "OracledbTransactionsLimitMetricConfig provides config for the oracledb.transactions.limit metric."
type: object
Expand Down
Loading
Loading