summaryrefslogtreecommitdiffstats
path: root/modules/monitoring/doc/03-Configuration.md
blob: 9adacc1b670bdeb265dc55daafeb2f561a6ed91b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# Monitoring Module Configuration <a id="monitoring-module-configuration"></a>

## Overview <a id="monitoring-module-configuration-overview"></a>

The module specific configuration is stored in `/etc/icingaweb2/modules/monitoring`.

File/Directory                                                        | Description
----------------------------------------------------------------------|---------------------------------
config.ini                                                            | Security settings (e.g. protected custom vars) for the `monitoring` module |
[backends.ini](04-Backends.md#monitoring-module-backends)             | Data backend (e.g. the IDO database [resource](../../../doc/04-Resources.md#resources-configuration-database) name).
[commandtransports.ini](05-Command-Transports.md)                     | Command transports for specific Icinga instances


## General Configuration <a id="monitoring-module-configuration-general"></a>

Navigate into `Configuration` -> `Modules` -> `Monitoring`. This allows
you to see the provided [permissions and restrictions](06-Security.md#monitoring-security)
by this module.

### Default Settings <a id="monitoring-module-configuration-settings"></a>

Option                            | Description
----------------------------------|-----------------------------------------------
acknowledge_expire                | **Optional.** Check "Use Expire Time" in Acknowledgement dialog by default. Defaults to **0 (false)**.
acknowledge_expire_time           | **Optional.** Set default value for "Expire Time" in Acknowledgement dialog, its calculated as now + this setting. Format is a [PHP Dateinterval](http://www.php.net/manual/en/dateinterval.construct.php). Defaults to **1 hour (PT1H)**.
acknowledge_notify                | **Optional.** Check "Send Notification" in Acknowledgement dialog by default. Defaults to **1 (true)**.
acknowledge_persistent            | **Optional.** Check "Persistent Comment" in Acknowledgement dialog by default. Defaults to **0 (false)**.
acknowledge_sticky                | **Optional.** Check "Sticky Acknowledgement" in Acknowledgement dialog by default. Defaults to **0 (false)**.
comment_expire                    | **Optional.** Check "Use Expire Time" in Comment dialog by default. Defaults to **0 (false)**.
hostdowntime_comment_text         | **Optional.** Set default text for "Comment" in Host Downtime dialog by default.
servicedowntime_comment_text      | **Optional.** Set default text for "Comment" in Service Downtime dialog by default.
comment_expire_time               | **Optional.** Set default value for "Expire Time" in Comment dialog, its calculated as now + this setting. Format is a [PHP Dateinterval](http://www.php.net/manual/en/dateinterval.construct.php). Defaults to **1 hour (PT1H)**.
custom_notification_forced        | **Optional.** Check "Forced" in Custom Notification dialog by default. Defaults to **0 (false)**.
hostcheck_all_services            | **Optional.** Check "All Services" in Schedule Host Check dialog by default. Defaults to **0 (false)**.
hostdowntime_all_services         | **Optional.** Check "All Services" in Schedule Host Downtime dialog by default. Defaults to **0 (false)**.
hostdowntime_end_fixed            | **Optional.** Set default value for "End Time" in Schedule Host Downtime dialog for **Fixed** downtime, its calculated as now + this setting. Format is a [PHP Dateinterval](http://www.php.net/manual/en/dateinterval.construct.php). Defaults to **1 hour (PT1H)**.
hostdowntime_end_flexible         | **Optional.** Set default value for "End Time" in Schedule Host Downtime dialog for **Flexible** downtime, its calculated as now + this setting. Format is a [PHP Dateinterval](http://www.php.net/manual/en/dateinterval.construct.php). Defaults to **1 hour (PT1H)**.
hostdowntime_flexible_duration    | **Optional.** Set default value for "Flexible Duration" in Schedule Host Downtime dialog for **Flexible** downtime. Format is a [PHP Dateinterval](http://www.php.net/manual/en/dateinterval.construct.php). Defaults to **2 hour (PT2H)**.
servicedowntime_end_fixed         | **Optional.** Set default value for "End Time" in Schedule Service Downtime dialog for **Fixed** downtime, its calculated as now + this setting. Format is a [PHP Dateinterval](http://www.php.net/manual/en/dateinterval.construct.php). Defaults to **1 hour (PT1H)**.
servicedowntime_end_flexible      | **Optional.** Set default value for "End Time" in Schedule Service Downtime dialog for **Flexible** downtime, its calculated as now + this setting. Format is a [PHP Dateinterval](http://www.php.net/manual/en/dateinterval.construct.php). Defaults to **1 hour (PT1H)**.
servicedowntime_flexible_duration | **Optional.** Set default value for "Flexible Duration" in Schedule Service Downtime dialog for **Flexible** downtime. Format is a [PHP Dateinterval](http://www.php.net/manual/en/dateinterval.construct.php). Defaults to **2 hour (PT2H)**.

Example for having acknowledgements with 2 hours expire time by default.

```
# vim /etc/icingaweb2/modules/monitoring/config.ini

[settings]
acknowledge_expire = 1
acknowledge_expire_time = PT2H

```

### Security Configuration <a id="monitoring-module-configuration-security"></a>

Option                   | Description
-------------------------|-----------------------------------------------
protected\_customvars    | **Optional.** Comma separated list of string patterns for custom variables which should be excluded from user's view.


Example for custom variable names which match `*pw*` or `*pass*` or `community`.

```
# vim /etc/icingaweb2/modules/monitoring/config.ini

[security]
protected_customvars = "*pw*,*pass*,community"
```