Oracle plugin

Overview

Configuration parameters allow customizing the Oracle plugin behavior.

It is recommended to specify them in their own configuration file (e.g. oracle.conf), rather than in the agent 2 configuration file. Then use the Include directive to include this file in the Zabbix agent 2 configuration.

All parameters are optional, unless explicitly stated that the parameter is mandatory.

This page is structured as:

  • Parameter overview (to see full details of a parameter, click its name)
  • Parameter details
Parameter Description
Plugins.Oracle.CallTimeout Specify the maximum wait time in seconds for a request to be completed.
Plugins.Oracle.ConnectTimeout Specify the maximum wait time in seconds for a connection to be established.
Plugins.Oracle.CustomQueriesPath Specify full pathname of the directory containing .sql files with custom queries.
Plugins.Oracle.CustomQueriesEnabled Enable execution of the oracle.custom.query item key.
Plugins.Oracle.Default.Password Specify the default password.
Plugins.Oracle.Default.Service Specify the default service name.
Plugins.Oracle.Default.URI Specify the default URI.
Plugins.Oracle.Default.User Specify the default username.
Plugins.Oracle.KeepAlive Set the maximum time of waiting (in seconds) before unused plugin connections are closed.
Plugins.Oracle.ResolveTNS Specify how to interpret the connection string (ConnString) for connecting to the Oracle server.
Plugins.Oracle.Sessions.<SessionName>.Password Specify the named session password.
Plugins.Oracle.Sessions.<SessionName>.Service Specify the named session service name.
Plugins.Oracle.Sessions.<SessionName>.URI Specify the named session URI.
Plugins.Oracle.Sessions.<SessionName>.User Specify the named session username.

Note that:

  • The default values reflect process defaults, not the values in the shipped configuration files.
  • Values support environment variables.
  • Zabbix supports configuration files only in UTF-8 encoding without BOM.
  • Comments starting with "#" are only supported at the beginning of the line.

Parameter details

Plugins.Oracle.CallTimeout

Specify the maximum wait time in seconds for a request to be completed.

Default: default timeout
Range: 1-30

Plugins.Oracle.ConnectTimeout

Specify the maximum wait time in seconds for a connection to be established.

Default: default timeout
Range: 1-30

Plugins.Oracle.CustomQueriesPath

Specify full pathname of the directory containing .sql files with custom queries.

Defaults:
/usr/local/share/zabbix/custom-queries/oracle - for Unix systems,
*:\Program Files\Zabbix Agent 2\Custom Queries\Oracle - for Windows systems (where * is the drive name from the ProgramFiles environment variable)

Example: 

/etc/zabbix/oracle/sql
Plugins.Oracle.CustomQueriesEnabled

Enable execution of the oracle.custom.query item key.
If disabled, no queries will be loaded from the custom query directory path.

Default: false
Range: true/false

Plugins.Oracle.Default.Password

Specify the default password for connecting to Oracle.
Used if no value is specified in an item key or named session.

Plugins.Oracle.Default.Service

Specify the default service name for connecting to Oracle (SID is not supported).
Used if no value is specified in an item key or named session.

Plugins.Oracle.Default.Uri

Specify the default URI for connecting to Oracle.
Used if no value is specified in an item key or named session.
Embedded credentials will be ignored.
Must match the URI format.
Supported schemes: tcp, tcps
The schema can be omitted.
The port can be omitted (default=1521).
It is also possible to specify the TNS key or TNS value as the connection string. The TNS value must be composed without whitespaces.

Examples: 

tcp://127.0.0.1:1521
localhost
zbx_tns_example (TNS key)
(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=localhost)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=xe))) (TNS value)
Plugins.Oracle.Default.User

Specify the default username for connecting to Oracle.
Used if no value is specified in an item key or named session.

Plugins.Oracle.KeepAlive

Set the maximum time of waiting (in seconds) before unused plugin connections are closed.

Default: 300
Range: 60-900

Plugins.Oracle.ResolveTNS

Specify how to interpret the connection string (ConnString) for connecting to the Oracle server.
If it is set to false the default scheme and port will be added to ConnString (if absent).
If the option is set to true, the default scheme and port will be omitted (unless explicitly specified in ConnString), and ConnString will be passed to the Oracle client as is. If the Oracle client finds ConnString in the tnsnames.ora file, the connection description found will be used to connect to the Oracle server.

Default: true
Range: true/false

Plugins.Oracle.Sessions.<SessionName>.Password

Specify the named session password for connecting to Oracle.
<SessionName> - define name of a session for using in item keys.

Plugins.Oracle.Sessions.<SessionName>.Service

Specify the named session service name for connecting to Oracle (SID is not supported).
<SessionName> - define name of a session for using in item keys.

Plugins.Oracle.Sessions.<SessionName>.Uri

Specify the named session URI for connecting to Oracle.
<SessionName> - define name of a session for using in item keys.
Embedded credentials will be ignored.
Must match the URI format.
Supported schemes: tcp, tcps
The schema can be omitted.
The port can be omitted (default=1521).
It is also possible to specify the TNS key or TNS value as the connection string. The TNS value must be composed without whitespaces.

Examples: 

tcp://127.0.0.1:1521
localhost
zbx_tns_example (TNS key)
(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=localhost)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=xe))) (TNS value)
Plugins.Oracle.Sessions.<SessionName>.User

Specify the named session username for connecting to Oracle.
<SessionName> - define name of a session for using in item keys.

See also