mirror of https://github.com/Icinga/icinga2.git
Docs: Fix typos and other small corrections
fixes #7477 Signed-off-by: Gunnar Beutner <gunnar@beutner.name>
This commit is contained in:
Wolfgang Nieder
Gunnar Beutner
parent
4b6abd9aa7
commit
ae1dcf6258
|
|
@ -66,7 +66,7 @@ Icinga 2 is available as [Vagrant Demo VM](#vagrant).
|
|||
* `icinga2-build-{ca,key}` can be used with cli command `icinga2 pki` #7247
|
||||
* `icinga2 repository` manages `/etc/icinga2/repository.d` which must be included in `icinga2.conf` #7255
|
||||
|
||||
* `python-icinga2` package dropped in favor of cli commands #7245
|
||||
* `python-icinga2` package dropped in favour of cli commands #7245
|
||||
* GraphiteWriter: Add warn/crit/min/max perfdata and downtime_depth stats values #7366 #6946
|
||||
|
||||
#### Issues
|
||||
|
|
@ -101,7 +101,7 @@ in its operation. Same goes for performance data writers and the external comman
|
|||
file writers on disk (`statusdata`).
|
||||
Unlike Icinga 1.x the [daemon reload](#differences-1x-2-real-reload) happens asynchronously.
|
||||
A child daemon validates the new configuration, the parent process is still doing checks, replicating cluster events, triggering alert notifications, etc. If the configuration validation is ok, all remaining events are synchronized and the child process continues as normal.
|
||||
The DB IDO configuration dump and status/historical event updates also runs asynchronously in a queue not blocking the core anymore. The configuration validation itself runs in paralell allowing fast verification checks.
|
||||
The DB IDO configuration dump and status/historical event updates also runs asynchronously in a queue not blocking the core anymore. The configuration validation itself runs in parallel allowing fast verification checks.
|
||||
That way you are not blind (anymore) during a configuration reload and benefit from a real scalable architecture.
|
||||
|
||||
|
||||
|
|
@ -182,7 +182,7 @@ All [Monitoring Plugins](#setting-up-check-plugins) can be integrated into Icing
|
|||
newly created check command configuration if not already provided.
|
||||
[Configuration migration](#configuration-migration) is possible through an external migration tool.
|
||||
|
||||
Detailed [migration hints](#manual-config-migration-hints) explain migration the Icinga 1.x
|
||||
Detailed [migration hints](#manual-config-migration-hints) explain migration of the Icinga 1.x
|
||||
configuration objects into the native Icinga 2 configuration schema.
|
||||
Additional information on the differences is documented in the [migration](#differences-1x-2) chapter.
|
||||
|
||||
|
|
|
|||
|
|
@ -223,6 +223,8 @@ by trying to run it on the console using whichever user Icinga 2 is running as:
|
|||
|
||||
Additional libraries may be required for some plugins. Please consult the plugin
|
||||
documentation and/or plugin provided README for installation instructions.
|
||||
Sometimes plugins contain hard-coded paths to other components. Instead of changing
|
||||
the plugin it might be easier to create logical links which is (more) update-safe.
|
||||
|
||||
Each plugin requires a [CheckCommand](#objecttype-checkcommand) object in your
|
||||
configuration which can be used in the [Service](#objecttype-service) or
|
||||
|
|
@ -497,7 +499,7 @@ a valid `address` resp. `address6` attribute will be excluded.
|
|||
|
||||
Each of these services has the custom attribute `sla` set to `24x7`. The
|
||||
notification apply rule in `notifications.conf` will automatically apply
|
||||
a service notification matchting this attribute pattern.
|
||||
a service notification matching this attribute pattern.
|
||||
|
||||
apply Notification "mail-icingaadmin" to Service {
|
||||
import "mail-service-notification"
|
||||
|
|
@ -825,7 +827,9 @@ enable sending commands to Icinga 2 through your web interface:
|
|||
# usermod -G -a icingacmd www-data
|
||||
|
||||
Debian packages use `nagios` as the default user and group name. Therefore change `icingacmd` to
|
||||
`nagios`. The webserver's user is different between distributions as well.
|
||||
`nagios`.
|
||||
The webserver's user is different between distributions so you might have to change `www-data` to
|
||||
`wwwrun`, `www`, or `apache`.
|
||||
|
||||
Change "www-data" to the user you're using to run queries.
|
||||
|
||||
|
|
@ -964,7 +968,7 @@ The Debian packages require additional packages which are provided by the
|
|||
[Debian Monitoring Project](http://www.debmon.org) (`DebMon`) repository.
|
||||
|
||||
`libjs-jquery-ui` requires at least version `1.10.*` which is not available
|
||||
in Debian Wheezy and Ubuntu 12.04 LTS (Precise). Add the following repositories
|
||||
in Debian 7 (Wheezy) and Ubuntu 12.04 LTS (Precise). Add the following repositories
|
||||
to satisfy this dependency:
|
||||
|
||||
Distribution | Package Repositories
|
||||
|
|
@ -1153,7 +1157,7 @@ blog updates and more.
|
|||
There are many visualization addons which can be used with Icinga 2.
|
||||
|
||||
Some of the more popular ones are [PNP](#addons-graphing-pnp), [inGraph](#addons-graphing-pnp)
|
||||
graphing performance data), [Graphite](#addons-graphing-pnp), and
|
||||
(graphing performance data), [Graphite](#addons-graphing-pnp), and
|
||||
[NagVis](#addons-visualization-nagvis) (network maps).
|
||||
|
||||
|
||||
|
|
@ -1178,7 +1182,7 @@ These tools are in development and require feedback and tests:
|
|||
|
||||
## <a id="configuration-syntax-highlighting"></a> Configuration Syntax Highlighting
|
||||
|
||||
Icinga 2 ships configuration examples for syntax highlighting using the `vim` and `nano`editors.
|
||||
Icinga 2 ships configuration examples for syntax highlighting using the `vim` and `nano` editors.
|
||||
The RHEL, SUSE and Debian package `icinga2-common` install these files into
|
||||
`/usr/share/*/icinga2-common/syntax`. Sources provide these files in `tools/syntax`.
|
||||
|
||||
|
|
@ -1419,7 +1423,7 @@ or manually passing the `-C` argument:
|
|||
|
||||
### <a id="config-change-reload"></a> Reload on Configuration Changes
|
||||
|
||||
Everytime you have changed your configuration you should first tell Icinga 2
|
||||
Everytime you have changed your configuration you should first tell Icinga 2
|
||||
to [validate](#config-validation). If there are no validation errors you can
|
||||
safely reload the Icinga 2 daemon.
|
||||
|
||||
|
|
|
|||
|
|
@ -1963,7 +1963,7 @@ chapter. Details on the configuration can be found in the
|
|||
[IdoMysqlConnection](#objecttype-idomysqlconnection) and
|
||||
[IdoPgsqlConnection](#objecttype-idoPgsqlconnection)
|
||||
object configuration documentation.
|
||||
The DB IDO feature supports [High Availability](##high-availability-db-ido) in
|
||||
The DB IDO feature supports [High Availability](#high-availability-db-ido) in
|
||||
the Icinga 2 cluster.
|
||||
|
||||
The following example query checks the health of the current Icinga 2 instance
|
||||
|
|
|
|||
|
|
@ -207,7 +207,7 @@ Example:
|
|||
}
|
||||
|
||||
The [Endpoint](#objecttype-endpoint) name is further referenced as `endpoints` attribute on the
|
||||
[Zone](objecttype-zone) object.
|
||||
[Zone](#objecttype-zone) object.
|
||||
|
||||
object Endpoint "icinga2b" {
|
||||
host = "icinga2b.icinga.org"
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ number of community provided web interfaces too:
|
|||
## <a id="plugins"></a> Plugins
|
||||
|
||||
You can find plugins (additional to the ones at [Monitoring Plugins](https://www.monitoring-plugins.org)) over at
|
||||
[Monitoring Exchange](#https://www.monitoringexchange.org)
|
||||
[Monitoring Exchange](https://www.monitoringexchange.org)
|
||||
|
||||
More details on the plugins can also be found on the Icinga Wiki at https://wiki.icinga.org
|
||||
|
||||
|
|
|
|||
|
|
@ -66,7 +66,7 @@ the following error:
|
|||
Config error: in /etc/icinga2/conf.d/hosts/localhost.conf: 15:8-15:14: syntax error, unexpected include (T_INCLUDE), expecting T_IDENTIFIER
|
||||
[2014-09-15 17:24:00 +0200] critical/config: 1 errors, 0 warnings.
|
||||
|
||||
You can escape the `include` key with an additiona `@` character becoming `vars.@include`:
|
||||
You can escape the `include` key with an additional `@` character becoming `vars.@include`:
|
||||
|
||||
object Host "localhost" {
|
||||
import "generic-host"
|
||||
|
|
@ -177,7 +177,7 @@ by an ASCII character in octal encoding.
|
|||
Strings spanning multiple lines can be specified by enclosing them in
|
||||
{{{ and }}}.
|
||||
|
||||
Example.
|
||||
Example:
|
||||
|
||||
{{{This
|
||||
is
|
||||
|
|
@ -1355,7 +1355,7 @@ Attributes:
|
|||
instance\_name |**Optional.** Unique identifier for the local Icinga 2 instance. Defaults to "default".
|
||||
instance\_description|**Optional.** Description for the Icinga 2 instance.
|
||||
enable_ha |**Optional.** Enable the high availability functionality. Only valid in a [cluster setup](#high-availability-db-ido). Defaults to "true".
|
||||
failover_timeout | **Optional.** Set the failover timeout in a [HA cluster](#high-availability-db-ido). Must not be lower than 60s". Defaults to "60s".
|
||||
failover_timeout | **Optional.** Set the failover timeout in a [HA cluster](#high-availability-db-ido). Must not be lower than 60s. Defaults to "60s".
|
||||
cleanup |**Optional.** Dictionary with items for historical table cleanup.
|
||||
categories |**Optional.** The types of information that should be written to the database.
|
||||
|
||||
|
|
@ -1444,7 +1444,7 @@ Attributes:
|
|||
instance\_name |**Optional.** Unique identifier for the local Icinga 2 instance. Defaults to "default".
|
||||
instance\_description|**Optional.** Description for the Icinga 2 instance.
|
||||
enable_ha |**Optional.** Enable the high availability functionality. Only valid in a [cluster setup](#high-availability-db-ido). Defaults to "true".
|
||||
failover_timeout | **Optional.** Set the failover timeout in a [HA cluster](#high-availability-db-ido). Must not be lower than 60s". Defaults to "60s".
|
||||
failover_timeout | **Optional.** Set the failover timeout in a [HA cluster](#high-availability-db-ido). Must not be lower than 60s. Defaults to "60s".
|
||||
cleanup |**Optional.** Dictionary with items for historical table cleanup.
|
||||
categories |**Optional.** The types of information that should be written to the database.
|
||||
|
||||
|
|
@ -1851,7 +1851,7 @@ cluster_zone | **Optional.** The zone name. Defaults to "$host.name$".
|
|||
### <a id="plugin-check-command-overview"></a> Overview
|
||||
|
||||
The Plugin Check Commands provides example configuration for plugin check commands
|
||||
provided by the the Monitoring Plugins project.
|
||||
provided by the Monitoring Plugins project.
|
||||
|
||||
You can include the plugin check command definitions by using the `include`
|
||||
directive in your configuration file:
|
||||
|
|
@ -2029,7 +2029,7 @@ http_ignore_body | **Optional.** Don't download the body, just the heade
|
|||
http_linespan | **Optional.** Allow regex to span newline.
|
||||
http_expect_body_regex | **Optional.** A regular expression which the body must match against. Incompatible with http_ignore_body.
|
||||
http_expect_body_eregi | **Optional.** A case-insensitive expression which the body must match against. Incompatible with http_ignore_body.
|
||||
http_invertregex | **Optional.** Changes behavior of http_expect_body_regex and http_expect_body_eregi to return CRITICAL if found, OK if not.
|
||||
http_invertregex | **Optional.** Changes behaviour of http_expect_body_regex and http_expect_body_eregi to return CRITICAL if found, OK if not.
|
||||
http_warn_time | **Optional.** The warning threshold.
|
||||
http_critical_time | **Optional.** The critical threshold.
|
||||
http_expect | **Optional.** Comma-delimited list of strings, at least one of them is expected in the first (status) line of the server response. Default: HTTP/1.
|
||||
|
|
@ -2046,7 +2046,7 @@ http_useragent | **Optional.** String to be sent in http header as Use
|
|||
http_header | **Optional.** Any other tags to be sent in http header.
|
||||
http_extendedperfdata | **Optional.** Print additional perfdata. Defaults to "false".
|
||||
http_onredirect | **Optional.** How to handle redirect pages. Possible values: "ok" (default), "warning", "critical", "follow", "sticky" (like follow but stick to address), "stickyport" (like sticky but also to port)
|
||||
http_pagesize | **Optional.** Minim page size required:Maximum page size required.
|
||||
http_pagesize | **Optional.** Minimum page size required:Maximum page size required.
|
||||
http_timeout | **Optional.** Seconds before connection times out.
|
||||
|
||||
|
||||
|
|
@ -2235,7 +2235,7 @@ snmp_oid | **Required.** The SNMP OID.
|
|||
snmp_community | **Optional.** The SNMP community. Defaults to "public".
|
||||
snmp_warn | **Optional.** The warning threshold.
|
||||
snmp_crit | **Optional.** The critical threshold.
|
||||
snmp_string | **Optional.** Return OK state if the string exact match with the output value
|
||||
snmp_string | **Optional.** Return OK state if the string matches exactly with the output value
|
||||
snmp_ereg | **Optional.** Return OK state if extended regular expression REGEX matches with the output value
|
||||
snmp_eregi | **Optional.** Return OK state if case-insensitive extended REGEX matches with the output value
|
||||
snmp_label | **Optional.** Prefix label for output value
|
||||
|
|
@ -2280,7 +2280,7 @@ Custom Attributes:
|
|||
|
||||
Name | Description
|
||||
---------------------|--------------
|
||||
dns_lookup | **Optional.** The hostname or IP to query the dns for. Defaults to $host_name$.
|
||||
dns_lookup | **Optional.** The hostname or IP to query the DNS for. Defaults to $host_name$.
|
||||
dns_server | **Optional.** The DNS server to query. Defaults to the server configured in the OS.
|
||||
dns_expected_answer | **Optional.** The answer to look for. A hostname must end with a dot.
|
||||
dns_authoritative | **Optional.** Expect the server to send an authoritative answer.
|
||||
|
|
@ -2453,7 +2453,7 @@ snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol.
|
|||
snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
|
||||
snmp_warn | **Optional.** The warning threshold. Change the `snmp_load_type` var to "netsl" for using 3 values.
|
||||
snmp_crit | **Optional.** The critical threshold. Change the `snmp_load_type` var to "netsl" for using 3 values.
|
||||
snmp_load_type | **Optional.** Load type. Defaults to "stand". Check all available types int the [snmp load](http://nagios.manubulon.com/snmp_load.html) documentation.
|
||||
snmp_load_type | **Optional.** Load type. Defaults to "stand". Check all available types in the [snmp load](http://nagios.manubulon.com/snmp_load.html) documentation.
|
||||
snmp_perf | **Optional.** Enable perfdata values. Defaults to "true".
|
||||
|
||||
#### <a id="plugin-check-command-snmp-memory"></a> snmp-memory
|
||||
|
|
@ -2497,7 +2497,7 @@ snmp_login | **Optional.** SNMP version 3 username. Defaults to "sn
|
|||
snmp_password | **Required.** SNMP version 3 password. No value defined as default.
|
||||
snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to "false".
|
||||
snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
|
||||
snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default..
|
||||
snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
|
||||
snmp_warn | **Optional.** The warning threshold.
|
||||
snmp_crit | **Optional.** The critical threshold.
|
||||
snmp_storage_name | **Optional.** Storage name. Default to regex "^/$$". More options available in the [snmp storage](http://nagios.manubulon.com/snmp_storage.html) documentation.
|
||||
|
|
|
|||
|
|
@ -112,13 +112,17 @@ Examples:
|
|||
|
||||
Verify the following configuration
|
||||
|
||||
* Is the host/service the `enable_notifications` attribute set, and if, to which value?
|
||||
* Is the host/service `enable_notifications` attribute set, and if, to which value?
|
||||
* Do the notification attributes `states`, `types`, `period` match the notification conditions?
|
||||
* Do the user attributes `states`, `types`, `period` match the notification conditions?
|
||||
* Are there any notification `begin` and `end` times configured?
|
||||
* Make sure the [notification](#features) feature is enabled.
|
||||
* Does the referenced NotificationCommand work when executed as Icinga user on the shell?
|
||||
|
||||
If notifications are to be sent via mail make sure that the mail program specified exists.
|
||||
The name and location depends on the distribution so the preconfigured setting might have to be
|
||||
changed on your system.
|
||||
|
||||
Examples:
|
||||
|
||||
# icinga2 feature enable notification
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ Some specific migration steps will be still required to be done manually,
|
|||
especially if you want to preserve your existing file layout, or any other
|
||||
object specific policies.
|
||||
|
||||
If you encounter a bug, please open an issue at https://dev.icinga.org
|
||||
If you encounter a bug, please open an issue at https://dev.icinga.org.
|
||||
|
||||
### <a id="manual-config-migration"></a> Manual Config Migration
|
||||
|
||||
|
|
@ -1257,7 +1257,7 @@ accordingly.
|
|||
|
||||
### <a id="differences-1x-2-groups"></a> Groups
|
||||
|
||||
In Icinga 2 hosts, services and users are added to groups using the `groups`
|
||||
In Icinga 2 hosts, services, and users are added to groups using the `groups`
|
||||
attribute in the object. The old way of listing all group members in the group's
|
||||
`members` attribute is available through `assign where` and `ignore where`
|
||||
conditions.
|
||||
|
|
@ -1364,7 +1364,7 @@ All state and type filter use long names OR'd with a pipe together
|
|||
states = [ Warning, Unknown, Critical ]
|
||||
filters = [ Problem, Recovery, FlappingStart, FlappingEnd, DowntimeStart, DowntimeEnd, DowntimeRemoved ]
|
||||
|
||||
Icinga 2 adds more fine-grained type filters for acknowledgements, downtime
|
||||
Icinga 2 adds more fine-grained type filters for acknowledgements, downtime,
|
||||
and flapping type (start, end, ...).
|
||||
|
||||
### <a id="differences-1x-2-dependencies-parents"></a> Dependencies and Parents
|
||||
|
|
@ -1438,7 +1438,7 @@ Unlike Icinga 1.x the Icinga 2 daemon reload happens asynchronously.
|
|||
* validation NOT ok: child process terminates, parent process continues with old configuration state
|
||||
(this is ESSENTIAL for the [cluster config synchronisation](#cluster-zone-config-sync))
|
||||
* validation ok: child process signals parent process to terminate and save its current state
|
||||
(all events til now) into the icinga2 state file
|
||||
(all events until now) into the icinga2 state file
|
||||
* parent process shuts down writing icinga2.state file
|
||||
* child process waits for parent process gone, reads the icinga2 state file and synchronizes all historical and status data
|
||||
* child becomes the new session leader
|
||||
|
|
@ -1487,7 +1487,7 @@ popular broker modules was implemented for Icinga 2:
|
|||
Icinga 1.x uses the native "obsess over host/service" method which requires the NSCA addon
|
||||
passing the slave's check results passively onto the master's external command pipe.
|
||||
While this method may be used for check load distribution, it does not provide any configuration
|
||||
distribution out-of-the-box. Furthermore comments, downtimes and other stateful runtime data is
|
||||
distribution out-of-the-box. Furthermore comments, downtimes, and other stateful runtime data is
|
||||
not synced between the master and slave nodes. There are addons available solving the check
|
||||
and configuration distribution problems Icinga 1.x distributed monitoring currently suffers from.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue