Skip to main content

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:

MetricDimensionsUnit
oracledb.sessionssessionsessions
oracledb.average_active_sessionsactivesessions
oracledb.sessions_utilizationsession_limitpercent
oracledb.current_logonslogonslogons
oracledb.logonslogonslogons/s
oracledb.database_wait_time_ratiodb_wait_timepercent
oracledb.sql_service_response_timesql_resp_timeseconds
oracledb.enqueue_timeoutsenqueuetimeouts/s
oracledb.disk_ioread, writtenbytes/s
oracledb.disk_iopsread, writeoperations/s
oracledb.sortsmemory, disksorts/s
oracledb.table_scansshort_table, long_tablescans/s
oracledb.cache_hit_ratiobuffer, cursor, library, rowpercent
oracledb.global_cache_blockscorrupted, lostblocks/s
oracledb.activityparse, execute, user_commits, user_rollbacksevents/s

Per tablespace

These metrics refer to the Tablespace.

Labels:

LabelDescription
tablespaceTablespace name.

Metrics:

MetricDimensionsUnit
oracledb.tablespace_utilizationutilizationpercent
oracledb.tablespace_usageavail, usedbytes

Per wait class

These metrics refer to the Wait Class.

Labels:

LabelDescription
wait_classWait Class name.

Metrics:

MetricDimensionsUnit
oracledb.wait_class_wait_timewait_timemilliseconds

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/oracle.conf.

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/oracle.conf

Options

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

Config options
NameDescriptionDefaultRequired
update_everyData collection frequency.1no
autodetection_retryRecheck interval in seconds. Zero means no recheck will be scheduled.0no
dsnOracle server DSN (Data Source Name). Format is oracle://username:password@host:port/service?param1=value1&...&paramN=valueN.yes
timeoutQuery timeout in seconds.1no

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

Do you have any feedback for this page? If so, you can open a new issue on our netdata/learn repository.