tyler.durden/icinga2
1
0
Fork 0
mirror of https://github.com/Icinga/icinga2.git synced 2025-07-28 08:04:14 +02:00
Code Issues Packages Projects Releases Wiki Activity

Documentation: Explain how command parameters work with CheckCommand and Host, Service objects.

Browse Source 
Fixes #6267
This commit is contained in:
Michael Friedrich 2014-05-22 16:46:29 +02:00
parent 4296ec3987
commit d8511a3193
1 changed files with 25 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
doc/3-monitoring-basics.md
View File

@ -309,10 +309,13 @@ events should be handled.
Please check [Runtime Custom Attributes as Environment Variables](#runtime-custom-attribute-env-vars). Please check [Runtime Custom Attributes as Environment Variables](#runtime-custom-attribute-env-vars).
### <a id="check-commands"></a> Check Commands ### <a id="check-commands"></a> Check Commands
`CheckCommand` objects define the command line how a check is called. `CheckCommand` objects define the command line how a check is called.
#### <a id="command-plugin-integration"></a> Integrate the Plugin with a CheckCommand Definition
`CheckCommand` objects require the [ITL template](#itl-plugin-check-command) `CheckCommand` objects require the [ITL template](#itl-plugin-check-command)
`plugin-check-command` to support native plugin based check methods. `plugin-check-command` to support native plugin based check methods.
@ -328,8 +331,29 @@ all available options. Our example defines warning (`-w`) and
critical (`-c`) thresholds for the disk usage. Without any critical (`-c`) thresholds for the disk usage. Without any
partition defined (`-p`) it will check all local partitions. partition defined (`-p`) it will check all local partitions.
icinga@icinga2 $ /usr/lib/nagios/plugins/check_disk --help
...
This plugin checks the amount of used disk space on a mounted file system
and generates an alert if free space is less than one of the threshold values
Usage:
check_disk -w limit -c limit [-W limit] [-K limit] {-p path | -x device}
[-C] [-E] [-e] [-f] [-g group ] [-k] [-l] [-M] [-m] [-R path ] [-r path ]
[-t timeout] [-u unit] [-v] [-X type] [-N type]
...
Next step is to understand how command parameters are being passed from
a host or service object, and add a `CheckCommand` definition based on these
required parameters and/or default values.
#### <a id="command-passing-parameters"></a> Passing Check Command Parameters from Host or Service
Unline Icinga 1.x check command parameters are defined as custom attributes
which can be accessed as runtime macros by the executed check command.
Define the default check command custom attribute `disk_wfree` and `disk_cfree` Define the default check command custom attribute `disk_wfree` and `disk_cfree`
freely definable naming schema) and their default threshold values. You can (freely definable naming schema) and their default threshold values. You can
then use these custom attributes as runtime macros on the command line. then use these custom attributes as runtime macros on the command line.
The default custom attributes can be overridden by the custom attributes The default custom attributes can be overridden by the custom attributes