mirror of https://github.com/Icinga/icinga2.git
51 lines
1.8 KiB
Markdown
51 lines
1.8 KiB
Markdown
## <a id="setting-up-livestatus"></a> Setting up Livestatus
|
|
|
|
The [MK Livestatus](http://mathias-kettner.de/checkmk_livestatus.html) project
|
|
implements a query protocol that lets users query their Icinga instance for
|
|
status information. It can also be used to send commands.
|
|
|
|
> **Tip**
|
|
>
|
|
> Only install the Livestatus feature if your web interface or addon requires
|
|
> you to do so (for example, [Icinga Web 2](#setting-up-icingaweb2)).
|
|
> [Icinga Classic UI](#setting-up-icinga-classic-ui) and [Icinga Web](#setting-up-icinga-web)
|
|
> do not use Livestatus as backend.
|
|
|
|
The Livestatus component that is distributed as part of Icinga 2 is a
|
|
re-implementation of the Livestatus protocol which is compatible with MK
|
|
Livestatus.
|
|
|
|
Details on the available tables and attributes with Icinga 2 can be found
|
|
in the [Livestatus Schema](#schema-livestatus) section.
|
|
|
|
You can enable Livestatus using icinga2-enable-feature:
|
|
|
|
# icinga2-enable-feature livestatus
|
|
|
|
After that you will have to restart Icinga 2:
|
|
|
|
# /etc/init.d/icinga2 restart
|
|
|
|
By default the Livestatus socket is available in `/var/run/icinga2/cmd/livestatus`.
|
|
|
|
In order for queries and commands to work you will need to add your query user
|
|
(e.g. your web server) to the `icingacmd` group:
|
|
|
|
# usermod -a -G icingacmd www-data
|
|
|
|
> **Note**
|
|
>
|
|
> Debian packages use `nagios` as default user/group. Therefore change `icingacmd` to
|
|
> `nagios`.
|
|
|
|
> **Note**
|
|
>
|
|
> Change "www-data" to the user you're using to run queries.
|
|
|
|
In order to use the historical tables provided by the livestatus feature (for example, the
|
|
`log` table) you need to have the `CompatLogger` feature enabled. By default these logs
|
|
are expected in `/var/log/icinga2/compat`. A different path can be set using the `compat_log_path`
|
|
configuration attribute.
|
|
|
|
# icinga2-enable-feature compatlog
|