granicus.if.org Git - icinga2/blob - doc/13-addons.md

   1 # <a id="addons"></a> Icinga 2 Addons
   2
   3 ## <a id="addons-graphing"></a> Graphing
   4
   5 ### <a id="addons-graphing-pnp"></a> PNP
   6
   7 [PNP](http://www.pnp4nagios.org) is a graphing addon.
   8
   9 [PNP](http://www.pnp4nagios.org) is an addon which adds a graphical representation of the performance data collected
  10 by the monitoring plugins. The data is stored as rrd (round robin database) files.
  11
  12 Use your distribution's package manager to install the `pnp4nagios` package.
  13
  14 If you're planning to use it, configure it to use the
  15 [bulk mode with npcd and npcdmod](http://docs.pnp4nagios.org/pnp-0.6/modes#bulk_mode_with_npcd_and_npcdmod)
  16 in combination with Icinga 2's [PerfdataWriter](14-features.md#performance-data). NPCD collects the performance
  17 data files which Icinga 2 generates.
  18
  19 Enable performance data writer in icinga 2
  20
  21     # icinga2 feature enable perfdata
  22
  23 Configure npcd to use the performance data created by Icinga 2:
  24
  25     vim /etc/pnp4nagios/npcd.cfg
  26
  27 Set `perfdata_spool_dir = /var/spool/icinga2/perfdata` and restart the `npcd` daemon.
  28
  29 There's also an Icinga Web 2 module for direct PNP graph integration
  30 available at [Icinga Exchange](https://exchange.icinga.org/icinga/PNP).
  31
  32 More information on [action_url as attribute](13-addons.md#addons-graphing-pnp-action-url)
  33 and [graph template names](13-addons.md#addons-graphing-pnp-custom-templates).
  34
  35
  36 ### <a id="addons-graphing-graphite"></a> Graphite
  37
  38 [Graphite](http://graphite.readthedocs.org/en/latest/) is a time-series database
  39 storing collected metrics and making them available through restful apis
  40 and web interfaces.
  41
  42 Graphite consists of 3 software components:
  43
  44 * carbon -- a Twisted daemon that listens for time-series data
  45 * whisper -- a simple database library for storing time-series data (similar in design to RRD)
  46 * graphite webapp -- a Django webapp that renders graphs on-demand using Cairo
  47
  48 Use the [GraphiteWriter](14-features.md#graphite-carbon-cache-writer) feature
  49 for sending real-time metrics from Icinga 2 to Graphite.
  50
  51     # icinga2 feature enable graphite
  52
  53 There are Graphite addons available for collecting the performance data files too (e.g. `Graphios`).
  54
  55 A popular alternative frontend for Graphite is for example [Grafana](http://grafana.org).
  56
  57 ### <a id="addons-graphing-influxdb"></a> InfluxDB
  58
  59 [InfluxDB](https://influxdb.com) is a time series, metrics, and analytics database.
  60 It’s written in Go and has no external dependencies.
  61
  62 Use the [InfluxdbWriter](14-features.md#influxdb-writer) feature
  63 for sending real-time metrics from Icinga 2 to InfluxDB.
  64
  65     # icinga2 feature enable influxdb
  66
  67 A popular frontend for InfluxDB is for example [Grafana](http://grafana.org).
  68
  69 ## <a id="addons-visualization"></a> Visualization
  70
  71 ### <a id="addons-visualization-reporting"></a> Icinga Reporting
  72
  73 By enabling the [DB IDO](14-features.md#db-ido) feature you can use the
  74 [Icinga Reporting package](https://wiki.icinga.org/display/howtos/Setting+up+Icinga+with+Reporting).
  75
  76 ### <a id="addons-visualization-nagvis"></a> NagVis
  77
  78 By using either [Livestatus](14-features.md#setting-up-livestatus) or
  79 [DB IDO](14-features.md#db-ido) as a backend you can create your own network maps
  80 based on your monitoring configuration and status data using [NagVis](http://www.nagvis.org).
  81
  82 The configuration in nagvis.ini.php should look like this for Livestatus for example:
  83
  84     [backend_live_1]
  85     backendtype="mklivestatus"
  86     socket="unix:/var/run/icinga2/cmd/livestatus"
  87
  88 If you are planning an integration into Icinga Web 2, look at [this module](https://github.com/Icinga/icingaweb2-module-nagvis).
  89
  90 ### <a id="addons-visualization-thruk"></a> Thruk
  91
  92 [Thruk](http://www.thruk.org) is an alternative web interface which can be used with Icinga 2
  93 and the [Livestatus](14-features.md#setting-up-livestatus) feature.
  94
  95 ## <a id="log-monitoring"></a> Log Monitoring
  96
  97 Using [Logstash](https://www.elastic.co/guide/en/logstash/current/introduction.html) or
  98 [Graylog](https://www.graylog.org) in your infrastructure and correlate events with your monitoring
  99 is even simpler these days.
 100
 101 * Use the `GelfWriter` feature to write Icinga 2's check and notification events to Graylog or Logstash.
 102 * Configure the logstash `nagios` output to send passive traps to Icinga 2 using the external command pipe.
 103 * Execute a plugin to check Graylog alert streams.
 104
 105 More details can be found in [this blog post](https://www.icinga.org/2014/12/02/team-icinga-at-osmc-2014/).
 106
 107 ## <a id="notification-scripts-interfaces"></a> Notification Scripts and Interfaces
 108
 109 There's a variety of resources available, for example different notification scripts such as:
 110
 111 * E-Mail ([examples](3-monitoring-basics.md#notifications) provided)
 112 * SMS
 113 * Pager (XMPP, etc.)
 114 * Twitter
 115 * IRC
 116 * Ticket systems
 117 * etc.
 118
 119 Additionally external services can be [integrated with Icinga 2](https://www.icinga.org/icinga/integration/):
 120
 121 * [Pagerduty](https://www.icinga.org/partners/pagerduty/)
 122 * [VictorOps](https://www.icinga.org/partners/victorops/)
 123 * [StackStorm](https://www.icinga.org/partners/stackstorm/)
 124
 125 More information can be found on the [Icinga Website](https://www.icinga.org/)
 126 and the [Icinga Wiki](https://wiki.icinga.org/display/howtos/Home).
 127
 128 ## <a id="configuration-tools"></a> Configuration Management Tools
 129
 130 If you require your favourite configuration tool to export the Icinga 2 configuration, please get in
 131 touch with their developers. The Icinga project does not provide a configuration web interface
 132 yet. Follow the [Icinga Blog](https://www.icinga.org/blog/) for updates on this topic.
 133
 134 If you're looking for puppet manifests, chef cookbooks, ansible recipes, etc. -- we're happy
 135 to integrate them upstream, so please get in touch with the [Icinga team](https://www.icinga.org/community/get-involved/).
 136
 137 These tools are currently in development and require feedback and tests:
 138
 139 * [Ansible Roles](https://github.com/Icinga/icinga2-ansible)
 140 * [Puppet Module](https://github.com/Icinga/puppet-icinga2)
 141 * [Chef Cookbook](https://github.com/Icinga/chef-icinga2)
 142
 143 ## <a id="addon-integration-hints"></a> More Addon Integration Hints
 144
 145 ### <a id="addons-graphing-pnp-action-url"></a> PNP Action Url
 146
 147 They work in a similar fashion for Icinga 2 and are used for 1.x web interfaces (Icinga Web 2 doesn't require
 148 the action url attribute in its own module).
 149
 150     template Service "pnp-hst" {
 151       action_url = "/pnp4nagios/graph?host=$HOSTNAME$"
 152     }
 153
 154     template Service "pnp-svc" {
 155       action_url = "/pnp4nagios/graph?host=$HOSTNAME$&srv=$SERVICEDESC$"
 156     }
 157
 158 ### <a id="addons-graphing-pnp-custom-templates"></a> PNP Custom Templates with Icinga 2
 159
 160 PNP automatically determines the graph template from the check command name (or the argument's name).
 161 This behavior changed in Icinga 2 compared to Icinga 1.x. Though there are certain possibilities to
 162 fix this:
 163
 164 * Create a symlink for example from the `templates.dist/check_ping.php` template to the actual check name in Icinga 2 (`templates/ping4.php`)
 165 * Pass the check command name inside the [format template configuration](14-features.md#writing-performance-data-files)
 166
 167 The latter becomes difficult with agent based checks like NRPE or SSH where the first command argument acts as
 168 graph template identifier. There is the possibility to define the pnp template name as custom attribute
 169 and use that inside the formatting templates as `SERVICECHECKCOMMAND` for instance.
 170
 171 Example for services:
 172
 173     # vim /etc/icinga2/features-enabled/perfdata.conf
 174
 175     service_format_template = "DATATYPE::SERVICEPERFDATA\tTIMET::$icinga.timet$\tHOSTNAME::$host.name$\tSERVICEDESC::$service.name$\tSERVICEPERFDATA::$service.perfdata$\tSERVICECHECKCOMMAND::$service.check_command$$pnp_check_arg1$\tHOSTSTATE::$host.state$\tHOSTSTATETYPE::$host.state_type$\tSERVICESTATE::$service.state$\tSERVICESTATETYPE::$service.state_type$"
 176
 177     # vim /etc/icinga2/conf.d/services.conf
 178
 179     template Service "pnp-svc" {
 180       action_url = "/pnp4nagios/graph?host=$HOSTNAME$&srv=$SERVICEDESC$"
 181       vars.pnp_check_arg1 = ""
 182     }
 183
 184     apply Service "nrpe-check" {
 185       import "pnp-svc"
 186       check_command = nrpe
 187       vars.nrpe_command = "check_disk"
 188
 189       vars.pnp_check_arg1 = "!$nrpe_command$"
 190     }
 191
 192 If there are warnings about unresolved macros, make sure to specify a default value for `vars.pnp_check_arg1` inside the
 193
 194 In PNP, the custom template for nrpe is then defined in `/etc/pnp4nagios/custom/nrpe.cfg`
 195 and the additional command arg string will be seen in the xml too for other templates.