Oracle Database receiver

The Oracle Database receiver allows the Splunk Distribution of OpenTelemetry Collector to collect metrics from Oracle Database by connecting to it.

The Oracle Database receiver allows the Splunk Distribution of the OpenTelemetry Collector to collect metrics from Oracle Database. The receiver connects to an Oracle Database instance and obtains metrics such as the number of physical reads, cumulative CPU time, and others. The supported pipeline type is metrics. See Process your data with pipelines for more information.

Get started

Follow these steps to configure and activate the component:

Deploy the Splunk Distribution of the OpenTelemetry Collector to your host or container platform:
Configure the Oracle Database receiver as described in the next section.
Restart the Collector.

Create a database user for this monitor

To create an Oracle Database user for this monitor, run the following commands:

-- Create user and set a password
CREATE USER <username> IDENTIFIED BY <password>;

Depending on which metrics you collect, you might need to assign the following permissions to the database user:

GRANT SELECT ON V_$SESSION TO <username>;
GRANT SELECT ON V_$SYSSTAT TO <username>;
GRANT SELECT ON V_$RESOURCE_LIMIT TO <username>;
GRANT SELECT ON DBA_TABLESPACES TO <username>;
GRANT SELECT ON DBA_DATA_FILES TO <username>;
GRANT SELECT ON DBA_TABLESPACE_USAGE_METRICS TO <username>;

Sample configurations

To activate the Oracle Database receiver, add oracledb to the receivers section of your configuration file, as shown in the following example:

receivers:
  oracledb:
    # Refer to Oracle Go Driver go_ora documentation for full connection string options
    datasource: "oracle://<username>:<password>@<host>:<port>/<database>"

To add more than one instance of Oracle Database, add as many entries of the oracledb receiver as needed. For example:

receivers:
  oracledb/aninstance:
    # Refer to Oracle Go Driver go_ora documentation for full connection string options
    datasource: "oracle://<username>:<password>@<host>:<port>/<database>"

  oracledb/anotherinstance:
    # Refer to Oracle Go Driver go_ora documentation for full connection string options
    datasource: "oracle://<username>:<password>@<host>:<port>/<database>"

To complete the configuration, include the receiver in the metrics pipeline of the service section of your configuration file. For example:

service:
  pipelines:
    metrics:
      receivers:
        - oracledb

To configure the Oracle Database receiver for high availability, use:

receivers:
  oracledb:
    # Refer to Oracle Go Driver go_ora documentation for full connection string options
    datasource: "oracle://<username>:<password>@<host>:<port>/<service_name>?<server>=<host>:<port>"

Settings

The following table shows the configuration options for the Oracle Database receiver:

included

https://raw.githubusercontent.com/splunk/collector-config-tools/main/cfg-metadata/receiver/oracledb.yaml

Metrics

The following metrics, resource attributes, and attributes, are available.

included

https://raw.githubusercontent.com/splunk/collector-config-tools/main/metric-metadata/oracledbreceiver.yaml

Activate or deactivate specific metrics

You can activate or deactivate specific metrics by setting the enabled field in the metrics section for each metric. For example:

receivers:
  samplereceiver:
    metrics:
      metric-one:
        enabled: true
      metric-two:
        enabled: false

The following is an example of host metrics receiver configuration with activated metrics:

receivers:
  hostmetrics:
    scrapers:
      process:
        metrics:
          process.cpu.utilization:
            enabled: true

Note: Deactivated metrics aren’t sent to Splunk Observability Cloud.

Billing

If you’re in a MTS-based subscription, all metrics count towards metrics usage.
If you’re in a host-based plan, metrics listed as active (Active: Yes) on this document are considered default and are included free of charge.

Learn more at Infrastructure Monitoring subscription usage (Host and metric plans).

Troubleshooting

If you are a Splunk Observability Cloud customer and are not able to see your data in Splunk Observability Cloud, you can get help in the following ways.

Available to Splunk Observability Cloud customers

Submit a case in the Splunk Support Portal.
Contact Splunk Support.

Available to prospective customers and free trial users

Ask a question and get answers through community support at Splunk Answers.
Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide. To join, see Chat groups.

Documentation