Oracle DB

Plugin: go.d.plugin Module: oracledb

Overview

This collector monitors the health and performance of Oracle DB servers and collects general statistics, replication and user metrics.

It establishes a connection to the Oracle DB instance via a TCP or UNIX socket and extracts metrics from the following database tables:

• v$sysmetric
• v$sysstat
• v$waitclassmetric
• v$system_wait_class
• dba_data_files
• dba_free_space

This collector is supported on all platforms.

This collector supports collecting metrics from multiple instances of this integration, including remote instances.

Default Behavior

Auto-Detection

The collector can automatically detect Oracle DB instances running on:

• Localhost, listening on port 1521
• Within Docker containers

Note: Oracle DB requires a username and password. While Netdata can automatically discover Oracle DB instances and create data collection jobs, these jobs will fail unless you provide the correct credentials.

Limits

The default configuration for this integration does not impose any limits on data collection.

Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.

Metrics

Metrics grouped by scope.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.

Per Oracle DB instance

These metrics refer to the entire monitored application.

This scope has no labels.

Metrics:

Metric	Dimensions	Unit
oracledb.sessions	session	sessions
oracledb.average_active_sessions	active	sessions
oracledb.sessions_utilization	session_limit	percent
oracledb.current_logons	logons	logons
oracledb.logons	logons	logons/s
oracledb.database_wait_time_ratio	db_wait_time	percent
oracledb.sql_service_response_time	sql_resp_time	seconds
oracledb.enqueue_timeouts	enqueue	timeouts/s
oracledb.disk_io	read, written	bytes/s
oracledb.disk_iops	read, write	operations/s
oracledb.sorts	memory, disk	sorts/s
oracledb.table_scans	short_table, long_table	scans/s
oracledb.cache_hit_ratio	buffer, cursor, library, row	percent
oracledb.global_cache_blocks	corrupted, lost	blocks/s
oracledb.activity	parse, execute, user_commits, user_rollbacks	events/s

Per tablespace

These metrics refer to the Tablespace.

Labels:

Label	Description
tablespace	Tablespace name.

Metrics:

Metric	Dimensions	Unit
oracledb.tablespace_utilization	utilization	percent
oracledb.tablespace_usage	avail, used	bytes

Per wait class

These metrics refer to the Wait Class.

Labels:

Label	Description
wait_class	Wait Class name.

Metrics:

Metric	Dimensions	Unit
oracledb.wait_class_wait_time	wait_time	milliseconds

Alerts

There are no alerts configured by default for this integration.

Setup

Prerequisites

Create a read only user for netdata

Follow the official instructions for your oracle RDBMS to create a read-only user for netdata. The operation may follow this approach

Connect to your Oracle database with an administrative user and execute:

CREATE USER netdata IDENTIFIED BY <PASSWORD>;

GRANT CONNECT TO netdata;
GRANT SELECT_CATALOG_ROLE TO netdata;

Configuration

File

The configuration file name for this integration is go.d/oracledb.conf.

The file format is YAML. Generally, the structure is:

update_every: 1
autodetection_retry: 0
jobs:
  - name: some_name1
  - name: some_name1

You can edit the configuration file using the edit-config script from the Netdata config directory.

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/oracledb.conf

Options

The following options can be defined globally: update_every, autodetection_retry.

Config options

Name	Description	Default	Required
update_every	Data collection frequency.	1	no
autodetection_retry	Recheck interval in seconds. Zero means no recheck will be scheduled.	0	no
dsn	Oracle server DSN (Data Source Name). Format is oracle://username:password@host:port/service?param1=value1&...&paramN=valueN.		yes
timeout	Query timeout in seconds.	1	no

Examples

TCP socket

An example configuration.

Config

jobs:
  - name: local
    dsn: oracle://netdata:[email protected]:1521/XE

TLS connection (TCPS)

An example configuration for TLS connection.

Config

jobs:
  - name: local
    dsn: 'oracle://netdata:[email protected]:1521/XE?ssl=true&ssl verify=true'

Multi-instance

Note: When you define multiple jobs, their names must be unique.

Local and remote instances.

Config

jobs:
  - name: local
    dsn: oracle://netdata:[email protected]:1521/XE

  - name: remote
    dsn: oracle://netdata:[email protected]:1521/XE

Troubleshooting

Debug Mode

Important: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.

To troubleshoot issues with the oracledb collector, run the go.d.plugin with the debug option enabled. The output should give you clues as to why the collector isn't working.

• Navigate to the plugins.d directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the plugins setting under [directories].

  cd /usr/libexec/netdata/plugins.d/

• Switch to the netdata user.

  sudo -u netdata -s

• Run the go.d.plugin to debug the collector:

  ./go.d.plugin -d -m oracledb

Getting Logs

If you're encountering problems with the oracledb collector, follow these steps to retrieve logs and identify potential issues:

• Run the command specific to your system (systemd, non-systemd, or Docker container).
• Examine the output for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.

System with systemd

Use the following command to view logs generated since the last Netdata service restart:

journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep oracledb

System without systemd

Locate the collector log file, typically at /var/log/netdata/collector.log, and use grep to filter for collector's name:

grep oracledb /var/log/netdata/collector.log

Note: This method shows logs from all restarts. Focus on the latest entries for troubleshooting current issues.

Docker Container

If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:

docker logs netdata 2>&1 | grep oracledb