Skip to main content

Oracle Database

Pack assets​

Templates​

The Monitoring Connector Oracle Database brings a host template:

  • App-DB-Oracle-custom

The connector brings the following service templates (sorted by the host template they are attached to):

Service AliasService TemplateService DescriptionDiscovery
Connection-NumberApp-DB-Oracle-Connection-Number-customCheck connection number to the Oracle server
Connection-TimeApp-DB-Oracle-Connection-Time-customCheck the connection time to the server. This time is given in seconds
Corrupted-BlocksApp-DB-Oracle-Corrupted-Blocks-customCheck the number of corrupted blocks on the server
Datacache-HitratioApp-DB-Oracle-Datacache-Hitratio-customCheck the 'Data Buffer Cache Hit Ratio' of the server. No alerts by default
Process-UsageApp-DB-Oracle-Process-Usage-customCheck Oracle process used
Rman-Backup-ProblemsApp-DB-Oracle-Rman-Backup-Problems-customCheck RMAN backup errors of the server during the last three days
Session-UsageApp-DB-Oracle-Session-Usage-customCheck session used
Tablespace-Usage-GlobalApp-DB-Oracle-Tablespace-Usage-Global-customCheck the tablespace usage of the serverX
TnspingApp-DB-Oracle-Tnsping-customCheck the connection to a remote listener

The services listed above are created automatically when the App-DB-Oracle-custom host template is used.

If Discovery is checked, it means a service discovery rule exists for this service template.

Discovery rules​

Service discovery​

Rule nameDescription
App-DB-Oracle-ASM-Diskgroup-Usage-NameDiscover the disk partitions and monitor space occupation
App-DB-Oracle-Tablespaces-Usage-Name

More information about discovering services automatically is available on the dedicated page and in the following chapter.

Collected metrics & status​

Here is the list of services for this connector, detailing all metrics linked to each service.

Metric nameUnit
dg#statusN/A
dg#offline-disksN/A
dg#usageN/A
dg#usage-failureN/A

Applies to the following service templates: ASM-Diskgroup-Usage-Generic-Name, ASM-Diskgroup-Usage-Global

To obtain this new metric format, include --use-new-perfdata in the EXTRAOPTIONS service macro.

Prerequisites​

Dependencies​

dnf install gcc wget

Oracle instant client​

Go to Instant Client Downloads, choose the right OS your Poller is running on (Linux x86-64) and download the following packages (RPM):

  • oracle-instantclient-basic
  • oracle-instantclient-sqlplus
  • oracle-instantclientdevel

Install the RPM package manually:

rpm -ivh oracle-*.rpm

Perl library for Oracle​

As root, run:

cd /usr/local/src 
wget https://www.cpan.org/modules/by-module/DBD/DBD-Oracle-1.83.tar.gz 
tar xzf DBD-Oracle-1.83.tar.gz 
cd DBD-Oracle-1.83 
export ORACLE_HOME=/usr/lib/oracle/21/client64
export LD_LIBRARY_PATH=/usr/lib/oracle/21/client64/lib 
export PATH=$ORACLE_HOME:$PATH
export TNS_ADMIN=$ORACLE_HOME/network/admin
perl Makefile.PL -m /usr/share/oracle/21/client64/demo/demo.mk

The following message should appear:

LD_RUN_PATH=/usr/lib/oracle/21/client64/lib
Using DBD::Oracle 1.83.
Using DBD::Oracle 1.83.
Using DBI 1.641 (for perl 5.026003 on x86_64-linux-thread-multi) installed in /usr/lib64/perl5/vendor_perl/auto/DBI/
Generating a Unix-style Makefile
Writing Makefile for DBD::Oracle

If you get an error during the Makefile.PL step, explicitely force the Oracle version to a named version (it will not impact the plugin operations): perl Makefile.PL -V 12.1.0 -m /usr/share/oracle/21/client64/demo/demo.mk

Compile the library:

make

Install it:

make install

Create the file /etc/ld.so.conf.d/oracle.conf and add one line representing the path to the library: 

cat > /etc/ld.so.conf.d/oracle.conf <<EOF
/usr/lib/oracle/21/client64/lib/
EOF

Update library cache with the following command: 

/sbin/ldconfig

User account​

The safest way to retrieve information from the Oracle server is to create a dedicated user for Centreon.

This user account must have the READ (Oracle 12+) or SELECT (Oracle < 12) permission on following tables:

  • dba_free_space
  • dba_data_files
  • dba_temp_files
  • dba_segments
  • dba_jobs
  • dba_objects
  • DBA_MVIEW_refresh_times
  • dba_indexes
  • dba_ind_partitions
  • dba_ind_subpartitions
  • dba_registry
  • dba_tablespaces
  • DBA_MVIEW_refresh_times
  • DBA_TABLESPACE_USAGE_METRICS
  • v_$sysstat
  • v_$sgastat
  • v_$parameter
  • v_$process
  • v_$session
  • v_$filestat
  • v_$log
  • v_$instance
  • V_$ASM_DISKGROUP
  • v_$database_block_corruption
  • v_$tempstat
  • v_$rowcache
  • v_$system_event
  • v_$recovery_area_usage
  • v_$librarycache
  • v_$sql_monitor
  • v_$resource_limit
  • v_$rman_status
  • v_$backup
  • v_$rman_status
  • v_$rollstat
  • v_$resource_limit
  • v_$tablespace
  • v_$event_name
  • v_$waitstat

Installing the monitoring connector​

Pack​

  1. If the platform uses an online license, you can skip the package installation instruction below as it is not required to have the connector displayed within the Configuration > Monitoring Connector Manager menu. If the platform uses an offline license, install the package on the central server with the command corresponding to the operating system's package manager:
dnf install centreon-pack-applications-databases-oracle
  1. Whatever the license type (online or offline), install the Oracle Database connector through the Configuration > Monitoring Connector Manager menu.

Plugin​

Since Centreon 22.04, you can benefit from the 'Automatic plugin installation' feature. When this feature is enabled, you can skip the installation part below.

You still have to manually install the plugin on the poller(s) when:

  • Automatic plugin installation is turned off
  • You want to run a discovery job from a poller that doesn't monitor any resource of this kind yet

More information in the Installing the plugin section.

Use the commands below according to your operating system's package manager:

dnf install centreon-plugin-Applications-Databases-Oracle

Using the monitoring connector​

Using a host template provided by the connector​

  1. Log into Centreon and add a new host through Configuration > Hosts.
  2. Fill the Name, Alias & IP Address/DNS fields according to your ressource settings.
  3. Apply the App-DB-Oracle-custom template to the host. A list of macros appears. Macros allow you to define how the connector will connect to the resource, and to customize the connector's behavior.
  4. Fill in the macros you want. Some macros are mandatory.
MacroDescriptionDefault valueMandatory
ORACLEUSERNAMEUser name used to connect to the databaseUSERNAME
ORACLEPASSWORDPassword for the defined user namePASSWORD
ORACLEPORTDatabase Server Port1521
ORACLESERVICENAMEDatabase Service Name
ORACLESIDDatabase SIDSID
  1. Deploy the configuration. The host appears in the list of hosts, and on the Resources Status page. The command that is sent by the connector is displayed in the details panel of the host: it shows the values of the macros.

Using a service template provided by the connector​

  1. If you have used a host template and checked Create Services linked to the Template too, the services linked to the template have been created automatically, using the corresponding service templates. Otherwise, create manually the services you want and apply a service template to them.
  2. Fill in the macros you want (e.g. to change the thresholds for the alerts). Some macros are mandatory (see the table below).
MacroDescriptionDefault valueMandatory
FILTERFilter by name (regexp can be used)
WARNINGWarning threshold80
CRITICALCritical threshold90
WARNINGUSAGEFAILUREWarning threshold
CRITICALUSAGEFAILURECritical threshold
EXTRAOPTIONSAny extra option you may want to add to the command (E.g. a --verbose flag). All options are listed here
  1. Deploy the configuration. The service appears in the list of services, and on page Resources Status. The command that is sent by the connector is displayed in the details panel of the service: it shows the values of the macros.

How to check in the CLI that the configuration is OK and what are the main options for?​

Once the plugin is installed, log into your Centreon poller's CLI using the centreon-engine user account (su - centreon-engine). Test that the connector is able to monitor a resource using a command like this one (replace the sample values by yours):

/usr/lib/centreon/plugins/centreon_oracle.pl \
    --plugin=database::oracle::plugin \
    --hostname='10.0.0.1' \
    --port='1521' \
    --sid='SID' \
    --servicename='' \
    --username='USERNAME' \
    --password='PASSWORD' \
    --mode=rollback-segment-usage \
    --warning-extends='' \
    --critical-extends='' \
    --warning-wraps='' \
    --critical-wraps='' \
    --warning-hit-ratio='' \
    --critical-hit-ratio='' \
    --warning-block-contention='' \
    --critical-block-contention=''  \
    --warning-header-contention='' \
    --critical-header-contention=''

The expected command output is shown below:

OK: Extends : 7/s Wraps : 21/s Header Contention :  88 % Block Contention :  27 % gets/waits Ratio :  85 % | 'extends'=7/s;;;0;'wraps'=21/s;;;0;'header-contention'=88%;;;0;100'block-contention'=27%;;;0;100'hit-ratio'=85%;;;0;100

Troubleshooting​

Please find the troubleshooting documentation for Centreon Plugins typical issues.

Available modes​

In most cases, a mode corresponds to a service template. The mode appears in the execution command for the connector. In the Centreon interface, you don't need to specify a mode explicitly: its use is implied when you apply a service template. However, you will need to specify the correct mode for the template if you want to test the execution command for the connector in your terminal.

All available modes can be displayed by adding the --list-mode parameter to the command:

/usr/lib/centreon/plugins/centreon_oracle.pl \
    --plugin=database::oracle::plugin \
    --list-mode

The plugin brings the following modes:

ModeLinked service template
asm-diskgroup-usage [code]App-DB-Oracle-ASM-Diskgroup-Usage-Generic-Name-custom
App-DB-Oracle-ASM-Diskgroup-Usage-Global-custom
collection [code]Not used in this Monitoring Connector
connected-users [code]App-DB-Oracle-Connection-Number-custom
connection-time [code]App-DB-Oracle-Connection-Time-custom
corrupted-blocks [code]App-DB-Oracle-Corrupted-Blocks-custom
data-files-status [code]App-DB-Oracle-Data-Files-Status-custom
datacache-hitratio [code]App-DB-Oracle-Datacache-Hitratio-custom
dataguard [code]Not used in this Monitoring Connector
dictionary-cache-usage [code]App-DB-Oracle-Dictionary-Cache-Usage-custom
event-waits-usage [code]App-DB-Oracle-Event-Waits-Usage-custom
fra-usage [code]App-DB-Oracle-Fra-Usage-custom
invalid-object [code]App-DB-Oracle-Invalid-Object-custom
library-cache-usage [code]App-DB-Oracle-Library-Cache-Usage-custom
list-asm-diskgroups [code]Used for service discovery
list-tablespaces [code]Used for service discovery
long-queries [code]App-DB-Oracle-Long-Queries-custom
password-expiration [code]Not used in this Monitoring Connector
process-usage [code]App-DB-Oracle-Process-Usage-custom
redolog-usage [code]App-DB-Oracle-Redolog-Usage-custom
rman-backup-age [code]App-DB-Oracle-Rman-Backup-Age-custom
rman-backup-problems [code]App-DB-Oracle-Rman-Backup-Problems-custom
rman-online-backup-age [code]App-DB-Oracle-Rman-Backup-Online-Age-custom
rollback-segment-usage [code]App-DB-Oracle-Rollback-Segment-Usage-custom
session-usage [code]App-DB-Oracle-Session-Usage-custom
sql [code]App-DB-Oracle-Sql-Statement-Generic-custom
sql-string [code]App-DB-Oracle-Sql-Statement-String-Generic-custom
tablespace-usage [code]App-DB-Oracle-Tablespace-Usage-Global-custom
tnsping [code]App-DB-Oracle-Tnsping-custom

Available options​

Generic options​

All generic options are listed here:

OptionDescription
--hostnameHostname to query.
--portDatabase Server Port.
--sidDatabase SID.
--servicenameDatabase Service Name.
--containerChange container (does an alter session set container command).
--modeDefine the mode in which you want the plugin to be executed (see--list-mode).
--dyn-modeSpecify a mode with the module's path (advanced).
--list-modeList all available modes.
--mode-versionCheck minimal version of mode. If not, unknown error.
--versionReturn the version of the plugin.
--sqlmodeThis plugin offers several ways to query the database (default: dbi). See --list-sqlmode.
--list-sqlmodeList all available sql modes.
--multipleEnable connecting to multiple databases (required by some specific modes such as replication).
--pass-managerDefine the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass.
--verboseDisplay extended status information (long output).
--debugDisplay debug messages.
--filter-perfdataFilter perfdata that match the regexp. Eg: adding --filter-perfdata='avg' will remove all metrics that do not contain 'avg' from performance data.
--filter-perfdata-advFilter perfdata based on a "if" condition using the following variables: label, value, unit, warning, critical, min, max. Variables must be written either %{variable} or %(variable). Eg: adding --filter-perfdata-adv='not (%(value) == 0 and %(max) eq "")' will remove all metrics whose value equals 0 and that don't have a maximum value.
--explode-perfdata-maxCreate a new metric for each metric that comes with a maximum limit. The new metric will be named identically with a '_max' suffix). Eg: it will split 'used_prct'=26.93%;0:80;0:90;0;100 into 'used_prct'=26.93%;0:80;0:90;0;100 'used_prct_max'=100%;;;;
--change-perfdata --extend-perfdataChange or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[newuom],[min],[m ax]] Common examples: Convert storage free perfdata into used: --change-perfdata=free,used,invert() Convert storage free perfdata into used: --change-perfdata=used,free,invert() Scale traffic values automatically: --change-perfdata=traffic,,scale(auto) Scale traffic values in Mbps: --change-perfdata=traffic_in,,scale(Mbps),mbps Change traffic values in percent: --change-perfdata=traffic_in,,percent()
--extend-perfdata-groupAdd new aggregated metrics (min, max, average or sum) for groups of metrics defined by a regex match on the metrics' names. Syntax: --extend-perfdata-group=regex,namesofnewmetrics,calculation[,[ne wuom],[min],[max]] regex: regular expression namesofnewmetrics: how the new metrics' names are composed (can use $1, $2... for groups defined by () in regex). calculation: how the values of the new metrics should be calculated newuom (optional): unit of measure for the new metrics min (optional): lowest value the metrics can reach max (optional): highest value the metrics can reach Common examples: Sum wrong packets from all interfaces (with interface need --units-errors=absolute): --extend-perfdata-group=',packets_wrong,sum(packets_(discard |error)_(in|out))' Sum traffic by interface: --extend-perfdata-group='traffic_in_(.*),traffic_$1,sum(traf fic_(in|out)_$1)'
--change-short-output --change-long-outputModify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Eg: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up'
--change-exitReplace an exit code with one of your choice. Eg: adding --change-exit=unknown=critical will result in a CRITICAL state instead of an UNKNOWN state.
--range-perfdataRewrite the ranges displayed in the perfdata. Accepted values: 0: nothing is changed. 1: if the lower value of the range is equal to 0, it is removed. 2: remove the thresholds from the perfdata.
--filter-uomMask the units when they don't match the given regular expression.
--opt-exitReplace the exit code in case of an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc). Default: unknown.
--output-ignore-perfdataRemove all the metrics from the service. The service will still have a status and an output.
--output-ignore-labelRemove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the beginning of the output. Eg: 'OK: Ram Total:...' will become 'Ram Total:...'
--output-xmlReturn the output in XML format (to send to an XML API).
--output-jsonReturn the output in JSON format (to send to a JSON API).
--output-openmetricsReturn the output in OpenMetrics format (to send to a tool expecting this format).
--output-fileWrite output in file (can be combined with json, xml and openmetrics options). E.g.: --output-file=/tmp/output.txt will write the output in /tmp/output.txt.
--disco-formatApplies only to modes beginning with 'list-'. Returns the list of available macros to configure a service discovery rule (formatted in XML).
--disco-showApplies only to modes beginning with 'list-'. Returns the list of discovered objects (formatted in XML) for service discovery.
--float-precisionDefine the float precision for thresholds (default: 8).
--source-encodingDefine the character encoding of the response sent by the monitored resource Default: 'UTF-8'.
--datasourceDatabase server information, mandatory if the server's address and port are not defined in the corresponding options. The syntax depends on the database type.
--usernameUser name used to connect to the database.
--passwordPassword for the defined user name.
--connect-optionsAdd connection options for the DBI connect method. Format: name=value,name2=value2,...
--connect-queryExecute a query just after the connection.
--sql-errors-exitExpected status in case of DB error or timeout. Possible values are warning, critical and unknown (default).
--timeoutTimeout in seconds for connection.
--exec-timeoutTimeout in seconds for query execution

Modes options​

All available options for each service template are listed below:

OptionDescription
--warning-usageWarning threshold.
--critical-usageCritical threshold.
--warning-usage-failureWarning threshold.
--critical-usage-failureCritical threshold.
--unknown-statusDefine the conditions to match for the status to be UNKNOWN. You can use the following variables: %{status}, %{display}
--warning-statusDefine the conditions to match for the status to be WARNING. You can use the following variables: %{status}, %{display}
--critical-statusDefine the conditions to match for the status to be CRITICAL. You can use the following variables: %{status}, %{display}
--warning-offline-disksSet warning threshold for offline disks (Default: '(%{offline_disks} > 0 && %{type} eq "extern") || (%{offline_disks} > 1 && %{type} eq "high")'). You can use the following variables: %{offline_disks}, %{type}, %{display}
--critical-offline-disksSet critical threshold for offline disks (Default: '%{offline_disks} > 0 && %{type} =~ /^normal|high$/'). You can use the following variables: %{offline_disks}, %{type}, %{display}
--unitsUnits of thresholds (Default: '%') ('%', 'B').
--freeThresholds are on free space left.
--filter-nameFilter by name (regexp can be used).

All available options for a given mode can be displayed by adding the --help parameter to the command:

/usr/lib/centreon/plugins/centreon_oracle.pl \
    --plugin=database::oracle::plugin \
    --hostname='10.0.0.1' \
    --help