tyler.durden
/
icinga2
mirror of https://github.com/Icinga/icinga2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update documentation 

refs #9105
This commit is contained in:
Gunnar Beutner 2015-10-27 08:59:36 +01:00
parent 23330150f4
commit 263e9d43a6
3 changed files with 18 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/17-troubleshooting.md
View File

@ -301,7 +301,7 @@ There is no cli command for manually executing the check, but you can verify
the following (e.g. by invoking a forced check from the web interface):
* `/var/log/icinga2/icinga2.log` contains connection and execution errors.
* The ApiListener is not enabled to [accept commands](#clients-as-command-execution-bridge).
* The ApiListener is not enabled to [accept commands](11-icinga2-client.md#icinga2-client-configuration-command-bridge).
* `CheckCommand` definition not found on the remote client.
* Referenced check plugin not found on the remote client.
* Runtime warnings and errors, e.g. unresolved runtime macros or configuration problems.
@ -318,7 +318,7 @@ If the cluster zones do not sync their configuration, make sure to check the fol
* The `icinga2.log` log file in `/var/log/icinga2` will indicate whether this ApiListener
[accepts config](13-distributed-monitoring-ha.md#zone-config-sync-permissions), or not.
### <a id="troubleshooting-cluster-replay-log"></a> Cluster Troubleshooting Overdue Check Results
### <a id="troubleshooting-cluster-check-results"></a> Cluster Troubleshooting Overdue Check Results
If your master does not receive check results (or any other events) from the child zones
(satellite, clients, etc) make sure to check whether the client sending in events

28
doc/7-icinga-template-library.md
View File

@ -984,7 +984,7 @@ pgsql_query_warning | **Optional.** SQL query value to result in warning status
pgsql_query_critical | **Optional.** SQL query value to result in critical status (double).
# <a id="windows-plugins"></a>Icinga 2 Windows plugins
# <a id="windows-plugins"></a> Icinga 2 Windows plugins
To allow a basic monitoring of Windows clients Icinga 2 comes with a set of Windows only plugins. While trying to mirror the functionalities of their linux cousins from the monitoring-plugins package, the differences between Windows and Linux are too big to be able use the same CheckCommands for both systems.
@ -995,7 +995,7 @@ A check-commands-windows.conf comes with Icinga 2, it asumes that the Windows Pl
One of the differences between the Windows plugins and their linux counterparts is that they consistently do not require thresholds to run, functioning like dummies without.
## <a id="windows-plugins-thresholds"></a>Threshold syntax
## <a id="windows-plugins-thresholds"></a> Threshold syntax
So not specified differently the thresholds for the plugins all follow the same pattern
@ -1007,7 +1007,7 @@ Threshold | Meaning
"![10-40]" | Same as above, but the result is inverted.
## <a id="windows-plugins-disk-windows"></a>disk-windows
## <a id="windows-plugins-disk-windows"></a> disk-windows
Check command object for the `check_disk.exe` plugin.
Aggregates the free disk space of all volumes and mount points it can find, or the ones defined in `disk_win_path`. Ignores removable storage like fash drives and discs (CD, DVD etc.).
@ -1022,7 +1022,7 @@ disk\_win\_path | **Optional**. Check only these paths, default checks all.
disk\_win\_unit | **Optional**. Use this unit to display disk space, thresholds are interpreted in this unit. Defaults to "mb", possible values are: b, kb, mb, gb and tb.
## <a id="windows-plugins-load-windows"></a>load-windows
## <a id="windows-plugins-load-windows"></a> load-windows
Check command object for the `check_load.exe` plugin.
This plugin collects the inverse of the performance counter `\Processor(_Total)\% Idle Time` two times, with a wait time of one second between the collection. To change this wait time use [`perfmon-windows`](7-icinga-template-library.md#windows-plugins-load-windows).
@ -1035,7 +1035,7 @@ load\_win\_warn | **Optional**. The warning threshold.
load\_win\_crit | **Optional**. The critical threshold.
## <a id="windows-plugins-memory-windows"></a>memory-windows
## <a id="windows-plugins-memory-windows"></a> memory-windows
Check command object for the `check_memory.exe` plugin.
The memory collection is instant.
@ -1055,7 +1055,7 @@ memory\_win\_crit | **Optional**. The critical threshold.
memory\_win\_unit | **Optional**. The unit to display the received value in, thresholds are interpreted in this unit. Defaults to "mb" (megabye), possible values are: b, kb, mb, gb and tb.
## <a id="windows-plugins-network-windows"></a>network-windows
## <a id="windows-plugins-network-windows"></a> network-windows
Check command object for the `check_network.exe` plugin.
Collects the total Bytes inbount and outbound for all interfaces in one second, to itemise interfaces or use a different collection interval use [`perfmon-windows`](7-icinga-template-library.md#windows-plugins-load-windows).
@ -1068,7 +1068,7 @@ network\_win\_warn | **Optional**. The warning threshold.
network\_win\_crit | **Optional**. The critical threshold.
## <a id="windows-plugins-permon-windows"></a>perfmon-windows
## <a id="windows-plugins-permon-windows"></a> perfmon-windows
Check command object for the `check_perfmon.exe` plugin.
This plugins allows to collect data from a Performance Counter. After the first data collection a second one is done after `perfmon_win_wait` milliseconds. When you know `perfmon_win_counter` only requires one set of data to provide valid data you can set `perfmon_win_wait` to `0`.
@ -1086,7 +1086,7 @@ perfmon\_win\_wait | **Optional**. Time in milliseconds to wait between data
perfmon\_win\_type | **Optional**. Format in which to expect perfomance values. Possible are: long, int64 and double (default).
## <a id="windows-plugins-ping-windows"></a>ping-windows
## <a id="windows-plugins-ping-windows"></a> ping-windows
Check command object for the `check_ping.exe` plugin.
ping-windows should automaticly detect whether `ping_win_address` is an IPv4 or IPv6 address, if not use ping4-windows and ping6-windows. Also note that check\_ping.exe waits at least `ping_win_timeout` milliseconds between the pings.
@ -1102,7 +1102,7 @@ ping\_win\_packets | **Optional**. Number of packages to send. Default: 5.
ping\_win\_timeout | **Optional**. The timeout in milliseconds. Default: 1000
## <a id="windows-plugins-procs-windows"></a>procs-windows
## <a id="windows-plugins-procs-windows"></a> procs-windows
Check command object for `check_procs.exe` plugin.
When useing `procs_win_user` this plugins needs adminstratice privileges to access the processes of other users, to just enumerate them no additional privileges are required.
@ -1116,7 +1116,7 @@ procs\_win\_crit | **Optional**. The critical threshold.
procs\_win\_user | **Optional**. Count this useres processes.
## <a id="windows-plugins-service-windows"></a>service-windows
## <a id="windows-plugins-service-windows"></a> service-windows
Check command object for `check_service.exe` plugin.
This checks thresholds work different since the binary decision whether a service is running or not does not allow for three states. As a default `check_service.exe` will return CRITICAL when `service_win_service` is not running, the `service_win_warn` flag changes this to WARNING.
@ -1129,7 +1129,7 @@ service\_win\_warn | **Optional**. Warn when service is not running.
service\_win\_service | **Required**. The critical threshold.
## <a id="windows-plugins-swap-windows"></a>swap-windows
## <a id="windows-plugins-swap-windows"></a> swap-windows
Check command object for `check_swap.exe` plugin.
The data collection is instant.
@ -1143,7 +1143,7 @@ swap\_win\_crit | **Optional**. The critical threshold.
swap\_win\_unit | **Optional**. The unit to display the received value in, thresholds are interpreted in this unit. Defaults to "mb" (megabyte).
## <a id="windows-plugins-update-windows"></a>update-windows
## <a id="windows-plugins-update-windows"></a> update-windows
Check command object for `check_update.exe` plugin.
Querying Microsoft for Windows updates can take multiple seconds to minutes. An update is treated as important when it has the WSUS flag for SecurityUpdates or CriticalUpdates.
@ -1162,7 +1162,7 @@ update\_win\_crit | If set return critical when important updates that require
update\_win\_reboot | Set to treat 'may need update' as 'definitely needs update'
## <a id="windows-plugins-uptime-windows"></a>uptime-windows
## <a id="windows-plugins-uptime-windows"></a> uptime-windows
Check command opject for `check_uptime.exe` plugin.
Uses GetTickCount64 to get the uptime, so boot time is not included.
@ -1176,7 +1176,7 @@ uptime\_win\_crit | **Optional**. The critical threshold.
uptime\_win\_unit | **Optional**. The unit to display the received value in, thresholds are interpreted in this unit. Defaults to "s"(seconds), possible values are ms (milliseconds), s, m (minutes), h (hours).
## <a id="windows-plugins-users-windows"></a>users-windows
## <a id="windows-plugins-users-windows"></a> users-windows
Check command object for `check_users.exe` plugin.

6
doc/9-icinga2-api.md
View File

@ -67,7 +67,7 @@ Succesful requests will send back a response body containing a `results`
list. Depending on the number of affected objects in your request, the
results may contain one or more entries.
The [output](9-icinga2-api.md#icinga2-api-output) will be sent back as a JSON object:
The [output](9-icinga2-api.md#icinga2-api-output-format) will be sent back as a JSON object:
{
@ -217,14 +217,12 @@ Example for matching all hosts by name (**Note**: `"` are url-encoded as `%22`):
### <a id="icinga2-api-output-format"></a> Output Format
The request and response body contain a JSON encoded string.
The request and response bodies contain a JSON-encoded object.
### <a id="icinga2-api-version"></a> Version
Each url contains the version string as prefix (currently "/v1").
### <a id="icinga2-api-url-endpoints"></a> URL Endpoints
The Icinga 2 API provides multiple URL endpoints: