]> granicus.if.org Git - icinga2/blob - doc/1-about.md
Docs: fix some typos.
[icinga2] / doc / 1-about.md
1 # <a id="about-icinga2"></a> About Icinga 2
2
3 ## <a id="what-is-icinga2"></a> What is Icinga 2?
4
5 Icinga 2 is an open source monitoring system which checks the availability of your
6 network resources, notifies users of outages, and generates performance data for reporting.
7
8 Scalable and extensible, Icinga 2 can monitor large, complex environments across
9 multiple locations.
10
11 ## <a id="licensing"></a> Licensing
12
13 Icinga 2 and the Icinga 2 documentation are licensed under the terms of the GNU
14 General Public License Version 2, you will find a copy of this license in the
15 LICENSE file included in the source package.
16
17 ## <a id="support"></a> Support
18
19 Support for Icinga 2 is available in a number of ways. Please have a look at
20 the support overview page at [https://support.icinga.org].
21
22 ## <a id="contribute"></a> Contribute
23
24 There are many ways to contribute to Icinga - whether it be sending patches, testing,
25 reporting bugs, or reviewing and updating the documentation. Every contribution
26 is appreciated!
27
28 Please get in touch with the Icinga team at [https://www.icinga.org/community/].
29
30 ## <a id="development"></a> Icinga 2 Development
31
32 You can follow Icinga 2's development closely by checking
33 out these resources:
34
35 * [Development Bug Tracker](https://dev.icinga.org/projects/i2): [How to report a bug?](http://www.icinga.org/faq/how-to-report-a-bug/)
36 * Git Repositories: [main mirror on icinga.org](https://git.icinga.org/?p=icinga2.git;a=summary) [release mirror at github.com](https://github.com/Icinga/icinga2)
37 * (Git Checkins Mailinglist](https://lists.icinga.org/mailman/listinfo/icinga-checkins)
38 * [Development](https://lists.icinga.org/mailman/listinfo/icinga-devel) and [Users](https://lists.icinga.org/mailman/listinfo/icinga-users) Mailinglists
39 * [#icinga-devel on irc.freenode.net](http://webchat.freenode.net/?channels=icinga-devel) including a Git Commit Bot
40
41 For general support questions, please refer to the [community support channels](https://support.icinga.org).
42
43 ## <a id="demo-vm"></a> Demo VM
44
45 Icinga 2 is available as [Vagrant Demo VM](#vagrant).
46
47 ## <a id="whats-new"></a> What's new
48
49 ### What's New in Version 2.0.0
50
51 Lots of things. Please read [Icinga 2 in a nutshell](#icinga2-in-a-nutshell).
52
53 #### Changes
54
55 ### Archive
56
57 Please check the `ChangeLog` file.
58
59 ## <a id="icinga2-in-a-nutshell"></a> Icinga 2 in a Nutshell
60
61 * Use [Packages](#getting-started)
62
63 Look for available packages on [http://packages.icinga.org] or ask your distribution's maintainer.
64 Compiling from source is not recommended.
65
66 * Real Distributed Architecture
67
68 [Cluster](#distributed-monitoring-high-availability) model for distributed setups, load balancing
69 and High-Availability installations (or a combination of them). On-demand configuration
70 synchronisation between zones is available, but not mandatory (for example when config management
71 tools such as Puppet are used). Secured by SSL x509 certificates, supporting IPv4 and IPv6.
72 High Availability for DB IDO: Only active on the current zone master, failover happens automatically.
73
74 * High Performance
75
76 Multithreaded and scalable for small embedded systems as well as large scale environments.
77 Running checks every second is no longer a problem and enables real-time monitoring capabilities.
78 Unlike Icinga 1.x the [daemon reload](#differences-1x-2-real-reload) happens asynchronously.
79 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.
80 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.
81 That way you are not blind (anymore) during a configuration reload and benefit from a real scalable architecture.
82
83
84 * Modular & flexible [features](#features)
85
86 Enable only the features you require. Want to use Icinga Web 2 with DB IDO but no status data?
87 No problem! Just enable ido-mysql and disable statusdata. Another example: Graphite should be enabled
88 on a dedicated cluster node. Enable it over there and point it to the carbon cache socket.
89
90 * Native support for the [Livestatus protocol](#setting-up-livestatus)
91
92 In Icinga2, the 'Livestatus' protocol is available for use as either a UNIX, or TCP socket.
93
94 * Native support for [Graphite](#graphite-carbon-cache-writer)
95
96 Icinga 2 still supports writing performance data files for graphing addons, but also adds the
97 capability of writing performance data directly into a Graphite TCP socket simplifying realtime
98 monitoring graphs.
99
100 * Dynamic configuration language
101
102 Simple [apply](#using-apply) and [assign](#group-assign) rules for creating configuration object
103 relationships based on patterns. Supported with [duration literals](#duration-literals) for interval
104 attributes, [expression operators](#expression-operators), [function calls](#function-calls) for
105 pattern and regex matching and (global) [constants](#constants).
106 Sample configuration for common plugins is shipped with Icinga 2 as part of the [Icinga Template Library](#itl).
107
108 * Revamped Commands
109
110 One command to rule them all - supporting optional and conditional [command arguments](#command-arguments).
111 [Environment variables](#command-environment-variables) exported on-demand populated with
112 runtime evaluated macros.
113 Three types of commands used for different actions: checks, notifications and events.
114 Check timeout for commands instead of a global option. Commands also have custom attributes allowing
115 you to specify default values.
116 There is no plugin output or performance data length restriction anymore compared to Icinga 1.x.
117
118 * Custom Runtime Macros
119
120 Access [custom attributes](#custom-attributes) with their short name, for example $mysql_user$,
121 or any object attribute, for example $host.notes$. Additional macros with runtime and statistic
122 information are available as well. Use these [runtime macros](#runtime-custom-attributes) in
123 the command line, environment variables and custom attribute assignments.
124
125 * Notifications simplified
126
127 Multiple [notifications](#notifications) for one host or service with existing users
128 and notification commands. No more duplicated contacts for different notification types.
129 Telling notification filters by state and type, even more fine-grained than Icinga 1.x.
130 [Escalation notifications](#notification-escalations) and [delayed notifications](#first-notification-delay)
131 are just notifications with an additional begin and/or end time attribute.
132
133 * Dependencies between Hosts and Services
134
135 Classic [dependencies](#dependencies) between host and parent hosts, and services and parent services work the
136 same way as "mixed" dependencies from a service to a parent host and vice versa. Host checks
137 depending on an upstream link port (as service) are not a problem anymore.
138 No more additional parents settings - host dependencies already define the host parent relationship
139 required for network reachability calculations.
140
141 * [Recurring Downtimes](#recurring-downtimes)
142
143 Forget using cronjobs to set up recurring downtime - you can configure them as Icinga 2 configuration
144 objects and specify their active time window.
145
146 * Embedded Health Checks
147
148 No more external statistic tool but an [instance](#itl-icinga) and [cluster](#itl-cluster) health
149 check providing direct statistics as performance data for your graphing addon, for example Graphite.
150
151 * Compatibility with Icinga 1.x
152
153 All known interfaces are optionally available: [status files](#status-data), [logs](#compat-logging),
154 [DB IDO](#configuring-ido) MySQL/PostgreSQL, [performance data](#performance-data),
155 [external command pipe](#external-commands) and for migration reasons a
156 [checkresult file reader](#check-result-files) too.
157 All [Monitoring Plugins](#setting-up-check-plugins) can be integrated into Icinga 2 with
158 newly created check command configuration if not already provided.
159 [Configuration migration](#configuration-migration) is possible through an external migration tool.
160
161 Detailed [migration hints](#manual-config-migration-hints) explain migration the Icinga 1.x
162 configuration objects into the native Icinga 2 configuration schema.
163 Additional information on the differences is documented in the [migration](#differences-1x-2) chapter.
164
165 * Configuration Syntax Highlighting
166
167 Icinga 2 ships [syntax highlighting](#configuration-syntax-highlighting) for `vim` and `nano` to help
168 edit your configuration.
169
170 * Puppet modules, Chef Cookbooks, Ansible Playbooks, Salt Formulas, etc
171
172 This is a constant work-in-progress. For details checkout [https://dev.icinga.org/projects/icinga-tools].
173 If you want to contribute to these projects, do not hesitate to contact us at [https://support.icinga.org].
174
175 * [Vagrant Demo VM](#vagrant)
176
177 Used for demo cases and development tests. Get Icinga 2 running within minutes and spread the #monitoringlove
178 to your friends and colleagues.
179
180
181