.. _thebasics/notifications:

===============
 Notifications 
===============


Introduction 
=============

.. image:: /_static/images///official/images/objects-contacts.png
   :scale: 90 %

I've had a lot of questions as to exactly how notifications work. This will attempt to explain exactly when and how host and service notifications are sent out, as well as who receives them.

Notification escalations are explained :ref:`here <advanced/escalations>`.


When Do Notifications Occur? 
=============================

The decision to send out notifications is made in the service check and host check logic. Host and service notifications occur in the following instances...

  * When a hard state change occurs. More information on state types and hard state changes can be found :ref:`here <thebasics/statetypes>`.
  * When a host or service remains in a hard non-OK state and the time specified by the "notification_interval" option in the host or service definition has passed since the last notification was sent out (for that specified host or service).


Who Gets Notified? 
===================

Each host and service definition has a "contact_groups" option that specifies what contact groups receive notifications for that particular host or service. Contact groups can contain one or more individual contacts.

When Shinken sends out a host or service notification, it will notify each contact that is a member of any contact groups specified in the "contact_groups" option of the service definition. Shinken realizes that a contact may be a member of more than one contact group, so it removes duplicate contact notifications before it does anything.


What Filters Must Be Passed In Order For Notifications To Be Sent? 
===================================================================

Just because there is a need to send out a host or service notification doesn't mean that any contacts are going to get notified. There are several filters that potential notifications must pass before they are deemed worthy enough to be sent out. Even then, specific contacts may not be notified if their notification filters do not allow for the notification to be sent to them. Let's go into the filters that have to be passed in more detail...


Program-Wide Filter: 
=====================

The first filter that notifications must pass is a test of whether or not notifications are enabled on a program-wide basis. This is initially determined by the :ref:`"enable_notifications" <configuration/configmain-advanced#enable_notifications>` directive in the main config file, but may be changed during runtime from the web interface. If notifications are disabled on a program-wide basis, no host or service notifications can be sent out - period. If they are enabled on a program-wide basis, there are still other tests that must be passed...


Service and Host Filters: 
==========================

The first filter for host or service notifications is a check to see if the host or service is in a period of :ref:`scheduled downtime <advanced/downtime>`. It it is in a scheduled downtime, no one gets notified. If it isn't in a period of downtime, it gets passed on to the next filter. As a side note, notifications for services are suppressed if the host they're associated with is in a period of scheduled downtime.

The second filter for host or service notification is a check to see if the host or service is :ref:`flapping <advanced/flapping>` (if you enabled flap detection). If the service or host is currently flapping, no one gets notified. Otherwise it gets passed to the next filter.

The third host or service filter that must be passed is the host- or service-specific notification options. Each service definition contains options that determine whether or not notifications can be sent out for warning states, critical states, and recoveries. Similarly, each host definition contains options that determine whether or not notifications can be sent out when the host goes down, becomes unreachable, or recovers. If the host or service notification does not pass these options, no one gets notified. If it does pass these options, the notification gets passed to the next filter...

Notifications about host or service recoveries are only sent out if a notification was sent out for the original problem. It doesn't make sense to get a recovery notification for something you never knew was a problem.

The fourth host or service filter that must be passed is the time period test. Each host and service definition has a "notification_period" option that specifies which time period contains valid notification times for the host or service. If the time that the notification is being made does not fall within a valid time range in the specified time period, no one gets contacted. If it falls within a valid time range, the notification gets passed to the next filter...

If the time period filter is not passed, Shinken will reschedule the next notification for the host or service (if its in a non-OK state) for the next valid time present in the time period. This helps ensure that contacts are notified of problems as soon as possible when the next valid time in time period arrives.

The last set of host or service filters is conditional upon two things: (1) a notification was already sent out about a problem with the host or service at some point in the past and (2) the host or service has remained in the same non-OK state that it was when the last notification went out. If these two criteria are met, then Shinken will check and make sure the time that has passed since the last notification went out either meets or exceeds the value specified by the "notification_interval" option in the host or service definition. If not enough time has passed since the last notification, no one gets contacted. If either enough time has passed since the last notification or the two criteria for this filter were not met, the notification will be sent out! Whether or not it actually is sent to individual contacts is up to another set of filters...


Contact Filters: 
=================

At this point the notification has passed the program mode filter and all host or service filters and Shinken starts to notify :ref:`all the people it should <configobjects/contact>`. Does this mean that each contact is going to receive the notification? No! Each contact has their own set of filters that the notification must pass before they receive it.

Contact filters are specific to each contact and do not affect whether or not other contacts receive notifications.

The first filter that must be passed for each contact are the notification options. Each contact definition contains options that determine whether or not service notifications can be sent out for warning states, critical states, and recoveries. Each contact definition also contains options that determine whether or not host notifications can be sent out when the host goes down, becomes unreachable, or recovers. If the host or service notification does not pass these options, the contact will not be notified. If it does pass these options, the notification gets passed to the next filter...

Notifications about host or service recoveries are only sent out if a notification was sent out for the original problem. It doesn't make sense to get a recovery notification for something you never knew was a problem...

The last filter that must be passed for each contact is the time period test. Each contact definition has a "notification_period" option that specifies which time period contains valid notification times for the contact. If the time that the notification is being made does not fall within a valid time range in the specified time period, the contact will not be notified. If it falls within a valid time range, the contact gets notified!


Notification Methods 
=====================

You can have Shinken notify you of problems and recoveries pretty much anyway you want: pager, cellphone, email, instant message, audio alert, electric shocker, etc. How notifications are sent depends on the :ref:`notification commands <configobjects/command>` that are defined in your :ref:`object definition files <configuration/config>`.

If you install Shinken according to the :ref:`quickstart guide <gettingstarted/quickstart>`, it should be configured to send email notifications. You can see the email notification commands that are used by viewing the contents of the following file: "/etc/shinken/objects/commands.cfg".

Specific notification methods (paging, etc.) are not directly incorporated into the Shinken code as it just doesn't make much sense. The "core" of Shinken is not designed to be an all-in-one application. If service checks were embedded in Shinken's core it would be very difficult for users to add new check methods, modify existing checks, etc. Notifications work in a similar manner. There are a thousand different ways to do notifications and there are already a lot of packages out there that handle the dirty work, so why re-invent the wheel and limit yourself to a bike tire? Its much easier to let an external entity (i.e. a simple script or a full-blown messaging system) do the messy stuff. Some messaging packages that can handle notifications for pagers and cellphones are listed below in the resource section.


Notification Type Macro 
========================

When crafting your notification commands, you need to take into account what type of notification is occurring. The :ref:`$NOTIFICATIONTYPE$ <$NOTIFICATIONTYPE$>` macro contains a string that identifies exactly that. The table below lists the possible values for the macro and their respective descriptions:


================= ====================================================================================================================================================================================================================================================================
Value             Description                                                                                                                                                                                                                                                         
PROBLEM           A service or host has just entered (or is still in) a problem state. If this is a service notification, it means the service is either in a WARNING, UNKNOWN or CRITICAL state. If this is a host notification, it means the host is in a DOWN or UNREACHABLE state.
RECOVERY          A service or host recovery has occurred. If this is a service notification, it means the service has just returned to an OK state. If it is a host notification, it means the host has just returned to an UP state.                                                
ACKNOWLEDGEMENT   This notification is an acknowledgement notification for a host or service problem. Acknowledgement notifications are initiated via the web interface by contacts for the particular host or service.                                                               
FLAPPINGSTART     The host or service has just started :ref:`flapping <advanced/flapping>`.                                                                                                                                                                                     
FLAPPINGSTOP      The host or service has just stopped :ref:`flapping <advanced/flapping>`.                                                                                                                                                                                     
FLAPPINGDISABLED  The host or service has just stopped :ref:`flapping <advanced/flapping>` because flap detection was disabled..                                                                                                                                                
DOWNTIMESTART     The host or service has just entered a period of :ref:`scheduled downtime <advanced/downtime>`. Future notifications will be suppressed.
DOWNTIMESTOP      The host or service has just exited from a period of :ref:`scheduled downtime <advanced/downtime>`. Notifications about problems can now resume.                                                                                                              
DOWNTIMECANCELLED The period of :ref:`scheduled downtime <advanced/downtime>` for the host or service was just cancelled. Notifications about problems can now resume.                                                                                                          
================= ====================================================================================================================================================================================================================================================================

Detailled Notification Macros
==============================

Shinken introduces optional hosts and services macros that adds informations about which impacts have an object and what to do. That can be usefull when users that are notified, works for many customers and don't know very well every services. So that help users without knowledge to take a decision about it.

There are 3 objects macros to add on host or service object definition :
   - _DETAILLEDESC : provides detailled informations about monitored object.
   - _IMPACT : describes impacts that will have on infrastructure and help to specify severity.
   - _FIXACTIONS : How resolved the problem. Only available on service type objects.
  
::

  define service{
     service_description    Oracle-$KEY$-tnsping
     use                    oracle-service
     register               0
     host_name              oracle
     check_command          check_oracle_tnsping!$KEY$
     duplicate_foreach      _databases
     business_impact      5
     aggregation            /oracle/$KEY$/connectivity
  
     _DETAILLEDESC          Ping Oracle Listener
     _IMPACT                Critical: Can't network connect to database
     _FIXACTIONS            Start listener !
  }

  define host{
    host_name   hostA
    use         generic_host

    _DETAILLEDESC   This is control all the IT !!!
    _IMPACT         Critical: Nothing can work without it !
  }
  

Then all you got to do is to change notificationways of your contact to get detailled email notification, example :

::

  define contact{
    contact_name                    hotline
    use                             generic-contact
    email                           hotline@corporation.com
    can_submit_commands             1
    notificationways                detailled-email
  }


Helpful Resources 
==================

There are many ways you could configure Shinken to send notifications out. Its up to you to decide which method(s) you want to use. Once you do that you'll have to install any necessary software and configure notification commands in your config files before you can use them. Here are just a few possible notification methods:

  * Email
  * Pager
  * Phone (SMS)
  * WinPopup message
  * Yahoo, ICQ, or MSN instant message
  * Audio alerts
  * etc...

Basically anything you can do from a command line can be tailored for use as a notification command.

If you're looking for an alternative to using email for sending messages to your pager or cellphone, check out these packages. They could be used in conjunction with Shinken to send out a notification via a modem when a problem arises. That way you don't have to rely on email to send notifications out (remember, email may *not* work if there are network problems). I haven't actually tried these packages myself, but others have reported success using them...

  * `Gnokii`_ (SMS software for contacting Nokia phones via GSM network)
  * `QuickPage`_ (alphanumeric pager software)
  * `Sendpage`_ (paging software)

If you want to try out a non-traditional method of notification, you might want to mess around with audio alerts. If you want to have audio alerts played on the monitoring server (with synthesized speech), check out `Festival`_. If you'd rather leave the monitoring box alone and have audio alerts played on another box, check out the `Network Audio System (NAS)`_ and `rplay`_ projects.


.. _Gnokii: http://www.gnokii.org/
.. _Festival: http://www.cstr.ed.ac.uk/projects/festival/
.. _rplay: http://rplay.doit.org/
.. _Network Audio System (NAS): http://radscan.com/nas
.. _QuickPage: http://www.qpage.org/
.. _Sendpage: http://www.sendpage.org/
.. _SMSEagle: http://www.smseagle.eu/shinken.php
