1 # Icinga 2 Features <a id="icinga2-features"></a>
3 ## Logging <a id="logging"></a>
5 Icinga 2 supports three different types of logging:
8 * Syslog (on Linux/UNIX)
9 * Console logging (`STDOUT` on tty)
11 You can enable additional loggers using the `icinga2 feature enable`
12 and `icinga2 feature disable` commands to configure loggers:
15 ---------|------------
16 debuglog | Debug log (path: `/var/log/icinga2/debug.log`, severity: `debug` or higher)
17 mainlog | Main log (path: `/var/log/icinga2/icinga2.log`, severity: `information` or higher)
18 syslog | Syslog (severity: `warning` or higher)
20 By default file the `mainlog` feature is enabled. When running Icinga 2
21 on a terminal log messages with severity `information` or higher are
22 written to the console.
24 Packages will install a configuration file for logrotate on supported
25 platforms. This configuration ensures that the `icinga2.log`, `error.log` and
26 `debug.log` files are rotated on a daily basis.
28 ## DB IDO <a id="db-ido"></a>
30 The IDO (Icinga Data Output) feature for Icinga 2 takes care of exporting all
31 configuration and status information into a database. The IDO database is used
32 by Icinga Web 2 as data backend.
34 Details on the installation can be found in the [Configuring DB IDO](02-getting-started.md#configuring-db-ido-mysql)
35 chapter. Details on the configuration can be found in the
36 [IdoMysqlConnection](09-object-types.md#objecttype-idomysqlconnection) and
37 [IdoPgsqlConnection](09-object-types.md#objecttype-idopgsqlconnection)
38 object configuration documentation.
39 The DB IDO feature supports [High Availability](06-distributed-monitoring.md#distributed-monitoring-high-availability-db-ido) in
42 ### DB IDO Health <a id="db-ido-health"></a>
44 If the monitoring health indicator is critical in Icinga Web 2,
45 you can use the following queries to manually check whether Icinga 2
46 is actually updating the IDO database.
48 Icinga 2 writes its current status to the `icinga_programstatus` table
49 every 10 seconds. The query below checks 60 seconds into the past which is a reasonable
50 amount of time -- adjust it for your requirements. If the condition is not met,
51 the query returns an empty result.
55 > Use [check plugins](05-service-monitoring.md#service-monitoring-plugins) to monitor the backend.
57 Replace the `default` string with your instance name if different.
62 # mysql -u root -p icinga -e "SELECT status_update_time FROM icinga_programstatus ps
63 JOIN icinga_instances i ON ps.instance_id=i.instance_id
64 WHERE (UNIX_TIMESTAMP(ps.status_update_time) > UNIX_TIMESTAMP(NOW())-60)
65 AND i.instance_name='default';"
67 +---------------------+
68 | status_update_time |
69 +---------------------+
70 | 2014-05-29 14:29:56 |
71 +---------------------+
74 Example for PostgreSQL:
77 # export PGPASSWORD=icinga; psql -U icinga -d icinga -c "SELECT ps.status_update_time FROM icinga_programstatus AS ps
78 JOIN icinga_instances AS i ON ps.instance_id=i.instance_id
79 WHERE ((SELECT extract(epoch from status_update_time) FROM icinga_programstatus) > (SELECT extract(epoch from now())-60))
80 AND i.instance_name='default'";
83 ------------------------
84 2014-05-29 15:11:38+02
88 A detailed list on the available table attributes can be found in the [DB IDO Schema documentation](24-appendix.md#schema-db-ido).
90 ### DB IDO Cleanup <a id="db-ido-cleanup"></a>
92 Objects get deactivated when they are deleted from the configuration.
93 This is visible with the `is_active` column in the `icinga_objects` table.
94 Therefore all queries need to join this table and add `WHERE is_active=1` as
95 condition. Deleted objects preserve their history table entries for later SLA
98 Historical data isn't purged by default. You can enable the least
99 kept data age inside the `cleanup` configuration attribute for the
100 IDO features [IdoMysqlConnection](09-object-types.md#objecttype-idomysqlconnection)
101 and [IdoPgsqlConnection](09-object-types.md#objecttype-idopgsqlconnection).
103 Example if you prefer to keep notification history for 30 days:
107 notifications_age = 30d
108 contactnotifications_age = 30d
112 The historical tables are populated depending on the data `categories` specified.
113 Some tables are empty by default.
115 ### DB IDO Tuning <a id="db-ido-tuning"></a>
117 As with any application database, there are ways to optimize and tune the database performance.
119 General tips for performance tuning:
121 * [MariaDB KB](https://mariadb.com/kb/en/library/optimization-and-tuning/)
122 * [PostgreSQL Wiki](https://wiki.postgresql.org/wiki/Performance_Optimization)
124 Re-creation of indexes, changed column values, etc. will increase the database size. Ensure to
125 add health checks for this, and monitor the trend in your Grafana dashboards.
127 In order to optimize the tables, there are different approaches. Always keep in mind to have a
128 current backup and schedule maintenance downtime for these kind of tasks!
133 mariadb> OPTIMIZE TABLE icinga_statehistory;
138 > Tables might not support optimization at runtime. This can take a **long** time.
140 > `Table does not support optimize, doing recreate + analyze instead`.
142 If you want to optimize all tables in a specified database, there is a script called `mysqlcheck`.
143 This also allows to repair broken tables in the case of emergency.
146 mysqlcheck --optimize icinga
158 > Don't use `VACUUM FULL` as this has a severe impact on performance.
161 ## External Commands <a id="external-commands"></a>
165 > Please use the [REST API](12-icinga2-api.md#icinga2-api) as modern and secure alternative
166 > for external actions.
168 Icinga 2 provides an external command pipe for processing commands
169 triggering specific actions (for example rescheduling a service check
170 through the web interface).
172 In order to enable the `ExternalCommandListener` configuration use the
173 following command and restart Icinga 2 afterwards:
175 # icinga2 feature enable command
177 Icinga 2 creates the command pipe file as `/var/run/icinga2/cmd/icinga2.cmd`
178 using the default configuration.
180 Web interfaces and other Icinga addons are able to send commands to
181 Icinga 2 through the external command pipe, for example for rescheduling
182 a forced service check:
184 # /bin/echo "[`date +%s`] SCHEDULE_FORCED_SVC_CHECK;localhost;ping4;`date +%s`" >> /var/run/icinga2/cmd/icinga2.cmd
186 # tail -f /var/log/messages
188 Oct 17 15:01:25 icinga-server icinga2: Executing external command: [1382014885] SCHEDULE_FORCED_SVC_CHECK;localhost;ping4;1382014885
189 Oct 17 15:01:25 icinga-server icinga2: Rescheduling next check for service 'ping4'
191 A list of currently supported external commands can be found [here](24-appendix.md#external-commands-list-detail).
193 Detailed information on the commands and their required parameters can be found
194 on the [Icinga 1.x documentation](https://docs.icinga.com/latest/en/extcommands2.html).
196 ## Performance Data <a id="performance-data"></a>
198 When a host or service check is executed plugins should provide so-called
199 `performance data`. Next to that additional check performance data
200 can be fetched using Icinga 2 runtime macros such as the check latency
201 or the current service state (or additional custom attributes).
203 The performance data can be passed to external applications which aggregate and
204 store them in their backends. These tools usually generate graphs for historical
205 reporting and trending.
207 Well-known addons processing Icinga performance data are [PNP4Nagios](13-addons.md#addons-graphing-pnp),
208 [Graphite](13-addons.md#addons-graphing-graphite) or [OpenTSDB](14-features.md#opentsdb-writer).
210 ### Writing Performance Data Files <a id="writing-performance-data-files"></a>
212 PNP4Nagios and Graphios use performance data collector daemons to fetch
213 the current performance files for their backend updates.
215 Therefore the Icinga 2 [PerfdataWriter](09-object-types.md#objecttype-perfdatawriter)
216 feature allows you to define the output template format for host and services helped
217 with Icinga 2 runtime vars.
219 host_format_template = "DATATYPE::HOSTPERFDATA\tTIMET::$icinga.timet$\tHOSTNAME::$host.name$\tHOSTPERFDATA::$host.perfdata$\tHOSTCHECKCOMMAND::$host.check_command$\tHOSTSTATE::$host.state$\tHOSTSTATETYPE::$host.state_type$"
220 service_format_template = "DATATYPE::SERVICEPERFDATA\tTIMET::$icinga.timet$\tHOSTNAME::$host.name$\tSERVICEDESC::$service.name$\tSERVICEPERFDATA::$service.perfdata$\tSERVICECHECKCOMMAND::$service.check_command$\tHOSTSTATE::$host.state$\tHOSTSTATETYPE::$host.state_type$\tSERVICESTATE::$service.state$\tSERVICESTATETYPE::$service.state_type$"
222 The default templates are already provided with the Icinga 2 feature configuration
223 which can be enabled using
225 # icinga2 feature enable perfdata
227 By default all performance data files are rotated in a 15 seconds interval into
228 the `/var/spool/icinga2/perfdata/` directory as `host-perfdata.<timestamp>` and
229 `service-perfdata.<timestamp>`.
230 External collectors need to parse the rotated performance data files and then
231 remove the processed files.
233 ### Graphite Carbon Cache Writer <a id="graphite-carbon-cache-writer"></a>
235 While there are some [Graphite](13-addons.md#addons-graphing-graphite)
236 collector scripts and daemons like Graphios available for Icinga 1.x it's more
237 reasonable to directly process the check and plugin performance
238 in memory in Icinga 2. Once there are new metrics available, Icinga 2 will directly
239 write them to the defined Graphite Carbon daemon tcp socket.
241 You can enable the feature using
243 # icinga2 feature enable graphite
245 By default the [GraphiteWriter](09-object-types.md#objecttype-graphitewriter) feature
246 expects the Graphite Carbon Cache to listen at `127.0.0.1` on TCP port `2003`.
248 #### Current Graphite Schema <a id="graphite-carbon-cache-writer-schema"></a>
250 The current naming schema is defined as follows. The [Icinga Web 2 Graphite module](https://github.com/icinga/icingaweb2-module-graphite)
251 depends on this schema.
253 The default prefix for hosts and services is configured using
254 [runtime macros](03-monitoring-basics.md#runtime-macros)like this:
256 icinga2.$host.name$.host.$host.check_command$
257 icinga2.$host.name$.services.$service.name$.$service.check_command$
259 You can customize the prefix name by using the `host_name_template` and
260 `service_name_template` configuration attributes.
262 The additional levels will allow fine granular filters and also template
263 capabilities, e.g. by using the check command `disk` for specific
264 graph templates in web applications rendering the Graphite data.
266 The following characters are escaped in prefix labels:
268 Character | Escaped character
269 --------------|--------------------------
275 Metric values are stored like this:
277 <prefix>.perfdata.<perfdata-label>.value
279 The following characters are escaped in perfdata labels:
281 Character | Escaped character
282 --------------|--------------------------
288 Note that perfdata labels may contain dots (`.`) allowing to
289 add more subsequent levels inside the Graphite tree.
290 `::` adds support for [multi performance labels](http://my-plugin.de/wiki/projects/check_multi/configuration/performance)
291 and is therefore replaced by `.`.
293 By enabling `enable_send_thresholds` Icinga 2 automatically adds the following threshold metrics:
295 <prefix>.perfdata.<perfdata-label>.min
296 <prefix>.perfdata.<perfdata-label>.max
297 <prefix>.perfdata.<perfdata-label>.warn
298 <prefix>.perfdata.<perfdata-label>.crit
300 By enabling `enable_send_metadata` Icinga 2 automatically adds the following metadata metrics:
302 <prefix>.metadata.current_attempt
303 <prefix>.metadata.downtime_depth
304 <prefix>.metadata.acknowledgement
305 <prefix>.metadata.execution_time
306 <prefix>.metadata.latency
307 <prefix>.metadata.max_check_attempts
308 <prefix>.metadata.reachable
309 <prefix>.metadata.state
310 <prefix>.metadata.state_type
312 Metadata metric overview:
315 -------------------|------------------------------------------
316 current_attempt | current check attempt
317 max_check_attempts | maximum check attempts until the hard state is reached
318 reachable | checked object is reachable
319 downtime_depth | number of downtimes this object is in
320 acknowledgement | whether the object is acknowledged or not
321 execution_time | check execution time
322 latency | check latency
323 state | current state of the checked object
324 state_type | 0=SOFT, 1=HARD state
326 The following example illustrates how to configure the storage schemas for Graphite Carbon
330 # intervals like PNP4Nagios uses them per default
332 retentions = 1m:2d,5m:10d,30m:90d,360m:4y
335 ### InfluxDB Writer <a id="influxdb-writer"></a>
337 Once there are new metrics available, Icinga 2 will directly write them to the
338 defined InfluxDB HTTP API.
340 You can enable the feature using
342 # icinga2 feature enable influxdb
344 By default the [InfluxdbWriter](09-object-types.md#objecttype-influxdbwriter) feature
345 expects the InfluxDB daemon to listen at `127.0.0.1` on port `8086`.
347 Measurement names and tags are fully configurable by the end user. The InfluxdbWriter
348 object will automatically add a `metric` tag to each data point. This correlates to the
349 perfdata label. Fields (value, warn, crit, min, max, unit) are created from data if available
350 and the configuration allows it. If a value associated with a tag is not able to be
351 resolved, it will be dropped and not sent to the target host.
353 Backslashes are allowed in tag keys, tag values and field keys, however they are also
354 escape characters when followed by a space or comma, but cannot be escaped themselves.
355 As a result all trailling slashes in these fields are replaced with an underscore. This
356 predominantly affects Windows paths e.g. `C:\` becomes `C:_`.
358 The database is assumed to exist so this object will make no attempt to create it currently.
360 If [SELinux](22-selinux.md#selinux) is enabled, it will not allow access for Icinga 2 to InfluxDB until the [boolean](22-selinux.md#selinux-policy-booleans)
361 `icinga2_can_connect_all` is set to true as InfluxDB is not providing its own policy.
363 More configuration details can be found [here](09-object-types.md#objecttype-influxdbwriter).
365 #### Instance Tagging <a id="influxdb-writer-instance-tags"></a>
367 Consider the following service check:
370 apply Service "disk" for (disk => attributes in host.vars.disks) {
371 import "generic-service"
372 check_command = "disk"
373 display_name = "Disk " + disk
374 vars.disk_partitions = disk
375 assign where host.vars.disks
379 This is a typical pattern for checking individual disks, NICs, SSL certificates etc associated
380 with a host. What would be useful is to have the data points tagged with the specific instance
381 for that check. This would allow you to query time series data for a check on a host and for a
382 specific instance e.g. /dev/sda. To do this quite simply add the instance to the service variables:
385 apply Service "disk" for (disk => attributes in host.vars.disks) {
392 Then modify your writer configuration to add this tag to your data points if the instance variable
393 is associated with the service:
396 object InfluxdbWriter "influxdb" {
399 measurement = "$service.check_command$"
401 hostname = "$host.name$"
402 service = "$service.name$"
403 instance = "$service.vars.instance$"
410 ### Elastic Stack Integration <a id="elastic-stack-integration"></a>
412 [Icingabeat](https://github.com/icinga/icingabeat) is an Elastic Beat that fetches data
413 from the Icinga 2 API and sends it either directly to [Elasticsearch](https://www.elastic.co/products/elasticsearch)
414 or [Logstash](https://www.elastic.co/products/logstash).
418 * [Logstash output](https://github.com/Icinga/logstash-output-icinga) for the Icinga 2 API.
419 * [Logstash Grok Pattern](https://github.com/Icinga/logstash-grok-pattern) for Icinga 2 logs.
421 #### Elasticsearch Writer <a id="elasticsearch-writer"></a>
423 This feature forwards check results, state changes and notification events
424 to an [Elasticsearch](https://www.elastic.co/products/elasticsearch) installation over its HTTP API.
426 The check results include parsed performance data metrics if enabled.
430 > Elasticsearch 5.x or 6.x are required. This feature has been successfully tested with
431 > Elasticsearch 5.6.7 and 6.3.1.
435 Enable the feature and restart Icinga 2.
438 # icinga2 feature enable elasticsearch
441 The default configuration expects an Elasticsearch instance running on `localhost` on port `9200
442 and writes to an index called `icinga2`.
444 More configuration details can be found [here](09-object-types.md#objecttype-elasticsearchwriter).
446 #### Current Elasticsearch Schema <a id="elastic-writer-schema"></a>
448 The following event types are written to Elasticsearch:
450 * icinga2.event.checkresult
451 * icinga2.event.statechange
452 * icinga2.event.notification
454 Performance data metrics must be explicitly enabled with the `enable_send_perfdata`
457 Metric values are stored like this:
459 check_result.perfdata.<perfdata-label>.value
461 The following characters are escaped in perfdata labels:
463 Character | Escaped character
464 ------------|--------------------------
470 Note that perfdata labels may contain dots (`.`) allowing to
471 add more subsequent levels inside the tree.
472 `::` adds support for [multi performance labels](http://my-plugin.de/wiki/projects/check_multi/configuration/performance)
473 and is therefore replaced by `.`.
475 Icinga 2 automatically adds the following threshold metrics
478 check_result.perfdata.<perfdata-label>.min
479 check_result.perfdata.<perfdata-label>.max
480 check_result.perfdata.<perfdata-label>.warn
481 check_result.perfdata.<perfdata-label>.crit
483 ### Graylog Integration <a id="graylog-integration"></a>
485 #### GELF Writer <a id="gelfwriter"></a>
487 The `Graylog Extended Log Format` (short: [GELF](http://docs.graylog.org/en/latest/pages/gelf.html))
488 can be used to send application logs directly to a TCP socket.
490 While it has been specified by the [Graylog](https://www.graylog.org) project as their
491 [input resource standard](http://docs.graylog.org/en/latest/pages/sending_data.html), other tools such as
492 [Logstash](https://www.elastic.co/products/logstash) also support `GELF` as
493 [input type](https://www.elastic.co/guide/en/logstash/current/plugins-inputs-gelf.html).
495 You can enable the feature using
497 # icinga2 feature enable gelf
499 By default the `GelfWriter` object expects the GELF receiver to listen at `127.0.0.1` on TCP port `12201`.
500 The default `source` attribute is set to `icinga2`. You can customize that for your needs if required.
502 Currently these events are processed:
508 ### OpenTSDB Writer <a id="opentsdb-writer"></a>
510 While there are some OpenTSDB collector scripts and daemons like tcollector available for
511 Icinga 1.x it's more reasonable to directly process the check and plugin performance
512 in memory in Icinga 2. Once there are new metrics available, Icinga 2 will directly
513 write them to the defined TSDB TCP socket.
515 You can enable the feature using
517 # icinga2 feature enable opentsdb
519 By default the `OpenTsdbWriter` object expects the TSD to listen at
520 `127.0.0.1` on port `4242`.
522 The current naming schema is
524 icinga.host.<metricname>
525 icinga.service.<servicename>.<metricname>
527 for host and service checks. The tag host is always applied.
529 To make sure Icinga 2 writes a valid metric into OpenTSDB some characters are replaced
530 with `_` in the target name:
534 The resulting name in OpenTSDB might look like:
536 www-01 / http-cert / response time
537 icinga.http_cert.response_time
539 In addition to the performance data retrieved from the check plugin, Icinga 2 sends
540 internal check statistic data to OpenTSDB:
543 -------------------|------------------------------------------
544 current_attempt | current check attempt
545 max_check_attempts | maximum check attempts until the hard state is reached
546 reachable | checked object is reachable
547 downtime_depth | number of downtimes this object is in
548 acknowledgement | whether the object is acknowledged or not
549 execution_time | check execution time
550 latency | check latency
551 state | current state of the checked object
552 state_type | 0=SOFT, 1=HARD state
554 While reachable, state and state_type are metrics for the host or service the
555 other metrics follow the current naming schema
557 icinga.check.<metricname>
559 with the following tags
562 --------|------------------------------------------
563 type | the check type, one of [host, service]
564 host | hostname, the check ran on
565 service | the service name (if type=service)
569 > You might want to set the tsd.core.auto_create_metrics setting to `true`
570 > in your opentsdb.conf configuration file.
573 ## Livestatus <a id="setting-up-livestatus"></a>
575 The [MK Livestatus](https://mathias-kettner.de/checkmk_livestatus.html) project
576 implements a query protocol that lets users query their Icinga instance for
577 status information. It can also be used to send commands.
579 The Livestatus component that is distributed as part of Icinga 2 is a
580 re-implementation of the Livestatus protocol which is compatible with MK
585 > Only install the Livestatus feature if your web interface or addon requires
587 > [Icinga Web 2](02-getting-started.md#setting-up-icingaweb2) does not need
590 Details on the available tables and attributes with Icinga 2 can be found
591 in the [Livestatus Schema](24-appendix.md#schema-livestatus) section.
593 You can enable Livestatus using icinga2 feature enable:
595 # icinga2 feature enable livestatus
597 After that you will have to restart Icinga 2:
599 # systemctl restart icinga2
601 By default the Livestatus socket is available in `/var/run/icinga2/cmd/livestatus`.
603 In order for queries and commands to work you will need to add your query user
604 (e.g. your web server) to the `icingacmd` group:
606 # usermod -a -G icingacmd www-data
608 The Debian packages use `nagios` as the user and group name. Make sure to change `icingacmd` to
609 `nagios` if you're using Debian.
611 Change `www-data` to the user you're using to run queries.
613 In order to use the historical tables provided by the livestatus feature (for example, the
614 `log` table) you need to have the `CompatLogger` feature enabled. By default these logs
615 are expected to be in `/var/log/icinga2/compat`. A different path can be set using the
616 `compat_log_path` configuration attribute.
618 # icinga2 feature enable compatlog
621 ### Livestatus Sockets <a id="livestatus-sockets"></a>
623 Other to the Icinga 1.x Addon, Icinga 2 supports two socket types
625 * Unix socket (default)
628 Details on the configuration can be found in the [LivestatusListener](09-object-types.md#objecttype-livestatuslistener)
629 object configuration.
631 ### Livestatus GET Queries <a id="livestatus-get-queries"></a>
635 > All Livestatus queries require an additional empty line as query end identifier.
636 > The `nc` tool (`netcat`) provides the `-U` parameter to communicate using
639 There also is a Perl module available in CPAN for accessing the Livestatus socket
640 programmatically: [Monitoring::Livestatus](http://search.cpan.org/~nierlein/Monitoring-Livestatus-0.74/)
643 Example using the unix socket:
645 # echo -e "GET services\n" | /usr/bin/nc -U /var/run/icinga2/cmd/livestatus
647 Example using the tcp socket listening on port `6558`:
649 # echo -e 'GET services\n' | netcat 127.0.0.1 6558
651 # cat servicegroups <<EOF
656 (cat servicegroups; sleep 1) | netcat 127.0.0.1 6558
659 ### Livestatus COMMAND Queries <a id="livestatus-command-queries"></a>
661 A list of available external commands and their parameters can be found [here](24-appendix.md#external-commands-list-detail)
663 $ echo -e 'COMMAND <externalcommandstring>' | netcat 127.0.0.1 6558
666 ### Livestatus Filters <a id="livestatus-filters"></a>
670 Operator | Negate | Description
671 ----------|----------|-------------
674 =~ | !=~ | Equality ignoring case
675 ~~ | !~~ | Regex ignoring case
678 <= | | Less than or equal
679 >= | | Greater than or equal
682 ### Livestatus Stats <a id="livestatus-stats"></a>
684 Schema: "Stats: aggregatefunction aggregateattribute"
686 Aggregate Function | Description
687 -------------------|--------------
692 std | standard deviation
693 suminv | sum (1 / value)
694 avginv | suminv / count
695 count | ordinary default for any stats query if not aggregate function defined
700 Filter: has_been_checked = 1
701 Filter: check_type = 0
702 Stats: sum execution_time
704 Stats: sum percent_state_change
705 Stats: min execution_time
707 Stats: min percent_state_change
708 Stats: max execution_time
710 Stats: max percent_state_change
712 ResponseHeader: fixed16
714 ### Livestatus Output <a id="livestatus-output"></a>
718 CSV output uses two levels of array separators: The members array separator
719 is a comma (1st level) while extra info and host|service relation separator
720 is a pipe (2nd level).
722 Separators can be set using ASCII codes like:
724 Separators: 10 59 44 124
730 ### Livestatus Error Codes <a id="livestatus-error-codes"></a>
733 ----------|--------------
735 404 | Table does not exist
736 452 | Exception on query
738 ### Livestatus Tables <a id="livestatus-tables"></a>
740 Table | Join |Description
741 --------------|-----------|----------------------------
742 hosts | | host config and status attributes, services counter
743 hostgroups | | hostgroup config, status attributes and host/service counters
744 services | hosts | service config and status attributes
745 servicegroups | | servicegroup config, status attributes and service counters
746 contacts | | contact config and status attributes
747 contactgroups | | contact config, members
748 commands | | command name and line
749 status | | programstatus, config and stats
750 comments | services | status attributes
751 downtimes | services | status attributes
752 timeperiods | | name and is inside flag
753 endpoints | | config and status attributes
754 log | services, hosts, contacts, commands | parses [compatlog](09-object-types.md#objecttype-compatlogger) and shows log attributes
755 statehist | hosts, services | parses [compatlog](09-object-types.md#objecttype-compatlogger) and aggregates state change attributes
756 hostsbygroup | hostgroups | host attributes grouped by hostgroup and its attributes
757 servicesbygroup | servicegroups | service attributes grouped by servicegroup and its attributes
758 servicesbyhostgroup | hostgroups | service attributes grouped by hostgroup and its attributes
760 The `commands` table is populated with `CheckCommand`, `EventCommand` and `NotificationCommand` objects.
762 A detailed list on the available table attributes can be found in the [Livestatus Schema documentation](24-appendix.md#schema-livestatus).
765 ## Status Data Files <a id="status-data"></a>
769 > This feature is DEPRECATED and will be removed in Icinga 2 v2.11.
771 Icinga 1.x writes object configuration data and status data in a cyclic
772 interval to its `objects.cache` and `status.dat` files. Icinga 2 provides
773 the `StatusDataWriter` object which dumps all configuration objects and
774 status updates in a regular interval.
776 # icinga2 feature enable statusdata
778 If you are not using any web interface or addon which uses these files,
779 you can safely disable this feature.
781 ## Compat Log Files <a id="compat-logging"></a>
785 > This feature is DEPRECATED and will be removed in Icinga 2 v2.11.
787 The Icinga 1.x log format is considered being the `Compat Log`
788 in Icinga 2 provided with the `CompatLogger` object.
790 These logs are used for informational representation in
791 external web interfaces parsing the logs, but also to generate
792 SLA reports and trends.
793 The [Livestatus](14-features.md#setting-up-livestatus) feature uses these logs
794 for answering queries to historical tables.
796 The `CompatLogger` object can be enabled with
798 # icinga2 feature enable compatlog
800 By default, the Icinga 1.x log file called `icinga.log` is located
801 in `/var/log/icinga2/compat`. Rotated log files are moved into
802 `var/log/icinga2/compat/archives`.
804 ## Check Result Files <a id="check-result-files"></a>
808 > This feature is DEPRECATED and will be removed in Icinga 2 v2.11.
810 Icinga 1.x writes its check result files to a temporary spool directory
811 where they are processed in a regular interval.
812 While this is extremely inefficient in performance regards it has been
813 rendered useful for passing passive check results directly into Icinga 1.x
814 skipping the external command pipe.
816 Several clustered/distributed environments and check-aggregation addons
817 use that method. In order to support step-by-step migration of these
818 environments, Icinga 2 supports the `CheckResultReader` object.
820 There is no feature configuration available, but it must be defined
821 on-demand in your Icinga 2 objects configuration.
823 object CheckResultReader "reader" {
824 spool_dir = "/data/check-results"