jnrpe-plugins.0.7.5.source-code.check_oracle_plugin.xml Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jnrpe-plugins Show documentation
The JNRPE bundled plugins
The newest version!
<plugin name="CHECK_ORACLE" class="it.jnrpe.plugin.CCheckOracle">
	<description>
<![CDATA[
    This plugin is used to perform various check against an Oracle Database Server.
    This version is able to perform:
    * is alive check: checks if the database is alive, connecting to it and performing a
      'SELECT SYSDATE FROM DUAL' query.
    * CACHE HIT RATE check :  Check the database for library and buffer cache hit ratios
    * TABLESPACE check: Check the usage of the given tablespace

    **** TO USE THIS PLUGIN, YOU MUST PUT THE ORACLE JDBC THIN DRIVER IN THE DIRECTORY WHERE
         THIS PLUGIN IS INSTALLED!!
    **** JDBC OCI DRIVER IS NOT SUPPORTED!!

    Example Command Definitions

    1. CHECK IS ALIVE

    Command Definition (XML Style)
    ------------------------------
      <command name="check_oracle_alive" plugin_name="CHECK_ORACLE"
        params="--username $ARG1$ --password $ARG2$ -db $ARG3$
        --server $ARG4$ --alive"/>

    Command Definition (INI Style)
    ------------------------------
      check_oracle_alive: CHECK_ORACLE --username $ARG1$ --password $ARG2$ --db $ARG3
        --server $ARG4$ --alive

    Example invocation:
    -------------------

      ./check_nrpe -t 20 -n -H myjnrpeserver -c check_oracle_alive -a 'username!password!SID!server'

    2. CHECK TABLESPACE

    Command Definition (XML Style)
    ------------------------------
      <command name="check_oracle_ts" plugin_name="CHECK_ORACLE"
        params="--username $ARG1$ --password $ARG2$ -db $ARG3$
        --server $ARG4$ --tablespace $ARG5$ -w 70: -c 80:"/>

    Command Definition (INI Style)
    ------------------------------
      check_oracle_ts: CHECK_ORACLE --username $ARG1$ --password $ARG2$ --db $ARG3
        --server $ARG4$ --tablespace $ARG5$ -w 70: -c 80:

    Example invocation:
    -------------------
    ./check_nrpe -t 20 -n -H myjnrpeserver -c check_oracle_ts -a 'username!password!SID!server!tablespacename'

    3. CHECK CACHE

    Command Definition (XML Style)
    ------------------------------
      <command name="check_oracle_cache" plugin_name="CHECK_ORACLE"
        params="--username $ARG1$ --password $ARG2$ -db $ARG3$
       --server $ARG4$ --cache -w 70: -c 80:"/>

    Command Definition (INI Style)
    ------------------------------
       check_oracle_ts: CHECK_ORACLE --username $ARG1$ --password $ARG2$ --db $ARG3
       --server $ARG4$ --cache -w 70: -c 80:

    Example invocation:
    -------------------
    ./check_nrpe -t 20 -n -H myjnrpeserver -c check_oracle_cache -a 'username!password!SID!server'
]]>
	</description>
	<command-line>
		<options>
			<option shortName="d" longName="db" description="Orace SID"
				hasArgs="true" argName="SID" required="true" optionalArgs="false" />
			<option shortName="s" longName="server" description="Database Server (IP or NAME)"
				hasArgs="true" argName="address" required="true" optionalArgs="false" />
			<option shortName="l" longName="port"
				description="Database Server port (default: 1521)" hasArgs="true"
				argName="port" required="false" optionalArgs="false" />
			<option shortName="u" longName="username" description="database username"
				hasArgs="true" argName="username" required="true" optionalArgs="false" />
			<option shortName="p" longName="password" description="database password"
				hasArgs="true" argName="password" required="true" optionalArgs="false" />
			<option shortName="t" longName="tablespace"
				description="Check the database for tablespace capacity in ORACLE_SID"
				hasArgs="true" argName="tablespace" required="false" optionalArgs="false" />
			<option shortName="w" longName="warning" description="warning threshold"
				hasArgs="true" argName="threshold" required="false" optionalArgs="false" />
			<option shortName="c" longName="critical" description="critical threshold"
				hasArgs="true" argName="threshold" required="false" optionalArgs="false" />
			<option shortName="k" longName="cache"
				description="Check the database for library and buffer cache hit ratios"
				required="false" />
			<option shortName="a" longName="alive"
				description="Check if the database is alive" hasArgs="false"
				required="false" />

			<option shortName="T" longName="th"
				description="Configure a threshold. Format : metric={metric},ok={range},warn={range},crit={range},unit={unit},prefix={SI prefix}"
				hasArgs="true" required="false" />

		</options>
	</command-line>
</plugin>