OracleDb

Overview

This plugin collects runtime metrics from OracleDb database. It gathers information about database usage and allows defining custom metrics.

Setup

The oracledb plugin is included with the SolarWinds Snap Agent by default, please follow the directions below to enable it for a agent instance.

Prerequisites

This plugin requires Oracle Instant Client to be installed and added to the PATH environment variable. Follow the Oracle Instant Client installation instructions for your platform to have it properly set up.

The plugin also requires the user to be able to read various statistic tables in OracleDb. i.e. for a solarwinds read-only user, you need to grant the following privileges:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
grant select on v_$instance to solarwinds;
grant select on v_$database to solarwinds;
grant select on DBA_FEATURE_USAGE_STATISTICS to solarwinds;
grant select on V_$ASM_DISK to solarwinds;
grant select on V_$SYSSTAT to solarwinds;
grant select on V_$SESSION to solarwinds;
grant select on V_$SESSION_WAIT to solarwinds;
grant select on GV_$LOCK to solarwinds;
grant select on v_$parameter to solarwinds;
grant select on v_$timer to solarwinds;
grant select on v_$osstat to solarwinds;
grant select on v_$system_event to solarwinds;
grant select on v_$sga_dynamic_components to solarwinds;
grant select on v_$process to solarwinds;
grant select on v_$librarycache to solarwinds;
grant select on v_$sgastat to solarwinds;
grant select on v_$metric to solarwinds;
grant select on v_$process_memory to solarwinds;
grant select on v_$temp_space_header to solarwinds;
grant select on dba_tablespace_usage_metrics to solarwinds;
grant select on dba_data_files to solarwinds;
grant select on dba_segments to solarwinds;

Configuration

The agent provides an example configuration file to help you get started quickly. It defines the plugin and task file to be loaded by the agent, but requires you to provide the correct settings for your database. To enable the plugin:

1. Make a copy of the oracledb example configuration file oracledb.yaml.example, renaming it to oracledb.yaml:

On Windows, using Explorer or PowerShell:

Copy

> copy "C:\ProgramData\SolarWinds\Snap\plugins.d\oracledb.yaml.example" "C:\ProgramData\SolarWinds\Snap\plugins.d\oracledb.yaml"

On Linux using command line:

Copy

$ sudo cp /opt/SolarWinds/Snap/etc/plugins.d/oracledb.yaml.example /opt/SolarWinds/Snap/etc/plugins.d/oracledb.yaml

2. Update the oracledb.yaml configuration file with settings specific to your database instance, for example:

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
collector:
  oracledb:
    all:
      oracle_connection_strings: |
            solarwinds/password123@localhost:32118/XE
      #custom_sql_queries: |
      #  - sql: select distinct value from v$metric where metric_name='Disk Sort Per Sec' and  ROWNUM= 1
      #    metrics:
      #      - disk.sort.per.sec
      #  - sql: select distinct v1.value, v2.value from v$metric v1, v$metric v2 where v1.metric_name='Logons Per Sec' and  v2.metric_name='Current Logons Count' and ROWNUM= 1
      #    metrics:
      #      - logons.per.sec
      #      - current.logons.count
load:
  plugin: snap-plugin-collector-oracledb
  task: task-oracledb.yaml

3. Restart the agent:

On Windows command line:

Copy

> net stop swisnapd
> net start swisnapd

On Linux command line:

Copy

$ sudo service swisnapd restart

4. Enable the OracleDb plugin in the AppOptics UI

On the Integrations Page you will see the OracleDb plugin available if the previous steps were successful. If you do not see the plugin, see Troubleshooting Linux.

Select the OracleDb plugin to open the configuration menu in the UI, and enable the plugin.

You should soon see the oracledb metrics reported to your dashboard.

Metrics and Tags

All of the metrics can be enabled or disabled in task-oracledb.yaml. The tables below outline the default set of metrics collected by the oracledb plugin along with the optional metrics available.

Default Metrics

Default Metric Tags

All OracleDb metrics are tagged with db_host, db_id, db_version and db_instance_name.

Optional Metrics

Optinal metrics can be activated by editing the task yaml. For more information please read the SolarWinds Snap Agent configuration article.

The scripts are not supported under any SolarWinds support program or service. The scripts are provided AS IS without warranty of any kind. SolarWinds further disclaims all warranties including, without limitation, any implied warranties of merchantability or of fitness for a particular purpose. The risk arising out of the use or performance of the scripts and documentation stays with you. In no event shall SolarWinds or anyone else involved in the creation, production, or delivery of the scripts be liable for any damages whatsoever (including, without limitation, damages for loss of business profits, business interruption, loss of business information, or other pecuniary loss) arising out of the use of or inability to use the scripts or documentation.