View source for Icinga

'''Icinga''' ( http://www.icinga.org/ ) is a host and service monitoring software using a binary daemon, some cgi scripts for the web interface and binaries plugins to check various things. Basically, automated testing of our site that screams and sends up alarms when it fails.
It originated as a fork of the earlier project "Nagios", from which WMF transitioned in 2013.

It can be set to monitor services such as ssh, squid status, mysql socket as well as # of user logged in, load, disk usage. There are two levels of alarms (warning, critical) and the notification system is fully customizable (groups of users, notified by email / irc / pager, stop notifying after x alarm...).

Our installation can be found at https://icinga.wikimedia.org which is currently an alias to machine [[einsteinium]].

:''(April 2013) The rest of this page needs to be updated for icinga''
{{Old-doc}}

== Quick summary ==

* In order to set downtime / ack alerts you need to login which is done over https
* Nagios configuration files are automatically generated by /home/w/conf/nagios/conf.php (on any host with NFS home mounted) and synched over to Spence.
* MRTG was setup and will display Nagios usage data (useful to see if Nagios is actually doing what it is supposed to be doing) - https://nagios.wikimedia.org/stats/ -
* Ganglia and Wikitech are loosely integrated with most hosts (G and W icons next to the host name respectively) and will display the Ganglia data of that host or its associated wikitech page if SPOF.  
* There is an icinga-wm bot in #wikimedia-operations that will echo whatever Icinga alerts on (see below)
* Merlin (Module for Endless Redundancy and Load balancing In Nagios) was installed and configured but is not being used at this time.
* Nagios has shortcuts in the side panel for most of Wikimedia's infrastructure monitoring
* On Spence, the nagios install is located in /usr/local/nagios. 
* On Spence, the nagios config files are located in /etc/nagios (but you probably don't want to edit anything there)
* On Spence, the HTTP interface is configured in /usr/local/nagios/share

== Installation ==

=== On the server ===
Install package from source found at http://www.nagios.org/download/core/thanks/ (both core and plugins packages are needed)

After installing, do this:

 cp /home/wikipedia/conf/nagios/* /etc/nagios/
 service start nagios

and you're away.

=== On each client ===

'''Ubuntu:'''
 
 apt-get update
 apt-get -y install nagios-nrpe-server nagios-plugins
 scp fenari:/home/wikipedia/conf/nagios/nrpe-debian.cfg /etc/nagios/nrpe.cfg
 invoke-rc.d nagios-nrpe-server restart

'''Solaris:'''

 pkgadd -d http://toolserver.org/~rriver/TSnrpe.pkg
 pkgadd -d http://toolserver.org/~rriver/TSnagios-plugins.pkg

The right answers are: all, yes, all, yes, yes.

 mv /lib/svc/method/nagios-nrpe /lib/svc/method/nagios-nrpe.old
 sed 's/nrpe.cfg -dn/nrpe.cfg -d/' /lib/svc/method/nagios-nrpe.old > /lib/svc/method/nagios-nrpe
 chmod a+x /lib/svc/method/nagios-nrpe
 scp fenari:/home/wikipedia/conf/nagios/nrpe-solaris.cfg /etc/opt/ts/nrpe/nrpe.cfg
 scp fenari:/home/wikipedia/conf/nagios/check-zfs /opt/local/bin/
 svcadm -v enable nrpe

If you're installing on a server with no internet access, you can use a local path to the pkg file instead.

== Wikimedia-fication ==

=== Customization ===

   * Logo: yeah... had to put it somewhere to show our 'leetness, so it is in /usr/local/nagios/share/images on Spence
   * Theme: I prefer a black theme. This is controlled in the CSS in /usr/local/nagios/share/stylesheets
   * Links to other services: this is controlled by /usr/local/nagios/share/side.php

=== ADDONS === 

   * Merlin

Merlin Is an addon for Nagios that provides ease of integration and redundancy across multiple Nagios instances. Usually, we will want to have a Nagios installation in each Datacenter, and each instance should be able to talk to the other, share data, and act as a backup should one fail. This is in essence what Merlin offers. The interresting thing about Merlin is that it stores everything in a mysql DB, from host config, to statuses. This is a lot easier to use to parse data that Nagios' own files, which is why it was installed in the first place. However, at this moment nothing is making use of Merlin, and it is just there 'in case'. Find more information about Merlin at http://www.op5.org/community/projects/merlin. 

   * Ganglia / wikitech integration

I wrote a little perl script that parses ganglia data from Spence (/var/lib/ganglia) and tries its best to match up Ganlia hostnames with Nagios hosts definition. In most cases it will work as advertised. The same goes for wikitech. Most servers don't have a wikitech entry associated with them, but some do. Most legacy systems and SPOF should have an entry. 

This script is located on Nagios in /etc/nagios/generate_ext-info.pl and runs automagically when sync in called.

== Paging / Alert System Details ==

Our icinga installation sends SMS pages via email to SMS gateways.  The file listing each contact is in the 'nagios' directory in private repo modules.  Look for 'contacts.cfg'  All alerts are emailed to a

* Most USA based cellular carriers tend to offer an email to sms gateway.  Use these if they are offered, as they tend to not charge for use.
** T-Mobile = 10digitphone@tmomail.net, Verizon = 10digitphone@@vtext.com.
* International (outside the USA) cellular carriers will need to use the @text.aql.com email address.
* If the icinga master changes, the login/sender details will need to be changed on the AQL portal.  Failure to change this will result in no alerts going out via AQL.
** Their system is setup to not just allow anyone to email via their gateway, it has to be setup for the host sending the alerts.

== Configuration ==
There are two ways to setup monitoring: using the old PHP script, and using Puppet.

=== PHP script ===
There's a configurator script for adding hosts, host groups, services and service groups at /home/wikipedia/conf/nagios/conf.php . Run it somewhere with PHP CLI installed, i.e. '''[[fenari]]'''. The configurator writes to a file called hosts.cfg in the current directory.

 cd /home/wikipedia/conf/nagios
 ./sync

Most host groups (the ones in $hostGroups) are based on dsh node group files. This is preferred for maintainability reasons, if such a node group exists, otherwise you can list miscellaneous hosts inline using $listedHosts. Some service groups (e.g. Apache and Squid) are just replicas of the host groups, others (such as Lucene and Memcached) are taken from the MediaWiki configuration. Services may also be listed inline using $listedServices, but again, this is not preferred.

Other configuration should be done by editing the *.cfg files on NFS and then copying to [[spence]]. Keeping two up-to-date copies like this protects us against failure of the monitoring host or NFS. (Note: the Sync command actually replicates every .cfg to Spence)

If nagios refuses to restart due to a configuration error, you can get more information by running this on the monitoring host (Spence):

 nagios -v /etc/nagios/nagios.cfg

The error messages can be cryptic at times.

=== Puppet ===
Puppet is being integrated with Nagios as well, in file <tt>manifests/nagios.pp</tt>. To monitor the availability of a host, simply define the following anywhere under its node definition (i.e. in site.pp or included classes):
 monitor_host { $hostname: }

To monitor a service, e.g. SSH, use something like the following:
 monitor_service { "ssh": description => "SSH status", check_command => "check_ssh" }

=== Custom Checks ===

Custom checks can be found on the private [[svn-private | svn]] repository under '''ops/nagios-checks'''

Examples include:

* check_stomp.pl 
* check_all_memcached.php

=== Grafana ===
See [[Grafana.wikimedia.org#Alerts (with notifications via Icinga)|Alerts (with notifications via Icinga)]].

To monitor an grafana dashboard's alerts, use something like the following:
 monitoring::grafana_alert { 'db/my-dashboard': contact_group   => 'my-team', }

== Authentication ==

To add a user or update a password:

# Log in to Spence
# Run <tt>htpasswd /usr/local/nagios/etc/htpasswd.users ''&lt;user>''</tt>


== IRC notification ==

There's a contact called "irc" in a contact group called "admins" which currently does the IRC notification. Messages are appended to /var/log/nagios/irc.log and picked up by an IRC client. Our IRC client ([[ircecho]]) can be started with:

 /usr/local/bin/start-nagios-bot

Which is just the shell one-liner:

 su -s/bin/sh -c'tail -n0 -f /var/log/nagios/irc.log | /home/wikipedia/bin/ircecho \#wikimedia-tech nagios-wm irc.freenode.net &' nobody > /dev/null 2>&1

== Hostgroups ==

Hostgroups are configured on operations/puppet repository, on hieradata/common/monitoring.yaml

== Acknowledgement logic ==
From Nagios Wiki (but this was just on Google Cache and the original site seemed gone, so pasted it here)
*'''There is a difference between sticky and non-sticky acknowledgements'''
<pre>
From Nagios 3.2.3.

Assuming you have a service with notifications enabled for all states with a max retry attempts of 1, these are the notifications you should get based on the following transitions:

#service in OK
#service goes into WARNING - notification sent
#non-sticky acknowledgement applied
#service goes into CRITICAL. Acknowledgement removed. Notification sent
#non-sticky acknowledgement applied
#service goes into WARNING. Acknowledgement removed. Notification sent
#non-sticky acknowledgement applied
#service goes into CRITICAL. Acknowledgement removed. Notification sent
#service goes into OK. Recovery notification sent 


This is the flow if sticky acknowledgements are used:

#service in OK
#service goes into WARNING - notification sent
#sticky acknowledgement applied
#service goes into CRITICAL. No notification sent
#service goes into WARNING. No notification sent
#service goes into CRITICAL. No notification sent
#service goes into OK. Recovery notification sent 
</pre>

== Scheduling downtimes with a shell command ==

Put multiple hosts into a scheduled downtime, from now on for the next 3 days. Example used on Labs Nagios:

nagios command file is a named pipe at /var/lib/nagios/rw/nagios.cmd

<pre>
for host in huggle-wa-w1 puppet-lucid turnkey-1 pad2 webserver-lcarr asher1 dumpster01 dumps-4 ; do
printf "[%lu] SCHEDULE_HOST_DOWNTIME;$host;$(date +%s);1332479449;1;0;259200;Dzahn;down to save memory on virt3 having RAM issues\n" $(date +%s) \
> /var/lib/nagios/rw/nagios.cmd ; done
</pre>

After a few seconds you should see something like this in /var/log/icinga/icinga.log (on einsteinium)

 [1332220596] HOST DOWNTIME ALERT: dumpster01;STARTED; Host has entered a period of scheduled downtime

<pre>
Command Format:
SCHEDULE_HOST_DOWNTIME;<host_name>;<start_time>;<end_time>;<fixed>;<trigger_id>;<duration>;<author>;<comment>
</pre>

quote: <i>If the "fixed" argument is set to one (1), downtime will start and end at the times specified by the "start" and "end" arguments. Otherwise, downtime will begin between the "start" and "end" times and last for "duration" seconds. The "start" and "end" arguments are specified in time_t format (seconds since the UNIX epoch). The specified host downtime can be triggered by another downtime entry if the "trigger_id" is set to the ID of another scheduled downtime entry. Set the "trigger_id" argument to zero (0) if the downtime for the specified host should not be triggered by another downtime entry.</i>

== Adding a new contact ==

If you want to add a new contact to Icinga you either need root privileges on production servers or ask somebody who does (members of the Operations team).


To request it from the Operations team, create a Phabricator ticket with the tags "Operations","Monitoring","Icinga" and describe the contact you want to be added.

You should add which notification method you want for this contact (email, IRC, SMS) and if you want 24/7 notifications or specific time periods only. If you want specific timeperiod you can pick (or add) one from ./modules/nagios_common/files/timeperiods.cfg in the public puppet repo.

Here is an [https://assets.nagios.com/downloads/nagioscore/docs/nagioscore/3/en/objectdefinitions.html#contact example contact and other options you have].

Once you have your new contact you can use it as a _member of a contactgroup_ in any manifest in the public puppet repo. For this part you don't need the access to the private repo anymore, you can just upload changes to Gerrit and find somebody to merge them.

== Disabling notifications programmatically ==

There many scenarios in which we may want a role to run its puppet logic to fully or partially provision its configuration, but not create alerts. Examples of this are: 
* Hosts in the process of being installed, set up and not yet servicing real traffic (but need to run puppet before they are 100% ready)
* Decommissioned hosts
* hosts with hardware problems for an extended period of time, and for which manual downtime would be inappropiate. 
* Canary hosts (like cp1008 aka pink unicorn)
* Spare systems that are running but are not really doing anything (aka spare::system role)

For discussions about this topic, see {{phabricator|T151632}}

To disable notifications on a host, set <code>notifications_enabled</code> on hiera to 0 (it defaults to 1). 
This is intended as a temporary (even if extended on time) measure- if no check should exist when the server is in full production, just do not add it in the first place or change its LEVEL.

For an example see https://phabricator.wikimedia.org/source/operations-puppet/browse/production/hieradata/hosts/cp1008.yaml;ec81a8ecf74e351613dd9d2d21df8a696c482a1f$12 . 

== Failover Icinga between the active and passive servers ==
'''[As of Jan. 2018]''' Icinga is currently installed in an active/passive configuration on <code>einsteinium.wikimedia.org</code> (eqiad, usually active) and <code>tegmen.wikimedia.org</code> (codfw, usually passive). Use <code>icinga.wikimedia.org</code> to check wich one is the active one at any given time with: <code>dig +short icinga.wikimedia.org</code>.

To failover between the two servers, follow these steps:
* Prepare a Puppet patch similar to https://gerrit.wikimedia.org/r/#/c/403627/
* Prepare a DNS patch similar to https://gerrit.wikimedia.org/r/#/c/403628/
* Announce the failover on IRC with some advance, and plan to avoid SWAT, Puppet SWAT and other ongoing maintenances or outages. Also avoid the time of the root's crontab on the passive host to sync Icinga state files (currently at minute 33 of each hour).
* Log on <code>#wikimedia-operations</code> the start of the failover 
* Disable Puppet on '''both hosts''': <code>sudo cumin 'O:icinga' "disable-puppet 'Failover Icinga - $USER'"</code>
* Merge, submit and puppet-merge the Puppet patch
* Enable and run Puppet on the '''previously active server''' to make it '''passive''', check for errors: <code>sudo run-puppet-agent -e "Failover Icinga - $USER"</code>
* On the '''previously passive server''', run the script to sync Icinga state files: <code>sudo sync_icinga_state</code>
* Merge and submit the DNS patch and deploy the change, see [[DNS#authdns-update]] or ask in <code>#wikimedia-traffic</code>
* On the '''previously passive server''', ensure that the DNS is updated, if not wait for the TTL to expire: <code>dig +short icinga.wikimedia.org</code>
* Enable and run Puppet on the '''previously passive server''' to make it '''active''', check for errors: <code>sudo run-puppet-agent -e "Failover Icinga - $USER"</code>
* Check that https://icinga.wikimedia.org/icinga/ is running properly. If you see a red message "Notifications are disabled", your browser is most likely still pointing to the old active server. Flush the DNS cache or wait the TTL to expire.
* Log on <code>#wikimedia-operations</code> the end of the failover 
[[Category:Bot and monitoring]]
[[Category:Services]]