The Oracle Database receiver, a component of the Splunk Distribution of the OpenTelemetry Collector, queries and retrieves metrics from Oracle Database instances. The receiver connects to an Oracle Database instance and obtains metrics from it 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.

Prerequisites

1. Create an Oracle Database user and password:

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

2. Depending on which metrics you collect, you might need to assign the following permissions to the Oracle Database user you created in the previous step:

   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>;

Configure the receiver

1. Add oracledb to the receivers section of your Splunk Distribution of the OpenTelemetry Collector configuration file.

   Sample configuration for collecting data from one Oracle Database server

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

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

   Alternatively, add endpoint, password, service, and username to the receivers section of your configuration file, as shown in the following example:

   receivers:
     oracledb:
       endpoint: <host>
       password: <password>
       service: <service>
       username: <username>

   Sample configuration for collecting data from multiple Oracle Database servers

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

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

   Sample configuration for high availability

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

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

2. Configure advanced settings.

3. Add oracledb to service.pipeline.metrics in the collector configuration file:

   service:
     pipelines:
       metrics:
         receivers:
           - oracledb