granicus.if.org Git - icinga2/blob - 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?](https://www.icinga.org/icinga/faq/)
  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="how-to-report-bug-feature-requests"></a> How to Report a Bug or Feature Request
  44
  45 More details in the [Icinga FAQ](https://www.icinga.org/icinga/faq/).
  46
  47 * [Register](https://exchange.icinga.org/authentication/register) an Icinga account.
  48 * Create a new issue at the [Icinga 2 Development Tracker](https://dev.icinga.org/projects/i2).
  49 * When reporting a bug, please include the details described in the [Troubleshooting](#troubleshooting-information-required) chapter (version, configs, logs, etc).
  50
  51 ## <a id="demo-vm"></a> Demo VM
  52
  53 Icinga 2 is available as [Vagrant Demo VM](#vagrant).
  54
  55 ## <a id="whats-new"></a> What's new
  56
  57 ### What's New in Version 2.2.0
  58
  59 #### Changes
  60
  61 * DB IDO schema update to version `1.12.0`
  62     * schema files in `lib/db_ido_{mysql,pgsql}/schema` (source)
  63     * Table `programstatus`: New column `program_version`
  64     * Table `customvariables` and `customvariablestatus`: New column `is_json` (required for custom attribute array/dictionary support)
  65 * New CLI commands #7245
  66     * `icinga2 feature {enable,disable}` replaces `icinga2-{enable,disable}-feature` script  #7250
  67     * `icinga2 object list` replaces `icinga2-list-objects` script  #7251
  68     * `icinga2 pki` replaces` icinga2-build-{ca,key}` scripts  #7247
  69     * `icinga2 repository` manages `/etc/icinga2/repository.d` which must be included in `icinga2.conf` #7255
  70     * `icinga2 node` cli command provides node (master, satellite, agent) setup (wizard) and management functionality #7248
  71     * bash auto-completion & terminal colors #7396
  72 * Configuration
  73     * Former `localhost` example host is now defined in [hosts.conf](#hosts-conf) #7594
  74     * All example services moved into advanced apply rules in [services.conf](#services-conf)
  75     * Updated downtimes configuration example in [downtimes.conf](#downtimes-conf) #7472
  76     * Updated notification apply example in [notifications.conf](#notifications-conf) #7594
  77     * Support for object attribute 'zone' #7400
  78     * Support setting object variables in apply rules #7479
  79     * Support arrays and dictionaries in custom attributes #6544 #7560
  80     * Add [apply for rules](#using-apply-for) for advanced dynamic object generation #7561
  81 * Cluster
  82     * Add CSR Auto-Signing support using generated ticket #7244
  83 * Perfdata
  84     * PerfdataWriter: Don't change perfdata, pass through from plugins #7268
  85     * GraphiteWriter: Add warn/crit/min/max perfdata and downtime_depth stats values #7366 #6946
  86 * Packages
  87     * `python-icinga2` package dropped in favor of integrated cli commands #7245
  88     * Windows Installer for the agent parts #7243
  89
  90 > **Note**
  91 >
  92 >  Please remove `conf.d/hosts/localhost*` after verifying your updated configuration!
  93
  94 #### Issues
  95
  96
  97
  98 ### Archive
  99
 100 Please check the `ChangeLog` file.
 101
 102 ## <a id="icinga2-in-a-nutshell"></a> Icinga 2 in a Nutshell
 103
 104 * Use [Packages](#getting-started)
 105
 106 Look for available packages on http://packages.icinga.org or ask your distribution's maintainer.
 107 Compiling from source is not recommended.
 108
 109 * Real Distributed Architecture
 110
 111 [Cluster](#distributed-monitoring-high-availability) model for distributed setups, load balancing
 112 and High-Availability installations (or a combination of them). On-demand configuration
 113 synchronisation between zones is available, but not mandatory (for example when config management
 114 tools such as Puppet are used). Secured by SSL x509 certificates, supporting IPv4 and IPv6.
 115 High Availability for DB IDO: Only active on the current zone master, failover happens automatically.
 116
 117 * Monitoring Remote Clients
 118
 119 Built on proven [cluster](#distributed-monitoring-high-availability) stack, [Icinga 2 clients](#icinga2-remote-client-monitoring)
 120 can be installed acting as remote satellite or agent. Secured communication by SSL x509 certificates,
 121 install them with [cli commands](#cli-commands), and configure them either locally with
 122 discovery on the master, or use them for executing checks and event handlers remotely.
 123
 124
 125 * High Performance
 126
 127 Multithreaded and scalable for small embedded systems as well as large scale environments.
 128 Running checks every second is no longer a problem and enables real-time monitoring capabilities.
 129 Checks, notifications and event handlers [do not block Icinga 2](#differences-1x-2-async-event-execution)
 130 in its operation. Same goes for performance data writers and the external command pipe, or any
 131 file writers on disk (`statusdata`).
 132 Unlike Icinga 1.x the [daemon reload](#differences-1x-2-real-reload) happens asynchronously.
 133 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.
 134 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.
 135 That way you are not blind (anymore) during a configuration reload and benefit from a real scalable architecture.
 136
 137 * Integrated CLI with Bash Auto-Completion
 138
 139 Enable only the [features](#cli-command-feature) which are currently disabled,
 140 [list objects](#cli-command-object) generated from [apply rules](#using-apply) or
 141 [generate SSL x509 certificates](#cli-command-pki) for remote clients or cluster setup.
 142 Start/stop the Icinga 2 [daemon](#cli-command-daemon) or validate your configuration,
 143 [manage and install](#cli-command-node) remote clients and service discovery helped
 144 with black- and whitelists.
 145
 146 * Modular & flexible [features](#features)
 147
 148 Enable only the features you require. Want to use Icinga Web 2 with DB IDO but no status data?
 149 No problem! Just enable ido-mysql and disable statusdata. Another example: Graphite should be enabled
 150 on a dedicated cluster node. Enable it over there and point it to the carbon cache socket.
 151
 152 Combine Icinga 2 Core with web user interfaces: Use [Icinga Web 2](#setting-up-icingaweb2), but also
 153 Web 1.x or Classic UI or your own preferred addon.
 154
 155 * Native support for the [Livestatus protocol](#setting-up-livestatus)
 156
 157 In Icinga2, the 'Livestatus' protocol is available for use as either a UNIX, or TCP socket.
 158
 159 * Native support for [Graphite](#graphite-carbon-cache-writer)
 160
 161 Icinga 2 still supports writing performance data files for graphing addons, but also adds the
 162 capability of writing performance data directly into a Graphite TCP socket simplifying realtime
 163 monitoring graphs.
 164
 165 * Dynamic configuration language
 166
 167 Simple [apply](#using-apply) and [assign](#group-assign) rules for creating configuration object
 168 relationships based on patterns. More advanced features for dynamic object generation using
 169 [apply for rules](#using-apply-for) helped with arrays and dictionaries for
 170 [custom attributes](#custom-attributes-apply).
 171 Supported with [duration literals](#duration-literals) for interval
 172 attributes, [expression operators](#expression-operators), [function calls](#function-calls) for
 173 pattern and regex matching and (global) [constants](#constants).
 174 [Check command configuration](#plugin-check-commands) for common plugins is shipped with Icinga 2 as part of the [Icinga Template Library](#itl).
 175
 176 * Revamped Commands
 177
 178 One command to rule them all - supporting optional and conditional [command arguments](#command-arguments).
 179 [Environment variables](#command-environment-variables) exported on-demand populated with
 180 runtime evaluated macros.
 181 Three types of commands used for different actions: checks, notifications and events.
 182 Check timeout for commands instead of a global option. Commands also have custom attributes allowing
 183 you to specify default values.
 184 There is no plugin output or performance data length restriction anymore compared to Icinga 1.x.
 185
 186 * Custom Runtime Macros
 187
 188 Access [custom attributes](#custom-attributes) with their short name, for example $mysql_user$,
 189 or any object attribute, for example $host.notes$. Additional macros with runtime and statistic
 190 information are available as well. Use these [runtime macros](#runtime-custom-attributes) in
 191 the command line, environment variables and custom attribute assignments.
 192
 193 * Notifications simplified
 194
 195 Multiple [notifications](#notifications) for one host or service with existing users
 196 and notification commands. No more duplicated contacts for different notification types.
 197 Telling notification filters by state and type, even more fine-grained than Icinga 1.x.
 198 [Escalation notifications](#notification-escalations) and [delayed notifications](#first-notification-delay)
 199 are just notifications with an additional begin and/or end time attribute.
 200
 201 * Dependencies between Hosts and Services
 202
 203 Classic [dependencies](#dependencies) between host and parent hosts, and services and parent services work the
 204 same way as "mixed" dependencies from a service to a parent host and vice versa. Host checks
 205 depending on an upstream link port (as service) are not a problem anymore.
 206 No more additional parents settings - host dependencies already define the host parent relationship
 207 required for network reachability calculations.
 208 Set parent host/services based on [host/service custom attributes](#dependencies-apply-custom-attributes)
 209 generated from your cloud inventory or CMDB and make your dependency rules simple and short.
 210
 211 * [Recurring Downtimes](#recurring-downtimes)
 212
 213 Forget using cronjobs to set up recurring downtime - you can configure them as Icinga 2 configuration
 214 objects and specify their active time window.
 215
 216 * Embedded Health Checks
 217
 218 No more external statistic tool but an [instance](#itl-icinga) and [cluster](#itl-cluster) health
 219 check providing direct statistics as performance data for your graphing addon, for example Graphite.
 220
 221 * Compatibility with Icinga 1.x
 222
 223 All known interfaces are optionally available: [status files](#status-data), [logs](#compat-logging),
 224 [DB IDO](#configuring-ido) MySQL/PostgreSQL, [performance data](#performance-data),
 225 [external command pipe](#external-commands) and for migration reasons a
 226 [checkresult file reader](#check-result-files) too.
 227 All [Monitoring Plugins](#setting-up-check-plugins) can be integrated into Icinga 2 with
 228 newly created check command configuration if not already provided.
 229 [Configuration migration](#configuration-migration) is possible through an external migration tool.
 230
 231 Detailed [migration hints](#manual-config-migration-hints) explain migration of the Icinga 1.x
 232 configuration objects into the native Icinga 2 configuration schema.
 233 Additional information on the differences is documented in the [migration](#differences-1x-2) chapter.
 234
 235 * Configuration Syntax Highlighting
 236
 237 Icinga 2 ships [syntax highlighting](#configuration-syntax-highlighting) for `vim` and `nano` to help
 238 edit your configuration.
 239
 240 * Puppet modules, Chef Cookbooks, Ansible Playbooks, Salt Formulas, etc
 241
 242 This is a constant work-in-progress. For details checkout https://dev.icinga.org/projects/icinga-tools
 243 If you want to contribute to these projects, do not hesitate to contact us at https://support.icinga.org
 244
 245 * [Vagrant Demo VM](#vagrant)
 246
 247 Used for demo cases and development tests. Get Icinga 2 running within minutes and spread the #monitoringlove
 248 to your friends and colleagues.