Oracle Database

The Oracle DB integration collects Oracle DB metrics and logs. The metrics are collected by querying relevant monitoring views. This integration writes structured trace logs.

For more information about Oracle DB, see the Oracle Database documentation .

Prerequisites

To collect Oracle DB telemetry, you must install the Ops Agent :

• For metrics, install version 2.22.0 or higher.
• For logs, install version 2.22.0 or higher.

This integration supports Oracle DB versions 12.2, 18c, 19c, and 21c.

Configure your Oracle DB instance

To collect metrics, a monitoring user requires SELECT access to the relevant views. The following sql script should create a monitoring user and give it the appropriate permissions if executed by a user with sufficient permissions connected to the Oracle DB instance as SYSDBA or SYSOPER.

-- Create the monitoring user "otel"
CREATE USER otel IDENTIFIED BY ;

-- Grant the "otel" user the required permissions
GRANT CONNECT TO otel;
GRANT SELECT ON SYS.GV_$DATABASE to otel;
GRANT SELECT ON SYS.GV_$INSTANCE to otel;
GRANT SELECT ON SYS.GV_$PROCESS to otel;
GRANT SELECT ON SYS.GV_$RESOURCE_LIMIT to otel;
GRANT SELECT ON SYS.GV_$SYSMETRIC to otel;
GRANT SELECT ON SYS.GV_$SYSSTAT to otel;
GRANT SELECT ON SYS.GV_$SYSTEM_EVENT to otel;
GRANT SELECT ON SYS.V_$RMAN_BACKUP_JOB_DETAILS to otel;
GRANT SELECT ON SYS.V_$SORT_SEGMENT to otel;
GRANT SELECT ON SYS.V_$TABLESPACE to otel;
GRANT SELECT ON SYS.V_$TEMPFILE to otel;
GRANT SELECT ON SYS.DBA_DATA_FILES to otel;
GRANT SELECT ON SYS.DBA_FREE_SPACE to otel;
GRANT SELECT ON SYS.DBA_TABLESPACE_USAGE_METRICS to otel;
GRANT SELECT ON SYS.DBA_TABLESPACES to otel;
GRANT SELECT ON SYS.GLOBAL_NAME to otel; 

Configure the Ops Agent for Oracle DB

Following the guide to Configure the Ops Agent , add the required elements to collect telemetry from Oracle DB instances, and restart the agent .

Example configuration

The following commands create the configuration to collect and ingest telemetry for Oracle DB:

  # 
  
 Configures 
  
 Ops 
  
 Agent 
  
 to 
  
 collect 
  
 telemetry 
  
 from 
  
 the 
  
 app 
 . 
  
 You 
  
 must 
  
 restart 
  
 the 
  
 agent 
  
 for 
  
 the 
  
 configuration 
  
 to 
  
 take 
  
 effect 
 . 
 set 
  
 - 
 e 
 # 
  
 Check 
  
 if 
  
 the 
  
 file 
  
 exists 
 if 
  
 [ 
  
 ! 
  
 - 
 f 
  
 / 
 etc 
 / 
 google 
 - 
 cloud 
 - 
 ops 
 - 
 agent 
 / 
 config 
 . 
 yaml 
  
 ]; 
  
 then 
  
 # 
  
 Create 
  
 the 
  
 file 
  
 if 
  
 it 
  
 doesn 
 ' 
 t 
  
 exist 
 . 
  
 sudo 
  
 mkdir 
  
 - 
 p 
  
 / 
 etc 
 / 
 google 
 - 
 cloud 
 - 
 ops 
 - 
 agent 
  
 sudo 
  
 touch 
  
 / 
 etc 
 / 
 google 
 - 
 cloud 
 - 
 ops 
 - 
 agent 
 / 
 config 
 . 
 yaml 
 fi 
 # 
  
 Create 
  
 a 
  
 back 
  
 up 
  
 of 
  
 the 
  
 existing 
  
 file 
  
 so 
  
 existing 
  
 configurations 
  
 are 
  
 not 
  
 lost 
 . 
 sudo 
  
 cp 
  
 / 
 etc 
 / 
 google 
 - 
 cloud 
 - 
 ops 
 - 
 agent 
 / 
 config 
 . 
 yaml 
  
 / 
 etc 
 / 
 google 
 - 
 cloud 
 - 
 ops 
 - 
 agent 
 / 
 config 
 . 
 yaml 
 . 
 bak 
 # 
  
 Configure 
  
 the 
  
 Ops 
  
 Agent 
 . 
 sudo 
  
 tee 
  
 / 
 etc 
 / 
 google 
 - 
 cloud 
 - 
 ops 
 - 
 agent 
 / 
 config 
 . 
 yaml 
 > 
 / 
 dev 
 / 
 null 
 << 
 EOF 
 logging 
 : 
  
 receivers 
 : 
  
 oracledb_audit 
 : 
  
 type 
 : 
  
 oracledb_audit 
  
 oracle_home 
 : 
  
 / 
 opt 
 / 
 oracle 
  
 oracledb_alert 
 : 
  
 type 
 : 
  
 oracledb_alert 
  
 oracle_home 
 : 
  
 / 
 opt 
 / 
 oracle 
  
 service 
 : 
  
 pipelines 
 : 
  
 oracledb 
 : 
  
 receivers 
 : 
  
 - 
  
 oracledb_audit 
  
 - 
  
 oracledb_alert 
 metrics 
 : 
  
 receivers 
 : 
  
 oracledb 
 : 
  
 type 
 : 
  
 oracledb 
  
 username 
 : 
  
 otel 
  
 password 
 : 
  
 ora19c 
  
 sid 
 : 
  
 ORCLCDB 
  
 service_name 
 : 
  
 ORCLCDB 
  
 service 
 : 
  
 log_level 
 : 
  
 debug 
  
 pipelines 
 : 
  
 oracledb 
 : 
  
 receivers 
 : 
  
 - 
  
 oracledb 
 EOF 
 

For these changes to take effect, you must restart the Ops Agent:

Configure logs collection

To ingest logs from Oracle DB, you must create a receiver for the logs that Oracle DB produces and then create a pipeline for the new receiver.

To configure a receiver for your oracledb_audit logs, specify the following fields:

To configure a receiver for your oracledb_alert logs, specify the following fields:

What is logged

The logName is derived from the receiver IDs specified in the configuration. Detailed fields inside the LogEntry are as follows.

The oracledb_alert logs contain the following fields in the LogEntry :

The oracledb_audit logs contain the following fields in the LogEntry :

Configure metrics collection

To ingest metrics from Oracle DB, you must create a receiver for the metrics that Oracle DB produces and then create a pipeline for the new receiver.

This receiver does not support the use of multiple instances in the configuration, for example, to monitor multiple endpoints. All such instances write to the same time series, and Cloud Monitoring has no way to distinguish among them.

To configure a receiver for your oracledb metrics, specify the following fields:

What is monitored

The following table provides the list of metrics that the Ops Agent collects from the Oracle DB instance.

Verify the configuration

This section describes how to verify that you correctly configured the Oracle DB receiver. It might take one or two minutes for the Ops Agent to begin collecting telemetry.

To verify that Oracle DB logs are being sent to Cloud Logging, do the following:

1. In the Google Cloud console, go to the Logs Explorer page:

   Go to Logs Explorer

   If you use the search bar to find this page, then select the result whose subheading is Logging .

2. Enter the following query in the editor, and then click Run query :
   

   resource.type="gce_instance"
   (log_id("oracledb_alert") OR log_id("oracledb_audit"))

To verify that Oracle DB metrics are being sent to Cloud Monitoring, do the following:

1. In the Google Cloud console, go to the leaderboard Metrics explorer page:

   Go to Metrics explorer

   If you use the search bar to find this page, then select the result whose subheading is Monitoring .

2. In the toolbar of the query-builder pane, select the button whose name is either code MQL or code PromQL .
3. Verify that PromQL is selected in the Language toggle. The language toggle is in the same toolbar that lets you format your query.
4. Enter the following query in the editor, and then click Run query :
   

   {"workload.googleapis.com/oracle.logon.count", monitored_resource="gce_instance"}

View dashboard

To view your Oracle DB metrics, you must have a chart or dashboard configured. The Oracle DB integration includes one or more dashboards for you. Any dashboards are automatically installed after you configure the integration and the Ops Agent has begun collecting metric data.

You can also view static previews of dashboards without installing the integration.

To view an installed dashboard, do the following:

1. In the Google Cloud console, go to the Dashboards page:

   Go to Dashboards

   If you use the search bar to find this page, then select the result whose subheading is Monitoring .

2. Select the Dashboard List tab, and then choose the Integrations category.
3. Click the name of the dashboard you want to view.

If you have configured an integration but the dashboard has not been installed, then check that the Ops Agent is running. When there is no metric data for a chart in the dashboard, installation of the dashboard fails. After the Ops Agent begins collecting metrics, the dashboard is installed for you.

To view a static preview of the dashboard, do the following:

1. In the Google Cloud console, go to the Integrations page:

   Go to Integrations

   If you use the search bar to find this page, then select the result whose subheading is Monitoring .

2. Click the Compute Engine deployment-platform filter.
3. Locate the entry for Oracle DB and click View Details .
4. Select the Dashboards tab to see a static preview. If the dashboard is installed, then you can navigate to it by clicking View dashboard .

For more information about dashboards in Cloud Monitoring, see Dashboards and charts .

For more information about using the Integrations page, see Manage integrations .

Install alerting policies

Alerting policies instruct Cloud Monitoring to notify you when specified conditions occur. The Oracle DB integration includes one or more alerting policies for you to use. You can view and install these alerting policies from the Integrations page in Monitoring.

To view the descriptions of available alerting policies and install them, do the following:

1. In the Google Cloud console, go to the Integrations page:

   Go to Integrations

   If you use the search bar to find this page, then select the result whose subheading is Monitoring .

2. Locate the entry for Oracle DB and click View Details .
3. Select the Alerts tab. This tab provides descriptions of available alerting policies and provides an interface for installing them.
4. Install alerting policies. Alerting policies need to know where to send notifications that the alert has been triggered, so they require information from you for installation. To install alerting policies, do the following:
   1. From the list of available alerting policies, select those that you want to install.

   2. In the Configure notifications section, select one or more notification channels. You have the option to disable the use of notification channels, but if you do, then your alerting policies fire silently. You can check their status in Monitoring, but you receive no notifications.

      For more information about notification channels, see Manage notification channels .

   3. Click Create Policies .

For more information about alerting policies in Cloud Monitoring, see Introduction to alerting .

For more information about using the Integrations page, see Manage integrations .

What's next

For a walkthrough on how to use Ansible to install the Ops Agent, configure a third-party application, and install a sample dashboard, see the Install the Ops Agent to troubleshoot third-party applications video.