"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "doc/09-object-types.md" between
icinga2-2.11.5.tar.gz and icinga2-2.12.0.tar.gz

About: Icinga 2 is an enterprise grade monitoring system which keeps watch over networks and any conceivable network resource.

09-object-types.md  (icinga2-2.11.5):09-object-types.md  (icinga2-2.12.0)
skipping to change at line 404 skipping to change at line 404
state | Number | The current state (0 = UP, 1 = DOWN). state | Number | The current state (0 = UP, 1 = DOWN).
last\_state | Number | The previous state (0 = UP , 1 = DOWN). last\_state | Number | The previous state (0 = UP , 1 = DOWN).
last\_hard\_state | Number | The last hard state (0 = U P, 1 = DOWN). last\_hard\_state | Number | The last hard state (0 = U P, 1 = DOWN).
last\_state\_up | Timestamp | When the last UP state occ urred (as a UNIX timestamp). last\_state\_up | Timestamp | When the last UP state occ urred (as a UNIX timestamp).
last\_state\_down | Timestamp | When the last DOWN state o ccurred (as a UNIX timestamp). last\_state\_down | Timestamp | When the last DOWN state o ccurred (as a UNIX timestamp).
last\_state\_unreachable | Timestamp | When the host was unreacha ble the last time (as a UNIX timestamp). last\_state\_unreachable | Timestamp | When the host was unreacha ble the last time (as a UNIX timestamp).
previous\_state\_change | Timestamp | Previous timestamp of `las t_state_change` before processing a new check result. previous\_state\_change | Timestamp | Previous timestamp of `las t_state_change` before processing a new check result.
severity | Number | [Severity](19-technical-co ncepts.md#technical-concepts-checks-severity) calculated value. severity | Number | [Severity](19-technical-co ncepts.md#technical-concepts-checks-severity) calculated value.
problem | Boolean | Whether the host is consid ered in a problem state type (NOT-UP). problem | Boolean | Whether the host is consid ered in a problem state type (NOT-UP).
handled | Boolean | Whether the host problem i s handled (downtime or acknowledgement). handled | Boolean | Whether the host problem i s handled (downtime or acknowledgement).
next\_update | Timestamp | When the next check update is to be expected.
### HostGroup <a id="objecttype-hostgroup"></a> ### HostGroup <a id="objecttype-hostgroup"></a>
A group of hosts. A group of hosts.
> **Best Practice** > **Best Practice**
> >
> Assign host group members using the [group assign](17-language-reference.md#gr oup-assign) rules. > Assign host group members using the [group assign](17-language-reference.md#gr oup-assign) rules.
Example: Example:
skipping to change at line 732 skipping to change at line 733
icon\_image\_alt | String | **Optional.** Icon image d escription for the service. Used by external interface only. icon\_image\_alt | String | **Optional.** Icon image d escription for the service. Used by external interface only.
Service objects have composite names, i.e. their names are based on the host\_na me attribute and the name you specified. This means Service objects have composite names, i.e. their names are based on the host\_na me attribute and the name you specified. This means
you can define more than one object with the same (short) name as long as the `h ost_name` attribute has a different value. you can define more than one object with the same (short) name as long as the `h ost_name` attribute has a different value.
The actual check interval might deviate slightly from the configured values due to the fact that Icinga tries The actual check interval might deviate slightly from the configured values due to the fact that Icinga tries
to evenly distribute all checks over a certain period of time, i.e. to avoid loa d spikes. to evenly distribute all checks over a certain period of time, i.e. to avoid loa d spikes.
Runtime Attributes: Runtime Attributes:
Name | Type | Description Name | Type | Description
--------------------------|-----------------------|--------------------------- ------------------------------|-------------------|---------------------------
------- -------
next\_check | Timestamp | When the next check occurs next\_check | Timestamp | When the next check occurs
(as a UNIX timestamp). (as a UNIX timestamp).
last\_check | Timestamp | When the last check occurr last\_check | Timestamp | When the last check occurr
ed (as a UNIX timestamp). ed (as a UNIX timestamp).
check\_attempt | Number | The current check attempt check\_attempt | Number | The current check attempt
number. number.
state\_type | Number | The current state type (0 state\_type | Number | The current state type (0
= SOFT, 1 = HARD). = SOFT, 1 = HARD).
last\_state\_type | Number | The previous state type (0 last\_state\_type | Number | The previous state type (0
= SOFT, 1 = HARD). = SOFT, 1 = HARD).
last\_reachable | Boolean | Whether the service was re last\_reachable | Boolean | Whether the service was re
achable when the last check occurred. achable when the last check occurred.
last\_check\_result | CheckResult | The current [check result] last\_check\_result | CheckResult | The current [check result]
(08-advanced-topics.md#advanced-value-types-checkresult). (08-advanced-topics.md#advanced-value-types-checkresult).
last\_state\_change | Timestamp | When the last state change last\_state\_change | Timestamp | When the last state change
occurred (as a UNIX timestamp). occurred (as a UNIX timestamp).
last\_hard\_state\_change | Timestamp | When the last hard state c last\_hard\_state\_change | Timestamp | When the last hard state c
hange occurred (as a UNIX timestamp). hange occurred (as a UNIX timestamp).
last\_in\_downtime | Boolean | Whether the service was in last\_in\_downtime | Boolean | Whether the service was in
a downtime when the last check occurred. a downtime when the last check occurred.
acknowledgement | Number | The acknowledgement type ( acknowledgement | Number | The acknowledgement type (
0 = NONE, 1 = NORMAL, 2 = STICKY). 0 = NONE, 1 = NORMAL, 2 = STICKY).
acknowledgement\_expiry | Timestamp | When the acknowledgement e acknowledgement\_expiry | Timestamp | When the acknowledgement e
xpires (as a UNIX timestamp; 0 = no expiry). xpires (as a UNIX timestamp; 0 = no expiry).
downtime\_depth | Number | Whether the service has on acknowledgement\_last\_change | Timestamp | When the acknowledgement h
e or more active downtimes. as been set/cleared
flapping\_last\_change | Timestamp | When the last flapping cha downtime\_depth | Number | Whether the service has on
nge occurred (as a UNIX timestamp). e or more active downtimes.
flapping\_current | Number | Current flapping value in flapping\_last\_change | Timestamp | When the last flapping cha
percent (see flapping\_thresholds) nge occurred (as a UNIX timestamp).
flapping | Boolean | Whether the service is fla flapping\_current | Number | Current flapping value in
pping between states. percent (see flapping\_thresholds)
state | Number | The current state (0 = OK, flapping | Boolean | Whether the service is fla
1 = WARNING, 2 = CRITICAL, 3 = UNKNOWN). pping between states.
last\_state | Number | The previous state (0 = OK state | Number | The current state (0 = OK,
, 1 = WARNING, 2 = CRITICAL, 3 = UNKNOWN). 1 = WARNING, 2 = CRITICAL, 3 = UNKNOWN).
last\_hard\_state | Number | The last hard state (0 = O last\_state | Number | The previous state (0 = OK
K, 1 = WARNING, 2 = CRITICAL, 3 = UNKNOWN). , 1 = WARNING, 2 = CRITICAL, 3 = UNKNOWN).
last\_state\_ok | Timestamp | When the last OK state occ last\_hard\_state | Number | The last hard state (0 = O
urred (as a UNIX timestamp). K, 1 = WARNING, 2 = CRITICAL, 3 = UNKNOWN).
last\_state\_warning | Timestamp | When the last WARNING stat last\_state\_ok | Timestamp | When the last OK state occ
e occurred (as a UNIX timestamp). urred (as a UNIX timestamp).
last\_state\_critical | Timestamp | When the last CRITICAL sta last\_state\_warning | Timestamp | When the last WARNING stat
te occurred (as a UNIX timestamp). e occurred (as a UNIX timestamp).
last\_state\_unknown | Timestamp | When the last UNKNOWN stat last\_state\_critical | Timestamp | When the last CRITICAL sta
e occurred (as a UNIX timestamp). te occurred (as a UNIX timestamp).
last\_state\_unreachable | Timestamp | When the service was unrea last\_state\_unknown | Timestamp | When the last UNKNOWN stat
chable the last time (as a UNIX timestamp). e occurred (as a UNIX timestamp).
previous\_state\_change | Timestamp | Previous timestamp of `las last\_state\_unreachable | Timestamp | When the service was unrea
t_state_change` before processing a new check result. chable the last time (as a UNIX timestamp).
severity | Number | [Severity](19-technical-co previous\_state\_change | Timestamp | Previous timestamp of `las
ncepts.md#technical-concepts-checks-severity) calculated value. t_state_change` before processing a new check result.
problem | Boolean | Whether the service is con severity | Number | [Severity](19-technical-co
sidered in a problem state type (NOT-OK). ncepts.md#technical-concepts-checks-severity) calculated value.
handled | Boolean | Whether the service proble problem | Boolean | Whether the service is con
m is handled (downtime or acknowledgement). sidered in a problem state type (NOT-OK).
handled | Boolean | Whether the service proble
m is handled (downtime or acknowledgement).
next\_update | Timestamp | When the next check update
is to be expected.
### ServiceGroup <a id="objecttype-servicegroup"></a> ### ServiceGroup <a id="objecttype-servicegroup"></a>
A group of services. A group of services.
> **Best Practice** > **Best Practice**
> >
> Assign service group members using the [group assign](17-language-reference.md #group-assign) rules. > Assign service group members using the [group assign](17-language-reference.md #group-assign) rules.
Example: Example:
skipping to change at line 1354 skipping to change at line 1357
--------------------------|-----------------------|--------------------------- ------- --------------------------|-----------------------|--------------------------- -------
enable\_notifications | Boolean | **Optional.** Whether noti fications are globally enabled. Defaults to true. enable\_notifications | Boolean | **Optional.** Whether noti fications are globally enabled. Defaults to true.
enable\_event\_handlers | Boolean | **Optional.** Whether even t handlers are globally enabled. Defaults to true. enable\_event\_handlers | Boolean | **Optional.** Whether even t handlers are globally enabled. Defaults to true.
enable\_flapping | Boolean | **Optional.** Whether flap detection is globally enabled. Defaults to true. enable\_flapping | Boolean | **Optional.** Whether flap detection is globally enabled. Defaults to true.
enable\_host\_checks | Boolean | **Optional.** Whether acti ve host checks are globally enabled. Defaults to true. enable\_host\_checks | Boolean | **Optional.** Whether acti ve host checks are globally enabled. Defaults to true.
enable\_service\_checks | Boolean | **Optional.** Whether acti ve service checks are globally enabled. Defaults to true. enable\_service\_checks | Boolean | **Optional.** Whether acti ve service checks are globally enabled. Defaults to true.
enable\_perfdata | Boolean | **Optional.** Whether perf ormance data processing is globally enabled. Defaults to true. enable\_perfdata | Boolean | **Optional.** Whether perf ormance data processing is globally enabled. Defaults to true.
vars | Dictionary | **Optional.** A dictionary containing custom variables that are available globally. vars | Dictionary | **Optional.** A dictionary containing custom variables that are available globally.
environment | String | **Optional.** Specify the Icinga environment. This overrides the `Environment` constant specified in the c onfiguration or on the CLI with `--define`. Defaults to empty. environment | String | **Optional.** Specify the Icinga environment. This overrides the `Environment` constant specified in the c onfiguration or on the CLI with `--define`. Defaults to empty.
### IcingaDB <a id="objecttype-icingadb"></a>
The IcingaDB object implements the [icingadb feauture](14-features.md#core-backe
nds-icingadb).
Example:
```
object IcingaDB "icingadb" {
//host = "127.0.0.1"
//port = 6380
//password = "xxx"
}
```
Configuration Attributes:
Name | Type | Description
--------------------------|-----------------------|---------------------------
-------
host | String | **Optional.** Redis host f
or IcingaDB. Defaults to `127.0.0.1`.
port | Number | **Optional.** Redis port f
or IcingaDB. Defaults to `6380`.
path | String | **Optional.** Redix unix s
ocket path. Can be used instead of `host` and `port` attributes.
password | String | **Optional.** Redis auth p
assword for IcingaDB.
### IdoMySqlConnection <a id="objecttype-idomysqlconnection"></a> ### IdoMySqlConnection <a id="objecttype-idomysqlconnection"></a>
IDO database adapter for MySQL. IDO database adapter for MySQL.
This configuration object is available as [ido-mysql feature](14-features.md#db- ido). This configuration object is available as [ido-mysql feature](14-features.md#db- ido).
Example: Example:
``` ```
object IdoMysqlConnection "mysql-ido" { object IdoMysqlConnection "mysql-ido" {
host = "127.0.0.1" host = "127.0.0.1"
skipping to change at line 1609 skipping to change at line 1635
to InfluxDB. Experiment with the setting, if you are processing more than 1024 m etrics per second to InfluxDB. Experiment with the setting, if you are processing more than 1024 m etrics per second
or similar. or similar.
### LiveStatusListener <a id="objecttype-livestatuslistener"></a> ### LiveStatusListener <a id="objecttype-livestatuslistener"></a>
Livestatus API interface available as TCP or UNIX socket. Historical table queri es Livestatus API interface available as TCP or UNIX socket. Historical table queri es
require the [CompatLogger](09-object-types.md#objecttype-compatlogger) feature e nabled require the [CompatLogger](09-object-types.md#objecttype-compatlogger) feature e nabled
pointing to the log files using the `compat_log_path` configuration attribute. pointing to the log files using the `compat_log_path` configuration attribute.
This configuration object is available as [livestatus feature](14-features.md#se tting-up-livestatus). This configuration object is available as [livestatus feature](14-features.md#se tting-up-livestatus).
> **Note**
>
> This feature is DEPRECATED and will be removed in future releases.
> Check the [roadmap](https://github.com/Icinga/icinga2/milestones).
Examples: Examples:
``` ```
object LivestatusListener "livestatus-tcp" { object LivestatusListener "livestatus-tcp" {
socket_type = "tcp" socket_type = "tcp"
bind_host = "127.0.0.1" bind_host = "127.0.0.1"
bind_port = "6558" bind_port = "6558"
} }
object LivestatusListener "livestatus-unix" { object LivestatusListener "livestatus-unix" {
skipping to change at line 1676 skipping to change at line 1707
} }
``` ```
Configuration Attributes: Configuration Attributes:
Name | Type | Description Name | Type | Description
--------------------------|-----------------------|--------------------------- ------- --------------------------|-----------------------|--------------------------- -------
host | String | **Optional.** OpenTSDB host address. Defaults to `127.0.0.1`. host | String | **Optional.** OpenTSDB host address. Defaults to `127.0.0.1`.
port | Number | **Optional.** OpenTSDB port . Defaults to `4242`. port | Number | **Optional.** OpenTSDB port . Defaults to `4242`.
enable\_ha | Boolean | **Optional.** Enable the h igh availability functionality. Only valid in a [cluster setup](06-distributed-m onitoring.md#distributed-monitoring-high-availability-features). Defaults to `fa lse`. enable\_ha | Boolean | **Optional.** Enable the h igh availability functionality. Only valid in a [cluster setup](06-distributed-m onitoring.md#distributed-monitoring-high-availability-features). Defaults to `fa lse`.
enable_generic_metrics | Boolean | **Optional.** Re-use metri
c names to store different perfdata values for a particular check. Use tags to d
istinguish perfdata instead of metric name. Defaults to `false`.
host_template | Dictionary | **Optional.** Specify
additional tags to be included with host metrics. This requires a sub-dictionary
named `tags`. Also specify a naming prefix by setting `metric`. More informatio
n can be found in [OpenTSDB custom tags](14-features.md#opentsdb-custom-tags) an
d [OpenTSDB Metric Prefix](14-features.md#opentsdb-metric-prefix). More informat
ion can be found in [OpenTSDB custom tags](14-features.md#opentsdb-custom-tags).
Defaults to an `empty Dictionary`.
service_template | Dictionary | **Optional.** Specify
additional tags to be included with service metrics. This requires a sub-diction
ary named `tags`. Also specify a naming prefix by setting `metric`. More informa
tion can be found in [OpenTSDB custom tags](14-features.md#opentsdb-custom-tags)
and [OpenTSDB Metric Prefix](14-features.md#opentsdb-metric-prefix). Defaults t
o an `empty Dictionary`.
### PerfdataWriter <a id="objecttype-perfdatawriter"></a> ### PerfdataWriter <a id="objecttype-perfdatawriter"></a>
Writes check result performance data to a defined path using macro Writes check result performance data to a defined path using macro
pattern consisting of custom variables and runtime macros. pattern consisting of custom variables and runtime macros.
This configuration object is available as [perfdata feature](14-features.md#writ ing-performance-data-files). This configuration object is available as [perfdata feature](14-features.md#writ ing-performance-data-files).
Example: Example:
``` ```
 End of changes. 5 change blocks. 
59 lines changed or deleted 114 lines changed or added

Home  |  About  |  Features  |  All  |  Newest  |  Dox  |  Diffs  |  RSS Feeds  |  Screenshots  |  Comments  |  Imprint  |  Privacy  |  HTTP(S)