From: Frank Brehm Date: Sat, 20 Nov 2010 20:09:10 +0000 (+0000) Subject: Added current state X-Git-Url: https://git.uhu-banane.org/?a=commitdiff_plain;h=ac0753e4463d508ec36dee1b9a212cea34637aee;p=my-stuff%2Fnagios.git Added current state git-svn-id: http://svn.brehm-online.com/svn/my-stuff/nagios/trunk@124 ec8d2aa5-1599-4edb-8739-2b3a1bc399aa --- diff --git a/bin/check_nagios_config.pl b/bin/check_nagios_config.pl new file mode 100755 index 0000000..b8bf27d --- /dev/null +++ b/bin/check_nagios_config.pl @@ -0,0 +1,43 @@ +#!/usr/bin/perl + +# $Id$ +# $URL$ + +use strict; +use 5.10.0; +use warnings; + +use FindBin; +use Data::Dumper; +use File::Find; +use File::Spec; +use File::Spec::Functions; +use Cwd 'abs_path'; + +BEGIN { + { + my $libdir = catfile( $FindBin::Bin, '..', 'lib' ); + if ( -d $libdir ) { + $libdir = abs_path($libdir); + unshift @INC, $libdir; + } + } +} + +$Data::Dumper::Indent = 1; +$Data::Dumper::Sortkeys = 1; + +$| = 1; + +my $Revisn = <<'ENDE'; + $Revision$ +ENDE +$Revisn =~ s/^.*:\s*(\S+)\s*\$.*/$1/s; +our $VERSION = "0.1." . $Revisn; + +#print "Includes: " . Dumper( \@INC ); + + + + +# vim: fileencoding=utf-8 syntax=perl ts=4 noai diff --git a/bin/check_nagios_config.py b/bin/check_nagios_config.py new file mode 100755 index 0000000..dc73f39 --- /dev/null +++ b/bin/check_nagios_config.py @@ -0,0 +1,29 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- + +import sys +from nagios.config import NagiosConfig, NagiosConfigError + +#print "Modul-Suchpfade:" +#for p in sys.path: +# print " -", p + +#print "Namen aus dem NagiosConfig-Objekt:" +#for name in dir(NagiosConfig): +# print " -", name +#print "" + +try: + nagios_conf = NagiosConfig() + nagios_conf.read() +except NagiosConfigError as e: + print >> sys.stderr, e + sys.exit(2) + + +#print "Nagios-Objekt: " + repr( nagios_conf ) + +print nagios_conf.dump_config() +nagios_conf.read_objects() + +# vim: fileencoding=utf-8 filetype=python ts=4 expandtab diff --git a/bin/nagios/__init__.py b/bin/nagios/__init__.py new file mode 100644 index 0000000..58e5493 --- /dev/null +++ b/bin/nagios/__init__.py @@ -0,0 +1,4 @@ +#!/usr/bin/python + + +# vim: fileencoding=utf-8 filetype=python ts=4 diff --git a/bin/nagios/__init__.pyc b/bin/nagios/__init__.pyc new file mode 100644 index 0000000..c9f7b03 Binary files /dev/null and b/bin/nagios/__init__.pyc differ diff --git a/bin/nagios/config.py b/bin/nagios/config.py new file mode 100644 index 0000000..9db8a4c --- /dev/null +++ b/bin/nagios/config.py @@ -0,0 +1,410 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- + +import os +import re +import sys +import warnings +import logging +import nagios.object.host + +class NagiosConfigError(Exception): + """Base class for exceptions in this module.""" + pass + +class NagiosConfig(object): + """Klasse zur Kapselung aller Dinge der Nagios-Konfiguration.""" + + # Konfigurationsverzeichnis von Nagios + conf_dir = os.sep + os.path.join('etc', 'nagios') + + # Basename der Nagios-Konfigurationsdatei + file_base = 'nagios.cfg' + + # Kompletter Pfad der Nagios-Konfigurationsdatei + file_name = os.path.join(conf_dir, file_base) + + # Inhalt der Konfiguration + conf = {} + + # Die Objekte aus der Konfiguration oder dem Cache im Rohformat + objects = {} + + # Die überprüften Objekte aus der Konfiguration + config_objects = {} + + #------------------------------------------------------ + def __repr__( self ): + "Dumper seiner selbst" + + dump = {} + dump['conf_dir'] = self.conf_dir + dump['file_base'] = self.file_base + dump['file_name'] = self.file_name + dump['conf'] = repr(self.conf) + dump['objects'] = repr(self.objects) + + return repr(dump) + + #------------------------------------------------------ + def __init__( self, new_file = file_name ): + "Konstruktor." + self.file_name = self.canonize_file(new_file) + self.conf = {} + self.objects = {} + self.config_objects = {} + + # Logging-Setup + self.logger = logging.getLogger('nagiosConfig') + self.logger.setLevel(logging.DEBUG) + + ch = logging.StreamHandler() + ch.setLevel(logging.DEBUG) + + formatter = logging.Formatter("%(name)s - %(funcName)s(%(lineno)d) - %(levelname)s - %(message)s") + ch.setFormatter(formatter) + + self.logger.addHandler(ch) + + #------------------------------------------------------ + def __del__( self ): + "Destruktor" + + self.logger.debug( "Hilfe - ich werde zerstört!!" ) + + #------------------------------------------------------ + def canonize_file( self, f ): + """Kanonisiert den übergebenen Dateinamen, indem er nicht-absoluten Dateinamen verabsolutiert""" + f = os.path.abspath(f); + f = self.search_conf(f) + return f + + #------------------------------------------------------ + def file( self, new_file = None ): + "Gibt den aktuellen Konfigurationsdateiname zururück bzw. setzt ihn." + old_name = self.file_name + if new_file is not None: + self.file_name = os.path.abspath(new_file) + return old_name + + #------------------------------------------------------ + def search_conf( self, f = None ): + "Sucht die Nagios-Konfigurationsdatei und speichert diese in self.file_name bzw. stirbt, wenn nicht gefunden." + + if f is None: f = self.file_name + if os.path.exists(f): + if os.path.isfile(f): + f = os.path.realpath(f) + self.file_name = f + return f + else: + raise NagiosConfigError( "Pfad '" + f + "' ist keine normale Datei." ) + + search_dirs = ( os.path.dirname(self.file_name), self.conf_dir, \ + os.sep + os.path.join( 'etc', 'nagios3'), \ + os.sep + os.path.join( 'etc', 'nagios'), \ + os.sep + os.path.join( 'usr', 'local', 'nagios', 'etc' ), \ + os.sep + os.path.join( 'usr', 'local', 'etc', 'nagios' ) ) + used_dirs = {} + #print repr(search_dirs) + + for path in search_dirs: + if not ( os.path.exists(path) and os.path.isdir(path) ): + continue + if path in used_dirs: continue + used_dirs[path] = 1 + print "Suche Konfig in Verzeichnis '" + path + "' ..." + my_file = os.path.join( path, 'nagios.cfg' ) + if os.path.exists(my_file) and os.path.isfile(my_file): + my_file = os.path.realpath(my_file) + self.file_name = my_file + return my_file + + raise NagiosConfigError( "Nagios-Konfigurationsdatei nicht gefunden." ) + return None + + #------------------------------------------------------ + def read( self ): + "Liest die in self.file_name hinterlegte Konfigurationsdatei ein und legt das Gelesene in self.conf ab" + + try: + file = open( self.file_name, 'rU' ) + except IOError as e: + raise NagiosConfigError( e ) + + self.conf = {} + + try: + for line in file: + self.perform_line( line ) + finally: + file.close() + + #------------------------------------------------------ + def perform_line( self, line ): + "Verarbeitet eine Konfigurationszeile und legt diese in self.conf ab." + + pattern_comment = re.compile( r'^\s*#.*', re.MULTILINE ); + + line = re.sub( r'^\s+', '', line, 0 ) + line = re.sub( r'\s+$', '', line, 0 ) + + if pattern_comment.search( line ): + return + + match = re.search( r'\s*(\w+)\s*=\s*(.*)', line ) + if match is not None: + key = match.group(1) + value = match.group(2) + #print "Gefunden - key: " + repr(key) + ", value: " + repr(value) + if key in self.conf: + #print "Eintrag Gefunden: " + repr( self.conf[key] ) + #print "Typ von self.conf[", key, "]: ", type( self.conf[key] ) + if not isinstance( self.conf[key], list ): + oldval = self.conf[key] + self.conf[key] = [ oldval ] + #print "Eintrag Umgewandelt: " + repr( self.conf[key] ) + self.conf[key].append(value) + else: + self.conf[key] = value + #print key + ": " + repr( self.conf[key] ) + + return + + #------------------------------------------------------ + def param( self, key ): + "Gibt den Inhalt der entsprechenden Konfiguration aus bzw. None, wenn nicht vorhanden." + + if not key in self.conf: + return None + + return self.conf[key] + + #------------------------------------------------------ + def dump_config( self ): + "Gibt den Inhalt der Konfiguration in gedumpter Form zurück." + + res = '{\n' + for key in sorted( self.conf.keys(), None, str.lower ): + res = res + " '" + key + "': " + if isinstance( self.conf[key], list ): + valdump = "[\n " + valdump = valdump + ",\n ".join( map( repr, self.conf[key] ) ) + valdump = valdump + "\n ]," + else: + valdump = repr( self.conf[key] ) + res = res + valdump + ",\n" + + + res = res + "}" + + return res + + #------------------------------------------------------ + def read_objects( self ): + "Liest die in der Konfiguration engegebenen Objekt-Kofigurations-Dateien ein" + + self.objects = {} + files = set([]) + dirs = set([]) + + # cfg_file auswerten + if 'cfg_file' in self.conf: + if isinstance( self.conf['cfg_file'], list ): + for item in self.conf['cfg_file']: + approved_file = self.check_cfg_file_syntax(item) + if approved_file: files.add(approved_file) + else: + approved_file = self.check_cfg_file_syntax( self.conf['cfg_file'] ) + if approved_file: files.add(approved_file) + + # cfg_dir auswerten + if 'cfg_dir' in self.conf: + if isinstance( self.conf['cfg_dir'], list ): + for item in self.conf['cfg_dir']: + approved_dir = self.check_cfg_file_syntax( item, True ) + if approved_dir: dirs.add(approved_dir) + else: + approved_dir = self.check_cfg_file_syntax( self.conf['cfg_dir'], True ) + if approved_dir: dirs.add(approved_dir) + + # Verzeichnisse rekursiv durchsteigen ... + for dir in dirs: + for root, found_dirs, found_files in os.walk( dir, followlinks = True): + for file in found_files: + file_absolute = os.path.join( root, file ) + if not os.path.exists(file_absolute) or not os.path.isfile(file_absolute): + continue + if not re.search( r'\.cfg$', file, re.IGNORECASE ): + continue + file_absolute = os.path.realpath(file_absolute) + files.add(file_absolute) + + #print repr(files) + for file_name in files: + self.read_objectfile(file_name) + + self.logger.debug( "Gelesene Objekte: {0!r}".format( self.objects ) ) + + return + + #------------------------------------------------------ + def read_objectfile( self, file_name ): + "Liest eine Datei mit Objektdefinitionen ein und legt diese unter self.objects ab." + + try: + file = open( file_name, 'rU' ) + except IOError as e: + raise NagiosConfigError( e ) + + cur_object = {} + in_block = False + object_type = None + pattern_comment = re.compile( r'^\s*#.*', re.MULTILINE ); + row_num = 0 + + try: + for line in file: + + row_num = row_num + 1 + line = re.sub( r'^\s+', '', line, 0 ) + line = re.sub( r'\s+$', '', line, 0 ) + if line == '': continue + #self.logger.debug( "Untersuche Zeile {0} in {1}: {2!r}".format( row_num, file_name, line ) ) + if pattern_comment.search( line ): continue + line = re.sub( r'\s*;(?:[^"]*(?:"[^"]*")?)*', '', line, 0 ) + if line == '': continue + #self.logger.debug( "Untersuche Zeile {0} in {1}: {2!r}".format( row_num, file_name, line ) ) + + if in_block: + + if line == '}': + in_block = False + if not object_type in self.objects: + self.objects[object_type] = [] + self.objects[object_type].append( cur_object ) + cur_object = {} + self.logger.debug( "Zeile {0} in {1}: Beende Block vom Type {2!r}".format( row_num, file_name, object_type ) ) + + else: + + ( key, value ) = self.check_object_file_entry( line, object_type, file_name, row_num ) + if ( key == None ): + self.logger.debug( "Nichts gefunden." ) + else: + self.logger.debug( "Gefunden: key: {0!r}, value: {1!r}".format( key, value ) ) + if key in cur_object: + self.logger.warn( "Doppelter Eintrag für Eigenschaft {0!r} von {1!r} in {2}({3}).".format( + key, object_type, file_name, row_num ) + else: + cur_object[key] = ( value, file, row_num ) + + else: + + match = re.search( r'^define\s+(\w+)\s*{$', line, re.IGNORECASE ) + if match is not None: + in_block = True + cur_object = {} + object_type = match.group(1).lower() + cur_object['__object_definition__'] = ( file, row_num ) + self.logger.debug( "Zeile {0} in {1}: Beginne Block vom Type {2!r}".format( row_num, file_name, object_type ) ) + continue + + self.logger.debug( "Ungültige Zeile {0} in {1} gefunden: {2!r}".format( row_num, file_name, line ) ) + + finally: + file.close() + + #------------------------------------------------------ + def verify_objects( self, as_cache_objects = False ): + "Überprüft die Syntax der eingelesenen Konfiguration" + + verify_success = True + self.config_objects = {} + + for object_type in self.objects: + + for definition in self.objects[object_type]: + + if object_type == 'host': + + ( identifier, struct ) = nagios.object.host.verify( definition, self.logger ) + + if identifier is None: + verify_success = False + continue + + if as_cache_objects: + if not 'host' in self.cache_objects: + self.cache_objects['host'] = {} + else: + if not 'host' in self.config_objects: + self.config_objects['host'] = {} + + if identifier in self.config_objects['host']: + ( file_name, rownum ) = definition['__object_definition__'] + msg = "Host-Objekt {0!r} ist bereits vorhanden, ".format( identifier ) + msg = msg + "neue Definition in {0}({1}) wird nicht beachtet.".format( file_name, rownum ) + self.logger.warn( msg ) + continue + + if as_cache_objects: + self.cache_objects['host'][identifier] = struct + else: + self.config_objects['host'][identifier] = struct + + if not verify_success: + raise NagiosConfigError( "Objektstruktur konnte nicht verifiziert werden." ) + + return True + + #------------------------------------------------------ + def check_object_file_entry( self, line, object_type, file_name, row_num ): + + line = re.sub( r'\s*;(?!.*").*$', '', line, 0 ) + if line == '': return ( None, None ) + + key = 'key{0!s}'.format( row_num ) + value = line + + match = re.search( r'^\s*(\w+)(?:\s+(.*))?', line ) + if match is None: + self.logger.error( "Konnte Zeile {0} in {1} nicht auswerten: {2!r}.".format( row_num, file_name, line ) ) + return ( None, None ) + + key = match.group(1) + value = match.group(2) + + return ( key, value ) + + #------------------------------------------------------ + def check_cfg_file_syntax( self, file, as_dir = False ): + "Checkt absolute Angabe und Vorhandensein der übergebenen Datei bzw. Verzeichnis" + + directive = 'cfg_file' + file_type = 'Datei' + if as_dir: + directive = 'cfg_dir' + file_type = 'Verzeichnis' + + if not os.path.isabs(file): + self.logger.error( "Keine absolute Pfadangabe in {0}={1}".format( directive, file ) ) + return None + + if not os.path.exists(file): + self.logger.error( "{0} {1} existiert nicht.".format( file_type, file ) ) + return None + + if as_dir: + if not os.path.isdir(file): + self.logger.error( "Verzeichnis {0} ist keine normales Verzeichnis.".format(file) ) + return None + else: + if not os.path.isfile(file): + self.logger.error( "Datei {0} ist keine normale Datei.".format(file) ) + return None + + return os.path.realpath(file) + + +# vim: fileencoding=utf-8 filetype=python ts=4 expandtab diff --git a/bin/nagios/config.pyc b/bin/nagios/config.pyc new file mode 100644 index 0000000..ba01b13 Binary files /dev/null and b/bin/nagios/config.pyc differ diff --git a/bin/nagios/object/__init__.py b/bin/nagios/object/__init__.py new file mode 100644 index 0000000..58e5493 --- /dev/null +++ b/bin/nagios/object/__init__.py @@ -0,0 +1,4 @@ +#!/usr/bin/python + + +# vim: fileencoding=utf-8 filetype=python ts=4 diff --git a/bin/nagios/object/__init__.pyc b/bin/nagios/object/__init__.pyc new file mode 100644 index 0000000..e210bd7 Binary files /dev/null and b/bin/nagios/object/__init__.pyc differ diff --git a/bin/nagios/object/host.py b/bin/nagios/object/host.py new file mode 100644 index 0000000..a5f5846 --- /dev/null +++ b/bin/nagios/object/host.py @@ -0,0 +1,103 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- + +import re + +def verfify( definition, logger ) +"Verifiziert einen übergebenen Definitionsblock als Nagios-Host." + + res = {} + identifier = None + +""" +define host{ + *host_name host_name + *alias alias + display_name display_name + *address address + parents host_names + hostgroups hostgroup_names + check_command command_name + initial_state [o,d,u] + *max_check_attempts # + check_interval # + retry_interval # + active_checks_enabled [0/1] + passive_checks_enabled [0/1] + *check_period timeperiod_name + obsess_over_host [0/1] + check_freshness [0/1] + freshness_threshold # + event_handler command_name + event_handler_enabled [0/1] + low_flap_threshold # + high_flap_threshold # + flap_detection_enabled [0/1] + flap_detection_options [o,d,u] + process_perf_data [0/1] + retain_status_information [0/1] + retain_nonstatus_information [0/1] + *contacts contacts + *contact_groups contact_groups + *notification_interval # + first_notification_delay # + *notification_period timeperiod_name + notification_options [d,u,r,f,s] + notifications_enabled [0/1] + stalking_options [o,d,u] + notes note_string + notes_url url + action_url url + icon_image image_file + icon_image_alt alt_string + vrml_image image_file + statusmap_image image_file + 2d_coords x_coord,y_coord + 3d_coords x_coord,y_coord,z_coord +} +""" + + valid_keys = set( + 'host_name', 'alias', 'display_name', 'address', 'parents', 'hostgroups', 'check_command', 'initial_state', + 'max_check_attempts', 'check_interval', 'retry_interval', 'active_checks_enabled', 'passive_checks_enabled', + 'check_period', 'obsess_over_host', 'check_freshness', 'freshness_threshold', 'event_handler', 'event_handler_enabled', + 'low_flap_threshold', 'high_flap_threshold', 'flap_detection_enabled', 'flap_detection_options', 'process_perf_data', + 'retain_status_information', 'retain_nonstatus_information', 'contacts', 'contact_groups', 'notification_interval', + 'first_notification_delay', 'notification_period', 'notification_options', 'notifications_enabled', 'stalking_options', + 'notes', 'notes_url', 'action_url', 'icon_image', 'icon_image_alt', 'vrml_image', 'statusmap_image', + '2d_coords', '3d_coords' + ) + + for key in definition: + if not key in valid_keys: + logger.warn( "Ungültige Eigenschaft {0!r} für Hostdefinition in {1}({2}).".format( + key, definition[key][1], definition[key][2] ) + + if 'host_name' in definition: + identifier = definition['host_name'][0] + res['host_name'] = definition['host_name'][0] + else + logger.warn( "Kein Hostname in Hostdefinition gegeben." ) + + # Einfache String-Eigenschaften + for key in ( 'alias', 'address', 'display_name', 'check_period', 'event_handler', 'notification_period', + 'notes', 'notes_url', 'action_url', 'icon_image', 'icon_image_alt', 'vrml_image', 'statusmap_image' ): + if key in definition: + res[key] = definition[key][0] + + # Array-String-Eigenschaften + for key in ( 'parents', 'hostgroups', 'contacts', 'contact_groups' ): + if key in definition: + array = re.split( r',+', definition[key][0] + res[key] = array[] + + if 'initial_state' in definition: + array = re.split( r',+', definition['initial_state'][0] + for value in array: + if value not in ( 'o', 'd', 'u' ): + logger.warn( "Ungültiger Wert für 'initial_state' in {0}({1}) gegeben.".format( + definition['initial_state'][1], definition['initial_state'][2] ) + + return ( identifier, res ) + +# vim: fileencoding=utf-8 filetype=python ts=4 expandtab diff --git a/bin/nagios/object/host.pyc b/bin/nagios/object/host.pyc new file mode 100644 index 0000000..ef9b2bc Binary files /dev/null and b/bin/nagios/object/host.pyc differ diff --git a/docs/about.html b/docs/about.html new file mode 100644 index 0000000..a4dad48 --- /dev/null +++ b/docs/about.html @@ -0,0 +1,238 @@ + + + + + + + + +About Nagios + + + + + + + + + + + + + + + +
+ +Nagios + +

About Nagios

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Quickstart Installation Guides + +

+ +

+ + + +Nagios Overview + +

+ +

+More information about Nagios - including features, case studies, and technical specifications can be found online at www.nagios.org/about/. +

+ +

+ + + +What Is Nagios? + +

+ + + +

+ +Nagios® is a system and network monitoring application. It watches hosts and services that you specify, alerting you when things go bad and when they get better. + +

+ +

+ +Nagios was originally designed to run under Linux, although it should work under most other unices as well. + +

+ +

+ +Some of the many features of Nagios include: + +

+ + + + + + + +

+ + + +System Requirements + +

+ +

+ +The only requirement of running Nagios is a machine running Linux (or UNIX variant) and a C compiler. You will probably also want to have TCP/IP configured, as most service checks will be performed over the network. + +

+ +

+ +You are not required to use the CGIs included with Nagios. However, if you do decide to use them, you will need to have the following software installed... + +

+ + + +
    + +
  1. A web server (preferrably Apache) + +
  2. Thomas Boutell's gd library version 1.6.3 or higher (required by the statusmap and trends CGIs) + +
+ + + +

+ + + +Licensing + +

+ +

+ +Nagios is licensed under the terms of the GNU General Public License Version 2 as published by the Free Software Foundation. This gives you legal permission to copy, distribute and/or modify Nagios under certain conditions. Read the 'LICENSE' file in the Nagios distribution or read the online version of the license for more details. + +

+ + + +

+ +Nagios is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE WARRANTY OF DESIGN, MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE. + +

+ + + +

+ + + +Acknowledgements + +

+ +

+ +Several people have contributed to Nagios by either reporting bugs, suggesting improvements, writing plugins, etc. A list of some of the many contributors to the development of Nagios can be found in the THANKS file in the root of the Nagios distribution. + +

+ + + +

+ + + +Downloading The Latest Version + +

+ +

+ +You can check for new versions of Nagios at http://www.nagios.org. + +

+ + + +
+ + + +
+ +
+ +Nagios and the Nagios logo are trademarks of Nagios Enterprises, LLC. All other trademarks, servicemarks, registered trademarks, and registered servicemarks may be the property of their respective owner(s). + +
+ + + + + + + diff --git a/docs/activechecks.html b/docs/activechecks.html new file mode 100644 index 0000000..485bb63 --- /dev/null +++ b/docs/activechecks.html @@ -0,0 +1,162 @@ + + + + + + + + +Active Checks + + + + + + + + + + + + + + + +
+ +Nagios + +

Active Checks

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Passive Checks, Plugins, Service Checks, Host Checks + +

+ + + +

+ +Introduction + +

+ + + +

+ +Nagios is capable of monitoring hosts and services in two ways: actively and passively. Passive checks are described elsewhere, so we'll focus on active checks here. Active checks are the most common method for monitoring hosts and services. The main features of actives checks as as follows: + +

+ + + + + + + +Active Checks + + + +

+ +How Are Active Checks Performed? + +

+ + + +

+ +Active checks are initiated by the check logic in the Nagios daemon. When Nagios needs to check the status of a host or service it will execute a plugin and pass it information about what needs to be checked. The plugin will then check the operational state of the host or service and report the results back to the Nagios daemon. Nagios will process the results of the host or service check and take appropriate action as necessary (e.g. send notifications, run event handlers, etc). + +

+ + + +

+ +More information on how plugins work can be found here. + +

+ + + +

+ +When Are Active Checks Executed? + +

+ + + +

+ +Active check are executed: + +

+ + + + + +

+ +Regularly scheduled checks occur at intervals equaling either the check_interval or the retry_interval in your host or service definitions, depending on what type of state the host or service is in. If a host or service is in a HARD state, it will be actively checked at intervals equal to the check_interval option. If it is in a SOFT state, it will be checked at intervals equal to the retry_interval option. + +

+ + + +

+ +On-demand checks are performed whenever Nagios sees a need to obtain the latest status information about a particular host or service. For example, when Nagios is determining the reachability of a host, it will often perform on-demand checks of parent and child hosts to accurately determine the status of a particular network segment. On-demand checks also occur in the predictive dependency check logic in order to ensure Nagios has the most accurate status information. + +

+ + + + + +
+ + + + + + + diff --git a/docs/adaptive.html b/docs/adaptive.html new file mode 100644 index 0000000..e7e7eb2 --- /dev/null +++ b/docs/adaptive.html @@ -0,0 +1,200 @@ + + + + + + + + +Adaptive Monitoring + + + + + + + + + + + + + + + +
+ +Nagios + +

Adaptive Monitoring

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: External Commands + +

+ + + +

+ +Introduction + +

+ + + +

+ +Nagios allows you to change certain commands and host and service check attributes during runtime. I'll refer to this feature as "adaptive monitoring". Please note that the adaptive monitoring features found in Nagios will probably not be of much use to 99% of users, but they do allow you to do some neat things. + +

+ + + +

+ +What Can Be Changed? + +

+ + + +

+ +The following service check attributes can be changed during runtime: + +

+ + + + + + + +

+ +The following host check attributes can be changed during runtime: + +

+ + + + + + + +

+ +The following global attributes can be changed during runtime: + +

+ + + + + + + +

+ +External Commands For Adaptive Monitoring + +

+ + + +

+ +In order to change global or host- or service-specific attributes during runtime, you must submit the appropriate external command to Nagios via the external command file. The table below lists the different attributes that may be changed during runtime, along with the external command to accomplish the job. + +

+ + + +

+ +A full listing of external commands that can be used for adaptive monitoring (along with examples of how to use them) can be found online at the following URL: http://www.nagios.org/developerinfo/externalcommands/ + +

+ + + +

+ +Note Notes: + +

+ + + + + + + + + +
+ + + + + + + diff --git a/docs/addons.html b/docs/addons.html new file mode 100644 index 0000000..6272084 --- /dev/null +++ b/docs/addons.html @@ -0,0 +1,249 @@ + + + + + + + + +Nagios Addons + + + + + + + + + + + + + + + +
+ +Nagios + +

Nagios Addons

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +

+ + + +

Introduction

+ + + +

+ +There are a lot of "addon" software packages that are available for Nagios. Addons can be used to extend Nagios' functionality or integrate Nagios with other applications. + +

+ + + +

+ +Addons are available for: + +

+ + + + + + + +

+ +You can find many addons for Nagios by visiting: + +

+ + + + + + + +

+ +I'll give a brief introduction to a few of the addons that I've developed for Nagios... + +

+ + + + + + + + + +

NRPE

+ + + +

+ +NRPE + +

+ + + +

+ +NRPE is an addon that allows you to execute plugins on remote Linux/Unix hosts. This is useful if you need to monitor local resources/attributes like disk usage, CPU load, memory usage, etc. on a remote host. Similiar functionality can be accomplished by using the check_by_ssh plugin, although it can impose a higher CPU load on the monitoring machine - especially if you are monitoring hundreds or thousands of hosts. + +

+ + + +

+ +The NRPE addon and documentation can be found at http://www.nagios.org/. + +

+
+ + + + + + +

NSCA

+ + + +

+ +NSCA + +

+ + + +

+ +NSCA is an addon that allows you to send passive check results from remote Linux/Unix hosts to the Nagios daemon running on the monitoring server. This is very useful in distributed and redundant/failover monitoring setups. + +

+ + + +

+ +The NSCA addon can be found at http://www.nagios.org/. + +

+ + + +
+ + + + + +

NDOUtils

+ + + +

+ +NDOUtils + +

+ + + +

+ +NDOUtils is an addon that allows you to store all status information from Nagios in a MySQL database. Multiple instances of Nagios can all store their information in a central database for centralized reporting. This will likely serve as the basis for a new PHP-based web interface for Nagios in the future. + +

+ + + +

+ +The NDOUtils addon and documentation can be found at http://www.nagios.org/. + +

+ + + +
+ + + +

Nagios Exchange - Hundreds of Other Addons

+ + + +

+ +Nagios Exchange + +

+ +

+Hundreds of community-developed Nagios addons can be found on the Nagios Exchange website at exchange.nagios.org. +

+ +
+ + +
+ + + + + + + diff --git a/docs/beginners.html b/docs/beginners.html new file mode 100644 index 0000000..82c701c --- /dev/null +++ b/docs/beginners.html @@ -0,0 +1,100 @@ + + + + + + + + +Advice for Beginners + + + + + + + + + + + + + + + +
+ +Nagios + +

Advice for Beginners

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Quickstart Installation Guide + +

+ + + + + +

+ +Congratulations on choosing Nagios! Nagios is quite powerful and flexible, but it can take a lot of work to get it configured just the way you'd like. Once you become familiar with how it works and what it can do for you, you'll never want to be without it. :-) Here are some important things to keep in mind for first-time Nagios users: + +

+ + + +
    + + + +
  1. Relax - it's going to take some time. Don't expect to be able to get things working exactly the way you want them right off the bat. it's not that easy. Setting up Nagios can involve a bit of work - partly because of the options that Nagios offers, partly because you need to know what to monitor on your network (and how best to do it).

    + + + +
  2. Use the quickstart instructions. The quickstart installation guide is designed to get most new users up and running with a basic Nagios setup fairly quickly. Within 20 minutes you can have Nagios installed and monitoring your local system. Once that's complete, you can move on to learning how to configure Nagios to do more.

    + + + +
  3. Read the documentation. Nagios can be tricky to configure when you've got a good grasp of what's going on, and nearly impossible if you don't. Make sure you read the documentation (particularly the sections on "Configuring Nagios" and "The Basics"). Save the advanced topics for when you've got a good understanding of the basics.

    + + + +
  4. Seek the help of others. If you've read the documentation, reviewed the sample config files, and are still having problems, send an email message describing your problems to the nagios-users mailing list. Due to the amount of work that I have to do for this project, I am unable to answer most of the questions that get sent directly to me, so your best source of help is going to be the mailing list. If you've done some background reading and you provide a good problem description, odds are that someone will give you some pointers on getting things working properly. More information on subscribing to the mailing lists or searching the list archives can be found at http://www.nagios.org/support/. + +
+ + + + + +
+ + + + + + + diff --git a/docs/cachedchecks.html b/docs/cachedchecks.html new file mode 100644 index 0000000..b1cbb35 --- /dev/null +++ b/docs/cachedchecks.html @@ -0,0 +1,364 @@ + + + + + + + + +Cached Checks + + + + + + + + + + + + + + + +
+ +Nagios + +

Cached Checks

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Host Checks, Service Checks, Predictive Dependency Checks + +

+ + + +

+ +Introduction + +

+ + + +Cached Checks + + + +

+ +The performance of Nagios' monitoring logic can be significantly improved by implementing the use of cached checks. Cached checks allow Nagios to forgo executing a host or service check command if it determines a relatively recent check result will do instead. + +

+ + + +

+ +For On-Demand Checks Only + +

+ + + +

+ +Regularly scheduled host and service checks will not see a performance improvement with use of cached checks. Cached checks are only useful for improving the performance of on-demand host and service checks. Scheduled checks help to ensure that host and service states are updated regularly, which may result in a greater possibility their results can be used as cached checks in the future. + +

+ + + +

+ +For reference, on-demand host checks occur... + +

+ + + + + + + +

+ +And on-demand service checks occur... + +

+ + + + + + + +

+ +Note Note: Unless you make use of service dependencies, Nagios will not be able to use cached check results to improve the performance of service checks. Don't worry about that - its normal. Cached host checks are where the big performance improvements lie, and everyone should see a benefit there. + +

+ + + + + +

+ +How Caching Works + +

+ + + +Cached Check Logic + + + +

+ +When Nagios needs to perform an on-demand host or service check, it will make a determination as to whether it can used a cached check result or if it needs to perform an actual check by executing a plugin. It does this by checking to see if the last check of the host or service occured within the last X minutes, where X is the cached host or service check horizon. + +

+ + + +

+ +If the last check was performed within the timeframe specified by the cached check horizon variable, Nagios will use the result of the last host or service check and will not execute a new check. If the host or service has not yet been checked, or if the last check falls outside of the cached check horizon timeframe, Nagios will execute a new host or service check by running a plugin. + +

+ + + +

+ +What This Really Means + +

+ + + +

+ +Nagios performs on-demand checks because it need to know the current state of a host or service at that exact moment in time. Utilizing cached checks allows you to make Nagios think that recent check results are "good enough" for determining the current state of hosts, and that it doesn't need to go out and actually re-check the status of that host or service. + +

+ + + +

+ +The cached check horizon tells Nagios how recent check results must be in order to reliably reflect the current state of a host or service. For example, with a cached check horizon of 30 seconds, you are telling Nagios that if a host's state was checked sometime in the last 30 seconds, the result of that check should still be considered the current state of the host. + +

+ + + +

+ +The number of cached check results that Nagios can use versus the number of on-demand checks it has to actually execute can be considered the cached check "hit" rate. By increasing the cached check horizon to equal the regular check interval of a host, you could theoretically achieve a cache hit rate of 100%. In that case all on-demand checks of that host would use cached check results. What a performance improvement! But is it really? Probably not. + +

+ + + +

+ +The reliability of cached check result information decreases over time. Higher cache hit rates require that previous check results are considered "valid" for longer periods of time. Things can change quickly in any network scenario, and there's no guarantee that a server that was functioning properly 30 seconds ago isn't on fire right now. There's the tradeoff - reliability versus speed. If you have a large cached check horizon, you risk having unreliable check result values being used in the monitoring logic. + +

+ + + +

+ +Nagios will eventually determine the correct state of all hosts and services, so even if cached check results prove to unreliably represent their true value, Nagios will only work with incorrect information for a short period of time. Even short periods of unreliable status information can prove to be a nuisance for admins, as they may receive notifications about problems which no longer exist. + +

+ + + +

+ +There is no standard cached check horizon or cache hit rate that will be acceptable to every Nagios users. Some people will want a short horizon timeframe and a low cache hit rate, while others will want a larger horizon timeframe and a larger cache hit rate (with a low reliability rate). Some users may even want to disable cached checks altogether to obtain a 100% reliability rate. Testing different horizon timeframes, and their effect on the reliability of status information, is the only want that an individual user will find the "right" value for their situation. More information on this is discussed below. + +

+ + + + + +

+ +Configuration Variables + +

+ + + +

+ +The following variables determine the timeframes in which a previous host or service check result may be used as a cached host or service check result: + +

+ + + + + + + +

+ +Optimizing Cache Effectiveness + +

+ + + +

+ +In order to make the most effective use of cached checks, you should: + +

+ + + + + + + +

+ +You can schedule regular checks of your hosts by specifying a value greater than 0 for check_interval option in your host definitions. If you do this, make sure that you set the max_check_attempts option to a value greater than 1, or it will cause a big performance hit. This potential performance hit is describe in detail here. + +

+ + + +Cached Checks Graph + + + +

+ +A good way to determine the proper value for the cached check horizon options is to compare how many on-demand checks Nagios has to actually run versus how may it can use cached values for. The nagiostats utility can produce information on cached checks, which can then be graphed with MRTG. Example MRTG graphs that show cached vs. actual on-demand checks are shown to the right. + +

+ + + +

+ +The monitoring installation which produced the graphs above had: + +

+ + + + + + + +

+ +The first MRTG graph shows how many regularly scheduled host checks compared to how many cached host checks have occured. In this example, an average of 53 host checks occur every five minutes. 9 of these (17%) are on-demand checks. + +

+ + + +

+ +The second MRTG graph shows how many cached host checks have occurred over time. In this example an average of 2 cached host checks occurs every five minutes. + +

+ + + +

+ +Remember, cached checks are only available for on-demand checks. Based on the 5 minute averages from the graphs, we see that Nagios is able to used cached host check results every 2 out of 9 times an on-demand check has to be run. That may not seem much, but these graphs represent a small monitoring environment. Consider that 2 out of 9 is 22% and you can start to see how this could significantly help improve host check performance in large environments. That percentage could be higher if the cached host check horizon variable value was increased, but that would reduce the reliability of the cached host state information. + +

+ + + +

+ +Once you've had a few hours or days worth of MRTG graphs, you should see how many host and service checks were done by executing plugins versus those that used cached check results. Use that information to adjust the cached check horizon variables appropriately for your situation. Continue to monitor the MRTG graphs over time to see how changing the horizon variables affected cached check statistics. Rinse and repeat as necessary. + +

+ + + +
+ + + +
+ + + + + + + diff --git a/docs/cgiauth.html b/docs/cgiauth.html new file mode 100644 index 0000000..7ed6800 --- /dev/null +++ b/docs/cgiauth.html @@ -0,0 +1,516 @@ + + + + + + + + +Authentication And Authorization In The CGIs + + + + + + + + + + + + + + + +
+ +Nagios + +

Authentication And Authorization In The CGIs

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: CGI Configuration File Options, Information on the CGIs + +

+ + + +

+ +Introduction + +

+ + + +

+ +This documentation describes how the Nagios CGIs decide who has access to view monitoring and configuration information, and who can submit commands to the Nagios daemon through the web interface. + +

+ + + + + + + +

+ +Definitions + +

+ + + +

+ +Before continuing, it is important that you understand the meaning of and difference between authenticated users and authenticated contacts: + +

+ + + + + + + + + +

+ + + +Setting Up Authenticated Users + +

+ + + +

+ +Assuming you configured your web server as described in the quickstart guide, it should require that you authenticate before accessing the Nagios CGIs. You should also have one user account (nagiosadmin) that can access the CGIs. + +

+ + + +

+ +As you define more contacts for receiving host and service notifications, you'll most likely want to let them access the Nagios web interface. You can use the following command to add additional users who can authenticate to the CGIs. Replace <username> with the actual username you want to add. In most cases, the username should match the short name of a contact that has been defined. + +

+ + + +
+
+htpasswd /usr/local/nagios/etc/htpasswd.users <username>
+
+
+ + + +

+ + + +Enabling Authentication/Authorization Functionality In The CGIs + +

+ + + +

+ +The next thing you need to do is make sure that the CGIs are configured to use the authentication and authorization functionality in determining what information and/or commands users have access to. This is done be setting the use_authentication variable in the CGI configuration file to a non-zero value. Example: + +

+ + + +
+
+use_authentication=1
+
+
+ + + +

+ +Okay, you're now done with setting up basic authentication/authorization functionality in the CGIs. + +

+ + + + + +

+ + + +Default Permissions To CGI Information + +

+ + + +

+ +So what default permissions do users have in the CGIs by default when the authentication/authorization functionality is enabled? + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CGI DataAuthenticated Contacts*Other Authenticated Users*
Host Status InformationYesNo
Host Configuration InformationYesNo
Host HistoryYesNo
Host NotificationsYesNo
Host CommandsYesNo
Service Status InformationYesNo
Service Configuration InformationYesNo
Service HistoryYesNo
Service NotificationsYesNo
Service CommandsYesNo
All Configuration InformationNoNo
System/Process InformationNoNo
System/Process CommandsNoNo
+ + + +
+ + + +

+ +Authenticated contacts* are granted the following permissions for each service for which they are contacts (but not for services for which they are not contacts)... + +

+ + + + + +

+ +Authenticated contacts* are granted the following permissions for each host for which they are contacts (but not for hosts for which they are not contacts)... + +

+ + + + + +

+ +It is important to note that by default no one is authorized for the following... + +

+ + + + + +

+ +You will undoubtably want to access this information, so you'll have to assign additional rights for yourself (and possibly other users) as described below... + +

+ + + +

+ + + +Granting Additional Permissions To CGI Information + +

+ + + +

+ +You can grant authenticated contacts or other authenticated users permission to additional information in the CGIs by adding them to various authorization variables in the CGI configuration file. I realize that the available options don't allow for getting really specific about particular permissions, but its better than nothing.. + +

+ + + +

+ +Additional authorization can be given to users by adding them to the following variables in the CGI configuration file... + +

+ + + + + +

+ + + +CGI Authorization Requirements + +

+ + + +

+ +If you are confused about the authorization needed to access various information in the CGIs, read the Authorization Requirements section for each CGI as described here. + +

+ + + + + +

+ + + +Authentication On Secured Web Servers + +

+ + + +

+ +If your web server is located in a secure domain (i.e., behind a firewall) or if you are using SSL, you can define a default username that can be used to access the CGIs. This is done by defining the default_user_name option in the CGI configuration file. By defining a default username that can access the CGIs, you can allow users to access the CGIs without necessarily having to authenticate to the web server. You may want to use this to avoid having to use basic web authentication, as basic authentication transmits passwords in clear text over the Internet. + +

+ +

+ +Important: Do not define a default username unless you are running a secure web server and are sure that everyone who has access to the CGIs has been authenticated in some manner. If you define this variable, anyone who has not authenticated to the web server will inherit all rights you assign to this user! + +

+ + + +
+ + + + + + + diff --git a/docs/cgiincludes.html b/docs/cgiincludes.html new file mode 100644 index 0000000..64cf7f1 --- /dev/null +++ b/docs/cgiincludes.html @@ -0,0 +1,152 @@ + + + + + + + + +Custom CGI Headers and Footers + + + + + + + + + + + + + + + +
+ +Nagios + +

Custom CGI Headers and Footers

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Information on the CGIs + +

+ + + +

+ +Introduction + +

+ + + +

+ +If you're doing custom installs of Nagios for clients, you may want to have a custom header and/or footer displayed in the output of the CGIs. This is particularly useful for displaying support contact information, etc. to the end user. + +

+ + + +

+ +It is important to note that, unless they are executable, custom header and footer files are not pre-processed in any way before they are displayed. The contents of the header and footer include files are simply read and displayed in the CGI output. That means they can only contain information a web browser can understand (HTML, JavaScript, etc.). + +

+ + + +

+ +If the custom header and footer files are executable, then the files are executed and their output returned to the user, so they should output valid HTML. Using this you can run your own custom designed CGI to insert data into the nagios display. This has been used to insert graphs from rrdtool using ddraw and command menus into the nagios display pane. The execuable customer header and footer files are run with the same CGI environment as the main nagios CGI, so your files can parse the query information, authenticated user information, etc. to produce appropriate output. + +

+ + + + + +

+ +How Does It Work? + +

+ + + +

+ +You can include custom headers and footers in the output of the CGIs by dropping some appropriately named HTML files in the ssi/ subdirectory of the Nagios HTML directory (i.e. /usr/local/nagios/share/ssi). + +

+ + + +

+ +Custom headers are included immediately after the <BODY>> tag in the CGI output, while custom footers are included immediately before the closing </BODY> tag. + +

+ + + +

There are two types of customer headers and footers: + +

+ + + + + + + +

+ +You are not required to use any custom headers or footers. You can use only a global header if you wish. You can use only CGI-specific headers and a global footer if you wish. Whatever you want. Really. + +

+ + + +
+ + + + + + + diff --git a/docs/cgis.html b/docs/cgis.html new file mode 100644 index 0000000..b8ecb58 --- /dev/null +++ b/docs/cgis.html @@ -0,0 +1,1381 @@ + + + + + + + + +Information On The CGIs + + + + + + + + + + + + + + + +
+ +Nagios + +

Information On The CGIs

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: CGI Configuration File Options, Authentication And Authorization In The CGIs, CGI Footers and Headers, CGI Security + +

+ + + +

+ +Introduction + +

+ + + +

+ +The various CGIs distributed with Nagios are described here, along with the authorization requirements for accessing and using each CGI. By default the CGIs require that you have authenticated to the web server and are authorized to view any information you are requesting. More information on configuring authorization can be found here. + +

+ + + +

+ +Index + +

+ +

+ +Status CGI
+ +Status map CGI
+ +WAP interface CGI
+ +Status world CGI (VRML)
+ +Tactical overview CGI
+ +Network outages CGI
+ +Configuration CGI
+ +Command CGI
+ +Extended information CGI
+ +Event log CGI
+ +Alert history CGI
+ +Notifications CGI
+ +Trends CGI
+ +Availability reporting CGI
+ +Alert histogram CGI
+ +Alert summary CGI
+ +

+ + + + + + + + + + + + + + + +
Status CGI
+ + + + + + + + + + + + + + + + + +
Status CGI - DetailsStatus CGI - OverviewStatus CGI - SummaryStatus CGI - Grid
+ + + + + + + + + + + + + +
File Name:status.cgi
+ + + + + + + + + + + +
+ +

+ +Description:
+ +This is the most important CGI included with Nagios. It allows you to view the current status of all hosts and services that are being monitored. The status CGI can produce two main types of output - a status overview of all host groups (or a particular host group) and a detailed view of all services (or those associated with a particular host). + +

+ +Authorization Requirements:
+ +

    + +
  • If you are authorized for all hosts you can view all hosts and all services. + +
  • If you are authorized for all services you can view all services. + +
  • If you are an authenticated contact you can view all hosts and services for which you are a contact. + +
+ +
+ + + + + + + + + + + + + + + +
Status Map CGI
+ + + + + + + + + + + +
Status Map CGI
+ + + + + + + + + + + + + +
File Name:statusmap.cgi
+ + + + + + + + + + + +
+ +

+ +Description:
+ +This CGI creates a map of all hosts that you have defined on your network. The CGI uses Thomas Boutell's gd library (version 1.6.3 or higher) to create a PNG image of your network layout. The coordinates used when drawing each host (along with the optional pretty icons) are taken from host definitions. If you'd prefer to let the CGI automatically generate drawing coordinates for you, use the default_statusmap_layout directive to specify a layout algorithm that should be used. + +

+ +

+ +Authorization Requirements:
+ +

    + +
  • If you are authorized for all hosts you can view all hosts. + +
  • If you are an authenticated contact you can view hosts for which you are a contact. + +
+ +
+ +Note: Users who are not authorized to view specific hosts will see unknown nodes in those positions. I realize that they really shouldn't see anything there, but it doesn't make sense to even generate the map if you can't see all the host dependencies... + +
+ + + + + + + + + + + + + + + +
WAP Interface CGI
+ + + + + + + + + + + +
WAP Interface CGI
+ + + + + + + + + + + + + +
File Name:statuswml.cgi
+ + + + + + + + + + + +
+ +

+ +Description:
+ +This CGI serves as a WAP interface to network status information. If you have a WAP-enabled device (i.e. an Internet-ready cellphone), you can view status information while you're on the go. Different status views include hostgroup summary, hostgroup overview, host detail, service detail, all problems, and unhandled problems. In addition to viewing status information, you can also disable notifications and checks and acknowledge problems from your cellphone. Pretty cool, huh? + +

+ +

+ +Authorization Requirements:
+ +

+ +
+ + + + + + + + + + + + + + + +
Status World CGI (VRML)
+ + + + + + + + + + + +
3-D Status Map CGI
+ + + + + + + + + + + + + +
File Name:statuswrl.cgi
+ + + + + + + + + + + +
+ +

+ +Description:
+ +This CGI creates a 3-D VRML model of all hosts that you have defined on your network. Coordinates used when drawing the hosts (as well as pretty texture maps) are taken from host definitions. If you'd prefer to let the CGI automatically generate drawing coordinates for you, use the default_statuswrl_layout directive to specify a layout algorithm that should be used. You'll need a VRML browser (like Cortona, Cosmo Player or WorldView) installed on your system before you can actually view the generated model. + +

+ +

+ +Authorization Requirements:
+ +

    + +
  • If you are authorized for all hosts you can view all hosts. + +
  • If you are an authenticated contact you can view hosts for which you are a contact. + +
+ +
+ +Note: Users who are not authorized to view specific hosts will see unknown nodes in those positions. I realize that they really shouldn't see anything there, but it doesn't make sense to even generate the map if you can't see all the host dependencies... + +
+ + + + + + + + + + + + + + + +
Tactical Overview CGI
+ + + + + + + + + + + +
Tactical Overview CGI
+ + + + + + + + + + + + + +
File Name:tac.cgi
+ + + + + + + + + + + +
+ +

+ +Description:
+ +This CGI is designed to server as a "birds-eye view" of all network monitoring activity. It allows you to quickly see network outages, host status, and service status. It distinguishes between problems that have been "handled" in some way (i.e. been acknowledged, had notifications disabled, etc.) and those which have not been handled, and thus need attention. Very useful if you've got a lot of hosts/services you're monitoring and you need to keep a single screen up to alert you of problems. + +

+ +Authorization Requirements:
+ +

    + +
  • If you are authorized for all hosts you can view all hosts and all services. + +
  • If you are authorized for all services you can view all services. + +
  • If you are an authenticated contact you can view all hosts and services for which you are a contact. + +
+ +
+ + + + + + + + + + + + + + + +
Network Outages CGI
+ + + + + + + + + + + +
Network Outages CGI
+ + + + + + + + + + + + + +
File Name:outages.cgi
+ + + + + + + + + + + +
+ +

+ +Description:
+ +This CGI will produce a listing of "problem" hosts on your network that are causing network outages. This can be particularly useful if you have a large network and want to quickly identify the source of the problem. Hosts are sorted based on the severity of the outage they are causing. + +

+ +

+ +Authorization Requirements:
+ +

    + +
  • If you are authorized for all hosts you can view all hosts. + +
  • If you are an authenticated contact you can view hosts for which you are a contact. + +
+ +
+ + + + + + + + + + + + + +
Configuration CGI
+ + + + + + + + + + + +
Configuration CGI
+ + + + + + + + + + + + + +
File Name:config.cgi
+ + + + + + + + + + + +
+ +

+ +Description:
+ +This CGI allows you to view objects (i.e. hosts, host groups, contacts, contact groups, time periods, services, etc.) that you have defined in your object configuration file(s). + +

+ +Authorization Requirements:
+ +

+ +
+ + + + + + + + + + + + + +
Command CGI
+ + + + + + + + + + + +
Command CGI
+ + + + + + + + + + + + + +
File Name:cmd.cgi
+ + + + + + + + + + + +
+ +

+ +Description:
+ +This CGI allows you to send commands to the Nagios process. Although this CGI has several arguments, you would be better to leave them alone. Most will change between different revisions of Nagios. Use the extended information CGI as a starting point for issuing commands. + +

+ +Authorization Requirements:
+ +

+ +Notes: + +
    + +
  • If you have chosen not to use authentication with the CGIs, this CGI will not allow anyone to issue commands to Nagios. This is done for your own protection. I would suggest removing this CGI altogether if you decide not to use authentication with the CGIs. + +
+ +
+ + + + + + + + + + + + + +
Extended Information CGI
+ + + + + + + + + + + + + + + + + +
Extended Information CGI - Process InformationExtended Information CGI - Performance InformationExtended Information CGI - Host InformationExtended Information CGI - Service Information
+ + + + + + + + + + + + + +
File Name:extinfo.cgi
+ + + + + + + + + + + +
+ +

+ +Description:
+ +This CGI allows you to view Nagios process information, host and service state statistics, host and service comments, and more. It also serves as a launching point for sending commands to Nagios via the command CGI. Although this CGI has several arguments, you would be better to leave them alone - they are likely to change between different releases of Nagios. You can access this CGI by clicking on the 'Network Health' and 'Process Information' links on the side navigation bar, or by clicking on a host or service link in the output of the status CGI. + +

+ +Authorization Requirements:
+ +

    + +
  • You must be authorized for system information in order to view Nagios process information. + +
  • If you are authorized for all hosts you can view extended information for all hosts and services. + +
  • If you are authorized for all services you can view extended information for all services. + +
  • If you are an authenticated contact you can view extended information for all hosts and services for which you are a contact. + +
+ +
+ + + + + + + + + + + + + + + + + +
Event Log CGI
+ + + + + + + + + + + +
Event Log CGI
+ + + + + + + + + + + + + +
File Name:showlog.cgi
+ + + + + + + + + + + +
+ +

+ +Description:
+ +This CGI will display the log file. If you have log rotation enabled, you can browse notifications present in archived log files by using the navigational links near the top of the page. + +

+ +

+ +Authorization Requirements:
+ +

+ +
+ + + + + + + + + + + + + +
Alert History CGI
+ + + + + + + + + + + +
Alert History CGI
+ + + + + + + + + + + + + +
File Name:history.cgi
+ + + + + + + + + + + +
+ +

+ +Description:
+ +This CGI is used to display the history of problems with either a particular host or all hosts. The output is basically a subset of the information that is displayed by the log file CGI. You have the ability to filter the output to display only the specific types of problems you wish to see (i.e. hard and/or soft alerts, various types of service and host alerts, all types of alerts, etc.). If you have log rotation enabled, you can browse history information present in archived log files by using the navigational links near the top of the page. + +

+ +

+ +Authorization Requirements:
+ +

    + +
  • If you are authorized for all hosts you can view history information for all hosts and all services. + +
  • If you are authorized for all services you can view history information for all services. + +
  • If you are an authenticated contact you can view history information for all services and hosts for which you are a contact. + +
+ +
+ + + + + + + + + + + + + +
Notifications CGI
+ + + + + + + + + + + +
Notifications CGI
+ + + + + + + + + + + + + +
File Name:notifications.cgi
+ + + + + + + + + + + +
+ +

+ +Description:
+ +This CGI is used to display host and service notifications that have been sent to various contacts. The output is basically a subset of the information that is displayed by the log file CGI. You have the ability to filter the output to display only the specific types of notifications you wish to see (i.e. service notifications, host notifications, notifications sent to specific contacts, etc). If you have log rotation enabled, you can browse notifications present in archived log files by using the navigational links near the top of the page. + +

+ +

+ +Authorization Requirements:
+ +

    + +
  • If you are authorized for all hosts you can view notifications for all hosts and all services. + +
  • If you are authorized for all services you can view notifications for all services. + +
  • If you are an authenticated contact you can view notifications for all services and hosts for which you are a contact. + +
+ +
+ + + + + + + + + + + + + + + +
Trends CGI
+ + + + + + + + + + + +
Trends CGI
+ + + + + + + + + + + + + +
File Name:trends.cgi
+ + + + + + + + + + + +
+ +

+ +Description:
+ +This CGI is used to create a graph of host or service states over an arbitrary period of time. In order for this CGI to be of much use, you should enable log rotation and keep archived logs in the path specified by the log_archive_path directive. The CGI uses Thomas Boutell's gd library (version 1.6.3 or higher) to create the trends image. + +

+ +

+ +Authorization Requirements:
+ +

    + +
  • If you are authorized for all hosts you can view trends for all hosts and all services. + +
  • If you are authorized for all services you can view trends for all services. + +
  • If you are an authenticated contact you can view trends for all services and hosts for which you are a contact. + +
+ +
+ + + + + + + + + + + + + + + +
Availability Reporting CGI
+ + + + + + + + + + + + + +
Availability CGI - HostgroupAvailability CGI - Host
+ + + + + + + + + + + + + +
File Name:avail.cgi
+ + + + + + + + + + + +
+ +

+ +Description:
+ +This CGI is used to report on the availability of hosts and services over a user-specified period of time. In order for this CGI to be of much use, you should enable log rotation and keep archived logs in the path specified by the log_archive_path directive. + +

+ +

+ +Authorization Requirements:
+ +

    + +
  • If you are authorized for all hosts you can view availability data for all hosts and all services. + +
  • If you are authorized for all services you can view availability data for all services. + +
  • If you are an authenticated contact you can view availability data for all services and hosts for which you are a contact. + +
+ +
+ + + + + + + + + + + + + + + + + +
Alert Histogram CGI
+ + + + + + + + + + + +
Alert Histogram CGI
+ + + + + + + + + + + + + +
File Name:histogram.cgi
+ + + + + + + + + + + +
+ +

+ +Description:
+ +This CGI is used to report on the availability of hosts and services over a user-specified period of time. In order for this CGI to be of much use, you should enable log rotation and keep archived logs in the path specified by the log_archive_path directive. The CGI uses Thomas Boutell's gd library (version 1.6.3 or higher) to create the histogram image. + +

+ +

+ +Authorization Requirements:
+ +

    + +
  • If you are authorized for all hosts you can view histograms for all hosts and all services. + +
  • If you are authorized for all services you can view histograms for all services. + +
  • If you are an authenticated contact you can view histograms for all services and hosts for which you are a contact. + +
+ +
+ + + + + + + + + + + + + + + + + +
Alert Summary CGI
+ + + + + + + + + + + +
Alert Summary CGI
+ + + + + + + + + + + + + +
File Name:summary.cgi
+ + + + + + + + + + + +
+ +

+ +Description:
+ +This CGI provides some generic reports about host and service alert data, including alert totals, top alert producers, etc. + +

+ +

+ +Authorization Requirements:
+ +

    + +
  • If you are authorized for all hosts you can view summary information for all hosts and all services. + +
  • If you are authorized for all services you can view summary information for all services. + +
  • If you are an authenticated contact you can view summary information for all services and hosts for which you are a contact. + +
+ +
+ + + +
+ + + + + + \ No newline at end of file diff --git a/docs/cgisecurity.html b/docs/cgisecurity.html new file mode 100644 index 0000000..344e840 --- /dev/null +++ b/docs/cgisecurity.html @@ -0,0 +1,468 @@ + + + + + + + + +Enhanced CGI Security and Authentication + + + + + + + + + + + + + + + +
+ +Nagios + +

Enhanced CGI Security and Authentication

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Security Considerations, Configuration Overview + +

+ + + +

+ + + +Introduction + +

+ + + +Security + + + +

+ +This is intended to be an introduction for implementation of stronger authentication and server security focused around the CGI web interface. + +

+ + + +

+ +There are many ways to enhance the security of your monitoring server and Nagios environment. This should not be taken as the end all approach to security. Instead, think of it as an introduction to some of the techniques you can use to tighten the security of your system. As always, you should do your research and use the best techniques available. Treat your monitoring server as it were the most important server in your network and you shall be rewarded. + +

+ + + +
+ +

+ + + +Additional Techniques + +

+ + + + + + + + + +
+ +

+ + + +Implementing Digest Authentication + +

+ + + +

+ +The implementation of Digest Authentication is simple. You will have to create the new type of password file using the 'htdigest' tool, then modify the Apache configuration for nagios (typically /etc/httpd/conf.d/nagios.conf). + +

+ + + +

+ +Create a new passwords file using the 'htdigest' tool. The difference that you will notice if you are familiar with 'htpasswd' tools is the requirement to supply a 'realm' argument. Where 'realm' in this case refers to the value of the 'AuthName' directive in the Apache configuration. + +

+ + + +
+
+htdigest -c /usr/local/nagios/etc/.digest_pw "Nagios Access" nagiosadmin
+
+
+ + + +

+ +Next, edit the Apache configuration file for Nagios (typically /etc/httpd/conf.d/nagios.conf) using the following example. + +

+ + + +
+
+## BEGIN APACHE CONFIG SNIPPET - NAGIOS.CONF
+
+ScriptAlias /nagios/cgi-bin "/usr/local/nagios/sbin"
+
+<Directory "/usr/local/nagios/sbin">
+
+   Options ExecCGI
+
+   AllowOverride None
+
+   Order allow,deny
+
+   Allow from all
+
+   AuthType Digest
+
+   AuthName "Nagios Access"
+
+   AuthUserFile /usr/local/nagios/etc/.digest_pw
+
+   Require valid-user
+
+</Directory>
+
+
+
+Alias /nagios "/usr/local/nagios/share"
+
+<Directory "/usr/local/nagios/share">
+
+   Options None
+
+   AllowOverride None
+
+   Order allow,deny
+
+   Allow from all
+
+   AuthType Digest
+
+   AuthName "Nagios Access"
+
+   AuthUserFile /usr/local/nagios/etc/.digest_pw
+
+   Require valid-user
+
+</Directory>
+
+## END APACHE CONFIG SNIPPETS
+
+
+ + + +

+ +Then, restart the Apache service so the new settings can take effect. + +

+ + + +
+
+/etc/init.d/httpd restart
+
+
+ + + + + + + +
+ +

+ + + +Implementing Forced TLS/SSL + +

+ + + +

+ +Make sure you've installed Apache and OpenSSL. By default you should have mod_ssl support if you are still having trouble you may find help reading Apache's TLS/SSL Encryption Documentation. + +

+ + + +

+ +Next, verify that TLS/SSL support is working by visiting your Nagios Web Interface using HTTPS (https://your.domain/nagios). If it is working you can continue on to the next steps that will force using HTTPS and block all HTTP requests for the Nagios Web Interface. If you are having trouble visit Apache's TLS/SSL Encryption Documentation and Google for troubleshooting your specific Apache installation. + +

+ + + +

+ +Next, edit the Apache configuration file for Nagios (typically /etc/httpd/conf.d/nagios.conf) by adding the 'SSLRequireSSL' directive to both the 'sbin' and 'share' directories. + +

+ + + +
+
+## BEGIN APACHE CONFIG SNIPPET - NAGIOS.CONF
+
+ScriptAlias /nagios/cgi-bin "/usr/local/nagios/sbin"
+
+<Directory "/usr/local/nagios/sbin">
+
+   ...
+
+   SSLRequireSSL
+
+   ...
+
+</Directory>
+
+
+
+Alias /nagios "/usr/local/nagios/share"
+
+<Directory "/usr/local/nagios/share">
+
+   ...
+
+   SSLRequireSSL
+
+   ...
+
+</Directory>
+
+## END APACHE CONFIG SNIPPETS
+
+
+ + + +

+ +Restart the Apache service so the new settings can take effect. + +

+ + + +
+
+/etc/init.d/httpd restart
+
+
+ + + + + + + +
+ +

+ + + +Implementing IP subnet lockdown + +

+ + + +

+ +The following example will show how to lock down Nagios CGIs to a specific IP address, IP address range, or IP subnet using Apache's access controls. + +

+ + + +

+ +Edit the Apache configuration file for Nagios (typically /etc/httpd/conf.d/nagios.conf) by using the 'Allow', 'Deny', and 'Order' directives using the following as an example. + +

+ + + +
+
+## BEGIN APACHE CONFIG SNIPPET - NAGIOS.CONF
+
+ScriptAlias /nagios/cgi-bin "/usr/local/nagios/sbin"
+
+<Directory "/usr/local/nagios/sbin">
+
+   ...
+
+   AllowOverride None
+
+   Order deny,allow
+
+   Deny from all
+
+   Allow from 127.0.0.1 10.0.0.25		# Allow single IP addresses
+
+   Allow from 10.0.0.0/255.255.255.0		# Allow network/netmask pair
+
+   Allow from 10.0.0.0/24			# Allow network/nnn CIDR spec
+
+   ...
+
+</Directory>
+
+
+
+Alias /nagios "/usr/local/nagios/share"
+
+<Directory "/usr/local/nagios/share">
+
+   ...
+
+   AllowOverride None
+
+   Order deny,allow
+
+   Deny from all
+
+   Allow from 127.0.0.1 10.0.0.25		# Allow single IP addresses
+
+   Allow from 10.0.0.0/255.255.255.0		# Allow network/netmask pair
+
+   Allow from 10.0.0.0/24			# Allow network/nnn CIDR spec
+
+   ...
+
+</Directory>
+
+## END APACHE CONFIG SNIPPET
+
+
+ + + + + +
+ +

+ + + +Important Notes + +

+ + + + + + + + + + + +
+ + + + + + + diff --git a/docs/checkscheduling.html b/docs/checkscheduling.html new file mode 100644 index 0000000..62aff33 --- /dev/null +++ b/docs/checkscheduling.html @@ -0,0 +1,96 @@ + + + + + + + + +Service and Host Check Scheduling + + + + + + + + + + + + + + + +
+ +Nagios + +

Service and Host Check Scheduling

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Active Checks + +

+ + + + + + + + + + + + + + + +

+ +TODO + +

+ + + +

+ +This documentation is being rewritten for Nagios 3. Stay tuned for more information in a later beta release... + +

+ + + + + +
+ + + + + + + diff --git a/docs/clusters.html b/docs/clusters.html new file mode 100644 index 0000000..5a99e5b --- /dev/null +++ b/docs/clusters.html @@ -0,0 +1,322 @@ + + + + + + + + +Monitoring Service and Host Clusters + + + + + + + + + + + + + + + +
+ +Nagios + +

Monitoring Service and Host Clusters

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Active Checks, Macros + +

+ + + + + +

+ +Introduction + +

+ + + +

+ +Several people have asked how to go about monitoring clusters of hosts or services, so I decided to write up a little documentation on how to do this. Its fairly straightforward, so hopefully you find things easy to understand... + +

+ + + +

+ +First off, we need to define what we mean by a "cluster". The simplest way to understand this is with an example. Let's say that your organization has five hosts which provide redundant DNS services to your organization. If one of them fails, its not a major catastrophe because the remaining servers will continue to provide name resolution services. If you're concerned with monitoring the availability of DNS service to your organization, you will want to monitor five DNS servers. This is what I consider to be a service cluster. The service cluster consists of five separate DNS services that you are monitoring. Although you do want to monitor each individual service, your main concern is with the overall status of the DNS service cluster, rather than the availability of any one particular service. + +

+ + + +

+ +If your organization has a group of hosts that provide a high-availability (clustering) solution, I would consider those to be a host cluster. If one particular host fails, another will step in to take over all the duties of the failed server. As a side note, check out the High-Availability Linux Project for information on providing host and service redundancy with Linux. + +

+ + + +

+ +Plan of Attack + +

+ + + +

+ +There are several ways you could potentially monitor service or host clusters. I'll describe the method that I believe to be the easiest. Monitoring service or host clusters involves two things: + +

+ + + + + + + +

+ +Monitoring individual host or service cluster elements is easier than you think. In fact, you're probably already doing it. For service clusters, just make sure that you are monitoring each service element of the cluster. If you've got a cluster of five DNS servers, make sure you have five separate service definitions (probably using the check_dns plugin). For host clusters, make sure you have configured appropriate host definitions for each member of the cluster (you'll also have to define at least one service to be monitored for each of the hosts). Important: You're going to want to disable notifications for the individual cluster elements (host or service definitions). Even though no notifications will be sent about the individual elements, you'll still get a visual display of the individual host or service status in the status CGI. This will be useful for pinpointing the source of problems within the cluster in the future. + +

+ + + +

+ +Monitoring the overall cluster can be done by using the previously cached results of cluster elements. Although you could re-check all elements of the cluster to determine the cluster's status, why waste bandwidth and resources when you already have the results cached? Where are the results cached? Cached results for cluster elements can be found in the status file (assuming you are monitoring each element). The check_cluster plugin is designed specifically for checking cached host and service states in the status file. Important: Although you didn't enable notifications for individual elements of the cluster, you will want them enabled for the overall cluster status check. + +

+ + + +

+ +Using the check_cluster Plugin + +

+ + + +

+ +The check_cluster plugin is designed to report the overall status of a host or service cluster by checking the status information of each individual host or service cluster elements. + +

+ + + +

+ +More to come... The check_cluster plugin can be found in the contrib directory of the Nagios Plugins release at http://sourceforge.net/projects/nagiosplug/. + + + +

+ + + +

+ +Monitoring Service Clusters + +

+ + + +

+ +Let's say you have three DNS servers that provide redundant services on your network. First off, you need to be monitoring each of these DNS servers seperately before you can monitor them as a cluster. I'll assume that you already have three seperate services (all called "DNS Service") associated with your DNS hosts (called "host1", "host2" and "host3"). + +

+ + + +

+ +In order to monitor the services as a cluster, you'll need to create a new "cluster" service. However, before you do that, make sure you have a service cluster check command configured. Let's assume that you have a command called check_service_cluster defined as follows: + +

+ + + +
+
+define command{
+
+	command_name	check_service_cluster
+
+	command_line	/usr/local/nagios/libexec/check_cluster --service -l $ARG1$ -w $ARG2$ -c $ARG3$ -d $ARG4$ 
+
+	}
+
+
+ + + +

+ +Now you'll need to create the "cluster" service and use the check_service_cluster command you just created as the cluster's check command. The example below gives an example of how to do this. The example below will generate a CRITICAL alert if 2 or more services in the cluster are in a non-OK state, and a WARNING alert if only 1 of the services is in a non-OK state. If all the individual service members of the cluster are OK, the cluster check will return an OK state as well. + +

+ + + +
+
+define service{
+
+	...
+
+	check_command	check_service_cluster!"DNS Cluster"!1!2!$SERVICESTATEID:host1:DNS Service$,$SERVICESTATEID:host2:DNS Service$,$SERVICESTATEID:host3:DNS Service$
+
+	...
+
+	}
+
+
+ + + +

+ +It is important to notice that we are passing a comma-delimited list of on-demand service state macros to the $ARG4$ macro in the cluster check command. That's important! Nagios will fill those on-demand macros in with the current service state IDs (numerical values, rather than text strings) of the individual members of the cluster. + +

+ + + + + + + +

+ +Monitoring Host Clusters + +

+ + + +

+ +Monitoring host clusters is very similiar to monitoring service clusters. Obviously, the main difference is that the cluster members are hosts and not services. In order to monitor the status of a host cluster, you must define a service that uses the check_cluster plugin. The service should not be associated with any of the hosts in the cluster, as this will cause problems with notifications for the cluster if that host goes down. A good idea might be to associate the service with the host that Nagios is running on. After all, if the host that Nagios is running on goes down, then Nagios isn't running anymore, so there isn't anything you can do as far as monitoring (unless you've setup redundant monitoring hosts)... + +

+ + + +

+ +Anyway, let's assume that you have a check_host_cluster command defined as follows: + +

+ + + +
+
+define command{
+
+	command_name	check_host_cluster
+
+	command_line	/usr/local/nagios/libexec/check_cluster --host -l $ARG1$ -w $ARG2$ -c $ARG3$ -d $ARG4$ 
+
+	}
+
+
+ + + +

+ +Let's say you have three hosts (named "host1", "host2" and "host3") in the host cluster. If you want Nagios to generate a warning alert if one host in the cluster is not UP or a critical alert if two or more hosts are not UP, the the service you define to monitor the host cluster might look something like this: + +

+ + + +
+
+define service{
+
+	...
+
+	check_command	check_host_cluster!"Super Host Cluster"!1!2!$HOSTSTATEID:host1$,$HOSTSTATEID:host2$,$HOSTSTATEID:host3$
+
+	...
+
+	}
+
+
+ + + +

+ +It is important to notice that we are passing a comma-delimited list of on-demand host state macros to the $ARG4$ macro in the cluster check command. That's important! Nagios will fill those on-demand macros in with the current host state IDs (numerical values, rather than text strings) of the individual members of the cluster. + +

+ + + +

+ +That's it! Nagios will periodically check the status of the host cluster and send notifications to you when its status is degraded (assuming you've enabled notification for the service). Note that for thehost definitions of each cluster member, you will most likely want to disable notifications when the host goes down . Remeber that you don't care as much about the status of any individual host as you do the overall status of the cluster. Depending on your network layout and what you're trying to accomplish, you may wish to leave notifications for unreachable states enabled for the host definitions. + +

+ + + +
+ + + + + + + diff --git a/docs/config.html b/docs/config.html new file mode 100644 index 0000000..bc45db1 --- /dev/null +++ b/docs/config.html @@ -0,0 +1,200 @@ + + + + + + + + +Configuration Overview + + + + + + + + + + + + + + + +
+ +Nagios + +

Configuration Overview

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Main Configuration File, Object Configuration Overview, CGI Configuration File + +

+ + + +

+ +Introduction + +

+ + + +

+ +There are several different configuration files that you're going to need to create or edit before you start monitoring anything. Be patient! Configuring Nagios can take quite a while, especially if you're first-time user. Once you figure out how things work, it'll all be well worth your time. :-) + +

+ + + +

+ +Note Note: Sample configuration files are installed in the /usr/local/nagios/etc/ directory when you follow the quickstart installation guide. + +

+ + + +Config Overview + + + +

+ +Main Configuration File + +

+ + + +

+ +The main configuration file contains a number of directives that affect how the Nagios daemon operates. This config file is read by both the Nagios daemon and the CGIs. This is where you're going to want to get started in your configuration adventures. + +

+ + + +

+ +Documentation for the main configuration file can be found here. + +

+ + + +

+ +Resource File(s) + +

+ + + +

+ +Resource files can be used to store user-defined macros. The main point of having resource files is to use them to store sensitive configuration information (like passwords), without making them available to the CGIs. + +

+ + + +

+ +You can specify one or more optional resource files by using the resource_file directive in your main configuration file. + +

+ + + +

+ +Object Definition Files + +

+ + + +

+ +Object definition files are used to define hosts, services, hostgroups, contacts, contactgroups, commands, etc. This is where you define all the things you want monitor and how you want to monitor them. + +

+ + + +

+ +You can specify one or more object definition files by using the cfg_file and/or cfg_dir directives in your main configuration file. + +

+ + + +

+ +An introduction to object definitions, and how they relate to each other, can be found here. + +

+ + + +

+ +CGI Configuration File + +

+ + + +

+ +The CGI configuration file contains a number of directives that affect the operation of the CGIs. It also contains a reference the main configuration file, so the CGIs know how you've configured Nagios and where your object defintions are stored. + +

+ + + +

+ +Documentation for the CGI configuration file can be found here. + +

+ + + + + +
+ + + + + + + diff --git a/docs/configcgi.html b/docs/configcgi.html new file mode 100644 index 0000000..8665eb4 --- /dev/null +++ b/docs/configcgi.html @@ -0,0 +1,1519 @@ + + + + + + + + +CGI Configuration File Options + + + + + + + + + + + + + + + +
+ +Nagios + +

CGI Configuration File Options

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Configuration Overview, Information on the CGIs, Authentication And Authorization In The CGIs, CGI Footers and Headers + +

+ + + +

+ +Notes + +

+ +

+ +When creating and/or editing configuration files, keep the following in mind: + +

+ +
    + +
  1. Lines that start with a '#' character are taken to be comments and are not processed + +
  2. Variables names must begin at the start of the line - no white space is allowed before the name + +
  3. Variable names are case-sensitive + +
+ + + +

+ +Sample Configuration + +

+ +

+ +Tip Tip: A sample CGI configuration file (/usr/local/nagios/etc/cgi.cfg) is installed for you when you follow the quickstart installation guide. + +

+ + + +

+ +Config File Location + +

+ +

+ +By default, Nagios expects the CGI configuration file to be named cgi.cfg and located in the config file directory along with the main config file. If you need to change the name of the file or its location, you can configure Apache to pass an environment variable named NAGIOS_CGI_CONFIG (which points to the correct location) to the CGIs. See the Apache documentation for information on how to do this. + +

+ + + +

+ +Configuration File Variables + +

+ + + +

+ +Below you will find descriptions of each main Nagios configuration file option... + +

+ + + + + + + + + + + + + + + +
Main Configuration File Location
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Format:main_config_file=<file_name>
Example:main_config_file=/usr/local/nagios/etc/nagios.cfg
+ + + +

+ +This specifies the location of your main configuration file. The CGIs need to know where to find this file in order to get information about configuration information, current host and service status, etc. + +

+ + + + + + + + + + + + + +
Physical HTML Path
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Format:physical_html_path=<path>
Example:physical_html_path=/usr/local/nagios/share
+ + + +

+ +This is the physical path where the HTML files for Nagios are kept on your workstation or server. Nagios + +assumes that the documentation and images files (used by the CGIs) are stored in subdirectories called docs/ and images/, respectively. + +

+ + + + + + + + + + + + + + + +
URL HTML Path
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Format:url_html_path=<path>
Example:url_html_path=/nagios
+ + + +

+ +If, when accessing Nagios via a web browser, you point to an URL like http://www.myhost.com/nagios, this value + +should be /nagios. Basically, its the path portion of the URL that is used to access the Nagios HTML pages. + +

+ + + + + + + + + + + + + + + +
Authentication Usage
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Format:use_authentication=<0/1>
Example:use_authentication=1
+ + + +

+ +This option controls whether or not the CGIs will use the authentication and authorization functionality when determining what information and commands users have access to. I would strongly suggest that you use the authentication functionality for the CGIs. If you decide not to use authentication, make sure to remove the command CGI to prevent unauthorized users from issuing commands to Nagios. The CGI will not issue commands to Nagios if authentication is disabled, but I would suggest removing it altogether just to be on the safe side. More information on how to setup authentication and configure authorization for the CGIs can be found here. + +

+ + + + + + + + + + + + + + + + + +
Default User Name
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Format:default_user_name=<username>
Example:default_user_name=guest
+ + + +

+ +Setting this variable will define a default username that can access the CGIs. This allows people within a secure domain (i.e., behind a firewall) to access the CGIs without necessarily having to authenticate to the web server. You may want to use this to avoid having to use basic authentication if you are not using a secure server, as basic authentication transmits passwords in clear text over the Internet. + +

+ +

+ +Important: Do not define a default username unless you are running a secure web server and are sure that everyone who has access to the CGIs has been authenticated in some manner! If you define this variable, anyone who has not authenticated to the web server will inherit all rights you assign to this user! + +

+ + + + + + + + + + + + + +
System/Process Information Access
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Format:authorized_for_system_information=<user1>,<user2>,<user3>,...<usern>
Example:authorized_for_system_information=nagiosadmin,theboss
+ + + +

+ +This is a comma-delimited list of names of authenticated users who can view system/process information in the extended information CGI. Users in this list are not automatically authorized to issue system/process commands. If you want users to be able to issue system/process commands as well, you must add them to the authorized_for_system_commands variable. More information on how to setup authentication and configure authorization for the CGIs can be found here. + +

+ + + + + + + + + + + + + + + +
System/Process Command Access
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Format:authorized_for_system_commands=<user1>,<user2>,<user3>,...<usern>
Example:authorized_for_system_commands=nagiosadmin
+ + + +

+ +This is a comma-delimited list of names of authenticated users who can issue system/process commands via the command CGI. Users in this list are not automatically authorized to view system/process information. If you want users to be able to view system/process information as well, you must add them to the authorized_for_system_information variable. More information on how to setup authentication and configure authorization for the CGIs can be found here. + +

+ + + + + + + + + + + + + + + +
Configuration Information Access
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Format:authorized_for_configuration_information=<user1>,<user2>,<user3>,...<usern>
Example:authorized_for_configuration_information=nagiosadmin
+ + + +

+ +This is a comma-delimited list of names of authenticated users who can view configuration information in the configuration CGI. Users in this list can view information on all configured hosts, host groups, services, contacts, contact groups, time periods, and commands. More information on how to setup authentication and configure authorization for the CGIs can be found here. + +

+ + + + + + + + + + + + + + + +
Global Host Information Access
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Format:authorized_for_all_hosts=<user1>,<user2>,<user3>,...<usern>
Example:authorized_for_all_hosts=nagiosadmin,theboss
+ + + +

+ +This is a comma-delimited list of names of authenticated users who can view status and configuration information for all hosts. Users in this list are also automatically authorized to view information for all services. Users in this list are not automatically authorized to issue commands for all hosts or services. If you want users able to issue commands for all hosts and services as well, you must add them to the authorized_for_all_host_commands variable. More information on how to setup authentication and configure authorization for the CGIs can be found here. + +

+ + + + + + + + + + + + + + + +
Global Host Command Access
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Format:authorized_for_all_host_commands=<user1>,<user2>,<user3>,...<usern>
Example:authorized_for_all_host_commands=nagiosadmin
+ + + +

+ +This is a comma-delimited list of names of authenticated users who can issue commands for all hosts via the command CGI. Users in this list are also automatically authorized to issue commands for all services. Users in this list are not automatically authorized to view status or configuration information for all hosts or services. If you want users able to view status and configuration information for all hosts and services as well, you must add them to the authorized_for_all_hosts variable. More information on how to setup authentication and configure authorization for the CGIs can be found here. + +

+ + + + + + + + + + + + + + + +
Global Service Information Access
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Format:authorized_for_all_services=<user1>,<user2>,<user3>,...<usern>
Example:authorized_for_all_services=nagiosadmin,theboss
+ + + +

+ +This is a comma-delimited list of names of authenticated users who can view status and configuration information for all services. Users in this list are not automatically authorized to view information for all hosts. Users in this list are not automatically authorized to issue commands for all services. If you want users able to issue commands for all services as well, you must add them to the authorized_for_all_service_commands variable. More information on how to setup authentication and configure authorization for the CGIs can be found here. + +

+ + + + + + + + + + + + + + + +
Global Service Command Access
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Format:authorized_for_all_service_commands=<user1>,<user2>,<user3>,...<usern>
Example:authorized_for_all_service_commands=nagiosadmin
+ + + +

+ +This is a comma-delimited list of names of authenticated users who can issue commands for all services via the command CGI. Users in this list are not automatically authorized to issue commands for all hosts. Users in this list are not automatically authorized to view status or configuration information for all hosts. If you want users able to view status and configuration information for all services as well, you must add them to the authorized_for_all_services variable. More information on how to setup authentication and configure authorization for the CGIs can be found here. + +

+ + + + + + + + + + + + + + + +
Read-Only Users
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Format:authorized_for_read_only=<user1>,<user2>,<user3>,...<usern>
Example:authorized_for_read_only=john,mark
+ + + +

+ +A comma-delimited list of usernames that have read-only rights in the CGIs. This will block any service or host commands normally shown on the extinfo CGI pages. It will also block comments from being shown to read-only users. + +

+ + + + + + + + + + + + + + + + + + +
Lock Author Names
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Format:lock_author_names=[0/1]
Example:lock_author_names=1
+ + + +

+ +This option allows you to restrict users from changing the author name when submitting comments, acknowledgements, and scheduled downtime from the web interface. If this option is enabled, users will be unable to change the author name associated with the command request. + +

+ + + + + + + + + + + + + + + + + +
Statusmap CGI Background Image
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Format:statusmap_background_image=<image_file>
Example:statusmap_background_image=smbackground.gd2
+ + + +

+ +This option allows you to specify an image to be used as a background in the statusmap CGI if you use the user-supplied coordinates layout method. The background image is not be available in any other layout methods. It is assumed that the image resides in the HTML images path (i.e. /usr/local/nagios/share/images). This path is automatically determined by appending "/images" to the path specified by the physical_html_path directive. Note: The image file can be in GIF, JPEG, PNG, or GD2 format. However, GD2 format (preferably in uncompressed format) is recommended, as it will reduce the CPU load when the CGI generates the map image. + +

+ + + + + + + + + + + + + + + + + +
Statusmap CGI Color Transparency Indexes
+ +
+ + + + + + + + + + + + + + +
Format: +color_transparency_index_r=<0-255>
+color_transparency_index_g=<0-255>
+color_transparency_index_b=<0-255>
+
Example: +color_transparency_index_r=255
+color_transparency_index_g=255
+color_transparency_index_b=255
+
+ + + +

+These options set the r,g,b values of the background color used the statusmap CGI, +so normal browsers that can't show real png transparency set the desired color as a background color instead (to make it look pretty). Defaults to white: (R,G,B) = (255,255,255). +

+
+ + + + + + + + + + + +
Default Statusmap Layout Method
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Format:default_statusmap_layout=<layout_number>
Example:default_statusmap_layout=4
+ + + +

+ +This option allows you to specify the default layout method used by the statusmap CGI. Valid options are: + +

+ + + + + + + + + + + + + + + + + + + + + +
<layout_number> ValueLayout Method
0User-defined coordinates
1Depth layers
2Collapsed tree
3Balanced tree
4Circular
5Circular (Marked Up)
6Circular (Balloon)
+ + + + + + + + + + + + + + + +
Statuswrl CGI Include World
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Format:statuswrl_include=<vrml_file>
Example:statuswrl_include=myworld.wrl
+ + + +

+ +This option allows you to include your own objects in the generated VRML world. It is assumed that the file resides in the path specified by the physical_html_path directive. Note: This file must be a fully qualified VRML world (i.e. you can view it by itself in a VRML browser). + +

+ + + + + + + + + + + + + + + + + +
Default Statuswrl Layout Method
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Format:default_statuswrl_layout=<layout_number>
Example:default_statuswrl_layout=4
+ + + +

+ +This option allows you to specify the default layout method used by the statuswrl CGI. Valid options are: + +

+ + + + + + + + + + + + + + + +
<layout_number> ValueLayout Method
0User-defined coordinates
2Collapsed tree
3Balanced tree
4Circular
+ + + + + + + + + + + + + + + +
CGI Refresh Rate
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Format:refresh_rate=<rate_in_seconds>
Example:refresh_rate=90
+ + + +

+ +This option allows you to specify the number of seconds between page refreshes for the status, statusmap, and extinfo CGIs. + +

+ + + + + + + + + + + + + + + +
Audio Alerts
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Formats: + +host_unreachable_sound=<sound_file>
+ +host_down_sound=<sound_file>
+ +service_critical_sound=<sound_file>
+ +service_warning_sound=<sound_file>
+ +service_unknown_sound=<sound_file>
+ +
Examples: + +host_unreachable_sound=hostu.wav
+ +host_down_sound=hostd.wav
+ +service_critical_sound=critical.wav
+ +service_warning_sound=warning.wav
+ +service_unknown_sound=unknown.wav
+ +
+ + + +

+ +These options allow you to specify an audio file that should be played in your browser if there are problems when you are viewing the status CGI. If there are problems, the audio file for the most critical type of problem will be played. The most critical type of problem is on or more unreachable hosts, while the least critical is one or more services in an unknown state (see the order in the example above). Audio files are assumed to be in the media/ subdirectory in your HTML directory (i.e. /usr/local/nagios/share/media). + +

+ + + + + + + + + + + + + +
Ping Syntax
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Format:ping_syntax=<command>
Example:ping_syntax=/bin/ping -n -U -c 5 $HOSTADDRESS$
+ + + +

+ +This option determines what syntax should be used when attempting to ping a host from the WAP interface (using + +the statuswml CGI. You must include the full path to the ping binary, along with all required options. The $HOSTADDRESS$ macro is substituted with the address of the host before the command is executed. + +

+ + + + + + + + + + + + + + + +
Escape HTML Tags Option
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Format:escape_html_tags=[0/1]
Example:escape_html_tags=1
+ + + +

+ +This option determines whether or not HTML tags in host and service (plugin) output is escaped in the CGIs. If you enable this option, your plugin output will not be able to contain clickable hyperlinks. + +

+ + + + + + + + + + + + + + + +
Notes URL Target
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Format:notes_url_target=[target]
Example:notes_url_target=_blank
+ + + +

+ +This option determines the name of the frame target that notes URLs should be displayed in. Valid options include _blank, _self, _top, _parent, or any other valid target name. + +

+ + + + + + + + + + + + + + + +
Action URL Target
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Format:action_url_target=[target]
Example:action_url_target=_blank
+ + + +

+ +This option determines the name of the frame target that action URLs should be displayed in. Valid options include _blank, _self, _top, _parent, or any other valid target name. + +

+ + + + + + + + + + + + + + + +
Splunk Integration Option
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Format:enable_splunk_integration=[0/1]
Example:enable_splunk_integration=1
+ + + +

+ +This option determines whether integration functionality with Splunk is enabled in the web interface. If enabled, you'll be presented with "Splunk It" links in various places in the CGIs (log file, alert history, host/service detail, etc). Useful if you're trying to research why a particular problem occurred. For more information on Splunk, visit http://www.splunk.com/. + +

+ + + + + + + + + + + + + +
Splunk URL
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Format:splunk_url=<path>
Example:splunk_url=http://127.0.0.1:8000/
+ + + +

+ +This option is used to define the base URL to your Splunk interface. This URL is used by the CGIs when creating links if the enable_splunk_integration option is enabled. + +

+
+ + + + + +
+ + + + + + + diff --git a/docs/configmain.html b/docs/configmain.html new file mode 100644 index 0000000..e25f7b9 --- /dev/null +++ b/docs/configmain.html @@ -0,0 +1,7038 @@ + + + + + + + + +Main Configuration File Options + + + + + + + + + + + + + + + +
+ +Nagios + +

Main Configuration File Options

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +

+ + + +

+ +Notes + +

+ +

+ +When creating and/or editing configuration files, keep the following in mind: + +

+ +
    + +
  1. Lines that start with a '#' character are taken to be comments and are not processed + +
  2. Variables names must begin at the start of the line - no white space is allowed before the name + +
  3. Variable names are case-sensitive + +
+ + + +

+ +Sample Configuration File + +

+ +

+ +Tip Tip: A sample main configuration file (/usr/local/nagios/etc/nagios.cfg) is installed for you when you follow the quickstart installation guide. + +

+ + + +

+ +Config File Location + +

+ + + +

+ +The main configuration file is usually named nagios.cfg and located in the /usr/local/nagios/etc/ directory. + +

+ + + + + +

+ +Configuration File Variables + +

+ + + + + + + +

+ +Below you will find descriptions of each main Nagios configuration file option... + +

+ + + + + + + + + + + + + + + +
Log File
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:log_file=<file_name>
Example:log_file=/usr/local/nagios/var/nagios.log
+ + + +

+ +This variable specifies where Nagios should create its main log file. This should be the first + +variable that you define in your configuration file, as Nagios will try to write errors that it + +finds in the rest of your configuration data to this file. If you have log rotation enabled, this file will automatically be rotated every hour, day, week, or month. + +

+ + + + + + + + + + + + + + + +
Object Configuration File
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:cfg_file=<file_name>
Example: + +cfg_file=/usr/local/nagios/etc/hosts.cfg
+ +cfg_file=/usr/local/nagios/etc/services.cfg
+ +cfg_file=/usr/local/nagios/etc/commands.cfg + +
+ + + +

+ +This directive is used to specify an object configuration file containing object definitions that Nagios should use for monitoring. Object configuration files contain definitions for hosts, host groups, contacts, contact groups, services, commands, etc. You can seperate your configuration information into several files and specify multiple cfg_file= statements to have each of them processed. + +

+ + + + + + + + + + + + + + + +
Object Configuration Directory
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:cfg_dir=<directory_name>
Example: + +cfg_dir=/usr/local/nagios/etc/commands
+ +cfg_dir=/usr/local/nagios/etc/services
+ +cfg_dir=/usr/local/nagios/etc/hosts + +
+ + + +

+ +This directive is used to specify a directory which contains object configuration files that Nagios should use for monitoring. All files in the directory with a .cfg extension are processed as object config files. Additionally, Nagios will recursively process all config files in subdirectories of the directory you specify here. You can seperate your configuration files into different directories and specify multiple cfg_dir= statements to have all config files in each directory processed. + +

+ + + + + + + + + + + + + + + + + +
Object Cache File
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:object_cache_file=<file_name>
Example: + +object_cache_file=/usr/local/nagios/var/objects.cache + +
+ + + +

+ +This directive is used to specify a file in which a cached copy of object definitions should be stored. The cache file is (re)created every time Nagios is (re)started and is used by the CGIs. It is intended to speed up config file caching in the CGIs and allow you to edit the source object config files while Nagios is running without affecting the output displayed in the CGIs. + +

+ + + + + + + + + + + + + + + +
Precached Object File
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:precached_object_file=<file_name>
Example: + +precached_object_file=/usr/local/nagios/var/objects.precache + +
+ + + +

+ +This directive is used to specify a file in which a pre-processed, pre-cached copy of object definitions should be stored. This file can be used to drastically improve startup times in large/complex Nagios installations. Read more information on how to speed up start times here. + +

+ + + + + + + + + + + + + + + +
Resource File
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:resource_file=<file_name>
Example:resource_file=/usr/local/nagios/etc/resource.cfg
+ + + +

+ +This is used to specify an optional resource file that can contain $USERn$ macro definitions. $USERn$ macros are useful for storing usernames, passwords, and items commonly used in command definitions (like directory paths). The CGIs will not attempt to read resource files, so you can set restrictive permissions (600 or 660) on them to protect sensitive information. You can include multiple resource files by adding multiple resource_file statements to the main config file - Nagios will process them all. See the sample resource.cfg file in the sample-config/ subdirectory of the Nagios distribution for an example of how to define $USERn$ macros. + +

+ + + + + + + + + + + + + + + +
Temp File
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:temp_file=<file_name>
Example:temp_file=/usr/local/nagios/var/nagios.tmp
+ + + +

+ +This is a temporary file that Nagios periodically creates to use when updating comment data, status data, etc. The file is deleted when it is no longer needed. + +

+ + + + + + + + + + + + + +
Temp Path
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:temp_path=<dir_name>
Example:temp_path=/tmp
+ + + +

+ +This is a directory that Nagios can use as scratch space for creating temporary files used during the monitoring process. You should run tmpwatch, or a similiar utility, on this directory occassionally to delete files older than 24 hours. + +

+ + + + + + + + + + + + + + + +
Status File
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:status_file=<file_name>
Example:status_file=/usr/local/nagios/var/status.dat
+ + + +

+ +This is the file that Nagios uses to store the current status, comment, and downtime information. This file is used by the CGIs so that current monitoring status can be reported via a web interface. The CGIs must have read access to this file in order to function properly. This file is deleted every time Nagios stops and recreated when it starts. + +

+ + + + + + + + + + + + + + + +
Status File Update Interval
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:status_update_interval=<seconds>
Example:status_update_interval=15
+ + + +

+ +This setting determines how often (in seconds) that Nagios will update status data in the status file. The minimum update interval is 1 second. + +

+ + + + + + + + + + + + + + + +
Nagios User
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:nagios_user=<username/UID>
Example:nagios_user=nagios
+ + + +

+ +This is used to set the effective user that the Nagios process should run as. After initial program startup and before starting to monitor anything, Nagios will drop its effective privileges and run as this user. You may specify either a username or a UID. + +

+ + + + + + + + + + + + + + + +
Nagios Group
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:nagios_group=<groupname/GID>
Example:nagios_group=nagios
+ + + +

+ +This is used to set the effective group that the Nagios process should run as. After initial program startup and before starting to monitor anything, Nagios will drop its effective privileges and run as this group. You may specify either a groupname or a GID. + +

+ + + + + + + + + + + + + + + +
Notifications Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:enable_notifications=<0/1>
Example:enable_notifications=1
+ + + +

+ +This option determines whether or not Nagios will send out notifications when it initially (re)starts. If this option is disabled, Nagios will not send out notifications for any host or service. Note: If you have state retention enabled, Nagios will ignore this setting when it (re)starts and use the last known setting for this option (as stored in the state retention file), unless you disable the use_retained_program_state option. If you want to change this option when state retention is active (and the use_retained_program_state is enabled), you'll have to use the appropriate external command or change it via the web interface. Values are as follows: + +

+ + + + + + + + + + + + + + + + + +
Service Check Execution Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:execute_service_checks=<0/1>
Example:execute_service_checks=1
+ + + +

+ +This option determines whether or not Nagios will execute service checks when it initially (re)starts. If this option is disabled, Nagios will not actively execute any service checks and will remain in a sort of "sleep" mode (it can still accept passive checks unless you've disabled them). This option is most often used when configuring backup monitoring servers, as described in the documentation on redundancy, or when setting up a distributed monitoring environment. Note: If you have state retention enabled, Nagios will ignore this setting when it (re)starts and use the last known setting for this option (as stored in the state retention file), unless you disable the use_retained_program_state option. If you want to change this option when state retention is active (and the use_retained_program_state is enabled), you'll have to use the appropriate external command or change it via the web interface. Values are as follows: + +

+ + + + + + + + + + + + + + + + + +
Passive Service Check Acceptance Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:accept_passive_service_checks=<0/1>
Example:accept_passive_service_checks=1
+ + + +

+ +This option determines whether or not Nagios will accept passive service checks when it initially (re)starts. If this option is disabled, Nagios will not accept any passive service checks. Note: If you have state retention enabled, Nagios will ignore this setting when it (re)starts and use the last known setting for this option (as stored in the state retention file), unless you disable the use_retained_program_state option. If you want to change this option when state retention is active (and the use_retained_program_state is enabled), you'll have to use the appropriate external command or change it via the web interface. Values are as follows: + +

+ + + + + + + + + + + + + + + + + +
Host Check Execution Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:execute_host_checks=<0/1>
Example:execute_host_checks=1
+ + + +

+ +This option determines whether or not Nagios will execute on-demand and regularly scheduled host checks when it initially (re)starts. If this option is disabled, Nagios will not actively execute any host checks, although it can still accept passive host checks unless you've disabled them). This option is most often used when configuring backup monitoring servers, as described in the documentation on redundancy, or when setting up a distributed monitoring environment. Note: If you have state retention enabled, Nagios will ignore this setting when it (re)starts and use the last known setting for this option (as stored in the state retention file), unless you disable the use_retained_program_state option. If you want to change this option when state retention is active (and the use_retained_program_state is enabled), you'll have to use the appropriate external command or change it via the web interface. Values are as follows: + +

+ + + + + + + + + + + + + + + + + +
Passive Host Check Acceptance Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:accept_passive_host_checks=<0/1>
Example:accept_passive_host_checks=1
+ + + +

+ +This option determines whether or not Nagios will accept passive host checks when it initially (re)starts. If this option is disabled, Nagios will not accept any passive host checks. Note: If you have state retention enabled, Nagios will ignore this setting when it (re)starts and use the last known setting for this option (as stored in the state retention file), unless you disable the use_retained_program_state option. If you want to change this option when state retention is active (and the use_retained_program_state is enabled), you'll have to use the appropriate external command or change it via the web interface. Values are as follows: + +

+ + + + + + + + + + + + + + + + + +
Event Handler Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:enable_event_handlers=<0/1>
Example:enable_event_handlers=1
+ + + +

+ +This option determines whether or not Nagios will run event handlers when it initially (re)starts. If this option is disabled, Nagios will not run any host or service event handlers. Note: If you have state retention enabled, Nagios will ignore this setting when it (re)starts and use the last known setting for this option (as stored in the state retention file), unless you disable the use_retained_program_state option. If you want to change this option when state retention is active (and the use_retained_program_state is enabled), you'll have to use the appropriate external command or change it via the web interface. Values are as follows: + +

+ + + + + + + + + + + + + + + + + +
Log Rotation Method
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:log_rotation_method=<n/h/d/w/m>
Example:log_rotation_method=d
+ + + +

+ +This is the rotation method that you would like Nagios to use for your log file. Values are as follows: + +

+ + + + + + + + + + + + + + + + + +
Log Archive Path
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:log_archive_path=<path>
Example:log_archive_path=/usr/local/nagios/var/archives/
+ + + +

+ +This is the directory where Nagios should place log files that have been rotated. This option is ignored if you choose to not use the log rotation functionality. + +

+ + + + + + + + + + + + + + + +
External Command Check Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:check_external_commands=<0/1>
Example:check_external_commands=1
+ + + +

+ +This option determines whether or not Nagios will check the command file for commands that should be executed. This option must be enabled if you plan on using the command CGI to issue commands via the web interface. More information on external commands can be found here. + +

+ + + + + + + + + + + + + + + + + +
External Command Check Interval
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:command_check_interval=<xxx>[s]
Example:command_check_interval=1
+ + + +

+ +If you specify a number with an "s" appended to it (i.e. 30s), this is the number of seconds to wait between external command checks. If you leave off the "s", this is the number of "time units" to wait between external command checks. Unless you've changed the interval_length value (as defined below) from the default value of 60, this number will mean minutes. + +

+ + + +

+ +Note: By setting this value to -1, Nagios will check for external commands as often as possible. Each time Nagios checks for external commands it will read and process all commands present in the command file before continuing on with its other duties. More information on external commands can be found here. + +

+ + + + + + + + + + + + + + + +
External Command File
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:command_file=<file_name>
Example:command_file=/usr/local/nagios/var/rw/nagios.cmd
+ + + +

+ +This is the file that Nagios will check for external commands to process. The command CGI writes commands to this file. The external command file is implemented as a named pipe (FIFO), which is created when Nagios starts and removed when it shuts down. If the file exists when Nagios starts, the Nagios process will terminate with an error message. More information on external commands can be found here. + +

+ + + + + + + + + + + + + + + +
External Command Buffer Slots
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:external_command_buffer_slots=<#>
Example:external_command_buffer_slots=512
+ + + +

+ +Note: This is an advanced feature. This option determines how many buffer slots Nagios will reserve for caching external commands that have been read from the external command file by a worker thread, but have not yet been processed by the main thread of the Nagios deamon. Each slot can hold one external command, so this option essentially determines how many commands can be buffered. For installations where you process a large number of passive checks (e.g. distributed setups), you may need to increase this number. You should consider using MRTG to graph Nagios' usage of external command buffers. You can read more on how to configure graphing here. + +

+ + + + + + + + + + + + + + + +
Update Checks
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:check_for_updates=<0/1>
Example:check_for_updates=1
+ + + +

+ +This option determines whether Nagios will automatically check to see if new updates (releases) are available. It is recommend that you enable this option to ensure that you stay on top of the latest critical patches to Nagios. Nagios is critical to you - make sure you keep it in good shape. Nagios will check once a day for new updates. Data collected by Nagios Enterprises from the update check is processed in accordance with our privacy policy - see http://api.nagios.org for details. + +

+ + + + + + + + + + + + + + + +
Bare Update Checks
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:bare_update_checks=<0/1>
Example:bare_update_checks
+ + + +

+ +This option deterines what data Nagios will send to api.nagios.org when it checks for updates. By default, Nagios will send information on the current version of Nagios you have installed, as well as an indicator as to whether this was a new installation or not. Nagios Enterprises uses this data to determine the number of users running specific version of Nagios. Enable this option if you do not wish for this information to be sent. + +

+ + + + + + + + + + + + + + + +
Lock File
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:lock_file=<file_name>
Example:lock_file=/tmp/nagios.lock
+ + + +

+ +This option specifies the location of the lock file that Nagios should create when it runs as a daemon (when started with the -d command line argument). This file contains the process id (PID) number of the running Nagios process. + +

+ + + + + + + + + + + + + + + +
State Retention Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:retain_state_information=<0/1>
Example:retain_state_information=1
+ + + +

+ +This option determines whether or not Nagios will retain state information for hosts and services between program restarts. If you enable this option, you should supply a value for the state_retention_file variable. When enabled, Nagios will save all state information for hosts and service before it shuts down (or restarts) and will read in previously saved state information when it starts up again. + +

+ + + + + + + + + + + + + + + + + +
State Retention File
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:state_retention_file=<file_name>
Example:state_retention_file=/usr/local/nagios/var/retention.dat
+ + + +

+ +This is the file that Nagios will use for storing status, downtime, and comment information before it shuts down. When Nagios is restarted it will use the information stored in this file for setting the initial states of services and hosts before it starts monitoring anything. In order to make Nagios retain state information between program restarts, you must enable the retain_state_information option. + +

+ + + + + + + + + + + + + + + +
Automatic State Retention Update Interval
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:retention_update_interval=<minutes>
Example:retention_update_interval=60
+ + + +

+ +This setting determines how often (in minutes) that Nagios will automatically save retention data during normal operation. If you set this value to 0, Nagios will not save retention data at regular intervals, but it will still save retention data before shutting down or restarting. If you have disabled state retention (with the retain_state_information option), this option has no effect. + +

+ + + + + + + + + + + + + + + +
Use Retained Program State Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:use_retained_program_state=<0/1>
Example:use_retained_program_state=1
+ + + +

+ +This setting determines whether or not Nagios will set various program-wide state variables based on the values saved in the retention file. Some of these program-wide state variables that are normally saved across program restarts if state retention is enabled include the enable_notifications, enable_flap_detection, enable_event_handlers, execute_service_checks, and accept_passive_service_checks options. If you do not have state retention enabled, this option has no effect. + +

+ + + + + + + + + + + + + + + + + +
Use Retained Scheduling Info Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:use_retained_scheduling_info=<0/1>
Example:use_retained_scheduling_info=1
+ + + +

+ +This setting determines whether or not Nagios will retain scheduling info (next check times) for hosts and services when it restarts. If you are adding a large number (or percentage) of hosts and services, I would recommend disabling this option when you first restart Nagios, as it can adversely skew the spread of initial checks. Otherwise you will probably want to leave it enabled. + +

+ + + + + + + + + + + + + + + + + + + +
Retained Host and Service Attribute Masks
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format: + +retained_host_attribute_mask=<number>
+ +retained_service_attribute_mask=<number> + +
Example: + +retained_host_attribute_mask=0
+ +retained_service_attribute_mask=0 + +
+ + + +

+ +WARNING: This is an advanced feature. You'll need to read the Nagios source code to use this option effectively. + +

+ +

+ +These options determine which host or service attributes are NOT retained across program restarts. The values for these options are a bitwise AND of values specified by the "MODATTR_" definitions in the include/common.h source code file. By default, all host and service attributes are retained. + +

+ + + + + + + + + + + + + + + + + +
Retained Process Attribute Masks
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format: + +retained_process_host_attribute_mask=<number>
+ +retained_process_service_attribute_mask=<number> + +
Example: + +retained_process_host_attribute_mask=0
+ +retained_process_service_attribute_mask=0 + +
+ + + +

+ +WARNING: This is an advanced feature. You'll need to read the Nagios source code to use this option effectively. + +

+ +

+ +These options determine which process attributes are NOT retained across program restarts. There are two masks because there are often separate host and service process attributes that can be changed. For example, host checks can be disabled at the program level, while service checks are still enabled. The values for these options are a bitwise AND of values specified by the "MODATTR_" definitions in the include/common.h source code file. By default, all process attributes are retained. + +

+ + + + + + + + + + + + + + + + + +
Retained Contact Attribute Masks
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format: + +retained_contact_host_attribute_mask=<number>
+ +retained_contact_service_attribute_mask=<number> + +
Example: + +retained_contact_host_attribute_mask=0
+ +retained_contact_service_attribute_mask=0 + +
+ + + +

+ +WARNING: This is an advanced feature. You'll need to read the Nagios source code to use this option effectively. + +

+ +

+ +These options determine which contact attributes are NOT retained across program restarts. There are two masks because there are often separate host and service contact attributes that can be changed. The values for these options are a bitwise AND of values specified by the "MODATTR_" definitions in the include/common.h source code file. By default, all process attributes are retained. + +

+ + + + + + + + + + + + + + + +
Syslog Logging Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:use_syslog=<0/1>
Example:use_syslog=1
+ + + +

+ +This variable determines whether messages are logged to the syslog facility on your local host. Values + +are as follows: + +

+ + + + + + + + + + + + + + + + + +
Notification Logging Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:log_notifications=<0/1>
Example:log_notifications=1
+ + + +

+ +This variable determines whether or not notification messages are logged. If you have a lot of contacts + +or regular service failures your log file will grow relatively quickly. Use this option to keep contact + +notifications from being logged. + +

+ + + + + + + + + + + + + + + + + +
Service Check Retry Logging Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:log_service_retries=<0/1>
Example:log_service_retries=1
+ + + +

+ +This variable determines whether or not service check retries are logged. Service check retries occur when a + +service check results in a non-OK state, but you have configured Nagios to retry the service more than once before + +responding to the error. Services in this situation are considered to be in "soft" states. Logging service check retries + +is mostly useful when attempting to debug Nagios or test out service event handlers. + +

+ + + + + + + + + + + + + + + + + +
Host Check Retry Logging Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:log_host_retries=<0/1>
Example:log_host_retries=1
+ + + +

+ +This variable determines whether or not host check retries are logged. Logging host check retries + +is mostly useful when attempting to debug Nagios or test out host event handlers. + +

+ + + + + + + + + + + + + + + + + +
Event Handler Logging Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:log_event_handlers=<0/1>
Example:log_event_handlers=1
+ + + +

+ +This variable determines whether or not service and host event handlers are logged. + +Event handlers are optional commands that can be run whenever a service or hosts changes state. Logging event handlers + +is most useful when debugging Nagios or first trying out your event handler scripts. + +

+ + + + + + + + + + + + + + + + + +
Initial States Logging Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:log_initial_states=<0/1>
Example:log_initial_states=1
+ + + +

+ +This variable determines whether or not Nagios will force all initial host and service states to be logged, even if they result in an OK state. Initial service and host states are normally only logged when there is a problem on the first check. Enabling this option is useful if you are using an application that scans the log file to determine long-term state statistics for services and hosts. + +

+ + + + + + + + + + + + + + + + + + + +
External Command Logging Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:log_external_commands=<0/1>
Example:log_external_commands=1
+ + + +

+ +This variable determines whether or not Nagios will log external commands that it receives from the external command file. Note: This option does not control whether or not passive service checks (which are a type of external command) get logged. To enable or disable logging of passive checks, use the log_passive_checks option. + +

+ + + + + + + + + + + + + + + + + + + + + +
Passive Check Logging Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:log_passive_checks=<0/1>
Example:log_passive_checks=1
+ + + +

+ +This variable determines whether or not Nagios will log passive host and service checks that it receives from the external command file. If you are setting up a distributed monitoring environment or plan on handling a large number of passive checks on a regular basis, you may wish to disable this option so your log file doesn't get too large. + +

+ + + + + + + + + + + + + + + + + + + +
Global Host Event Handler Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:global_host_event_handler=<command>
Example:global_host_event_handler=log-host-event-to-db
+ + + +

+ +This option allows you to specify a host event handler command that is to be run for every host state change. The global event handler is executed immediately prior to the event handler that you have optionally specified in each host definition. The command argument is the short name of a command that you define in your object configuration file. The maximum amount of time that this command can run is controlled by the event_handler_timeout option. More information on event handlers can be found here. + +

+ + + + + + + + + + + + + + + +
Global Service Event Handler Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:global_service_event_handler=<command>
Example:global_service_event_handler=log-service-event-to-db
+ + + +

+ +This option allows you to specify a service event handler command that is to be run for every service state change. The global event handler is executed immediately prior to the event handler that you have optionally specified in each service definition. The command argument is the short name of a command that you define in your object configuration file. The maximum amount of time that this command can run is controlled by the event_handler_timeout option. More information on event handlers can be found here. + +

+ + + + + + + + + + + + + + + +
Inter-Check Sleep Time
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:sleep_time=<seconds>
Example:sleep_time=1
+ + + +

+ +This is the number of seconds that Nagios will sleep before checking to see if the next service or host check in the scheduling queue should be executed. Note that Nagios will only sleep after it "catches up" with queued service checks that have fallen behind. + +

+ + + + + + + + + + + + + + + +
Service Inter-Check Delay Method
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:service_inter_check_delay_method=<n/d/s/x.xx>
Example:service_inter_check_delay_method=s
+ + + +

+ +This option allows you to control how service checks are initially "spread out" in the event queue. Using a "smart" delay calculation (the default) will cause Nagios to calculate an average check interval and spread initial checks of all services out over that interval, thereby helping to eliminate CPU load spikes. Using no delay is generally not recommended, as it will cause all service checks to be scheduled for execution at the same time. This means that you will generally have large CPU spikes when the services are all executed in parallel. More information on how to estimate how the inter-check delay affects service check scheduling can be found here. Values are as follows: + +

+ + + + + + + + + + + + + + + + + +
Maximum Service Check Spread
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:max_service_check_spread=<minutes>
Example:max_service_check_spread=30
+ + + +

+ +This option determines the maximum number of minutes from when Nagios starts that all services (that are scheduled to be regularly checked) are checked. This option will automatically adjust the service inter-check delay method (if necessary) to ensure that the initial checks of all services occur within the timeframe you specify. In general, this option will not have an affect on service check scheduling if scheduling information is being retained using the use_retained_scheduling_info option. Default value is 30 (minutes). + +

+ + + + + + + + + + + + + + + +
Service Interleave Factor
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:service_interleave_factor=<s|x>
Example:service_interleave_factor=s
+ + + +

+ +This variable determines how service checks are interleaved. Interleaving allows for a more even distribution of service checks, reduced load on remote hosts, and faster overall detection of host problems. Setting this value to 1 is equivalent to not interleaving the service checks (this is how versions of Nagios previous to 0.0.5 worked). Set this value to s (smart) for automatic calculation of the interleave factor unless you have a specific reason to change it. The best way to understand how interleaving works is to watch the status CGI (detailed view) when Nagios is just starting. You should see that the service check results are spread out as they begin to appear. More information on how interleaving works can be found here. + +

+ + + + + + + + + + + + + + + +
Maximum Concurrent Service Checks
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:max_concurrent_checks=<max_checks>
Example:max_concurrent_checks=20
+ + + +

+ +This option allows you to specify the maximum number of service checks that can be run in parallel at any given time. Specifying a value of 1 for this variable essentially prevents any service checks from being run in parallel. Specifying a value of 0 (the default) does not place any restrictions on the number of concurrent checks. You'll have to modify this value based on the system resources you have available on the machine that runs Nagios, as it directly affects the maximum load that will be imposed on the system (processor utilization, memory, etc.). More information on how to estimate how many concurrent checks you should allow can be found here. + +

+ + + + + + + + + + + + + + + +
Check Result Reaper Frequency
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:check_result_reaper_frequency=<frequency_in_seconds>
Example:check_result_reaper_frequency=5
+ + + +

+ +This option allows you to control the frequency in seconds of check result "reaper" events. "Reaper" events process the results from host and service checks that have finished executing. These events consitute the core of the monitoring logic in Nagios. + +

+ + + + + + + + + + + + + + + + + +
Maximum Check Result Reaper Time
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:max_check_result_reaper_time=<seconds>
Example:max_check_result_reaper_time=30
+ + + +

+ +This option allows you to control the maximum amount of time in seconds that host and service check result "reaper" events are allowed to run. "Reaper" events process the results from host and service checks that have finished executing. If there are a lot of results to process, reaper events may take a long time to finish, which might delay timely execution of new host and service checks. This variable allows you to limit the amount of time that an individual reaper event will run before it hands control back over to Nagios for other portions of the monitoring logic. + +

+ + + + + + + + + + + + + + + + + +
Check Result Path
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:check_result_path=<path>
Example:check_result_path=/var/spool/nagios/checkresults
+ + + +

+ +This options determines which directory Nagios will use to temporarily store host and service check results before they are processed. This directory should not be used to store any other files, as Nagios will periodically clean this directory of old file (see the max_check_result_file_age option for more information). + +

+ + + +

+ +Note: Make sure that only a single instance of Nagios has access to the check result path. If multiple instances of Nagios have their check result path set to the same directory, you will run into problems with check results being processed (incorrectly) by the wrong instance of Nagios! + +

+ + + + + + + + + + + + + + + +
Max Check Result File Age
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:max_check_result_file_age=<seconds>
Example:max_check_result_file_age=3600
+ + + +

+ +This options determines the maximum age in seconds that Nagios will consider check result files found in the check_result_path directory to be valid. Check result files that are older that this threshold will be deleted by Nagios and the check results they contain will not be processed. By using a value of zero (0) with this option, Nagios will process all check result files - even if they're older than your hardware :-). + +

+ + + + + + + + + + + + + +
Host Inter-Check Delay Method
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:host_inter_check_delay_method=<n/d/s/x.xx>
Example:host_inter_check_delay_method=s
+ + + +

+ +This option allows you to control how host checks that are scheduled to be checked on a regular basis are initially "spread out" in the event queue. Using a "smart" delay calculation (the default) will cause Nagios to calculate an average check interval and spread initial checks of all hosts out over that interval, thereby helping to eliminate CPU load spikes. Using no delay is generally not recommended. Using no delay will cause all host checks to be scheduled for execution at the same time. More information on how to estimate how the inter-check delay affects host check scheduling can be found here.Values are as follows: + +

+ + + + + + + + + + + + + + + + + +
Maximum Host Check Spread
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:max_host_check_spread=<minutes>
Example:max_host_check_spread=30
+ + + +

+ +This option determines the maximum number of minutes from when Nagios starts that all hosts (that are scheduled to be regularly checked) are checked. This option will automatically adjust the host inter-check delay method (if necessary) to ensure that the initial checks of all hosts occur within the timeframe you specify. In general, this option will not have an affect on host check scheduling if scheduling information is being retained using the use_retained_scheduling_info option. Default value is 30 (minutes). + +

+ + + + + + + + + + + + + + + +
Timing Interval Length
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:interval_length=<seconds>
Example:interval_length=60
+ + + +

+ +This is the number of seconds per "unit interval" used for timing in the scheduling queue, re-notifications, etc. "Units intervals" are used in the object configuration file to determine how often to run a service check, how often to re-notify a contact, etc. + +

+ +

+ +Important: The default value for this is set to 60, which means that a "unit value" of 1 in the object configuration file will mean 60 seconds (1 minute). I have not really tested other values for this variable, so proceed at your own risk if you decide to do so! + +

+ + + + + + + + + + + + + + + +
Auto-Rescheduling Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:auto_reschedule_checks=<0/1>
Example:auto_reschedule_checks=1
+ + + +

+ +This option determines whether or not Nagios will attempt to automatically reschedule active host and service checks to + + "smooth" them out over time. This can help to balance the load on the monitoring server, as it will attempt to keep the time between consecutive checks consistent, at the expense of executing checks on a more rigid schedule. + +

+ +

+ +WARNING: THIS IS AN EXPERIMENTAL FEATURE AND MAY BE REMOVED IN FUTURE VERSIONS. ENABLING THIS OPTION CAN DEGRADE PERFORMANCE - RATHER THAN INCREASE IT - IF USED IMPROPERLY! + +

+ + + + + + + + + + + + + + + +
Auto-Rescheduling Interval
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:auto_rescheduling_interval=<seconds>
Example:auto_rescheduling_interval=30
+ + + +

+ +This option determines how often (in seconds) Nagios will attempt to automatically reschedule checks. This option only has an effect if the auto_reschedule_checks option is enabled. Default is 30 seconds. + +

+ +

+ +WARNING: THIS IS AN EXPERIMENTAL FEATURE AND MAY BE REMOVED IN FUTURE VERSIONS. ENABLING THE AUTO-RESCHEDULING OPTION CAN DEGRADE PERFORMANCE - RATHER THAN INCREASE IT - IF USED IMPROPERLY! + +

+ + + + + + + + + + + + + + + +
Auto-Rescheduling Window
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:auto_rescheduling_window=<seconds>
Example:auto_rescheduling_window=180
+ + + +

+ +This option determines the "window" of time (in seconds) that Nagios will look at when automatically rescheduling checks. Only host and service checks that occur in the next X seconds (determined by this variable) will be rescheduled. This option only has an effect if the auto_reschedule_checks option is enabled. Default is 180 seconds (3 minutes). + +

+ +

+ +WARNING: THIS IS AN EXPERIMENTAL FEATURE AND MAY BE REMOVED IN FUTURE VERSIONS. ENABLING THE AUTO-RESCHEDULING OPTION CAN DEGRADE PERFORMANCE - RATHER THAN INCREASE IT - IF USED IMPROPERLY! + +

+ + + + + + + + + + + + + + + + + +
Aggressive Host Checking Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:use_aggressive_host_checking=<0/1>
Example:use_aggressive_host_checking=0
+ + + +

+ +Nagios tries to be smart about how and when it checks the status of hosts. In general, disabling this option will allow Nagios to make some smarter decisions and check hosts a bit faster. Enabling this option will increase the amount of time required to check hosts, but may improve reliability a bit. Unless you have problems with Nagios not recognizing that a host recovered, I would suggest not enabling this option. + +

+ + + + + + + + + + + + + + + + + + + + + +
Translate Passive Host Checks Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:translate_passive_host_checks=<0/1>
Example:translate_passive_host_checks=1
+ + + +

+ +This option determines whether or not Nagios will translate DOWN/UNREACHABLE passive host check results to their "correct" state from the viewpoint of the local Nagios instance. This can be very useful in distributed and failover monitoring installations. More information on passive check state translation can be found here. + +

+ + + + + + + + + + + + + + + + + + + + + +
Passive Host Checks Are SOFT Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:passive_host_checks_are_soft=<0/1>
Example:passive_host_checks_are_soft=1
+ + + +

+ +This option determines whether or not Nagios will treat passive host checks as HARD states or SOFT states. By default, a passive host check result will put a host into a HARD state type. You can change this behavior by enabling this option. + +

+ + + + + + + + + + + + + + + + + + + + + +
Predictive Host Dependency Checks Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:enable_predictive_host_dependency_checks=<0/1>
Example:enable_predictive_host_dependency_checks=1
+ + + +

+ +This option determines whether or not Nagios will execute predictive checks of hosts that are being depended upon (as defined in host dependencies) for a particular host when it changes state. Predictive checks help ensure that the dependency logic is as accurate as possible. More information on how predictive checks work can be found here. + +

+ + + + + + + + + + + + + + + + + + + +
Predictive Service Dependency Checks Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:enable_predictive_service_dependency_checks=<0/1>
Example:enable_predictive_service_dependency_checks=1
+ + + +

+ +This option determines whether or not Nagios will execute predictive checks of services that are being depended upon (as defined in service dependencies) for a particular service when it changes state. Predictive checks help ensure that the dependency logic is as accurate as possible. More information on how predictive checks work can be found here. + +

+ + + + + + + + + + + + + + + + + + + + + +
Cached Host Check Horizon
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:cached_host_check_horizon=<seconds>
Example:cached_host_check_horizon=15
+ + + +

+ +This option determines the maximum amount of time (in seconds) that the state of a previous host check is considered current. Cached host states (from host checks that were performed more recently than the time specified by this value) can improve host check performance immensely. Too high of a value for this option may result in (temporarily) inaccurate host states, while a low value may result in a performance hit for host checks. Use a value of 0 if you want to disable host check caching. More information on cached checks can be found here. + +

+ + + + + + + + + + + + + + + + + + + +
Cached Service Check Horizon
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:cached_service_check_horizon=<seconds>
Example:cached_service_check_horizon=15
+ + + +

+ +This option determines the maximum amount of time (in seconds) that the state of a previous service check is considered current. Cached service states (from service checks that were performed more recently than the time specified by this value) can improve service check performance when a lot of service dependencies are used. Too high of a value for this option may result in inaccuracies in the service dependency logic. Use a value of 0 if you want to disable service check caching. More information on cached checks can be found here. + +

+ + + + + + + + + + + + + + + + + + + +
Large Installation Tweaks Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:use_large_installation_tweaks=<0/1>
Example:use_large_installation_tweaks=0
+ + + +

+ +This option determines whether or not the Nagios daemon will take several shortcuts to improve performance. These shortcuts result in the loss of a few features, but larger installations will likely see a lot of benefit from doing so. More information on what optimizations are taken when you enable this option can be found here. + +

+ + + + + + + + + + + + + + + + + + + + + +
Child Process Memory Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:free_child_process_memory=<0/1>
Example:free_child_process_memory=0
+ + + +

+ +This option determines whether or not Nagios will free memory in child processes when they are fork()ed off from the main process. By default, Nagios frees memory. However, if the use_large_installation_tweaks option is enabled, it will not. By defining this option in your configuration file, you are able to override things to get the behavior you want. + +

+ + + + + + + + + + + + + + + + + + + + + +
Child Processes Fork Twice
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:child_processes_fork_twice=<0/1>
Example:child_processes_fork_twice=0
+ + + +

+ +This option determines whether or not Nagios will fork() child processes twice when it executes host and service checks. By default, Nagios fork()s twice. However, if the use_large_installation_tweaks option is enabled, it will only fork() once. By defining this option in your configuration file, you are able to override things to get the behavior you want. + +

+ + + + + + + + + + + + + + + + + + + +
Environment Macros Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:enable_environment_macros=<0/1>
Example:enable_environment_macros=0
+ + + +

+ +This option determines whether or not the Nagios daemon will make all standard macros available as environment variables to your check, notification, event hander, etc. commands. In large Nagios installations this can be problematic because it takes additional memory and (more importantly) CPU to compute the values of all macros and make them available to the environment. + +

+ + + + + + + + + + + + + + + + + + + + + +
Flap Detection Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:enable_flap_detection=<0/1>
Example:enable_flap_detection=0
+ + + +

+ +This option determines whether or not Nagios will try and detect hosts and services that are "flapping". Flapping occurs when a host or service changes between states too frequently, resulting in a barrage of notifications being sent out. When Nagios detects that a host or service is flapping, it will temporarily suppress notifications for that host/service until it stops flapping. Flap detection is very experimental at this point, so use this feature with caution! More information on how flap detection and handling works can be found here. Note: If you have state retention enabled, Nagios will ignore this setting when it (re)starts and use the last known setting for this option (as stored in the state retention file), unless you disable the use_retained_program_state option. If you want to change this option when state retention is active (and the use_retained_program_state is enabled), you'll have to use the appropriate external command or change it via the web interface. + +

+ + + + + + + + + + + + + + + + + +
Low Service Flap Threshold
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:low_service_flap_threshold=<percent>
Example:low_service_flap_threshold=25.0
+ + + +

+ +This option is used to set the low threshold for detection of service flapping. For more information on how flap detection and handling works (and how this option affects things) read this. + +

+ + + + + + + + + + + + + + + +
High Service Flap Threshold
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:high_service_flap_threshold=<percent>
Example:high_service_flap_threshold=50.0
+ + + +

+ +This option is used to set the high threshold for detection of service flapping. For more information on how flap detection and handling works (and how this option affects things) read this. + +

+ + + + + + + + + + + + + + + +
Low Host Flap Threshold
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:low_host_flap_threshold=<percent>
Example:low_host_flap_threshold=25.0
+ + + +

+ +This option is used to set the low threshold for detection of host flapping. For more information on how flap detection and handling works (and how this option affects things) read this. + +

+ + + + + + + + + + + + + + + +
High Host Flap Threshold
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:high_host_flap_threshold=<percent>
Example:high_host_flap_threshold=50.0
+ + + +

+ +This option is used to set the high threshold for detection of host flapping. For more information on how flap detection and handling works (and how this option affects things) read this. + +

+ + + + + + + + + + + + + + + +
Soft State Dependencies Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:soft_state_dependencies=<0/1>
Example:soft_state_dependencies=0
+ + + +

+ +This option determines whether or not Nagios will use soft state information when checking host and service dependencies. Normally Nagios will only use the latest hard host or service state when checking dependencies. If you want it to use the latest state (regardless of whether its a soft or hard state type), enable this option. + +

+ + + + + + + + + + + + + + + + + +
Service Check Timeout
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:service_check_timeout=<seconds>
Example:service_check_timeout=60
+ + + +

+ +This is the maximum number of seconds that Nagios will allow service checks to run. If checks exceed this limit, they are killed and a CRITICAL state is returned. A timeout error will also be logged. + +

+ +

+ +There is often widespread confusion as to what this option really does. It is meant to be used as a last ditch mechanism to kill off plugins which are misbehaving and not exiting in a timely manner. It should be set to something high (like 60 seconds or more), so that each service check normally finishes executing within this time limit. If a service check runs longer than this limit, Nagios will kill it off thinking it is a runaway processes. + +

+ + + + + + + + + + + + + + + +
Host Check Timeout
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:host_check_timeout=<seconds>
Example:host_check_timeout=60
+ + + +

+ +This is the maximum number of seconds that Nagios will allow host checks to run. If checks exceed this limit, they are killed and a CRITICAL state is returned and the host will be assumed to be DOWN. A timeout error will also be logged. + +

+ +

+ +There is often widespread confusion as to what this option really does. It is meant to be used as a last ditch mechanism to kill off plugins which are misbehaving and not exiting in a timely manner. It should be set to something high (like 60 seconds or more), so that each host check normally finishes executing within this time limit. If a host check runs longer than this limit, Nagios will kill it off thinking it is a runaway processes. + +

+ + + + + + + + + + + + + + + +
Event Handler Timeout
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:event_handler_timeout=<seconds>
Example:event_handler_timeout=60
+ + + +

+ +This is the maximum number of seconds that Nagios will allow event handlers to be run. If an event handler exceeds this time limit it will be killed and a warning will be logged. + +

+ +

+ +There is often widespread confusion as to what this option really does. It is meant to be used as a last ditch mechanism to kill off commands which are misbehaving and not exiting in a timely manner. It should be set to something high (like 60 seconds or more), so that each event handler command normally finishes executing within this time limit. If an event handler runs longer than this limit, Nagios will kill it off thinking it is a runaway processes. + +

+ + + + + + + + + + + + + + + +
Notification Timeout
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:notification_timeout=<seconds>
Example:notification_timeout=60
+ + + +

+ +This is the maximum number of seconds that Nagios will allow notification commands to be run. If a notification command exceeds this time limit it will be killed and a warning will be logged. + +

+ +

+ +There is often widespread confusion as to what this option really does. It is meant to be used as a last ditch mechanism to kill off commands which are misbehaving and not exiting in a timely manner. It should be set to something high (like 60 seconds or more), so that each notification command finishes executing within this time limit. If a notification command runs longer than this limit, Nagios will kill it off thinking it is a runaway processes. + +

+ + + + + + + + + + + + + + + +
Obsessive Compulsive Service Processor Timeout
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:ocsp_timeout=<seconds>
Example:ocsp_timeout=5
+ + + +

+ +This is the maximum number of seconds that Nagios will allow an obsessive compulsive service processor command to be run. If a command exceeds this time limit it will be killed and a warning will be logged. + +

+ + + + + + + + + + + + + + + +
Obsessive Compulsive Host Processor Timeout
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:ochp_timeout=<seconds>
Example:ochp_timeout=5
+ + + +

+ +This is the maximum number of seconds that Nagios will allow an obsessive compulsive host processor command to be run. If a command exceeds this time limit it will be killed and a warning will be logged. + +

+ + + + + + + + + + + + + + + +
Performance Data Processor Command Timeout
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:perfdata_timeout=<seconds>
Example:perfdata_timeout=5
+ + + +

+ +This is the maximum number of seconds that Nagios will allow a host performance data processor command or service performance data processor command to be run. If a command exceeds this time limit it will be killed and a warning will be logged. + +

+ + + + + + + + + + + + + + + +
Obsess Over Services Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:obsess_over_services=<0/1>
Example:obsess_over_services=1
+ + + +

+ +This value determines whether or not Nagios will "obsess" over service checks results and run the obsessive compulsive service processor command you define. I know - funny name, but it was all I could think of. This option is useful for performing distributed monitoring. If you're not doing distributed monitoring, don't enable this option. + +

+ + + + + + + + + + + + + + + + + +
Obsessive Compulsive Service Processor Command
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:ocsp_command=<command>
Example:ocsp_command=obsessive_service_handler
+ + + +

+ +This option allows you to specify a command to be run after every service check, which can be useful in distributed monitoring. This command is executed after any event handler or notification commands. The command argument is the short name of a command definition that you define in your object configuration file. The maximum amount of time that this command can run is controlled by the ocsp_timeout option. More information on distributed monitoring can be found here. This command is only executed if the obsess_over_services option is enabled globally and if the obsess_over_service directive in the service definition is enabled. + +

+ + + + + + + + + + + + + + + +
Obsess Over Hosts Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:obsess_over_hosts=<0/1>
Example:obsess_over_hosts=1
+ + + +

+ +This value determines whether or not Nagios will "obsess" over host checks results and run the obsessive compulsive host processor command you define. I know - funny name, but it was all I could think of. This option is useful for performing distributed monitoring. If you're not doing distributed monitoring, don't enable this option. + +

+ + + + + + + + + + + + + + + + + +
Obsessive Compulsive Host Processor Command
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:ochp_command=<command>
Example:ochp_command=obsessive_host_handler
+ + + +

+ +This option allows you to specify a command to be run after every host check, which can be useful in distributed monitoring. This command is executed after any event handler or notification commands. The command argument is the short name of a command definition that you define in your object configuration file. The maximum amount of time that this command can run is controlled by the ochp_timeout option. More information on distributed monitoring can be found here. This command is only executed if the obsess_over_hosts option is enabled globally and if the obsess_over_host directive in the host definition is enabled. + +

+ + + + + + + + + + + + + + + +
Performance Data Processing Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:process_performance_data=<0/1>
Example:process_performance_data=1
+ + + +

+ +This value determines whether or not Nagios will process host and service check performance data. + +

+ + + + + + + + + + + + + + + + + +
Host Performance Data Processing Command
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:host_perfdata_command=<command>
Example:host_perfdata_command=process-host-perfdata
+ + + +

+ +This option allows you to specify a command to be run after every host check to process host performance data that may be returned from the check. The command argument is the short name of a command definition that you define in your object configuration file. This command is only executed if the process_performance_data option is enabled globally and if the process_perf_data directive in the host definition is enabled. + +

+ + + + + + + + + + + + + + + +
Service Performance Data Processing Command
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:service_perfdata_command=<command>
Example:service_perfdata_command=process-service-perfdata
+ + + +

+ +This option allows you to specify a command to be run after every service check to process service performance data that may be returned from the check. The command argument is the short name of a command definition that you define in your object configuration file. This command is only executed if the process_performance_data option is enabled globally and if the process_perf_data directive in the service definition is enabled. + +

+ + + + + + + + + + + + + + + +
Host Performance Data File
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:host_perfdata_file=<file_name>
Example:host_perfdata_file=/usr/local/nagios/var/host-perfdata.dat
+ + + +

+ +This option allows you to specify a file to which host performance data will be written after every host check. Data will be written to the performance file as specified by the host_perfdata_file_template option. Performance data is only written to this file if the process_performance_data option is enabled globally and if the process_perf_data directive in the host definition is enabled. + +

+ + + + + + + + + + + + + + + +
Service Performance Data File
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:service_perfdata_file=<file_name>
Example:service_perfdata_file=/usr/local/nagios/var/service-perfdata.dat
+ + + +

+ +This option allows you to specify a file to which service performance data will be written after every service check. Data will be written to the performance file as specified by the service_perfdata_file_template option. Performance data is only written to this file if the process_performance_data option is enabled globally and if the process_perf_data directive in the service definition is enabled. + +

+ + + + + + + + + + + + + + + +
Host Performance Data File Template
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:host_perfdata_file_template=<template>
Example:host_perfdata_file_template=[HOSTPERFDATA]\t$TIMET$\t$HOSTNAME$\t$HOSTEXECUTIONTIME$\t$HOSTOUTPUT$\t$HOSTPERFDATA$
+ + + +

+ +This option determines what (and how) data is written to the host performance data file. The template may contain macros, special characters (\t for tab, \r for carriage return, \n for newline) and plain text. A newline is automatically added after each write to the performance data file. + +

+ + + + + + + + + + + + + + + +
Service Performance Data File Template
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:service_perfdata_file_template=<template>
Example:service_perfdata_file_template=[SERVICEPERFDATA]\t$TIMET$\t$HOSTNAME$\t$SERVICEDESC$\t$SERVICEEXECUTIONTIME$\t$SERVICELATENCY$\t$SERVICEOUTPUT$\t$SERVICEPERFDATA$
+ + + +

+ +This option determines what (and how) data is written to the service performance data file. The template may contain macros, special characters (\t for tab, \r for carriage return, \n for newline) and plain text. A newline is automatically added after each write to the performance data file. + +

+ + + + + + + + + + + + + + + +
Host Performance Data File Mode
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:host_perfdata_file_mode=<mode>
Example:host_perfdata_file_mode=a
+ +

+ +This option determines how the host performance data file is opened. Unless the file is a named pipe you'll probably want to use the default mode of append. + +

+ + + + + + + + + + + + + + + + + +
Service Performance Data File Mode
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:service_perfdata_file_mode=<mode>
Example:service_perfdata_file_mode=a
+ +

+ +This option determines how the service performance data file is opened. Unless the file is a named pipe you'll probably want to use the default mode of append. + +

+ + + + + + + + + + + + + + + + + +
Host Performance Data File Processing Interval
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:host_perfdata_file_processing_interval=<seconds>
Example:host_perfdata_file_processing_interval=0
+ +

+ +This option allows you to specify the interval (in seconds) at which the host performance data file is processed using the host performance data file processing command. A value of 0 indicates that the performance data file should not be processed at regular intervals. + +

+ + + + + + + + + + + + + + + +
Service Performance Data File Processing Interval
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:service_perfdata_file_processing_interval=<seconds>
Example:service_perfdata_file_processing_interval=0
+ +

+ +This option allows you to specify the interval (in seconds) at which the service performance data file is processed using the service performance data file processing command. A value of 0 indicates that the performance data file should not be processed at regular intervals. + +

+ + + + + + + + + + + + + + + +
Host Performance Data File Processing Command
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:host_perfdata_file_processing_command=<command>
Example:host_perfdata_file_processing_command=process-host-perfdata-file
+ +

+ +This option allows you to specify the command that should be executed to process the host performance data file. The command argument is the short name of a command definition that you define in your object configuration file. The interval at which this command is executed is determined by the host_perfdata_file_processing_interval directive. + +

+ + + + + + + + + + + + + + + +
Service Performance Data File Processing Command
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:service_perfdata_file_processing_command=<command>
Example:service_perfdata_file_processing_command=process-service-perfdata-file
+ + + +

+ +This option allows you to specify the command that should be executed to process the service performance data file. The command argument is the short name of a command definition that you define in your object configuration file. The interval at which this command is executed is determined by the service_perfdata_file_processing_interval directive. + +

+ + + + + + + + + + + + + + + +
Orphaned Service Check Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:check_for_orphaned_services=<0/1>
Example:check_for_orphaned_services=1
+ + + +

+ +This option allows you to enable or disable checks for orphaned service checks. Orphaned service checks are checks which have been executed and have been removed from the event queue, but have not had any results reported in a long time. Since no results have come back in for the service, it is not rescheduled in the event queue. This can cause service checks to stop being executed. Normally it is very rare for this to happen - it might happen if an external user or process killed off the process that was being used to execute a service check. If this option is enabled and Nagios finds that results for a particular service check have not come back, it will log an error message and reschedule the service check. If you start seeing service checks that never seem to get rescheduled, enable this option and see if you notice any log messages about orphaned services. + +

+ + + + + + + + + + + + + + + + + +
Orphaned Host Check Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:check_for_orphaned_hosts=<0/1>
Example:check_for_orphaned_hosts=1
+ + + +

+ +This option allows you to enable or disable checks for orphaned hoste checks. Orphaned host checks are checks which have been executed and have been removed from the event queue, but have not had any results reported in a long time. Since no results have come back in for the host, it is not rescheduled in the event queue. This can cause host checks to stop being executed. Normally it is very rare for this to happen - it might happen if an external user or process killed off the process that was being used to execute a host check. If this option is enabled and Nagios finds that results for a particular host check have not come back, it will log an error message and reschedule the host check. If you start seeing host checks that never seem to get rescheduled, enable this option and see if you notice any log messages about orphaned hosts. + +

+ + + + + + + + + + + + + + + + + +
Service Freshness Checking Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:check_service_freshness=<0/1>
Example:check_service_freshness=0
+ + + +

+ +This option determines whether or not Nagios will periodically check the "freshness" of service checks. Enabling this option is useful for helping to ensure that passive service checks are received in a timely manner. More information on freshness checking can be found here. + +

+ + + + + + + + + + + + + + + + + +
Service Freshness Check Interval
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:service_freshness_check_interval=<seconds>
Example:service_freshness_check_interval=60
+ + + +

+ +This setting determines how often (in seconds) Nagios will periodically check the "freshness" of service check results. If you have disabled service freshness checking (with the check_service_freshness option), this option has no effect. More information on freshness checking can be found here. + +

+ + + + + + + + + + + + + + + +
Host Freshness Checking Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:check_host_freshness=<0/1>
Example:check_host_freshness=0
+ + + +

+ +This option determines whether or not Nagios will periodically check the "freshness" of host checks. Enabling this option is useful for helping to ensure that passive host checks are received in a timely manner. More information on freshness checking can be found here. + +

+ + + + + + + + + + + + + + + + + +
Host Freshness Check Interval
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:host_freshness_check_interval=<seconds>
Example:host_freshness_check_interval=60
+ + + +

+ +This setting determines how often (in seconds) Nagios will periodically check the "freshness" of host check results. If you have disabled host freshness checking (with the check_host_freshness option), this option has no effect. More information on freshness checking can be found here. + +

+ + + + + + + + + + + + + + + +
Additional Freshness Threshold Latency Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:additional_freshness_latency=<#>
Example:additional_freshness_latency=15
+ + + +

+ +This option determines the number of seconds Nagios will add to any host or services freshness threshold it automatically calculates (e.g. those not specified explicity by the user). More information on freshness checking can be found here. + +

+ + + + + + + + + + + + + + + +
Embedded Perl Interpreter Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:enable_embedded_perl=<0/1>
Example:enable_embedded_perl=1
+ + + +

+ +This setting determines whether or not the embedded Perl interpreter is enabled on a program-wide basis. Nagios must be compiled with support for embedded Perl for this option to have an effect. More information on the embedded Perl interpreter can be found here. + +

+ + + + + + + + + + + + + + + +
Embedded Perl Implicit Use Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:use_embedded_perl_implicitly=<0/1>
Example:use_embedded_perl_implicitly=1
+ + + +

+ +This setting determines whether or not the embedded Perl interpreter should be used for Perl plugins/scripts that do not explicitly enable/disable it. Nagios must be compiled with support for embedded Perl for this option to have an effect. More information on the embedded Perl interpreter and the effect of this setting can be found here. + +

+ + + + + + + + + + + + + + + +
Date Format
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:date_format=<option>
Example:date_format=us
+ + + +

+ +This option allows you to specify what kind of date/time format Nagios should use in the web interface and date/time macros. Possible options (along with example output) include: + +

+ + + + + + + + + + + + + + + +
OptionOutput FormatSample Output
usMM/DD/YYYY HH:MM:SS06/30/2002 03:15:00
euroDD/MM/YYYY HH:MM:SS30/06/2002 03:15:00
iso8601YYYY-MM-DD HH:MM:SS2002-06-30 03:15:00
strict-iso8601YYYY-MM-DDTHH:MM:SS2002-06-30T03:15:00
+ +
+ + + + + + + + + + + + + + + +
Timezone Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:use_timezone=<tz>
Example:use_timezone=US/Mountain
+ + + +

+ +This option allows you to override the default timezone that this instance of Nagios runs in. Useful if you have multiple instances of Nagios that need to run from the same server, but have different local times associated with them. If not specified, Nagios will use the system configured timezone. + +

+ +

+ +Note Note: If you use this option to specify a custom timezone, you will also need to alter the Apache configuration directives for the CGIs to specify the timezone you want. Example: + +

+ +
+ +<Directory "/usr/local/nagios/sbin/">
+ +SetEnv TZ "US/Mountain"
+ +...
+ +</Directory> + +
+ +
+ + + + + + + + + + + + + + + +
Illegal Object Name Characters
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:illegal_object_name_chars=<chars...>
Example:illegal_object_name_chars=`~!$%^&*"|'<>?,()=
+ + + +

+ +This option allows you to specify illegal characters that cannot be used in host names, service descriptions, or names of other object types. Nagios will allow you to use most characters in object definitions, but I recommend not using the characters shown in the example above. Doing may give you problems in the web interface, notification commands, etc. + +

+ + + + + + + + + + + + + + + +
Illegal Macro Output Characters
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:illegal_macro_output_chars=<chars...>
Example:illegal_macro_output_chars=`~$^&"|'<>
+ + + +

+ +This option allows you to specify illegal characters that should be stripped from macros before being used in notifications, event handlers, and other commands. This DOES NOT affect macros used in service or host check commands. You can choose to not strip out the characters shown in the example above, but I recommend you do not do this. Some of these characters are interpreted by the shell (i.e. the backtick) and can lead to security problems. The following macros are stripped of the characters you specify: + +

+ +

+ +$HOSTOUTPUT$, $HOSTPERFDATA$, $HOSTACKAUTHOR$, $HOSTACKCOMMENT$, $SERVICEOUTPUT$, $SERVICEPERFDATA$, $SERVICEACKAUTHOR$, and $SERVICEACKCOMMENT$ + +

+ + + + + + + + + + + + + + + +
Regular Expression Matching Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:use_regexp_matching=<0/1>
Example:use_regexp_matching=0
+ + + +

+ +This option determines whether or not various directives in your object definitions will be processed as regular expressions. More information on how this works can be found here. + +

+ + + + + + + + + + + + + + + + + +
True Regular Expression Matching Option
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:use_true_regexp_matching=<0/1>
Example:use_true_regexp_matching=0
+ + + +

+ +If you've enabled regular expression matching of various object directives using the use_regexp_matching option, this option will determine when object directives are treated as regular expressions. If this option is disabled (the default), directives will only be treated as regular expressions if they contain *, ?, +, or \.. If this option is enabled, all appropriate directives will be treated as regular expression - be careful when enabling this! More information on how this works can be found here. + +

+ + + + + + + + + + + + + + + + + +
Administrator Email Address
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:admin_email=<email_address>
Example:admin_email=root@localhost.localdomain
+ + + +

+ +This is the email address for the administrator of the local machine (i.e. the one that Nagios is running on). + +This value can be used in notification commands by using the $ADMINEMAIL$ macro. + +

+ + + + + + + + + + + + + + + +
Administrator Pager
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:admin_pager=<pager_number_or_pager_email_gateway>
Example:admin_pager=pageroot@localhost.localdomain
+ + + +

+ +This is the pager number (or pager email gateway) for the administrator of the local machine (i.e. the one that Nagios is running on). The pager number/address can be used in notification commands by using the $ADMINPAGER$ macro. + +

+ + + + + + + + + + + + + + + +
Event Broker Options
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:event_broker_options=<#>
Example:event_broker_options=-1
+ + + +

+ +This option controls what (if any) data gets sent to the event broker and, in turn, to any loaded event broker modules. This is an advanced option. When in doubt, either broker nothing (if not using event broker modules) or broker everything (if using event broker modules). Possible values are shown below. + +

+ + + + + + + + + + + + + + + + + + + +
Event Broker Modules
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:broker_module=<modulepath> [moduleargs]
Example:broker_module=/usr/local/nagios/bin/ndomod.o cfg_file=/usr/local/nagios/etc/ndomod.cfg
+ + + +

+ +This directive is used to specify an event broker module that should by loaded by Nagios at startup. Use multiple directives if you want to load more than one module. Arguments that should be passed to the module at startup are seperated from the module path by a space. + +

+ +

+ +!!! WARNING !!! + +

+ +

+ +Do NOT overwrite modules while they are being used by Nagios or Nagios will crash in a fiery display of SEGFAULT glory. This is a bug/limitation either in dlopen(), the kernel, and/or the filesystem. And maybe Nagios... + +

+ +

+ +The correct/safe way of updating a module is by using one of these methods: + +

+ +
    + +
  1. Shutdown Nagios, replace the module file, restart Nagios
    2. + +
  2. While Nagios is running... delete the original module file, move the new module file into place, restart Nagios
    3. + +
+ + + + + + + + + + + + + + + +
Debug File
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:debug_file=<file_name>
Example:debug_file=/usr/local/nagios/var/nagios.debug
+ + + +

+ +This option determines where Nagios should write debugging information. What (if any) information is written is determined by the debug_level and debug_verbosity options. You can have Nagios automaticaly rotate the debug file when it reaches a certain size by using the max_debug_file_size option. + +

+ + + + + + + + + + + + + + + +
Debug Level
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:debug_level=<#>
Example:debug_level=24
+ + + +

+ +This option determines what type of information Nagios should write to the debug_file. This value is a logical OR of the values below. + +

+ + + + + + + + + + + + + + + +
Debug Verbosity
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:debug_verbosity=<#>
Example:debug_verbosity=1
+ + + +

+ +This option determines how much debugging information Nagios should write to the debug_file. + +

+ + + + + + + + + + + + + + + + + +
Maximum Debug File Size
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Format:max_debug_file_size=<#>
Example:max_debug_file_size=1000000
+ + + +

+ +This option determines the maximum size (in bytes) of the debug file. If the file grows larger than this size, it will be renamed with a .old extension. If a file already exists with a .old extension it will automatically be deleted. This helps ensure your disk space usage doesn't get out of control when debugging Nagios. + +

+ + + + + +
+ + + + + + + diff --git a/docs/configobject.html b/docs/configobject.html new file mode 100644 index 0000000..4d09327 --- /dev/null +++ b/docs/configobject.html @@ -0,0 +1,404 @@ + + + + + + + + +Object Configuration Overview + + + + + + + + + + + + + + + +
+ +Nagios + +

Object Configuration Overview

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Configuration Overview, Object Definitions + +

+ + + +

+ +What Are Objects? + +

+ + + +

+ +Objects are all the elements that are involved in the monitoring and notification logic. Types of objects include: + +

+ + + + + + + +

+ +More information on what objects are and how they relate to each other can be found below. + +

+ + + +

+ +Where Are Objects Defined? + +

+ + + +

+ +Objects can be defined in one or more configuration files and/or directories that you specify using the cfg_file and/or cfg_dir directives in the main configuration file. + +

+ + + +

+ +Tip Tip: When you follow quickstart installation guide, several sample object configuration files are placed in /usr/local/nagios/etc/objects/. You can use these sample files to see how object inheritance works and learn how to define your own object definitions. + +

+ + + +

+ +How Are Objects Defined? + +

+ + + +

+ +Objects are defined in a flexible template format, which can make it much easier to manage your Nagios configuration in the long term. Basic information on how to define objects in your configuration files can be found here. + +

+ +

+ +Once you get familiar with the basics of how to define objects, you should read up on object inheritance, as it will make your configuration more robust for the future. Seasoned users can exploit some advanced features of object definitions as described in the documentation on object tricks. + +

+ + + + + +

+ +Objects Explained + +

+ + + +

+ +Some of the main object types are explained in greater detail below... + +

+ + + + + + + + + + + + + + + + + +
+ +

+ +Hosts are one of the central objects in the monitoring logic. Important attributes of hosts are as follows: + +

+ +
    + +
  • Hosts are usually physical devices on your network (servers, workstations, routers, switches, printers, etc).
    • + +
  • Hosts have an address of some kind (e.g. an IP or MAC address).
    • + +
  • Hosts have one or more more services associated with them.
    • + +
  • Hosts can have parent/child relationships with other hosts, often representing real-world network connections, which is used in the network reachability logic.
    • + +
+ +

+ +Host Groups are groups of one or more hosts. Host groups can make it easier to (1) view the status of related hosts in the Nagios web interface and (2) simplify your configuration through the use of object tricks. + +

+ +		 + +Hosts + +
+ + + + + + + + + + + + + + + + + +
+ +

+ +Services are one of the central objects in the monitoring logic. Services are associated with hosts and can be: + +

+ +
    + +
  • Attributes of a host (CPU load, disk usage, uptime, etc.)
    • + +
  • Services provided by the host (HTTP, POP3, FTP, SSH, etc.)
    • + +
  • Other things associated with the host (DNS records, etc.)
    • + +
+ +

+ +Service Groups are groups of one or more services. Service groups can make it easier to (1) view the status of related services in the Nagios web interface and (2) simplify your configuration through the use of object tricks. + +

+ +		 + +Services + +
+ + + + + + + + + + + + + + + + + +
+ +

+ +Contacts are people involved in the notification process: + +

+ +
    + +
  • Contacts have one or more notification methods (cellphone, pager, email, instant messaging, etc.)
    • + +
  • Contacts receive notifications for hosts and service they are responsible for
    • + +
+ +

+ +Contact Groups are groups of one or more contacts. Contact groups can make it easier to define all the people who get notified when certain host or service problems occur. + +

+ +		 + +Contacts + +
+ + + + + + + + + + + + + + + + + +
+ +

+ +Timeperiods are are used to control: + +

+ +
    + +
  • When hosts and services can be monitored
    • + +
  • When contacts can receive notifications
    • + +
+ +

+ +Information on how timeperiods work can be found here. + +

+ +		 + +Timeperiods + +
+ + + + + + + + + + + + + + + + + +
+ +

+ +Commands are used to tell Nagios what programs, scripts, etc. it should execute to perform: + +

+ +
    + +
  • Host and service checks
    • + +
  • Notifications
    • + +
  • Event handlers
    • + +
  • and more...
    • + +
+ +		 + +Commands + +
+ + + +
+ + + + + + + diff --git a/docs/customobjectvars.html b/docs/customobjectvars.html new file mode 100644 index 0000000..80f29e4 --- /dev/null +++ b/docs/customobjectvars.html @@ -0,0 +1,246 @@ + + + + + + + + +Custom Object Variables + + + + + + + + + + + + + + + +
+ +Nagios + +

Custom Object Variables

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Object Configuration, Object Inheritance, Macros + +

+ + + +

+ +Introduction + +

+ + + +

+ +Users often request that new variables be added to host, service, and contact definitions. These include variables for SNMP community, MAC address, AIM username, Skype number, and street address. The list is endless. The problem that I see with doing this is that it makes Nagios less generic and more infrastructure-specific. Nagios was intended to be flexible, which meant things needed to be designed in a generic manner. Host definitions in Nagios, for example, have a generic "address" variable that can contain anything from an IP address to human-readable driving directions - whatever is appropriate for the user's setup. + +

+ +

+ +Still, there needs to be a method for admins to store information about their infrastructure components in their Nagios configuration without imposing a set of specific variables on others. Nagios attempts to solve this problem by allowing users to define custom variables in their object definitions. Custom variables allow users to define additional properties in their host, service, and contact definitions, and use their values in notifications, event handlers, and host and service checks. + +

+ + + +

+ +Custom Variable Basics + +

+ + + +

+ +There are a few important things that you should note about custom variables: + +

+ + + + + + + +

+ +Examples + +

+ + + +

+ +Here's an example of how custom variables can be defined in different types of object definitions: + +

+ + + +
+
+define host{
+
+	host_name	linuxserver
+
+	_mac_address	00:06:5B:A6:AD:AA	; <-- Custom MAC_ADDRESS variable
+
+	_rack_number	R32		; <-- Custom RACK_NUMBER variable
+
+	...
+
+	}
+
+
+
+define service{
+
+	host_name	linuxserver
+
+	description	Memory Usage
+
+	_SNMP_community	public		; <-- Custom SNMP_COMMUNITY variable
+
+	_TechContact	Jane Doe		; <-- Custom TECHCONTACT variable
+
+	....
+
+	}
+
+
+
+define contact{
+
+	contact_name	john
+
+	_AIM_username	john16		; <-- Custom AIM_USERNAME variable
+
+	_YahooID	john32			; <-- Custom YAHOOID variable
+
+	...
+
+	}
+
+
+ + + +

+ +Custom Variables As Macros + +

+ + + +

+ +Custom variable values can be referenced in scripts and executables that Nagios runs for checks, notifications, etc. by using macros or environment variables. + +

+ +

+ +In order to prevent name collision among custom variables from different object types, Nagios prepends "_HOST", "_SERVICE", or "_CONTACT" to the beginning of custom host, service, or contact variables, respectively, in macro and environment variable names. The table below shows the corresponding macro and environment variable names for the custom variables that were defined in the example above. + +

+ + + +

+ + + + + + + + + + + + + + + + + +
Object TypeVariable NameMacro NameEnvironment Variable
HostMAC_ADDRESS$_HOSTMAC_ADDRESS$NAGIOS__HOSTMAC_ADDRESS
HostRACK_NUMBER$_HOSTRACK_NUMBER$NAGIOS__HOSTRACK_NUMBER
ServiceSNMP_COMMUNITY$_SERVICESNMP_COMMUNITY$NAGIOS__SERVICESNMP_COMMUNITY
ServiceTECHCONTACT$_SERVICETECHCONTACT$NAGIOS__SERVICETECHCONTACT
ContactAIM_USERNAME$_CONTACTAIM_USERNAME$NAGIOS__CONTACTAIM_USERNAME
ContactYAHOOID$_CONTACTYAHOOID$NAGIOS__CONTACTYAHOOID
+ +

+ + + +

+ +Custom Variables And Inheritance + +

+ + + +

+ +Custom object variables are inherited just like standard host, service, or contact variables. + +

+ + + + + +
+ + + + + + + diff --git a/docs/dependencies.html b/docs/dependencies.html new file mode 100644 index 0000000..cbce6a1 --- /dev/null +++ b/docs/dependencies.html @@ -0,0 +1,592 @@ + + + + + + + + +Host and Service Dependencies + + + + + + + + + + + + + + + +
+ +Nagios + +

Host and Service Dependencies

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Predictive Dependency Checks, Service Checks, Host Checks + +

+ + + +

+ +Introduction + +

+ + + +

+ +Service and host dependencies are an advanced feature of Nagios that allow you to control the behavior of hosts and services based on the status of one or more other hosts or services. I'll explain how dependencies work, along with the differences between host and service dependencies. + +

+ + + +

+ +Service Dependencies Overview + +

+ + + +

+ +There are a few things you should know about service dependencies: + +

+ +
    + +
  1. A service can be dependent on one or more other services + +
  2. A service can be dependent on services which are not associated with the same host + +
  3. Service dependencies are not inherited (unless specifically configured to) + +
  4. Service dependencies can be used to cause service check execution and service notifications to be suppressed under different circumstances (OK, WARNING, UNKNOWN, and/or CRITICAL states) + +
  5. Service dependencies might only be valid during specific timeperiods
    6. + +
+ + + + + +

+ +Defining Service Dependencies + +

+ + + +

+ +First, the basics. You create service dependencies by adding service dependency definitions in your object config file(s). In each definition you specify the dependent service, the service you are depending on, and the criteria (if any) that cause the execution and notification dependencies to fail (these are described later). + +

+ + + +

+ +You can create several dependencies for a given service, but you must add a separate service dependency definition for each dependency you create. + +

+ + + + + +

+ +Example Service Dependencies + +

+ + + +

+ +The image below shows an example logical layout of service notification and execution dependencies. Different services are dependent on other services for notifications and check execution. + +

+ + + +Service Dependencies + + + +

+ +In this example, the dependency definitions for Service F on Host C would be defined as follows: + +

+ + + +
+
+define servicedependency{
+
+	host_name			Host B
+
+	service_description		Service D
+
+	dependent_host_name		Host C
+
+	dependent_service_description	Service F
+
+	execution_failure_criteria	o
+
+	notification_failure_criteria	w,u
+
+	}
+
+
+
+define servicedependency{
+
+	host_name			Host B
+
+	service_description		Service E
+
+	dependent_host_name		Host C
+
+	dependent_service_description	Service F
+
+	execution_failure_criteria	n
+
+	notification_failure_criteria	w,u,c
+
+	}
+
+
+
+define servicedependency{
+
+	host_name			Host B
+
+	service_description		Service C
+
+	dependent_host_name		Host C
+
+	dependent_service_description	Service F
+
+	execution_failure_criteria	w
+
+	notification_failure_criteria	c
+
+	}
+
+
+ + + + + +

+ +The other dependency definitions shown in the image above would be defined as follows: + +

+ + + +
+
+define servicedependency{
+
+	host_name			Host A
+
+	service_description		Service A
+
+	dependent_host_name		Host B
+
+	dependent_service_description	Service D
+
+	execution_failure_criteria	u
+
+	notification_failure_criteria	n
+
+	}
+
+
+
+define servicedependency{
+
+	host_name			Host A
+
+	service_description		Service B
+
+	dependent_host_name		Host B
+
+	dependent_service_description	Service E
+
+	execution_failure_criteria	w,u
+
+	notification_failure_criteria	c
+
+	}
+
+
+
+define servicedependency{
+
+	host_name			Host B
+
+	service_description		Service C
+
+	dependent_host_name		Host B
+
+	dependent_service_description	Service E
+
+	execution_failure_criteria	n
+
+	notification_failure_criteria	w,u,c
+
+	}
+
+
+ + + + + +

+ +How Service Dependencies Are Tested + +

+ + + +

+ +Before Nagios executes a service check or sends notifications out for a service, it will check to see if the service has any dependencies. If it doesn't have any dependencies, the check is executed or the notification is sent out as it normally would be. If the service does have one or more dependencies, Nagios will check each dependency entry as follows: + +

+ + + +
    + +
  1. Nagios gets the current status* of the service that is being depended upon. + +
  2. Nagios compares the current status of the service that is being depended upon against either the execution or notification failure options in the dependency definition (whichever one is relevant at the time). + +
  3. If the current status of the service that is being depended upon matches one of the failure options, the dependency is said to have failed and Nagios will break out of the dependency check loop. + +
  4. If the current state of the service that is being depended upon does not match any of the failure options for the dependency entry, the dependency is said to have passed and Nagios will go on and check the next dependency entry.
+ + + +

+ +This cycle continues until either all dependencies for the service have been checked or until one dependency check fails. + +

+ + + +

+ + + +Note Note: *One important thing to note is that by default, Nagios will use the most current hard state of the service(s) that is/are being depended upon when it does the dependeny checks. If you want Nagios to use the most current state of the services (regardless of whether its a soft or hard state), enable the soft_state_dependencies option. + +

+ + + +

+ +Execution Dependencies + +

+ + + +

+ +Execution dependencies are used to restrict when active checks of a service can be performed. Passive checks are not restricted by execution dependencies. + +

+ + + +

+ +If all of the execution dependency tests for the service passed, Nagios will execute the check of the service as it normally would. If even just one of the execution dependencies for a service fails, Nagios will temporarily prevent the execution of checks for that (dependent) service. At some point in the future the execution dependency tests for the service may all pass. If this happens, Nagios will start checking the service again as it normally would. More information on the check scheduling logic can be found here. + +

+ + + +

+ +In the example above, Service E would have failed execution dependencies if Service B is in a WARNING or UNKNOWN state. If this was the case, the service check would not be performed and the check would be scheduled for (potential) execution at a later time. + +

+ + + +

+ +Notification Dependencies + +

+ + + +

+ +If all of the notification dependency tests for the service passed, Nagios will send notifications out for the service as it normally would. If even just one of the notification dependencies for a service fails, Nagios will temporarily repress notifications for that (dependent) service. At some point in the future the notification dependency tests for the service may all pass. If this happens, Nagios will start sending out notifications again as it normally would for the service. More information on the notification logic can be found here. + +

+ + + +

+ +In the example above, Service F would have failed notification dependencies if Service C is in a CRITICAL state, and/or Service D is in a WARNING or UNKNOWN state, and/or if Service E is in a WARNING, UNKNOWN, or CRITICAL state. If this were the case, notifications for the service would not be sent out. + +

+ + + +

+ +Dependency Inheritance + +

+ + + +

+ +As mentioned before, service dependencies are not inherited by default. In the example above you can see that Service F is dependent on Service E. However, it does not automatically inherit Service E's dependencies on Service B and Service C. In order to make Service F dependent on Service C we had to add another service dependency definition. There is no dependency definition for Service B, so Service F is not dependent on Service B. + +

+ + + +

+ +If you do wish to make service dependencies inheritable, you must use the inherits_parent directive in the service dependency definition. When this directive is enabled, it indicates that the dependency inherits dependencies of the service that is being depended upon (also referred to as the master service). In other words, if the master service is dependent upon other services and any one of those dependencies fail, this dependency will also fail. + +

+ + + +

+ +In the example above, imagine that you want to add a new dependency for service F to make it dependent on service A. You could create a new dependency definition that specified service F as the dependent service and service A as being the master service (i.e. the service that is being dependend on). You could alternatively modify the dependency definition for services D and F to look like this: + +

+ + + +
+
+define servicedependency{
+
+	host_name			Host B
+
+	service_description		Service D
+
+	dependent_host_name		Host C
+
+	dependent_service_description	Service F
+
+	execution_failure_criteria	o
+
+	notification_failure_criteria	n
+
+	inherits_parent		1
+
+	}
+
+
+
+
+ + + +

+ +Since the inherits_parent directive is enabled, the dependency between services A and D will be tested when the dependency between services F and D are being tested. + +

+ + + +

+ +Dependencies can have multiple levels of inheritence. If the dependency definition between A and D had its inherits_parent directive enable and service A was dependent on some other service (let's call it service G), the service F would be dependent on services D, A, and G (each with potentially different criteria). + +

+ + + +

+ +Host Dependencies + +

+ + + +

+ +As you'd probably expect, host dependencies work in a similiar fashion to service dependencies. The difference is that they're for hosts, not services. + +

+ + + +

+ +Tip Tip: Do not confuse host dependencies with parent/child host relationships. You should be using parent/child host relationships (defined with the parents directive in host definitions) for most cases, rather than host dependencies. A description of how parent/child host relationships work can be found in the documentation on network reachability. + +

+ + + +

+ +Here are the basics about host dependencies: + +

+ +
    + +
  1. A host can be dependent on one or more other host + +
  2. Host dependencies are not inherited (unless specifically configured to) + +
  3. Host dependencies can be used to cause host check execution and host notifications to be suppressed under different circumstances (UP, DOWN, and/or UNREACHABLE states) + +
  4. Host dependencies might only be valid during specific timeperiods
    5. + +
+ + + +

+ +Example Host Dependencies + +

+ + + +

+ +The image below shows an example of the logical layout of host notification dependencies. Different hosts are dependent on other hosts for notifications. + +

+ + + +Host Dependencies + + + +

+ +In the example above, the dependency definitions for Host C would be defined as follows: + +

+ + + +
+
+define hostdependency{
+
+	host_name			Host A
+
+	dependent_host_name		Host C
+
+	notification_failure_criteria	d
+
+	}
+
+
+
+define hostdependency{
+
+	host_name			Host B
+
+	dependent_host_name		Host C
+
+	notification_failure_criteria	d,u
+
+	}
+
+
+ + + +

+ +As with service dependencies, host dependencies are not inherited. In the example image you can see that Host C does not inherit the host dependencies of Host B. In order for Host C to be dependent on Host A, a new host dependency definition must be defined. + +

+ + + +

+ +Host notification dependencies work in a similiar manner to service notification dependencies. If all of the notification dependency tests for the host pass, Nagios will send notifications out for the host as it normally would. If even just one of the notification dependencies for a host fails, Nagios will temporarily repress notifications for that (dependent) host. At some point in the future the notification dependency tests for the host may all pass. If this happens, Nagios will start sending out notifications again as it normally would for the host. More information on the notification logic can be found here. + +

+ + + + + + + +
+ + + + + + + diff --git a/docs/dependencychecks.html b/docs/dependencychecks.html new file mode 100644 index 0000000..7ba7ba2 --- /dev/null +++ b/docs/dependencychecks.html @@ -0,0 +1,192 @@ + + + + + + + + +Predictive Dependency Checks + + + + + + + + + + + + + + + +
+ +Nagios + +

Predictive Dependency Checks

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Dependencies, Service Checks, Host Checks, Cached Checks + +

+ + + +

+ +Introduction + +

+ + + +

+ +Host and service dependencies can be defined to allow you greater control over when checks are executed and when notifications are sent out. As dependencies are used to control basic aspects of the monitoring process, it is crucial to ensure that status information used in the dependency logic is as up to date as possible. + +

+ + + +

+ +Nagios allows you to enable predictive dependency checks for hosts and services to ensure that the dependency logic will have the most up-to-date status information when it comes to making decisions about whether to send out notifications or allow active checks of a host or service. + +

+ + + +

+ +How Do Predictive Checks Work? + +

+ + + +

+ +The image below shows a basic diagram of hosts that are being monitored by Nagios, along with their parent/child relationships and dependencies. + +

+ +

+ +The Switch2 host in this example has just changed state from an UP state to a problem state. Nagios needs to determine whether the host is DOWN or UNREACHABLE, so it will launch parallel checks of Switch2's immediate parents (Firewall1) and children (Comp1, Comp2, and Switch3). This is a normal function of the host reachability logic. + +

+ +

+ +You will also notice that Switch2 is depending on Monitor1 and File1 for either notifications or check execution (which one is unimportant in this example). If predictive host dependency checks are enabled, Nagios will launch parallel checks of Monitor1 and File1 at the same time it launches checks of Switch2's immediate parents and children. Nagios does this because it knows that it will have to test the dependency logic in the near future (e.g. for purposes of notification) and it wants to make sure it has the most current status information for the hosts that take part in the dependency. + +

+ + + +

+ +Predictive Dependency Checks + +

+ + + +

+ +That's how predictive dependency checks work. Simple, eh? + +

+ + + +

+ +Note Note: Predictive service dependency checks work in a similiar manner to what is described above. Except, of course, they deal with services instead of hosts. + +

+ + + +

+ +Enabling Predictive Checks + +

+ + + +

+ +Predictive dependency checks involve rather little overhead, so I would recommend that you enable them. In most cases, the benefits of having accurate information for the dependency logic outweighs the extra overhead imposed by these checks. + +

+ + + +

+ +Enabling predictive dependency checks is easy: + +

+ + + + + + + +

+ +Cached Checks + +

+ + + +

+ +Predictive dependency checks are on-demand checks and are therefore subject to the rules of cached checks. Cached checks can provide you with performance improvements by allowing Nagios to forgo running an actual host or service check if it can use a relatively recent check result instead. More information on cached checks can be found here. + +

+ + + +
+ + + + + + + diff --git a/docs/distributed.html b/docs/distributed.html new file mode 100644 index 0000000..24c3be9 --- /dev/null +++ b/docs/distributed.html @@ -0,0 +1,630 @@ + + + + + + + + +Distributed Monitoring + + + + + + + + + + + + + + + +
+ +

Distributed Monitoring

+ +
+ + + +
+ + + +

+ +Introduction + +

+ + + +

+ +Nagios can be configured to support distributed monitoring of network services and resources. I'll try to briefly explan how this can be accomplished... + +

+ + + +

+ +Goals + +

+ + + +

+ +The goal in the distributed monitoring environment that I will describe is to offload the overhead (CPU usage, etc.) of performing service checks from a "central" server onto one or more "distributed" servers. Most small to medium sized shops will not have a real need for setting up such an environment. However, when you want to start monitoring hundreds or even thousands of hosts (and several times that many services) using Nagios, this becomes quite important. + +

+ + + +

+ +Reference Diagram + +

+ + + +

+ +The diagram below should help give you a general idea of how distributed monitoring works with Nagios. I'll be referring to the items shown in the diagram as I explain things... + +

+ + + +

+ + + +

+ + + +

+ +Central Server vs. Distributed Servers + +

+ + + +

+ +When setting up a distributed monitoring environment with Nagios, there are differences in the way the central and distributed servers are configured. I'll show you how to configure both types of servers and explain what effects the changes being made have on the overall monitoring. For starters, lets describe the purpose of the different types of servers... + +

+ + + +

+ +The function of a distributed server is to actively perform checks all the services you define for a "cluster" of hosts. I use the term "cluster" loosely - it basically just mean an arbitrary group of hosts on your network. Depending on your network layout, you may have several cluters at one physical location, or each cluster may be separated by a WAN, its own firewall, etc. The important thing to remember to that for each cluster of hosts (however you define that), there is one distributed server that runs Nagios and monitors the services on the hosts in the cluster. A distributed server is usually a bare-bones installation of Nagios. It doesn't have to have the web interface installed, send out notifications, run event handler scripts, or do anything other than execute service checks if you don't want it to. More detailed information on configuring a distributed server comes later... + +

+ + + +

+ +The purpose of the central server is to simply listen for service check results from one or more distributed servers. Even though services are occassionally actively checked from the central server, the active checks are only performed in dire circumstances, so lets just say that the central server only accepts passive check for now. Since the central server is obtaining passive service check results from one or more distributed servers, it serves as the focal point for all monitoring logic (i.e. it sends out notifications, runs event handler scripts, determines host states, has the web interface installed, etc). + +

+ + + +

+ +Obtaining Service Check Information From Distributed Monitors + +

+ + + +

+ +Okay, before we go jumping into configuration detail we need to know how to send the service check results from the distributed servers to the central server. I've already discussed how to submit passive check results to Nagios from same host that Nagios is running on (as described in the documentation on passive checks), but I haven't given any info on how to submit passive check results from other hosts. + +

+ + + +

+ +In order to facilitate the submission of passive check results to a remote host, I've written the nsca addon. The addon consists of two pieces. The first is a client program (send_nsca) which is run from a remote host and is used to send the service check results to another server. The second piece is the nsca daemon (nsca) which either runs as a standalone daemon or under inetd and listens for connections from client programs. Upon receiving service check information from a client, the daemon will sumbit the check information to Nagios (on the central server) by inserting a PROCESS_SVC_CHECK_RESULT command into the external command file, along with the check results. The next time Nagios checks for external commands, it will find the passive service check information that was sent from the distributed server and process it. Easy, huh? + +

+ + + + + +

+ +Distributed Server Configuration + +

+ + + +

+ +So how exactly is Nagios configured on a distributed server? Basically, its just a bare-bones installation. You don't need to install the web interface or have notifications sent out from the server, as this will all be handled by the central server. + +

+ + + +

+ +Key configuration changes: + +

+ + + + + + + +

+ +In order to make everything come together and work properly, we want the distributed server to report the results of all service checks to Nagios. We could use event handlers to report changes in the state of a service, but that just doesn't cut it. In order to force the distributed server to report all service check results, you must enabled the obsess_over_services option in the main configuration file and provide a ocsp_command to be run after every service check. We will use the ocsp command to send the results of all service checks to the central server, making use of the send_nsca client and nsca daemon (as described above) to handle the tranmission. + +

+ + + +

+ +In order to accomplish this, you'll need to define an ocsp command like this: + +

+ + + +

+ +ocsp_command=submit_check_result + +

+ + + +

+ +The command definition for the submit_check_result command looks something like this: + +

+ + + +

+ + + + + +

+
+define command{
+
+	command_name	submit_check_result
+
+	command_line	/usr/local/nagios/libexec/eventhandlers/submit_check_result $HOSTNAME$ '$SERVICEDESC$' $SERVICESTATE$ '$SERVICEOUTPUT$'
+
+	}
+
+
+ + + + + +

+ + + +

+ +The submit_check_result shell scripts looks something like this (replace central_server with the IP address of the central server): + +

+ + + +
+
+	#!/bin/sh
+
+
+
+	# Arguments:
+
+	#  $1 = host_name (Short name of host that the service is
+
+	#       associated with)
+
+	#  $2 = svc_description (Description of the service)
+
+	#  $3 = state_string (A string representing the status of
+
+	#       the given service - "OK", "WARNING", "CRITICAL"
+
+	#       or "UNKNOWN")
+
+	#  $4 = plugin_output (A text string that should be used
+
+	#       as the plugin output for the service checks)
+
+	#
+
+
+
+	# Convert the state string to the corresponding return code
+
+	return_code=-1
+
+
+
+	case "$3" in
+
+    	    OK)
+
+        	        return_code=0
+
+            	    ;;
+
+	        WARNING)
+
+    	            return_code=1
+
+        	        ;;
+
+	        CRITICAL)
+
+    	            return_code=2
+
+        	        ;;
+
+	        UNKNOWN)
+
+    	            return_code=-1
+
+        	        ;;
+
+	esac
+
+
+
+	# pipe the service check info into the send_nsca program, which
+
+	# in turn transmits the data to the nsca daemon on the central
+
+	# monitoring server
+
+
+
+	/bin/printf "%s\t%s\t%s\t%s\n" "$1" "$2" "$return_code" "$4" | /usr/local/nagios/bin/send_nsca -H central_server -c /usr/local/nagios/etc/send_nsca.cfg
+
+
+ + + +

+ +The script above assumes that you have the send_nsca program and it configuration file (send_nsca.cfg) located in the /usr/local/nagios/bin/ and /usr/local/nagios/etc/ directories, respectively. + +

+ + + +

+ +That's it! We've sucessfully configured a remote host running Nagios to act as a distributed monitoring server. Let's go over exactly what happens with the distributed server and how it sends service check results to Nagios (the steps outlined below correspond to the numbers in the reference diagram above): + +

+ + + +
    + +
  1. After the distributed server finishes executing a service check, it executes the command you defined by the ocsp_command variable. In our example, this is the /usr/local/nagios/libexec/eventhandlers/submit_check_result script. Note that the definition for the submit_check_result command passed four pieces of information to the script: the name of the host the service is associated with, the service description, the return code from the service check, and the plugin output from the service check. + +
  2. The submit_check_result script pipes the service check information (host name, description, return code, and output) to the send_nsca client program. + +
  3. The send_nsca program transmits the service check information to the nsca daemon on the central monitoring server. + +
  4. The nsca daemon on the central server takes the service check information and writes it to the external command file for later pickup by Nagios. + +
  5. The Nagios process on the central server reads the external command file and processes the passive service check information that originated from the distributed monitoring server. + +
+ + + +

+ +Central Server Configuration + +

+ + + +

+ +We've looked at how distributed monitoring servers should be configured, so let's turn to the central server. For all intensive purposes, the central is configured as you would normally configure a standalone server. It is setup as follows: + +

+ + + + + + + +

+ +There are three other very important things that you need to keep in mind when configuring the central server: + +

+ + + + + + + +

+ +It is important that you either disable all service checks on a program-wide basis or disable the enable_active_checks option in the definitions for each service that is monitored by a distributed server. This will ensure that active service checks are never executed under normal circumstances. The services will keep getting rescheduled at their normal check intervals (3 minutes, 5 minutes, etc...), but the won't actually be executed. This rescheduling loop will just continue all the while Nagios is running. I'll explain why this is done in a bit... + +

+ + + +

+ +That's it! Easy, huh? + +

+ + + + + +

+ +Problems With Passive Checks + +

+ + + +

+ +For all intensive purposes we can say that the central server is relying solely on passive checks for monitoring. The main problem with relying completely on passive checks for monitoring is the fact that Nagios must rely on something else to provide the monitoring data. What if the remote host that is sending in passive check results goes down or becomes unreachable? If Nagios isn't actively checking the services on the host, how will it know that there is a problem? + +

+ + + +

+ +Fortunately, there is a way we can handle these types of problems... + +

+ + + +

+ +Freshness Checking + +

+ + + +

+ +Nagios supports a feature that does "freshness" checking on the results of service checks. More information freshness checking can be found here. This features gives some protection against situations where remote hosts may stop sending passive service checks into the central monitoring server. The purpose of "freshness" checking is to ensure that service checks are either being provided passively by distributed servers on a regular basis or performed actively by the central server if the need arises. If the service check results provided by the distributed servers get "stale", Nagios can be configured to force active checks of the service from the central monitoring host. + +

+ + + +

+ +So how do you do this? On the central monitoring server you need to configure services that are being monitoring by distributed servers as follows... + +

+ + + + + + + +

+ +Nagios periodically checks the "freshness" of the results for all services that have freshness checking enabled. The freshness_threshold option in each service definition is used to determine how "fresh" the results for each service should be. For example, if you set this value to 300 for one of your services, Nagios will consider the service results to be "stale" if they're older than 5 minutes (300 seconds). If you do not specify a value for the freshness_threshold option, Nagios will automatically calculate a "freshness" threshold by looking at either the normal_check_interval or retry_check_interval options (depending on what type of state the service is in). If the service results are found to be "stale", Nagios will run the service check command specified by the check_command option in the service definition, thereby actively checking the service. + +

+ + + +

+ +Remember that you have to specify a check_command option in the service definitions that can be used to actively check the status of the service from the central monitoring server. Under normal circumstances, this check command is never executed (because active checks were disabled on a program-wide basis or for the specific services). When freshness checking is enabled, Nagios will run this command to actively check the status of the service even if active checks are disabled on a program-wide or service-specific basis. + +

+ + + +

+ +If you are unable to define commands to actively check a service from the central monitoring host (or if turns out to be a major pain), you could simply define all your services with the check_command option set to run a dummy script that returns a critical status. Here's an example... Let's assume you define a command called 'service-is-stale' and use that command name in the check_command option of your services. Here's what the definition would look like... + +

+ + + +

+ + + + + +

+
+define command{
+
+	command_name	service-is-stale
+
+	command_line	/usr/local/nagios/libexec/check_dummy 2 "CRITICAL: Service results are stale"
+
+	}
+
+
+ + + + + +

+ + + + + +

+ +When Nagios detects that the service results are stale and runs the service-is-stale command, the check_dummy plugin is executed and the service will go into a critical state. This would likely cause notifications to be sent out, so you'll know that there's a problem. + +

+ + + +

+ +Performing Host Checks + +

+ + + +

+ +At this point you know how to obtain service check results passivly from distributed servers. This means that the central server is not actively checking services on its own. But what about host checks? You still need to do them, so how? + +

+ + + +

+ +Since host checks usually compromise a small part of monitoring activity (they aren't done unless absolutely necessary), I'd recommend that you perform host checks actively from the central server. That means that you define host checks on the central server the same way that you do on the distributed servers (and the same way you would in a normal, non-distributed setup). + +

+ + + +

+ +Passive host checks are available (read here), so you could use them in your distributed monitoring setup, but they suffer from a few problems. The biggest problem is that Nagios does not translate passive host check problem states (DOWN and UNREACHABLE) when they are processed. This means that if your monitoring servers have a different parent/child host structure (and they will, if you monitoring servers are in different locations), the central monitoring server will have an inaccurate view of host states. + +

+ + + +

+ +If you do want to send passive host checks to a central server in your distributed monitoring setup, make sure: + +

+ + + + + + + +

+ +The ochp command, which is used for processing host check results, works in a similiar manner to the ocsp command, which is used for processing service check results (see documentation above). In order to make sure passive host check results are up to date, you'll want to enable freshness checking for hosts (similiar to what is described above for services). + +

+ + + +
+ + + + + + + diff --git a/docs/downtime.html b/docs/downtime.html new file mode 100644 index 0000000..5195b5b --- /dev/null +++ b/docs/downtime.html @@ -0,0 +1,238 @@ + + + + + + + + +Scheduled Downtime + + + + + + + + + + + + + + + +
+ +Nagios + +

Scheduled Downtime

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Notifications + +

+ + + +

+ +Introduction + +

+ + + +

+ +Nagios allows you to schedule periods of planned downtime for hosts and service that you're monitoring. This is useful in the event that you actually know you're going to be taking a server down for an upgrade, etc. + +

+ + + +Scheduled Downtime + + + + + +

+ +Scheduling Downtime + +

+ + + +

+ +You can schedule downtime for hosts and service through the extinfo CGI (either when viewing host or service information). Click in the "Schedule downtime for this host/service" link to actually schedule the downtime. + +

+ + + +

+ +Once you schedule downtime for a host or service, Nagios will add a comment to that host/service indicating that it is scheduled for downtime during the period of time you indicated. When that period of downtime passes, Nagios will automatically delete the comment that it added. Nice, huh? + +

+ + + +

+ +Fixed vs. Flexible Downtime + +

+ + + +

+ +When you schedule downtime for a host or service through the web interface you'll be asked if the downtime is fixed or flexible. Here's an explanation of how "fixed" and "flexible" downtime differs: + +

+ + + +

+ +"Fixed" downtime starts and stops at the exact start and end times that you specify when you schedule it. Okay, that was easy enough... + +

+ + + +

+ +"Flexible" downtime is intended for times when you know that a host or service is going to be down for X minutes (or hours), but you don't know exactly when that'll start. When you schedule flexible downtime, Nagios will start the scheduled downtime sometime between the start and end times you specified. The downtime will last for as long as the duration you specified when you scheduled the downtime. This assumes that the host or service for which you scheduled flexible downtime either goes down (or becomes unreachable) or goes into a non-OK state sometime between the start and end times you specified. The time at which a host or service transitions to a problem state determines the time at which Nagios actually starts the downtime. The downtime will then last for the duration you specified, even if the host or service recovers before the downtime expires. This is done for a very good reason. As we all know, you might think you've got a problem fixed, but then have to restart a server ten times before it actually works right. Smart, eh? + +

+ + + +

+ +Triggered Downtime + +

+ + + +

+ +When scheduling host or service downtime you have the option of making it "triggered" downtime. What is triggered downtime, you ask? With triggered downtime the start of the downtime is triggered by the start of some other scheduled host or service downtime. This is extremely useful if you're scheduling downtime for a large number or hosts or services and the start time of the downtime period depends on the start time of another downtime entry. For instance, if you schedule flexible downtime for a particular host (because its going down for maintenance), you might want to schedule triggered downtime for all of that hosts's "children". + +

+ + + + + +

+ +How Scheduled Downtime Affects Notifications + +

+ + + +

+ +When a host or service is in a period of scheduled downtime, Nagios will not allow normal notifications to be sent out for the host or service. However, a "DOWNTIMESTART" notification will get sent out for the host or service, which will serve to put any admins on notice that they won't receive upcoming problem alerts. + +

+ +

+ +When the scheduled downtime is over, Nagios will allow normal notifications to be sent out for the host or service again. A "DOWNTIMEEND" notification will get sent out notifying admins that the scheduled downtime is over, and they will start receiving normal alerts again. + +

+ +

+ +If the scheduled downtime is cancelled prematurely (before it expires), a "DOWNTIMECANCELLED" notification will get sent out to the appropriate admins. + +

+ + + +

+ +Overlapping Scheduled Downtime + +

+ + + +

+ +I like to refer to this as the "Oh crap, its not working" syndrome. You know what I'm talking about. You take a server down to perform a "routine" hardware upgrade, only to later realize that the OS drivers aren't working, the RAID array blew up, or the drive imaging failed and left your original disks useless to the world. Moral of the story is that any routine work on a server is quite likely to take three or four times as long as you had originally planned... + +

+ + + +

+ +Let's take the following scenario: + +

+ + + +
    + +
  1. You schedule downtime for host A from 7:30pm-9:30pm on a Monday + +
  2. You bring the server down about 7:45pm Monday evening to start a hard drive upgrade + +
  3. After wasting an hour and a half battling with SCSI errors and driver incompatabilities, you finally get the machine to boot up + +
  4. At 9:15 you realize that one of your partitions is either hosed or doesn't seem to exist anywhere on the drive + +
  5. Knowing you're in for a long night, you go back and schedule additional downtime for host A from 9:20pm Monday evening to 1:30am Tuesday Morning. + +
+ + + +

+ +If you schedule overlapping periods of downtime for a host or service (in this case the periods were 7:40pm-9:30pm and 9:20pm-1:30am), Nagios will wait until the last period of scheduled downtime is over before it allows notifications to be sent out for that host or service. In this example notifications would be suppressed for host A until 1:30am Tuesday morning. + +

+ + + +
+ + + + + + + diff --git a/docs/embeddedperl.html b/docs/embeddedperl.html new file mode 100644 index 0000000..b8f6645 --- /dev/null +++ b/docs/embeddedperl.html @@ -0,0 +1,386 @@ + + + + + + + + +Using The Embedded Perl Interpreter + + + + + + + + + + + + + + + +
+ +Nagios + +

Using The Embedded Perl Interpreter

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Developing Plugins For Use With Embedded Perl + +

+ + + + + + + + + + + + + + + +
+ +

+ +Introduction + +

+ + + +

+ +Nagios can be compiled with support for an embedded Perl interpreter. This allows Nagios to execute Perl plugins much more efficiently that it otherwise would, so it may be of interest to you if you rely heavily on plugins written in Perl. + +

+ + + +

+ +Without the embedded Perl interpreter, Nagios executes Perl (and non-Perl) plugins by forking and executing the plugins as an external command. When the embedded Perl interpreter is used, Nagios can execute Perl plugins by simply making a library call. + +

+ + + +

+ +Tip Tip: The embedded Perl interpreter works with all Perl scripts that Nagios executes - not just plugins. This documentation discusses the embedded Perl interpreter in relation to plugins used for host and service checks, but it applies just the same to other types of Perl scripts you may be using for other types of commands (e.g. notification scripts, event handler scripts, etc.). + +

+ + + + + +

+ +Stephen Davies contributed the original embedded Perl interpreter code several years back. Stanley Hopcroft has been the primary person helping to improve the embedded Perl interpreter code quite a bit and has commented on the advantages/disadvanges of using it. He has also given several helpful hints on creating Perl plugins that work properly with the embedded interpreter. + +

+ + + +

+ +It should be noted that "ePN", as used in this documentation, refers to embedded Perl Nagios, or if you prefer, Nagios compiled with an embedded Perl interpreter. + +

+ +		Embedded Perl Interpreter
+ + + +

+ +Advantages + +

+ + + +

+ +Some advantages of ePN (embedded Perl Nagios) include: + +

+ + + + + + + +

+ +Disadvantages + +

+ + + +

+ +The disadvantages of ePN (embedded Perl Nagios) are much the same as Apache mod_perl (i.e. Apache with an embedded interpreter) compared to a plain Apache: + +

+ + + + + + + + + +

+ +Using The Embedded Perl Interpreter + +

+ + + +

+ +If you want to use the embedded Perl interpreter to run your Perl plugins and scripts, here's what you'll need to do: + +

+ + + +
    + +
  1. Compile Nagios with support for the embedded Perl interpreter (see instructions below).

    2. + +
  2. Enable the enable_embedded_perl option in the main configuration file.

    3. + +
  3. Set the use_embedded_perl_implicitly option to fit your needs. This option determines whether or not the Perl interpreter should be used by default for individual Perl plugins and scripts.

    4. + +
  4. Optionally enable or disable certain Perl plugins and scripts from being run using the embedded Perl interpreter. This can be useful if certain Perl scripts have problems being running under the Perl interpreter. See instructions below for more information on doing this.

    5. + +
+ + + + + +

+ +Compiling Nagios With Embedded Perl + +

+ + + + + +

+ +If you want to use the embedded Perl interpreter, you'll first need to compile Nagios with support for it. + +To do this, simply run the configure script with the addition of the --enable-embedded-perl option. If you want the embedded interpreter to cache internally compiled scripts, add the --with-perlcache option as well. Example: + +

+ + + +
+
+	./configure --enable-embedded-perl --with-perlcache otheroptions...
+
+
+ + + +

+ +Once you've rerun the configure script with the new options, make sure to recompile Nagios. + +

+ + + + + +

+ +Plugin-Specific Use of the Perl Interpreter + +

+ + + +

+ +Beginning with Nagios 3, you can specify which Perl plugins or scripts should or should not be run under the embedded Perl interpreter. This is particularly useful if you have troublesome Perl scripts which do not work well with the Perl interpreter. + +

+ + + +

+ +To explicitly tell Nagios whether or not to use the embedded Perl interpreter for a particular perl script, add one of the following entries to your Perl script/plugin... + +

+ + + +

+ +To tell Nagios to use the Perl interpreter for a particular script, add this line to the Perl script: + +

+ + + +
+
+# nagios: +epn
+
+
+ + + +

+ +To tell Nagios to NOT use the embedded Perl interpreter for a particular script, add this line to the Perl script: + +

+ + + +
+
+# nagios: -epn
+
+
+ + + + + +

+ +Either line must be located within the first 10 lines of a script for Nagios to detect it. + +

+ + + +

+ +Tip Tip: If you do not explicitly use the method above to tell Nagios whether an individual plugin can be run under the Perl interpreter, Nagios will make will a decision for you. This decision process is controlled by the use_embedded_perl_implicitly variable. If the value is set to 1, all Perl plugins/scripts (that do not explicitly enable/disable the ePN) will be run under the Perl interpreter. If the value is 0, they will NOT be run under the Perl interpreter. + +

+ + + + + +

+ +Developing Plugins For Use With Embedded Perl + +

+ + + +

+ +Information on developing plugins for use with the embedded Perl interpreter can be found here. + +

+ + + + + +
+ + + + + + + diff --git a/docs/epnplugins.html b/docs/epnplugins.html new file mode 100644 index 0000000..30aac24 --- /dev/null +++ b/docs/epnplugins.html @@ -0,0 +1,476 @@ + + + + + + + + +Developing Plugins For Use With Embedded Perl + + + + + + + + + + + + + + + +
+ +Nagios + +

Developing Plugins For Use With Embedded Perl

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Embedded Perl Interpreter Overview, Plugin API + +

+ + + +

+ +Introduction + +

+ + + +

+ +Stanley Hopcroft has worked with the embedded Perl interpreter quite a bit and has commented on the advantages/disadvanges of using it. He has also given several helpful hints on creating Perl plugins that work properly with the embedded interpreter. The majority of this documentation comes from his comments. + +

+ +

+ +It should be noted that "ePN", as used in this documentation, refers to embedded Perl Nagios, or if you prefer, Nagios compiled with an embedded Perl interpreter. + +

+ + + +

+ +Target Audience + +

+ + + + + + + + + +

+ +Things you should do when developing a Perl Plugin (ePN or not) + +

+ + + + + + + + + +

+ +Things you must do to develop a Perl plugin for ePN + +

+ + + +
    + + + + + +
  1. <DATA> can not be used; use here documents instead e.g.

    + +
    +
+my $data = <<DATA;
+
+portmapper 100000
+
+portmap 100000
+
+sunrpc 100000
+
+rpcbind 100000
+
+rstatd 100001
+
+rstat 100001
+
+rup 100001
+
+..
+
+DATA
+
+
+
+%prognum = map { my($a, $b) = split; ($a, $b) } split(/\n/, $data) ;
+
+
    + + + +
  2. BEGIN blocks will not work as you expect. May be best to avoid.

    + + + +
  3. Ensure that it is squeaky clean at compile time i.e.

    + +
      + +
    • use strict + +
    • use perl -w (other switches [T notably] may not help) + +
    • use perl -c + +
    + + + +

    + + + +
  4. Avoid lexical variables (my) with global scope as a means of passing __variable__ data into subroutines. In fact this is __fatal__ if the subroutine is called by the plugin more than once when the check is run. Such subroutines act as 'closures' that lock the global lexicals first value into subsequent calls of the subroutine. If however, your global + +is read-only (a complicated structure for example) this is not a problem. What Bekman recommends you do instead, is any of the following:

    + + + +
      + +
    • make the subroutine anonymous and call it via a code ref e.g.

      + +
      +
+turn this                     into  
+
+
+
+my $x = 1 ;                   my $x = 1 ;
+
+sub a { .. Process $x ... }   $a_cr = sub { ... Process $x ... } ;
+
+.                             .
+
+.                             .
+
+a ;                           &$a_cr ;
+
+$x = 2                        $x = 2 ;
+
+a ;                           &$a_cr ;
+
+
+
+# anon closures __always__ rebind the current lexical value
+
+
      + + + +
    • put the global lexical and the subroutine using it in their own package (as an object or a module) + + + +
    • pass info to subs as references or aliases (\$lex_var or $_[n]) + + + +
    • replace lexicals with package globals and exclude them from 'use strict' objections with 'use vars qw(global1 global2 ..)' + +
    + + + +
    + + + +
  5. Be aware of where you can get more information.

    + + + +

    + +Useful information can be had from the usual suspects (the O'Reilly books, plus Damien Conways "Object Oriented Perl") but for the really useful stuff in the right context start at Stas Bekman's mod_perl guide at http://perl.apache.org/guide/. + +

    + +

    + +This wonderful book sized document has nothing whatsoever about Nagios, but all about writing Perl programs for the embedded Perl interpreter in Apache (ie Doug MacEacherns mod_perl). + +

    + +

    + +The perlembed manpage is essential for context and encouragement. + +

    + +

    + +On the basis that Lincoln Stein and Doug MacEachern know a thing or two about Perl and embedding Perl, their book 'Writing Apache Modules with Perl and C' is almost certainly worth looking at. + +

    + + + +
  6. Be aware that your plugin may return strange values with an ePN and that this is likely to be caused by the problem in item #4 above

    + + + + + +
  7. Be prepared to debug via:

    + +
      + +
    • having a test ePN and + +
    • adding print statements to your plugin to display variable values to STDERR (can't use STDOUT) + +
    • adding print statements to p1.pl to display what ePN thinks your plugin is before it tries to run it (vi) + +
    • running the ePN in foreground mode (probably in conjunction with the former recommendations) + +
    • use the 'Deparse' module on your plugin to see how the parser has optimised it and what the interpreter will actually get. (see 'Constants in Perl' by Sean M. Burke, The Perl Journal, Fall 2001) + +
    + + + +
    + + + +
    +
+perl -MO::Deparse <your_program>
+
+
    + + + +
    + + + +
  8. Be aware of what ePN is transforming your plugin too, and if all else fails try and debug the transformed version.

    + + + +

    + +As you can see below p1.pl rewrites your plugin as a subroutine called 'hndlr' in the package named 'Embed::<something_related_to_your_plugin_file_name>'. + +

    + +

    + +Your plugin may be expecting command line arguments in @ARGV so pl.pl also assigns @_ to @ARGV. + +

    + +

    + +This in turn gets 'eval' ed and if the eval raises an error (any parse error and run error), the plugin gets chucked out. + +

    + +

    + +The following output shows how a test ePN transformed the check_rpc plugin before attempting to execute it. Most of the code from the actual plugin is not shown, as we are interested in only the transformations that the ePN has made to the plugin). For clarity, transformations are shown in red: + +

    + + + +
    +
+
+
+                package main;
+
+                use subs 'CORE::GLOBAL::exit';
+
+                sub CORE::GLOBAL::exit { die "ExitTrap: $_[0] 
+
+(Embed::check_5frpc)"; }
+
+                package Embed::check_5frpc; sub hndlr { shift(@_);
+
+@ARGV=@_;
+
+#! /usr/bin/perl -w
+
+#
+
+# check_rpc plugin for Nagios
+
+#
+
+# usage:
+
+#    check_rpc host service
+
+#
+
+# Check if an rpc serice is registered and running
+
+# using rpcinfo - $proto $host $prognum 2>&1 |";
+
+#
+
+# Use these hosts.cfg entries as examples
+
+#
+
+# command[check_nfs]=/some/path/libexec/check_rpc $HOSTADDRESS$ nfs
+
+# service[check_nfs]=NFS;24x7;3;5;5;unix-admin;60;24x7;1;1;1;;check_rpc
+
+#
+
+# initial version: 3 May 2000 by Truongchinh Nguyen and Karl DeBisschop
+
+# current status: $Revision$
+
+#
+
+# Copyright Notice: GPL
+
+#
+
+... rest of plugin code goes here (it was removed for brevity) ...
+
+}
+
+
    + + + + + +
    + + + +
  9. Don't use 'use diagnostics' in a plugin run by your production ePN. I think it causes__all__ the Perl plugins to return CRITICAL.

    + + + +
  10. Consider using a mini embedded Perl C program to check your plugin. This is not sufficient to guarantee your plugin will perform Ok with an ePN but if the plugin fails this test it will certainly fail with your ePN. [ A sample mini ePN is included in the contrib/ directory of the Nagios distribution for use in testing Perl plugins. Change to the contrib/ directory and type 'make mini_epn' to compile it. It must be executed from the same directory that the p1.pl file resides in (this file is distributed with Nagios). ]

    + + + + + +
+ + + + + + + +
+ + + + + + + diff --git a/docs/escalations.html b/docs/escalations.html new file mode 100644 index 0000000..65cb988 --- /dev/null +++ b/docs/escalations.html @@ -0,0 +1,604 @@ + + + + + + + + +Notification Escalations + + + + + + + + + + + + + + + +
+ +Nagios + +

Notification Escalations

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Notifications, Time Periods + +

+ + + +

+ +Introduction + +

+ + + +Contacts + + + +

+ +Nagios supports optional escalation of contact notifications for hosts and services. Escalation of host and service notifications is accomplished by defining host escalations and service escalations in your object configuration file(s). + +

+ + + +

+ +Note Note: The examples I provide below all make use of service escalation definitions, but host escalations work the same way. Except, of course, that they're for hosts instead of services. :-) + +

+ + + +

+ +When Are Notifications Escalated? + +

+ + + +

+ +Notifications are escalated if and only if one or more escalation definitions matches the current notification that is being sent out. If a host or service notification does not have any valid escalation definitions that applies to it, the contact group(s) specified in either the host group or service definition will be used for the notification. Look at the example below: + +

+ + + +
+
+define serviceescalation{
+
+	host_name		webserver
+
+	service_description	HTTP
+
+	first_notification	3
+
+	last_notification	5
+
+	notification_interval	90
+
+	contact_groups		nt-admins,managers
+
+	}
+
+
+
+define serviceescalation{
+
+	host_name		webserver
+
+	service_description	HTTP
+
+	first_notification	6
+
+	last_notification	10
+
+	notification_interval	60
+
+	contact_groups		nt-admins,managers,everyone
+
+	}
+
+
+ + + +

+ +Notice that there are "holes" in the notification escalation definitions. In particular, notifications 1 and 2 are not handled by the escalations, nor are any notifications beyond 10. For the first and second notification, as well as all notifications beyond the tenth one, the default contact groups specified in the service definition are used. For all the examples I'll be using, I'll be assuming that the default contact groups for the service definition is called nt-admins. + +

+ + + +

+ +Contact Groups + +

+ + + +

+ +When defining notification escalations, it is important to keep in mind that any contact groups that were members of "lower" escalations (i.e. those with lower notification number ranges) should also be included in "higher" escalation definitions. This should be done to ensure that anyone who gets notified of a problem continues to get notified as the problem is escalated. Example: + +

+ + + +
+
+define serviceescalation{
+
+	host_name		webserver
+
+	service_description	HTTP
+
+	first_notification	3
+
+	last_notification	5
+
+	notification_interval	90
+
+	contact_groups		nt-admins,managers
+
+	}
+
+
+
+define serviceescalation{
+
+	host_name		webserver
+
+	service_description	HTTP
+
+	first_notification	6
+
+	last_notification	0
+
+	notification_interval	60
+
+	contact_groups		nt-admins,managers,everyone
+
+	}
+
+
+ + + +

+ +The first (or "lowest") escalation level includes both the nt-admins and managers contact groups. The last (or "highest") escalation level includes the nt-admins, managers, and everyone contact groups. Notice that the nt-admins contact group is included in both escalation definitions. This is done so that they continue to get paged if there are still problems after the first two service notifications are sent out. The managers contact group first appears in the "lower" escalation definition - they are first notified when the third problem notification gets sent out. We want the managers group to continue to be notified if the problem continues past five notifications, so they are also included in the "higher" escalation definition. + +

+ + + +

+ +Overlapping Escalation Ranges + +

+ + + +

+ +Notification escalation definitions can have notification ranges that overlap. Take the following example: + +

+ + + +
+
+define serviceescalation{
+
+	host_name		webserver
+
+	service_description	HTTP
+
+	first_notification	3
+
+	last_notification	5
+
+	notification_interval	20
+
+	contact_groups		nt-admins,managers
+
+	}
+
+
+
+define serviceescalation{
+
+	host_name		webserver
+
+	service_description	HTTP
+
+	first_notification	4
+
+	last_notification	0
+
+	notification_interval	30
+
+	contact_groups		on-call-support
+
+	}
+
+
+ + + +

+ +In the example above: + +

+ + + + + + + +

+ +Recovery Notifications + +

+ + + +

+ +Recovery notifications are slightly different than problem notifications when it comes to escalations. Take the following example: + +

+ + + +
+
+define serviceescalation{
+
+	host_name		webserver
+
+	service_description	HTTP
+
+	first_notification	3
+
+	last_notification	5
+
+	notification_interval	20
+
+	contact_groups		nt-admins,managers
+
+	}
+
+
+
+define serviceescalation{
+
+	host_name		webserver
+
+	service_description	HTTP
+
+	first_notification	4
+
+	last_notification	0
+
+	notification_interval	30
+
+	contact_groups		on-call-support
+
+	}
+
+
+ + + +

+ +If, after three problem notifications, a recovery notification is sent out for the service, who gets notified? The recovery is actually the fourth notification that gets sent out. However, the escalation code is smart enough to realize that only those people who were notified about the problem on the third notification should be notified about the recovery. In this case, the nt-admins and managers contact groups would be notified of the recovery. + +

+ + + +

+ +Notification Intervals + +

+ + + +

+ +You can change the frequency at which escalated notifications are sent out for a particular host or service by using the notification_interval option of the hostgroup or service escalation definition. Example: + +

+ + + +
+
+define serviceescalation{
+
+	host_name		webserver
+
+	service_description	HTTP
+
+	first_notification	3
+
+	last_notification	5
+
+	notification_interval	45
+
+	contact_groups		nt-admins,managers
+
+	}
+
+
+
+define serviceescalation{
+
+	host_name		webserver
+
+	service_description	HTTP
+
+	first_notification	6
+
+	last_notification	0
+
+	notification_interval	60
+
+	contact_groups		nt-admins,managers,everyone
+
+	}
+
+
+ + + +

+ +In this example we see that the default notification interval for the services is 240 minutes (this is the value in the service definition). When the service notification is escalated on the 3rd, 4th, and 5th notifications, an interval of 45 minutes will be used between notifications. On the 6th and subsequent notifications, the notification interval will be 60 minutes, as specified in the second escalation definition. + +

+ + + +

+ +Since it is possible to have overlapping escalation definitions for a particular hostgroup or service, and the fact that a host can be a member of multiple hostgroups, Nagios has to make a decision on what to do as far as the notification interval is concerned when escalation definitions overlap. In any case where there are multiple valid escalation definitions for a particular notification, Nagios will choose the smallest notification interval. Take the following example: + +

+ + + +
+
+define serviceescalation{
+
+	host_name		webserver
+
+	service_description	HTTP
+
+	first_notification	3
+
+	last_notification	5
+
+	notification_interval	45
+
+	contact_groups		nt-admins,managers
+
+	}
+
+
+
+define serviceescalation{
+
+	host_name		webserver
+
+	service_description	HTTP
+
+	first_notification	4
+
+	last_notification	0
+
+	notification_interval	60
+
+	contact_groups		nt-admins,managers,everyone
+
+	}
+
+
+ + + +

+ +We see that the two escalation definitions overlap on the 4th and 5th notifications. For these notifications, Nagios will use a notification interval of 45 minutes, since it is the smallest interval present in any valid escalation definitions for those notifications. + +

+ + + +

+ +One last note about notification intervals deals with intervals of 0. An interval of 0 means that Nagios should only sent a notification out for the first valid notification during that escalation definition. All subsequent notifications for the hostgroup or service will be suppressed. Take this example: + +

+ + + +
+
+define serviceescalation{
+
+	host_name		webserver
+
+	service_description	HTTP
+
+	first_notification	3
+
+	last_notification	5
+
+	notification_interval	45
+
+	contact_groups		nt-admins,managers
+
+	}
+
+
+
+define serviceescalation{
+
+	host_name		webserver
+
+	service_description	HTTP
+
+	first_notification	4
+
+	last_notification	6
+
+	notification_interval	0
+
+	contact_groups		nt-admins,managers,everyone
+
+	}
+
+	
+
+define serviceescalation{
+
+	host_name		webserver
+
+	service_description	HTTP
+
+	first_notification	7
+
+	last_notification	0
+
+	notification_interval	30
+
+	contact_groups		nt-admins,managers
+
+	}
+
+
+ + + +

+ +In the example above, the maximum number of problem notifications that could be sent out about the service would be four. This is because the notification interval of 0 in the second escalation definition indicates that only one notification should be sent out (starting with and including the 4th notification) and all subsequent notifications should be repressed. Because of this, the third service escalation definition has no effect whatsoever, as there will never be more than four notifications. + +

+ + + +

+ +Time Period Restrictions + +

+ + + +

+ +Under normal circumstances, escalations can be used at any time that a notification could normally be sent out for the host or service. This "notification time window" is determined by the notification_period directive in the host or service definition. + +

+ + + +

+ +You can optionally restrict escalations so that they are only used during specific time periods by using the escalation_period directive in the host or service escalation definition. If you use the escalation_period directive to specify a timeperiod during which the escalation can be used, the escalation will only be used during that time. If you do not specify any escalation_period directive, the escalation can be used at any time within the "notification time window" for the host or service. + +

+ + + +

+ +Note Note: Escalated notifications are still subject to the normal time restrictions imposed by the notification_period directive in a host or service definition, so the timeperiod you specify in an escalation definition should be a subset of that larger "notification time window". + +

+ + + +

+ +State Restrictions + +

+ + + +

+ +If you would like to restrict the escalation definition so that it is only used when the host or service is in a particular state, you can use the escalation_options directive in the host or service escalation definition. If you do not use the escalation_options directive, the escalation can be used when the host or service is in any state. + +

+ + + +
+ + + + + + + diff --git a/docs/eventhandlers.html b/docs/eventhandlers.html new file mode 100644 index 0000000..0436d1f --- /dev/null +++ b/docs/eventhandlers.html @@ -0,0 +1,547 @@ + + + + + + + + +Event Handlers + + + + + + + + + + + + + + + +
+ +Nagios + +

Event Handlers

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: State Types, Host Checks, Service Checks + +

+ + + +

+ +Introduction + +

+ + + +Event Handlers + + + +

+ +Event handlers are optional system commands (scripts or executables) that are run whenever a host or service state change occurs. + +

+ + + +

+ +An obvious use for event handlers is the ability for Nagios to proactively fix problems before anyone is notified. Some other uses for event handlers include: + +

+ + + + + + + +

+ +* Cycling power on a host that is experiencing problems with an auomated script should not be implemented lightly. Consider the consequences of this carefully before implementing automatic reboots. :-) + +

+ + + +

+ +When Are Event Handlers Executed? + +

+ +

+ +Event handlers are executed when a service or host: + +

+ + + +

+ +SOFT and HARD states are described in detail here . + +

+ + + +

+ +Event Handler Types + +

+ + + +

+ +There are different types of optional event handlers that you can define to handle host and state changes: + +

+ + + + + + + +

+ +Global host and service event handlers are run for every host or service state change that occurs, immediately prior to any host- or service-specific event handler that may be run. You can specify global event handler commands by using the global_host_event_handler and global_service_event_handler options in your main configuration file. + +

+ + + +

+ +Individual hosts and services can have their own event handler command that should be run to handle state changes. You can specify an event handler that should be run by using the event_handler directive in your host and service definitions. These host- and service-specific event handlers are executed immediately after the (optional) global host or service event handler is executed. + +

+ + + +

+ +Enabling Event Handlers + +

+ + + +

+ +Event handlers can be enabled or disabled on a program-wide basis by using the enable_event_handlers in your main configuration file. + +

+ + + +

+ +Host- and service-specific event handlers can be enabled or disabled by using the event_handler_enabled directive in your host and service definitions. Host- and service-specific event handlers will not be executed if the global enable_event_handlers option is disabled. + +

+ + + +

+ +Event Handler Execution Order + +

+ + + +

+ +As already mentioned, global host and service event handlers are executed immediately before host- or service-specific event handlers. + +

+ + + +

+ +Event handlers are executed for HARD problem and recovery states immediately after notifications are sent out. + +

+ + + +

+ +Writing Event Handler Commands + +

+ +

+ +Event handler commands will likely be shell or perl scripts, but they can be any type of executable that can run from a command prompt. At a minimum, the scripts should take the following macros as arguments: + +

+ +

+ +For Services: $SERVICESTATE$, $SERVICESTATETYPE$, $SERVICEATTEMPT$
+ +For Hosts: $HOSTSTATE$, $HOSTSTATETYPE$, $HOSTATTEMPT$ + +

+ +

+ +The scripts should examine the values of the arguments passed to it and take any necessary action based upon those values. The best way to understand how event handlers work is to see an example. Lucky for you, one is provided below. + +

+ + + +

+ +Tip Tip: Additional sample event handler scripts can be found in the contrib/eventhandlers/ subdirectory of the Nagios distribution. Some of these sample scripts demonstrate the use of external commands to implement a redundant and distributed monitoring environments. + +

+ + + +

+ +Permissions For Event Handler Commands + +

+ +

+ +Event handler commands will normally execute with the same permissions as the user under which + +Nagios is running on your machine. This can present a problem if you want to write an event handler that restarts system + +services, as root privileges are generally required to do these sorts of tasks. + +

+ +

+ +Ideally you should evaluate the types of event handlers you will be implementing and grant just enough permissions + +to the Nagios user for executing the necessary system commands. You might want to try using sudo to accomplish this. + +

+ + + + + +

+ +Service Event Handler Example + +

+ +

+ +The example below assumes that you are monitoring the HTTP server on the local machine and have specified restart-httpd as the event handler command for the HTTP service definition. Also, I will be assuming that you have set the max_check_attempts option for the service to be a value of 4 or greater (i.e. the service is checked 4 times before it is considered to have a real problem). An abbreviated example service definition might look like this... + +

+ + + +
+
+define service{
+
+	host_name			somehost
+
+	service_description	HTTP
+
+	max_check_attempts		4
+
+	event_handler		restart-httpd
+
+	...
+
+	}
+
+
+ + + + + +

+ +Once the service has been defined with an event handler, we must define that event handler as a command. An example command definition for restart-httpd is shown below. Notice the macros in the command line that I am passing to the event handler script - these are important! + +

+ + + +
+
+define command{
+
+	command_name	restart-httpd
+
+	command_line	/usr/local/nagios/libexec/eventhandlers/restart-httpd  $SERVICESTATE$ $SERVICESTATETYPE$ $SERVICEATTEMPT$
+
+	}
+
+
+ + + +

+ +Now, let's actually write the event handler script (this is the /usr/local/nagios/libexec/eventhandlers/restart-httpd script). + +

+ + + +

+ + + +
+
+#!/bin/sh
+
+#
+
+# Event handler script for restarting the web server on the local machine
+
+#
+
+# Note: This script will only restart the web server if the service is
+
+#       retried 3 times (in a "soft" state) or if the web service somehow
+
+#       manages to fall into a "hard" error state.
+
+#
+
+
+
+
+
+# What state is the HTTP service in?
+
+case "$1" in
+
+OK)
+
+	# The service just came back up, so don't do anything...
+
+	;;
+
+WARNING)
+
+	# We don't really care about warning states, since the service is probably still running...
+
+	;;
+
+UNKNOWN)
+
+	# We don't know what might be causing an unknown error, so don't do anything...
+
+	;;
+
+CRITICAL)
+
+	# Aha!  The HTTP service appears to have a problem - perhaps we should restart the server...
+
+
+
+	# Is this a "soft" or a "hard" state?
+
+	case "$2" in
+
+		
+
+	# We're in a "soft" state, meaning that Nagios is in the middle of retrying the
+
+	# check before it turns into a "hard" state and contacts get notified...
+
+	SOFT)
+
+			
+
+		# What check attempt are we on?  We don't want to restart the web server on the first
+
+		# check, because it may just be a fluke!
+
+		case "$3" in
+
+				
+
+		# Wait until the check has been tried 3 times before restarting the web server.
+
+		# If the check fails on the 4th time (after we restart the web server), the state
+
+		# type will turn to "hard" and contacts will be notified of the problem.
+
+		# Hopefully this will restart the web server successfully, so the 4th check will
+
+		# result in a "soft" recovery.  If that happens no one gets notified because we
+
+		# fixed the problem!
+
+		3)
+
+			echo -n "Restarting HTTP service (3rd soft critical state)..."
+
+			# Call the init script to restart the HTTPD server
+
+			/etc/rc.d/init.d/httpd restart
+
+			;;
+
+			esac
+
+		;;
+
+				
+
+	# The HTTP service somehow managed to turn into a hard error without getting fixed.
+
+	# It should have been restarted by the code above, but for some reason it didn't.
+
+	# Let's give it one last try, shall we?  
+
+	# Note: Contacts have already been notified of a problem with the service at this
+
+	# point (unless you disabled notifications for this service)
+
+	HARD)
+
+		echo -n "Restarting HTTP service..."
+
+		# Call the init script to restart the HTTPD server
+
+		/etc/rc.d/init.d/httpd restart
+
+		;;
+
+	esac
+
+	;;
+
+esac
+
+exit 0
+
+
+ + + +

+ + + +

+ +The sample script provided above will attempt to restart the web server on the local machine in two different instances: + +

+ + + + + + + +

+ +The script should theoretically restart and web server and fix the problem before the service goes into a HARD problem state, but we include a fallback case in the event it doesn't work the first time. It should be noted that the event handler will only be executed the first time that the service falls into a HARD problem state. This prevents Nagios from continuously executing the script to restart the web server if the service remains in a HARD problem state. You don't want that. :-) + +

+ + + +

+ +That's all there is to it! Event handlers are pretty simple to write and implement, so give it a try and see what you can do. + +

+ + + + + +
+ + + + + + \ No newline at end of file diff --git a/docs/extcommands.html b/docs/extcommands.html new file mode 100644 index 0000000..6a21f6d --- /dev/null +++ b/docs/extcommands.html @@ -0,0 +1,198 @@ + + + + + + + + +External Commands + + + + + + + + + + + + + + + +
+ +Nagios + +

External Commands

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Passive Checks, Adaptive Monitoring + +

+ + + +

+ +Introduction + +

+ + + +

+ +Nagios can process commands from external applications (including the CGIs) and alter various aspects of its monitoring functions based on the commands it receives. External applications can submit commands by writing to the command file, which is periodically processed by the Nagios daemon. + +

+ + + +External Commands + + + +

+ +Enabling External Commands + +

+ + + +

+ +In order to have Nagios process external commands, make sure you do the following: + +

+ + + + + + + +

+ +When Does Nagios Check For External Commands? + +

+ + + + + + + +

+ +Using External Commands + +

+ + + +

+ +External commands can be used to accomplish a variety of things while Nagios is running. Example of what can be done include temporarily disabling notifications for services and hosts, temporarily disabling service checks, forcing immediate service checks, adding comments to hosts and services, etc. + +

+ + + +

+ +Command Format + +

+ + + +

+ +External commands that are written to the command file have the following format... + +

+ + + +
+
+[time] command_id;command_arguments
+
+
+ + + +

+ +...where time is the time (in time_t format) that the external application submitted the external command to the command file. The values for the command_id and command_arguments arguments will depend on what command is being submitted to Nagios. + +

+ + + +

+ +A full listing of external commands that can be used (along with examples of how to use them) can be found online at the following URL: + +

+ +

+ +http://www.nagios.org/developerinfo/externalcommands/ + +

+ + + + + +
+ + + + + + + diff --git a/docs/faststartup.html b/docs/faststartup.html new file mode 100644 index 0000000..8164724 --- /dev/null +++ b/docs/faststartup.html @@ -0,0 +1,522 @@ + + + + + + + + +Fast Startup Options + + + + + + + + + + + + + + + +
+ +Nagios + +

Fast Startup Options

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Performance Tuning, Large Installation Tweaks + +

+ + + +

+ +Introduction + +

+ + + +

+ +There are a few things you can do that can decrease the amount of time it take Nagios to startup (or restart). These speedups involve easing some of the burden involved in processing your configuration files. + +

+ + + +

+ +Using these techniques is particularly useful when you have one or more of the following: + +

+ + + + + + + +

+ +Background + +

+ + + +

+ +Whenever Nagios starts/restarts it has to process your configuration files before it can get down to the business of monitoring. This configuration startup process involves a number of steps: + +

+ + + + + + + +

+ +Some of these steps can be quite time-consuming when you have large or complex configurations. Is there a way to speed any of these steps up? Yes! + +

+ + + +

+ +Evaluating Startup Times + +

+ + + +

+ +Before we get on to making things faster, we need to see what's possible and whether or not we should even bother with the whole thing. This is easy to do - simply start nagios with the -s command line switch to get timing and scheduling information. + +

+ + + +

+ +An example of the output (abbreviated to only show relevant portions) is shown below. For this example, I'm using a Nagios config that has 25 hosts defined and just over 10,000 services. + +

+ + + +
+
+/usr/local/nagios/bin/nagios -s /usr/local/nagios/etc/nagios.cfg
+
+
+
+Nagios 3.0-prealpha
+
+Copyright (c) 1999-2007 Ethan Galstad (http://www.nagios.org)
+
+Last Modified: 01-27-2007
+
+License: GPL
+
+
+
+Timing information on object configuration processing is listed
+
+below.  You can use this information to see if precaching your
+
+object configuration would be useful.
+
+
+
+Object Config Source: Config files (uncached)
+
+
+
+OBJECT CONFIG PROCESSING TIMES      (* = Potential for precache savings with -u option)
+
+----------------------------------
+
+Read:                 0.486780 sec
+
+Resolve:              0.004106 sec  *
+
+Recomb Contactgroups: 0.000077 sec  *
+
+Recomb Hostgroups:    0.000172 sec  *
+
+Dup Services:         0.028801 sec  *
+
+Recomb Servicegroups: 0.010358 sec  *
+
+Duplicate:            5.666932 sec  *
+
+Inherit:              0.003770 sec  *
+
+Recomb Contacts:      0.030085 sec  *
+
+Sort:                 2.648863 sec  *
+
+Register:             2.654628 sec
+
+Free:                 0.021347 sec
+
+                      ============
+
+TOTAL:                11.555925 sec  * = 8.393170 sec (72.63%) estimated savings
+
+
+
+
+
+Timing information on configuration verification is listed below.
+
+
+
+CONFIG VERIFICATION TIMES          (* = Potential for speedup with -x option)
+
+----------------------------------
+
+Object Relationships: 1.400807 sec
+
+Circular Paths:       54.676622 sec  *
+
+Misc:                 0.006924 sec
+
+                      ============
+
+TOTAL:                56.084353 sec  * = 54.676622 sec (97.5%) estimated savings
+
+
+ + + +

+ +Okay, lets see what happened. Looking at the totals, it took roughly 11.6 seconds to process the configuration files and another 56 seconds to verify the config. That means that every time I start or restart Nagios with this configuration, it will take nearly 68 seconds of startup work before it can monitor anything! That's not acceptable if I have to restart Nagios on a semi-regular basis. + +

+ + + +

+ +What can I do about this? Take another look at the output and you'll see that Nagios estimates that I could save about 8.4 seconds off the configuration processing time and another 54.7 off the verification times. In total, Nagios thinks I could save 63 seconds of the normal startup time if some optimizations were taken. + +

+ + + +

+ +Whoa! From 68 seconds to just 5 seconds? Yep, read on for how to do it. + +

+ + + + + + + +

+ +Pre-Caching Object Configuration + +

+ + + +

+ +Nagios can spend quite a bit of time parsing your config files, especially if you make use of the template features such as inheritance, etc. In order to reduce the time it takes to parse your config, you can have Nagios pre-process and pre-cache your config files for future use. + +

+ + + + + + + + + + + + + + + + + + + + + + + +
+ +

+ +When you run nagios with the -p command line option, Nagios will read your config files in, process them, and save them to a pre-cached object config file (specified by the precached_object_file directive). This pre-cached config file will contain pre-processed configuration entries that are easier/faster for Nagios to process in the future. + +

+ + + +

+ +You must use the -p command line option along with either the -v or -s command line options, as shown below. This ensures that your configuration is verified before the precached file is created. + +

+ + + +
+
+/usr/local/nagios/bin/nagios -pv /usr/local/nagios/etc/nagios.cfg
+
+
+ + + +

+ +The size of your precached config file will most likely be significantly larger than the sum of the sizes of your object config files. This is normal and by design. + +

+ +		 + +
+ +Pre-Caching Object Config Files + +
+ +
+ +

+ +Once the precached object configuration file have been created, you can start Nagios and tell it to use the precached config file instead of your object config file(s) by using the -u command line option. + +

+ + + +
+
+/usr/local/nagios/bin/nagios -ud /usr/local/nagios/etc/nagios.cfg
+
+
+ + + +

Important If you modify your configuration files, you will need to re-verify and re-cache your configuration files before restarting Nagios. If you don't re-generate the precached object file, Nagios will continue to use your old configuration because it is now reading from the precached file, rather than your source configuration files. + +

+ + + +		 + +
+ +Pre-Caching Object Config Files + +
+ +
+ + + +

+ +Skipping Circular Path Tests + +

+ + + +

+ +The second (and most time-intensive) portion of the configuration startup phase is the circular path check. In the example above, it took nearly a minute to perform this step of the configuration verification. + +

+ + + +

+ +What is the circular path check and why does it take so long? The circular patch check is designed to ensure that you don't define any circular paths in your host, host dependency, or service dependency definitions. If a circular path existed in your config files, Nagios could end up in a deadlock situation. The most likely reason for the check taking so long is that I'm not using an efficient algorithm. A much more efficient algorithm for detecting circular paths would be most welcomed. Hint: That means all you CompSci graduate students who have been emailing me about doing your thesis on Nagios can contribute some code back. :-) + +

+ + + +

+ +If you want to skip the circular path check when Nagios starts, you can add the -x command line option like this: + +

+ + + +
+
+/usr/local/nagios/bin/nagios -xd /usr/local/nagios/etc/nagios.cfg
+
+
+ + + +

Important It is of utmost importance that you verify your configuration before starting/restarting Nagios when skipping circular path checks. Failure to do so could lead to deadlocks in the Nagios logic. You have been warned. + +

+ + + +

+ +Putting It All Together + +

+ + + +

+ +Follow these steps if you want to make use of potential speedups from pre-caching your configuration and skipping circular path checks. + +

+ + + +

+ +1. Verify your configuration and create the precache file with the following command: + +

+ + + +
+
+/usr/local/nagios/bin/nagios -vp /usr/local/nagios/etc/nagios.cfg
+
+
+ + + +

+ +2. Stop Nagios if it is currently running. + +

+ + + +

+ +3. Start Nagios like so to use the precached config file and skip circular path checks: + +

+ + + +
+
+/usr/local/nagios/bin/nagios -uxd /usr/local/nagios/etc/nagios.cfg
+
+
+ + + + + +

+ +4. When you modify your original configuration files in the future and need to restart Nagios to make those changes take place, repeat step 1 to re-verify your config and regenerate your cached config file. Once that is done you can restart Nagios through the web interface or by sending a SIGHUP signal. If you don't re-generate the precached object file, Nagios will continue to use your old confguration because it is now reading from the precached file, rather than your source configuration files. + +

+ + + +

+ +5. That's it! Enjoy the increased startup speed. + +

+ + + + + +
+ + + + + + + diff --git a/docs/flapping.html b/docs/flapping.html new file mode 100644 index 0000000..895f4ab --- /dev/null +++ b/docs/flapping.html @@ -0,0 +1,504 @@ + + + + + + + + +Detection and Handling of State Flapping + + + + + + + + + + + + + + + +
+ +Nagios + +

Detection and Handling of State Flapping

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: State Types + +

+ + + +

+ +Introduction + +

+ + + +

+ +Nagios supports optional detection of hosts and services that are "flapping". Flapping occurs when a service or host changes state too frequently, resulting in a storm of problem and recovery notifications. Flapping can be indicative of configuration problems (i.e. thresholds set too low), troublesome services, or real network problems. + +

+ + + + + +

+ +How Flap Detection Works + +

+ + + +

+ +Before I get into this, let me say that flapping detection has been a little difficult to implement. How exactly does one determine what "too frequently" means in regards to state changes for a particular host or service? When I first started thinking about implementing flap detection I tried to find some information on how flapping could/should be detected. I couldn't find any information about what others were using (where they using any?), so I decided to settle with what seemed to me to be a reasonable solution... + +

+ + + +

+ +Whenever Nagios checks the status of a host or service, it will check to see if it has started or stopped flapping. It does this by: + +

+ + + + + + + +

+ +A host or service is determined to have started flapping when its percent state change first exceeds a high flapping threshold. + +

+ + + +

+ +A host or service is determined to have stopped flapping when its percent state goes below a low flapping threshold (assuming that is was previously flapping). + +

+ + + +

+ +Example + +

+ + + +

+ +Let's describe in more detail how flap detection works with services... + +

+ + + +

+ +The image below shows a chronological history of service states from the most recent 21 service checks. OK states are shown in green, WARNING states in yellow, CRITICAL states in red, and UNKNOWN states in orange. + +

+ + + +

+ +Service State Transitions + +

+ + + +

+ +The historical service check results are examined to determine where state changes/transitions occur. State changes occur when an archived state is different from the archived state that immediately precedes it chronologically. Since we keep the results of the last 21 service checks in the array, there is a possibility of having at most 20 state changes. In this example there are 7 state changes, indicated by blue arrows in the image above. + +

+ + + +

+ +The flap detection logic uses the state changes to determine an overall percent state change for the service. This is a measure of volatility/change for the service. Services that never change state will have a 0% state change value, while services that change state each time they're checked will have 100% state change. Most services will have a percent state change somewhere in between. + +

+ + + +

+ +When calculating the percent state change for the service, the flap detection algorithm will give more weight to new state changes compare to older ones. Specfically, the flap detection routines are currently designed to make the newest possible state change carry 50% more weight than the oldest possible state change. The image below shows how recent state changes are given more weight than older state changes when calculating the overall or total percent state change for a particular service. + +

+ + + +

+ +Weighted Service State Transitions + +

+ + + +

+ +Using the images above, lets do a calculation of percent state change for the service. You will notice that there are a total of 7 state changes (at t3, t4, t5, t9, t12, t16, and t19). Without any weighting of the state changes over time, this would give us a total state change of 35%: + +

+ +

+ +(7 observed state changes / possible 20 state changes) * 100 = 35 % + +

+ +

+ +Since the flap detection logic will give newer state changes a higher rate than older state changes, the actual calculated percent state change will be slightly less than 35% in this example. Let's say that the weighted percent of state change turned out to be 31%... + +

+ + + +

+ +The calculated percent state change for the service (31%) will then be compared against flapping thresholds to see what should happen: + +

+ + + + + +

+ +If neither of those two conditions are met, the flap detection logic won't do anything else with the service, since it is either not currently flapping or it is still flapping. + +

+ + + +

+ +Flap Detection for Services + +

+ + + +

+ +Nagios checks to see if a service is flapping whenever the service is checked (either actively or passively). + +

+ +

+ +The flap detection logic for services works as described in the example above. + +

+ + + + + +

+ +Flap Detection for Hosts + +

+ + + +

+ +Host flap detection works in a similiar manner to service flap detection, with one important difference: Nagios will attempt to check to see if a host is flapping whenever: + +

+ + + + + + + +

+ +Why is this done? With services we know that the minimum amount of time between consecutive flap detection routines is going to be equal to the service check interval. However, you might not be monitoring hosts on a regular basis, so there might not be a host check interval that can be used in the flap detection logic. Also, it makes sense that checking a service should count towards the detection of host flapping. Services are attributes of or things associated with host after all... At any rate, that's the best method I could come up with for determining how often flap detection could be performed on a host, so there you have it. + +

+ + + + + +

+ +Flap Detection Thresholds + +

+ + + +

+ +Nagios uses several variables to determine the percent state change thresholds is uses for flap detection. For both hosts and services, there are global high and low thresholds and host- or service-specific thresholds that you can configure. Nagios will use the global thresholds for flap detection if you to not specify host- or service- specific thresholds. + +

+ + + +

+ +The table below shows the global and host- or service-specific variables that control the various thresholds used in flap detection. + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Object TypeGlobal VariablesObject-Specific Variables
Host + +low_host_flap_threshold
+ +high_host_flap_threshold + +		 + +low_flap_threshold
+ +high_flap_threshold
+ +
Service + +low_service_flap_threshold
+ +high_service_flap_threshold + +		 + +low_flap_threshold
+ +high_flap_threshold
+ +
+ + + +

+ +States Used For Flap Detection + +

+ + + +

+ +Normally Nagios will track the results of the last 21 checks of a host or service, regardless of the check result (host/service state), for use in the flap detection logic. + +

+ + + +

Tip Tip: You can exclude certain host or service states from use in flap detection logic by using the flap_detection_options directive in your host or service definitions. This directive allows you to specify what host or service states (i.e. "UP, "DOWN", "OK, "CRITICAL") you want to use for flap detection. If you don't use this directive, all host or service states are used in flap detection. + +

+ + + +

+ +Flap Handling + +

+ + + +

+ +When a service or host is first detected as flapping, Nagios will: + +

+ + + +
    + +
  1. Log a message indicating that the service or host is flapping. + +
  2. Add a non-persistent comment to the host or service indicating that it is flapping. + +
  3. Send a "flapping start" notification for the host or service to appropriate contacts. + +
  4. Suppress other notifications for the service or host (this is one of the filters in the notification logic). + +
+ + + + + +

+ +When a service or host stops flapping, Nagios will: + +

+ + + +
    + +
  1. Log a message indicating that the service or host has stopped flapping. + +
  2. Delete the comment that was originally added to the service or host when it started flapping. + +
  3. Send a "flapping stop" notification for the host or service to appropriate contacts. + +
  4. Remove the block on notifications for the service or host (notifications will still be bound to the normal notification logic). + +
+ + + + + +

+ +Enabling Flap Detection + +

+ + + +

+ +In order to enable the flap detection features in Nagios, you'll need to: + +

+ + + + + + + +

+ +If you want to disable flap detection on a global basis, set the enable_flap_detection directive to 0. + +

+ + + +

+ +If you would like to disable flap detection for just a few hosts or services, use the flap_detection_enabled directive in the host and/or service definitions to do so. + +

+ + + + + +
+ + + + + + + diff --git a/docs/freshness.html b/docs/freshness.html new file mode 100644 index 0000000..7b903d3 --- /dev/null +++ b/docs/freshness.html @@ -0,0 +1,266 @@ + + + + + + + + +Service and Host Freshness Checks + + + + + + + + + + + + + + + +
+ +Nagios + +

Service and Host Freshness Checks

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Passive Checks, Distributed Monitoring, Redundant and Failover Monitoring + +

+ + + +

+ +Introduction + +

+ + + +

+ +Nagios supports a feature that does "freshness" checking on the results of host and service checks. The purpose of freshness checking is to ensure that host and service checks are being provided passively by external applications on a regular basis. + +

+ + + +

+ +Freshness checking is useful when you want to ensure that passive checks are being received as frequently as you want. This can be very useful in distributed and failover monitoring environments. + +

+ + + +Minty Fresh + + + +

+ +How Does Freshness Checking Work? + +

+ + + +

+ +Nagios periodically checks the freshness of the results for all hosts services that have freshness checking enabled. + +

+ + + + + + + +

+ +Tip Tip: An active check is executed even if active checks are disabled on a program-wide or host- or service-specific basis. + +

+ + + +

+ +For example, if you have a freshness threshold of 60 for one of your services, Nagios will consider that service to be stale if its last check result is older than 60 seconds. + +

+ + + +

+ +Enabling Freshness Checking + +

+ + + +

+ +Here's what you need to do to enable freshness checking... + +

+ + + + + + + + + +

+ +Tip Tip: If you do not specify a host- or service-specific freshness_threshold value (or you set it to zero), Nagios will automatically calculate a threshold automatically, based on a how often you monitor that particular host or service. I would recommended that you explicitly specify a freshness threshold, rather than let Nagios pick one for you. + +

+ + + + + +

+ +Example + +

+ + + +

+ +An example of a service that might require freshness checking might be one that reports the status of your nightly backup jobs. Perhaps you have a external script that submit the results of the backup job to Nagios once the backup is completed. In this case, all of the checks/results for the service are provided by an external application using passive checks. In order to ensure that the status of the backup job gets reported every day, you may want to enable freshness checking for the service. If the external script doesn't submit the results of the backup job, you can have Nagios fake a critical result by doing something like this... + +

+ + + +

+ +Here's what the definition for the service might look like (some required options are omitted)... + +

+ + + +
+
+define service{
+
+	host_name		backup-server
+
+	service_description	ArcServe Backup Job
+
+	active_checks_enabled	0		; active checks are NOT enabled
+
+	passive_checks_enabled	1		; passive checks are enabled (this is how results are reported)
+
+	check_freshness		1
+
+	freshness_threshold	93600		; 26 hour threshold, since backups may not always finish at the same time
+
+	check_command		no-backup-report	; this command is run only if the service results are "stale"
+
+	...other options...
+
+	}
+
+
+ + + +

+ +Notice that active checks are disabled for the service. This is because the results for the service are only made by an external application using passive checks. Freshness checking is enabled and the freshness threshold has been set to 26 hours. This is a bit longer than 24 hours because backup jobs sometimes run late from day to day (depending on how much data there is to backup, how much network traffic is present, etc.). The no-backup-report command is executed only if the results of the service are determined to be stale. The definition of the no-backup-report command might look like this... + +

+ + + +
+
+define command{
+
+	command_name	no-backup-report
+
+	command_line	/usr/local/nagios/libexec/check_dummy 2 "CRITICAL: Results of backup job were not reported!"
+
+	}
+
+
+ + + +

+ +If Nagios detects that the service results are stale, it will run the no-backup-report command as an active service check. This causes the check_dummy plugin to be executed, which returns a critical state to Nagios. The service will then go into to a critical state (if it isn't already there) and someone will probably get notified of the problem. + +

+ + + +
+ + + + + + + diff --git a/docs/funstuff.html b/docs/funstuff.html new file mode 100644 index 0000000..474483f --- /dev/null +++ b/docs/funstuff.html @@ -0,0 +1,58 @@ + + + + + + + + +Neat Hacks and Tricks + + + + + + + + + + + + + + + +
+ +

Neat Hacks and Tricks

+ +
+ +
+ + + +

+ +Other than the standard monitoring stuff, Nagios can be used to do some pretty cool things. Instead of spending your free time playing Quake, why don't you take some time and read about them at http://www.nagios.org/docs/hacks... + +

+ + + +
+ + + + + diff --git a/docs/hostchecks.html b/docs/hostchecks.html new file mode 100644 index 0000000..2ece38a --- /dev/null +++ b/docs/hostchecks.html @@ -0,0 +1,352 @@ + + + + + + + + +Host Checks + + + + + + + + + + + + + + + +
+ +Nagios + +

Host Checks

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Network Reachability, Active Checks, Service Checks, Check Scheduling, Predictive Dependency Checks + +

+ + + +

+ +Introduction + +

+ + + +

+ +The basic workings of host checks are described here... + +

+ + + +

+ +When Are Host Checks Performed? + +

+ + + +

+ +Hosts are checked by the Nagios daemon: + +

+ + + + + + + +

+ +Regularly scheduled host checks are optional. If you set the check_interval option in your host definition to zero (0), Nagios will not perform checks of the hosts on a regular basis. It will, however, still perform on-demand checks of the host as needed for other parts of the monitoring logic. + +

+ + + +

+ +On-demand checks are made when a service associated with the host changes state because Nagios needs to know whether the host has also changed state. Services that change state are often an indicator that the host may have also changed state. For example, if Nagios detects that the HTTP service associated with a host just changed from a CRITICAL to an OK state, it may indicate that the host just recovered from a reboot and is now back up and running. + +

+ + + +

+ +On-demand checks of hosts are also made as part of the host reachability logic. Nagios is designed to detect network outages as quickly as possible, and distinguish between DOWN and UNREACHABLE host states. These are very different states and can help an admin quickly locate the cause of a network outage. + +

+ + + +

+ +On-demand checks are also performed as part of the predictive host dependency check logic. These checks help ensure that the dependency logic is as accurate as possible. + +

+ + + + + +

+ +Cached Host Checks + +

+ + + +

+ +The performance of on-demand host checks can be significantly improved by implementing the use of cached checks, which allow Nagios to forgo executing a host check if it determines a relatively recent check result will do instead. More information on cached checks can be found here. + +

+ + + + + +

+ +Dependencies and Checks + +

+ + + +

+ +You can define host execution dependencies that prevent Nagios from checking the status of a host depending on the state of one or more other hosts. More information on dependencies can be found here. + +

+ + + +

+ +Parallelization of Host Checks + +

+ + + +

+ +Scheduled host checks are run in parallel. When Nagios needs to run a scheduled host check, it will initiate the host check and then return to doing other work (running service checks, etc). The host check runs in a child process that was fork()ed from the main Nagios daemon. When the host check has completed, the child process will inform the main Nagios process (its parent) of the check results. The main Nagios process then handles the check results and takes appropriate action (running event handlers, sending notifications, etc.). + +

+ + + +

+ +On-demand host checks are also run in parallel if needed. As mentioned earlier, Nagios can forgo the actual execution of an on-demand host check if it can use the cached results from a relatively recent host check. + +

+ + + +

+ +When Nagios processes the results of scheduled and on-demand host checks, it may initiate (secondary) checks of other hosts. These checks can be initated for two reasons: predictive dependency checks and to determining the status of the host using the network reachability logic. The secondary checks that are initiated are usually run in parallel. However, there is one big exception that you should be aware of, as it can have negative effect on performance... + +

+ + + +

+ +Note Hosts which have their max_check_attempts value set to 1 can cause serious performance problems. The reason? If Nagios needs to determine their true state using the network reachability logic (to see if they're DOWN or UNREACHABLE), it will have to launch serial checks of all of the host's immediate parents. Just to reiterate, those checks are run serially, rather than in parallel, so it can cause a big performance hit. For this reason, I would recommend that you always use a value greater than 1 for the max_check_attempts directives in your host definitions. + +

+ + + +

+ +Host States + +

+ + + +

+ +Hosts that are checked can be in one of three different states: + +

+ + + + + + + +

+ +Host State Determination + +

+ + + +

+ +Host checks are performed by plugins, which can return a state of OK, WARNING, UNKNOWN, or CRITICAL. How does Nagios translate these plugin return codes into host states of UP, DOWN, or UNREACHABLE? Lets see... + +

+ + + +

+ +The table below shows how plugin return codes correspond with preliminary host states. Some post-processing (which is described later) is done which may then alter the final host state. + +

+ + + + + + + + + + + + + + + +
Plugin ResultPreliminary Host State
OKUP
WARNINGUP or DOWN*
UNKNOWNDOWN
CRITICALDOWN
+ + + +

+ +Note Note: WARNING results usually means the host is UP. However, WARNING results are interpreted to mean the host is DOWN if the use_aggressive_host_checking option is enabled. + +

+ + + +

+ +If the preliminary host state is DOWN, Nagios will attempt to see if the host is really DOWN or if it is UNREACHABLE. The distinction between DOWN and UNREACHABLE host states is important, as it allows admins to determine root cause of network outages faster. The following table shows how Nagios makes a final state determination based on the state of the hosts parent(s). A host's parents are defined in the parents directive in host definition. + +

+ + + + + + + + + + + +
Preliminary Host StateParent Host StateFinal Host State
DOWNAt least one parent is UPDOWN
DOWNAll parents are either DOWN or UNREACHABLEUNREACHABLE
+ + + +

+ +More information on how Nagios distinguishes between DOWN and UNREACHABLE states can be found here. + +

+ + + + + +

+ +Host State Changes + +

+ + + +

+ +As you are probably well aware, hosts don't always stay in one state. Things break, patches get applied, and servers need to be rebooted. When Nagios checks the status of hosts, it will be able to detect when a host changes between UP, DOWN, and UNREACHABLE states and take appropriate action. These state changes result in different state types (HARD or SOFT), which can trigger event handlers to be run and notifications to be sent out. Detecting and dealing with state changes is what Nagios is all about. + +

+ + + +

+ +When hosts change state too frequently they are considered to be "flapping". A good example of a flapping host would be server that keeps spontaneously rebooting as soon as the operating system loads. That's always a fun scenario to have to deal with. Nagios can detect when hosts start flapping, and can suppress notifications until flapping stops and the host's state stabilizes. More information on the flap detection logic can be found here. + +

+ + + + + +
+ + + + + + + diff --git a/docs/images/activechecks.png b/docs/images/activechecks.png new file mode 100644 index 0000000..5346a49 Binary files /dev/null and b/docs/images/activechecks.png differ diff --git a/docs/images/cachedcheckgraphs.png b/docs/images/cachedcheckgraphs.png new file mode 100644 index 0000000..f4f2f21 Binary files /dev/null and b/docs/images/cachedcheckgraphs.png differ diff --git a/docs/images/cachedchecks.png b/docs/images/cachedchecks.png new file mode 100644 index 0000000..7ffc169 Binary files /dev/null and b/docs/images/cachedchecks.png differ diff --git a/docs/images/cachedchecks1.png b/docs/images/cachedchecks1.png new file mode 100644 index 0000000..fcfe951 Binary files /dev/null and b/docs/images/cachedchecks1.png differ diff --git a/docs/images/cgi-avail-a.png b/docs/images/cgi-avail-a.png new file mode 100644 index 0000000..58d7b09 Binary files /dev/null and b/docs/images/cgi-avail-a.png differ diff --git a/docs/images/cgi-avail-b.png b/docs/images/cgi-avail-b.png new file mode 100644 index 0000000..1ae8238 Binary files /dev/null and b/docs/images/cgi-avail-b.png differ diff --git a/docs/images/cgi-cmd.png b/docs/images/cgi-cmd.png new file mode 100644 index 0000000..de22db5 Binary files /dev/null and b/docs/images/cgi-cmd.png differ diff --git a/docs/images/cgi-config.png b/docs/images/cgi-config.png new file mode 100644 index 0000000..0640ac8 Binary files /dev/null and b/docs/images/cgi-config.png differ diff --git a/docs/images/cgi-extinfo-a.png b/docs/images/cgi-extinfo-a.png new file mode 100644 index 0000000..8cd1444 Binary files /dev/null and b/docs/images/cgi-extinfo-a.png differ diff --git a/docs/images/cgi-extinfo-b.png b/docs/images/cgi-extinfo-b.png new file mode 100644 index 0000000..4a923ae Binary files /dev/null and b/docs/images/cgi-extinfo-b.png differ diff --git a/docs/images/cgi-extinfo-c.png b/docs/images/cgi-extinfo-c.png new file mode 100644 index 0000000..82f0bb9 Binary files /dev/null and b/docs/images/cgi-extinfo-c.png differ diff --git a/docs/images/cgi-extinfo-d.png b/docs/images/cgi-extinfo-d.png new file mode 100644 index 0000000..2766e59 Binary files /dev/null and b/docs/images/cgi-extinfo-d.png differ diff --git a/docs/images/cgi-histogram.png b/docs/images/cgi-histogram.png new file mode 100644 index 0000000..3617600 Binary files /dev/null and b/docs/images/cgi-histogram.png differ diff --git a/docs/images/cgi-history.png b/docs/images/cgi-history.png new file mode 100644 index 0000000..9472076 Binary files /dev/null and b/docs/images/cgi-history.png differ diff --git a/docs/images/cgi-notifications.png b/docs/images/cgi-notifications.png new file mode 100644 index 0000000..4a917c7 Binary files /dev/null and b/docs/images/cgi-notifications.png differ diff --git a/docs/images/cgi-outages.png b/docs/images/cgi-outages.png new file mode 100644 index 0000000..3c715bd Binary files /dev/null and b/docs/images/cgi-outages.png differ diff --git a/docs/images/cgi-showlog.png b/docs/images/cgi-showlog.png new file mode 100644 index 0000000..3ada195 Binary files /dev/null and b/docs/images/cgi-showlog.png differ diff --git a/docs/images/cgi-status-a.png b/docs/images/cgi-status-a.png new file mode 100644 index 0000000..f3bdb69 Binary files /dev/null and b/docs/images/cgi-status-a.png differ diff --git a/docs/images/cgi-status-b.png b/docs/images/cgi-status-b.png new file mode 100644 index 0000000..7c43a36 Binary files /dev/null and b/docs/images/cgi-status-b.png differ diff --git a/docs/images/cgi-status-c.png b/docs/images/cgi-status-c.png new file mode 100644 index 0000000..2546804 Binary files /dev/null and b/docs/images/cgi-status-c.png differ diff --git a/docs/images/cgi-status-d.png b/docs/images/cgi-status-d.png new file mode 100644 index 0000000..9a87671 Binary files /dev/null and b/docs/images/cgi-status-d.png differ diff --git a/docs/images/cgi-statusmap.png b/docs/images/cgi-statusmap.png new file mode 100644 index 0000000..d4654ab Binary files /dev/null and b/docs/images/cgi-statusmap.png differ diff --git a/docs/images/cgi-statuswml.png b/docs/images/cgi-statuswml.png new file mode 100644 index 0000000..9214e72 Binary files /dev/null and b/docs/images/cgi-statuswml.png differ diff --git a/docs/images/cgi-statuswrl.png b/docs/images/cgi-statuswrl.png new file mode 100644 index 0000000..60edefd Binary files /dev/null and b/docs/images/cgi-statuswrl.png differ diff --git a/docs/images/cgi-summary.png b/docs/images/cgi-summary.png new file mode 100644 index 0000000..d42d8ee Binary files /dev/null and b/docs/images/cgi-summary.png differ diff --git a/docs/images/cgi-tac.png b/docs/images/cgi-tac.png new file mode 100644 index 0000000..448514d Binary files /dev/null and b/docs/images/cgi-tac.png differ diff --git a/docs/images/cgi-trends.png b/docs/images/cgi-trends.png new file mode 100644 index 0000000..993bc19 Binary files /dev/null and b/docs/images/cgi-trends.png differ diff --git a/docs/images/checkmark.png b/docs/images/checkmark.png new file mode 100644 index 0000000..2529f1d Binary files /dev/null and b/docs/images/checkmark.png differ diff --git a/docs/images/checktiming.png b/docs/images/checktiming.png new file mode 100644 index 0000000..d46ad27 Binary files /dev/null and b/docs/images/checktiming.png differ diff --git a/docs/images/configoverview.png b/docs/images/configoverview.png new file mode 100644 index 0000000..c571da1 Binary files /dev/null and b/docs/images/configoverview.png differ diff --git a/docs/images/distributed.png b/docs/images/distributed.png new file mode 100644 index 0000000..8768e72 Binary files /dev/null and b/docs/images/distributed.png differ diff --git a/docs/images/downtime.png b/docs/images/downtime.png new file mode 100644 index 0000000..a3b4ca4 Binary files /dev/null and b/docs/images/downtime.png differ diff --git a/docs/images/epn.png b/docs/images/epn.png new file mode 100644 index 0000000..7c96ae9 Binary files /dev/null and b/docs/images/epn.png differ diff --git a/docs/images/eventhandlers.png b/docs/images/eventhandlers.png new file mode 100644 index 0000000..b5d1315 Binary files /dev/null and b/docs/images/eventhandlers.png differ diff --git a/docs/images/externalcommands.png b/docs/images/externalcommands.png new file mode 100644 index 0000000..76f2ed3 Binary files /dev/null and b/docs/images/externalcommands.png differ diff --git a/docs/images/fast-startup.png b/docs/images/fast-startup.png new file mode 100644 index 0000000..156cfdb Binary files /dev/null and b/docs/images/fast-startup.png differ diff --git a/docs/images/fast-startup1.png b/docs/images/fast-startup1.png new file mode 100644 index 0000000..4a4308b Binary files /dev/null and b/docs/images/fast-startup1.png differ diff --git a/docs/images/fast-startup2.png b/docs/images/fast-startup2.png new file mode 100644 index 0000000..143b677 Binary files /dev/null and b/docs/images/fast-startup2.png differ diff --git a/docs/images/freshness.png b/docs/images/freshness.png new file mode 100644 index 0000000..1757a02 Binary files /dev/null and b/docs/images/freshness.png differ diff --git a/docs/images/host-dependencies.png b/docs/images/host-dependencies.png new file mode 100644 index 0000000..0c77bdb Binary files /dev/null and b/docs/images/host-dependencies.png differ diff --git a/docs/images/important.gif b/docs/images/important.gif new file mode 100644 index 0000000..5b5bf3e Binary files /dev/null and b/docs/images/important.gif differ diff --git a/docs/images/integrationoverview.png b/docs/images/integrationoverview.png new file mode 100644 index 0000000..01d0c3e Binary files /dev/null and b/docs/images/integrationoverview.png differ diff --git a/docs/images/interleaved1.png b/docs/images/interleaved1.png new file mode 100644 index 0000000..012380d Binary files /dev/null and b/docs/images/interleaved1.png differ diff --git a/docs/images/interleaved2.png b/docs/images/interleaved2.png new file mode 100644 index 0000000..4e837dd Binary files /dev/null and b/docs/images/interleaved2.png differ diff --git a/docs/images/interleaved3.png b/docs/images/interleaved3.png new file mode 100644 index 0000000..e250613 Binary files /dev/null and b/docs/images/interleaved3.png differ diff --git a/docs/images/logofullsize.png b/docs/images/logofullsize.png new file mode 100644 index 0000000..85d3ba8 Binary files /dev/null and b/docs/images/logofullsize.png differ diff --git a/docs/images/monitoring-printers.png b/docs/images/monitoring-printers.png new file mode 100644 index 0000000..be781a5 Binary files /dev/null and b/docs/images/monitoring-printers.png differ diff --git a/docs/images/monitoring-routers.png b/docs/images/monitoring-routers.png new file mode 100644 index 0000000..d346283 Binary files /dev/null and b/docs/images/monitoring-routers.png differ diff --git a/docs/images/monitoring-windows.png b/docs/images/monitoring-windows.png new file mode 100644 index 0000000..a52a588 Binary files /dev/null and b/docs/images/monitoring-windows.png differ diff --git a/docs/images/mrtg-activehostchecks.png b/docs/images/mrtg-activehostchecks.png new file mode 100644 index 0000000..1e0b593 Binary files /dev/null and b/docs/images/mrtg-activehostchecks.png differ diff --git a/docs/images/mrtg-activelychecked.png b/docs/images/mrtg-activelychecked.png new file mode 100644 index 0000000..4719eca Binary files /dev/null and b/docs/images/mrtg-activelychecked.png differ diff --git a/docs/images/mrtg-activeservicechecks.png b/docs/images/mrtg-activeservicechecks.png new file mode 100644 index 0000000..108d82b Binary files /dev/null and b/docs/images/mrtg-activeservicechecks.png differ diff --git a/docs/images/mrtg-cachedchecks.png b/docs/images/mrtg-cachedchecks.png new file mode 100644 index 0000000..7e46f9c Binary files /dev/null and b/docs/images/mrtg-cachedchecks.png differ diff --git a/docs/images/mrtg-commandbuffers.png b/docs/images/mrtg-commandbuffers.png new file mode 100644 index 0000000..79aa14b Binary files /dev/null and b/docs/images/mrtg-commandbuffers.png differ diff --git a/docs/images/mrtg-externalcommands.png b/docs/images/mrtg-externalcommands.png new file mode 100644 index 0000000..187d6de Binary files /dev/null and b/docs/images/mrtg-externalcommands.png differ diff --git a/docs/images/mrtg-hostperfstats.png b/docs/images/mrtg-hostperfstats.png new file mode 100644 index 0000000..e063750 Binary files /dev/null and b/docs/images/mrtg-hostperfstats.png differ diff --git a/docs/images/mrtg-hoststatechange.png b/docs/images/mrtg-hoststatechange.png new file mode 100644 index 0000000..238a3d5 Binary files /dev/null and b/docs/images/mrtg-hoststatechange.png differ diff --git a/docs/images/mrtg-passivechecks.png b/docs/images/mrtg-passivechecks.png new file mode 100644 index 0000000..a9463ea Binary files /dev/null and b/docs/images/mrtg-passivechecks.png differ diff --git a/docs/images/mrtg-passivelychecked.png b/docs/images/mrtg-passivelychecked.png new file mode 100644 index 0000000..495d3bb Binary files /dev/null and b/docs/images/mrtg-passivelychecked.png differ diff --git a/docs/images/mrtg-serviceperfstats.png b/docs/images/mrtg-serviceperfstats.png new file mode 100644 index 0000000..0511acc Binary files /dev/null and b/docs/images/mrtg-serviceperfstats.png differ diff --git a/docs/images/mrtg-servicestatechange.png b/docs/images/mrtg-servicestatechange.png new file mode 100644 index 0000000..74537a7 Binary files /dev/null and b/docs/images/mrtg-servicestatechange.png differ diff --git a/docs/images/multiple-templates1.png b/docs/images/multiple-templates1.png new file mode 100644 index 0000000..72b019f Binary files /dev/null and b/docs/images/multiple-templates1.png differ diff --git a/docs/images/multiple-templates2.png b/docs/images/multiple-templates2.png new file mode 100644 index 0000000..03373bc Binary files /dev/null and b/docs/images/multiple-templates2.png differ diff --git a/docs/images/nagios.jpg b/docs/images/nagios.jpg new file mode 100644 index 0000000..3e8fc71 Binary files /dev/null and b/docs/images/nagios.jpg differ diff --git a/docs/images/nagiosexchange.png b/docs/images/nagiosexchange.png new file mode 100644 index 0000000..594732e Binary files /dev/null and b/docs/images/nagiosexchange.png differ diff --git a/docs/images/nagiossupport.png b/docs/images/nagiossupport.png new file mode 100644 index 0000000..92cb1a7 Binary files /dev/null and b/docs/images/nagiossupport.png differ diff --git a/docs/images/ndoutils.png b/docs/images/ndoutils.png new file mode 100644 index 0000000..f0c32cc Binary files /dev/null and b/docs/images/ndoutils.png differ diff --git a/docs/images/network-outage1.png b/docs/images/network-outage1.png new file mode 100644 index 0000000..b3f5dde Binary files /dev/null and b/docs/images/network-outage1.png differ diff --git a/docs/images/network-outage2.png b/docs/images/network-outage2.png new file mode 100644 index 0000000..2ded254 Binary files /dev/null and b/docs/images/network-outage2.png differ diff --git a/docs/images/noninterleaved1.png b/docs/images/noninterleaved1.png new file mode 100644 index 0000000..fe5e511 Binary files /dev/null and b/docs/images/noninterleaved1.png differ diff --git a/docs/images/noninterleaved2.png b/docs/images/noninterleaved2.png new file mode 100644 index 0000000..d95a7ca Binary files /dev/null and b/docs/images/noninterleaved2.png differ diff --git a/docs/images/note.gif b/docs/images/note.gif new file mode 100644 index 0000000..8c7f2d2 Binary files /dev/null and b/docs/images/note.gif differ diff --git a/docs/images/nrpe.png b/docs/images/nrpe.png new file mode 100644 index 0000000..4c7c4e4 Binary files /dev/null and b/docs/images/nrpe.png differ diff --git a/docs/images/nsca.png b/docs/images/nsca.png new file mode 100644 index 0000000..8bb8b96 Binary files /dev/null and b/docs/images/nsca.png differ diff --git a/docs/images/nscpp.png b/docs/images/nscpp.png new file mode 100644 index 0000000..d5836ee Binary files /dev/null and b/docs/images/nscpp.png differ diff --git a/docs/images/objects-commands.png b/docs/images/objects-commands.png new file mode 100644 index 0000000..725c16b Binary files /dev/null and b/docs/images/objects-commands.png differ diff --git a/docs/images/objects-contacts.png b/docs/images/objects-contacts.png new file mode 100644 index 0000000..b700cd9 Binary files /dev/null and b/docs/images/objects-contacts.png differ diff --git a/docs/images/objects-hosts.png b/docs/images/objects-hosts.png new file mode 100644 index 0000000..35f4d31 Binary files /dev/null and b/docs/images/objects-hosts.png differ diff --git a/docs/images/objects-services.png b/docs/images/objects-services.png new file mode 100644 index 0000000..9b0e3cb Binary files /dev/null and b/docs/images/objects-services.png differ diff --git a/docs/images/objects-timeperiods.png b/docs/images/objects-timeperiods.png new file mode 100644 index 0000000..17a514a Binary files /dev/null and b/docs/images/objects-timeperiods.png differ diff --git a/docs/images/passivechecks.png b/docs/images/passivechecks.png new file mode 100644 index 0000000..1078e46 Binary files /dev/null and b/docs/images/passivechecks.png differ diff --git a/docs/images/passivehosttranslation.png b/docs/images/passivehosttranslation.png new file mode 100644 index 0000000..09f1eb7 Binary files /dev/null and b/docs/images/passivehosttranslation.png differ diff --git a/docs/images/plugins.png b/docs/images/plugins.png new file mode 100644 index 0000000..024e9ff Binary files /dev/null and b/docs/images/plugins.png differ diff --git a/docs/images/predictive-dependency-checks.png b/docs/images/predictive-dependency-checks.png new file mode 100644 index 0000000..35faac2 Binary files /dev/null and b/docs/images/predictive-dependency-checks.png differ diff --git a/docs/images/printer.png b/docs/images/printer.png new file mode 100644 index 0000000..0d63c62 Binary files /dev/null and b/docs/images/printer.png differ diff --git a/docs/images/reachability1.png b/docs/images/reachability1.png new file mode 100644 index 0000000..15be8f3 Binary files /dev/null and b/docs/images/reachability1.png differ diff --git a/docs/images/reachability2.png b/docs/images/reachability2.png new file mode 100644 index 0000000..d8f9e64 Binary files /dev/null and b/docs/images/reachability2.png differ diff --git a/docs/images/reachability3.png b/docs/images/reachability3.png new file mode 100644 index 0000000..3acae3f Binary files /dev/null and b/docs/images/reachability3.png differ diff --git a/docs/images/reachability4.png b/docs/images/reachability4.png new file mode 100644 index 0000000..817b1e7 Binary files /dev/null and b/docs/images/reachability4.png differ diff --git a/docs/images/redudancy.png b/docs/images/redudancy.png new file mode 100644 index 0000000..61dd9b0 Binary files /dev/null and b/docs/images/redudancy.png differ diff --git a/docs/images/redundancy.png b/docs/images/redundancy.png new file mode 100644 index 0000000..e04bf71 Binary files /dev/null and b/docs/images/redundancy.png differ diff --git a/docs/images/security.png b/docs/images/security.png new file mode 100644 index 0000000..095e0d5 Binary files /dev/null and b/docs/images/security.png differ diff --git a/docs/images/security1.png b/docs/images/security1.png new file mode 100644 index 0000000..f1491dc Binary files /dev/null and b/docs/images/security1.png differ diff --git a/docs/images/security2.png b/docs/images/security2.png new file mode 100644 index 0000000..ba2b6d2 Binary files /dev/null and b/docs/images/security2.png differ diff --git a/docs/images/security3.png b/docs/images/security3.png new file mode 100644 index 0000000..7ca9c84 Binary files /dev/null and b/docs/images/security3.png differ diff --git a/docs/images/seealso.gif b/docs/images/seealso.gif new file mode 100644 index 0000000..764c09f Binary files /dev/null and b/docs/images/seealso.gif differ diff --git a/docs/images/service-dependencies.png b/docs/images/service-dependencies.png new file mode 100644 index 0000000..f8681c1 Binary files /dev/null and b/docs/images/service-dependencies.png differ diff --git a/docs/images/statetransitions.png b/docs/images/statetransitions.png new file mode 100644 index 0000000..89d4892 Binary files /dev/null and b/docs/images/statetransitions.png differ diff --git a/docs/images/statetransitions2.png b/docs/images/statetransitions2.png new file mode 100644 index 0000000..f8b30c0 Binary files /dev/null and b/docs/images/statetransitions2.png differ diff --git a/docs/images/stoprestart.png b/docs/images/stoprestart.png new file mode 100644 index 0000000..1a32652 Binary files /dev/null and b/docs/images/stoprestart.png differ diff --git a/docs/images/switch.png b/docs/images/switch.png new file mode 100644 index 0000000..24608a8 Binary files /dev/null and b/docs/images/switch.png differ diff --git a/docs/images/tcpwrappers.png b/docs/images/tcpwrappers.png new file mode 100644 index 0000000..218d1dc Binary files /dev/null and b/docs/images/tcpwrappers.png differ diff --git a/docs/images/tip.gif b/docs/images/tip.gif new file mode 100644 index 0000000..fe45707 Binary files /dev/null and b/docs/images/tip.gif differ diff --git a/docs/images/tuning.png b/docs/images/tuning.png new file mode 100644 index 0000000..dcf3333 Binary files /dev/null and b/docs/images/tuning.png differ diff --git a/docs/images/upto.gif b/docs/images/upto.gif new file mode 100644 index 0000000..31c8800 Binary files /dev/null and b/docs/images/upto.gif differ diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..6ea690e --- /dev/null +++ b/docs/index.html @@ -0,0 +1,130 @@ + + + + + + + + + + +Nagios Core Documentation + + + + + + + + + + + + + +
+ +Nagios + +
+ + + +

+ +Nagios Core Version 3.x Documentation + +

+ + + +

+ +http://www.nagios.org + +

+ + + +
+ +Copyright © 2009 Nagios Core Development Team and Community Contributors.
+Copyright © 1999-2009 Ethan Galstad.

+ +Portions copyright by Nagios Community members. See the THANKS file for more information. + +
+ +
+ +Last Updated: 06-16-2009 + +
+ + + + + + + +

+ + + +
+ +[ Table of Contents ] + +
+ + + +



+ + + +

+ +Nagios, Nagios Core, NRPE, NSCA, and the Nagios logo are trademarks, servicemarks, registered servicemarks or registered trademarks of Nagios Enterprises. All other trademarks, servicemarks, registered trademarks, and registered servicemarks mentioned herein may be the property of their respective owner(s). The information contained herein is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE WARRANTY OF DESIGN, MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE. + +

+ + + + + + \ No newline at end of file diff --git a/docs/int-snmptrap.html b/docs/int-snmptrap.html new file mode 100644 index 0000000..73b08e8 --- /dev/null +++ b/docs/int-snmptrap.html @@ -0,0 +1,98 @@ + + + + + + + + +SNMP Trap Integration + + + + + + + + + + + + + + + +
+ +Nagios + +

SNMP Trap Integration

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Integration Overview, External Commands, Passive Checks + +

+ + + +

+ +Introduction + +

+ + + +

+ +Note Note: Nagios is not designed to be a replacement for a full-blown SNMP management application like HP OpenView or OpenNMS. However, you can set things up so that SNMP traps received by a host on your network can generate alerts in Nagios. + +

+ + + +

+ +As if designed to make the Gods of Hypocrisy die of laughter, SNMP is anything but simple. Translating SNMP traps and getting them into Nagios (as passive check results) can be a bit tedious. To make this task easier, I suggest you check out Alex Burger's SNMP Trap Translator project located at http://www.snmptt.org. When combined with Net-SNMP, SNMPTT provides an enhanced trap handling system that can be integrated with Nagios. + +

+ + + +

+ +Yep, that's all. + +

+ + + +
+ + + + + + + diff --git a/docs/int-tcpwrappers.html b/docs/int-tcpwrappers.html new file mode 100644 index 0000000..9bb17e2 --- /dev/null +++ b/docs/int-tcpwrappers.html @@ -0,0 +1,298 @@ + + + + + + + + +TCP Wrapper Integration + + + + + + + + + + + + + + + +
+ +Nagios + +

TCP Wrapper Integration

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Integration Overview, External Commands, Passive Checks + +

+ + + +

+ +Introduction + +

+ + + +TCP Wrappers + + + +

+ +This document explains how to easily generate alerts in Nagios for connection attempts that are rejected by TCP wrappers. For example, if an unauthorized host attempts to connect to your SSH server, you can receive an alert in Nagios that contains the name of the host that was rejected. If you implement this on your Linux/Unix boxes, you'll be surprised how many port scans you can detect across your network. + +

+ + + +

+ +These directions assume: + +

+ + + +
    + +
  1. You are already familiar with passive checks and how they work.
    2. + +
  2. You are already familiar with volatile services and how they work.
    3. + +
  3. The host which you are generating alerts for (i.e. the host you are using TCP wrappers on) is a remote host (called firestorm in this example). If you want to generate alerts on the same host that Nagios is running you will need to make a few modifications to the examples I provide.
    4. + +
  4. You have installed the NSCA daemon on your monitoring server and the NSCA client (send_nsca) on the remote machine that you are generating TCP wrapper alerts from.
    5. + +
+ + + +
+ + + +

+ +Defining A Service + +

+ + + +

+ +If you haven't done so already, create a host definition for the remote host (firestorm). + +

+ + + +

+ +Next, define a service in one of your object configuration files for the TCP wrapper alerts on host firestorm. The service definition might look something like this: + +

+ + + +
+
+define service{
+
+	host_name                       firestorm
+
+	service_description             TCP Wrappers
+
+	is_volatile                     1
+
+	active_checks_enabled		0
+
+	passive_checks_enabled		1
+
+	max_check_attempts              1
+
+	check_command                   check_none
+
+	...
+
+	}
+
+
+ + + +

+ +There are some important things to note about the above service definition: + +

+ + + +
    + +
  1. The volatile option enabled. We want this option enabled because we want a notification to be generated for every alert that comes in.
    2. + +
  2. Active checks of the service as disabled, while passive checks are enabled. This means that the service will never be actively checked by Nagios - all alert information will have to be received passively from an external source.
    3. + +
  3. The max_check_attempts value is set to 1. This guarantees you will get a notification when the first alert is generated.
    4. + +
+ + + +

+ +Configuring TCP Wrappers + +

+ + + +

+ +Now you're going to have to modify the /etc/hosts.deny file on firestorm. In order to have the TCP wrappers send an alert to the monitoring host whenever a connection attempt is denied, you'll have to add a line similiar to the following: + +

+ + + +
+
+ALL: ALL: RFC931: twist (/usr/local/nagios/libexec/eventhandlers/handle_tcp_wrapper %h %d) &
+
+
+ + + +

+ +This line assumes that there is a script called handle_tcp_wrapper in the /usr/local/nagios/libexec/eventhandlers/ directory on firestorm. We'll write that script next. + +

+ + + +

+ +Writing The Script + +

+ + + +

+ +The last thing you need to do is write the handle_tcp_wrapper script on firestorm that will send the alert back to the Nagios server. It might look something like this: + +

+ + + +
+
+#!/bin/sh
+
+
+
+/usr/local/nagios/libexec/eventhandlers/submit_check_result firestorm "TCP Wrappers" 2 "Denied $2-$1" > /dev/null 2> /dev/null
+
+
+ + + +

+ +Notice that the handle_tcp_wrapper script calls the submit_check_result script to actually send the alert back to the monitoring host. Assuming your Nagios server is called monitor, the submit check_result script might look like this: + +

+ + + +
+
+#!/bin/sh
+
+# Arguments
+
+#	$1 = name of host in service definition
+
+#	$2 = name/description of service in service definition
+
+#	$3 = return code
+
+#	$4 = output
+
+
+
+/bin/echo -e "$1\t$2\t$3\t$4\n" | /usr/local/nagios/bin/send_nsca monitor -c /usr/local/nagios/etc/send_nsca.cfg
+
+
+ + + +

+ +Finishing Up + +

+ + + +

+ +You've now configured everything you need to, so all you have to do is restart the inetd process on firestorm and restart Nagios on your monitoring server. That's it! When the TCP wrappers on firestorm deny a connection attempt, you should be getting alerts in Nagios. The plugin output for the alert will look something like the following: + +

+ + + +
+
+Denied sshd2-sdn-ar-002mnminnP321.dialsprint.net 
+
+
+ + + + + +
+ + + + + + + diff --git a/docs/integration.html b/docs/integration.html new file mode 100644 index 0000000..9f0d132 --- /dev/null +++ b/docs/integration.html @@ -0,0 +1,190 @@ + + + + + + + + +Integration Overview + + + + + + + + + + + + + + + +
+ +Nagios + +

Integration Overview

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: External Commands, Passive Checks, Event Handlers, Plugins + +

+ + + +

+ +Introduction + +

+ + + +

+ +One of the reasons that Nagios is such a popular monitoring application is the fact that it can be easily integrated in your existing infrastructure. There are several methods of integrating Nagios with the management software you're already using and you can monitor almost any type of new or custom hardware, service, or application that you might have. + +

+ + + +

+ +Integration Points + +

+ + + +Integration Overview + + + +

+ +To monitor new hardware, services, or applications, check out the docs on: + +

+ + + + + + + +

+ +To get data into Nagios from external applications, check out the docs on: + +

+ + + + + + + +

+ +To send status, performance, or notification information from Nagios to external applications, check out the docs on: + +

+ + + + + + + +
+ + + + + +

+ +Integration Examples + +

+ + + +

+ +I've documented some examples on how to integrate Nagios with external applications: + +

+ + + + + + + + + +
+ + + + + + + diff --git a/docs/knownissues.html b/docs/knownissues.html new file mode 100644 index 0000000..e415a90 --- /dev/null +++ b/docs/knownissues.html @@ -0,0 +1,95 @@ + + + + + + + + +Known Issues + + + + + + + + + + + + + + + +
+ +

Known Issues

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: What's New +

+ + + + + +

+ +Known Issues + +

+ + + +
    + + + +
  1. Timeperiods:
    + +
      + +
    • Exclusions and Host/Service Checks - There is a bug in the service/host check scheduling logic that rears its head when you use timeperiod definitions that use the exclude directive. The problem occurs when Nagios Core tries to re-schedule the next check. In this case, the scheduling logic may incorrectly schedule the next check further out in the future than it should. In essence, it skips over the (missing) logic where it could determine an earlier possible time using the exception times. Imperfect Solution: Don't use timeperiod definitions that exclude other timeperods for your host/service check periods. A fix is being worked on, and will hopefully make it into a 3.4.x release.
      • + +
    + +
    2. + +
    + + + +
+ + + +
+ + + + + + + diff --git a/docs/largeinstalltweaks.html b/docs/largeinstalltweaks.html new file mode 100644 index 0000000..2aad1e2 --- /dev/null +++ b/docs/largeinstalltweaks.html @@ -0,0 +1,120 @@ + + + + + + + + +Large Installation Tweaks + + + + + + + + + + + + + + + +
+ +Nagios + +

Large Installation Tweaks

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Performance Tuning, Fast Startup Options + +

+ + + +

+ +Introduction + +

+ + + +

+ +Users with large Nagios installations may benefit from the use_large_installation_tweaks configuration option. Enabling this option allows the Nagios daemon to take certain shortcuts which result in lower system load and better performance. + +

+ + + +

+ +Effects + +

+ + + +

+ +When you enable the use_large_installation_tweaks option in your main Nagios config file, several changes are made to the way the Nagios daemon operates: + +

+ + + +
    + + + +
  1. No Summary Macros In Environment Variables - The summary macros will not be available to you as environment variables. Calculating the values of these macros can be quite time-intensive in large configurations, so they are not available as environment variables when use this option. Summary macros will still be available as regular macros if you pass them to to your scripts as arguments.

    2. + + + +
  2. Different Memory Cleanup - Normally Nagios will free all allocated memory in child processes before they exit. This is probably best practice, but is likely unnecessary in most installations, as most OSes will take care of freeing allocated memory when processes exit. The OS tends to free allocated memory faster than can be done within Nagios itself, so Nagios won't attempt to free memory in child processes if you enable this option.

    3. + + + +
  3. Checks fork() Less - Normally Nagios will fork() twice when it executes host and service checks. This is done to (1) ensure a high level of resistance against plugins that go awry and segfault and (2) make the OS deal with cleaning up the grandchild process once it exits. The extra fork() is not really necessary, so it is skipped when you enable this option. As a result, Nagios will itself clean up child processes that exit (instead of leaving that job to the OS). This feature should result in significant load savings on your Nagios installation.

    4. + + + +
+ + + + + +
+ + + + + + + diff --git a/docs/macrolist.html b/docs/macrolist.html new file mode 100644 index 0000000..25c31bf --- /dev/null +++ b/docs/macrolist.html @@ -0,0 +1,3576 @@ + + + + + + + + +Standard Macros in Nagios + + + + + + + + + + + + + + + +
+ +Nagios + +

Standard Macros in Nagios

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: How Macros Work + +

+ + + +

+ +Standard macros that are available in Nagios are listed here. On-demand macros and macros for custom variables are described here. + +

+ + + +

+ +Macro Validity + +

+ + + +

+ +Although macros can be used in all commands you define, not all macros may be "valid" in a particular type of command. For example, some macros may only be valid during service notification commands, whereas other may only be valid during host check commands. There are ten types of commands that Nagios recognizes and treats differently. They are as follows: + +

+ +
    + +
  1. Service checks + +
  2. Service notifications + +
  3. Host checks + +
  4. Host notifications + +
  5. Service event handlers and/or a global service event handler + +
  6. Host event handlers and/or a global host event handler + +
  7. OCSP command + +
  8. OCHP command + +
  9. Service performance data commands + +
  10. Host performance data commands + +
+ + + +

+ +The tables below list all macros currently available in Nagios, along with a brief description of each and the types of commands in which they are valid. If a macro is used in a command in which it is invalid, it is replaced with an empty string. It should be noted that macros consist of all uppercase characters and are enclosed in $ characters. + +

+ + + +

+ +Macro Availability Chart + +

+ + + +Legend:
+ + + + + + + +
NoThe macro is not available
YesThe macro is available
+ + + +
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Macro NameService ChecksService NotificationsHost ChecksHost NotificationsService Event Handlers and OCSPHost Event Handlers and OCHPService Perf DataHost Perf Data
Host Macros: 3
$HOSTNAME$YesYesYesYesYesYesYesYes
$HOSTDISPLAYNAME$YesYesYesYesYesYesYesYes
$HOSTALIAS$YesYesYesYesYesYesYesYes
$HOSTADDRESS$YesYesYesYesYesYesYesYes
$HOSTSTATE$YesYesYes 1YesYesYesYesYes
$HOSTSTATEID$YesYesYes 1YesYesYesYesYes
$LASTHOSTSTATE$YesYesYesYesYesYesYesYes
$LASTHOSTSTATEID$YesYesYesYesYesYesYesYes
$HOSTSTATETYPE$YesYesYes 1YesYesYesYesYes
$HOSTATTEMPT$YesYesYesYesYesYesYesYes
$MAXHOSTATTEMPTS$YesYesYesYesYesYesYesYes
$HOSTEVENTID$YesYesYesYesYesYesYesYes
$LASTHOSTEVENTID$YesYesYesYesYesYesYesYes
$HOSTPROBLEMID$YesYesYesYesYesYesYesYes
$LASTHOSTPROBLEMID$YesYesYesYesYesYesYesYes
$HOSTLATENCY$YesYesYesYesYesYesYesYes
$HOSTEXECUTIONTIME$YesYesYes 1YesYesYesYesYes
$HOSTDURATION$YesYesYesYesYesYesYesYes
$HOSTDURATIONSEC$YesYesYesYesYesYesYesYes
$HOSTDOWNTIME$YesYesYesYesYesYesYesYes
$HOSTPERCENTCHANGE$YesYesYesYesYesYesYesYes
$HOSTGROUPNAME$YesYesYesYesYesYesYesYes
$HOSTGROUPNAMES$YesYesYesYesYesYesYesYes
$LASTHOSTCHECK$YesYesYesYesYesYesYesYes
$LASTHOSTSTATECHANGE$YesYesYesYesYesYesYesYes
$LASTHOSTUP$YesYesYesYesYesYesYesYes
$LASTHOSTDOWN$YesYesYesYesYesYesYesYes
$LASTHOSTUNREACHABLE$YesYesYesYesYesYesYesYes
$HOSTOUTPUT$YesYesYes 1YesYesYesYesYes
$LONGHOSTOUTPUT$YesYesYes 1YesYesYesYesYes
$HOSTPERFDATA$YesYesYes 1YesYesYesYesYes
$HOSTCHECKCOMMAND$YesYesYesYesYesYesYesYes
$HOSTACKAUTHOR$ 8NoNoNoYesNoNoNoNo
$HOSTACKAUTHORNAME$ 8NoNoNoYesNoNoNoNo
$HOSTACKAUTHORALIAS$ 8NoNoNoYesNoNoNoNo
$HOSTACKCOMMENT$ 8NoNoNoYesNoNoNoNo
$HOSTACTIONURL$YesYesYesYesYesYesYesYes
$HOSTNOTESURL$YesYesYesYesYesYesYesYes
$HOSTNOTES$YesYesYesYesYesYesYesYes
$TOTALHOSTSERVICES$YesYesYesYesYesYesYesYes
$TOTALHOSTSERVICESOK$YesYesYesYesYesYesYesYes
$TOTALHOSTSERVICESWARNING$YesYesYesYesYesYesYesYes
$TOTALHOSTSERVICESUNKNOWN$YesYesYesYesYesYesYesYes
$TOTALHOSTSERVICESCRITICAL$YesYesYesYesYesYesYesYes

Macro NameService ChecksService NotificationsHost ChecksHost NotificationsService Event Handlers and OCSPHost Event Handlers and OCHPService Perf DataHost Perf Data
Host Group Macros:
$HOSTGROUPALIAS$ 5YesYesYesYesYesYesYesYes
$HOSTGROUPMEMBERS$ 5YesYesYesYesYesYesYesYes
$HOSTGROUPNOTES$ 5YesYesYesYesYesYesYesYes
$HOSTGROUPNOTESURL$ 5YesYesYesYesYesYesYesYes
$HOSTGROUPACTIONURL$ 5YesYesYesYesYesYesYesYes

Macro NameService ChecksService NotificationsHost ChecksHost NotificationsService Event Handlers and OCSPHost Event Handlers and OCHPService Perf DataHost Perf Data
Service Macros:
$SERVICEDESC$YesYesNoNoYesNoYesNo
$SERVICEDISPLAYNAME$YesYesNoNoYesNoYesNo
$SERVICESTATE$Yes 2YesNoNoYesNoYesNo
$SERVICESTATEID$Yes 2YesNoNoYesNoYesNo
$LASTSERVICESTATE$YesYesNoNoYesNoYesNo
$LASTSERVICESTATEID$YesYesNoNoYesNoYesNo
$SERVICESTATETYPE$YesYesNoNoYesNoYesNo
$SERVICEATTEMPT$YesYesNoNoYesNoYesNo
$MAXSERVICEATTEMPTS$YesYesNoNoYesNoYesNo
$SERVICEISVOLATILE$YesYesNoNoYesNoYesNo
$SERVICEEVENTID$Yes YesNoNoYesNoYesNo
$LASTSERVICEEVENTID$YesYesNoNoYesNoYesNo
$SERVICEPROBLEMID$Yes YesNoNoYesNoYesNo
$LASTSERVICEPROBLEMID$YesYesNoNoYesNoYesNo
$SERVICELATENCY$YesYesNoNoYesNoYesNo
$SERVICEEXECUTIONTIME$Yes 2YesNoNoYesNoYesNo
$SERVICEDURATION$YesYesNoNoYesNoYesNo
$SERVICEDURATIONSEC$YesYesNoNoYesNoYesNo
$SERVICEDOWNTIME$YesYesNoNoYesNoYesNo
$SERVICEPERCENTCHANGE$YesYesNoNoYesNoYesNo
$SERVICEGROUPNAME$YesYesNoNoYesNoYesNo
$SERVICEGROUPNAMES$YesYesNoNoYesNoYesNo
$LASTSERVICECHECK$YesYesNoNoYesNoYesNo
$LASTSERVICESTATECHANGE$YesYesNoNoYesNoYesNo
$LASTSERVICEOK$YesYesNoNoYesNoYesNo
$LASTSERVICEWARNING$YesYesNoNoYesNoYesNo
$LASTSERVICEUNKNOWN$YesYesNoNoYesNoYesNo
$LASTSERVICECRITICAL$YesYesNoNoYesNoYesNo
$SERVICEOUTPUT$Yes 2YesNoNoYesNoYesNo
$LONGSERVICEOUTPUT$Yes 2YesNoNoYesNoYesNo
$SERVICEPERFDATA$Yes 2YesNoNoYesNoYesNo
$SERVICECHECKCOMMAND$YesYesNoNoYesNoYesNo
$SERVICEACKAUTHOR$ 8NoYesNoNoNoNoNoNo
$SERVICEACKAUTHORNAME$ 8NoYesNoNoNoNoNoNo
$SERVICEACKAUTHORALIAS$ 8NoYesNoNoNoNoNoNo
$SERVICEACKCOMMENT$ 8NoYesNoNoNoNoNoNo
$SERVICEACTIONURL$YesYesNoNoYesNoYesNo
$SERVICENOTESURL$YesYesNoNoYesNoYesNo
$SERVICENOTES$YesYesNoNoYesNoYesNo

Macro NameService ChecksService NotificationsHost ChecksHost NotificationsService Event Handlers and OCSPHost Event Handlers and OCHPService Perf DataHost Perf Data
Service Group Macros:
$SERVICEGROUPALIAS$ 6YesYesYesYesYesYesYesYes
$SERVICEGROUPMEMBERS$ 6YesYesYesYesYesYesYesYes
$SERVICEGROUPNOTES$ 6YesYesYesYesYesYesYesYes
$SERVICEGROUPNOTESURL$ 6YesYesYesYesYesYesYesYes
$SERVICEGROUPACTIONURL$ 6YesYesYesYesYesYesYesYes

Macro NameService ChecksService NotificationsHost ChecksHost NotificationsService Event Handlers and OCSPHost Event Handlers and OCHPService Perf DataHost Perf Data
Contact Macros:
$CONTACTNAME$NoYesNoYesNoNoNoNo
$CONTACTALIAS$NoYesNoYesNoNoNoNo
$CONTACTEMAIL$NoYesNoYesNoNoNoNo
$CONTACTPAGER$NoYesNoYesNoNoNoNo
$CONTACTADDRESSn$NoYesNoYesNoNoNoNo

Macro NameService ChecksService NotificationsHost ChecksHost NotificationsService Event Handlers and OCSPHost Event Handlers and OCHPService Perf DataHost Perf Data
Contact Group Macros:
$CONTACTGROUPALIAS$ 7YesYesYesYesYesYesYesYes
$CONTACTGROUPMEMBERS$ 7YesYesYesYesYesYesYesYes

Macro NameService ChecksService NotificationsHost ChecksHost NotificationsService Event Handlers and OCSPHost Event Handlers and OCHPService Perf DataHost Perf Data
Summary Macros:
$TOTALHOSTSUP$ 10YesYes 4YesYes 4YesYesYesYes
$TOTALHOSTSDOWN$ 10YesYes 4YesYes 4YesYesYesYes
$TOTALHOSTSUNREACHABLE$ 10YesYes 4YesYes 4YesYesYesYes
$TOTALHOSTSDOWNUNHANDLED$ 10YesYes 4YesYes 4YesYesYesYes
$TOTALHOSTSUNREACHABLEUNHANDLED$ 10YesYes 4YesYes 4YesYesYesYes
$TOTALHOSTPROBLEMS$ 10YesYes 4YesYes 4YesYesYesYes
$TOTALHOSTPROBLEMSUNHANDLED$ 10YesYes 4YesYes 4YesYesYesYes
$TOTALSERVICESOK$ 10YesYes 4YesYes 4YesYesYesYes
$TOTALSERVICESWARNING$ 10YesYes 4YesYes 4YesYesYesYes
$TOTALSERVICESCRITICAL$ 10YesYes 4YesYes 4YesYesYesYes
$TOTALSERVICESUNKNOWN$ 10YesYes 4YesYes 4YesYesYesYes
$TOTALSERVICESWARNINGUNHANDLED$ 10YesYes 4YesYes 4YesYesYesYes
$TOTALSERVICESCRITICALUNHANDLED$ 10YesYes 4YesYes 4YesYesYesYes
$TOTALSERVICESUNKNOWNUNHANDLED$ 10YesYes 4YesYes 4YesYesYesYes
$TOTALSERVICEPROBLEMS$ 10YesYes 4YesYes 4YesYesYesYes
$TOTALSERVICEPROBLEMSUNHANDLED$ 10YesYes 4YesYes 4YesYesYesYes

Macro NameService ChecksService NotificationsHost ChecksHost NotificationsService Event Handlers and OCSPHost Event Handlers and OCHPService Perf DataHost Perf Data
Notification Macros:
$NOTIFICATIONTYPE$NoYesNoYesNoNoNoNo
$NOTIFICATIONRECIPIENTS$NoYesNoYesNoNoNoNo
$NOTIFICATIONISESCALATED$NoYesNoYesNoNoNoNo
$NOTIFICATIONAUTHOR$NoYesNoYesNoNoNoNo
$NOTIFICATIONAUTHORNAME$NoYesNoYesNoNoNoNo
$NOTIFICATIONAUTHORALIAS$NoYesNoYesNoNoNoNo
$NOTIFICATIONCOMMENT$NoYesNoYesNoNoNoNo
$HOSTNOTIFICATIONNUMBER$NoYesNoYesNoNoNoNo
$HOSTNOTIFICATIONID$NoYesNoYesNoNoNoNo
$SERVICENOTIFICATIONNUMBER$NoYesNoYesNoNoNoNo
$SERVICENOTIFICATIONID$NoYesNoYesNoNoNoNo

Macro NameService ChecksService NotificationsHost ChecksHost NotificationsService Event Handlers and OCSPHost Event Handlers and OCHPService Perf DataHost Perf Data
Date/Time Macros:
$LONGDATETIME$YesYesYesYesYesYesYesYes
$SHORTDATETIME$YesYesYesYesYesYesYesYes
$DATE$YesYesYesYesYesYesYesYes
$TIME$YesYesYesYesYesYesYesYes
$TIMET$YesYesYesYesYesYesYesYes
$ISVALIDTIME:$ 9YesYesYesYesYesYesYesYes
$NEXTVALIDTIME:$ 9YesYesYesYesYesYesYesYes

Macro NameService ChecksService NotificationsHost ChecksHost NotificationsService Event Handlers and OCSPHost Event Handlers and OCHPService Perf DataHost Perf Data
File Macros:
$MAINCONFIGFILE$YesYesYesYesYesYesYesYes
$STATUSDATAFILE$YesYesYesYesYesYesYesYes
$COMMENTDATAFILE$YesYesYesYesYesYesYesYes< 5/td> + +
$DOWNTIMEDATAFILE$YesYesYesYesYesYesYesYes
$RETENTIONDATAFILE$YesYesYesYesYesYesYesYes
$OBJECTCACHEFILE$YesYesYesYesYesYesYesYes
$TEMPFILE$YesYesYesYesYesYesYesYes
$TEMPPATH$YesYesYesYesYesYesYesYes
$LOGFILE$YesYesYesYesYesYesYesYes
$RESOURCEFILE$YesYesYesYesYesYesYesYes
$COMMANDFILE$YesYesYesYesYesYesYesYes
$HOSTPERFDATAFILE$YesYesYesYesYesYesYesYes
$SERVICEPERFDATAFILE$YesYesYesYesYesYesYesYes

Macro NameService ChecksService NotificationsHost ChecksHost NotificationsService Event Handlers and OCSPHost Event Handlers and OCHPService Perf DataHost Perf Data
Misc Macros:
$PROCESSSTARTTIME$YesYesYesYesYesYesYesYes
$EVENTSTARTTIME$YesYesYesYesYesYesYesYes
$ADMINEMAIL$YesYesYesYesYesYesYesYes
$ADMINPAGER$YesYesYesYesYesYesYesYes
$ARGn$YesYesYesYesYesYesYesYes
$USERn$YesYesYesYesYesYesYesYes
+ +
+ + + +
+ + + + + +

+ +Macro Descriptions + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Host Macros: 3
$HOSTNAME$Short name for the host (i.e. "biglinuxbox"). This value is taken from the host_name directive in the host definition.
$HOSTDISPLAYNAME$An alternate display name for the host. This value is taken from the display_name directive in the host definition.
$HOSTALIAS$Long name/description for the host. This value is taken from the alias directive in the host definition.
$HOSTADDRESS$Address of the host. This value is taken from the address directive in the host definition.
$HOSTSTATE$A string indicating the current state of the host ("UP", "DOWN", or "UNREACHABLE").
$HOSTSTATEID$A number that corresponds to the current state of the host: 0=UP, 1=DOWN, 2=UNREACHABLE.
$LASTHOSTSTATE$A string indicating the last state of the host ("UP", "DOWN", or "UNREACHABLE").
$LASTHOSTSTATEID$A number that corresponds to the last state of the host: 0=UP, 1=DOWN, 2=UNREACHABLE.
$HOSTSTATETYPE$A string indicating the state type for the current host check ("HARD" or "SOFT"). Soft states occur when host checks return a non-OK (non-UP) state and are in the process of being retried. Hard states result when host checks have been checked a specified maximum number of times.
$HOSTATTEMPT$The number of the current host check retry. For instance, if this is the second time that the host is being rechecked, this will be the number two. Current attempt number is really only useful when writing host event handlers for "soft" states that take a specific action based on the host retry number.
$MAXHOSTATTEMPTS$The max check attempts as defined for the current host. Useful when writing host event handlers for "soft" states that take a specific action based on the host retry number.
$HOSTEVENTID$A globally unique number associated with the host's current state. Every time a host (or service) experiences a state change, a global event ID number is incremented by one (1). If a host has experienced no state changes, this macro will be set to zero (0).
$LASTHOSTEVENTID$The previous (globally unique) event number that was given to the host.
$HOSTPROBLEMID$A globally unique number associated with the host's current problem state. Every time a host (or service) transitions from an UP or OK state to a problem state, a global problem ID number is incremented by one (1). This macro will be non-zero if the host is currently a non-UP state. State transitions between non-UP states (e.g. DOWN to UNREACHABLE) do not cause this problem id to increase. If the host is currently in an UP state, this macro will be set to zero (0). Combined with event handlers, this macro could be used to automatically open trouble tickets when hosts first enter a problem state.
$LASTHOSTPROBLEMID$The previous (globally unique) problem number that was given to the host. Combined with event handlers, this macro could be used for automatically closing trouble tickets, etc. when a host recovers to an UP state.
$HOSTLATENCY$A (floating point) number indicating the number of seconds that a scheduled host check lagged behind its scheduled check time. For instance, if a check was scheduled for 03:14:15 and it didn't get executed until 03:14:17, there would be a check latency of 2.0 seconds. On-demand host checks have a latency of zero seconds.
$HOSTEXECUTIONTIME$A (floating point) number indicating the number of seconds that the host check took to execute (i.e. the amount of time the check was executing).
$HOSTDURATION$A string indicating the amount of time that the host has spent in its current state. Format is "XXh YYm ZZs", indicating hours, minutes and seconds.
$HOSTDURATIONSEC$A number indicating the number of seconds that the host has spent in its current state.
$HOSTDOWNTIME$A number indicating the current "downtime depth" for the host. If this host is currently in a period of scheduled downtime, the value will be greater than zero. If the host is not currently in a period of downtime, this value will be zero.
$HOSTPERCENTCHANGE$A (floating point) number indicating the percent state change the host has undergone. Percent state change is used by the flap detection algorithm.
$HOSTGROUPNAME$The short name of the hostgroup that this host belongs to. This value is taken from the hostgroup_name directive in the hostgroup definition. If the host belongs to more than one hostgroup this macro will contain the name of just one of them.
$HOSTGROUPNAMES$A comma separated list of the short names of all the hostgroups that this host belongs to.
$LASTHOSTCHECK$This is a timestamp in time_t format (seconds since the UNIX epoch) indicating the time at which a check of the host was last performed.
$LASTHOSTSTATECHANGE$This is a timestamp in time_t format (seconds since the UNIX epoch) indicating the time the host last changed state.
$LASTHOSTUP$This is a timestamp in time_t format (seconds since the UNIX epoch) indicating the time at which the host was last detected as being in an UP state.
$LASTHOSTDOWN$This is a timestamp in time_t format (seconds since the UNIX epoch) indicating the time at which the host was last detected as being in a DOWN state.
$LASTHOSTUNREACHABLE$This is a timestamp in time_t format (seconds since the UNIX epoch) indicating the time at which the host was last detected as being in an UNREACHABLE state.
$HOSTOUTPUT$The first line of text output from the last host check (i.e. "Ping OK").
$LONGHOSTOUTPUT$The full text output (aside from the first line) from the last host check.
$HOSTPERFDATA$This macro contains any performance data that may have been returned by the last host check.
$HOSTCHECKCOMMAND$This macro contains the name of the command (along with any arguments passed to it) used to perform the host check.
$HOSTACKAUTHOR$ 8A string containing the name of the user who acknowledged the host problem. This macro is only valid in notifications where the $NOTIFICATIONTYPE$ macro is set to "ACKNOWLEDGEMENT".
$HOSTACKAUTHORNAME$ 8A string containing the short name of the contact (if applicable) who acknowledged the host problem. This macro is only valid in notifications where the $NOTIFICATIONTYPE$ macro is set to "ACKNOWLEDGEMENT".
$HOSTACKAUTHORALIAS$ 8A string containing the alias of the contact (if applicable) who acknowledged the host problem. This macro is only valid in notifications where the $NOTIFICATIONTYPE$ macro is set to "ACKNOWLEDGEMENT".
$HOSTACKCOMMENT$ 8A string containing the acknowledgement comment that was entered by the user who acknowledged the host problem. This macro is only valid in notifications where the $NOTIFICATIONTYPE$ macro is set to "ACKNOWLEDGEMENT".
$HOSTACTIONURL$Action URL for the host. This macro may contain other macros (e.g. $HOSTNAME$), which can be useful when you want to pass the host name to a web page.
$HOSTNOTESURL$Notes URL for the host. This macro may contain other macros (e.g. $HOSTNAME$), which can be useful when you want to pass the host name to a web page.
$HOSTNOTES$Notes for the host. This macro may contain other macros (e.g. $HOSTNAME$), which can be useful when you want to host-specific status information, etc. in the description.
$TOTALHOSTSERVICES$The total number of services associated with the host.
$TOTALHOSTSERVICESOK$The total number of services associated with the host that are in an OK state.
$TOTALHOSTSERVICESWARNING$The total number of services associated with the host that are in a WARNING state.
$TOTALHOSTSERVICESUNKNOWN$The total number of services associated with the host that are in an UNKNOWN state.
$TOTALHOSTSERVICESCRITICAL$The total number of services associated with the host that are in a CRITICAL state.

Host Group Macros: 5
$HOSTGROUPALIAS$ 5The long name / alias of either 1) the hostgroup name passed as an on-demand macro argument or 2) the primary hostgroup associated with the current host (if not used in the context of an on-demand macro). This value is taken from the alias directive in the hostgroup definition.
$HOSTGROUPMEMBERS$ 5A comma-separated list of all hosts that belong to either 1) the hostgroup name passed as an on-demand macro argument or 2) the primary hostgroup associated with the current host (if not used in the context of an on-demand macro).
$HOSTGROUPNOTES$ 5The notes associated with either 1) the hostgroup name passed as an on-demand macro argument or 2) the primary hostgroup associated with the current host (if not used in the context of an on-demand macro). This value is taken from the notes directive in the hostgroup definition.
$HOSTGROUPNOTESURL$ 5The notes URL associated with either 1) the hostgroup name passed as an on-demand macro argument or 2) the primary hostgroup associated with the current host (if not used in the context of an on-demand macro). This value is taken from the notes_url directive in the hostgroup definition.
$HOSTGROUPACTIONURL$ 5The action URL associated with either 1) the hostgroup name passed as an on-demand macro argument or 2) the primary hostgroup associated with the current host (if not used in the context of an on-demand macro). This value is taken from the action_url directive in the hostgroup definition.

Service Macros:
$SERVICEDESC$The long name/description of the service (i.e. "Main Website"). This value is taken from the service_description directive of the service definition.
$SERVICEDISPLAYNAME$An alternate display name for the service. This value is taken from the display_name directive in the service definition.
$SERVICESTATE$A string indicating the current state of the service ("OK", "WARNING", "UNKNOWN", or "CRITICAL").
$SERVICESTATEID$A number that corresponds to the current state of the service: 0=OK, 1=WARNING, 2=CRITICAL, 3=UNKNOWN.
$LASTSERVICESTATE$A string indicating the last state of the service ("OK", "WARNING", "UNKNOWN", or "CRITICAL").
$LASTSERVICESTATEID$A number that corresponds to the last state of the service: 0=OK, 1=WARNING, 2=CRITICAL, 3=UNKNOWN.
$SERVICESTATETYPE$A string indicating the state type for the current service check ("HARD" or "SOFT"). Soft states occur when service checks return a non-OK state and are in the process of being retried. Hard states result when service checks have been checked a specified maximum number of times.
$SERVICEATTEMPT$The number of the current service check retry. For instance, if this is the second time that the service is being rechecked, this will be the number two. Current attempt number is really only useful when writing service event handlers for "soft" states that take a specific action based on the service retry number.
$MAXSERVICEATTEMPTS$The max check attempts as defined for the current service. Useful when writing host event handlers for "soft" states that take a specific action based on the service retry number.
$SERVICEISVOLATILE$Indicates whether the service is marked as being volatile or not: 0 = not volatile, 1 = volatile.
$SERVICEEVENTID$A globally unique number associated with the service's current state. Every time a a service (or host) experiences a state change, a global event ID number is incremented by one (1). If a service has experienced no state changes, this macro will be set to zero (0).
$LASTSERVICEEVENTID$The previous (globally unique) event number that given to the service.
$SERVICEPROBLEMID$A globally unique number associated with the service's current problem state. Every time a service (or host) transitions from an OK or UP state to a problem state, a global problem ID number is incremented by one (1). This macro will be non-zero if the service is currently a non-OK state. State transitions between non-OK states (e.g. WARNING to CRITICAL) do not cause this problem id to increase. If the service is currently in an OK state, this macro will be set to zero (0). Combined with event handlers, this macro could be used to automatically open trouble tickets when services first enter a problem state.
$LASTSERVICEPROBLEMID$The previous (globally unique) problem number that was given to the service. Combined with event handlers, this macro could be used for automatically closing trouble tickets, etc. when a service recovers to an OK state.
$SERVICELATENCY$A (floating point) number indicating the number of seconds that a scheduled service check lagged behind its scheduled check time. For instance, if a check was scheduled for 03:14:15 and it didn't get executed until 03:14:17, there would be a check latency of 2.0 seconds.
$SERVICEEXECUTIONTIME$A (floating point) number indicating the number of seconds that the service check took to execute (i.e. the amount of time the check was executing).
$SERVICEDURATION$A string indicating the amount of time that the service has spent in its current state. Format is "XXh YYm ZZs", indicating hours, minutes and seconds.
$SERVICEDURATIONSEC$A number indicating the number of seconds that the service has spent in its current state.
$SERVICEDOWNTIME$A number indicating the current "downtime depth" for the service. If this service is currently in a period of scheduled downtime, the value will be greater than zero. If the service is not currently in a period of downtime, this value will be zero.
$SERVICEPERCENTCHANGE$A (floating point) number indicating the percent state change the service has undergone. Percent state change is used by the flap detection algorithm.
$SERVICEGROUPNAME$The short name of the servicegroup that this service belongs to. This value is taken from the servicegroup_name directive in the servicegroup definition. If the service belongs to more than one servicegroup this macro will contain the name of just one of them.
$SERVICEGROUPNAMES$A comma separated list of the short names of all the servicegroups that this service belongs to.
$LASTSERVICECHECK$This is a timestamp in time_t format (seconds since the UNIX epoch) indicating the time at which a check of the service was last performed.
$LASTSERVICESTATECHANGE$This is a timestamp in time_t format (seconds since the UNIX epoch) indicating the time the service last changed state.
$LASTSERVICEOK$This is a timestamp in time_t format (seconds since the UNIX epoch) indicating the time at which the service was last detected as being in an OK state.
$LASTSERVICEWARNING$This is a timestamp in time_t format (seconds since the UNIX epoch) indicating the time at which the service was last detected as being in a WARNING state.
$LASTSERVICEUNKNOWN$This is a timestamp in time_t format (seconds since the UNIX epoch) indicating the time at which the service was last detected as being in an UNKNOWN state.
$LASTSERVICECRITICAL$This is a timestamp in time_t format (seconds since the UNIX epoch) indicating the time at which the service was last detected as being in a CRITICAL state.
$SERVICEOUTPUT$The first line of text output from the last service check (i.e. "Ping OK").
$LONGSERVICEOUTPUT$The full text output (aside from the first line) from the last service check.
$SERVICEPERFDATA$This macro contains any performance data that may have been returned by the last service check.
$SERVICECHECKCOMMAND$This macro contains the name of the command (along with any arguments passed to it) used to perform the service check.
$SERVICEACKAUTHOR$ 8A string containing the name of the user who acknowledged the service problem. This macro is only valid in notifications where the $NOTIFICATIONTYPE$ macro is set to "ACKNOWLEDGEMENT".
$SERVICEACKAUTHORNAME$ 8A string containing the short name of the contact (if applicable) who acknowledged the service problem. This macro is only valid in notifications where the $NOTIFICATIONTYPE$ macro is set to "ACKNOWLEDGEMENT".
$SERVICEACKAUTHORALIAS$ 8A string containing the alias of the contact (if applicable) who acknowledged the service problem. This macro is only valid in notifications where the $NOTIFICATIONTYPE$ macro is set to "ACKNOWLEDGEMENT".
$SERVICEACKCOMMENT$ 8A string containing the acknowledgement comment that was entered by the user who acknowledged the service problem. This macro is only valid in notifications where the $NOTIFICATIONTYPE$ macro is set to "ACKNOWLEDGEMENT".
$SERVICEACTIONURL$Action URL for the service. This macro may contain other macros (e.g. $HOSTNAME$ or $SERVICEDESC$), which can be useful when you want to pass the service name to a web page.
$SERVICENOTESURL$Notes URL for the service. This macro may contain other macros (e.g. $HOSTNAME$ or $SERVICEDESC$), which can be useful when you want to pass the service name to a web page.
$SERVICENOTES$Notes for the service. This macro may contain other macros (e.g. $HOSTNAME$ or $SERVICESTATE$), which can be useful when you want to service-specific status information, etc. in the description

Service Group Macros: 6
$SERVICEGROUPALIAS$ 6The long name / alias of either 1) the servicegroup name passed as an on-demand macro argument or 2) the primary servicegroup associated with the current service (if not used in the context of an on-demand macro). This value is taken from the alias directive in the servicegroup definition.
$SERVICEGROUPMEMBERS$ 6A comma-separated list of all services that belong to either 1) the servicegroup name passed as an on-demand macro argument or 2) the primary servicegroup associated with the current service (if not used in the context of an on-demand macro).
$SERVICEGROUPNOTES$ 6The notes associated with either 1) the servicegroup name passed as an on-demand macro argument or 2) the primary servicegroup associated with the current service (if not used in the context of an on-demand macro). This value is taken from the notes directive in the servicegroup definition.
$SERVICEGROUPNOTESURL$ 6The notes URL associated with either 1) the servicegroup name passed as an on-demand macro argument or 2) the primary servicegroup associated with the current service (if not used in the context of an on-demand macro). This value is taken from the notes_url directive in the servicegroup definition.
$SERVICEGROUPNOTES$ 6The action URL associated with either 1) the servicegroup name passed as an on-demand macro argument or 2) the primary servicegroup associated with the current service (if not used in the context of an on-demand macro). This value is taken from the action_url directive in the servicegroup definition.

Contact Macros:
$CONTACTNAME$Short name for the contact (i.e. "jdoe") that is being notified of a host or service problem. This value is taken from the contact_name directive in the contact definition.
$CONTACTALIAS$Long name/description for the contact (i.e. "John Doe") being notified. This value is taken from the alias directive in the contact definition.
$CONTACTEMAIL$Email address of the contact being notified. This value is taken from the email directive in the contact definition.
$CONTACTPAGER$Pager number/address of the contact being notified. This value is taken from the pager directive in the contact definition.
$CONTACTADDRESSn$Address of the contact being notified. Each contact can have six different addresses (in addition to email address and pager number). The macros for these addresses are $CONTACTADDRESS1$ - $CONTACTADDRESS6$. This value is taken from the addressx directive in the contact definition.
$CONTACTGROUPNAME$The short name of the contactgroup that this contact is a member of. This value is taken from the contactgroup_name directive in the contactgroup definition. If the contact belongs to more than one contactgroup this macro will contain the name of just one of them.
$CONTACTGROUPNAMES$A comma separated list of the short names of all the contactgroups that this contact is a member of.

Contact Group Macros: 5
$CONTACTGROUPALIAS$ 7The long name / alias of either 1) the contactgroup name passed as an on-demand macro argument or 2) the primary contactgroup associated with the current contact (if not used in the context of an on-demand macro). This value is taken from the alias directive in the contactgroup definition.
$CONTACTGROUPMEMBERS$ 7A comma-separated list of all contacts that belong to either 1) the contactgroup name passed as an on-demand macro argument or 2) the primary contactgroup associated with the current contact (if not used in the context of an on-demand macro).

SUMMARY Macros:
$TOTALHOSTSUP$This macro reflects the total number of hosts that are currently in an UP state.
$TOTALHOSTSDOWN$This macro reflects the total number of hosts that are currently in a DOWN state.
$TOTALHOSTSUNREACHABLE$This macro reflects the total number of hosts that are currently in an UNREACHABLE state.
$TOTALHOSTSDOWNUNHANDLED$This macro reflects the total number of hosts that are currently in a DOWN state that are not currently being "handled". Unhandled host problems are those that are not acknowledged, are not currently in scheduled downtime, and for which checks are currently enabled.
$TOTALHOSTSUNREACHABLEUNHANDLED$This macro reflects the total number of hosts that are currently in an UNREACHABLE state that are not currently being "handled". Unhandled host problems are those that are not acknowledged, are not currently in scheduled downtime, and for which checks are currently enabled.
$TOTALHOSTPROBLEMS$This macro reflects the total number of hosts that are currently either in a DOWN or an UNREACHABLE state.
$TOTALHOSTPROBLEMSUNHANDLED$This macro reflects the total number of hosts that are currently either in a DOWN or an UNREACHABLE state that are not currently being "handled". Unhandled host problems are those that are not acknowledged, are not currently in scheduled downtime, and for which checks are currently enabled.
$TOTALSERVICESOK$This macro reflects the total number of services that are currently in an OK state.
$TOTALSERVICESWARNING$This macro reflects the total number of services that are currently in a WARNING state.
$TOTALSERVICESCRITICAL$This macro reflects the total number of services that are currently in a CRITICAL state.
$TOTALSERVICESUNKNOWN$This macro reflects the total number of services that are currently in an UNKNOWN state.
$TOTALSERVICESWARNINGUNHANDLED$This macro reflects the total number of services that are currently in a WARNING state that are not currently being "handled". Unhandled services problems are those that are not acknowledged, are not currently in scheduled downtime, and for which checks are currently enabled.
$TOTALSERVICESCRITICALUNHANDLED$This macro reflects the total number of services that are currently in a CRITICAL state that are not currently being "handled". Unhandled services problems are those that are not acknowledged, are not currently in scheduled downtime, and for which checks are currently enabled.
$TOTALSERVICESUNKNOWNUNHANDLED$This macro reflects the total number of services that are currently in an UNKNOWN state that are not currently being "handled". Unhandled services problems are those that are not acknowledged, are not currently in scheduled downtime, and for which checks are currently enabled.
$TOTALSERVICEPROBLEMS$This macro reflects the total number of services that are currently either in a WARNING, CRITICAL, or UNKNOWN state.
$TOTALSERVICEPROBLEMSUNHANDLED$This macro reflects the total number of services that are currently either in a WARNING, CRITICAL, or UNKNOWN state that are not currently being "handled". Unhandled services problems are those that are not acknowledged, are not currently in scheduled downtime, and for which checks are currently enabled.

Notification Macros:
$NOTIFICATIONTYPE$A string identifying the type of notification that is being sent ("PROBLEM", "RECOVERY", "ACKNOWLEDGEMENT", "FLAPPINGSTART", "FLAPPINGSTOP", "FLAPPINGDISABLED", "DOWNTIMESTART", "DOWNTIMEEND", or "DOWNTIMECANCELLED").
$NOTIFICATIONRECIPIENTS$A comma-separated list of the short names of all contacts that are being notified about the host or service.
$NOTIFICATIONISESCALATED$An integer indicating whether this was sent to normal contacts for the host or service or if it was escalated. 0 = Normal (non-escalated) notification , 1 = Escalated notification.
$NOTIFICATIONAUTHOR$A string containing the name of the user who authored the notification. If the $NOTIFICATIONTYPE$ macro is set to "DOWNTIMESTART" or "DOWNTIMEEND", this will be the name of the user who scheduled downtime for the host or service. If the $NOTIFICATIONTYPE$ macro is "ACKNOWLEDGEMENT", this will be the name of the user who acknowledged the host or service problem. If the $NOTIFICATIONTYPE$ macro is "CUSTOM", this will be name of the user who initated the custom host or service notification. + +
$NOTIFICATIONAUTHORNAME$A string containing the short name of the contact (if applicable) specified in the $NOTIFICATIONAUTHOR$ macro.
$NOTIFICATIONAUTHORALIAS$A string containing the alias of the contact (if applicable) specified in the $NOTIFICATIONAUTHOR$ macro.
$NOTIFICATIONCOMMENT$A string containing the comment that was entered by the notification author. If the $NOTIFICATIONTYPE$ macro is set to "DOWNTIMESTART" or "DOWNTIMEEND", this will be the comment entered by the user who scheduled downtime for the host or service. If the $NOTIFICATIONTYPE$ macro is "ACKNOWLEDGEMENT", this will be the comment entered by the user who acknowledged the host or service problem. If the $NOTIFICATIONTYPE$ macro is "CUSTOM", this will be comment entered by the user who initated the custom host or service notification.
$HOSTNOTIFICATIONNUMBER$The current notification number for the host. The notification number increases by one (1) each time a new notification is sent out for the host (except for acknowledgements). The notification number is reset to 0 when the host recovers (after the recovery notification has gone out). Acknowledgements do not cause the notification number to increase, nor do notifications dealing with flap detection or scheduled downtime.
$HOSTNOTIFICATIONID$A unique number identifying a host notification. Notification ID numbers are unique across both hosts and service notifications, so you could potentially use this unique number as a primary key in a notification database. Notification ID numbers should remain unique across restarts of the Nagios process, so long as you have state retention enabled. The notification ID number is incremented by one (1) each time a new host notification is sent out, and regardless of how many contacts are notified.
$SERVICENOTIFICATIONNUMBER$The current notification number for the service. The notification number increases by one (1) each time a new notification is sent out for the service (except for acknowledgements). The notification number is reset to 0 when the service recovers (after the recovery notification has gone out). Acknowledgements do not cause the notification number to increase, nor do notifications dealing with flap detection or scheduled downtime.
$SERVICENOTIFICATIONID$A unique number identifying a service notification. Notification ID numbers are unique across both hosts and service notifications, so you could potentially use this unique number as a primary key in a notification database. Notification ID numbers should remain unique across restarts of the Nagios process, so long as you have state retention enabled. The notification ID number is incremented by one (1) each time a new service notification is sent out, and regardless of how many contacts are notified.

Date/Time Macros:
$LONGDATETIME$Current date/time stamp (i.e. Fri Oct 13 00:30:28 CDT 2000). Format of date is determined by date_format directive.
$SHORTDATETIME$Current date/time stamp (i.e. 10-13-2000 00:30:28). Format of date is determined by date_format directive.
$DATE$Date stamp (i.e. 10-13-2000). Format of date is determined by date_format directive.
$TIME$Current time stamp (i.e. 00:30:28).
$TIMET$Current time stamp in time_t format (seconds since the UNIX epoch).
$ISVALIDTIME:$ 9 + +

+ +This is a special on-demand macro that returns a 1 or 0 depending on whether or not a particular time is valid within a specified timeperiod. There are two ways of using this macro: + +

+ +
    + +
  1. $ISVALIDTIME:24x7$ will be set to "1" if the current time is valid within the "24x7" timeperiod. If not, it will be set to "0".
    2. + +
  2. $ISVALIDTIME:24x7:timestamp$ will be set to "1" if the time specified by the "timestamp" argument (which must be in time_t format) is valid within the "24x7" timeperiod. If not, it will be set to "0".
    3. + +
+ +
$NEXTVALIDTIME:$ 9 + +

+ +This is a special on-demand macro that returns the next valid time (in time_t format) for a specified timeperiod. There are two ways of using this macro: + +

+ +
    + +
  1. $NEXTVALIDTIME:24x7$ will return the next valid time - from and including the current time - in the "24x7" timeperiod.
    2. + +
  2. $NEXTVALIDTIME:24x7:timestamp$ will return the next valid time - from and including the time specified by the "timestamp" argument (which must be specified in time_t format) - in the "24x7" timeperiod.
    3. + +
+ +

+ +If a next valid time cannot be found in the specified timeperiod, the macro will be set to "0". + +

+ +

File Macros:
$MAINCONFIGFILE$The location of the main config file.
$STATUSDATAFILE$The location of the status data file.
$COMMENTDATAFILE$The location of the comment data file.
$DOWNTIMEDATAFILE$The location of the downtime data file.
$RETENTIONDATAFILE$The location of the retention data file.
$OBJECTCACHEFILE$The location of the object cache file.
$TEMPFILE$The location of the temp file.
$TEMPPATH$The directory specified by the temp path variable.
$LOGFILE$The location of the log file.
$RESOURCEFILE$The location of the resource file.
$COMMANDFILE$The location of the command file.
$HOSTPERFDATAFILE$The location of the host performance data file (if defined).
$SERVICEPERFDATAFILE$The location of the service performance data file (if defined).

Misc Macros:
$PROCESSSTARTTIME$Time stamp in time_t format (seconds since the UNIX epoch) indicating when the Nagios process was last (re)started. You can determine the number of seconds that Nagios has been running (since it was last restarted) by subtracting $PROCESSSTARTTIME$ from $TIMET$.
$EVENTSTARTTIME$Time stamp in time_t format (seconds since the UNIX epoch) indicating when the Nagios process starting process events (checks, etc.). You can determine the number of seconds that it took for Nagios to startup by subtracting $PROCESSSTARTTIME$ from $EVENTSTARTTIME$.
$ADMINEMAIL$Global administrative email address. This value is taken from the admin_email directive.
$ADMINPAGER$Global administrative pager number/address. This value is taken from the admin_pager directive.
$ARGn$The nth argument passed to the command (notification, event handler, service check, etc.). Nagios supports up to 32 argument macros ($ARG1$ through $ARG32$).
$USERn$The nth user-definable macro. User macros can be defined in one or more resource files. Nagios supports up to 32 user macros ($USER1$ through $USER32$).
+ + + + + + + +

+ +Notes + +

+ + + + + +

+ +1 These macros are not valid for the host they are associated with when that host is being checked (i.e. they make no sense, as they haven't been determined yet). + +

+ + + + + +

+ +2 These macros are not valid for the service they are associated with when that service is being checked (i.e. they make no sense, as they haven't been determined yet). + +

+ + + + + +

+ +3 When host macros are used in service-related commands (i.e. service notifications, event handlers, etc) they refer to they host that they service is associated with. + +

+ + + + + +

+ +4 When host and service summary macros are used in notification commands, the totals are filtered to reflect only those hosts and services for which the contact is authorized (i.e. hosts and services they are configured to receive notifications for). + +

+ + + + + +

+ +5 These macros are normally associated with the first/primary hostgroup associated with the current host. They could therefore be considered host macros in many cases. However, these macros are not available as on-demand host macros. Instead, they can be used as on-demand hostgroup macros when you pass the name of a hostgroup to the macro. For example: $HOSTGROUPMEMBERS:hg1$ would return a comma-delimited list of all (host) members of the hostgroup hg1. + +

+ + + + + +

+ +6 These macros are normally associated with the first/primary servicegroup associated with the current service. They could therefore be considered service macros in many cases. However, these macros are not available as on-demand service macros. Instead, they can be used as on-demand servicegroup macros when you pass the name of a servicegroup to the macro. For example: $SERVICEGROUPMEMBERS:sg1$ would return a comma-delimited list of all (service) members of the servicegroup sg1. + +

+ + + + + +

+ +7 These macros are normally associated with the first/primary contactgroup associated with the current contact. They could therefore be considered contact macros in many cases. However, these macros are not available as on-demand contact macros. Instead, they can be used as on-demand contactgroup macros when you pass the name of a contactgroup to the macro. For example: $CONTACTGROUPMEMBERS:cg1$ would return a comma-delimited list of all (contact) members of the contactgroup cg1. + +

+ + + + + +

+ +8 These acknowledgement macros are deprecated. Use the more generic $NOTIFICATIONAUTHOR$, $NOTIFICATIONAUTHORNAME$, $NOTIFICATIONAUTHORALIAS$ or $NOTIFICATIONAUTHORCOMMENT$ macros instead. + +

+ + + + + +

+ +9 These macro are only available as on-demand macros - e.g. you must supply an additional argument with them in order to use them. These macros are not available as environment variables. + +

+ + + + + +

+ +10 Summary macros are not available as environment variables if the use_large_installation_tweaks option is enabled, as they are quite CPU-intensive to calculate. + +

+ + + +
+ + + + + + + diff --git a/docs/macros.html b/docs/macros.html new file mode 100644 index 0000000..9b1bb6e --- /dev/null +++ b/docs/macros.html @@ -0,0 +1,586 @@ + + + + + + + + +Understanding Macros and How They Work + + + + + + + + + + + + + + + +
+ +Nagios + +

Understanding Macros and How They Work

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: List of Available Macros + +

+ + + +

+ +Macros + +

+ + + +

+ +One of the main features that make Nagios so flexible is the ability to use macros in command defintions. Macros allow you to reference information from hosts, services, and other sources in your commands. + +

+ + + +

+ +Macro Substitution - How Macros Work + +

+ + + +

+ +Before Nagios executes a command, it will replace any macros it finds in the command definition with their corresponding values. This macro substitution occurs for all types of commands that Nagios executes - host and service checks, notifications, event handlers, etc. + +

+ + + +

+ +Certain macros may themselves contain other macros. These include the $HOSTNOTES$, $HOSTNOTESURL$, $HOSTACTIONURL$, $SERVICENOTES$, $SERVICENOTESURL$, and $SERVICEACTIONURL$ macros. + +

+ + + + + +

+ +Example 1: Host Address Macro + +

+ + + +

+ +When you use host and service macros in command definitions, they refer to values for the host or service for which the command is being run. Let's try an example. Assuming we are using a host definition and a check_ping command defined like this: + +

+ + + +
+
+define host{
+
+	host_name		linuxbox
+
+	address		192.168.1.2
+
+	check_command	check_ping
+
+	...
+
+	}
+
+	
+
+define command{
+
+	command_name    check_ping
+
+	command_line    /usr/local/nagios/libexec/check_ping -H $HOSTADDRESS$ -w 100.0,90% -c 200.0,60%
+
+	}
+
+
+ + + +

+ +the expanded/final command line to be executed for the host's check command would look like this: + +

+ + + +
+
+	/usr/local/nagios/libexec/check_ping -H 192.168.1.2 -w 100.0,90% -c 200.0,60%
+
+
+ + + +

+ +Pretty simple, right? The beauty in this is that you can use a single command definition to check an unlimited number of hosts. Each host can be checked with the same command definition because each host's address is automatically substituted in the command line before execution. + +

+ + + +

+ +Example 2: Command Argument Macros + +

+ + + +

+ +You can pass arguments to commands as well, which is quite handy if you'd like to keep your command definitions rather generic. Arguments are specified in the object (i.e. host or service) definition, by separating them from the command name with exclamation points (!) like so: + +

+ + + +
+
+define service{
+
+	host_name		linuxbox
+
+	service_description	PING
+
+	check_command	check_ping!200.0,80%!400.0,40%
+
+	...
+
+	}
+
+
+ + + +

+ +In the example above, the service check command has two arguments (which can be referenced with $ARGn$ macros). The $ARG1$ macro will be "200.0,80%" and $ARG2$ will be "400.0,40%" (both without quotes). Assuming we are using the host definition given earlier and a check_ping command defined like this: + +

+ + + +
+
+define command{
+
+	command_name    check_ping
+
+	command_line    /usr/local/nagios/libexec/check_ping -H $HOSTADDRESS$ -w $ARG1$ -c $ARG2$
+
+	}
+
+
+ + + +

+ +the expanded/final command line to be executed for the service's check command would look like this: + +

+ + + +
+
+	/usr/local/nagios/libexec/check_ping -H 192.168.1.2 -w 200.0,80% -c 400.0,40%
+
+
+ + + +

+ +TipTip: If you need to pass bang (!) characters in your command arguments, you can do so by escaping them with a backslash (\). If you need to include backslashes in your command arguments, they should also be escaped with a backslash. + +

+ + + +

+ +On-Demand Macros + +

+ + + +

+ +Normally when you use host and service macros in command definitions, they refer to values for the host or service for which the command is being run. For instance, if a host check command is being executed for a host named "linuxbox", all the standard host macros will refer to values for that host ("linuxbox"). + +

+ + + +

+ +If you would like to reference values for another host or service in a command (for which the command is not being run), you can use what are called "on-demand" macros. On-demand macros look like normal macros, except for the fact that they contain an identifier for the host or service from which they should get their value. Here's the basic format for on-demand macros: + +

+ + + + + + + +

+ +Replace HOSTMACRONAME and SERVICEMACRONAME with the name of one of the standard host of service macros found here. + +

+ + + +

+ +Note that the macro name is separated from the host or service identifier by a colon (:). For on-demand service macros, the service identifier consists of both a host name and a service description - these are separated by a colon (:) as well. + +

+ + + +

+ +Tip Tip: On-demand service macros can contain an empty host name field. In this case the name of the host associated with the service will automatically be used. + +

+ + + +

+ +Examples of on-demand host and service macros follow: + +

+ + + +
+
+$HOSTDOWNTIME:myhost$                        <--- On-demand host macro
+
+$SERVICESTATEID:novellserver:DS Database$    <--- On-demand service macro
+
+$SERVICESTATEID::CPU Load$                   <--- On-demand service macro with blank host name field
+
+
+ + + +

+ +On-demand macros are also available for hostgroup, servicegroup, contact, and contactgroup macros. For example: + +

+ + + +
+
+$CONTACTEMAIL:john$                          <--- On-demand contact macro
+
+$CONTACTGROUPMEMBERS:linux-admins$           <--- On-demand contactgroup macro
+
+$HOSTGROUPALIAS:linux-servers$               <--- On-demand hostgroup macro
+
+$SERVICEGROUPALIAS:DNS-Cluster$              <--- On-demand servicegroup macro
+
+
+ + + + + +

+ +On-Demand Group Macros + +

+ + + +

+ +You can obtain the values of a macro across all contacts, hosts, or services in a specific group by using a special format for your on-demand macro declaration. You do this by referencing a specific host group, service group, or contact group name in an on-demand macro, like so: + +

+ + + + + + + +

+ +Replace HOSTMACRONAME, SERVICEMACRONAME, and CONTACTMACRONAME with the name of one of the standard host, service, or contact macros found here. The delimiter you specify is used to separate macro values for each group member. + +

+ + + +

+ +For example, the following macro will return a comma-separated list of host state ids for hosts that are members of the hg1 hostgroup: + +

+ + + +
+
+$HOSTSTATEID:hg1:,$
+
+
+ + + +

+ +This macro definition will return something that looks like this: + +

+ + + +
+
+0,2,1,1,0,0,2
+
+
+ + + +

+ +Custom Variable Macros + +

+ + + +

+ +Any custom object variables that you define in host, service, or contact definitions are also available as macros. Custom variable macros are named as follows: + +

+ + + + + + + +

+ +Take the following host definition with a custom variable called "_MACADDRESS"... + +

+ + + +
+
+define host{
+
+	host_name		linuxbox
+
+	address		192.168.1.1
+
+	_MACADDRESS	00:01:02:03:04:05
+
+	...
+
+	}
+
+
+ + + +

+ +The _MACADDRESS custom variable would be available in a macro called $_HOSTMACADDRESS$. More information on custom object variables and how they can be used in macros can be found here. + +

+ + + + + +

+ +Macro Cleansing + +

+ + + +

+ +Some macros are stripped of potentially dangerous shell metacharacters before being substituted into commands to be executed. Which characters are stripped from the macros depends on the setting of the illegal_macro_output_chars directive. The following macros are stripped of potentially dangerous characters: + +

+ + + +
    + +
  1. $HOSTOUTPUT$ + +
  2. $LONGHOSTOUTPUT$ + +
  3. $HOSTPERFDATA$ + +
  4. $HOSTACKAUTHOR$ + +
  5. $HOSTACKCOMMENT$ + +
  6. $SERVICEOUTPUT$ + +
  7. $LONGSERVICEOUTPUT$ + +
  8. $SERVICEPERFDATA$ + +
  9. $SERVICEACKAUTHOR$ + +
  10. $SERVICEACKCOMMENT$ + +
+ + + +

+ +Macros as Environment Variables + +

+ + + +

+ +Most macros are made available as environment variables for easy reference by scripts or commands that are executed by Nagios. For purposes of security and sanity, $USERn$ and "on-demand" host and service macros are not made available as environment variables. + +

+ +

+ +Environment variables that contain standard macros are named the same as their corresponding macro names (listed here), with "NAGIOS_" prepended to their names. For example, the $HOSTNAME$ macro would be available as an environment variable named "NAGIOS_HOSTNAME". + +

+ + + +

+ +Available Macros + +

+ + + +

+ +A list of all the macros that are available in Nagios, as well as a chart of when they can be used, can be found here. + +

+ + + +
+ + + + + + + diff --git a/docs/monitoring-linux.html b/docs/monitoring-linux.html new file mode 100644 index 0000000..a781cbc --- /dev/null +++ b/docs/monitoring-linux.html @@ -0,0 +1,155 @@ + + + + + + + + +Monitoring Linux/Unix Machines + + + + + + + + + + + + + + + +
+ +Nagios + +

Monitoring Linux/Unix Machines

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Quickstart Installation Guide, Monitoring Publicly Available Services + +

+ + + +

+ +Introduction + +

+ + + +

+ +This document describes how you can monitor "private" services and attributes of Linux/UNIX servers, such as: + +

+ + + + + + + +

+ +Publicly available services that are provided by Linux servers (HTTP, FTP, SSH, SMTP, etc.) can be monitored easily by following the documentation on monitoring publicly available services. + +

+ + + +

+ +Note Note: These instructions assume that you've installed Nagios according to the quickstart guide. The sample configuration entries below reference objects that are defined in the sample config files (commands.cfg, templates.cfg, etc.) that are installed if you follow the quickstart. + +

+ + + +

+ +Overview + +

+ + + +

+ +[Note: This document has not been completed. I would recommend you read the documentation on the NRPE addon for instructions on how to monitor a remote Linux/Unix server.] + +

+ + + +

+ +There are several different ways to monitor attributes or remote Linux/Unix servers. One is by using shared SSH keys and the check_by_ssh plugin to execute plugins on remote servers. This method will not be covered here, but can result in high load on your monitoring server if you are monitoring hundreds or thousands of services. The overhead of setting up/destroying SSH connections is the cause of this. + +

+ + + +NRPE + + + +

+ +Another common method of monitoring remote Linux/Unix hosts is to use the NRPE addon. NRPE allows you to execute plugins on remote Linux/Unix hosts. This is useful if you need to monitor local resources/attributes like disk usage, CPU load, memory usage, etc. on a remote host. + +

+ + + +
+ + + +
+ + + + + + \ No newline at end of file diff --git a/docs/monitoring-netware.html b/docs/monitoring-netware.html new file mode 100644 index 0000000..851246a --- /dev/null +++ b/docs/monitoring-netware.html @@ -0,0 +1,135 @@ + + + + + + + + +Monitoring Netware Servers + + + + + + + + + + + + + + + +
+ +Nagios + +

Monitoring Netware Servers

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Quickstart Installation Guide, Monitoring Publicly Available Services + +

+ + + +

+ +Introduction + +

+ + + +

+ +This document provides information on how you can monitor Novell Netware servers. + +

+ + + +

+ +External Resources + +

+ + + +

+ +You can find documentation on monitoring Netware servers with Nagios at Novell's Cool Solutions site, including: + +

+ + + + + + + +

+ +Tip Tip: When you visit Novell's Cool Solutions site, search for "Nagios" to find more articles and software components related to monitoring. + +

+ + + +

+ +Thanks to Christian Mies, Rainer Brunold, and others for contributing Nagios and Netware documentation, addons, etc. on the Novell site! + +

+ + + + + +
+ + + + + + \ No newline at end of file diff --git a/docs/monitoring-printers.html b/docs/monitoring-printers.html new file mode 100644 index 0000000..f5e20d5 --- /dev/null +++ b/docs/monitoring-printers.html @@ -0,0 +1,455 @@ + + + + + + + + +Monitoring Network Printers + + + + + + + + + + + + + + + +
+ +Nagios + +

Monitoring Network Printers

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Monitoring Publicly Available Services + +

+ + + +

+ +Introduction + +

+ + + +Printer + + + +

+ +This document describes how you can monitor the status of networked printers. Specifically, HP printers that have internal/external JetDirect cards/devices, or other print servers (like the Troy PocketPro 100S or the Netgear PS101) that support the JetDirect protocol. + +

+ + + +

+ +The check_hpjd plugin (which is part of the standard Nagios plugins distribution) allows you to monitor the status of JetDirect-capable printers which have SNMP enabled. The plugin is capable of detecting the following printer states: + +

+ + + + + + + +

+ +Note Note: These instructions assume that you've installed Nagios according to the quickstart guide. The sample configuration entries below reference objects that are defined in the sample config files (commands.cfg, templates.cfg, etc.) that are installed if you follow the quickstart. + +

+ + + +

+ +Overview + +

+ + + +Monitoring a Network Printer + + + +

+ +Monitoring the status of a networked printer is pretty simple. JetDirect-enabled printers usually have SNMP enabled, which allows Nagios to monitor their status using the check_hpjd plugin. + +

+ + + +

+ +The check_hpjd plugin will only get compiled and installed if you have the net-snmp and net-snmp-utils packages installed on your system. Make sure the plugin exists in /usr/local/nagios/libexec before you continue. If it doesn't, install net-snmp and net-snmp-utils and recompile/reinstall the Nagios plugins. + +

+ + + +

+ +Steps + +

+ + + +

+ +There are several steps you'll need to follow in order to monitor a new network printer. They are: + +

+ + + +
    + +
  1. Perform first-time prerequisites
    2. + +
  2. Create new host and service definitions for monitoring the printer
    3. + +
  3. Restart the Nagios daemon
    4. + +
+ + + + + +

+ +What's Already Done For You + +

+ + + +

+ +To make your life a bit easier, a few configuration tasks have already been done for you: + +

+ + + + + + + +

+ +The above-mentioned config files can be found in the /usr/local/nagios/etc/objects/ directory. You can modify the definitions in these and other definitions to suit your needs better if you'd like. However, I'd recommend waiting until you're more familiar with configuring Nagios before doing so. For the time being, just follow the directions outlined below and you'll be monitoring your network printers in no time. + +

+ + + +

+ +Prerequisites + +

+ + + +

+ +The first time you configure Nagios to monitor a network printer, you'll need to do a bit of extra work. Remember, you only need to do this for the *first* printer you monitor. + +

+ + + +

+ +Edit the main Nagios config file. + +

+ + + +
+
+vi /usr/local/nagios/etc/nagios.cfg
+
+
+ + + +

+ +Remove the leading pound (#) sign from the following line in the main configuration file: + +

+ + + +
+
+#cfg_file=/usr/local/nagios/etc/objects/printer.cfg
+
+
+ + + +

+ +Save the file and exit. + +

+ + + +

+ +What did you just do? You told Nagios to look to the /usr/local/nagios/etc/objects/printer.cfg to find additional object definitions. That's where you'll be adding host and service definitions for the printer. That configuration file already contains some sample host, hostgroup, and service definitions. For the *first* printer you monitor, you can simply modify the sample host and service definitions in that file, rather than creating new ones. + +

+ + + + + +

+ +Configuring Nagios + +

+ + + +

+ +You'll need to create some object definitions in order to monitor a new printer. + +

+ + + +

+ +Open the printer.cfg file for editing. + +

+ + + +
+
+vi /usr/local/nagios/etc/objects/printer.cfg
+
+
+ + + +

+ +Add a new host definition for the networked printer that you're going to monitor. If this is the *first* printer you're monitoring, you can simply modify the sample host definition in printer.cfg. Change the host_name, alias, and address fields to appropriate values for the printer. + +

+ + + +
+
+define host{
+
+	use		generic-printer	; Inherit default values from a template
+
+	host_name		hplj2605dn	; The name we're giving to this printer
+
+	alias		HP LaserJet 2605dn	; A longer name associated with the printer
+
+	address		192.168.1.30	; IP address of the printer
+
+	hostgroups	allhosts		; Host groups this printer is associated with
+
+	}
+
+
+ + + +

+ +Now you can add some service definitions (to the same configuration file) to monitor different aspects of the printer. If this is the *first* printer you're monitoring, you can simply modify the sample service definition in printer.cfg. + +

+ + + +

+ +Note Note: Replace "hplj2605dn" in the example definitions below with the name you specified in the host_name directive of the host definition you just added. + +

+ + + +

+ +Add the following service definition to check the status of the printer. The service uses the check_hpjd plugin to check the status of the printer every 10 minutes by default. The SNMP community string used to query the printer is "public" in this example. + +

+ + + +
+
+define service{
+
+	use			generic-service		; Inherit values from a template
+
+	host_name			hplj2605dn		; The name of the host the service is associated with
+
+	service_description	Printer Status		; The service description
+
+	check_command		check_hpjd!-C public	; The command used to monitor the service
+
+	normal_check_interval	10	; Check the service every 10 minutes under normal conditions
+
+	retry_check_interval	1	; Re-check the service every minute until its final/hard state is determined
+
+	}
+
+
+ + + +

+ +Add the following service definition to ping the printer every 10 minutes by default. This is useful for monitoring RTA, packet loss, and general network connectivity. + +

+ + + +
+
+define service{
+
+        use                     generic-service
+
+        host_name               hplj2605dn
+
+        service_description     PING
+
+        check_command           check_ping!3000.0,80%!5000.0,100%
+
+        normal_check_interval   10
+
+        retry_check_interval    1
+
+        }
+
+
+ + + +

+ +Save the file. + +

+ + + +

+ +Restarting Nagios + +

+ + + +

+ +Once you've added the new host and service definitions to the printer.cfg file, you're ready to start monitoring the printer. To do this, you'll need to verify your configuration and restart Nagios. + +

+ + + +

+ +If the verification process produces any errors messages, fix your configuration file before continuing. Make sure that you don't (re)start Nagios until the verification process completes without any errors! + +

+ + + + + + + +
+ + + + + + \ No newline at end of file diff --git a/docs/monitoring-publicservices.html b/docs/monitoring-publicservices.html new file mode 100644 index 0000000..b6354ce --- /dev/null +++ b/docs/monitoring-publicservices.html @@ -0,0 +1,828 @@ + + + + + + + + +Monitoring Publicly Available Services + + + + + + + + + + + + + + + +
+ +Nagios + +

Monitoring Publicly Available Services

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Quickstart Installation Guide + +

+ + + +

+ +Introduction + +

+ + + +

+ +This document describes how you can monitor publicly available services, applications and protocols. By "public" I mean services that are accessible across the network - either the local network or the greater Internet. Examples of public services include HTTP, POP3, IMAP, FTP, and SSH. There are many more public services that you probably use on a daily basis. These services and applications, as well as their underlying protocols, can usually be monitored by Nagios without any special access requirements. + +

+ + + +

+ +Private services, in contrast, cannot be monitored with Nagios without an intermediary agent of some kind. Examples of private services associated with hosts are things like CPU load, memory usage, disk usage, current user count, process information, etc. These private services or attributes of hosts are not usually exposed to external clients. This situation requires that an intermediary monitoring agent be installed on any host that you need to monitor such information on. More information on monitoring private services on different types of hosts can be found in the documentation on: + +

+ + + + + + + +

+ +Tip Tip: Occassionally you will find that information on private services and applications can be monitored with SNMP. The SNMP agent allows you to remotely monitor otherwise private (and inaccessible) information about the host. For more information about monitoring services using SNMP, check out the documentation on monitoring switches and routers. + +

+ + + +

+ +Note Note: These instructions assume that you've installed Nagios according to the quickstart guide. The sample configuration entries below reference objects that are defined in the sample commands.cfg and localhost.cfg config files. + +

+ + + + + +

+ +Plugins For Monitoring Services + +

+ + + +

+ +When you find yourself needing to monitor a particular application, service, or protocol, chances are good that a plugin exists to monitor it. The official Nagios plugins distribution comes with plugins that can be used to monitor a variety of services and protocols. There are also a large number of contributed plugins that can be found in the contrib/ subdirectory of the plugin distribution. The NagiosExchange.org website hosts a number of additional plugins that have been written by users, so check it out when you have a chance. + +

+ + + +

+ +If you don't happen to find an appropriate plugin for monitoring what you need, you can always write your own. Plugins are easy to write, so don't let this thought scare you off. Read the documentation on developing plugins for more information. + +

+ + + +

+ +I'll walk you through monitoring some basic services that you'll probably use sooner or later. Each of these services can be monitored using one of the plugins that gets installed as part of the Nagios plugins distribution. Let's get started... + +

+ + + + + +

+ +Creating A Host Definition + +

+ + + +

+ +Before you can monitor a service, you first need to define a host that is associated with the service. You can place host definitions in any object configuration file specified by a cfg_file directive or placed in a directory specified by a cfg_dir directive. If you have already created a host definition, you can skip this step. + +

+ + + +

+ +For this example, lets say you want to monitor a variety of services on a remote host. Let's call that host remotehost. The host definition can be placed in its own file or added to an already exiting object configuration file. Here's what the host definition for remotehost might look like: + +

+ + + +
+
+define host{
+
+	use		generic-host		; Inherit default values from a template
+
+	host_name		remotehost		; The name we're giving to this host
+
+	alias		Some Remote Host	; A longer name associated with the host
+
+	address		192.168.1.50		; IP address of the host
+
+	hostgroups		allhosts		; Host groups this host is associated with
+
+	}
+
+
+ + + +

+ +Now that a definition has been added for the host that will be monitored, we can start defining services that should be monitored. As with host definitions, service definitions can be placed in any object configuration file. + +

+ + + + + +

+ +Creating Service Definitions + +

+ + + +

+ +For each service you want to monitor, you need to define a service in Nagios that is associated with the host definition you just created. You can place service definitions in any object configuration file specified by a cfg_file directive or placed in a directory specified by a cfg_dir directive. + +

+ + + +

+ +Some example service definitions for monitoring common public service (HTTP, FTP, etc.) are given below. + +

+ + + +

+ +Monitoring HTTP + +

+ + + +

+ +Chances are you're going to want to monitor web servers at some point - either yours or someone else's. The check_http plugin is designed to do just that. It understands the HTTP protocol and can monitor response time, error codes, strings in the returned HTML, server certificates, and much more. + +

+ + + +

+ +The commands.cfg file contains a command definition for using the check_http plugin. It looks like this: + +

+ + + +
+
+define command{
+
+	name		check_http
+
+	command_name	check_http
+
+	command_line	$USER1$/check_http -I $HOSTADDRESS$ $ARG1$
+
+	}
+
+
+ + + +

+ +A simple service definition for monitoring the HTTP service on the remotehost machine might look like this: + +

+ + + +
+
+define service{
+
+	use		generic-service		; Inherit default values from a template
+
+	host_name		remotehost
+
+	service_description	HTTP
+
+	check_command	check_http
+
+	}
+
+
+ + + +

+ +This simple service definition will monitor the HTTP service running on remotehost. It will produce alerts if the web server doesn't respond within 10 seconds or if it returns HTTP errors codes (403, 404, etc.). That's all you need for basic monitoring. Pretty simple, huh? + +

+ + + +

+ +Tip Tip: For more advanced monitoring, run the check_http plugin manually with --help as a command-line argument to see all the options you can give the plugin. This --help syntax works with all of the plugins I'll cover in this document. + +

+ + + +

+ +A more advanced definition for monitoring the HTTP service is shown below. This service definition will check to see if the /download/index.php URI contains the string "latest-version.tar.gz". It will produce an error if the string isn't found, the URI isn't valid, or the web server takes longer than 5 seconds to respond. + +

+ + + +
+
+define service{
+
+	use		generic-service		; Inherit default values from a template
+
+	host_name		remotehost
+
+	service_description	Product Download Link
+
+	check_command	check_http!-u /download/index.php -t 5 -s "latest-version.tar.gz"
+
+	}
+
+
+ + + + + +

+ +Monitoring FTP + +

+ + + +

+ +When you need to monitor FTP servers, you can use the check_ftp plugin. The commands.cfg file contains a command definition for using the check_ftp plugin, which looks like this: + +

+ + + +
+
+define command{
+
+	command_name	check_ftp
+
+	command_line	$USER1$/check_ftp -H $HOSTADDRESS$ $ARG1$
+
+	}
+
+
+ + + +

+ +A simple service definition for monitoring the FTP server on remotehost would look like this: + +

+ + + +
+
+define service{
+
+	use		generic-service		; Inherit default values from a template
+
+	host_name		remotehost
+
+	service_description	FTP
+
+	check_command	check_ftp
+
+	}
+
+
+ + + +

+ +This service definition will monitor the FTP service and generate alerts if the FTP server doesn't respond within 10 seconds. + +

+ + + +

+ +A more advanced service definition is shown below. This service will check the FTP server running on port 1023 on remotehost. It will generate an alert if the server doesn't respond within 5 seconds or if the server response doesn't contain the string "Pure-FTPd [TLS]". + +

+ + + +
+
+define service{
+
+	use		generic-service		; Inherit default values from a template
+
+	host_name		remotehost
+
+	service_description	Special FTP 
+
+	check_command	check_ftp!-p 1023 -t 5 -e "Pure-FTPd [TLS]"
+
+	}
+
+
+ + + + + +

+ +Monitoring SSH + +

+ + + +

+ +When you need to monitor SSH servers, you can use the check_ssh plugin. The commands.cfg file contains a command definition for using the check_ssh plugin, which looks like this: + +

+ + + +
+
+define command{
+
+	command_name	check_ssh
+
+	command_line	$USER1$/check_ssh $ARG1$ $HOSTADDRESS$
+
+	}
+
+
+ + + +

+ +A simple service definition for monitoring the SSH server on remotehost would look like this: + +

+ + + +
+
+define service{
+
+	use		generic-service		; Inherit default values from a template
+
+	host_name		remotehost
+
+	service_description	SSH
+
+	check_command	check_ssh
+
+	}
+
+
+ + + +

+ +This service definition will monitor the SSH service and generate alerts if the SSH server doesn't respond within 10 seconds. + +

+ + + +

+ +A more advanced service definition is shown below. This service will check the SSH server and generate an alert if the server doesn't respond within 5 seconds or if the server version string string doesn't match "OpenSSH_4.2". + +

+ + + +
+
+define service{
+
+	use		generic-service		; Inherit default values from a template
+
+	host_name		remotehost
+
+	service_description	SSH Version Check 
+
+	check_command	check_ssh!-t 5 -r "OpenSSH_4.2"
+
+	}
+
+
+ + + + + +

+ +Monitoring SMTP + +

+ + + +

+ +The check_smtp plugin can be using for monitoring your email servers. The commands.cfg file contains a command definition for using the check_smtp plugin, which looks like this: + +

+ + + +
+
+define command{
+
+	command_name	check_smtp
+
+	command_line	$USER1$/check_smtp -H $HOSTADDRESS$ $ARG1$
+
+	}
+
+
+ + + +

+ +A simple service definition for monitoring the SMTP server on remotehost would look like this: + +

+ + + +
+
+define service{
+
+	use		generic-service		; Inherit default values from a template
+
+	host_name		remotehost
+
+	service_description	SMTP
+
+	check_command	check_smtp
+
+	}
+
+
+ + + +

+ +This service definition will monitor the SMTP service and generate alerts if the SMTP server doesn't respond within 10 seconds. + +

+ + + +

+ +A more advanced service definition is shown below. This service will check the SMTP server and generate an alert if the server doesn't respond within 5 seconds or if the response from the server doesn't contain "mygreatmailserver.com". + +

+ + + +
+
+define service{
+
+	use		generic-service		; Inherit default values from a template
+
+	host_name		remotehost
+
+	service_description	SMTP Response Check 
+
+	check_command	check_smtp!-t 5 -e "mygreatmailserver.com"
+
+	}
+
+
+ + + + + +

+ +Monitoring POP3 + +

+ + + +

+ +The check_pop plugin can be using for monitoring the POP3 service on your email servers. The commands.cfg file contains a command definition for using the check_pop plugin, which looks like this: + +

+ + + +
+
+define command{
+
+	command_name	check_pop
+
+	command_line	$USER1$/check_pop -H $HOSTADDRESS$ $ARG1$
+
+	}
+
+
+ + + +

+ +A simple service definition for monitoring the POP3 service on remotehost would look like this: + +

+ + + +
+
+define service{
+
+	use		generic-service		; Inherit default values from a template
+
+	host_name		remotehost
+
+	service_description	POP3
+
+	check_command	check_pop
+
+	}
+
+
+ + + +

+ +This service definition will monitor the POP3 service and generate alerts if the POP3 server doesn't respond within 10 seconds. + +

+ + + +

+ +A more advanced service definition is shown below. This service will check the POP3 service and generate an alert if the server doesn't respond within 5 seconds or if the response from the server doesn't contain "mygreatmailserver.com". + +

+ + + +
+
+define service{
+
+	use		generic-service		; Inherit default values from a template
+
+	host_name		remotehost
+
+	service_description	POP3 Response Check 
+
+	check_command	check_pop!-t 5 -e "mygreatmailserver.com"
+
+	}
+
+
+ + + + + +

+ +Monitoring IMAP + +

+ + + +

+ +The check_imap plugin can be using for monitoring IMAP4 service on your email servers. The commands.cfg file contains a command definition for using the check_imap plugin, which looks like this: + +

+ + + +
+
+define command{
+
+	command_name	check_imap
+
+	command_line	$USER1$/check_imap -H $HOSTADDRESS$ $ARG1$
+
+	}
+
+
+ + + +

+ +A simple service definition for monitoring the IMAP4 service on remotehost would look like this: + +

+ + + +
+
+define service{
+
+	use		generic-service		; Inherit default values from a template
+
+	host_name		remotehost
+
+	service_description	IMAP
+
+	check_command	check_imap
+
+	}
+
+
+ + + +

+ +This service definition will monitor the IMAP4 service and generate alerts if the IMAP server doesn't respond within 10 seconds. + +

+ + + +

+ +A more advanced service definition is shown below. This service will check the IMAP4 service and generate an alert if the server doesn't respond within 5 seconds or if the response from the server doesn't contain "mygreatmailserver.com". + +

+ + + +
+
+define service{
+
+	use		generic-service		; Inherit default values from a template
+
+	host_name		remotehost
+
+	service_description	IMAP4 Response Check 
+
+	check_command	check_imap!-t 5 -e "mygreatmailserver.com"
+
+	}
+
+
+ + + + + +

+ +Restarting Nagios + +

+ + + +

+ +Once you've added the new host and service definitions to your object configuration file(s), you're ready to start monitoring them. To do this, you'll need to verify your configuration and restart Nagios. + +

+ + + +

+ +If the verification process produces any errors messages, fix your configuration file before continuing. Make sure that you don't (re)start Nagios until the verification process completes without any errors! + +

+ + + + + +
+ + + + + + + diff --git a/docs/monitoring-routers.html b/docs/monitoring-routers.html new file mode 100644 index 0000000..21e7039 --- /dev/null +++ b/docs/monitoring-routers.html @@ -0,0 +1,612 @@ + + + + + + + + +Monitoring Routers and Switches + + + + + + + + + + + + + + + +
+ +Nagios + +

Monitoring Routers and Switches

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Monitoring Publicly Available Services + +

+ + + +

+ +Introduction + +

+ + + +Switch + + + +

+ +This document describes how you can monitor the status of network switches and routers. Some cheaper "unmanaged" switches and hubs don't have IP addresses and are essentially invisible on your network, so there's not any way to monitor them. More expensive switches and routers have addresses assigned to them and can be monitored by pinging them or using SNMP to query status information. + +

+ + + +

+ +I'll describe how you can monitor the following things on managed switches, hubs, and routers: + +

+ + + + + + + +

+ +Note Note: These instructions assume that you've installed Nagios according to the quickstart guide. The sample configuration entries below reference objects that are defined in the sample config files (commands.cfg, templates.cfg, etc.) that are installed when you follow the quickstart. + +

+ + + +

+ +Overview + +

+ + + +Monitoring a Router or Switch + + + +

+ +Monitoring switches and routers can either be easy or more involved - depending on what equipment you have and what you want to monitor. As they are critical infrastructure components, you'll no doubt want to monitor them in at least some basic manner. + +

+ + + +

+ +Switches and routers can be monitored easily by "pinging" them to determine packet loss, RTA, etc. If your switch supports SNMP, you can monitor port status, etc. with the check_snmp plugin and bandwidth (if you're using MRTG) with the check_mrtgtraf plugin. + +

+ + + +

+ +The check_snmp plugin will only get compiled and installed if you have the net-snmp and net-snmp-utils packages installed on your system. Make sure the plugin exists in /usr/local/nagios/libexec before you continue. If it doesn't, install net-snmp and net-snmp-utils and recompile/reinstall the Nagios plugins. + +

+ + + +

+ +Steps + +

+ + + +

+ +There are several steps you'll need to follow in order to monitor a new router or switch. They are: + +

+ + + +
    + +
  1. Perform first-time prerequisites
    2. + +
  2. Create new host and service definitions for monitoring the device
    3. + +
  3. Restart the Nagios daemon
    4. + +
+ + + + + +

+ +What's Already Done For You + +

+ + + +

+ +To make your life a bit easier, a few configuration tasks have already been done for you: + +

+ + + + + + + +

+ +The above-mentioned config files can be found in the /usr/local/nagios/etc/objects/ directory. You can modify the definitions in these and other definitions to suit your needs better if you'd like. However, I'd recommend waiting until you're more familiar with configuring Nagios before doing so. For the time being, just follow the directions outlined below and you'll be monitoring your network routers/switches in no time. + +

+ + + +

+ +Prerequisites + +

+ + + +

+ +The first time you configure Nagios to monitor a network switch, you'll need to do a bit of extra work. Remember, you only need to do this for the *first* switch you monitor. + +

+ + + +

+ +Edit the main Nagios config file. + +

+ + + +
+
+vi /usr/local/nagios/etc/nagios.cfg
+
+
+ + + +

+ +Remove the leading pound (#) sign from the following line in the main configuration file: + +

+ + + +
+
+#cfg_file=/usr/local/nagios/etc/objects/switch.cfg
+
+
+ + + +

+ +Save the file and exit. + +

+ + + +

+ +What did you just do? You told Nagios to look to the /usr/local/nagios/etc/objects/switch.cfg to find additional object definitions. That's where you'll be adding host and service definitions for routers and switches. That configuration file already contains some sample host, hostgroup, and service definitions. For the *first* router/switch you monitor, you can simply modify the sample host and service definitions in that file, rather than creating new ones. + +

+ + + + + +

+ +Configuring Nagios + +

+ + + +

+ +You'll need to create some object definitions in order to monitor a new router/switch.

+ + + +

+ +Open the switch.cfg file for editing. + +

+ + + +
+
+vi /usr/local/nagios/etc/objects/switch.cfg
+
+
+ + + +

+ +Add a new host definition for the switch that you're going to monitor. If this is the *first* switch you're monitoring, you can simply modify the sample host definition in switch.cfg. Change the host_name, alias, and address fields to appropriate values for the switch. + +

+ + + +
+
+define host{
+
+	use		generic-switch		; Inherit default values from a template
+
+	host_name		linksys-srw224p		; The name we're giving to this switch
+
+	alias		Linksys SRW224P Switch	; A longer name associated with the switch
+
+	address		192.168.1.253		; IP address of the switch
+
+	hostgroups	allhosts,switches			; Host groups this switch is associated with
+
+	}
+
+
+ + + +

+ +Monitoring Services + +

+ + + +

+ +Now you can add some service definitions (to the same configuration file) to monitor different aspects of the switch. If this is the *first* switch you're monitoring, you can simply modify the sample service definition in switch.cfg. + +

+ + + +

+ +Note Note: Replace "linksys-srw224p" in the example definitions below with the name you specified in the host_name directive of the host definition you just added. + +

+ + + + + +

+ +Monitoring Packet Loss and RTA + +

+ + + +

+ +Add the following service definition in order to monitor packet loss and round trip average between the Nagios host and the switch every 5 minutes under normal conditions. + +

+ + + +
+
+define service{
+
+	use			generic-service	; Inherit values from a template
+
+	host_name			linksys-srw224p	; The name of the host the service is associated with
+
+	service_description	PING		; The service description
+
+	check_command		check_ping!200.0,20%!600.0,60%	; The command used to monitor the service
+
+	normal_check_interval	5	; Check the service every 5 minutes under normal conditions
+
+	retry_check_interval	1	; Re-check the service every minute until its final/hard state is determined
+
+	}
+
+
+ + + +

+ +This service will be: + +

+ + + + + + + +

+ +Monitoring SNMP Status Information + +

+ + + +

+ +If your switch or router supports SNMP, you can monitor a lot of information by using the check_snmp plugin. If it doesn't, skip this section. + +

+ + + +

+ +Add the following service definition to monitor the uptime of the switch. + +

+ + + +
+
+define service{
+
+	use			generic-service	; Inherit values from a template
+
+	host_name			linksys-srw224p
+
+	service_description	Uptime	
+
+	check_command		check_snmp!-C public -o sysUpTime.0
+
+	}
+
+
+ + + +

+ +In the check_command directive of the service definition above, the "-C public" tells the plugin that the SNMP community name to be used is "public" and the "-o sysUpTime.0" indicates which OID should be checked. + +

+ + + +

+ +If you want to ensure that a specific port/interface on the switch is in an up state, you could add a service definition like this: + +

+ + + +
+
+define service{
+
+	use			generic-service	; Inherit values from a template
+
+	host_name			linksys-srw224p
+
+	service_description	Port 1 Link Status
+
+	check_command		check_snmp!-C public -o ifOperStatus.1 -r 1 -m RFC1213-MIB
+
+	}
+
+
+ + + +

+ +In the example above, the "-o ifOperStatus.1" refers to the OID for the operational status of port 1 on the switch. The "-r 1" option tells the check_snmp plugin to return an OK state if "1" is found in the SNMP result (1 indicates an "up" state on the port) and CRITICAL if it isn't found. The "-m RFC1213-MIB" is optional and tells the check_snmp plugin to only load the "RFC1213-MIB" instead of every single MIB that's installed on your system, which can help speed things up. + +

+ + + +

+ +That's it for the SNMP monitoring example. There are a million things that can be monitored via SNMP, so its up to you to decide what you need and want to monitor. Good luck! + +

+ + + +

+ +Tip Tip: You can usually find the OIDs that can be monitored on a switch by running the following command (replace 192.168.1.253 with the IP address of the switch): + +snmpwalk -v1 -c public 192.168.1.253 -m ALL .1 + +

+ + + +

+ +Monitoring Bandwidth / Traffic Rate + +

+ + + +

+ +If you're monitoring bandwidth usage on your switches or routers using MRTG, you can have Nagios alert you when traffic rates exceed thresholds you specify. The check_mrtgtraf plugin (which is included in the Nagios plugins distribution) allows you to do this. + +

+ + + +

+ +You'll need to let the check_mrtgtraf plugin know what log file the MRTG data is being stored in, along with thresholds, etc. In my example, I'm monitoring one of the ports on a Linksys switch. The MRTG log file is stored in /var/lib/mrtg/192.168.1.253_1.log. Here's the service definition I use to monitor the bandwidth data that's stored in the log file... + +

+ + + +
+
+define service{
+
+	use			generic-service	; Inherit values from a template
+
+	host_name			linksys-srw224p
+
+	service_description	Port 1 Bandwidth Usage
+
+	check_command		check_local_mrtgtraf!/var/lib/mrtg/192.168.1.253_1.log!AVG!1000000,2000000!5000000,5000000!10
+
+	}
+
+
+ + + +

+ +In the example above, the "/var/lib/mrtg/192.168.1.253_1.log" option that gets passed to the check_local_mrtgtraf command tells the plugin which MRTG log file to read from. The "AVG" option tells it that it should use average bandwidth statistics. The "1000000,2000000" options are the warning thresholds (in bytes) for incoming traffic rates. The "5000000,5000000" are critical thresholds (in bytes) for outgoing traffic rates. The "10" option causes the plugin to return a CRITICAL state if the MRTG log file is older than 10 minutes (it should be updated every 5 minutes). + +

+ + + + + +

+ +Save the file. + +

+ + + +

+ +Restarting Nagios + +

+ + + +

+ +Once you've added the new host and service definitions to the switch.cfg file, you're ready to start monitoring the router/switch. To do this, you'll need to verify your configuration and restart Nagios. + +

+ + + +

+ +If the verification process produces any errors messages, fix your configuration file before continuing. Make sure that you don't (re)start Nagios until the verification process completes without any errors! + +

+ + + + + + + +
+ + + + + + + diff --git a/docs/monitoring-windows.html b/docs/monitoring-windows.html new file mode 100644 index 0000000..1617547 --- /dev/null +++ b/docs/monitoring-windows.html @@ -0,0 +1,789 @@ + + + + + + + + +Monitoring Windows Machines + + + + + + + + + + + + + + + +
+ +Nagios + +

Monitoring Windows Machines

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Quickstart Installation Guide, Monitoring Publicly Available Services + +

+ + + +

+ +Introduction + +

+ + + +

+ +This document describes how you can monitor "private" services and attributes of Windows machines, such as: + +

+ + + + + + + +

+ +Publicly available services that are provided by Windows machines (HTTP, FTP, POP3, etc.) can be monitored easily by following the documentation on monitoring publicly available services. + +

+ + + +

+ +Note Note: These instructions assume that you've installed Nagios according to the quickstart guide. The sample configuration entries below reference objects that are defined in the sample config files (commands.cfg, templates.cfg, etc.) that are installed if you follow the quickstart. + +

+ + + + + +

+ +Overview + +

+ + + +Monitoring a Windows Machine + + + +

+ +Monitoring private services or attributes of a Windows machine requires that you install an agent on it. This agent acts as a proxy between the Nagios plugin that does the monitoring and the actual service or attribute of the Windows machine. Without installing an agent on the Windows box, Nagios would be unable to monitor private services or attributes of the Windows box. + +

+ + + +

+ +For this example, we will be installing the NSClient++ addon on the Windows machine and using the check_nt plugin to communicate with the NSClient++ addon. The check_nt plugin should already be installed on the Nagios server if you followed the quickstart guide. + +

+ + + +

+ +Other Windows agents (like NC_Net) could be used instead of NSClient++ if you wish - provided you change command and service definitions, etc. a bit. For the sake of simplicity I will only cover using the NSClient++ addon in these instructions. + +

+ + + + + + + +

+ +Steps + +

+ + + +

+ +There are several steps you'll need to follow in order to monitor a new Windows machine. They are: + +

+ + + +
    + +
  1. Perform first-time prerequisites
    2. + +
  2. Install a monitoring agent on the Windows machine
    3. + +
  3. Create new host and service definitions for monitoring the Windows machine
    4. + +
  4. Restart the Nagios daemon
    5. + +
+ + + +

+ +What's Already Done For You + +

+ + + +

+ +To make your life a bit easier, a few configuration tasks have already been done for you: + +

+ + + + + + + +

+ +The above-mentioned config files can be found in the /usr/local/nagios/etc/objects/ directory. You can modify the definitions in these and other definitions to suit your needs better if you'd like. However, I'd recommend waiting until you're more familiar with configuring Nagios before doing so. For the time being, just follow the directions outlined below and you'll be monitoring your Windows boxes in no time. + +

+ + + +

+ +Prerequisites + +

+ + + +

+ +The first time you configure Nagios to monitor a Windows machine, you'll need to do a bit of extra work. Remember, you only need to do this for the *first* Windows machine you monitor. + +

+ + + +

+ +Edit the main Nagios config file. + +

+ + + +
+
+vi /usr/local/nagios/etc/nagios.cfg
+
+
+ + + +

+ +Remove the leading pound (#) sign from the following line in the main configuration file: + +

+ + + +
+
+#cfg_file=/usr/local/nagios/etc/objects/windows.cfg
+
+
+ + + +

+ +Save the file and exit. + +

+ + + +

+ +What did you just do? You told Nagios to look to the /usr/local/nagios/etc/objects/windows.cfg to find additional object definitions. That's where you'll be adding Windows host and service definitions. That configuration file already contains some sample host, hostgroup, and service definitions. For the *first* Windows machine you monitor, you can simply modify the sample host and service definitions in that file, rather than creating new ones. + +

+ + + + + +

+ +Installing the Windows Agent + +

+ + + +

+ +Before you can begin monitoring private services and attributes of Windows machines, you'll need to install an agent on those machines. I recommend using the NSClient++ addon, which can be found at http://sourceforge.net/projects/nscplus. These instructions will take you through a basic installation of the NSClient++ addon, as well as the configuration of Nagios for monitoring the Windows machine. + +

+ + + +

+ +1. Download the latest stable version of the NSClient++ addon from http://sourceforge.net/projects/nscplus + +

+ + + +

+ +2. Unzip the NSClient++ files into a new C:\NSClient++ directory + +

+ + + +

+ +3. Open a command prompt and change to the C:\NSClient++ directory + +

+ + + +

+ +4. Register the NSClient++ system service with the following command: + +

+ + + +
+
+	nsclient++ /install
+
+
+ + + +

+ +5. Install the NSClient++ systray with the following command ('SysTray' is case-sensitive): + +

+ + + +
+
+	nsclient++ SysTray
+
+
+ + + +

+ +6. Open the services manager and make sure the NSClientpp service is allowed to interact with the desktop (see the 'Log On' tab of the services manager). If it isn't already allowed to interact with the desktop, check the box to allow it to. + +

+ + + +

+ +NSClientpp + +

+ + + +

+ +7. Edit the NSC.INI file (located in the C:\NSClient++ directory) and make the following changes: + +

+ + + + + + + + + +

+ +8. Start the NSClient++ service with the following command: + +

+ + + +
+
+	nsclient++ /start
+
+
+ + + +

+ +9. If installed properly, a new icon should appear in your system tray. It will be a yellow circle with a black 'M' inside. + +

+ + + +

+ +10. Success! The Windows server can now be added to the Nagios monitoring configuration... + +

+ + + + + +

+ +Configuring Nagios + +

+ + + +

+ +Now it's time to define some object definitions in your Nagios configuration files in order to monitor the new Windows machine. + +

+ + + +

+ +Open the windows.cfg file for editing. + +

+ + + +
+
+vi /usr/local/nagios/etc/objects/windows.cfg
+
+
+ + + +

+ +Add a new host definition for the Windows machine that you're going to monitor. If this is the *first* Windows machine you're monitoring, you can simply modify the sample host definition in windows.cfg. Change the host_name, alias, and address fields to appropriate values for the Windows box. + +

+ + + +
+
+define host{
+
+	use		windows-server	; Inherit default values from a Windows server template (make sure you keep this line!)
+
+	host_name		winserver
+
+	alias		My Windows Server
+
+	address		192.168.1.2
+
+	}
+
+
+ + + +

+ +Good. Now you can add some service definitions (to the same configuration file) in order to tell Nagios to monitor different aspects of the Windows machine. If this is the *first* Windows machine you're monitoring, you can simply modify the sample service definitions in windows.cfg. + +

+ + + +

+ +Note Note: Replace "winserver" in the example definitions below with the name you specified in the host_name directive of the host definition you just added. + +

+ + + +

+ +Add the following service definition to monitor the version of the NSClient++ addon that is running on the Windows server. This is useful when it comes time to upgrade your Windows servers to a newer version of the addon, as you'll be able to tell which Windows machines still need to be upgraded to the latest version of NSClient++. + +

+ + + +
+
+define service{
+
+	use			generic-service
+
+	host_name			winserver
+
+	service_description	NSClient++ Version
+
+	check_command		check_nt!CLIENTVERSION
+
+	}
+
+
+ + + +

+ +Add the following service definition to monitor the uptime of the Windows server. + +

+ + + +
+
+define service{
+
+	use			generic-service
+
+	host_name			winserver
+
+	service_description	Uptime
+
+	check_command		check_nt!UPTIME
+
+	}
+
+
+ + + + + +

+ +Add the following service definition to monitor the CPU utilization on the Windows server and generate a CRITICAL alert if the 5-minute CPU load is 90% or more or a WARNING alert if the 5-minute load is 80% or greater. + +

+ + + +
+
+define service{
+
+	use			generic-service
+
+	host_name			winserver
+
+	service_description	CPU Load
+
+	check_command		check_nt!CPULOAD!-l 5,80,90
+
+	}
+
+
+ + + + + +

+ +Add the following service definition to monitor memory usage on the Windows server and generate a CRITICAL alert if memory usage is 90% or more or a WARNING alert if memory usage is 80% or greater. + +

+ + + +
+
+define service{
+
+	use			generic-service
+
+	host_name			winserver
+
+	service_description	Memory Usage
+
+	check_command		check_nt!MEMUSE!-w 80 -c 90
+
+	}
+
+
+ + + + + +

+ +Add the following service definition to monitor usage of the C:\ drive on the Windows server and generate a CRITICAL alert if disk usage is 90% or more or a WARNING alert if disk usage is 80% or greater. + +

+ + + +
+
+define service{
+
+	use			generic-service
+
+	host_name			winserver
+
+	service_description	C:\ Drive Space
+
+	check_command		check_nt!USEDDISKSPACE!-l c -w 80 -c 90
+
+	}
+
+
+ + + + + +

+ +Add the following service definition to monitor the W3SVC service state on the Windows machine and generate a CRITICAL alert if the service is stopped. + +

+ + + +
+
+define service{
+
+	use			generic-service
+
+	host_name			winserver
+
+	service_description	W3SVC
+
+	check_command		check_nt!SERVICESTATE!-d SHOWALL -l W3SVC
+
+	}
+
+
+ + + + + +

+ +Add the following service definition to monitor the Explorer.exe process on the Windows machine and generate a CRITICAL alert if the process is not running. + +

+ + + +
+
+define service{
+
+	use			generic-service
+
+	host_name			winserver
+
+	service_description	Explorer
+
+	check_command		check_nt!PROCSTATE!-d SHOWALL -l Explorer.exe
+
+	}
+
+
+ + + +

+ +That's it for now. You've added some basic services that should be monitored on the Windows box. Save the configuration file. + +

+ + + + + +

+ +Password Protection + +

+ + + +

+ +If you specified a password in the NSClient++ configuration file on the Windows machine, you'll need to modify the check_nt command definition to include the password. Open the commands.cfg file for editing. + +

+ + + +
+
+vi /usr/local/nagios/etc/objects/commands.cfg
+
+
+ + + +

+ +Change the definition of the check_nt command to include the "-s <PASSWORD>" argument (where PASSWORD is the password you specified on the Windows machine) like this: + +

+ + + +
+
+define command{
+
+	command_name	check_nt
+
+	command_line	$USER1$/check_nt -H $HOSTADDRESS$ -p 12489 -s PASSWORD -v $ARG1$ $ARG2$
+
+	}
+
+
+ + + +

+ +Save the file. + +

+ + + +

+ +Restarting Nagios + +

+ + + +

+ +You're done with modifying the Nagios configuration, so you'll need to verify your configuration files and restart Nagios. + +

+ + + +

+ +If the verification process produces any errors messages, fix your configuration file before continuing. Make sure that you don't (re)start Nagios until the verification process completes without any errors! + +

+ + + + + +
+ + + + + + \ No newline at end of file diff --git a/docs/mrtggraphs.html b/docs/mrtggraphs.html new file mode 100644 index 0000000..2ba3498 --- /dev/null +++ b/docs/mrtggraphs.html @@ -0,0 +1,520 @@ + + + + + + + + +Graphing Performance Info With MRTG + + + + + + + + + + + + + + + +
+ +Nagios + +

Graphing Performance Info With MRTG

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Nagiostats Utility, Performance Tuning + +

+ + + +

+ +Introduction + +

+ + + +

+ +The nagiostats utility allows you to graph various Nagios performance statistics over time using MRTG. This is important because it can help you: + +

+ + + + + + + +

+ +Sample MRTG Configuration + +

+ + + +

+ +Sample MRTG configuration file snippets for graphing various Nagios performance statistics can be found in the mrtg.cfg file located in the sample-config/ subdirectory of the Nagios distribution. You can create graphs of other performance information if you'd like - the samples just provide you with a good starting point. + +

+ +

+ +Once you copy these sample entries into your MRTG config file (/etc/mrtg/mrtg.cfg) you should have some new graphs the next time MRTG runs. + +

+ + + +

+ +Example Graphs + +

+ + + +

+ +I'll describe what a few of the sample MRTG graphs mean and what they can be used for... + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

+ +Active Host Checks - This graph shows how may active host checks (regularly scheduled and on-demand) have occurred over time. Useful for understanding: + +

+ + + +		 + +Active Host Checks + +
+ +

+ +Active Service Checks - This graph shows how may active service checks (reguarly scheduled and on-demand) have occurred over time. Useful for understanding: + +

+ + + +		 + +Active Service Checks + +
+ +

+ +Cached Host and Service Checks - This graph shows how may cached host and service checks have occurred over time. Useful for understanding: + +

+ + + +		 + +Cached Host and Service Checks + +
+ +

+ +Passive Host and Service Checks - This graph shows how may passive host and service checks have occurred over time. Useful for understanding: + +

+ + + +		 + +Passive Host and Service Checks + +
+ +

+ +Hosts/Services Actively Checked - This graph shows how many (of the total number of) hosts and services were last checked actively over time. Useful for understanding: + +

+ + + +		 + +Hosts/Services Actively Checked + +
+ +

+ +Hosts/Services Passively Checked - This graph shows how many (of the total number of) hosts and services were last checked passively over time. Useful for understanding: + +

+ + + +		 + +Hosts/Services Passively Checked + +
+ +

+ +Average Service Check Latency and Execution Time - This graph shows average service check latency and execution times over time. Useful for understanding: + +

+ + + +

+ +Consistently high latencies can be an indication that one of more of the following variables need tweaking: + +

+ + + +		 + +Average Service Check Latency and Execution Time + +
+ +

+ +Average Service State Change - This graph shows the average percent state change (a measure of volatility) for services over time, broken down by services that were last checked either actively or passively. Useful for understanding: + +

+ + + +		 + +Average Service State Change + +
+ +

+ +Average Host Check Latency and Execution Time - This graph shows average host check latency and execution times over time. Useful for understanding: + +

+ + + +

+ +Consistently high latencies can be an indication that one of more of the following variables need tweaking: + +

+ + + +		 + +Average Host Check Latency and Execution Time + +
+ +

+ +Average Host State Change - This graph shows the average percent state change (a measure of volatility) for hosts over time, broken down by hosts that were last checked either actively or passively. Useful for understanding: + +

+ + + +		 + +Average Host State Change + +
+ +

+ +External Commands - This graph shows how may external commands have been processed by the Nagios daemon over time. Unless you're processing a large number of external commands (as in the case with distributed monitoring setups), this graph may appear mostly empty. Monitoring external commands can be useful for understanding the impacts of: + +

+ + + +		 + +External Commands + +
+ +

+ +External Command Buffers - This graph shows how may external command buffer slots are in use over time. If the number of used buffers is near the number of available buffers on a regular basis, it is likely you need to increase the available external command buffer slots. Each buffer slot can hold one external command. Buffers are used for temporarily holding external commands from the time they are read from the external command file to the time they are processed by the Nagios daemon. + +

+ +		 + +External Command Buffers + +
+ + + +
+ + + + + + + diff --git a/docs/nagiostats.html b/docs/nagiostats.html new file mode 100644 index 0000000..c9472db --- /dev/null +++ b/docs/nagiostats.html @@ -0,0 +1,286 @@ + + + + + + + + +Using The Nagiostats Utility + + + + + + + + + + + + + + + +
+ +Nagios + +

Using The Nagiostats Utility

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Graphing Performance Info, Performance Tuning + +

+ + + +

+ +Introduction + +

+ + + +

+ +A utility called nagiostats is included in the Nagios distribution. It is compiled and installed along with the main Nagios daemon. The nagiostats utility allows you to obtain various information about a running Nagios process that can be very helpful in tuning performance. You can obtain information either in human-readable or MRTG-compatible format. + +

+ + + +

+ +Usage Information + +

+ + + +

+ +You can run the nagiostats utility with the --help option to get usage information. + +

+ + + +

+ +Human-Readable Output + +

+ + + +

+ +To obtain human-readable information on the performance of a running Nagios process, run the nagiostats utility with the -c command line argument to specify your main configuration file location like such: + +

+ + + + + +
+
+[nagios@lanman ~]# /usr/local/nagios/bin/nagiostats -c /usr/local/nagios/etc/nagios.cfg
+
+
+
+
+
+Nagios Stats 3.0prealpha-05202006
+
+Copyright (c) 2003-2007 Ethan Galstad (www.nagios.org)
+
+Last Modified: 05-20-2006
+
+License: GPL
+
+
+
+CURRENT STATUS DATA
+
+------------------------------------------------------
+
+Status File:                            /usr/local/nagios/var/status.dat
+
+Status File Age:                        0d 0h 0m 9s
+
+Status File Version:                    3.0prealpha-05202006
+
+
+
+Program Running Time:                   0d 5h 20m 39s
+
+Nagios PID:                             10119
+
+Used/High/Total Command Buffers:        0 / 0 / 64
+
+Used/High/Total Check Result Buffers:   0 / 7 / 512
+
+
+
+Total Services:                         95
+
+Services Checked:                       94
+
+Services Scheduled:                     91
+
+Services Actively Checked:              94
+
+Services Passively Checked:             1
+
+Total Service State Change:             0.000 / 78.950 / 1.026 %
+
+Active Service Latency:                 0.000 / 4.272 / 0.561 sec
+
+Active Service Execution Time:          0.000 / 60.007 / 2.066 sec
+
+Active Service State Change:            0.000 / 78.950 / 1.037 %
+
+Active Services Last 1/5/15/60 min:     4 / 68 / 91 / 91
+
+Passive Service State Change:           0.000 / 0.000 / 0.000 %
+
+Passive Services Last 1/5/15/60 min:    0 / 0 / 0 / 0
+
+Services Ok/Warn/Unk/Crit:              58 / 16 / 0 / 21
+
+Services Flapping:                      1
+
+Services In Downtime:                   0
+
+
+
+Total Hosts:                            24
+
+Hosts Checked:                          24
+
+Hosts Scheduled:                        24
+
+Hosts Actively Checked:                 24
+
+Host Passively Checked:                 0
+
+Total Host State Change:                0.000 / 9.210 / 0.384 %
+
+Active Host Latency:                    0.000 / 0.446 / 0.219 sec
+
+Active Host Execution Time:             1.019 / 10.034 / 2.764 sec
+
+Active Host State Change:               0.000 / 9.210 / 0.384 %
+
+Active Hosts Last 1/5/15/60 min:        5 / 22 / 24 / 24
+
+Passive Host State Change:              0.000 / 0.000 / 0.000 %
+
+Passive Hosts Last 1/5/15/60 min:       0 / 0 / 0 / 0
+
+Hosts Up/Down/Unreach:                  18 / 4 / 2
+
+Hosts Flapping:                         0
+
+Hosts In Downtime:                      0
+
+
+
+Active Host Checks Last 1/5/15 min:     9 / 52 / 164
+
+   Scheduled:                           4 / 23 / 75
+
+   On-demand:                           3 / 23 / 69
+
+   Cached:                              2 / 6 / 20
+
+Passive Host Checks Last 1/5/15 min:    0 / 0 / 0
+
+Active Service Checks Last 1/5/15 min:  9 / 80 / 244
+
+   Scheduled:                           9 / 80 / 244
+
+   On-demand:                           0 / 0 / 0
+
+   Cached:                              0 / 0 / 0
+
+Passive Service Checks Last 1/5/15 min: 0 / 0 / 0
+
+
+
+External Commands Last 1/5/15 min:      0 / 0 / 0
+
+
+
+[nagios@lanman ~]# 
+
+
+ + + +

+ +As you can see, the utility displays a number of different metrics pertaining to the Nagios process. Metrics which have multiple values are (unless otherwise specified) min, max and average values for that particular metric. + +

+ + + +

+ +MRTG Integration + +

+ + + +

+ +You can use the nagiostats utility to display various Nagios metrics using MRTG (or other compatible program). To do so, run the nagiostats utility using the --mrtg and --data arguments. The --data argument is used to specify what statistics should be graphed. Possible values for the --data argument can be found by running the nagiostats utility with the --help option. + +

+ + + +

+ +Note Note: Information on using the nagiostats utility to generate MRTG graphs for Nagios performance statistics can be found here. + +

+ + + + + +
+ + + + + + + diff --git a/docs/networkreachability.html b/docs/networkreachability.html new file mode 100644 index 0000000..a8e4bd4 --- /dev/null +++ b/docs/networkreachability.html @@ -0,0 +1,344 @@ + + + + + + + + +Determining Status and Reachability of Network Hosts + + + + + + + + + + + + + + + +
+ +Nagios + +

Determining Status and Reachability of Network Hosts

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Host Checks, Passive Host State Translation + +

+ + + +

+ +Introduction + +

+ + + +

+ +If you've ever work in tech support, you've undoubtably had users tell you "the Internet is down". As a techie, you're pretty sure that no one pulled the power cord from the Internet. Something must be going wrong somewhere between the user's chair and the Internet. + +

+ + + +

+ +Assuming its a technical problem, you begin to search for the problem. Perhaps the user's computer is turned off, maybe their network cable is unplugged, or perhaps your organization's core router just took a dive. Whatever the problem might be, one thing is most certain - the Internet isn't down. It just happens to be unreachable for that user. + +

+ + + +

+ +Nagios is able to determine whether the hosts you're monitoring are in a DOWN or UNREACHABLE state. These are very different (although related) states and can help you quickly determine the root cause of network problems. Here's how the reachability logic works to distinguish between these two states... + +

+ + + + + +

+ +Example Network + +

+ + + +

+ +Take a look at the simple network diagram below. For this example, lets assume you're monitoring all the hosts (server, routers, switches, etc) that are pictured. Nagios is installed and running on the Nagios host. + +

+ + + +

+ +Example Network + +

+ + + +

+ +Defining Parent/Child Relationships + +

+ + + +

+ +In order for Nagios to be able to distinguish between DOWN and UNREACHABLE states for the hosts that are being monitored, you'll need to tell Nagios how those hosts are connected to each other - from the standpoint of the Nagios daemon. To do this, trace the path that a data packet would take from the Nagios daemon to each individual host. Each switch, router, and server the packet encounters or passes through is considered a "hop" and will require that you define a parent/child host relationship in Nagios. Here's what the host parent/child relationships look like from the viewpoint of Nagios: + +

+ + + +

+ +Parent/Child Relationships + +

+ + + + + +

+ +Now that you know what the parent/child relationships look like for hosts that are being monitored, how do you configure Nagios to reflect them? The parents directive in your host definitions allows you to do this. Here's what the (abbreviated) host definitions with parent/child relationships would look like for this example: + +

+ + + +
+
+define host{
+
+	host_name		Nagios   ; <-- The local host has no parent - it is the topmost host
+
+	}
+
+
+
+define host{
+
+	host_name		Switch1
+
+	parents		Nagios
+
+	}
+
+	
+
+define host{
+
+	host_name		Web
+
+	parents		Switch1
+
+	}
+
+	
+
+define host{
+
+	host_name		FTP
+
+	parents		Switch1
+
+	}
+
+	
+
+define host{
+
+	host_name		Router1
+
+	parents		Switch1
+
+	}
+
+	
+
+define host{
+
+	host_name		Switch2
+
+	parents		Router1
+
+	}
+
+	
+
+define host{
+
+	host_name		Wkstn1
+
+	parents		Switch2
+
+	}
+
+	
+
+define host{
+
+	host_name		HPLJ2605
+
+	parents		Switch2
+
+	}
+
+	
+
+define host{
+
+	host_name		Router2
+
+	parents		Router1
+
+	}
+
+	
+
+define host{
+
+	host_name		somewebsite.com
+
+	parents		Router2
+
+	}
+
+
+ + + +

+ +Reachability Logic in Action + +

+ + + +

+ +Now that you're configured Nagios with the proper parent/child relationships for your hosts, let's see what happen when problems arise. Assume that two hosts - Web and Router1 - go offline... + +

+ + + +

+ +Reachability Example + +

+ + + +

+ +When hosts change state (i.e. from UP to DOWN), the host reachability logic in Nagios kicks in. The reachability logic will initiate parallel checks of the parents and children of whatever hosts change state. This allows Nagios to quickly determine the current status of your network infrastructure when changes occur. + +

+ + + +

+ +Reachability Logic + +

+ + + +

+ +In this example, Nagios will determine that Web and Router1 are both in DOWN states because the "path" to those hosts is not being blocked. + +

+ + + +

+ +Nagios will determine that all the hosts "beneath" Router1 are all in an UNREACHABLE state because Nagios can't reach them. Router1 is DOWN and is blocking the path to those other hosts. Those hosts might be running fine, or they might be offline - Nagios doesn't know because it can't reach them. Hence Nagios considers them to be UNREACHABLE instead of DOWN. + +

+ + + +

+ +UNREACHABLE States and Notifications + +

+ + + +

+ +By default, Nagios will notify contacts about both DOWN and UNREACHABLE host states. As an admin/tech, you might not want to get notifications about hosts that are UNREACHABLE. You know your network structure, and if Nagios notifies you that your router/firewall is down, you know that everything behind it is unreachable. + +

+ + + +

+ +If you want to spare yourself from a flood of UNREACHABLE notifications during network outages, you can exclude the unreachable (u) option from the notification_options directive in your host definitions and/or the host_notification_options directive in your contact definitions. + +

+ + + + + + + +
+ + + + + + + diff --git a/docs/notifications.html b/docs/notifications.html new file mode 100644 index 0000000..27c167d --- /dev/null +++ b/docs/notifications.html @@ -0,0 +1,414 @@ + + + + + + + + +Notifications + + + + + + + + + + + + + + + +
+ +Nagios + +

Notifications

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Escalations, Timeperiods, On-Call Rotations + +

+ + + +

+ +Introduction + +

+ + + +Contacts + + + +

+ +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 here. + +

+ + + + + +

+ +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... + +

+ + + + + + + + + +

+ +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 Nagios sends out a host or service notification, it will notify each contact that is a member of any contact groups specified in the <contactgroups> option of the service definition. Nagios 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 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 scheduled downtime. If 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 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. Similiarly, 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... Note: 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... Note: If the time period filter is not passed, Nagios 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 Nagios 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 Nagios starts to notify all the people it should. 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. Note: 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... Note: 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 Nagios 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 depend on the notification commands that are defined in your object definition files. + +

+ + + +

+ +Note Note: If you install Nagios according to the quickstart guide, 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: /usr/local/nagios/etc/objects/commands.cfg. + +

+ + + +

+ +Specific notification methods (paging, etc.) are not directly incorporated into the Nagios code as it just doesn't make much sense. The "core" of Nagios is not designed to be an all-in-one application. If service checks were embedded in Nagios' core it would be very difficult for users to add new check methods, modify existing checks, etc. Notifications work in a similiar 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 $NOTIFICATIONTYPE$ macro contains a string that identifies exactly that. The table below lists the possible values for the macro and their respective descriptions: + +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ValueDescription
PROBLEMA 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.
RECOVERYA 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.
ACKNOWLEDGEMENTThis 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.
FLAPPINGSTARTThe host or service has just started flapping.
FLAPPINGSTOPThe host or service has just stopped flapping.
FLAPPINGDISABLEDThe host or service has just stopped flapping because flap detection was disabled..
DOWNTIMESTARTThe host or service has just entered a period of scheduled downtime. Future notifications will be supressed.
DOWNTIMESTOPThe host or service has just exited from a period of scheduled downtime. Notifications about problems can now resume.
DOWNTIMECANCELLEDThe period of scheduled downtime for the host or service was just cancelled. Notifications about problems can now resume.
+ + + +

+ +Helpful Resources + +

+ + + +

+ +There are many ways you could configure Nagios 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: + +

+ + + + + + + +

+ +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 conjuction with Nagios 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... + +

+ + + + + +

+ +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. + +

+ + + +
+ + + + + + + diff --git a/docs/objectdefinitions.html b/docs/objectdefinitions.html new file mode 100644 index 0000000..85a0fde --- /dev/null +++ b/docs/objectdefinitions.html @@ -0,0 +1,4108 @@ + + + + + + + + +Object Definitions + + + + + + + + + + + + + + + +
+ +Nagios + +

Object Definitions

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Object Configuration Overview, Object Tricks, Object Inheritance, Custom Object Variables + +

+ + + +

+ +Introduction + +

+ + + +

+ +One of the features of Nagios' object configuration format is that you can create object definitions that inherit properties from other object definitions. An explanation of how object inheritence works can be found here. I strongly suggest that you familiarize yourself with object inheritence once you read over the documentation presented below, as it will make the job of creating and maintaining object definitions much easier than it otherwise would be. Also, read up on the object tricks that offer shortcuts for otherwise tedious configuration tasks. + +

+ + + +

+ +NoteWhen creating and/or editing configuration files, keep the following in mind: + +

+ +
    + +
  1. Lines that start with a '#' character are taken to be comments and are not processed + +
  2. Directive names are case-sensitive + +
  3. Characters that appear after a semicolon (;) in configuration lines are treated as comments and are not processed + +
+ + + + + +

+ +Retention Notes + +

+ + + +

+ +It is important to point out that several directives in host, service, and contact definitions may not be picked up by Nagios when you change them in your configuration files. Object directives that can exhibit this behavior are marked with an asterisk (*). The reason for this behavior is due to the fact that Nagios chooses to honor values stored in the state retention file over values found in the config files, assuming you have state retention enabled on a program-wide basis and the value of the directive is changed during runtime with an external command. + +

+ + + +

+ +One way to get around this problem is to disable the retention of non-status information using the retain_nonstatus_information directive in the host, service, and contact definitions. Disabling this directive will cause Nagios to take the initial values for these directives from your config files, rather than from the state retention file when it (re)starts. + +

+ + + +

+ +Sample Configuration Files + +

+ + + +

+ +Note Note: Sample object configuration files are installed in the /usr/local/nagios/etc/ directory when you follow the quickstart installation guide. + +

+ + + +

+ +Object Types + +

+ +

+ +Host definitions
+ +Host group definitions
+ +Service definitions
+ +Service group definitions
+ +Contact definitions
+ +Contact group definitions
+ +Time period definitions
+ +Command definitions
+ +Service dependency definitions
+ +Service escalation definitions
+ +Host dependency definitions
+ +Host escalation definitions
+ +Extended host information definitions
+ +Extended service information definitions
+ +

+ + + +

+ + + + + + + + + + + +
Host Definition
+ + + +

Description:

+ +

+ +A host definition is used to define a physical server, workstation, device, etc. that resides on your network. + +

+ + + +

Definition Format:

+ +

+ +Note: Directives in red are required, while those in black are optional. + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
define host{
host_namehost_name
aliasalias
display_namedisplay_name
addressaddress
parentshost_names
hostgroupshostgroup_names
check_commandcommand_name
initial_state[o,d,u]
max_check_attempts#
check_interval#
retry_interval#
active_checks_enabled[0/1]
passive_checks_enabled[0/1]
check_periodtimeperiod_name
obsess_over_host[0/1]
check_freshness[0/1]
freshness_threshold#
event_handlercommand_name
event_handler_enabled[0/1]
low_flap_threshold#
high_flap_threshold#
flap_detection_enabled[0/1]
flap_detection_options[o,d,u]
process_perf_data[0/1]
retain_status_information[0/1]
retain_nonstatus_information[0/1]
contactscontacts
contact_groupscontact_groups
notification_interval#
first_notification_delay#
notification_periodtimeperiod_name
notification_options[d,u,r,f,s]
notifications_enabled[0/1]
stalking_options[o,d,u]
notesnote_string
notes_urlurl
action_urlurl
icon_imageimage_file
icon_image_altalt_string
vrml_imageimage_file
statusmap_imageimage_file
2d_coordsx_coord,y_coord
3d_coordsx_coord,y_coord,z_coord
   }
+ + + +

Example Definition:

+ +
+
+define host{
+
+	host_name			bogus-router
+
+	alias				Bogus Router #1
+
+	address				192.168.1.254
+
+	parents				server-backbone
+
+	check_command			check-host-alive
+
+	check_interval			5
+
+	retry_interval			1
+
+	max_check_attempts		5
+
+	check_period			24x7
+
+	process_perf_data		0
+
+	retain_nonstatus_information	0
+
+	contact_groups			router-admins
+
+	notification_interval		30
+
+	notification_period		24x7
+
+	notification_options		d,u,r
+
+	}
+
+
+ + + +

Directive Descriptions:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
host_name: + +This directive is used to define a short name used to identify the host. It is used in host group and service definitions to reference this particular host. Hosts can have multiple services (which are monitored) associated with them. When used properly, the $HOSTNAME$ macro will contain this short name. + +
alias: + +This directive is used to define a longer name or description used to identify the host. It is provided in order to allow you to more easily identify a particular host. When used properly, the $HOSTALIAS$ macro will contain this alias/description. + +
address: + +This directive is used to define the address of the host. Normally, this is an IP address, although it could really be anything you want (so long as it can be used to check the status of the host). You can use a FQDN to identify the host instead of an IP address, but if DNS services are not 3333ccle this could cause problems. When used properly, the $HOSTADDRESS$ macro will contain this address. Note: If you do not specify an address directive in a host definition, the name of the host will be used as its address. A word of caution about doing this, however - if DNS fails, most of your service checks will fail because the plugins will be unable to resolve the host name. + +
display_name: + +This directive is used to define an alternate name that should be displayed in the web interface for this host. If not specified, this defaults to the value you specify for the host_name directive. Note: The current CGIs do not use this option, although future versions of the web interface will. + +
parents: + +This directive is used to define a comma-delimited list of short names of the "parent" hosts for this particular host. Parent hosts are typically routers, switches, firewalls, etc. that lie between the monitoring host and a remote hosts. A router, switch, etc. which is closest to the remote host is considered to be that host's "parent". Read the "Determining Status and Reachability of Network Hosts" document located here for more information. If this host is on the same network segment as the host doing the monitoring (without any intermediate routers, etc.) the host is considered to be on the local network and will not have a parent host. Leave this value blank if the host does not have a parent host (i.e. it is on the same segment as the Nagios host). The order in which you specify parent hosts has no effect on how things are monitored. + +
hostgroups: + +This directive is used to identify the short name(s) of the hostgroup(s) that the host belongs to. Multiple hostgroups should be separated by commas. This directive may be used as an alternative to (or in addition to) using the members directive in hostgroup definitions. + +
check_command: + +This directive is used to specify the short name of the command that should be used to check if the host is up or down. Typically, this command would try and ping the host to see if it is "alive". The command must return a status of OK (0) or Nagios will assume the host is down. If you leave this argument blank, the host will not be actively checked. Thus, Nagios will likely always assume the host is up (it may show up as being in a "PENDING" state in the web interface). This is useful if you are monitoring printers or other devices that are frequently turned off. The maximum amount of time that the notification command can run is controlled by the host_check_timeout option. + +
initial_state: + +By default Nagios will assume that all hosts are in UP states when it starts. You can override the initial state for a host by using this directive. Valid options are: o = UP, d = DOWN, and u = UNREACHABLE. + +
max_check_attempts: + +This directive is used to define the number of times that Nagios will retry the host check command if it returns any state other than an OK state. Setting this value to 1 will cause Nagios to generate an alert without retrying the host check. Note: If you do not want to check the status of the host, you must still set this to a minimum value of 1. To bypass the host check, just leave the check_command option blank. + +
check_interval: + +This directive is used to define the number of "time units" between regularly scheduled checks of the host. Unless you've changed the interval_length directive from the default value of 60, this number will mean minutes. More information on this value can be found in the check scheduling documentation. + +
retry_interval: + +This directive is used to define the number of "time units" to wait before scheduling a re-check of the hosts. Hosts are rescheduled at the retry interval when they have changed to a non-UP state. Once the host has been retried max_check_attempts times without a change in its status, it will revert to being scheduled at its "normal" rate as defined by the check_interval value. Unless you've changed the interval_length directive from the default value of 60, this number will mean minutes. More information on this value can be found in the check scheduling documentation. + +
active_checks_enabled *: + +This directive is used to determine whether or not active checks (either regularly scheduled or on-demand) of this host are enabled. Values: 0 = disable active host checks, 1 = enable active host checks (default). + +
passive_checks_enabled *: + +This directive is used to determine whether or not passive checks are enabled for this host. Values: 0 = disable passive host checks, 1 = enable passive host checks (default). + +
check_period: + +This directive is used to specify the short name of the time period during which active checks of this host can be made. + +
obsess_over_host *: + +This directive determines whether or not checks for the host will be "obsessed" over using the ochp_command. + +
check_freshness *: + +This directive is used to determine whether or not freshness checks are enabled for this host. Values: 0 = disable freshness checks, 1 = enable freshness checks (default). + +
freshness_threshold: + +This directive is used to specify the freshness threshold (in seconds) for this host. If you set this directive to a value of 0, Nagios will determine a freshness threshold to use automatically. + +
event_handler: + +This directive is used to specify the short name of the command that should be run whenever a change in the state of the host is detected (i.e. whenever it goes down or recovers). Read the documentation on + +event handlers for a more detailed explanation of how to write scripts for handling events. The maximum amount of time that the event handler command can run is controlled by the event_handler_timeout option. + +
event_handler_enabled *: + +This directive is used to determine whether or not the event handler for this host is enabled. Values: 0 = disable host event handler, 1 = enable host event handler. + +
low_flap_threshold: + +This directive is used to specify the low state change threshold used in flap detection for this host. More information on flap detection can be found here. If you set this directive to a value of 0, the program-wide value specified by the low_host_flap_threshold directive will be used. + +
high_flap_threshold: + +This directive is used to specify the high state change threshold used in flap detection for this host. More information on flap detection can be found here. If you set this directive to a value of 0, the program-wide value specified by the high_host_flap_threshold directive will be used. + +
flap_detection_enabled *: + +This directive is used to determine whether or not flap detection is enabled for this host. More information on flap detection can be found here. Values: 0 = disable host flap detection, 1 = enable host flap detection. + +
flap_detection_options: + +This directive is used to determine what host states the flap detection logic will use for this host. Valid options are a combination of one or more of the following: o = UP states, d = DOWN states, u = UNREACHABLE states. + +
process_perf_data *: + +This directive is used to determine whether or not the processing of performance data is enabled for this host. Values: 0 = disable performance data processing, 1 = enable performance data processing. + +
retain_status_information: + +This directive is used to determine whether or not status-related information about the host is retained across program restarts. This is only useful if you have enabled state retention using the retain_state_information directive. Value: 0 = disable status information retention, 1 = enable status information retention. + +
retain_nonstatus_information: + +This directive is used to determine whether or not non-status information about the host is retained across program restarts. This is only useful if you have enabled state retention using the retain_state_information directive. Value: 0 = disable non-status information retention, 1 = enable non-status information retention. + +
contacts: + +This is a list of the short names of the contacts that should be notified whenever there are problems (or recoveries) with this host. Multiple contacts should be separated by commas. Useful if you want notifications to go to just a few people and don't want to configure contact groups. You must specify at least one contact or contact group in each host definition. + +
contact_groups: + +This is a list of the short names of the contact groups that should be notified whenever there are problems (or recoveries) with this host. Multiple contact groups should be separated by commas. You must specify at least one contact or contact group in each host definition. + +
notification_interval: + +This directive is used to define the number of "time units" to wait before re-notifying a contact that this service is still down or unreachable. Unless you've changed the interval_length directive from the default value of 60, this number will mean minutes. If you set this value to 0, Nagios will not re-notify contacts about problems for this host - only one problem notification will be sent out. + +
first_notification_delay: + +This directive is used to define the number of "time units" to wait before sending out the first problem notification when this host enters a non-UP state. Unless you've changed the interval_length directive from the default value of 60, this number will mean minutes. If you set this value to 0, Nagios will start sending out notifications immediately. + +
notification_period: + +This directive is used to specify the short name of the time period during which notifications of events for this host can be sent out to contacts. If a host goes down, becomes unreachable, or recoveries during a time which is not covered by the time period, no notifications will be sent out. + +
notification_options: + +This directive is used to determine when notifications for the host should be sent out. Valid options are a combination of one or more of the following: d = send notifications on a DOWN state, u = send notifications on an UNREACHABLE state, r = send notifications on recoveries (OK state), f = send notifications when the host starts and stops flapping, and s = send notifications when scheduled downtime starts and ends. If you specify n (none) as an option, no host notifications will be sent out. If you do not specify any notification options, Nagios will assume that you want notifications to be sent out for all possible states. Example: If you specify d,r in this field, notifications will only be sent out when the host goes DOWN and when it recovers from a DOWN state. + +
notifications_enabled *: + +This directive is used to determine whether or not notifications for this host are enabled. Values: 0 = disable host notifications, 1 = enable host notifications. + +
stalking_options: + +This directive determines which host states "stalking" is enabled for. Valid options are a combination of one or more of the following: o = stalk on UP states, d = stalk on DOWN states, and u = stalk on UNREACHABLE states. More information on state stalking can be found here. + +
notes: + +This directive is used to define an optional string of notes pertaining to the host. If you specify a note here, you will see the it in the extended information CGI (when you are viewing information about the specified host). + +
notes_url: + +This variable is used to define an optional URL that can be used to provide more information about the host. If you specify an URL, you will see a red folder icon in the CGIs (when you are viewing host information) that links to the URL you specify here. Any valid URL can be used. If you plan on using relative paths, the base path will the the same as what is used to access the CGIs (i.e. /cgi-bin/nagios/). This can be very useful if you want to make detailed information on the host, emergency contact methods, etc. available to other support staff. + +
action_url: + +This directive is used to define an optional URL that can be used to provide more actions to be performed on the host. If you specify an URL, you will see a red "splat" icon in the CGIs (when you are viewing host information) that links to the URL you specify here. Any valid URL can be used. If you plan on using relative paths, the base path will the the same as what is used to access the CGIs (i.e. /cgi-bin/nagios/). + +
icon_image: + +This variable is used to define the name of a GIF, PNG, or JPG image that should be associated with this host. This image will be displayed in the various places in the CGIs. The image will look best if it is 40x40 pixels in size. Images for hosts are assumed to be in the logos/ subdirectory in your HTML images directory (i.e. /usr/local/nagios/share/images/logos). + +
icon_image_alt: + +This variable is used to define an optional string that is used in the ALT tag of the image specified by the <icon_image> argument. + +
vrml_image: + +This variable is used to define the name of a GIF, PNG, or JPG image that should be associated with this host. This image will be used as the texture map for the specified host in the statuswrl CGI. Unlike the image you use for the <icon_image> variable, this one should probably not have any transparency. If it does, the host object will look a bit wierd. Images for hosts are assumed to be in the logos/ subdirectory in your HTML images directory (i.e. /usr/local/nagios/share/images/logos). + +
statusmap_image: + +This variable is used to define the name of an image that should be associated with this host in the statusmap CGI. You can specify a JPEG, PNG, and GIF image if you want, although I would strongly suggest using a GD2 format image, as other image formats will result in a lot of wasted CPU time when the statusmap image is generated. GD2 images can be created from PNG images by using the pngtogd2 utility supplied with Thomas Boutell's gd library. The GD2 images should be created in uncompressed format in order to minimize CPU load when the statusmap CGI is generating the network map image. The image will look best if it is 40x40 pixels in size. You can leave these option blank if you are not using the statusmap CGI. Images for hosts are assumed to be in the logos/ subdirectory in your HTML images directory (i.e. /usr/local/nagios/share/images/logos). + +
2d_coords: + +This variable is used to define coordinates to use when drawing the host in the statusmap CGI. Coordinates should be given in positive integers, as they correspond to physical pixels in the generated image. The origin for drawing (0,0) is in the upper left hand corner of the image and extends in the positive x direction (to the right) along the top of the image and in the positive y direction (down) along the left hand side of the image. For reference, the size of the icons drawn is usually about 40x40 pixels (text takes a little extra space). The coordinates you specify here are for the upper left hand corner of the host icon that is drawn. Note: Don't worry about what the maximum x and y coordinates that you can use are. The CGI will automatically calculate the maximum dimensions of the image it creates based on the largest x and y coordinates you specify. + +
3d_coords: + +This variable is used to define coordinates to use when drawing the host in the statuswrl CGI. Coordinates can be positive or negative real numbers. The origin for drawing is (0.0,0.0,0.0). For reference, the size of the host cubes drawn is 0.5 units on each side (text takes a little more space). The coordinates you specify here are used as the center of the host cube. + +
+ + + + + +

+ + + + + + + + + + + +
Host Group Definition
+ + + +

Description:

+ +

+ +A host group definition is used to group one or more hosts together for simplifying configuration with object tricks or display purposes in the CGIs. + +

+ + + +

Definition Format:

+ +

+ +Note: Directives in red are required, while those in black are optional. + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
define hostgroup{
hostgroup_namehostgroup_name
aliasalias
membershosts
hostgroup_membershostgroups
notesnote_string
notes_urlurl
action_urlurl
   }
+ + + +

Example Definition:

+ +
+
+define hostgroup{
+
+	hostgroup_name		novell-servers
+
+	alias			Novell Servers
+
+	members			netware1,netware2,netware3,netware4
+
+	}
+
+
+ + + +

Directive Descriptions:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
hostgroup_name: + +This directive is used to define a short name used to identify the host group. + +
alias: + +This directive is used to define is a longer name or description used to identify the host group. It is provided in order to allow you to more easily identify a particular host group. + +
members: + +This is a list of the short names of hosts that should be included in this group. Multiple host names should be separated by commas. This directive may be used as an alternative to (or in addition to) the hostgroups directive in host definitions. + +
hostgroup_members: + +This optional directive can be used to include hosts from other "sub" host groups in this host group. Specify a comma-delimited list of short names of other host groups whose members should be included in this group. + +
notes: + +This directive is used to define an optional string of notes pertaining to the host. If you specify a note here, you will see the it in the extended information CGI (when you are viewing information about the specified host). + +
notes_url: + +This variable is used to define an optional URL that can be used to provide more information about the host group. If you specify an URL, you will see a red folder icon in the CGIs (when you are viewing hostgroup information) that links to the URL you specify here. Any valid URL can be used. If you plan on using relative paths, the base path will the the same as what is used to access the CGIs (i.e. /cgi-bin/nagios/). This can be very useful if you want to make detailed information on the host group, emergency contact methods, etc. available to other support staff. + +
action_url: + +This directive is used to define an optional URL that can be used to provide more actions to be performed on the host group. If you specify an URL, you will see a red "splat" icon in the CGIs (when you are viewing hostgroup information) that links to the URL you specify here. Any valid URL can be used. If you plan on using relative paths, the base path will the the same as what is used to access the CGIs (i.e. /cgi-bin/nagios/). + +
+ + + + + +

+ + + + + + + + + + + +
Service Definition
+ + + +

Description:

+ +

+ +A service definition is used to identify a "service" that runs on a host. The term "service" is used very loosely. It can mean an actual service that runs on the host (POP, SMTP, HTTP, etc.) or some other type of metric associated with the host (response to a ping, number of logged in users, free disk space, etc.). The different arguments to a service definition are outlined below. + +

+ + + +

Definition Format:

+ +

+ +Note: Directives in red are required, while those in black are optional. + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
define service{
host_namehost_name
hostgroup_namehostgroup_name
service_descriptionservice_description
display_namedisplay_name
servicegroupsservicegroup_names
is_volatile[0/1]
check_commandcommand_name
initial_state[o,w,u,c]
max_check_attempts#
check_interval#
retry_interval#
active_checks_enabled[0/1]
passive_checks_enabled[0/1]
check_periodtimeperiod_name
obsess_over_service[0/1]
check_freshness[0/1]
freshness_threshold#
event_handlercommand_name
event_handler_enabled[0/1]
low_flap_threshold#
high_flap_threshold#
flap_detection_enabled[0/1]
flap_detection_options[o,w,c,u]
process_perf_data[0/1]
retain_status_information[0/1]
retain_nonstatus_information[0/1]
notification_interval#
first_notification_delay#
notification_periodtimeperiod_name
notification_options[w,u,c,r,f,s]
notifications_enabled[0/1]
contactscontacts
contact_groupscontact_groups
stalking_options[o,w,u,c]
notesnote_string
notes_urlurl
action_urlurl
icon_imageimage_file
icon_image_altalt_string
   }
+ + + +

Example Definition:

+ +
+
+define service{
+
+	host_name		linux-server
+
+	service_description	check-disk-sda1
+
+	check_command		check-disk!/dev/sda1
+
+	max_check_attempts	5
+
+	check_interval	5
+
+	retry_interval	3
+
+	check_period		24x7
+
+	notification_interval	30
+
+	notification_period	24x7
+
+	notification_options	w,c,r
+
+	contact_groups		linux-admins
+
+	}
+
+
+ + + +

Directive Descriptions:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
host_name: + +This directive is used to specify the short name(s) of the host(s) that the service "runs" on or is associated with. Multiple hosts should be separated by commas. + +
hostgroup_name: + +This directive is used to specify the short name(s) of the hostgroup(s) that the service "runs" on or is associated with. Multiple hostgroups should be separated by commas. The hostgroup_name may be used instead of, or in addition to, the host_name directive. + +
service_description;: + +This directive is used to define the description of the service, which may contain spaces, dashes, and colons (semicolons, apostrophes, and quotation marks should be avoided). No two services associated with the same host can have the same description. Services are uniquely identified with their host_name and service_description directives. + +
display_name: + +This directive is used to define an alternate name that should be displayed in the web interface for this service. If not specified, this defaults to the value you specify for the service_description directive. Note: The current CGIs do not use this option, although future versions of the web interface will. + +
servicegroups: + +This directive is used to identify the short name(s) of the servicegroup(s) that the service belongs to. Multiple servicegroups should be separated by commas. This directive may be used as an alternative to using the members directive in servicegroup definitions. + +
is_volatile: + +This directive is used to denote whether the service is "volatile". Services are normally not volatile. More information on volatile service and how they differ from normal services can be found here. Value: 0 = service is not volatile, 1 = service is volatile. + +
check_command: + +

+ +This directive is used to specify the short name of the command that Nagios will run in order to check the status of the service. The maximum amount of time that the service check command can run is controlled by the service_check_timeout option.

+ +
initial_state: + +By default Nagios will assume that all services are in OK states when it starts. You can override the initial state for a service by using this directive. Valid options are: o = OK, w = WARNING, u = UNKNOWN, and c = CRITICAL. + +
max_check_attempts: + +This directive is used to define the number of times that Nagios will retry the service check command if it returns any state other than an OK state. Setting this value to 1 will cause Nagios to generate an alert without retrying the service check again. + +
check_interval: + +This directive is used to define the number of "time units" to wait before scheduling the next "regular" check of the service. "Regular" checks are those that occur when the service is in an OK state or when the service is in a non-OK state, but has already been rechecked max_check_attempts number of times. Unless you've changed the interval_length directive from the default value of 60, this number will mean minutes. More information on this value can be found in the check scheduling documentation. + +
retry_interval: + +This directive is used to define the number of "time units" to wait before scheduling a re-check of the service. Services are rescheduled at the retry interval when they have changed to a non-OK state. Once the service has been retried max_check_attempts times without a change in its status, it will revert to being scheduled at its "normal" rate as defined by the check_interval value. Unless you've changed the interval_length directive from the default value of 60, this number will mean minutes. More information on this value can be found in the check scheduling documentation. + +
active_checks_enabled *: + +This directive is used to determine whether or not active checks of this service are enabled. Values: 0 = disable active service checks, 1 = enable active service checks (default). + +
passive_checks_enabled *: + +This directive is used to determine whether or not passive checks of this service are enabled. Values: 0 = disable passive service checks, 1 = enable passive service checks (default). + +
check_period: + +This directive is used to specify the short name of the time period during which active checks of this service can be made. + +
obsess_over_service *: + +This directive determines whether or not checks for the service will be "obsessed" over using the ocsp_command. + +
check_freshness *: + +This directive is used to determine whether or not freshness checks are enabled for this service. Values: 0 = disable freshness checks, 1 = enable freshness checks (default). + +
freshness_threshold: + +This directive is used to specify the freshness threshold (in seconds) for this service. If you set this directive to a value of 0, Nagios will determine a freshness threshold to use automatically. + +
event_handler: + +This directive is used to specify the short name of the command that should be run whenever a change in the state of the service is detected (i.e. whenever it goes down or recovers). Read the documentation on + +event handlers for a more detailed explanation of how to write scripts for handling events. The maximum amount of time that the event handler command can run is controlled by the event_handler_timeout option. + +
event_handler_enabled *: + +This directive is used to determine whether or not the event handler for this service is enabled. Values: 0 = disable service event handler, 1 = enable service event handler. + +
low_flap_threshold: + +This directive is used to specify the low state change threshold used in flap detection for this service. More information on flap detection can be found here. If you set this directive to a value of 0, the program-wide value specified by the low_service_flap_threshold directive will be used. + +
high_flap_threshold: + +This directive is used to specify the high state change threshold used in flap detection for this service. More information on flap detection can be found here. If you set this directive to a value of 0, the program-wide value specified by the high_service_flap_threshold directive will be used. + +
flap_detection_enabled *: + +This directive is used to determine whether or not flap detection is enabled for this service. More information on flap detection can be found here. Values: 0 = disable service flap detection, 1 = enable service flap detection. + +
flap_detection_options: + +This directive is used to determine what service states the flap detection logic will use for this service. Valid options are a combination of one or more of the following: o = OK states, w = WARNING states, c = CRITICAL states, u = UNKNOWN states. + +
process_perf_data *: + +This directive is used to determine whether or not the processing of performance data is enabled for this service. Values: 0 = disable performance data processing, 1 = enable performance data processing. + +
retain_status_information: + +This directive is used to determine whether or not status-related information about the service is retained across program restarts. This is only useful if you have enabled state retention using the retain_state_information directive. Value: 0 = disable status information retention, 1 = enable status information retention. + +
retain_nonstatus_information: + +This directive is used to determine whether or not non-status information about the service is retained across program restarts. This is only useful if you have enabled state retention using the retain_state_information directive. Value: 0 = disable non-status information retention, 1 = enable non-status information retention. + +
notification_interval: + +This directive is used to define the number of "time units" to wait before re-notifying a contact that this service is still in a non-OK state. Unless you've changed the interval_length directive from the default value of 60, this number will mean minutes. If you set this value to 0, Nagios will not re-notify contacts about problems for this service - only one problem notification will be sent out. + +
first_notification_delay: + +This directive is used to define the number of "time units" to wait before sending out the first problem notification when this service enters a non-OK state. Unless you've changed the interval_length directive from the default value of 60, this number will mean minutes. If you set this value to 0, Nagios will start sending out notifications immediately. + +
notification_period: + +This directive is used to specify the short name of the time period during which notifications of events for this service can be sent out to contacts. No service notifications will be sent out during times which is not covered by the time period. + +
notification_options: + +This directive is used to determine when notifications for the service should be sent out. Valid options are a combination of one or more of the following: w = send notifications on a WARNING state, u = send notifications on an UNKNOWN state, c = send notifications on a CRITICAL state, r = send notifications on recoveries (OK state), f = send notifications when the service starts and stops flapping, and s = send notifications when scheduled downtime starts and ends. If you specify n (none) as an option, no service notifications will be sent out. If you do not specify any notification options, Nagios will assume that you want notifications to be sent out for all possible states. Example: If you specify w,r in this field, notifications will only be sent out when the service goes into a WARNING state and when it recovers from a WARNING state. + +
notifications_enabled *: + +This directive is used to determine whether or not notifications for this service are enabled. Values: 0 = disable service notifications, 1 = enable service notifications. + +
contacts: + +This is a list of the short names of the contacts that should be notified whenever there are problems (or recoveries) with this service. Multiple contacts should be separated by commas. Useful if you want notifications to go to just a few people and don't want to configure contact groups. You must specify at least one contact or contact group in each service definition. + +
contact_groups: + +This is a list of the short names of the contact groups that should be notified whenever there are problems (or recoveries) with this service. Multiple contact groups should be separated by commas. You must specify at least one contact or contact group in each service definition. + +
stalking_options: + +This directive determines which service states "stalking" is enabled for. Valid options are a combination of one or more of the following: o = stalk on OK states, w = stalk on WARNING states, u = stalk on UNKNOWN states, and c = stalk on CRITICAL states. More information on state stalking can be found here. + +
notes: + +This directive is used to define an optional string of notes pertaining to the service. If you specify a note here, you will see the it in the extended information CGI (when you are viewing information about the specified service). + +
notes_url: + +This directive is used to define an optional URL that can be used to provide more information about the service. If you specify an URL, you will see a red folder icon in the CGIs (when you are viewing service information) that links to the URL you specify here. Any valid URL can be used. If you plan on using relative paths, the base path will the the same as what is used to access the CGIs (i.e. /cgi-bin/nagios/). This can be very useful if you want to make detailed information on the service, emergency contact methods, etc. available to other support staff. + +
action_url: + +This directive is used to define an optional URL that can be used to provide more actions to be performed on the service. If you specify an URL, you will see a red "splat" icon in the CGIs (when you are viewing service information) that links to the URL you specify here. Any valid URL can be used. If you plan on using relative paths, the base path will the the same as what is used to access the CGIs (i.e. /cgi-bin/nagios/). + +
icon_image: + +This variable is used to define the name of a GIF, PNG, or JPG image that should be associated with this service. This image will be displayed in the status and extended information CGIs. The image will look best if it is 40x40 pixels in size. Images for services are assumed to be in the logos/ subdirectory in your HTML images directory (i.e. /usr/local/nagios/share/images/logos). + +
icon_image_alt: + +This variable is used to define an optional string that is used in the ALT tag of the image specified by the <icon_image> argument. The ALT tag is used in the status, extended information and statusmap CGIs. + +
+ + + + + + + + + +

+ + + + + + + + + + + +
Service Group Definition
+ + + +

Description:

+ +

+ +A service group definition is used to group one or more services together for simplifying configuration with object tricks or display purposes in the CGIs. + +

+ + + +

Definition Format:

+ +

+ +Note: Directives in red are required, while those in black are optional. + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
define servicegroup{
servicegroup_nameservicegroup_name
aliasalias
membersservices
servicegroup_membersservicegroups
notesnote_string
notes_urlurl
action_urlurl
   }
+ + + +

Example Definition:

+ +
+
+define servicegroup{
+
+	servicegroup_name	dbservices
+
+	alias			Database Services
+
+	members			ms1,SQL Server,ms1,SQL Server Agent,ms1,SQL DTC
+
+	}
+
+
+ + + +

Directive Descriptions:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
servicegroup_name: + +This directive is used to define a short name used to identify the service group. + +
alias: + +This directive is used to define is a longer name or description used to identify the service group. It is provided in order to allow you to more easily identify a particular service group. + +
members: + +

+ +This is a list of the descriptions of services (and the names of their corresponding hosts) that should be included in this group. Host and service names should be separated by commas. This directive may be used as an alternative to the servicegroups directive in service definitions. The format of the member directive is as follows (note that a host name must precede a service name/description): + +

+ +

+ +members=<host1>,<service1>,<host2>,<service2>,...,<hostn>,<servicen> + +

+ +
servicegroup_members: + +This optional directive can be used to include services from other "sub" service groups in this service group. Specify a comma-delimited list of short names of other service groups whose members should be included in this group. + +
notes: + +This directive is used to define an optional string of notes pertaining to the service group. If you specify a note here, you will see the it in the extended information CGI (when you are viewing information about the specified service group). + +
notes_url: + +This directive is used to define an optional URL that can be used to provide more information about the service group. If you specify an URL, you will see a red folder icon in the CGIs (when you are viewing service group information) that links to the URL you specify here. Any valid URL can be used. If you plan on using relative paths, the base path will the the same as what is used to access the CGIs (i.e. /cgi-bin/nagios/). This can be very useful if you want to make detailed information on the service group, emergency contact methods, etc. available to other support staff. + +
action_url: + +This directive is used to define an optional URL that can be used to provide more actions to be performed on the service group. If you specify an URL, you will see a red "splat" icon in the CGIs (when you are viewing service group information) that links to the URL you specify here. Any valid URL can be used. If you plan on using relative paths, the base path will the the same as what is used to access the CGIs (i.e. /cgi-bin/nagios/). + +
+ + + + + + + + + +

+ + + + + + + + + + + +
Contact Definition
+ + + +

Description:

+ +

+ +A contact definition is used to identify someone who should be contacted in the event of a problem on your network. + +The different arguments to a contact definition are described below. + +

+ + + +

Definition Format:

+ +

+ +Note: Directives in red are required, while those in black are optional. + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
define contact{
contact_namecontact_name
aliasalias
contactgroupscontactgroup_names
host_notifications_enabled[0/1]
service_notifications_enabled[0/1]
host_notification_periodtimeperiod_name
service_notification_periodtimeperiod_name
host_notification_options[d,u,r,f,s,n]
service_notification_options[w,u,c,r,f,s,n]
host_notification_commandscommand_name
service_notification_commandscommand_name
emailemail_address
pagerpager_number or pager_email_gateway
addressxadditional_contact_address
can_submit_commands[0/1]
retain_status_information[0/1]
retain_nonstatus_information[0/1]
   }
+ + + +

Example Definition:

+ +
+
+define contact{
+
+	contact_name                    jdoe
+
+	alias                           John Doe
+
+	host_notifications_enabled		1
+
+	service_notifications_enabled	1
+
+	service_notification_period     24x7
+
+	host_notification_period        24x7
+
+	service_notification_options    w,u,c,r
+
+	host_notification_options       d,u,r
+
+	service_notification_commands   notify-by-email
+
+	host_notification_commands      host-notify-by-email
+
+	email			jdoe@localhost.localdomain
+
+	pager			555-5555@pagergateway.localhost.localdomain
+
+	address1			xxxxx.xyyy@icq.com
+
+	address2			555-555-5555
+
+	can_submit_commands	1
+
+	}
+
+
+ + + +

Directive Descriptions:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
contact_name: + +This directive is used to define a short name used to identify the contact. It is referenced in contact group definitions. Under the right circumstances, the $CONTACTNAME$ macro will contain this + +value. + +
alias: + +This directive is used to define a longer name or description for the contact. Under the rights circumstances, the $CONTACTALIAS$ macro will contain this value. If not specified, the contact_name will be used as the alias. + +
contactgroups: + +This directive is used to identify the short name(s) of the contactgroup(s) that the contact belongs to. Multiple contactgroups should be separated by commas. This directive may be used as an alternative to (or in addition to) using the members directive in contactgroup definitions. + +
host_notifications_enabled: + +This directive is used to determine whether or not the contact will receive notifications about host problems and recoveries. Values: 0 = don't send notifications, 1 = send notifications. + +
service_notifications_enabled: + +This directive is used to determine whether or not the contact will receive notifications about service problems and recoveries. Values: 0 = don't send notifications, 1 = send notifications. + +
host_notification_period: + +This directive is used to specify the short name of the time period during which the contact can be notified about host problems or recoveries. You can think of this as an "on call" time for host notifications for the contact. Read the documentation on time periods for more information on how this works and potential problems that may result from improper use. + +
service_notification_period: + +This directive is used to specify the short name of the time period during which the contact can be notified about service problems or recoveries. You can think of this as an "on call" time for service notifications for the contact. Read the documentation on time periods for more information on how this works and potential problems that may result from improper use. + +
host_notification_commands: + +This directive is used to define a list of the short names of the commands used to notify the contact of a host problem or recovery. Multiple notification commands should be separated by commas. All + +notification commands are executed when the contact needs to be notified. The maximum amount of time that a notification command can run is controlled by the notification_timeout option. + +
host_notification_options: + +This directive is used to define the host states for which notifications can be sent out to this contact. Valid options are a combination of one or more of the following: d = notify on DOWN host states, u = notify on UNREACHABLE host states, r = notify on host recoveries (UP states), f = notify when the host starts and stops flapping, and s = send notifications when host or service scheduled downtime starts and ends. If you specify n (none) as an option, the contact will not receive any type of host notifications. + +
service_notification_options: + +This directive is used to define the service states for which notifications can be sent out to this contact. Valid options are a combination of one or more of the following: w = notify on WARNING service states, u = notify on UNKNOWN service states, c = notify on CRITICAL service states, r = notify on service recoveries (OK states), and f = notify when the service starts and stops flapping. If you specify n (none) as an option, the contact will not receive any type of service notifications. + +
service_notification_commands: + +This directive is used to define a list of the short names of the commands used to notify the contact of a service problem or recovery. Multiple notification commands should be separated by commas. All + +notification commands are executed when the contact needs to be notified. The maximum amount of time that a notification command can run is controlled by the notification_timeout option. + +
email: + +This directive is used to define an email address for the contact. Depending on how you configure your notification commands, it can be used to send out an alert email to the contact. Under the right circumstances, the $CONTACTEMAIL$ + +macro will contain this value. + +
pager: + +This directive is used to define a pager number for the contact. It can also be an email address to a pager gateway + +(i.e. pagejoe@pagenet.com). Depending on how you configure your notification commands, it can be used to send out an alert page to the contact. Under the right circumstances, the $CONTACTPAGER$ macro will contain this value. + +
addressx: + +Address directives are used to define additional "addresses" for the contact. These addresses can be anything - cell phone numbers, instant messaging addresses, etc. Depending on how you configure your notification commands, they can be used to send out an alert to the contact. Up to six addresses can be defined using these directives (address1 through address6). The $CONTACTADDRESSx$ macro will contain this value. + +
can_submit_commands: + +This directive is used to determine whether or not the contact can submit external commands to Nagios from the CGIs. Values: 0 = don't allow contact to submit commands, 1 = allow contact to submit commands. + +
retain_status_information: + +This directive is used to determine whether or not status-related information about the contact is retained across program restarts. This is only useful if you have enabled state retention using the retain_state_information directive. Value: 0 = disable status information retention, 1 = enable status information retention. + +
retain_nonstatus_information: + +This directive is used to determine whether or not non-status information about the contact is retained across program restarts. This is only useful if you have enabled state retention using the retain_state_information directive. Value: 0 = disable non-status information retention, 1 = enable non-status information retention. + +
+ + + + + +

+ + + + + + + + + + + +
Contact Group Definition
+ + + +

Description:

+ +

+ +A contact group definition is used to group one or more contacts together for the purpose of sending out alert/recovery notifications. + +

+ + + +

Definition Format:

+ +

+ +Note: Directives in red are required, while those in black are optional. + +

+ + + + + + + + + + + + + + + + + + + + + +
define contactgroup{
contactgroup_namecontactgroup_name
aliasalias
memberscontacts
contactgroup_memberscontactgroups
   }
+ + + +

Example Definition:

+ +
+
+define contactgroup{
+
+	contactgroup_name		novell-admins
+
+	alias			Novell Administrators
+
+	members			jdoe,rtobert,tzach
+
+	}
+
+
+ + + +

Directive Descriptions:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
contactgroup_name: + +This directive is a short name used to identify the contact group. + +
alias: + +This directive is used to define a longer name or description used to identify the contact group. + +
members: + +This optional directive is used to define a list of the short names of contacts that should be included in this group. Multiple contact names should be separated by commas. This directive may be used as an alternative to (or in addition to) using the contactgroups directive in contact definitions. + +
contactgroup_members: + +This optional directive can be used to include contacts from other "sub" contact groups in this contact group. Specify a comma-delimited list of short names of other contact groups whose members should be included in this group. + +
+ + + + + + + +

+ + + + + + + + + + + +
Time Period Definition
+ + + +

Description:

+ +

+ +A time period is a list of times during various days that are considered to be "valid" times for notifications and service checks. It consists of time ranges for each day of the week that "rotate" once the week has come to an end. Different types of exceptions to the normal weekly time are supported, including: specific weekdays, days of generic months, days of specific months, and calendar dates. + +

+ + + + + +

Definition Format:

+ +

+ +Note: Directives in red are required, while those in black are optional. + +

+ + + + + + + + + + + + + + + + + + + + + + + +
define timeperiod{
timeperiod_nametimeperiod_name
aliasalias
[weekday]timeranges
[exception]timeranges
exclude[timeperiod1,timeperiod2,...,timeperiodn]
   }
+ + + +

Example Definitions:

+ +
+
+define timeperiod{
+
+	timeperiod_name		nonworkhours
+
+	alias			Non-Work Hours
+
+	sunday			00:00-24:00			; Every Sunday of every week
+
+	monday			00:00-09:00,17:00-24:00		; Every Monday of every week
+
+	tuesday			00:00-09:00,17:00-24:00		; Every Tuesday of every week
+
+	wednesday			00:00-09:00,17:00-24:00		; Every Wednesday of every week
+
+	thursday			00:00-09:00,17:00-24:00		; Every Thursday of every week
+
+	friday			00:00-09:00,17:00-24:00		; Every Friday of every week
+
+	saturday			00:00-24:00			; Every Saturday of every week
+
+	}
+
+
+
+define timeperiod{
+
+	timeperiod_name		misc-single-days
+
+	alias			Misc Single Days
+
+	1999-01-28		00:00-24:00 		; January 28th, 1999
+
+	monday 3			00:00-24:00		; 3rd Monday of every month
+
+	day 2			00:00-24:00		; 2nd day of every month
+
+	february 10		00:00-24:00		; February 10th of every year
+
+	february -1		00:00-24:00		; Last day in February of every year
+
+	friday -2			00:00-24:00		; 2nd to last Friday of every month
+
+	thursday -1 november	00:00-24:00		; Last Thursday in November of every year
+
+	}
+
+	
+
+define timeperiod{
+
+	timeperiod_name		misc-date-ranges
+
+	alias			Misc Date Ranges
+
+	2007-01-01 - 2008-02-01	00:00-24:00		; January 1st, 2007 to February 1st, 2008
+
+	monday 3 - thursday 4	00:00-24:00		; 3rd Monday to 4th Thursday of every month
+
+	day 1 - 15		00:00-24:00		; 1st to 15th day of every month
+
+	day 20 - -1		00:00-24:00		; 20th to the last day of every month
+
+	july 10 - 15		00:00-24:00		; July 10th to July 15th of every year
+
+	april 10 - may 15		00:00-24:00		; April 10th to May 15th of every year
+
+	tuesday 1 april - friday 2 may	00:00-24:00	; 1st Tuesday in April to 2nd Friday in May of every year
+
+	}
+
+
+
+define timeperiod{
+
+	timeperiod_name		misc-skip-ranges
+
+	alias			Misc Skip Ranges
+
+	2007-01-01 - 2008-02-01 / 3		00:00-24:00	; Every 3 days from January 1st, 2007 to February 1st, 2008
+
+	2008-04-01 / 7			00:00-24:00	; Every 7 days from April 1st, 2008 (continuing forever)
+
+	monday 3 - thursday 4 / 2		00:00-24:00	; Every other day from 3rd Monday to 4th Thursday of every month
+
+	day 1 - 15 / 5			00:00-24:00	; Every 5 days from the 1st to the 15th day of every month
+
+	july 10 - 15 / 2			00:00-24:00	; Every other day from July 10th to July 15th of every year
+
+	tuesday 1 april - friday 2 may / 6	00:00-24:00	; Every 6 days from the 1st Tuesday in April to the 2nd Friday in May of every year
+
+	}
+
+
+ + + +

Directive Descriptions:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
timeperiod_name: + +This directives is the short name used to identify the time period. + +
alias: + +This directive is a longer name or description used to identify the time period. + +
[weekday]: + +The weekday directives ("sunday" through "saturday")are comma-delimited lists of time ranges that are "valid" times for a particular day of the week. Notice that there are seven different days for which you can define time ranges (Sunday through Saturday). Each time range is in the form of HH:MM-HH:MM, where hours are specified on a 24 hour clock. For example, 00:15-24:00 means 12:15am in the morning for this day until 12:00am midnight (a 23 hour, 45 minute total time range). If you wish to exclude an entire day from the timeperiod, simply do not include it in the timeperiod definition. + +
[exception]: + +

+ +You can specify several different types of exceptions to the standard rotating weekday schedule. Exceptions can take a number of different forms including single days of a specific or generic month, single weekdays in a month, or single calendar dates. You can also specify a range of days/dates and even specify skip intervals to obtain functionality described by "every 3 days between these dates". Rather than list all the possible formats for exception strings, I'll let you look at the example timeperiod definitions above to see what's possible. :-) Weekdays and different types of exceptions all have different levels of precedence, so its important to understand how they can affect each other. More information on this can be found in the documentation on timeperiods. + +

+ +
exclude: + +This directive is used to specify the short names of other timeperiod definitions whose time ranges should be excluded from this timeperiod. Multiple timeperiod names should be separated with a comma. + +
+ + + + + + + +

+ + + + + + + + + + + +
Command Definition
+ + + +

Description:

+ +

+ +A command definition is just that. It defines a command. Commands that can be defined include service checks, service notifications, service event handlers, host checks, host notifications, and host event handlers. Command definitions can contain macros, but you must make sure that you include only those macros that are "valid" for the circumstances when the command will be used. More information on what macros are available and when they are "valid" can be found here. The different arguments to a command definition are outlined below. + +

+ + + +

Definition Format:

+ +

+ +Note: Directives in red are required, while those in black are optional. + +

+ + + + + + + + + + + + + + + + + +
define command{
command_namecommand_name
command_linecommand_line
   }
+ + + +

Example Definition:

+ +
+
+define command{
+
+	command_name	check_pop
+
+	command_line	/usr/local/nagios/libexec/check_pop -H $HOSTADDRESS$	
+
+	}
+
+
+ + + +

Directive Descriptions:

+ + + + + + + + + + + + + + + + + + + + + +
command_name: + +This directive is the short name used to identify the command. It is referenced in contact, host, and service definitions (in notification, check, and event handler directives), among other places. + +
command_line: + +

+ +This directive is used to define what is actually executed by Nagios when the command is used for service or host checks, notifications, or event handlers. Before the command line is executed, all valid macros are replaced with their respective values. See the documentation on macros for determining when you can use different macros. Note that the command line is not surrounded in quotes. Also, if you want to pass a dollar sign ($) on the command line, you have to escape it with another dollar sign. + +

+ +

NOTE: You may not include a semicolon (;) in the command_line directive, because everything after it will be ignored as a config file comment. You can work around this limitation by setting one of the $USER$ macros in your resource file to a semicolon and then referencing the appropriate $USER$ macro in the command_line directive in place of the semicolon. + +

+ +

+ +If you want to pass arguments to commands during runtime, you can use $ARGn$ macros in the command_line directive of the command definition and then separate individual arguments from the command name (and from each other) using bang (!) characters in the object definition directive (host check command, service event handler command, etc) that references the command. More information on how arguments in command definitions are processed during runtime can be found in the documentation on macros. + +

+ +
+ + + + + + + +

+ + + + + + + + + + + +
Service Dependency Definition
+ + + +

Description:

+ +

+ +Service dependencies are an advanced feature of Nagios that allow you to suppress notifications and active checks of services based on the status of one or more other services. Service dependencies are optional and are mainly targeted at advanced users who have complicated monitoring setups. More information on how service dependencies work (read this!) can be found here. + +

+ + + +

Definition Format:

+ +

+ +Note: Directives in red are required, while those in black are optional. However, you must supply at least one type of criteria for the definition to be of much use. + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
define servicedependency{
dependent_host_namehost_name
dependent_hostgroup_namehostgroup_name
dependent_service_descriptionservice_description
host_namehost_name
hostgroup_namehostgroup_name
service_descriptionservice_description
inherits_parent[0/1]
execution_failure_criteria[o,w,u,c,p,n]
notification_failure_criteria[o,w,u,c,p,n]
dependency_periodtimeperiod_name
   }
+ + + +

Example Definition:

+ +
+
+define servicedependency{
+
+	host_name			WWW1
+
+	service_description		Apache Web Server
+
+	dependent_host_name		WWW1
+
+	dependent_service_description	Main Web Site
+
+	execution_failure_criteria	n
+
+	notification_failure_criteria	w,u,c
+
+	}
+
+
+ + + +

Directive Descriptions:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
dependent_host_name: + +This directive is used to identify the short name(s) of the host(s) that the dependent service "runs" on or is associated with. Multiple hosts should be separated by commas. Leaving this directive blank can be used to create "same host" dependencies. + +
dependent_hostgroup_name: + +This directive is used to specify the short name(s) of the hostgroup(s) that the dependent service "runs" on or is associated with. Multiple hostgroups should be separated by commas. The dependent_hostgroup may be used instead of, or in addition to, the dependent_host directive. + +
dependent_service_description: + +This directive is used to identify the description of the dependent service. + +
host_name: + +This directive is used to identify the short name(s) of the host(s) that the service that is being depended upon (also referred to as the master service) "runs" on or is associated with. Multiple hosts should be separated by commas. + +
hostgroup_name: + +This directive is used to identify the short name(s) of the hostgroup(s) that the service that is being depended upon (also referred to as the master service) "runs" on or is associated with. Multiple hostgroups should be separated by commas. The hostgroup_name may be used instead of, or in addition to, the host_name directive. + +
service_description: + +This directive is used to identify the description of the service that is being depended upon (also referred to as the master service). + +
inherits_parent: + +This directive indicates whether or not the dependency inherits dependencies of the service that is being depended upon (also referred to as the master service). In other words, if the master service is dependent upon other services and any one of those dependencies fail, this dependency will also fail. + +
execution_failure_criteria: + +This directive is used to specify the criteria that determine when the dependent service should not be actively checked. If the master service is in one of the failure states we specify, the dependent service will not be actively checked. Valid options are a combination of one or more of the following (multiple options are separated with commas): o = fail on an OK state, w = fail on a WARNING state, u = fail on an UNKNOWN state, c = fail on a CRITICAL state, and p = fail on a pending state (e.g. the service has not yet been checked). If you specify n (none) as an option, the execution dependency will never fail and checks of the dependent service will always be actively checked (if other conditions allow for it to be). Example: If you specify o,c,u in this field, the dependent service will not be actively checked if the master service is in either an OK, a CRITICAL, or an UNKNOWN state. + +
notification_failure_criteria: + +This directive is used to define the criteria that determine when notifications for the dependent service should not be sent out. If the master service is in one of the failure states we specify, notifications for the dependent service will not be sent to contacts. Valid options are a combination of one or more of the following: o = fail on an OK state, w = fail on a WARNING state, u = fail on an UNKNOWN state, c = fail on a CRITICAL state, and p = fail on a pending state (e.g. the service has not yet been checked). If you specify n (none) as an option, the notification dependency will never fail and notifications for the dependent service will always be sent out. Example: If you specify w in this field, the notifications for the dependent service will not be sent out if the master service is in a WARNING state. + +
dependency_period: + +This directive is used to specify the short name of the time period during which this dependency is valid. If this directive is not specified, the dependency is considered to be valid during all times. + +
+ + + + + + + +

+ + + + + + + + + + + +
Service Escalation Definition
+ + + +

Description:

+ +

+ +Service escalations are completely optional and are used to escalate notifications for a particular service. More information on how notification escalations work can be found here. + +

+ + + +

Definition Format:

+ +

+ +Note: Directives in red are required, while those in black are optional. + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
define serviceescalation{
host_namehost_name
hostgroup_namehostgroup_name
service_descriptionservice_description
contactscontacts
contact_groupscontactgroup_name
first_notification#
last_notification#
notification_interval#
escalation_periodtimeperiod_name
escalation_options[w,u,c,r]
   }
+ + + +

Example Definition:

+ +
+
+define serviceescalation{
+
+	host_name		nt-3
+
+	service_description	Processor Load
+
+	first_notification	4
+
+	last_notification	0
+
+	notification_interval	30
+
+	contact_groups		all-nt-admins,themanagers
+
+	}
+
+
+ + + +

Directive Descriptions:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
host_name: + +This directive is used to identify the short name(s) of the host(s) that the service escalation should apply to or is associated with. + +
hostgroup_name: + +This directive is used to specify the short name(s) of the hostgroup(s) that the service escalation should apply to or is associated with. Multiple hostgroups should be separated by commas. The hostgroup_name may be used instead of, or in addition to, the host_name directive. + +
service_description: + +This directive is used to identify the description of the service the escalation should apply to. + +
first_notification: + +This directive is a number that identifies the first notification for which this escalation is effective. For instance, if you set this value to 3, this escalation will only be used if the service is in a non-OK state long enough for a third notification to go out. + +
last_notification: + +This directive is a number that identifies the last notification for which this escalation is effective. For instance, if you set this value to 5, this escalation will not be used if more than five notifications are sent out for the service. Setting this value to 0 means to keep using this escalation entry forever (no matter how many notifications go out). + +
contacts: + +This is a list of the short names of the contacts that should be notified whenever there are problems (or recoveries) with this service. Multiple contacts should be separated by commas. Useful if you want notifications to go to just a few people and don't want to configure contact groups. You must specify at least one contact or contact group in each service escalation definition. + +
contact_groups: + +This directive is used to identify the short name of the contact group that should be notified when the service notification is escalated. Multiple contact groups should be separated by commas. You must specify at least one contact or contact group in each service escalation definition. + +
notification_interval: + +This directive is used to determine the interval at which notifications should be made while this escalation is valid. If you specify a value of 0 for the interval, Nagios will send the first notification when this escalation definition is valid, but will then prevent any more problem notifications from being sent out for the host. Notifications are sent out again until the host recovers. This is useful if you want to stop having notifications sent out after a certain amount of time. Note: If multiple escalation entries for a host overlap for one or more notification ranges, the smallest notification interval from all escalation entries is used. + +
escalation_period: + +This directive is used to specify the short name of the time period during which this escalation is valid. If this directive is not specified, the escalation is considered to be valid during all times. + +
escalation_options: + +This directive is used to define the criteria that determine when this service escalation is used. The escalation is used only if the service is in one of the states specified in this directive. If this directive is not specified in a service escalation, the escalation is considered to be valid during all service states. Valid options are a combination of one or more of the following: r = escalate on an OK (recovery) state, w = escalate on a WARNING state, u = escalate on an UNKNOWN state, and c = escalate on a CRITICAL state. Example: If you specify w in this field, the escalation will only be used if the service is in a WARNING state. + +
+ + + + + +

+ + + + + + + + + + + +
Host Dependency Definition
+ + + +

Description:

+ +

+ +Host dependencies are an advanced feature of Nagios that allow you to suppress notifications for hosts based on the status of one or more other hosts. Host dependencies are optional and are mainly targeted at advanced users who have complicated monitoring setups. More information on how host dependencies work (read this!) can be found here. + +

+ + + +

Definition Format:

+ +

+ +Note: Directives in red are required, while those in black are optional. + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
define hostdependency{
dependent_host_namehost_name
dependent_hostgroup_namehostgroup_name
host_namehost_name
hostgroup_namehostgroup_name
inherits_parent[0/1]
execution_failure_criteria[o,d,u,p,n]
notification_failure_criteria[o,d,u,p,n]
dependency_periodtimeperiod_name
   }
+ + + +

Example Definition:

+ +
+
+define hostdependency{
+
+	host_name			WWW1
+
+	dependent_host_name		DBASE1
+
+	notification_failure_criteria	d,u
+
+	}
+
+
+ + + +

Directive Descriptions:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
dependent_host_name: + +This directive is used to identify the short name(s) of the dependent host(s). Multiple hosts should be separated by commas. + +
dependent_hostgroup_name: + +This directive is used to identify the short name(s) of the dependent hostgroup(s). Multiple hostgroups should be separated by commas. The dependent_hostgroup_name may be used instead of, or in addition to, the dependent_host_name directive. + +
host_name: + +This directive is used to identify the short name(s) of the host(s) that is being depended upon (also referred to as the master host). Multiple hosts should be separated by commas. + +
hostgroup_name: + +This directive is used to identify the short name(s) of the hostgroup(s) that is being depended upon (also referred to as the master host). Multiple hostgroups should be separated by commas. The hostgroup_name may be used instead of, or in addition to, the host_name directive. + +
inherits_parent: + +This directive indicates whether or not the dependency inherits dependencies of the host that is being depended upon (also referred to as the master host). In other words, if the master host is dependent upon other hosts and any one of those dependencies fail, this dependency will also fail. + +
execution_failure_criteria: + +This directive is used to specify the criteria that determine when the dependent host should not be actively checked. If the master host is in one of the failure states we specify, the dependent host will not be actively checked. Valid options are a combination of one or more of the following (multiple options are separated with commas): o = fail on an UP state, d = fail on a DOWN state, u = fail on an UNREACHABLE state, and p = fail on a pending state (e.g. the host has not yet been checked). If you specify n (none) as an option, the execution dependency will never fail and the dependent host will always be actively checked (if other conditions allow for it to be). Example: If you specify u,d in this field, the dependent host will not be actively checked if the master host is in either an UNREACHABLE or DOWN state. + +
notification_failure_criteria: + +This directive is used to define the criteria that determine when notifications for the dependent host should not be sent out. If the master host is in one of the failure states we specify, notifications for the dependent host will not be sent to contacts. Valid options are a combination of one or more of the following: o = fail on an UP state, d = fail on a DOWN state, u = fail on an UNREACHABLE state, and p = fail on a pending state (e.g. the host has not yet been checked). If you specify n (none) as an option, the notification dependency will never fail and notifications for the dependent host will always be sent out. Example: If you specify d in this field, the notifications for the dependent host will not be sent out if the master host is in a DOWN state. + +
dependency_period: + +This directive is used to specify the short name of the time period during which this dependency is valid. If this directive is not specified, the dependency is considered to be valid during all times. + +
+ + + + + + + +

+ + + + + + + + + + + +
Host Escalation Definition
+ + + +

Description:

+ +

+ +Host escalations are completely optional and are used to escalate notifications for a particular host. More information on how notification escalations work can be found here. + +

+ + + +

Definition Format:

+ +

+ +Note: Directives in red are required, while those in black are optional. + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
define hostescalation{
host_namehost_name
hostgroup_namehostgroup_name
contactscontacts
contact_groupscontactgroup_name
first_notification#
last_notification#
notification_interval#
escalation_periodtimeperiod_name
escalation_options[d,u,r]
   }
+ + + +

Example Definition:

+ +
+
+define hostescalation{
+
+	host_name		router-34
+
+	first_notification	5
+
+	last_notification	8
+
+	notification_interval	60
+
+	contact_groups		all-router-admins
+
+	}
+
+
+ + + +

Directive Descriptions:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
host_name: + +This directive is used to identify the short name of the host that the escalation should apply to. + +
hostgroup_name: + +This directive is used to identify the short name(s) of the hostgroup(s) that the escalation should apply to. Multiple hostgroups should be separated by commas. If this is used, the escalation will apply to all hosts that are members of the specified hostgroup(s). + +
first_notification: + +This directive is a number that identifies the first notification for which this escalation is effective. For instance, if you set this value to 3, this escalation will only be used if the host is down or unreachable long enough for a third notification to go out. + +
last_notification: + +This directive is a number that identifies the last notification for which this escalation is effective. For instance, if you set this value to 5, this escalation will not be used if more than five notifications are sent out for the host. Setting this value to 0 means to keep using this escalation entry forever (no matter how many notifications go out). + +
contacts: + +This is a list of the short names of the contacts that should be notified whenever there are problems (or recoveries) with this host. Multiple contacts should be separated by commas. Useful if you want notifications to go to just a few people and don't want to configure contact groups. You must specify at least one contact or contact group in each host escalation definition. + +
contact_groups: + +This directive is used to identify the short name of the contact group that should be notified when the host notification is escalated. Multiple contact groups should be separated by commas. You must specify at least one contact or contact group in each host escalation definition. + +
notification_interval: + +This directive is used to determine the interval at which notifications should be made while this escalation is valid. If you specify a value of 0 for the interval, Nagios will send the first notification when this escalation definition is valid, but will then prevent any more problem notifications from being sent out for the host. Notifications are sent out again until the host recovers. This is useful if you want to stop having notifications sent out after a certain amount of time. Note: If multiple escalation entries for a host overlap for one or more notification ranges, the smallest notification interval from all escalation entries is used. + +
escalation_period: + +This directive is used to specify the short name of the time period during which this escalation is valid. If this directive is not specified, the escalation is considered to be valid during all times. + +
escalation_options: + +This directive is used to define the criteria that determine when this host escalation is used. The escalation is used only if the host is in one of the states specified in this directive. If this directive is not specified in a host escalation, the escalation is considered to be valid during all host states. Valid options are a combination of one or more of the following: r = escalate on an UP (recovery) state, d = escalate on a DOWN state, and u = escalate on an UNREACHABLE state. Example: If you specify d in this field, the escalation will only be used if the host is in a DOWN state. + +
+ + + + + +

+ + + + + + + + + + + +
Extended Host Information Definition
+ + + +

Description:

+ +

+ +Extended host information entries are basically used to make the output from the status, statusmap, statuswrl, and extinfo CGIs look pretty. They have no effect on monitoring and are completely optional. + +

+ + + +

+ +Tip Tip: As of Nagios 3.x, all directives contained in extended host information definitions are also available in host definitions. Thus, you can choose to define the directives below in your host definitions if it makes your configuration simpler. Separate extended host information definitions will continue to be supported for backward compatability. + +

+ + + +

Definition Format:

+ +

+ +Note: Variables in red are required, while those in black are optional. However, you need to supply at least one optional variable in each definition for it to be of much use. + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
define hostextinfo{
host_namehost_name
notesnote_string
notes_urlurl
action_urlurl
icon_imageimage_file
icon_image_altalt_string
vrml_imageimage_file
statusmap_imageimage_file
2d_coordsx_coord,y_coord
3d_coordsx_coord,y_coord,z_coord
   }
+ + + +

Example Definition:

+ +
+
+define hostextinfo{
+
+	host_name	netware1
+
+	notes		This is the primary Netware file server
+
+	notes_url	http://webserver.localhost.localdomain/hostinfo.pl?host=netware1
+
+	icon_image	novell40.png 
+
+	icon_image_alt	IntranetWare 4.11
+
+	vrml_image	novell40.png
+
+	statusmap_image	novell40.gd2
+
+	2d_coords	100,250
+
+	3d_coords	100.0,50.0,75.0
+
+	}
+
+
+ + + +

Variable Descriptions:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
host_name: + +This variable is used to identify the short name of the host which the data is associated with. + +
notes: + +This directive is used to define an optional string of notes pertaining to the host. If you specify a note here, you will see the it in the extended information CGI (when you are viewing information about the specified host). + +
notes_url: + +This variable is used to define an optional URL that can be used to provide more information about the host. If you specify an URL, you will see a link that says "Extra Host Notes" in the extended information CGI (when you are viewing information about the specified host). Any valid URL can be used. If you plan on using relative paths, the base path will the the same as what is used to access the CGIs (i.e. /cgi-bin/nagios/). This can be very useful if you want to make detailed information on the host, emergency contact methods, etc. available to other support staff. + +
action_url: + +This directive is used to define an optional URL that can be used to provide more actions to be performed on the host. If you specify an URL, you will see a link that says "Extra Host Actions" in the extended information CGI (when you are viewing information about the specified host). Any valid URL can be used. If you plan on using relative paths, the base path will the the same as what is used to access the CGIs (i.e. /cgi-bin/nagios/). + +
icon_image: + +This variable is used to define the name of a GIF, PNG, or JPG image that should be associated with this host. This image will be displayed in the status and extended information CGIs. The image will look best if it is 40x40 pixels in size. Images for hosts are assumed to be in the logos/ subdirectory in your HTML images directory (i.e. /usr/local/nagios/share/images/logos). + +
icon_image_alt: + +This variable is used to define an optional string that is used in the ALT tag of the image specified by the <icon_image> argument. The ALT tag is used in the status, extended information and statusmap CGIs. + +
vrml_image: + +This variable is used to define the name of a GIF, PNG, or JPG image that should be associated with this host. This image will be used as the texture map for the specified host in the statuswrl CGI. Unlike the image you use for the <icon_image> variable, this one should probably not have any transparency. If it does, the host object will look a bit wierd. Images for hosts are assumed to be in the logos/ subdirectory in your HTML images directory (i.e. /usr/local/nagios/share/images/logos). + +
statusmap_image: + +This variable is used to define the name of an image that should be associated with this host in the statusmap CGI. You can specify a JPEG, PNG, and GIF image if you want, although I would strongly suggest using a GD2 format image, as other image formats will result in a lot of wasted CPU time when the statusmap image is generated. GD2 images can be created from PNG images by using the pngtogd2 utility supplied with Thomas Boutell's gd library. The GD2 images should be created in uncompressed format in order to minimize CPU load when the statusmap CGI is generating the network map image. The image will look best if it is 40x40 pixels in size. You can leave these option blank if you are not using the statusmap CGI. Images for hosts are assumed to be in the logos/ subdirectory in your HTML images directory (i.e. /usr/local/nagios/share/images/logos). + +
2d_coords: + +This variable is used to define coordinates to use when drawing the host in the statusmap CGI. Coordinates should be given in positive integers, as they correspond to physical pixels in the generated image. The origin for drawing (0,0) is in the upper left hand corner of the image and extends in the positive x direction (to the right) along the top of the image and in the positive y direction (down) along the left hand side of the image. For reference, the size of the icons drawn is usually about 40x40 pixels (text takes a little extra space). The coordinates you specify here are for the upper left hand corner of the host icon that is drawn. Note: Don't worry about what the maximum x and y coordinates that you can use are. The CGI will automatically calculate the maximum dimensions of the image it creates based on the largest x and y coordinates you specify. + +
3d_coords: + +This variable is used to define coordinates to use when drawing the host in the statuswrl CGI. Coordinates can be positive or negative real numbers. The origin for drawing is (0.0,0.0,0.0). For reference, the size of the host cubes drawn is 0.5 units on each side (text takes a little more space). The coordinates you specify here are used as the center of the host cube. + +
+ + + + + + + +

+ + + + + + + + + + + +
Extended Service Information Definition
+ + + +

Description:

+ +

+ +Extended service information entries are basically used to make the output from the status and extinfo CGIs look pretty. They have no effect on monitoring and are completely optional. + +

+ + + +

+ +Tip Tip: As of Nagios 3.x, all directives contained in extended service information definitions are also available in service definitions. Thus, you can choose to define the directives below in your service definitions if it makes your configuration simpler. Separate extended service information definitions will continue to be supported for backward compatability. + +

+ + + +

Definition Format:

+ +

+ +Note: Variables in red are required, while those in black are optional. However, you need to supply at least one optional variable in each definition for it to be of much use. + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
define serviceextinfo{
host_namehost_name
service_descriptionservice_description
notesnote_string
notes_urlurl
action_urlurl
icon_imageimage_file
icon_image_altalt_string
   }
+ + + +

Example Definition:

+ +
+
+define serviceextinfo{
+
+	host_name		linux2
+
+	service_description	Log Anomalies
+
+	notes			Security-related log anomalies on secondary Linux server
+
+	notes_url		http://webserver.localhost.localdomain/serviceinfo.pl?host=linux2&service=Log+Anomalies
+
+	icon_image		security.png 
+
+	icon_image_alt		Security-Related Alerts
+
+	}
+
+
+ + + +

Variable Descriptions:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
host_name: + +This directive is used to identify the short name of the host that the service is associated with. + +
service_description: + +This directive is description of the service which the data is associated with. + +
notes: + +This directive is used to define an optional string of notes pertaining to the service. If you specify a note here, you will see the it in the extended information CGI (when you are viewing information about the specified service). + +
notes_url: + +This directive is used to define an optional URL that can be used to provide more information about the service. If you specify an URL, you will see a link that says "Extra Service Notes" in the extended information CGI (when you are viewing information about the specified service). Any valid URL can be used. If you plan on using relative paths, the base path will the the same as what is used to access the CGIs (i.e. /cgi-bin/nagios/). This can be very useful if you want to make detailed information on the service, emergency contact methods, etc. available to other support staff. + +
action_url: + +This directive is used to define an optional URL that can be used to provide more actions to be performed on the service. If you specify an URL, you will see a link that says "Extra Service Actions" in the extended information CGI (when you are viewing information about the specified service). Any valid URL can be used. If you plan on using relative paths, the base path will the the same as what is used to access the CGIs (i.e. /cgi-bin/nagios/). + +
icon_image: + +This variable is used to define the name of a GIF, PNG, or JPG image that should be associated with this host. This image will be displayed in the status and extended information CGIs. The image will look best if it is 40x40 pixels in size. Images for hosts are assumed to be in the logos/ subdirectory in your HTML images directory (i.e. /usr/local/nagios/share/images/logos). + +
icon_image_alt: + +This variable is used to define an optional string that is used in the ALT tag of the image specified by the <icon_image> argument. The ALT tag is used in the status, extended information and statusmap CGIs. + +
+ + + + + +
+ + + + + + + diff --git a/docs/objectinheritance.html b/docs/objectinheritance.html new file mode 100644 index 0000000..1f0f270 --- /dev/null +++ b/docs/objectinheritance.html @@ -0,0 +1,1134 @@ + + + + + + + + +Object Inheritance + + + + + + + + + + + + + + + +
+ +Nagios + +

Object Inheritance

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Object Configuration, Object Tricks, Custom Object Variables, Fast Startup Options + +

+ + + +

+ +Introduction + +

+ + + +

+ +This documentation attempts to explain object inheritance and how it can be used in your object definitions. + +

+ + + +

+ +If you are confused about how recursion and inheritance work after reading this, take a look at the sample object config files provided in the Nagios distribution. If that still doesn't help, drop an email message with a detailed description of your problem to the nagios-users mailing list. + +

+ + + +

+ +Basics + +

+ + + +

+ +There are three variables affecting recursion and inheritance that are present in all object definitions. They are indicated in red as follows... + +

+ + + +
+
+	define someobjecttype{
+
+		object-specific variables ...
+
+		name		template_name
+
+		use		name_of_template_to_use
+
+		register	[0/1]
+
+		}
+
+
+ + + +

+ +The first variable is name. Its just a "template" name that can be referenced in other object definitions so they can inherit the objects properties/variables. Template names must be unique amongst objects of the same type, so you can't have two or more host definitions that have "hosttemplate" as their template name. + +

+ + + +

+ +The second variable is use. This is where you specify the name of the template object that you want to inherit properties/variables from. The name you specify for this variable must be defined as another object's template named (using the name variable). + +

+ + + +

+ +The third variable is register. This variable is used to indicate whether or not the object definition should be "registered" with Nagios. By default, all object definitions are registered. If you are using a partial object definition as a template, you would want to prevent it from being registered (an example of this is provided later). Values are as follows: 0 = do NOT register object definition, 1 = register object definition (this is the default). This variable is NOT inherited; every (partial) object definition used as a template must explicitly set the register directive to be 0. This prevents the need to override an inherited register directive with a value of 1 for every object that should be registered. + +

+ + + +

+ +Local Variables vs. Inherited Variables + +

+ + + +

+ +One important thing to understand with inheritance is that "local" object variables always take precedence over variables defined in the template object. Take a look at the following example of two host definitions (not all required variables have been supplied): + +

+ + + +
+
+	define host{
+
+		host_name		bighost1
+
+		check_command		check-host-alive
+
+		notification_options	d,u,r
+
+		max_check_attempts	5
+
+		name			hosttemplate1
+
+		}
+
+
+
+	define host{
+
+		host_name		bighost2
+
+		max_check_attempts	3
+
+		use			hosttemplate1
+
+		}
+
+
+ + + +

+ +You'll note that the definition for host bighost1 has been defined as having hosttemplate1 as its template name. The definition for host bighost2 is using the definition of bighost1 as its template object. Once Nagios processes this data, the resulting definition of host bighost2 would be equivalent to this definition: + +

+ + + +
+
+	define host{
+
+		host_name		bighost2
+
+		check_command		check-host-alive
+
+		notification_options	d,u,r
+
+		max_check_attempts	3
+
+		}
+
+
+ + + +

+ +You can see that the check_command and notification_options variables were inherited from the template object (where host bighost1 was defined). However, the host_name and max_check_attempts variables were not inherited from the template object because they were defined locally. Remember, locally defined variables override variables that would normally be inherited from a template object. That should be a fairly easy concept to understand. + +

+ + + +

+ +Tip Tip: If you would like local string variables to be appended to inherited string values, you can do so. Read more about how to accomplish this below. + +

+ + + +

+ +Inheritance Chaining + +

+ + + +

+ +Objects can inherit properties/variables from multiple levels of template objects. Take the following example: + +

+ + + +
+
+	define host{
+
+		host_name		bighost1
+
+		check_command		check-host-alive
+
+		notification_options	d,u,r
+
+		max_check_attempts	5
+
+		name			hosttemplate1
+
+		}
+
+
+
+	define host{
+
+		host_name		bighost2
+
+		max_check_attempts	3
+
+		use			hosttemplate1
+
+		name			hosttemplate2
+
+		}
+
+
+
+	define host{
+
+		host_name		bighost3
+
+		use			hosttemplate2
+
+		}
+
+
+ + + +

+ +You'll notice that the definition of host bighost3 inherits variables from the definition of host bighost2, which in turn inherits variables from the definition of host bighost1. Once Nagios processes this configuration data, the resulting host definitions are equivalent to the following: + +

+ + + + + +
+
+	define host{
+
+		host_name		bighost1
+
+		check_command		check-host-alive
+
+		notification_options	d,u,r
+
+		max_check_attempts	5
+
+		}
+
+
+
+	define host{
+
+		host_name		bighost2
+
+		check_command		check-host-alive
+
+		notification_options	d,u,r
+
+		max_check_attempts	3
+
+		}
+
+
+
+	define host{
+
+		host_name		bighost3
+
+		check_command		check-host-alive
+
+		notification_options	d,u,r
+
+		max_check_attempts	3
+
+		}
+
+
+ + + +

+ +There is no inherent limit on how "deep" inheritance can go, but you'll probably want to limit yourself to at most a few levels in order to maintain sanity. + +

+ + + +

+ +Using Incomplete Object Definitions as Templates + +

+ + + +

+ +It is possible to use incomplete object definitions as templates for use by other object definitions. By "incomplete" definition, I mean that all required variables in the object have not been supplied in the object definition. It may sound odd to use incomplete definitions as templates, but it is in fact recommended that you use them. Why? Well, they can serve as a set of defaults for use in all other object definitions. Take the following example: + +

+ + + +
+
+	define host{
+
+		check_command		check-host-alive
+
+		notification_options	d,u,r
+
+		max_check_attempts	5
+
+		name			generichosttemplate
+
+		register			0
+
+		}
+
+
+
+	define host{
+
+		host_name		bighost1
+
+		address			192.168.1.3
+
+		use			generichosttemplate
+
+		}
+
+
+
+	define host{
+
+		host_name		bighost2
+
+		address			192.168.1.4
+
+		use			generichosttemplate
+
+		}
+
+
+ + + +

+ +Notice that the first host definition is incomplete because it is missing the required host_name variable. We don't need to supply a host name because we just want to use this definition as a generic host template. In order to prevent this definition from being registered with Nagios as a normal host, we set the register variable to 0. + +

+ + + +

+ +The definitions of hosts bighost1 and bighost2 inherit their values from the generic host definition. The only variable we've chosed to override is the address variable. This means that both hosts will have the exact same properties, except for their host_name and address variables. Once Nagios processes the config data in the example, the resulting host definitions would be equivalent to specifying the following: + +

+ + + +
+
+	define host{
+
+		host_name		bighost1
+
+		address			192.168.1.3
+
+		check_command		check-host-alive
+
+		notification_options	d,u,r
+
+		max_check_attempts	5
+
+		}
+
+
+
+	define host{
+
+		host_name		bighost2
+
+		address			192.168.1.4
+
+		check_command		check-host-alive
+
+		notification_options	d,u,r
+
+		max_check_attempts	5
+
+		}
+
+
+ + + + + +

+ +At the very least, using a template definition for default variables will save you a lot of typing. It'll also save you a lot of headaches later if you want to change the default values of variables for a large number of hosts. + +

+ + + +

+ +Custom Object Variables + +

+ + + +

+ +Any custom object variables that you define in your host, service, or contact definition templates will be inherited just like other standard variables. Take the following example: + +

+ + + +
+
+	define host{
+
+		_customvar1		somevalue  ; <-- Custom host variable
+
+		_snmp_community		public	; <-- Custom host variable
+
+		name			generichosttemplate
+
+		register			0
+
+		}
+
+
+
+	define host{
+
+		host_name		bighost1
+
+		address			192.168.1.3
+
+		use			generichosttemplate
+
+		}
+
+
+ + + +

+ +The host bighost1 will inherit the custom host variables _customvar1 and _snmp_community, as well as their respective values, from the generichosttemplate definition. The effective result is a definition for bighost1 that looks like this: + +

+ + + +
+
+	define host{
+
+		host_name		bighost1
+
+		address			192.168.1.3
+
+		_customvar1		somevalue
+
+		_snmp_community		public
+
+		}
+
+
+ + + + + +

+ +Cancelling Inheritance of String Values + +

+ + + +

+ +In some cases you may not want your host, service, or contact definitions to inherit values of string variables from the templates they reference. If this is the case, you can specify "null" (without quotes) as the value of the variable that you do not want to inherit. Take the following example: + +

+ + + +
+
+	define host{
+
+		event_handler		my-event-handler-command
+
+		name			generichosttemplate
+
+		register			0
+
+		}
+
+
+
+	define host{
+
+		host_name		bighost1
+
+		address			192.168.1.3
+
+		event_handler	null
+
+		use			generichosttemplate
+
+		}
+
+
+ + + +

+ +In this case, the host bighost1 will not inherit the value of the event_handler variable that is defined in the generichosttemplate. The resulting effective definition of bighost1 is the following: + +

+ + + +
+
+	define host{
+
+		host_name		bighost1
+
+		address			192.168.1.3
+
+		}
+
+
+ + + + + +

+ +Additive Inheritance of String Values + +

+ + + +

+ +Nagios gives preference to local variables instead of values inherited from templates. In most cases local variable values override those that are defined in templates. In some cases it makes sense to allow Nagios to use the values of inherited and local variables together. + +

+ + + +

+ +This "additive inheritance" can be accomplished by prepending the local variable value with a plus sign (+). This features is only available for standard (non-custom) variables that contain string values. Take the following example: + +

+ + + +
+
+	define host{
+
+		hostgroups		all-servers
+
+		name			generichosttemplate
+
+		register			0
+
+		}
+
+
+
+	define host{
+
+		host_name			linuxserver1
+
+		hostgroups		+linux-servers,web-servers
+
+		use			generichosttemplate
+
+		}
+
+
+ + + +

+ +In this case, the host linuxserver1 will append the value of its local hostgroups variable to that from generichosttemplate. The resulting effective definition of linuxserver1 is the following: + +

+ + + +
+
+	define host{
+
+		host_name			linuxserver1
+
+		hostgroups		all-servers,linux-servers,web-servers
+
+		}
+
+
+ + + + + +

+ +Implied Inheritance + +

+ + + +

+ +Normally you have to either explicitly specify the value of a required variable in an object definition or inherit it from a template. There are a few exceptions to this rule, where Nagios will assume that you want to use a value that instead comes from a related object. For example, the values of some service variables will be copied from the host the service is associated with if you don't otherwise specify them. + +

+ + + +

+ +The following table lists the object variables that will be implicitly inherited from related objects if you don't explicitly specify their value in your object definition or inherit them from a template. + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Object TypeObject VariableImplied Source
Servicescontact_groupscontact_groups in the associated host definition
notification_intervalnotification_interval in the associated host definition
notification_periodnotification_period in the associated host definition
Host Escalationscontact_groupscontact_groups in the associated host definition
notification_intervalnotification_interval in the associated host definition
escalation_periodnotification_period in the associated host definition
Service Escalationscontact_groupscontact_groups in the associated service definition
notification_intervalnotification_interval in the associated service definition
escalation_periodnotification_period in the associated service definition
+ + + + + +

+ +Implied/Additive Inheritance in Escalations + +

+ + + +

+ +Service and host escalation definitions can make use of a special rule that combines the features of implied and additive inheritance. If escalations 1) do not inherit the values of their contact_groups or contacts directives from another escalation template and 2) their contact_groups or contacts directives begin with a plus sign (+), then the values of their corresponding host or service definition's contact_groups or contacts directives will be used in the additive inheritance logic. + +

+ + + +

+ +Confused? Here's an example: + +

+ + + +
+
+define host{
+
+	name 		linux-server
+
+	contact_groups	linux-admins
+
+	...
+
+	}
+
+
+
+define hostescalation{
+
+	host_name		linux-server
+
+	contact_groups	+management
+
+	...
+
+	}
+
+
+ + + +

+ +This is a much simpler equivalent to: + +

+ + + +
+
+define hostescalation{
+
+	host_name		linux-server
+
+	contact_groups	linux-admins,management
+
+	...
+
+	}
+
+
+ + + + + + +

+Important values +

+ +

+Service templates can make use of a special rule which gives precedence to their check_command value. If the check_command is prefixed with an exclamation mark (!), then the template's check_command is marked as important and will be used over the check_command defined for the service (this is styled after CSS syntax, which uses ! as an important attribute). +

+ +

+Why is this useful? It is mainly useful when setting a different check_command for distributed systems. You may want to set a freshness threshold and a check_command that forces the service into a failed state, but this doesn't work with the normal templating system. Using this important flag allows the custom check_command to be written, but a general distributed template can be used to overrule the check_command when used on a central Nagios server. +

+ +

+For instance: +

+ +
+# On master
+define service {
+	name			service-distributed
+	register		0
+	active_checks_enabled	0
+	check_freshness		1
+	check_command		!set_to_stale
+	}
+# On slave
+define service {
+	name			service-distributed
+	register		0
+	active_checks_enabled	1
+	}
+# Service definition, used by master and slave
+define service {
+	host_name 		host1
+	service_description	serviceA
+	check_command		check_http...
+	use			service-distributed
+	...
+	}
+
+ + + +

+ +Multiple Inheritance Sources + +

+ + + +

+ +Thus far, all examples of inheritance have shown object definitions inheriting variables/values from just a single source. You are also able to inherit variables/values from multiple sources for more complex configurations, as shown below. + +

+ + + + + + + + + + + + + +
+ +
+
+# Generic host template
+
+define host{
+
+	name 			generic-host
+
+	active_checks_enabled	1
+
+	check_interval		10
+
+	...
+
+	register 			0
+
+	}
+
+
+
+# Development web server template
+
+define host{
+
+	name 			development-server
+
+	check_interval		15
+
+	notification_options	d,u,r
+
+	...
+
+	register 			0
+
+	}
+
+
+
+# Development web server
+
+define host{
+
+	use			generic-host,development-server
+
+	host_name 		devweb1
+
+	...
+
+	}
+
+
+ +		 + +Multiple Inheritance Sources + +
+ + + +

+ +In the example above, devweb1 is inheriting variables/values from two sources: generic-host and development-server. You'll notice that a check_interval variable is defined in both sources. Since generic-host was the first template specified in devweb1's use directive, its value for the check_interval variable is inherited by the devweb1 host. After inheritance, the effective definition of devweb1 would be as follows: + +

+ + + +
+
+# Development web server
+
+define host{
+
+	host_name 		devweb1
+
+	active_checks_enabled	1
+
+	check_interval		10
+
+	notification_options	d,u,r
+
+	...
+
+	}
+
+
+ + + +

+ +Precedence With Multiple Inheritance Sources + +

+ + + +

+ +When you use multiple inheritance sources, it is important to know how Nagios handles variables that are defined in multiple sources. In these cases Nagios will use the variable/value from the first source that is specified in the use directive. Since inheritance sources can themselves inherit variables/values from one or more other sources, it can get tricky to figure out what variable/value pairs take precedence. + +

+ + + + + + + + + + + + + +
+ +

+ +Consider the following host definition that references three templates: + +

+ +
+
+# Development web server
+
+define host{
+
+	use 		1, 4, 8
+
+	host_name		devweb1
+
+	...
+
+	}
+
+
+ +

+ +If some of those referenced templates themselves inherit variables/values from one or more other templates, the precendence rules are shown to the right. + +

+ +

+ +Testing, trial, and error will help you better understand exactly how things work in complex inheritance situations like this. :-) + +

+ +		 + +Multiple Inheritance Sources + +
+ + + +
+ + + + + + + diff --git a/docs/objecttricks.html b/docs/objecttricks.html new file mode 100644 index 0000000..f9a49c0 --- /dev/null +++ b/docs/objecttricks.html @@ -0,0 +1,840 @@ + + + + + + + + +Time-Saving Tricks For Object Definitions + + + + + + + + + + + + + + + +
+ +Nagios + +

Time-Saving Tricks For Object Definitions

+ +or...
+ +"How To Preserve Your Sanity" + +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Object Configuration, Object Inheritance + +

+ + + +

+ +Introduction + +

+ + + +

+ +This documentation attempts to explain how you can exploit the (somewhat) hidden features of template-based object definitions to save your sanity. How so, you ask? Several types of objects allow you to specify multiple host names and/or hostgroup names in definitions, allowing you to "copy" the object defintion to multiple hosts or services. I'll cover each type of object that supports these features seperately. For starters, the object types which support this time-saving feature are as follows: + +

+ + + + + + + +

+ +Object types that are not listed above (i.e. timeperiods, commands, etc.) do not support the features I'm about to describe. + +

+ + + +

+ +Regular Expression Matching + +

+ + + +

+ +The examples I give below use "standard" matching of object names + + and *require* use_regexp_matching to be *disabled*. + +

+ + + +

+ +If you wish, you can enable regular expression matching for object names by using the use_regexp_matching config option. By default, regular expression matching will only be used in object names that contain *, ?, +, or \.. If you want regular expression matching to be used on all object names, enable the use_true_regexp_matching config option. Regular expressions can be used in any of the fields used in the examples below (host names, hostgroup names, service names, and servicegroup names). + +

+ + + +

+ +Note Note: Be careful when enabling regular expression matching - you may have to change your config file, since some directives that you might not want to be interpreted as a regular expression just might be! Any problems should become evident once you verify your configuration. + +

+ + + +

+ + + + + +

+ +Service Definitions + +

+ + + +

+ +Multiple Hosts:
If you want to create identical services that are assigned to multiple hosts, you can specify multiple hosts in the host_name directive. The definition below would create a service called SOMESERVICE on hosts HOST1 through HOSTN. All the instances of the SOMESERVICE service would be identical (i.e. have the same check command, max check attempts, notification period, etc.). + +

+ + + +
+
+	define service{
+
+		host_name		HOST1,HOST2,HOST3,...,HOSTN
+
+		service_description	SOMESERVICE
+
+		other service directives ...
+
+		}
+
+
+ + + + + +

+ +All Hosts In Multiple Hostgroups:
If you want to create identical services that are assigned to all hosts in one or more hostgroups, you can do so by creating a single service definition. How? The hostgroup_name directive allows you to specify the name of one or more hostgroups that the service should be created for. The definition below would create a service called SOMESERVICE on all hosts that are members of hostgroups HOSTGROUP1 through HOSTGROUPN. All the instances of the SOMESERVICE service would be identical (i.e. have the same check command, max check attempts, notification period, etc.). + +

+ + + +
+
+	define service{
+
+		hostgroup_name		HOSTGROUP1,HOSTGROUP2,...,HOSTGROUPN
+
+		service_description	SOMESERVICE
+
+		other service directives ...
+
+		}
+
+
+ + + +

+ +All Hosts:
If you want to create identical services that are assigned to all hosts that are defined in your configuration files, you can use a wildcard in the host_name directive. The definition below would create a service called SOMESERVICE on all hosts that are defined in your configuration files. All the instances of the SOMESERVICE service would be identical (i.e. have the same check command, max check attempts, notification period, etc.). + +

+ + + +
+
+	define service{
+
+		host_name		*
+
+		service_description	SOMESERVICE
+
+		other service directives ...
+
+		}
+
+
+ + + +

+ +Excluding Hosts:
If you want to create identical services on numerous hosts or hostgroups, but would like to exclude some hosts from the definition, this can be accomplished by preceding the host or hostgroup with a ! symbol. + +

+ + + +
+
+	define service{
+
+		host_name             HOST1,HOST2,!HOST3,!HOST4,...,HOSTN
+
+		hostgroup_name                HOSTGROUP1,HOSTGROUP2,!HOSTGROUP3,!HOSTGROUP4,...,HOSTGROUPN
+
+		service_description   SOMESERVICE
+
+		other service directives ...
+
+		}
+
+
+ + + +

+ + + + + +

+ +Service Escalation Definitions + +

+ + + +

+ +Multiple Hosts:
If you want to create service escalations for services of the same name/description that are assigned to multiple hosts, you can specify multiple hosts in the host_name directive. The definition below would create a service escalation for services called SOMESERVICE on hosts HOST1 through HOSTN. All the instances of the service escalation would be identical (i.e. have the same contact groups, notification interval, etc.). + +

+ + + +
+
+	define serviceescalation{
+
+		host_name		HOST1,HOST2,HOST3,...,HOSTN
+
+		service_description	SOMESERVICE
+
+		other escalation directives ...
+
+		}
+
+
+ + + + + +

+ +All Hosts In Multiple Hostgroups:
If you want to create service escalations for services of the same name/description that are assigned to all hosts in in one or more hostgroups, you can do use the hostgroup_name directive. The definition below would create a service escalation for services called SOMESERVICE on all hosts that are members of hostgroups HOSTGROUP1 through HOSTGROUPN. All the instances of the service escalation would be identical (i.e. have the same contact groups, notification interval, etc.). + +

+ + + +
+
+	define serviceescalation{
+
+		hostgroup_name		HOSTGROUP1,HOSTGROUP2,...,HOSTGROUPN
+
+		service_description	SOMESERVICE
+
+		other escalation directives ...
+
+		}
+
+
+ + + +

+ +All Hosts:
If you want to create identical service escalations for services of the same name/description that are assigned to all hosts that are defined in your configuration files, you can use a wildcard in the host_name directive. The definition below would create a service escalation for all services called SOMESERVICE on all hosts that are defined in your configuration files. All the instances of the service escalation would be identical (i.e. have the same contact groups, notification interval, etc.). + +

+ + + +
+
+	define serviceescalation{
+
+		host_name		*
+
+		service_description	SOMESERVICE
+
+		other escalation directives ...
+
+		}
+
+
+ + + +

+ +Excluding Hosts:
If you want to create identical services escalations for services on numerous hosts or hostgroups, + +but would like to exclude some hosts from the definition, this can be accomplished by preceding the host or hostgroup with a ! symbol. + +

+ + + +
+
+	define serviceescalation{
+
+		host_name             HOST1,HOST2,!HOST3,!HOST4,...,HOSTN
+
+		hostgroup_name                HOSTGROUP1,HOSTGROUP2,!HOSTGROUP3,!HOSTGROUP4,...,HOSTGROUPN
+
+		service_description   SOMESERVICE
+
+		other escalation directives ...
+
+		}
+
+
+ + + +

+ +All Services On Same Host:
If you want to create service escalations for all services assigned to a particular host, you can use a wildcard in the service_description directive. The definition below would create a service escalation for all services on host HOST1. All the instances of the service escalation would be identical (i.e. have the same contact groups, notification interval, etc.). + +

+ +

+ +If you feel like being particularly adventurous, you can specify a wildcard in both the host_name and service_description directives. Doing so would create a service escalation for all services that you've defined in your configuration files. + +

+ + + +
+
+	define serviceescalation{
+
+		host_name		HOST1
+
+		service_description	*
+
+		other escalation directives ...
+
+		}
+
+
+ + + + + +

+ +Multiple Services On Same Host:
If you want to create service escalations for all multiple services assigned to a particular host, you can use a specify more than one service description in the service_description directive. The definition below would create a service escalation for services SERVICE1 through SERVICEN on host HOST1. All the instances of the service escalation would be identical (i.e. have the same contact groups, notification interval, etc.). + +

+ + + +
+
+	define serviceescalation{
+
+		host_name		HOST1
+
+		service_description	SERVICE1,SERVICE2,...,SERVICEN
+
+		other escalation directives ...
+
+		}
+
+
+ + + +

+ +All Services In Multiple Servicegroups:
If you want to create service escalations for all services that belong in one or more servicegroups, you can do use the servicegroup_name directive. The definition below would create service escalations for all services that are members of servicegroups SERVICEGROUP1 through SERVICEGROUPN. All the instances of the service escalation would be identical (i.e. have the same contact groups, notification interval, etc.). + +

+ + + +
+
+	define serviceescalation{
+
+		servicegroup_name		SERVICEGROUP1,SERVICEGROUP2,...,SERVICEGROUPN
+
+		other escalation directives ...
+
+		}
+
+
+ + + +

+ + + + + +

+ +Service Dependency Definitions + +

+ + + +

+ +Multiple Hosts:
If you want to create service dependencies for services of the same name/description that are assigned to multiple hosts, you can specify multiple hosts in the host_name and or dependent_host_name directives. In the example below, service SERVICE2 on hosts HOST3 and HOST4 would be dependent on service SERVICE1 on hosts HOST1 and HOST2. All the instances of the service dependencies would be identical except for the host names (i.e. have the same notification failure criteria, etc.). + +

+ + + +
+
+	define servicedependency{
+
+		host_name			HOST1,HOST2
+
+		service_description		SERVICE1
+
+		dependent_host_name		HOST3,HOST4
+
+		dependent_service_description	SERVICE2
+
+		other dependency directives ...
+
+		}
+
+
+ + + +

+ +All Hosts In Multiple Hostgroups:
If you want to create service dependencies for services of the same name/description that are assigned to all hosts in in one or more hostgroups, you can do use the hostgroup_name and/or dependent_hostgroup_name directives. In the example below, service SERVICE2 on all hosts in hostgroups HOSTGROUP3 and HOSTGROUP4 would be dependent on service SERVICE1 on all hosts in hostgroups HOSTGROUP1 and HOSTGROUP2. Assuming there were five hosts in each of the hostgroups, this definition would be equivalent to creating 100 single service dependency definitions! All the instances of the service dependency would be identical except for the host names (i.e. have the same notification failure criteria, etc.). + +

+ + + +
+
+	define servicedependency{
+
+		hostgroup_name			HOSTGROUP1,HOSTGROUP2
+
+		service_description		SERVICE1
+
+		dependent_hostgroup_name	HOSTGROUP3,HOSTGROUP4
+
+		dependent_service_description	SERVICE2
+
+		other dependency directives ...
+
+		}
+
+
+ + + +

+ +All Services On A Host:
If you want to create service dependencies for all services assigned to a particular host, you can use a wildcard in the service_description and/or dependent_service_description directives. In the example below, all services on host HOST2 would be dependent on all services on host HOST1. All the instances of the service dependencies would be identical (i.e. have the same notification failure criteria, etc.). + +

+ + + +
+
+	define servicedependency{
+
+		host_name			HOST1
+
+		service_description		*
+
+		dependent_host_name		HOST2
+
+		dependent_service_description	*
+
+		other dependency directives ...
+
+		}
+
+
+ + + +

+ +Multiple Services On A Host:
If you want to create service dependencies for multiple services assigned to a particular host, you can specify more than one service description in the service_description and/or dependent_service_description directives as follows: + +

+ + + +
+
+	define servicedependency{
+
+		host_name			HOST1
+
+		service_description		SERVICE1,SERVICE2,...,SERVICEN
+
+		dependent_host_name		HOST2
+
+		dependent_service_description	SERVICE1,SERVICE2,...,SERVICEN
+
+		other dependency directives ...
+
+		}
+
+
+ + + +

+ +All Services In Multiple Servicegroups:
If you want to create service dependencies for all services that belong in one or more servicegroups, you can do use the servicegroup_name and/or dependent_servicegroup_name directive as follows: + +

+ + + +
+
+	define servicedependency{
+
+		servicegroup_name		SERVICEGROUP1,SERVICEGROUP2,...,SERVICEGROUPN
+
+		dependent_servicegroup_name	SERVICEGROUP3,SERVICEGROUP4,...SERVICEGROUPN
+
+		other dependency directives ...
+
+		}
+
+
+ + + + + +

+ +Same Host Dependencies:
If you want to create service dependencies for multiple services that are dependent on services on the same host, leave the dependent_host_name and dependent_hostgroup_name directives empty. The example below assumes that hosts HOST1 and HOST2 have at least the following four services associated with them: SERVICE1, SERVICE2, SERVICE3, and SERVICE4. In this example, SERVICE3 and SERVICE4 on HOST1 will be dependent on both SERVICE1 and SERVICE2 on HOST1. Similiarly, SERVICE3 and SERVICE4 on HOST2 will be dependent on both SERVICE1 and SERVICE2 on HOST2. + +

+ + + +
+
+	define servicedependency{
+
+		host_name			HOST1,HOST2
+
+		service_description		SERVICE1,SERVICE2
+
+		dependent_service_description	SERVICE3,SERVICE4
+
+		other dependency directives ...
+
+		}
+
+
+ + + +

+ + + + + +

+ +Host Escalation Definitions + +

+ + + +

+ +Multiple Hosts:
If you want to create host escalations for multiple hosts, you can specify multiple hosts in the host_name directive. The definition below would create a host escalation for hosts HOST1 through HOSTN. All the instances of the host escalation would be identical (i.e. have the same contact groups, notification interval, etc.). + +

+ + + +
+
+	define hostescalation{
+
+		host_name		HOST1,HOST2,HOST3,...,HOSTN
+
+		other escalation directives ...
+
+		}
+
+
+ + + +

+ +All Hosts In Multiple Hostgroups:
If you want to create host escalations for all hosts in in one or more hostgroups, you can do use the hostgroup_name directive. The definition below would create a host escalation on all hosts that are members of hostgroups HOSTGROUP1 through HOSTGROUPN. All the instances of the host escalation would be identical (i.e. have the same contact groups, notification interval, etc.). + +

+ + + +
+
+	define hostescalation{
+
+		hostgroup_name		HOSTGROUP1,HOSTGROUP2,...,HOSTGROUPN
+
+		other escalation directives ...
+
+		}
+
+
+ + + +

+ +All Hosts:
If you want to create identical host escalations for all hosts that are defined in your configuration files, you can use a wildcard in the host_name directive. The definition below would create a hosts escalation for all hosts that are defined in your configuration files. All the instances of the host escalation would be identical (i.e. have the same contact groups, notification interval, etc.). + +

+ + + +
+
+	define hostescalation{
+
+		host_name		*
+
+		other escalation directives ...
+
+		}
+
+
+ + + +

+ +Excluding Hosts:
If you want to create identical host escalations on numerous hosts or hostgroups, but would like to + + exclude some hosts from the definition, this can be accomplished by preceding the host or hostgroup with a ! symbol. + +

+ + + +
+
+	define hostescalation{
+
+		host_name             HOST1,HOST2,!HOST3,!HOST4,...,HOSTN
+
+		hostgroup_name                HOSTGROUP1,HOSTGROUP2,!HOSTGROUP3,!HOSTGROUP4,...,HOSTGROUPN
+
+		other escalation directives ...
+
+		}
+
+
+ + + +

+ + + + + +

+ +Host Dependency Definitions + +

+ + + +

+ +Multiple Hosts:
If you want to create host dependencies for multiple hosts, you can specify multiple hosts in the host_name and/or dependent_host_name directives. The definition below would be equivalent to creating six seperate host dependencies. In the example above, hosts HOST3, HOST4 and HOST5 would be dependent upon both HOST1 and HOST2. All the instances of the host dependencies would be identical except for the host names (i.e. have the same notification failure criteria, etc.). + +

+ + + +
+
+	define hostdependency{
+
+		host_name		HOST1,HOST2
+
+		dependent_host_name	HOST3,HOST4,HOST5
+
+		other dependency directives ...
+
+		}
+
+
+ + + +

+ +All Hosts In Multiple Hostgroups:
If you want to create host escalations for all hosts in in one or more hostgroups, you can do use the hostgroup_name and /or dependent_hostgroup_name directives. In the example below, all hosts in hostgroups HOSTGROUP3 and HOSTGROUP4 would be dependent on all hosts in hostgroups HOSTGROUP1 and HOSTGROUP2. All the instances of the host dependencies would be identical except for host names (i.e. have the same notification failure criteria, etc.). + +

+ + + +
+
+	define hostdependency{
+
+		hostgroup_name			HOSTGROUP1,HOSTGROUP2
+
+		dependent_hostgroup_name	HOSTGROUP3,HOSTGROUP4
+
+		other dependency directives ...
+
+		}
+
+
+ + + +

+ + + + + +

+ +Hostgroups + +

+ + + +

+ +All Hosts:
If you want to create a hostgroup that has all hosts that are defined in your configuration files as members, you can use a wildcard in the members directive. The definition below would create a hostgroup called HOSTGROUP1 that has all hosts that are defined in your configuration files as members. + +

+ + + +
+
+	define hostgroup{
+
+		hostgroup_name		HOSTGROUP1
+
+		members			*
+
+		other hostgroup directives ...
+
+		}
+
+
+ + + + + +
+ + + + + + + diff --git a/docs/oncallrotation.html b/docs/oncallrotation.html new file mode 100644 index 0000000..0d6f629 --- /dev/null +++ b/docs/oncallrotation.html @@ -0,0 +1,700 @@ + + + + + + + + +On-Call Rotations + + + + + + + + + + + + + + + +
+ +Nagios + +

On-Call Rotations

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Timeperiods, Notifications + +

+ + + +

+ +Introduction + +

+ + + +Contacts + + + +Timeperiods + + + +

+ +Admins often have to shoulder the burden of answering pagers, cell phone calls, etc. when they least desire them. No one likes to be woken up at 4 am to fix a problem. But its often better to fix the problem in the middle of the night, rather than face the wrath of an unhappy boss when you stroll in at 9 am the next morning. + +

+ + + +

+ +For those lucky admins who have a team of gurus who can help share the responsibility of answering alerts, on-call rotations are often setup. Multiple admins will often alternate taking notifications on weekends, weeknights, holidays, etc. + +

+ + + +

+ +I'll show you how you can create timeperiod definitions in a way that can facilitate most on-call notification rotations. These definitions won't handle human issues that will inevitably crop up (admins calling in sick, swapping shifts, or throwing their pagers into the river), but they will allow you to setup a basic structure that should work the majority of the time. + +

+ + + +

+ +Scenario 1: Holidays and Weekends + +

+ + + +

+ +Two admins - John and Bob - are responsible for responding to Nagios alerts. John receives all notifications for weekdays (with 24 hour days), excluding holidays; Bob handles notifications during the weekends and holidays. Lucky Bob. Here's how you can define this type of rotation using timeperiods... + +

+ + + +

+ +First, define 3 timeperiods that contains time ranges for holidays, weekdays, and weekends: + +

+ + + +
	
+
+define timeperiod{
+
+	name			weekdays
+
+	timeperiod_name		weekdays
+
+	monday			00:00-24:00
+
+	tuesday			00:00-24:00
+
+	wednesday		00:00-24:00
+
+	thursday		00:00-24:00
+
+	friday			00:00-24:00
+
+	}
+
+	
+
+define timeperiod{
+
+	name			weekends
+
+	timeperiod_name		weekends
+
+	saturday		00:00-24:00
+
+	sunday			00:00-24:00
+
+	}
+
+
+
+define timeperiod{
+
+	name			holidays
+
+	timeperiod_name		holidays
+
+	january 1		00:00-24:00	; New Year's Day
+
+	2008-03-23		00:00-24:00	; Easter (2008)
+
+	2009-04-12		00:00-24:00	; Easter (2009)
+
+	monday -1 may		00:00-24:00	; Memorial Day (Last Monday in May)
+
+	july 4			00:00-24:00	; Independence Day
+
+	monday 1 september	00:00-24:00	; Labor Day (1st Monday in September)
+
+	thursday 4 november	00:00-24:00	; Thanksgiving (4th Thursday in November)
+
+	december 25		00:00-24:00	; Christmas
+
+	december 31		17:00-24:00	; New Year's Eve (5pm onwards)
+
+	}
+
+
+ + + +

+ +Next, define a timeperiod for John's on-call times that include weekdays, but excludes the dates/times defined in the holidays timeperiod above: + +

+ + + +
+
+define timeperiod{
+
+	timeperiod_name		john-oncall
+
+	use			weekdays	; Include weekdays
+
+	exclude			holidays	; Exclude holiday dates/times defined elsewhere
+
+	}
+
+
+ + + +

+ +You can now reference this timeperiod in John's contact definition: + +

+ + + +
+
+define contact{
+
+	contact_name			john
+
+	...
+
+	host_notification_period	john-oncall
+
+	service_notification_period	john-oncall
+
+	}
+
+
+ + + +

+ +Define a new timeperiod for Bob's on-call times that include weekends and the dates/times defined in the holidays timeperiod above: + +

+ + + +
+
+define timeperiod{
+
+	timeperiod_name		bob-oncall
+
+	use			weekends,holidays	; Include weekend and holiday date/times defined elsewhere
+
+	}
+
+
+ + + +

+ +You can now reference this timeperiod in Bob's contact definition: + +

+ + + +
+
+define contact{
+
+	contact_name			bob
+
+	...
+
+	host_notification_period	bob-oncall
+
+	service_notification_period	bob-oncall
+
+	}
+
+
+ + + +

+ +Scenario 2: Alternating Days + +

+ + + +

+ +In this scenario John and Bob alternate handling alerts every other day - regardless of whether its a weekend, weekday, or holiday. + +

+ + + +

+ +Define a timeperiod for when John should receive notifications. Assuming today's date is August 1st, 2007 and John is handling notifications starting today, the definition would look like this: + +

+ + + +
+
+define timeperiod{
+
+	timeperiod_name		john-oncall
+
+	2007-08-01 / 2		00:00-24:00	; Every two days, starting August 1st, 2007
+
+	}
+
+
+ + + +

+ +Now define a timeperiod for when Bob should receive notifications. Bob gets notifications on the days that John doesn't, so his first on-call day starts tomorrow (August 2nd, 2007). + +

+ + + +
+
+define timeperiod{
+
+	timeperiod_name		bob-oncall
+
+	2007-08-02 / 2		00:00-24:00	; Every two days, starting August 2nd, 2007
+
+	}
+
+
+ + + +

+ +Now you need to reference these timeperiod definitions in the contact definitions for John and Bob: + +

+ + + +
+
+define contact{
+
+	contact_name			john
+
+	...
+
+	host_notification_period	john-oncall
+
+	service_notification_period	john-oncall
+
+	}
+
+
+ + + +
+
+define contact{
+
+	contact_name			bob
+
+	...
+
+	host_notification_period	bob-oncall
+
+	service_notification_period	bob-oncall
+
+	}
+
+
+ + + +

+ +Scenario 3: Alternating Weeks + +

+ + + +

+ +In this scenario John and Bob alternate handling alerts every other week. John handles alerts Sunday through Saturday one week, and Bob handles alerts for the following seven days. This continues in perpetuity. + +

+ + + +

+ +Define a timeperiod for when John should receive notifications. Assuming today's date is Sunday, July 29th, 2007 and John is handling notifications this week (starting today), the definition would look like this: + +

+ + + +
+
+define timeperiod{
+
+	timeperiod_name		john-oncall
+
+	2007-07-29 / 14	00:00-24:00	; Every 14 days (two weeks), starting Sunday, July 29th, 2007
+
+	2007-07-30 / 14	00:00-24:00	; Every other Monday starting July 30th, 2007
+
+	2007-07-31 / 14	00:00-24:00	; Every other Tuesday starting July 31st, 2007
+
+	2007-08-01 / 14	00:00-24:00	; Every other Wednesday starting August 1st, 2007
+
+	2007-08-02 / 14	00:00-24:00	; Every other Thursday starting August 2nd, 2007
+
+	2007-08-03 / 14	00:00-24:00	; Every other Friday starting August 3rd, 2007
+
+	2007-08-04 / 14	00:00-24:00	; Every other Saturday starting August 4th, 2007
+
+	}
+
+
+ + + +

+ +Now define a timeperiod for when Bob should receive notifications. Bob gets notifications on the weeks that John doesn't, so his first on-call day starts next Sunday (August 5th, 2007). + +

+ + + +
+
+define timeperiod{
+
+	timeperiod_name		bob-oncall
+
+	2007-08-05 / 14	00:00-24:00	; Every 14 days (two weeks), starting Sunday, August 5th, 2007
+
+	2007-08-06 / 14	00:00-24:00	; Every other Monday starting August 6th, 2007
+
+	2007-08-07 / 14	00:00-24:00	; Every other Tuesday starting August 7th, 2007
+
+	2007-08-08 / 14	00:00-24:00	; Every other Wednesday starting August 8th, 2007
+
+	2007-08-09 / 14	00:00-24:00	; Every other Thursday starting August 9th, 2007
+
+	2007-08-10 / 14	00:00-24:00	; Every other Friday starting August 10th, 2007
+
+	2007-08-11 / 14	00:00-24:00	; Every other Saturday starting August 11th, 2007
+
+	}
+
+
+ + + +

+ +Now you need to reference these timeperiod definitions in the contact definitions for John and Bob: + +

+ + + +
+
+define contact{
+
+	contact_name			john
+
+	...
+
+	host_notification_period	john-oncall
+
+	service_notification_period	john-oncall
+
+	}
+
+
+ + + +
+
+define contact{
+
+	contact_name			bob
+
+	...
+
+	host_notification_period	bob-oncall
+
+	service_notification_period	bob-oncall
+
+	}
+
+
+ + + +

+ +Scenario 4: Vacation Days + +

+ + + +

+ +In this scenarios, John handles notifications for all days except those he has off. He has several standing days off each month, as well as some planned vacations. Bob handles notifications when John is on vacation or out of the office. + +

+ + + +

+ +First, define a timeperiod that contains time ranges for John's vacation days and days off: + +

+ + + +
+
+define timeperiod{
+
+	name			john-out-of-office
+
+	timeperiod_name		john-out-of-office
+
+	day 15			00:00-24:00	; 15th day of each month
+
+	day -1			00:00-24:00	; Last day of each month (28th, 29th, 30th, or 31st)
+
+	day -2			00:00-24:00	; 2nd to last day of each month (27th, 28th, 29th, or 30th)
+
+	january 2		00:00-24:00	; January 2nd each year
+
+	june 1 - july 5		00:00-24:00	; Yearly camping trip (June 1st - July 5th)
+
+	2007-11-01 - 2007-11-10	00:00-24:00	; Vacation to the US Virgin Islands (November 1st-10th, 2007)
+
+	}
+
+
+ + + +

+ +Next, define a timeperiod for John's on-call times that excludes the dates/times defined in the timeperiod above: + +

+ + + +
+
+define timeperiod{
+
+	timeperiod_name		john-oncall
+
+	monday			00:00-24:00
+
+	tuesday			00:00-24:00
+
+	wednesday		00:00-24:00
+
+	thursday		00:00-24:00
+
+	friday			00:00-24:00
+
+	exclude			john-out-of-office	; Exclude dates/times John is out
+
+	}
+
+
+ + + +

+ +You can now reference this timeperiod in John's contact definition: + +

+ + + +
+
+define contact{
+
+	contact_name			john
+
+	...
+
+	host_notification_period	john-oncall
+
+	service_notification_period	john-oncall
+
+	}
+
+
+ + + +

+ +Define a new timeperiod for Bob's on-call times that include the dates/times that John is out of the office: + +

+ + + +
+
+define timeperiod{
+
+	timeperod_name		bob-oncall
+
+	use			john-out-of-office	; Include holiday date/times that John is out
+
+	}
+
+
+ + + +

+ +You can now reference this timeperiod in Bob's contact definition: + +

+ + + +
+
+define contact{
+
+	contact_name			bob
+
+	...
+
+	host_notification_period	bob-oncall
+
+	service_notification_period	bob-oncall
+
+	}
+
+
+ + + +

+ +Other Scenarios + +

+ + + +

+ +There are a lot of other on-call notification rotation scenarios that you might have. The date exception directive in timeperiod definitions is capable of handling most dates and date ranges that you might need to use, so check out the different formats that you can use. If you make a mistake when creating timeperiod definitions, always err on the side of giving someone else more on-call duty time. :-) + +

+ + + + + +
+ + + + + + + diff --git a/docs/passivechecks.html b/docs/passivechecks.html new file mode 100644 index 0000000..860bc5d --- /dev/null +++ b/docs/passivechecks.html @@ -0,0 +1,438 @@ + + + + + + + + +Passive Checks + + + + + + + + + + + + + + + +
+ +Nagios + +

Passive Checks

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Active Checks, Service Checks, Host Checks + +

+ + + +

+ +Introduction + +

+ + + +

+ +In most cases you'll use Nagios to monitor your hosts and services using regularly scheduled active checks. Active checks can be used to "poll" a device or service for status information every so often. Nagios also supports a way to monitor hosts and services passively instead of actively. They key features of passive checks are as follows: + +

+ + + + + + + +

+ +The major difference between active and passive checks is that active checks are initiated and performed by Nagios, while passive checks are performed by external applications. + +

+ + + +

+ +Uses For Passive Checks + +

+ + + +

+ +Passive checks are useful for monitoring services that are: + +

+ + + + + + + +

+ +Examples of asynchronous services that lend themselves to being monitored passively include SNMP traps and security alerts. You never know how many (if any) traps or alerts you'll receive in a given time frame, so it's not feasible to just monitor their status every few minutes. + +

+ + + +

+ +Passive checks are also used when configuring distributed or redundant monitoring installations. + +

+ + + +

+ +How Passive Checks Work + +

+ + + +Passive Checks + + + +

+ +Here's how passive checks work in more detail... + +

+ + + +
    + +
  1. An external application checks the status of a host or service.

    2. + +
  2. The external application writes the results of the check to the external command file.

    3. + +
  3. The next time Nagios reads the external command file it will place the results of all passive checks into a queue for later processing. The same queue that is used for storing results from active checks is also used to store the results from passive checks.

    4. + +
  4. Nagios will periodically execute a check result reaper event and scan the check result queue. Each service check result that is found in the queue is processed in the same manner - regardless of whether the check was active or passive. Nagios may send out notifications, log alerts, etc. depending on the check result information.

    5. + +
+ + + +

+ +The processing of active and passive check results is essentially identical. This allows for seamless integration of status information from external applications with Nagios. + +

+ + + +
+ + + +

+ +Enabling Passive Checks + +

+ + + +

+ +In order to enable passive checks in Nagios, you'll need to do the following: + +

+ + + + + + + +

+ +If you want to disable processing of passive checks on a global basis, set the accept_passive_service_checks directive to 0. + +

+ + + +

+ +If you would like to disable passive checks for just a few hosts or services, use the passive_checks_enabled directive in the host and/or service definitions to do so. + +

+ + + + + +

+ +Submitting Passive Service Check Results + +

+ + + +

+ +External applications can submit passive service check results to Nagios by writing a PROCESS_SERVICE_CHECK_RESULT external command to the external command file. + +

+ + + +

+ +The format of the command is as follows: + +

+ + + +
+
+[<timestamp>] PROCESS_SERVICE_CHECK_RESULT;<host_name>;<svc_description>;<return_code>;<plugin_output>
+
+
+ + + +

+ +where... + +

+ + + + + + + +

+ +Note + +Note: A service must be defined in Nagios before you can submit passive check results for it! Nagios will ignore all check results for services that had not been configured before it was last (re)started. + +

+ + + +

+ +Tip + +An example shell script of how to submit passive service check results to Nagios can be found in the documentation on volatile services. + +

+ + + +

+ +Submitting Passive Host Check Results + +

+ + + +

+ +External applications can submit passive host check results to Nagios by writing a PROCESS_HOST_CHECK_RESULT external command to the external command file. + +

+ + + +

+ +The format of the command is as follows: + +

+ + + +
+
+[<timestamp>] PROCESS_HOST_CHECK_RESULT;<host_name>;<host_status>;<plugin_output>
+
+
+ + + +

+ +where... + +

+ + + + + + + +

+ +Note + +Note: A host must be defined in Nagios before you can submit passive check results for it! Nagios will ignore all check results for hosts that had not been configured before it was last (re)started. + +

+ + + +

+ +Passive Checks and Host States + +

+ + + +

+ +Unlike with active host checks, Nagios does not (by default) attempt to determine whether or host is DOWN or UNREACHABLE with passive checks. Rather, Nagios takes the passive check result to be the actual state the host is in and doesn't try to determine the host's actual state using the reachability logic. This can cause problems if you are submitting passive checks from a remote host or you have a distributed monitoring setup where the parent/child host relationships are different. + +

+ + + +

+ +You can tell Nagios to translate DOWN/UNREACHABLE passive check result states to their "proper" state by using the translate_passive_host_checks variable. More information on how this works can be found here. + +

+ + + +

+ +Note Note: Passive host checks are normally treated as HARD states, unless the passive_host_checks_are_soft option is enabled. + +

+ + + + + +

+ +Submitting Passive Check Results From Remote Hosts + +

+ + + +NSCA Addon + + + +

+ +If an application that resides on the same host as Nagios is sending passive host or service check results, it can simply write the results directly to the external command file as outlined above. However, applications on remote hosts can't do this so easily. + +

+ + + +

+ +In order to allow remote hosts to send passive check results to the monitoring host, I've developed the NSCA addon. The NSCA addon consists of a daemon that runs on the Nagios hosts and a client that is executed from remote hosts. The daemon will listen for connections from remote clients, perform some basic validation on the results being submitted, and then write the check results directly into the external command file (as described above). More information on the NSCA addon can be found here. + +

+ + + +
+ + + +
+ + + + + + + diff --git a/docs/passivestatetranslation.html b/docs/passivestatetranslation.html new file mode 100644 index 0000000..c40c334 --- /dev/null +++ b/docs/passivestatetranslation.html @@ -0,0 +1,186 @@ + + + + + + + + +Passive Host State Translation + + + + + + + + + + + + + + + +
+ +Nagios + +

Passive Host State Translation

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Host Checks, Network Reachability, Passive Checks, Distributed Monitoring, Redundant/Failover Monitoring + +

+ + + +

+ +Introduction + +

+ + + +

+ +When Nagios receives passive host checks from remote sources (i.e other Nagios instances in distributed or failover setups), the host state reported by the remote source may not accurately reflect the state of the host from Nagios' view. As distributed and failover monitoring installations are fairly common, it is important to provide a mechanism for ensuring accurate host states between different instances of Nagios. + +

+ + + +

+ +Different World Views + +

+ + + +

+ +The image below shows a simplified view of a failover monitoring setup. + +

+ + + + + + + +Passive State Translation + + + +

+ +What states are Router-C and Router-D currently in? The answer depends on which Nagios instance you ask. + +

+ + + + + + + +

+ +Each Nagios instance has a different view of the network. The backup monitoring servers should not blindly accept passive host states from the primary monitoring server, or they will have incorrect information on the current state of the network. + +

+ + + +

+ +Without translating passive host check results from the primary monitoring server (Nagios-A), Nagios-C would see Router-D as UNREACHABLE, when it is really DOWN based on its viewpoint. Similarly, the DOWN/UNREACHABLE states (from the viewpoint of Nagios-A) for Router-C and Router-D should be flipped from the viewpoint of Nagios-B. + +

+ + + +

+ +Note Note: There may be some situations where you do not want Nagios to translate DOWN/UNREACHABLE states from remote sources to their "correct" state from the viewpoint of the local Nagios instance. For example, in distributed monitoring environments you may want the central Nagios instance to know how distributed instances see their respective portions of the network. + +

+ + + +

+ +Enabling State Translation + +

+ + + +

+ +By default, Nagios will not automatically translate DOWN/UNREACHABLE states from passive check results. You will need to enable this feature if you need and want it. + +

+ + + +

+ +The automatic translation of passive host check states is controlled by the translate_passive_host_checks variable. Enable it and Nagios will automatically translate DOWN and UNREACHABLE states from remote sources to their correct state for the local instance of Nagios. + +

+ + + + + + + +
+ + + + + + + diff --git a/docs/perfdata.html b/docs/perfdata.html new file mode 100644 index 0000000..017ac25 --- /dev/null +++ b/docs/perfdata.html @@ -0,0 +1,346 @@ + + + + + + + + +Performance Data + + + + + + + + + + + + + + + +
+ +Nagios + +

Performance Data

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Plugins, Plugin API + +

+ + + +

+ +Introduction + +

+ + + +

+ +Nagios is designed to allow plugins to return optional performance data in addition to normal status data, as well as allow you to pass that performance data to external applications for processing. A description of the different types of performance data, as well as information on how to go about processing that data is described below... + +

+ + + +

+ +Types of Performance Data + +

+ + + +

+ +There are two basic categories of performance data that can be obtained from Nagios: + +

+ + + +
    + +
  1. Check performance data + +
  2. Plugin performance data + +
+ + + +

+ +Check performance data is internal data that relates to the actual execution of a host or service check. This might include things like service check latency (i.e. how "late" was the service check from its scheduled execution time) and the number of seconds a host or service check took to execute. This type of performance data is available for all checks that are performed. The $HOSTEXECUTIONTIME$ and $SERVICEEXECUTIONTIME$ macros can be used to determine the number of seconds a host or service check was running and the $HOSTLATENCY$ and $SERVICELATENCY$ macros can be used to determine how "late" a regularly-scheduled host or service check was. + +

+ + + +

+ +Plugin performance data is external data specific to the plugin used to perform the host or service check. Plugin-specific data can include things like percent packet loss, free disk space, processor load, number of current users, etc. - basically any type of metric that the plugin is measuring when it executes. Plugin-specific performance data is optional and may not be supported by all plugins. Plugin-specific performance data (if available) can be obtained by using the $HOSTPERFDATA$ and $SERVICEPERFDATA$ macros. Read on for more information on how plugins can return performance data to Nagios for inclusion in the $HOSTPERFDATA$ and $SERVICEPERFDATA$ macros. + +

+ + + +

+ +Plugin Performance Data + +

+ + + +

+ +At a minimum, Nagios plugins must return a single line of human-readable text that indicates the status of some type of measurable data. For example, the check_ping plugin might return a line of text like the following: + +

+ + + +
+
+PING ok - Packet loss = 0%, RTA = 0.80 ms 
+
+
+ + + +

+ +With this simple type of output, the entire line of text is available in the $HOSTOUTPUT$ or $SERVICEOUTPUT$ macros (depending on whether this plugin was used as a host check or service check). + +

+ + + +

+ +Plugins can return optional performance data in their output by sending the normal, human-readable text string that they usually would, followed by a pipe character (|), and then a string containing one or more performance data metrics. Let's take the check_ping plugin as an example and assume that it has been enhanced to return percent packet loss and average round trip time as performance data metrics. Sample output from the plugin might look like this: + +

+ + + +
+
+PING ok - Packet loss = 0%, RTA = 0.80 ms | percent_packet_loss=0, rta=0.80
+
+
+ + + +

+ +When Nagios sees this plugin output format it will split the output into two parts: + +

+ + + +
    + +
  1. Everything before the pipe character is considered to be the "normal" plugin output and will be stored in either the $HOSTOUTPUT$ or $SERVICEOUTPUT$ macro
    2. + +
  2. Everything after the pipe character is considered to be the plugin-specific performance data and will be stored in the $HOSTPERFDATA$ or $SERVICEPERFDATA$ macro
    3. + +
+ + + +

+ +In the example above, the $HOSTOUTPUT$ or $SERVICEOUTPUT$ macro would contain "PING ok - Packet loss = 0%, RTA = 0.80 ms" (without quotes) and the $HOSTPERFDATA$ or $SERVICEPERFDATA$ macro would contain "percent_packet_loss=0, rta=0.80" (without quotes). + +

+ + + +

+ +Multiple lines of performace data (as well as normal text output) can be obtained from plugins, as described in the plugin API documentation. + +

+ + + +

+ +Note Note: The Nagios daemon doesn't directly process plugin performance data, so it doesn't really care what the performance data looks like. There aren't really any inherent limitations on the format or content of the performance data. However, if you are using an external addon to process the performance data (i.e. PerfParse), the addon may be expecting that the plugin returns performance data in a specific format. Check the documentation that comes with the addon for more information. + +

+ + + +

+ +Processing Performance Data + +

+ + + +

+ +If you want to process the performance data that is available from Nagios and the plugins, you'll need to do the following: + +

+ + + +
    + +
  1. Enable the process_performance_data option.

    + +
  2. Configure Nagios so that performance data is either written to files and/or processed by executing commands. + +
+ + + +

+ +Read on for information on how to process performance data by writing to files or executing commands. + +

+ + + +

+ +Processing Performance Data Using Commands + +

+ + + +

+ +The most flexible way to process performance data is by having Nagios execute commands (that you specify) to process or redirect the data for later processing by external applications. The commands that Nagios executes to process host and service performance data are determined by the host_perfdata_command and service_perfdata_command options, respectively. + +

+ + + +

+ +An example command definition that redirects service check performance data to a text file for later processing by another application is shown below: + +

+ + + +
+
+define command{
+
+	command_name	store-service-perfdata
+
+	command_line	/bin/echo -e "$LASTSERVICECHECK$\t$HOSTNAME$\t$SERVICEDESC$\t$SERVICESTATE$\t$SERVICEATTEMPT$\t$SERVICESTATETYPE$\t$SERVICEEXECUTIONTIME$\t$SERVICELATENCY$\t$SERVICEOUTPUT$\t$SERVICEPERFDATA$" >> /usr/local/nagios/var/service-perfdata.dat
+
+	}
+
+
+ + + + + +

+ +Tip Tip: This method, while flexible, comes with a relatively high CPU overhead. If you're processing performance data for a large number of hosts and services, you'll probably want Nagios to write performance data to files instead. This method is described in the next section. + +

+ + + +

+ +Writing Performance Data To Files + +

+ + + +

+ +You can have Nagios write all host and service performance data directly to text files using the host_perfdata_file and service_perfdata_file options. The format in which host and service performance data is written to those files is determined by the host_perfdata_file_template and service_perfdata_file_template options. + +

+ + + +

+ +An example file format template for service performance data might look like this: + +

+ + + +
+
+service_perfdata_file_template=[SERVICEPERFDATA]\t$TIMET$\t$HOSTNAME$\t$SERVICEDESC$\t$SERVICEEXECUTIONTIME$\t$SERVICELATENCY$\t$SERVICEOUTPUT$\t$SERVICEPERFDATA$
+
+
+ + + +

+ +By default, the text files will be opened in "append" mode. If you need to change the modes to "write" or "non-blocking read/write" (useful when writing to pipes), you can use the host_perfdata_file_mode and service_perfdata_file_mode options. + +

+ + + +

+ +Additionally, you can have Nagios periodically execute commands to periocially process the performance data files (e.g. rotate them) using the host_perfdata_file_processing_command and service_perfdata_file_processing_command options. The interval at which these commands are executed are governed by the host_perfdata_file_processing_interval and service_perfdata_file_processing_interval options, respectively. + +

+ + + + + +
+ + + + + + + diff --git a/docs/pluginapi.html b/docs/pluginapi.html new file mode 100644 index 0000000..d9bf885 --- /dev/null +++ b/docs/pluginapi.html @@ -0,0 +1,416 @@ + + + + + + + + +Nagios Plugin API + + + + + + + + + + + + + + + +
+ +Nagios + +

Nagios Plugin API

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Plugin Overview, Developing Plugins For Use With Embedded Perl, Performance Data + +

+ + + +

+ +Other Resources + +

+ + + +

+ +If you're looking at writing your own plugins for Nagios, please make sure to visit these other resources: + +

+ + + + + + + +

+ +Plugin Overview + +

+ + + +

+ +Scripts and executables must do two things (at a minimum) in order to function as Nagios plugins: + +

+ + + + + + + +

+ +The inner workings of your plugin are unimportant to Nagios. Your plugin could check the status of a TCP port, run a database query, check disk free space, or do whatever else it needs to check something. The details will depend on what needs to be checked - that's up to you. + +

+ + + +

+ +Return Code + +

+ + + +

+ +Nagios determines the status of a host or service by evaluating the return code from plugins. The following tables shows a list of valid return codes, along with their corresponding service or host states. + +

+ + + + + + + + + + + + + + + +
Plugin Return CodeService StateHost State
0OKUP
1WARNINGUP or DOWN/UNREACHABLE*
2CRITICALDOWN/UNREACHABLE
3UNKNOWNDOWN/UNREACHABLE
+ + + +

+ +Note Note: If the use_aggressive_host_checking option is enabled, return codes of 1 will result in a host state of DOWN or UNREACHABLE. Otherwise return codes of 1 will result in a host state of UP. The process by which Nagios determines whether or not a host is DOWN or UNREACHABLE is discussed here. + +

+ + + + + +

+ +Plugin Output Spec + +

+ + + +

+ +At a minimum, plugins should return at least one of text output. Beginning with Nagios 3, plugins can optionally return multiple lines of output. Plugins may also return optional performance data that can be processed by external applications. The basic format for plugin output is shown below: + +

+ + + +

+ +TEXT OUTPUT | OPTIONAL PERFDATA
+ +LONG TEXT LINE 1
+ +LONG TEXT LINE 2
+ +...
+ +LONG TEXT LINE N | PERFDATA LINE 2
+ +PERFDATA LINE 3
+ +...
+ +PERFDATA LINE N + +

+ + + +

+ +The performance data (shown in orange) is optional. If a plugin returns performance data in its output, it must separate the performance data from the other text output using a pipe (|) symbol. Additional lines of long text output (shown in blue) are also optional. + +

+ + + +

+ +Plugin Output Examples + +

+ + + +

+ +Let's see some examples of possible plugin output... + +

+ + + +

+ +Case 1: One line of output (text only)
+ +Assume we have a plugin that returns one line of output that looks like this: + +

+ + + +
+ +
DISK OK - free space: / 3326 MB (56%);
+ +
+ + + +

+ +If this plugin was used to perform a service check, the entire line of output will be stored in the $SERVICEOUTPUT$ macro. + +

+ + + +

+ +Case 2: One line of output (text and perfdata)
+ +A plugin can return optional performance data for use by external applications. To do this, the performance data must be separated from the text output with a pipe (|) symbol like such: + +

+ + + +
+ +
DISK OK - free space: / 3326 MB (56%);
 | 
/=2643MB;5948;5958;0;5968
+ +
+ + + +
If this plugin was used to perform a service check, the
+ +
 red 
+ +
portion of output (left of the pipe separator) will be stored in the $SERVICEOUTPUT$ macro and the
+ +
 orange 
+ +
portion of output (right of the pipe separator) will be stored in the $SERVICEPERFDATA$ macro.
+ + + +

+ +Case 3: Multiple lines of output (text and perfdata)
+ +A plugin optionally return multiple lines of both text output and perfdata, like such: + +

+ + + +
+ +DISK OK - free space: / 3326 MB (56%); | /=2643MB;5948;5958;0;5968
+ +/ 15272 MB (77%);
+ +/boot 68 MB (69%);
+ +/home 69357 MB (27%);
+ +/var/log 819 MB (84%); | /boot=68MB;88;93;0;98
+ +/home=69357MB;253404;253409;0;253414
+ +/var/log=818MB;970;975;0;980
+ +
+ + + +

+ +If this plugin was used to perform a service check, the red portion of first line of output (left of the pipe separator) will be stored in the $SERVICEOUTPUT$ macro. + +The orange portions of the first and subsequent lines are concatenated (with spaces) are stored in the $SERVICEPERFDATA$ macro. The blue portions of the 2nd - 5th lines of output will be concatenated (with escaped newlines) and stored in $LONGSERVICEOUTPUT$ the macro. + +

+ + + +

The final contents of each macro are listed below:

+ + + + + + + + + + + + + +
MacroValue
$SERVICEOUTPUT$DISK OK - free space: / 3326 MB (56%);
$SERVICEPERFDATA$/=2643MB;5948;5958;0;5968 /boot=68MB;88;93;0;98 /home=69357MB;253404;253409;0;253414 /var/log=818MB;970;975;0;980
$LONGSERVICEOUTPUT$/ 15272 MB (77%);\n/boot 68 MB (69%);\n/var/log 819 MB (84%);
+ + + +

+ +With regards to multiple lines of output, you have the following options for returning performance data: + +

+ + + + + + + +

+ +Plugin Output Length Restrictions + +

+ + + +

+ +Nagios will only read the first 4 KB of data that a plugin returns. This is done in order to prevent runaway plugins from dumping megs or gigs of data back to Nagios. This 4 KB output limit is fairly easy to change if you need. Simply edit the value of the MAX_PLUGIN_OUTPUT_LENGTH definition in the include/nagios.h.in file of the source code distribution and recompile Nagios. There's nothing else you need to change! + +

+ + + +

+ +Examples + +

+ + + +

+ +If you're looking for some example plugins to study, I would recommend that you download the official Nagios plugins and look through the code for various C, Perl, and shell script plugins. Information on obtaining the official Nagios plugins can be found here. + +

+ + + +

+ +Perl Plugins + +

+ + + +

+ +Nagios features an optional embedded Perl interpreter which can speed up the execution of Perl plugins. More information on developing Perl plugins for use with the embedded Perl interpreter can be found here. + +

+ + + + + +
+ + + + + + + diff --git a/docs/plugins.html b/docs/plugins.html new file mode 100644 index 0000000..fc570e7 --- /dev/null +++ b/docs/plugins.html @@ -0,0 +1,248 @@ + + + + + + + + +Nagios Plugins + + + + + + + + + + + + + + + +
+ +Nagios + +

Nagios Plugins

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Plugin API, Embedded Perl Interpreter Overview, Active Checks + +

+ + + +

+ +Introduction + +

+ +

+ +Unlike many other monitoring tools, Nagios does not include any internal mechanisms for checking the status of hosts and services on your network. Instead, Nagios relies on external programs (called plugins) to do all the dirty work. + +

+ + + +

+ +What Are Plugins? + +

+ + + +

+ +Plugins are compiled executables or scripts (Perl scripts, shell scripts, etc.) that can be run from a command line to check the status or a host or service. Nagios uses the results from plugins to determine the current status of hosts and services on your network. + +

+ + + +

+ +Nagios will execute a plugin whenever there is a need to check the status of a service or host. The plugin does something (notice the very general term) to perform the check and then simply returns the results to Nagios. Nagios will process the results that it receives from the plugin and take any necessary actions (running event handlers, sending out notifications, etc). + +

+ + + +

+ +Plugins As An Abstraction Layer + +

+ + + +Plugins + + + +

+ +Plugins act as an abstraction layer between the monitoring logic present in the Nagios daemon and the actual services and hosts that are being monitored. + +

+ + + +

+ +The upside of this type of plugin architecture is that you can monitor just about anything you can think of. If you can automate the process of checking something, you can monitor it with Nagios. There are already a lot of plugins that have been created in order to monitor basic resources such as processor load, disk usage, ping rates, etc. If you want to monitor something else, take a look at the documentation on writing plugins and roll your own. Its simple! + +

+ + + +

+ +The downside to this type of plugin architecture is the fact that Nagios has absolutely no idea what it is that you're monitoring. You could be monitoring network traffic statistics, data error rates, room temperate, CPU voltage, fan speed, processor load, disk space, or the ability of your super-fantastic toaster to properly brown your bread in the morning... Nagios doesn't understand the specifics of what's being monitored - it just tracks changes in the state of those resources. Only the plugins themselves know exactly what they're monitoring and how to perform the actual checks. + +

+ + + + + +
+ + + +

+ +What Plugins Are Available? + +

+ + + +

+ +There are plugins currently available to monitor many different kinds of devices and services, including: + +

+ + + + + + + +

+ +Obtaining Plugins + +

+ + + +

+ +Plugins are not distributed with Nagios, but you can download the official Nagios plugins and many additional plugins created and maintained by Nagios users from the following locations: + +

+ + + + + + + +

+ +How Do I Use Plugin X? + +

+ + + +

+ +Most all plugins will display basic usage information when you execute them using '-h' or '--help' on the command line. For example, if you want to know how the check_http plugin works or what options it accepts, you should try executing the following command: + +

+ + + +
+
+./check_http --help
+
+
+ + + + + +

+ +Plugin API + +

+ + + +

+ +You can find information on the technical aspects of plugins, as well as how to go about creating your own custom plugins here. + +

+ + + +
+ + + + + + + diff --git a/docs/quickstart-fedora.html b/docs/quickstart-fedora.html new file mode 100644 index 0000000..1dd67b0 --- /dev/null +++ b/docs/quickstart-fedora.html @@ -0,0 +1,747 @@ + + + + + + + + +Fedora Quickstart + + + + + + + + + + + + + + + +
+ +Nagios + +

Fedora Quickstart

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Quickstart Installation Guides, Security Considerations + +

+ + + +

+ +Introduction + +

+ + + +

+ +This guide is intended to provide you with simple instructions on how to install Nagios from source (code) on Fedora and have it monitoring your local machine inside of 20 minutes. No advanced installation options are discussed here - just the basics that will work for 95% of users who want to get started. + +

+ + + +

+ +These instructions were written based on a standard Fedora Core 6 Linux distribution. + +

+ + + +

+ +What You'll End Up With + +

+ + + +

+ +If you follow these instructions, here's what you'll end up with: + +

+ + + + + + + +

+ +Prerequisites + +

+ + + +

+ +During portions of the installation you'll need to have root access to your machine. + +

+ + + +

+ +Make sure you've installed the following packages on your Fedora installation before continuing. + +

+ + + + + + + +

+ +You can use yum to install these packages by running the following commands (as root): + +

+ + + +
+
+yum install httpd php
+
+yum install gcc glibc glibc-common
+
+yum install gd gd-devel
+
+
+ + + +

+ +1) Create Account Information + +

+ + + +

+ +Become the root user. + +

+ + + +
+
+su -l
+
+
+ + + +

+ +Create a new nagios user account and give it a password. + +

+ + + +
+
+/usr/sbin/useradd -m nagios
+
+passwd nagios
+
+
+ + + +

+ +Create a new nagcmd group for allowing external commands to be submitted through the web interface. Add both the nagios user and the apache user to the group. + +

+ + + +
+
+/usr/sbin/groupadd nagcmd
+
+/usr/sbin/usermod -a -G nagcmd nagios
+
+/usr/sbin/usermod -a -G nagcmd apache
+
+
+ + + +

+ +2) Download Nagios and the Plugins + +

+ + + +

+ +Create a directory for storing the downloads. + +

+ + + +
+
+mkdir ~/downloads
+
+cd ~/downloads
+
+
+ + + +

+ +Download the source code tarballs of both Nagios and the Nagios plugins (visit http://www.nagios.org/download/ for links to the latest versions). These directions were tested with Nagios 3.1.1 and Nagios Plugins 1.4.11. + +

+ + + +
+
+wget http://prdownloads.sourceforge.net/sourceforge/nagios/nagios-3.2.1.tar.gz
+
+wget http://prdownloads.sourceforge.net/sourceforge/nagiosplug/nagios-plugins-1.4.11.tar.gz
+
+
+ + + +

+ +3) Compile and Install Nagios + +

+ + + +

+ +Extract the Nagios source code tarball. + +

+ + + +
+
+cd ~/downloads
+
+tar xzf nagios-3.2.1.tar.gz
+
+cd nagios-3.2.1
+
+
+ + + +

+ +Run the Nagios configure script, passing the name of the group you created earlier like so: + +

+ + + +
+
+./configure --with-command-group=nagcmd
+
+
+ + + +

+ +Compile the Nagios source code. + +

+ + + +
+
+make all
+
+
+ + + +

+ +Install binaries, init script, sample config files and set permissions on the external command directory. + +

+ + + +
+
+make install
+
+make install-init
+
+make install-config
+
+make install-commandmode
+
+
+ + + +

+ +Don't start Nagios yet - there's still more that needs to be done... + +

+ + + +

+ +4) Customize Configuration + +

+ + + +

+ +Sample configuration files have now been installed in the /usr/local/nagios/etc directory. These sample files should work fine for getting started with Nagios. You'll need to make just one change before you proceed... + +

+ + + +

+ +Edit the /usr/local/nagios/etc/objects/contacts.cfg config file with your favorite editor and change the email address associated with the nagiosadmin contact definition to the address you'd like to use for receiving alerts. + +

+ + + +
+
+vi /usr/local/nagios/etc/objects/contacts.cfg
+
+
+ + + +

+ +5) Configure the Web Interface + +

+ + + +

+ +Install the Nagios web config file in the Apache conf.d directory. + +

+ + + +
+
+make install-webconf
+
+
+ + + +

+ +Create a nagiosadmin account for logging into the Nagios web interface. Remember the password you assign to this account - you'll need it later. + +

+ + + +
+
+htpasswd -c /usr/local/nagios/etc/htpasswd.users nagiosadmin
+
+
+ + + +

+ +Restart Apache to make the new settings take effect. + +

+ + + +
+
+service httpd restart
+
+
+ + + +

+ +Note Note: Consider implementing the ehanced CGI security measures described here to ensure that your web authentication credentials are not compromised. + +

+ + + + + +

+ +6) Compile and Install the Nagios Plugins + +

+ + + +

+ +Extract the Nagios plugins source code tarball. + +

+ + + +
+
+cd ~/downloads
+
+tar xzf nagios-plugins-1.4.11.tar.gz
+
+cd nagios-plugins-1.4.11
+
+
+ + + +

+ +Compile and install the plugins. + +

+ + + +
+
+./configure --with-nagios-user=nagios --with-nagios-group=nagios
+
+make
+
+make install
+
+
+ + + + + +

+ +7) Start Nagios + +

+ + + +

+ +Add Nagios to the list of system services and have it automatically start when the system boots. + +

+ + + +
+
+chkconfig --add nagios
+
+chkconfig nagios on
+
+
+ + + +

+ +Verify the sample Nagios configuration files. + +

+ + + +
+
+/usr/local/nagios/bin/nagios -v /usr/local/nagios/etc/nagios.cfg
+
+
+ + + +

+ +If there are no errors, start Nagios. + +

+ + + +
+
+service nagios start
+
+
+ + + +

+ +8) Modify SELinux Settings + +

+ + + +

+ +Fedora ships with SELinux (Security Enhanced Linux) installed and in Enforcing mode by default. This can result in "Internal Server Error" messages when you attempt to access the Nagios CGIs. + +

+ + + +

+ +See if SELinux is in Enforcing mode. + +

+ + + +
+
+getenforce
+
+
+ + + +

+ +Put SELinux into Permissive mode. + +

+ + + +
+
+setenforce 0
+
+
+ + + +

+ +To make this change permanent, you'll have to modify the settings in /etc/selinux/config and reboot. + +

+ + + +

+ +Instead of disabling SELinux or setting it to permissive mode, you can use the following command to run the CGIs under SELinux enforcing/targeted mode: + +

+ + + +
+
+chcon -R -t httpd_sys_content_t /usr/local/nagios/sbin/
+
+chcon -R -t httpd_sys_content_t /usr/local/nagios/share/
+
+
+ + + +

+ +For information on running the Nagios CGIs under Enforcing mode with a targeted policy, visit the Nagios Support Portal or Nagios Community Wiki. + +

+ + + +

+ +9) Login to the Web Interface + +

+ + + +

+ +You should now be able to access the Nagios web interface at the URL below. You'll be prompted for the username (nagiosadmin) and password you specified earlier. + +

+ + + +
+
+http://localhost/nagios/
+
+
+ + + +

+ +Click on the "Service Detail" navbar link to see details of what's being monitored on your local machine. It will take a few minutes for Nagios to check all the services associated with your machine, as the checks are spread out over time. + +

+ + + +

+ +10) Other Modifications + +

+ + + +

+ +Make sure your machine's firewall rules are configured to allow access to the web server if you want to access the Nagios interface remotely. + +

+ + + +

+ +Configuring email notifications is out of the scope of this documentation. While Nagios is currently configured to send you email notifications, your system may not yet have a mail program properly installed or configured. Refer to your system documentation, search the web, or look to the Nagios Support Portal or Nagios Community Wiki for specific instructions on configuring your system to send email messages to external addresses. More information on notifications can be found here. + +

+ + + +

+ +11) You're Done + +

+ + + +

+ +Congratulations! You sucessfully installed Nagios. Your journey into monitoring is just beginning. You'll no doubt want to monitor more than just your local machine, so check out the following docs... + +

+ + + + + + + +
+ + + + + + \ No newline at end of file diff --git a/docs/quickstart-opensuse.html b/docs/quickstart-opensuse.html new file mode 100644 index 0000000..3ba07f8 --- /dev/null +++ b/docs/quickstart-opensuse.html @@ -0,0 +1,617 @@ + + + + + + + + +openSUSE Quickstart + + + + + + + + + + + + + + + +
+ +Nagios + +

openSUSE Quickstart

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Quickstart Installation Guides, Security Considerations + +

+ + + +

+ +Introduction + +

+ + + +

+ +This guide is intended to provide you with simple instructions on how to install Nagios from source (code) on openSUSE and have it monitoring your local machine inside of 20 minutes. No advanced installation options are discussed here - just the basics that will work for 95% of users who want to get started. + +

+ + + +

+ +These instructions were written based on an openSUSE 10.2 installation. + +

+ + + +

+ +Required Packages + +

+ + + +

+ +Make sure you've installed the following packages on your openSUSE installation before continuing. You can use yast to install packages under openSUSE. + +

+ + + + + + + +

+ +1) Create Account Information + +

+ + + +

+ +Become the root user. + +

+ + + +
+
+su -l
+
+
+ + + +

+ +Create a new nagios user account and give it a password. + +

+ + + +
+
+/usr/sbin/useradd -m nagios
+
+passwd nagios
+
+
+ + + +

+ +Create a new nagios group. Add the nagios user to the group. + +

+ + + +
+
+/usr/sbin/groupadd nagios
+
+/usr/sbin/usermod -G nagios nagios
+
+
+ + + +

+ +Create a new nagcmd group for allowing external commands to be submitted through the web interface. Add both the nagios user and the apache user to the group. + +

+ + + +
+
+/usr/sbin/groupadd nagcmd
+
+/usr/sbin/usermod -a -G nagcmd nagios
+
+/usr/sbin/usermod -a -G nagcmd wwwrun
+
+
+ + + +

+ +2) Download Nagios and the Plugins + +

+ + + +

+ +Create a directory for storing the downloads. + +

+ + + +
+
+mkdir ~/downloads
+
+cd ~/downloads
+
+
+ + + +

+ +Download the source code tarballs of both Nagios and the Nagios plugins (visit http://www.nagios.org/download/ for links to the latest versions). These directions were tested with Nagios 3.1.1 and Nagios Plugins 1.4.11. + +

+ + + +
+
+wget http://prdownloads.sourceforge.net/sourceforge/nagios/nagios-3.2.1.tar.gz
+
+wget http://prdownloads.sourceforge.net/sourceforge/nagiosplug/nagios-plugins-1.4.11.tar.gz
+
+
+ + + +

+ +3) Compile and Install Nagios + +

+ + + +

+ +Extract the Nagios source code tarball. + +

+ + + +
+
+cd ~/downloads
+
+tar xzf nagios-3.2.1.tar.gz
+
+cd nagios-3.2.1
+
+
+ + + +

+ +Run the Nagios configure script, passing the name of the group you created earlier like so: + +

+ + + +
+
+./configure --with-command-group=nagcmd
+
+
+ + + +

+ +Compile the Nagios source code. + +

+ + + +
+
+make all
+
+
+ + + +

+ +Install binaries, init script, sample config files and set permissions on the external command directory. + +

+ + + +
+
+make install
+
+make install-init
+
+make install-config
+
+make install-commandmode
+
+
+ + + +

+ +Don't start Nagios yet - there's still more that needs to be done... + +

+ + + +

+ +4) Customize Configuration + +

+ + + +

+ +Sample configuration files have now been installed in the /usr/local/nagios/etc directory. These sample files should work fine for getting started with Nagios. You'll need to make just one change before you proceed... + +

+ + + +

+ +Edit the /usr/local/nagios/etc/objects/contacts.cfg config file with your favorite editor and change the email address associated with the nagiosadmin contact definition to the address you'd like to use for receiving alerts. + +

+ + + +
+
+vi /usr/local/nagios/etc/objects/contacts.cfg
+
+
+ + + +

+ +5) Configure the Web Interface + +

+ + + +

+ +Install the Nagios web config file in the Apache conf.d directory. + +

+ + + +
+
+make install-webconf
+
+
+ + + +

+ +Create a nagiosadmin account for logging into the Nagios web interface. Remember the password you assign to this account - you'll need it later. + +

+ + + +
+
+htpasswd2 -c /usr/local/nagios/etc/htpasswd.users nagiosadmin
+
+
+ + + +

+ +Restart Apache to make the new settings take effect. + +

+ + + +
+
+service apache2 restart
+
+
+ + + +

+ +Note Note: Consider implementing the ehanced CGI security measures described here to ensure that your web authentication credentials are not compromised. + +

+ + + +

+ +6) Compile and Install the Nagios Plugins + +

+ + + +

+ +Extract the Nagios plugins source code tarball. + +

+ + + +
+
+cd ~/downloads
+
+tar xzf nagios-plugins-1.4.11.tar.gz
+
+cd nagios-plugins-1.4.11
+
+
+ + + +

+ +Compile and install the plugins. + +

+ + + +
+
+./configure --with-nagios-user=nagios --with-nagios-group=nagios
+
+make
+
+make install
+
+
+ + + + + +

+ +7) Start Nagios + +

+ + + +

+ +Add Nagios to the list of system services and have it automatically start when the system boots. + +

+ + + +
+
+chkconfig --add nagios
+
+chkconfig nagios on
+
+
+ + + +

+ +Verify the sample Nagios configuration files. + +

+ + + +
+
+/usr/local/nagios/bin/nagios -v /usr/local/nagios/etc/nagios.cfg
+
+
+ + + +

+ +If there are no errors, start Nagios. + +

+ + + +
+
+service nagios start
+
+
+ + + +

+ +8) Login to the Web Interface + +

+ + + +

+ +You should now be able to access the Nagios web interface at the URL below. You'll be prompted for the username (nagiosadmin) and password you specified earlier. + +

+ + + +
+
+http://localhost/nagios/
+
+
+ + + +

+ +Click on the "Service Detail" navbar link to see details of what's being monitored on your local machine. It will take a few minutes for Nagios to check all the services associated with your machine, as the checks are spread out over time. + +

+ + + +

+ +9) Other Modifications + +

+ + + +

+ +Make sure your machine's firewall rules are configured to allow access to the web server if you want to access the Nagios interface remotely. + +

+ + + +

+ +You can do this by: + +

+ + + + + + + +

+ +Configuring email notifications is outside the scope of this documentation. Refer to your system documentation, search the web, or look to the Nagios Support Portal or Nagios Community Wiki for specific instructions on configuring your openSUSE system to send email messages to external addresses. + +

+ + + + + +
+ + + + + + \ No newline at end of file diff --git a/docs/quickstart-ubuntu.html b/docs/quickstart-ubuntu.html new file mode 100644 index 0000000..eed7c18 --- /dev/null +++ b/docs/quickstart-ubuntu.html @@ -0,0 +1,696 @@ + + + + + + + + +Ubuntu Quickstart + + + + + + + + + + + + + + + +
+ +Nagios + +

Ubuntu Quickstart

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Quickstart Installation Guides, Security Considerations + +

+ + + +

+ +Introduction + +

+ + + +

+ +This guide is intended to provide you with simple instructions on how to install Nagios from source (code) on Ubuntu and have it monitoring your local machine inside of 20 minutes. No advanced installation options are discussed here - just the basics that will work for 95% of users who want to get started. + +

+ + + +

+ +These instructions were written based on an Ubuntu 6.10 (desktop) installation. They should work for an Ubuntu 7.10 install as well. + +

+ + + +

+ +What You'll End Up With + +

+ + + +

+ +If you follow these instructions, here's what you'll end up with: + +

+ + + + + + + +

+ +Required Packages + +

+ + + +

+ +Make sure you've installed the following packages on your Ubuntu installation before continuing. + +

+ + + + + + + +

+ +You can use apt-get to install these packages by running the following commands: + +

+ + + +
+
+sudo apt-get install apache2
+
+sudo apt-get install libapache2-mod-php5
+
+sudo apt-get install build-essential
+
+
+ + + +

+ +With Ubuntu 6.10, install the gd2 library with this command: + +

+ + + +
+
+sudo apt-get install libgd2-dev
+
+
+ +

+ +With Ubuntu 7.10, the gd2 library name has changed, so you'll need to use the following: + +

+ + + +
+
+sudo apt-get install libgd2-xpm-dev
+
+
+ + + +

+ +1) Create Account Information + +

+ + + +

+ +Become the root user. + +

+ + + +
+
+sudo -s
+
+
+ + + +

+ +Create a new nagios user account and give it a password. + +

+ + + +
+
+/usr/sbin/useradd -m -s /bin/bash nagios
+
+passwd nagios
+
+
+ + +

+ +On older Ubuntu server editions (6.01 and earlier), you will need to also add a nagios group (it's not created by default). You should be able to skip this step on desktop, or newer server editions of Ubuntu. + +

+ + + +
+
+/usr/sbin/groupadd nagios
+
+/usr/sbin/usermod -G nagios nagios
+
+
+ + + +

+ +Create a new nagcmd group for allowing external commands to be submitted through the web interface. Add both the nagios user and the apache user to the group. + +

+ + + +
+
+/usr/sbin/groupadd nagcmd
+
+/usr/sbin/usermod -a -G nagcmd nagios
+
+/usr/sbin/usermod -a -G nagcmd www-data
+
+
+ + + +

+ +2) Download Nagios and the Plugins + +

+ + + +

+ +Create a directory for storing the downloads. + +

+ + + +
+
+mkdir ~/downloads
+
+cd ~/downloads
+
+
+ + + +

+ +Download the source code tarballs of both Nagios and the Nagios plugins (visit http://www.nagios.org/download/ for links to the latest versions). These directions were tested with Nagios 3.1.1 and Nagios Plugins 1.4.11. + +

+ + + +
+
+wget http://prdownloads.sourceforge.net/sourceforge/nagios/nagios-3.2.1.tar.gz
+
+wget http://prdownloads.sourceforge.net/sourceforge/nagiosplug/nagios-plugins-1.4.11.tar.gz
+
+
+ + + +

+ +3) Compile and Install Nagios + +

+ + + +

+ +Extract the Nagios source code tarball. + +

+ + + +
+
+cd ~/downloads
+
+tar xzf nagios-3.2.1.tar.gz
+
+cd nagios-3.2.1
+
+
+ + + +

+ +Run the Nagios configure script, passing the name of the group you created earlier like so: + +

+ + + +
+
+./configure --with-command-group=nagcmd
+
+
+ + + +

+ +Compile the Nagios source code. + +

+ + + +
+
+make all
+
+
+ + + +

+ +Install binaries, init script, sample config files and set permissions on the external command directory. + +

+ + + +
+
+make install
+
+make install-init
+
+make install-config
+
+make install-commandmode
+
+
+ + + +

+ +Don't start Nagios yet - there's still more that needs to be done... + +

+ + + +

+ +4) Customize Configuration + +

+ + + +

+ +Sample configuration files have now been installed in the /usr/local/nagios/etc directory. These sample files should work fine for getting started with Nagios. You'll need to make just one change before you proceed... + +

+ + + +

+ +Edit the /usr/local/nagios/etc/objects/contacts.cfg config file with your favorite editor and change the email address associated with the nagiosadmin contact definition to the address you'd like to use for receiving alerts. + +

+ + + +
+
+vi /usr/local/nagios/etc/objects/contacts.cfg
+
+
+ + + +

+ +5) Configure the Web Interface + +

+ + + +

+ +Install the Nagios web config file in the Apache conf.d directory. + +

+ + + +
+
+make install-webconf
+
+
+ + + +

+ +Create a nagiosadmin account for logging into the Nagios web interface. Remember the password you assign to this account - you'll need it later. + +

+ + + +
+
+htpasswd -c /usr/local/nagios/etc/htpasswd.users nagiosadmin
+
+
+ + + +

+ +Restart Apache to make the new settings take effect. + +

+ + + +
+
+/etc/init.d/apache2 reload
+
+
+ + + +

+ +Note Note: Consider implementing the ehanced CGI security measures described here to ensure that your web authentication credentials are not compromised. + +

+ + + +

+ +6) Compile and Install the Nagios Plugins + +

+ + + +

+ +Extract the Nagios plugins source code tarball. + +

+ + + +
+
+cd ~/downloads
+
+tar xzf nagios-plugins-1.4.11.tar.gz
+
+cd nagios-plugins-1.4.11
+
+
+ + + +

+ +Compile and install the plugins. + +

+ + + +
+
+./configure --with-nagios-user=nagios --with-nagios-group=nagios
+
+make
+
+make install
+
+
+ + + + + +

+ +7) Start Nagios + +

+ + + +

+ +Configure Nagios to automatically start when the system boots. + +

+ + + +
+
+ln -s /etc/init.d/nagios /etc/rcS.d/S99nagios
+
+
+ + + +

+ +Verify the sample Nagios configuration files. + +

+ + + +
+
+/usr/local/nagios/bin/nagios -v /usr/local/nagios/etc/nagios.cfg
+
+
+ + + +

+ +If there are no errors, start Nagios. + +

+ + + +
+
+/etc/init.d/nagios start
+
+
+ + + +

+ +8) Login to the Web Interface + +

+ + + +

+ +You should now be able to access the Nagios web interface at the URL below. You'll be prompted for the username (nagiosadmin) and password you specified earlier. + +

+ + + +
+
+http://localhost/nagios/
+
+
+ + + +

+ +Click on the "Service Detail" navbar link to see details of what's being monitored on your local machine. It will take a few minutes for Nagios to check all the services associated with your machine, as the checks are spread out over time. + +

+ + + +

+ +9) Other Modifications + +

+ + + +

+ +If you want to receive email notifications for Nagios alerts, you need to install the mailx (Postfix) package. + +

+ + + +
+
+sudo apt-get install mailx
+
+sudo apt-get install postfix
+
+
+ + + +

+ +You'll have to edit the Nagios email notification commands found in /usr/local/nagios/etc/objects/commands.cfg and change any '/bin/mail' references to '/usr/bin/mail'. Once you do that you'll need to restart Nagios to make the configuration changes live. + +

+ + + +
+
+sudo /etc/init.d/nagios restart
+
+
+ + + +

+ +Configuring email notifications is outside the scope of this documentation. Refer to your system documentation, search the web, or look to the Nagios Support Portal or Nagios Community Wiki for specific instructions on configuring your Ubuntu system to send email messages to external addresses. + +

+ + + + + +
+ + + + + + \ No newline at end of file diff --git a/docs/quickstart.html b/docs/quickstart.html new file mode 100644 index 0000000..2d9a172 --- /dev/null +++ b/docs/quickstart.html @@ -0,0 +1,206 @@ + + + + + + + + +Nagios Quickstart Installation Guides + + + + + + + + + + + + + + + +
+ +Nagios + +

Nagios Quickstart Installation Guides

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Upgrading Nagios, Configuration Overview, Security Considerations + +

+ +

+ +About Nagios + +

+ +

+Visit www.nagios.org/about/ for more information on Nagios - including features, capabilities, and technical specifications. +

+ + + +

+ +Installation Introduction + +

+ + + +

+ +These quickstart guides are intended to provide you with simple instructions on how to install Nagios from source (code) and have it monitoring your local machine inside of 20 minutes. No advanced installation options are discussed here - just the basics that will work for 95% of users who want to get started. + +

+ + + +

+ +Installation Guides + +

+ + + +

+ +Quickstart installation guides are currently available for the following Linux distributions: + +

+ + + + + + + +

+ +You can also find additional quickstart guides on the Nagios Community Wiki. Can't find a quickstart for your particular OS? Write one and post it to the wiki for others! + +

+ + + +

+ +If you are installing Nagios on an operating system or Linux distribution that isn't listed above, read the Fedora quickstart for an overview of what you'll need to do. Command names, paths, etc. vary widely across different OSes/distributions, so you'll likely need to tweak the installation docs a bit to work for your particular case. + +

+ + + + + +

+ +Post-Installation Modifications + +

+ + + +

+ +Once you get Nagios installed and running properly, you'll no doubt want to start monitoring more than just your local machine. Check out the following docs for how to go about monitoring other things... + +

+ + + + + +

Enhance Nagios With Community Addons

+ + + +

+ +Nagios Exchange + +

+ +

+Hundreds of community-developed addons provide additional GUIs and reporting, monitoring, and notification functionalities for Nagios. Visit the Nagios Exchange website at exchange.nagios.org to see some really cool things you can use to trick out your Nagios installation. +

+ +
+ + +

Nagios Support Portal

+ + + +

+ +Nagios Support + +

+ +

+Visit the Nagios Support portal at support.nagios.com for additional documentation, FAQs, and professional Nagios support plans. +

+ +
+ +
+ +

+ +Nagios and the Nagios logo are trademarks, servicemarks, registered servicemarks or registered trademarks of Nagios Enterprises. + +

+ + + + \ No newline at end of file diff --git a/docs/redundancy.html b/docs/redundancy.html new file mode 100644 index 0000000..9821b89 --- /dev/null +++ b/docs/redundancy.html @@ -0,0 +1,826 @@ + + + + + + + + +Redundant and Failover Network Monitoring + + + + + + + + + + + + + + + +
+ +

Redundant and Failover Network Monitoring

+ +
+ + + +
+ + + +

+ +Introduction + +

+ + + +

+ +This section describes a few scenarios for implementing redundant monitoring hosts an various types of network layouts. With redundant hosts, you can maintain the ability to monitor your network when the primary host that runs Nagios fails or when portions of your network become unreachable. + +

+ + + +

+ +Note: If you are just learning how to use Nagios, I would suggest not trying to implement redudancy until you have becoming familiar with the prerequisites I've laid out. Redundancy is a relatively complicated issue to understand, and even more difficult to implement properly. + +

+ + + +

+ +Index + +

+ + + +

+ +Prerequisites
+ +Sample scripts
+ +Scenario 1 - Redundant monitoring
+ +Scenario 2 - Failover monitoring
+ +

+ + + +

+ + + + + + + + + + + +
Prerequisites
+ +

+ + + +

+ +Before you can even think about implementing redundancy with Nagios, you need to be familiar with the following... + +

+ + + + + +

+ + + + + + + + + + + +
Sample Scripts
+ +

+ + + +

+ +All of the sample scripts that I use in this documentation can be found in the eventhandlers/ subdirectory of the Nagios distribution. You'll probably need to modify them to work on your system... + +

+ + + +

+ + + + + + + + + + + +
Scenario 1 - Redundant Monitoring
+ +

+ + + +

+ +Introduction + +

+ + + +

+ +This is an easy (and naive) method of implementing redundant monitoring hosts on your network and it will only protect against a limited number of failures. More complex setups are necessary in order to provide smarter redundancy, better redundancy across different network segments, etc. + +

+ + + +

+ +Goals + +

+ + + +

+ +The goal of this type of redundancy implementation is simple. Both the "master" and "slave" hosts monitor the same hosts and service on the network. Under normal circumstances only the "master" host will be sending out notifications to contacts about problems. We want the "slave" host running Nagios to take over the job of notifying contacts about problems if: + +

+ +
    + +
  1. The "master" host that runs Nagios is down or.. + +
  2. The Nagios process on the "master" host stops running for some reason + +
+ + + +

+ +Network Layout Diagram + +

+ + + +

+ +The diagram below shows a very simple network setup. For this scenario I will be assuming that hosts A and E are both running Nagios and are monitoring all the hosts shown. Host A will be considered the "master" host and host E will be considered the "slave" host. + +

+ + + +

+ + + + + + + + + +
+ +

+ + + +

+ +Initial Program Settings + +

+ + + +

+ +The slave host (host E) has its initial enable_notifications directive disabled, thereby preventing it from sending out any host or service notifications. You also want to make sure that the slave host has its check_external_commands directive enabled. That was easy enough... + +

+ + + +

+ +Initial Configuration + +

+ + + +

+ +Next we need to consider the differences between the object configuration file(s) on the master and slave hosts... + +

+ + + +

+ +I will assume that you have the master host (host A) setup to monitor services on all hosts shown in the diagram above. The slave host (host E) should be setup to monitor the same services and hosts, with the following additions in the configuration file... + +

+ + + + + + + +

+ +It is important to note that host A (the master host) has no knowledge of host E (the slave host). In this scenario it simply doesn't need to. Of course you may be monitoring services on host E from host A, but that has nothing to do with the implementation of redundancy... + +

+ + + +

+ +Event Handler Command Definitions + +

+ + + +

+ +We need to stop for a minute and describe what the command definitions for the event handlers on the slave host look like. Here is an example... + +

+ + + +

+ + + + + +

+
+define command{
+
+	command_name	handle-master-host-event
+
+	command_line	/usr/local/nagios/libexec/eventhandlers/handle-master-host-event $HOSTSTATE$ $HOSTSTATETYPE$
+
+	}
+
+	
+
+define command{
+
+	command_name	handle-master-proc-event
+
+	command_line	/usr/local/nagios/libexec/eventhandlers/handle-master-proc-event $SERVICESTATE$ $SERVICESTATETYPE$
+
+	}
+
+
+ + + + + +

+ + + +

+ +This assumes that you have placed the event handler scripts in the /usr/local/nagios/libexec/eventhandlers directory. You may place them anywhere you wish, but you'll need to modify the examples I've given here. + +

+ + + +

+ +Event Handler Scripts + +

+ + + +

+ +Okay, now lets take a look at what the event handler scripts look like... + +

+ + + +

+ +Host Event Handler (handle-master-host-event): + +

+ +
+
+#!/bin/sh
+
+
+
+# Only take action on hard host states...
+
+case "$2" in
+
+HARD)
+
+	case "$1" in
+
+	DOWN)
+
+		# The master host has gone down!
+
+		# We should now become the master host and take
+
+		# over the responsibilities of monitoring the 
+
+		# network, so enable notifications...
+
+		/usr/local/nagios/libexec/eventhandlers/enable_notifications
+
+		;;
+
+	UP)
+
+		# The master host has recovered!
+
+		# We should go back to being the slave host and
+
+		# let the master host do the monitoring, so 
+
+		# disable notifications...
+
+		/usr/local/nagios/libexec/eventhandlers/disable_notifications
+
+		;;
+
+	esac
+
+	;;
+
+esac
+
+exit 0
+
+
+ + + +

+ +Service Event Handler (handle-master-proc-event): + +

+ + + +
+
+#!/bin/sh
+
+
+
+# Only take action on hard service states...
+
+case "$2" in
+
+HARD)
+
+	case "$1" in
+
+	CRITICAL)
+
+		# The master Nagios process is not running!
+
+		# We should now become the master host and
+
+		# take over the responsibility of monitoring
+
+		# the network, so enable notifications...
+
+		/usr/local/nagios/libexec/eventhandlers/enable_notifications
+
+		;;
+
+	WARNING)
+
+	UNKNOWN)
+
+		# The master Nagios process may or may not
+
+		# be running.. We won't do anything here, but
+
+		# to be on the safe side you may decide you 
+
+		# want the slave host to become the master in
+
+		# these situations...
+
+		;;
+
+	OK)
+
+		# The master Nagios process running again!
+
+		# We should go back to being the slave host, 
+
+		# so disable notifications...
+
+		/usr/local/nagios/libexec/eventhandlers/disable_notifications
+
+		;;
+
+	esac
+
+	;;
+
+esac
+
+exit 0
+
+
+ + + +

+ +What This Does For Us + +

+ + + +

+ +The slave host (host E) initially has notifications disabled, so it won't send out any host or service notifications while the Nagios process on the master host (host A) is still running. + +

+ + + +

+ +The Nagios process on the slave host (host E) becomes the master host when... + +

+ + + + + +

+ +When the Nagios process on the slave host (host E) has notifications enabled, it will be able to send out notifications about any service or host problems or recoveries. At this point host E has effectively taken over the responsibility of notifying contacts of host and service problems! + +

+ + + +

+ +The Nagios process on host E returns to being the slave host when... + +

+ + + + + +

+ +When the Nagios process on host E has notifications disabled, it will not send out notifications about any service or host problems or recoveries. At this point host E has handed over the responsibilities of notifying contacts of problems to the Nagios process on host A. Everything is now as it was when we first started! + +

+ + + +

+ +Time Lags + +

+ + + +

+ +Redundancy in Nagios is by no means perfect. One of the more obvious problems is the lag time between the master host failing and the slave host taking over. This is affected by the following... + +

+ + + + + + + +

+ +You can minimize this lag by... + +

+ + + + + +

+ +When Nagios recovers on the host A, there is also some lag time before host E returns to being a slave host. This is affected by the following... + +

+ + + + + + + +

+ +The exact lag times between the transfer of monitoring responsibilities will vary depending on how many services you have defined, the interval at which services are checked, and a lot of pure chance. At any rate, its definitely better than nothing. + +

+ + + +

+ +Special Cases + +

+ + + +

+ +Here is one thing you should be aware of... If host A goes down, host E will have notifications enabled and take over the responsibilities of notifying contacts of problems. When host A recovers, host E will have notifications disabled. If - when host A recovers - the Nagios process on host A does not start up properly, there will be a period of time when neither host is notifying contacts of problems! Fortunately, the service check logic in Nagios accounts for this. The next time the Nagios process on host E checks the status of the Nagios process on host A, it will find that it is not running. Host E will then have notifications enabled again and take over all responsibilities of notifying contacts of problems. + +

+ + + +

+ +The exact amount of time that neither host is monitoring the network is hard to determine. Obviously, this period can be minimized by increasing the frequency of service checks (on host E) of the Nagios process on host A. The rest is up to pure chance, but the total "blackout" time shouldn't be too bad. + +

+ + + +

+ + + + + + + + + + + +
Scenario 2 - Failover Monitoring
+ +

+ + + +

+ +Introduction + +

+ + + +

+ +Failover monitoring is similiar to, but slightly different than redundant monitoring (as discussed above in scenario 1). + +

+ + + +

+ +Goals + +

+ + + +

+ +The basic goal of failover monitoring is to have the Nagios process on the slave host sit idle while the Nagios process on the master host is running. If the process on the master host stops running (or if the host goes down), the Nagios process on the slave host starts monitoring everything. + +

+ + + +

+ +While the method described in scenario 1 will allow you to continue receive notifications if the master monitoring hosts goes down, it does have some pitfalls. The biggest problem is that the slave host is monitoring the same hosts and servers as the master at the same time as the master! This can cause problems with excessive traffic and load on the machines being monitored if you have a lot of services defined. Here's how you can get around that problem... + +

+ + + +

+ +Initial Program Settings + +

+ + + +

+ +Disable active service checks and notifications on the slave host using the execute_service_checks and enable_notifications directives. This will prevent the slave host from monitoring hosts and services and sending out notifications while the Nagios process on the master host is still up and running. Make sure you also have the check_external_commands directive enabled on the slave host. + +

+ + + +

+ +Master Process Check + +

+ + + +

+ +Set up a cron job on the slave host that periodically (say every minute) runs a script that checks the staus of the Nagios process on the master host (using the check_nrpe plugin on the slave host and the nrpe daemon and check_nagios plugin on the master host). The script should check the return code of the check_nrpe plugin . If it returns a non-OK state, the script should send the appropriate commands to the external command file to enable both notifications and active service checks. If the plugin returns an OK state, the script should send commands to the external command file to disable both notifications and active checks. + +

+ + + +

+ +By doing this you end up with only one process monitoring hosts and services at a time, which is much more efficient that monitoring everything twice. + +

+ + + +

+ +Also of note, you don't need to define host and service handlers as mentioned in scenario 1 because things are handled differently. + +

+ + + +

+ +Additional Issues + +

+ + + +

+ +At this point, you have implemented a very basic failover monitoring setup. However, there is one more thing you should consider doing to make things work smoother. + +

+ + + +

+ +The big problem with the way things have been setup thus far is the fact that the slave host doesn't have the current status of any services or hosts at the time it takes over the job of monitoring. One way to solve this problem is to enable the ocsp command on the master host and have it send all service check results to the slave host using the nsca addon. The slave host will then have up-to-date status information for all services at the time it takes over the job of monitoring things. Since active service checks are not enabled on the slave host, it will not actively run any service checks. However, it will execute host checks if necessary. This means that both the master and slave hosts will be executing host checks as needed, which is not really a big deal since the majority of monitoring deals with service checks. + +

+ + + +

+ +That's pretty much it as far as setup goes. + +

+ + + + + +
+ + + + + + + diff --git a/docs/robots.txt b/docs/robots.txt new file mode 100644 index 0000000..1f53798 --- /dev/null +++ b/docs/robots.txt @@ -0,0 +1,2 @@ +User-agent: * +Disallow: / diff --git a/docs/security.html b/docs/security.html new file mode 100644 index 0000000..3527a74 --- /dev/null +++ b/docs/security.html @@ -0,0 +1,182 @@ + + + + + + + + +Security Considerations + + + + + + + + + + + + + + + +
+ +Nagios + +

Security Considerations

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: CGI Security + +

+ + + +

+ + + +Introduction + +

+ + + +Security + + + +

+ +This is intended to be a brief overview of some things you should keep in mind when installing Nagios, so as set it up in a secure manner. + +

+ + + +

+ +Your monitoring box should be viewed as a backdoor into your other systems. In many cases, the Nagios server might be allowed access through firewalls in order to monitor remote servers. In most all cases, it is allowed to query those remote servers for various information. Monitoring servers are always given a certain level of trust in order to query remote systems. This presents a potential attacker with an attractive backdoor to your systems. An attacker might have an easier time getting into your other systems if they compromise the monitoring server first. This is particularly true if you are making use of shared SSH keys in order to monitor remote systems. + +

+ + + +

+ +If an intruder has the ability to submit check results or external commands to the Nagios daemon, they have the potential to submit bogus monitoring data, drive you nuts you with bogus notifications, or cause event handler scripts to be triggered. If you have event handler scripts that restart services, cycle power, etc. this could be particularly problematic. + +

+ + + +

+ +Another area of concern is the ability for intruders to sniff monitoring data (status information) as it comes across the wire. If communication channels are not encrypted, attackers can gain valuable information by watching your monitoring information. Take as an example the following situation: An attacker captures monitoring data on the wire over a period of time and analyzes the typical CPU and disk load usage of your systems, along with the number of users that are typically logged into them. The attacker is then able to determine the best time to compromise a system and use its resources (CPU, etc.) without being noticed. + +

+ + + +

+ +Here are some tips to help ensure that you keep your systems secure when implementing a Nagios-based monitoring solution... + +

+ + + + + +

+ + + +Best Practices + +

+ + + +
    + +
  1. Use a Dedicated Monitoring Box. I would recommend that you install Nagios on a server that is dedicated to monitoring (and possibly other admin tasks). Protect your monitoring server as if it were one of the most important servers on your network. Keep running services to a minimum and lock down access to it via TCP wrappers, firewalls, etc. Since the Nagios server is allowed to talk to your servers and may be able to poke through your firewalls, allowing users access to your monitoring server can be a security risk. Remember, its always easier to gain root access through a system security hole if you have a local account on a box.

    Monitoring Box

    2. + + + +
  2. Don't Run Nagios As Root. Nagios doesn't need to run as root, so don't do it. You can tell Nagios to drop privileges after startup and run as another user/group by using the nagios_user and nagios_group directives in the main config file. If you need to execute event handlers or plugins which require root access, you might want to try using sudo.

    3. + + + +
  3. Lock Down The Check Result Directory. Make sure that only the nagios user is able to read/write in the check result path. If users other than nagios (or root) are able to write to this directory, they could send fake host/service check results to the Nagios daemon. This could result in annoyances (bogus notifications) or security problems (event handlers being kicked off).

    4. + + + +
  4. Lock Down The External Command File. If you enable external commands, make sure you set proper permissions on the /usr/local/nagios/var/rw directory. You only want the Nagios user (usually nagios) and the web server user (usually nobody, httpd, apache2, or www-data) to have permissions to write to the command file. If you've installed Nagios on a machine that is dedicated to monitoring and admin tasks and is not used for public accounts, that should be fine. If you've installed it on a public or multi-user machine (not recommended), allowing the web server user to have write access to the command file can be a security problem. After all, you don't want just any user on your system controlling Nagios through the external command file. In this case, I would suggest only granting write access on the command file to the nagios user and using something like CGIWrap to run the CGIs as the nagios user instead of nobody.

    5. + + + +
  5. Require Authentication In The CGIs. I would strongly suggest requiring authentication for accessing the CGIs. Once you do that, read the documentation on the default rights that authenticated contacts have, and only authorize specific contacts for additional rights as necessary. Instructions on setting up authentication and configuring authorization rights can be found here. If you disable the CGI authentication features using the use_authentication directive in the CGI config file, the command CGI will refuse to write any commands to the external command file. After all, you don't want the world to be able to control Nagios do you?

    6. + + + +
  6. Implement Enhanced CGI Security Measures. I would strongly suggest that you consider implementing enhanced security measures for the CGIs as described here. These measures can help ensure that the username/password you use to access the Nagios web interface are not intercepted by third parties.

    7. + + + +
  7. Use Full Paths In Command Definitions. When you define commands, make sure you specify the full path (not a relative one) to any scripts or binaries you're executing.

    8. + + + +
  8. Hide Sensitive Information With $USERn$ Macros. The CGIs read the main config file and object config file(s), so you don't want to keep any sensitive information (usernames, passwords, etc) in there. If you need to specify a username and/or password in a command definition use a $USERn$ macro to hide it. $USERn$ macros are defined in one or more resource files. The CGIs will not attempt to read the contents of resource files, so you can set more restrictive permissions (600 or 660) on them. See the sample resource.cfg file in the base of the Nagios distribution for an example of how to define $USERn$ macros.

    9. + + + +
  9. Strip Dangerous Characters From Macros. Use the illegal_macro_output_chars directive to strip dangerous characters from the $HOSTOUTPUT$, $SERVICEOUTPUT$, $HOSTPERFDATA$, and $SERVICEPERFDATA$ macros before they're used in notifications, etc. Dangerous characters can be anything that might be interpreted by the shell, thereby opening a security hole. An example of this is the presence of backtick (`) characters in the $HOSTOUTPUT$, $SERVICEOUTPUT$, $HOSTPERFDATA$, and/or $SERVICEPERFDATA$ macros, which could allow an attacker to execute an arbitrary command as the nagios user (one good reason not to run Nagios as the root user).

    10. + + + +
  10. Secure Access to Remote Agents. Make sure you lock down access to agents (NRPE, NSClient, SNMP, etc.) on remote systems using firewalls, access lists, etc. You don't want everyone to be able to query your systems for status information. This information could be used by an attacker to execute remote event handler scripts or to determine the best times to go unnoticed.

    Remote Agents

    11. + + + +
  11. Secure Communication Channels. Make sure you encrypt communication channels between different Nagios installations and between your Nagios servers and your monitoring agents whenever possible. You don't want someone to be able to sniff status information going across your network. This information could be used by an attacker to determine the best times to go unnoticed.

    Communication Channels

    12. + + + +
+ + + +
+ + + + + + + diff --git a/docs/servicechecks.html b/docs/servicechecks.html new file mode 100644 index 0000000..a3c6b12 --- /dev/null +++ b/docs/servicechecks.html @@ -0,0 +1,248 @@ + + + + + + + + +Service Checks + + + + + + + + + + + + + + + +
+ +Nagios + +

Service Checks

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Active Checks, Host Checks, Check Scheduling, Predictive Dependency Checks + +

+ + + +

+ +Introduction + +

+ + + +

+ +The basic workings of service checks are described here... + +

+ + + +

+ +When Are Service Checks Performed? + +

+ + + +

+ +Services are checked by the Nagios daemon: + +

+ + + + + + + +

+ +On-demand checks are performed as part of the predictive service dependency check logic. These checks help ensure that the dependency logic is as accurate as possible. If you don't make use of service dependencies, Nagios won't perform any on-demand service checks. + +

+ + + + + +

+ +Cached Service Checks + +

+ + + +

+ +The performance of on-demand service checks can be significantly improved by implementing the use of cached checks, which allow Nagios to forgo executing a service check if it determines a relatively recent check result will do instead. Cached checks will only provide a performance increase if you are making use of service dependencies. More information on cached checks can be found here. + +

+ + + + + +

+ +Dependencies and Checks + +

+ + + +

+ +You can define service execution dependencies that prevent Nagios from checking the status of a service depending on the state of one or more other services. More information on dependencies can be found here. + +

+ + + +

+ +Parallelization of Service Checks + +

+ + + +

+ +Scheduled service checks are run in parallel. When Nagios needs to run a scheduled service check, it will initiate the service check and then return to doing other work (running host checks, etc). The service check runs in a child process that was fork()ed from the main Nagios daemon. When the service check has completed, the child process will inform the main Nagios process (its parent) of the check results. The main Nagios process then handles the check results and takes appropriate action (running event handlers, sending notifications, etc.). + +

+ + + +

+ +On-demand service checks are also run in parallel if needed. As mentioned earlier, Nagios can forgo the actual execution of an on-demand service check if it can use the cached results from a relatively recent service check. + +

+ + + +

+ +Service States + +

+ + + +

+ +Services that are checked can be in one of four different states: + +

+ + + + + + + +

+ +Service State Determination + +

+ + + +

+ +Service checks are performed by plugins, which can return a state of OK, WARNING, UNKNOWN, or CRITICAL. These plugin states directly translate to service states. For example, a plugin which returns a WARNING state will cause a service to have a WARNING state. + +

+ + + + + +

+ +Services State Changes + +

+ + + +

+ +When Nagios checks the status of services, it will be able to detect when a service changes between OK, WARNING, UNKNOWN, and CRITICAL states and take appropriate action. These state changes result in different state types (HARD or SOFT), which can trigger event handlers to be run and notifications to be sent out. Service state changes can also trigger on-demand host checks. Detecting and dealing with state changes is what Nagios is all about. + +

+ + + +

+ +When services change state too frequently they are considered to be "flapping". Nagios can detect when services start flapping, and can suppress notifications until flapping stops and the service's state stabilizes. More information on the flap detection logic can be found here. + +

+ + + +
+ + + + + + + diff --git a/docs/stalking.html b/docs/stalking.html new file mode 100644 index 0000000..d04e13d --- /dev/null +++ b/docs/stalking.html @@ -0,0 +1,248 @@ + + + + + + + + +State Stalking + + + + + + + + + + + + + + + +
+ +Nagios + +

State Stalking

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Volatile Services + +

+ + + +

+ +Introduction + +

+ + + +

+ +State "stalking" is a feature which is probably not going to used by most users. When enabled, it allows you to log changes in the output service and host checks even if the state of the host or service does not change. When stalking is enabled for a particular host or service, Nagios will watch that host or service very carefully and log any changes it sees in the output of check results. As you'll see, it can be very helpful to you in later analysis of the log files. + +

+ + + +

+ +How Does It Work? + +

+ + + +

+ +Under normal circumstances, the result of a host or service check is only logged if the host or service has changed state since it was last checked. There are a few exceptions to this, but for the most part, that's the rule. + +

+ + + +

+ +If you enable stalking for one or more states of a particular host or service, Nagios will log the results of the host or service check if the output from the check differs from the output from the previous check. Take the following example of eight consecutive checks of a service: + +

+ + + + + + + + + + + + + + + + + + + + + + + +
Service Check #:Service State:Service Check Output:Logged NormallyLogged With Stalking
xOKRAID array optimal--
x+1OKRAID array optimal--
x+2WARNINGRAID array degraded (1 drive bad, 1 hot spare rebuilding)YesYes
x+3CRITICALRAID array degraded (2 drives bad, 1 host spare online, 1 hot spare rebuilding)YesYes
x+4CRITICALRAID array degraded (3 drives bad, 2 hot spares online)-Yes
x+5CRITICALRAID array failed-Yes
x+6CRITICALRAID array failed--
x+7CRITICALRAID array failed--
+ + + +

+ +Given this sequence of checks, you would normally only see two log entries for this catastrophe. The first one would occur at service check x+2 when the service changed from an OK state to a WARNING state. The second log entry would occur at service check x+3 when the service changed from a WARNING state to a CRITICAL state. + +

+ + + +

+ +For whatever reason, you may like to have the complete history of this catastrophe in your log files. Perhaps to help explain to your manager how quickly the situation got out of control, perhaps just to laugh at it over a couple of drinks at the local pub... + +

+ + + +

+ +Well, if you had enabled stalking of this service for CRITICAL states, you would have events at x+4 and x+5 logged in addition to the events at x+2 and x+3. Why is this? With state stalking enabled, Nagios would have examined the output from each service check to see if it differed from the output of the previous check. If the output differed and the state of the service didn't change between the two checks, the result of the newer service check would get logged. + +

+ + + +

+ +A similiar example of stalking might be on a service that checks your web server. If the check_http plugin first returns a WARNING state because of a 404 error and on subsequent checks returns a WARNING state because of a particular pattern not being found, you might want to know that. If you didn't enable state stalking for WARNING states of the service, only the first WARNING state event (the 404 error) would be logged and you wouldn't have any idea (looking back in the archived logs) that future WARNING states were not due to a 404, but rather some text pattern that could not be found in the returned web page. + +

+ + + +

+ +Should I Enable Stalking? + +

+ + + +

+ +First, you must decide if you have a real need to analyze archived log data to find the exact cause of a problem. You may decide you need this feature for some hosts or services, but not for all. You may also find that you only have a need to enable stalking for some host or service states, rather than all of them. For example, you may decide to enable stalking for WARNING and CRITICAL states of a service, but not for OK and UNKNOWN states. + +

+ + + +

+ +The decision to to enable state stalking for a particular host or service will also depend on the plugin that you use to check that host or service. If the plugin always returns the same text output for a particular state, there is no reason to enable stalking for that state. + +

+ + + +

+ +How Do I Enable Stalking? + +

+ + + +

+ +You can enable state stalking for hosts and services by using the stalking_options directive in host and service definitions. + +

+ + + + + +

+ +How Does Stalking Differ From Volatile Services? + +

+ + + +

+ +Volatile services are similar, but will cause notifications and event handlers to run. Stalking is purely for logging purposes. + +

+ + + + + +

+ +Caveats + +

+ + + +

+ +You should be aware that there are some potential pitfalls with enabling stalking. These all relate to the reporting functions found in various CGIs (histogram, alert summary, etc.). Because state stalking will cause additional alert entries to be logged, the data produced by the reports will show evidence of inflated numbers of alerts. + +

+ + + +

+ +As a general rule, I would suggest that you not enable stalking for hosts and services without thinking things through. Still, it's there if you need and want it. + +

+ + + + + +
+ + + + + + + diff --git a/docs/startstop.html b/docs/startstop.html new file mode 100644 index 0000000..cb9f0c2 --- /dev/null +++ b/docs/startstop.html @@ -0,0 +1,201 @@ + + + + + + + + +Starting and Stopping Nagios + + + + + + + + + + + + + + + +
+ +Nagios + +

Starting and Stopping Nagios

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Verifying Your Configuration + +

+ + + +

+ +There's more than one way to start, stop, and restart Nagios. Here are some of the more common ones... + +

+ + + +

+ +Tip Tip: Always make sure you verify your configuration before you (re)start Nagios. + +

+ + + +

+ +Starting Nagios + +

+ + + +
    + +
  1. Init Script: The easiest way to start the Nagios daemon is by using the init script like so: + +
    +
+/etc/rc.d/init.d/nagios start
+
+
    + +
    2. + +
  2. Manually: You can start the Nagios daemon manually with the -d command line option like so: + +
    +
+/usr/local/nagios/bin/nagios -d /usr/local/nagios/etc/nagios.cfg
+
+
    + +
    3. + +
+ + + +

+ +Restarting Nagios + +

+ + + +

+ +Restarting/reloading is nececessary when you modify your configuration files and want those changes to take effect. + +

+ + + +
    + +
  1. Init Script: The easiest way to restart the Nagios daemon is by using the init script like so: + +
    +
+/etc/rc.d/init.d/nagios reload
+
+
    + +
    2. + +
  2. Web Interface: You can restart the Nagios through the web interface by clicking the "Process Info" navigation link and selecting "Restart the Nagios process":

    + +Restart the Nagios process

    + +
    3. + +
  3. Manually: You can restart the Nagios process by sending it a SIGHUP signal like so: + +
    +
+kill -HUP <nagios_pid>
+
+
    + +
+ + + +

+ +Stopping Nagios + +

+ + + +
    + +
  1. Init Script: The easiest way to stop the Nagios daemon is by using the init script like so: + +
    +
+/etc/rc.d/init.d/nagios stop
+
+
    + +
    2. + +
  2. Web Interface: You can stop the Nagios through the web interface by clicking the "Process Info" navigation link and selecting "Shutdown the Nagios process":

    + +Shutdown the Nagios process

    + +
    3. + +
  3. Manually: You can stop the Nagios process by sending it a SIGTERM signal like so: + +
    +
+kill <nagios_pid>
+
+
    + +
    4. + +
+ + + +
+ + + + + + \ No newline at end of file diff --git a/docs/statetypes.html b/docs/statetypes.html new file mode 100644 index 0000000..335b5da --- /dev/null +++ b/docs/statetypes.html @@ -0,0 +1,295 @@ + + + + + + + + +State Types + + + + + + + + + + + + + + + +
+ +Nagios + +

State Types

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Host Checks, Service Checks, Event Handlers, Notifications + +

+ + + +

+ +Introduction + +

+ +

+ +The current state of monitored services and hosts is determined by two components: + +

+ + + + + + + + + +

+ +There are two state types in Nagios - SOFT states and HARD states. These state types are a crucial part of the monitoring logic, as they are used to determine when event handlers are executed and when notifications are initially sent out. + +

+ + + +

+ +This document describes the difference between SOFT and HARD states, how they occur, and what happens when they occur. + +

+ + + +

+ +Service and Host Check Retries + +

+ + + +

+ +In order to prevent false alarms from transient problems, Nagios allows you to define how many times a service or host should be (re)checked before it is considered to have a "real" problem. This is controlled by the max_check_attempts option in the host and service definitions. Understanding how hosts and services are (re)checked in order to determine if a real problem exists is important in understanding how state types work. + +

+ + + +

+ +Soft States + +

+ + + +

+ +Soft states occur in the following situations... + +

+ + + + + + + +

+ +The following things occur when hosts or services experience SOFT state changes: + +

+ + + + + + + +

+ +SOFT states are only logged if you enabled the log_service_retries or log_host_retries options in your main configuration file. + +

+ + + +

+ +The only important thing that really happens during a soft state is the execution of event handlers. Using event handlers can be particularly useful if you want to try and proactively fix a problem before it turns into a HARD state. + +The $HOSTSTATETYPE$ or $SERVICESTATETYPE$ macros will have a value of "SOFT" when event handlers are executed, which allows your event handler scripts to know when they should take corrective action. More information on event handlers can be found here. + +

+ + + +

+ +Hard States + +

+ + + +

+ +Hard states occur for hosts and services in the following situations: + +

+ + + + + + + +

+ +The following things occur when hosts or services experience HARD state changes: + +

+ + + + + + + +

+ +The $HOSTSTATETYPE$ or $SERVICESTATETYPE$ macros will have a value of "HARD" when event handlers are executed, which allows your event handler scripts to know when they should take corrective action. More information on event handlers can be found here. + +

+ + + + + +

+ +Example + +

+ + + +

+ +Here's an example of how state types are determined, when state changes occur, and when event handlers and notifications are sent out. The table below shows consecutive checks of a service over time. The service has a max_check_attempts value of 3. + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TimeCheck #StateState TypeState ChangeNotes
01OKHARDNoInitial state of the service
11CRITICALSOFTYesFirst detection of a non-OK state. Event handlers execute.
22WARNINGSOFTYesService continues to be in a non-OK state. Event handlers execute.
33CRITICALHARDYesMax check attempts has been reached, so service goes into a HARD state. Event handlers execute and a problem notification is sent out. Check # is reset to 1 immediately after this happens.
41WARNINGHARDYesService changes to a HARD WARNING state. Event handlers execute and a problem notification is sent out.
51WARNINGHARDNoService stabilizes in a HARD problem state. Depending on what the notification interval for the service is, another notification might be sent out.
61OKHARDYesService experiences a HARD recovery. Event handlers execute and a recovery notification is sent out.
71OKHARDNoService is still OK.
81UNKNOWNSOFTYesService is detected as changing to a SOFT non-OK state. Event handlers execute.
92OKSOFTYesService experiences a SOFT recovery. Event handlers execute, but notification are not sent, as this wasn't a "real" problem. State type is set HARD and check # is reset to 1 immediately after this happens.
101OKHARDNoService stabilizes in an OK state.
+ + + + + +
+ + + + + + \ No newline at end of file diff --git a/docs/timeperiods.html b/docs/timeperiods.html new file mode 100644 index 0000000..ff22b3f --- /dev/null +++ b/docs/timeperiods.html @@ -0,0 +1,274 @@ + + + + + + + + +Time Periods + + + + + + + + + + + + + + + +
+ +Nagios + +

Time Periods

+ +or...
+ +"Is This a Good Time?" + +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: On-Call Rotations, Host Checks, Service Checks, Notifications, Notification Escalations, Dependencies + +

+ + + +

+ +Introduction + +

+ + + +Timeperiods + + + +

+ +Timeperiod definitions allow you to control when various aspects of the monitoring and alerting logic can operate. For instance, you can restrict: + +

+ + + + + + + +

+ +Precedence in Time Periods + +

+ + + +

+ +Timeperod definitions may contain multiple types of directives, including weekdays, days of the month, and calendar dates. Different types of directives have different precendence levels and may override other directives in your timeperiod definitions. The order of precedence for different types of directives (in descending order) is as follows: + +

+ + + + + + + +

+ +Examples of different timeperiod directives can be found here. + +

+ + + +

+ +How Time Periods Work With Host and Service Checks + +

+ + + + + +

+ +Host and service definitions have an optional check_period directive that allows you to specify a timeperiod that should be used to restrict when regularly scheduled, active checks of the host or service can be made. + +

+ + + +

+ +If you do not use the check_period directive to specify a timeperiod, Nagios will be able to schedule active checks of the host or service anytime it needs to. This is essentially a 24x7 monitoring scenario. + +

+ + + +

+ +Specifying a timeperiod in the check_period directive allows you to restrict the time that Nagios perform regularly scheduled, active checks of the host or service. When Nagios attempts to reschedule a host or service check, it will make sure that the next check falls within a valid time range within the defined timeperiod. If it doesn't, Nagios will adjust the next check time to coincide with the next "valid" time in the specified timeperiod. This means that the host or service may not get checked again for another hour, day, or week, etc. + +

+ + + +

+ +Note Note: On-demand checks and passive checks are not restricted by the timeperiod you specify in the check_period directive. Only regularly scheduled active checks are restricted. + +

+ + + +

+ +Unless you have a good reason not to do so, I would recommend that you monitor all your hosts and services using timeperiods that cover a 24x7 time range. If you don't do this, you can run into some problems during "blackout" times (times that are not valid in the timeperiod definition): + +

+ + + +
    + +
  1. The status of the host or service will appear unchanged during the blackout time. + +
  2. Contacts will mostly likely not get re-notified of problems with a host or service during blackout times. + +
  3. If a host or service recovers during a blackout time, contacts will not be immediately notified of the recovery. + +
+ +
+ + + +

+ +How Time Periods Work With Contact Notifications + +

+ + + +

+ +By specifying a timeperiod in the notification_period directive of a host or service definition, you can control when Nagios is allowed to send notifications out regarding problems or recoveries for that host or service. When a host notification is about to get sent out, Nagios will make sure that the current time is within a valid range in the notification_period timeperiod. If it is a valid time, then Nagios will attempt to notify each contact of the problem or recovery. + +

+ + + +

+ +You can also use timeperiods to control when notifications can be sent out to individual contacts. By using the service_notification_period and host_notification_period directives in contact definitions, you're able to essentially define an "on call" period for each contact. Contacts will only receive host and service notifications during the times you specify in the notification period directives. + +

+ + + +

+ +Examples of how to create timeperiod definitions for use for on-call rotations can be found here. + +

+ + + +

+ +How Time Periods Work With Notification Escalations + +

+ + + +

+ +Service and host notification escalations have an optional escalation_period directive that allows you to specify a timeperiod when the escalation is valid and can be used. If you do not use the escalation_period directive in an escalation definition, the escalation is considered valid at all times. If you specify a timeperiod in the escalation_period directive, Nagios will only use the escalation definition during times that are valid in the timeperiod definition. + +

+ + + +

+ +How Time Periods Work With Dependencies + +

+ + + +

+ +Service and host dependencies have an optional dependency_period directive that allows you to specify a timeperiod when the dependendies are valid and can be used. If you do not use the dependency_period directive in a dependency definition, the dependency can be used at any time. If you specify a timeperiod in the dependency_period directive, Nagios will only use the dependency definition during times that are valid in the timeperiod definition. + +

+ + + +
+ + + + + + + diff --git a/docs/toc.html b/docs/toc.html new file mode 100644 index 0000000..cfbdd50 --- /dev/null +++ b/docs/toc.html @@ -0,0 +1,310 @@ + + + + + + + + + + +Table Of Contents + + + + + + + + + + + + + + + +
+ +Nagios + +
+ +

+ +Nagios Core 3.x Documentation + +

+ +

+ +Table of Contents + +

+ + + +
+ + + + + +
+ +
About

+ +
What is Nagios? + +
System requirements + +
Licensing + +
Downloading the latest version

+ + + +
Release Notes

+ +
What's new in this version + +
Known issues +

+ + + +
Support

+ +
Nagios Support Portal + +
Nagios Community Wiki

+ + + +
Getting Started

+ +
Advice for beginners

+ + + +
Quickstart installation guide

+ + + +
Upgrading from previous versions

+ + + +
How to monitor a Windows machine + +
How to monitor a Linux/Unix machine + +
How to monitor a Netware server + +
How to monitor a network printer + +
How to monitor a router/switch + +
How to monitor a publicly available service (HTTP, FTP, SSH, etc.)

+ + + +
Configuring Nagios

+ +
Configuration overview + +
Main configuration file options + +
Object configuration overview + +
Object definitions + +
CGI configuration file options + +
Configuring authorization for the CGIs

+ + + +
Running Nagios

+ +
Verifying your configuration + +
Starting and stopping Nagios

+ + + +
The Basics

+ +
Plugins + +
Macros and how they work + +
Standard macros available in Nagios + +
Host checks + +
Service checks + +
Active checks + +
Passive checks + +
State types + +
Time periods + +
Determining status and reachability of network hosts + +
Notifications + +
Information on the CGIs

+ + + +
Advanced Topics

+ +
External commands + +
Event handlers + +
Volatile services + +
Service and host result freshness checks + +
Distributed monitoring + +
Redundant and failover monitoring + +
Detection and handling of state flapping + +
Notification escalations + +
On-call notification rotations + +
Monitoring service and host clusters + +
Host and service dependencies + +
State stalking + +
Performance data + +
Scheduled host and service downtime + +
Using the embedded Perl interpreter + +
Adaptive monitoring + +
Predictive dependency checks + +
Cached checks + +
Passive host state translation + +
Check scheduling + +
Custom CGI headers and footers

+ + + +
Object inheritance + +
Time-saving tips for object definitions

+ + + + + +
Security and Performance Tuning

+ +
Security considerations + +
Enhanced CGI security and authentication + +
Tuning Nagios for maximum performance + +
Fast startup options + +
Large installation tweaks + +
Using the nagiostats utility + +
Graphing Nagios performance statistics

+ + + + + +
Integration With Other Software

+ +
Integration Overview + +
SNMP Traps + +
TCP Wrappers

+ + + + + +
Nagios Addons

+ +
NRPE + +
NSCA + +
NDOUtils + +
Other addons + +
Nagios Exchange

+ + + + + +
Development

+ +
Plugin API + +
Developing Plugins For Use With Embedded Perl

+ + + +
+ + + +
+ + + + + +
+ + + + + + \ No newline at end of file diff --git a/docs/tuning.html b/docs/tuning.html new file mode 100644 index 0000000..8635fea --- /dev/null +++ b/docs/tuning.html @@ -0,0 +1,172 @@ + + + + + + + + +Tuning Nagios For Maximum Performance + + + + + + + + + + + + + + + +
+ +Nagios + +

Tuning Nagios For Maximum Performance

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Large Installation Tweaks, Fast Startup Options, Graphing Performance Info + +

+ + + +

+ +Introduction + +

+ + + +Tuning + + + +

+ +So you've finally got Nagios up and running and you want to know how you can tweak it a bit. Tuning Nagios to increase performance can be necessary when you start monitoring a large number (> 1,000) of hosts and services. Here are a few things to look at for optimizing Nagios... + +

+ + + +
+ + + +

+ +Optimization Tips: + +

+ + + +
    + + + +
  1. Graph performance statistics with MRTG. In order to keep track of how well your Nagios installation handles load over time and how your configuration changes affect it, you should be graphing several important statistics with MRTG. This is really, really, really useful when it comes to tuning the performance of a Nagios installation. Really. Information on how to do this can be found here.

    2. + + + +
  2. Use large installation tweaks. Enabling the use_large_installation_tweaks option may provide you with better performance. Read more about what this option does here.

    3. + + + +
  3. Disable environment macros. Macros are normally made available to check, notification, event handler, etc. commands as environment variables. This can be a problem in a large Nagios installation, as it consumes some additional memory and (more importantly) more CPU. If your scripts don't need to access the macros as environment variables (e.g. you pass all necessary macros on the command line), you don't need this feature. You can prevent macros from being made available as environment variables by using the enable_environment_macros option.

    4. + + + +
  4. Check Result Reaper Frequency. The check_result_reaper_frequency variable determines how often Nagios should check for host and service check results that need to be processed. The maximum amount of time it can spend processing those results is determined by the max reaper time (see below). If your reaper frequency is too high (too infrequent), you might see high latencies for host and service checks.

    5. + + + +
  5. Max Reaper Time. The max_check_result_reaper_time variables determines the maximum amount of time the Nagios daemon can spend processing the results of host and service checks before moving on to other things - like executing new host and service checks. Too high of a value can result in large latencies for your host and service checks. Too low of a value can have the same effect. If you're experiencing high latencies, adjust this variable and see what effect it has. Again, you should be graphing statistics in order to make this determination.

    6. + + + +
  6. Adjust buffer slots. You may need to adjust the value of the external_command_buffer_slots option. Graphing buffer slot statistics with MRTG (see above) is critical in determining what values you should use for this option.

    7. + + + +
  7. Check service latencies to determine best value for maximum concurrent checks. Nagios can restrict the number of maximum concurrently executing service checks to the value you specify with the max_concurrent_checks option. This is good because it gives you some control over how much load Nagios will impose on your monitoring host, but it can also slow things down. If you are seeing high latency values (> 10 or 15 seconds) for the majority of your service checks (via the extinfo CGI), you are probably starving Nagios of the checks it needs. That's not Nagios's fault - its yours. Under ideal conditions, all service checks would have a latency of 0, meaning they were executed at the exact time that they were scheduled to be executed. However, it is normal for some checks to have small latency values. I would recommend taking the minimum number of maximum concurrent checks reported when running Nagios with the -s command line argument and doubling it. Keep increasing it until the average check latency for your services is fairly low. More information on service check scheduling can be found here.

    8. + + + +
  8. Use passive checks when possible. The overhead needed to process the results of passive service checks is much lower than that of "normal" active checks, so make use of that piece of info if you're monitoring a slew of services. It should be noted that passive service checks are only really useful if you have some external application doing some type of monitoring or reporting, so if you're having Nagios do all the work, this won't help things.

    9. + + + +
  9. Avoid using interpreted plugins. One thing that will significantly reduce the load on your monitoring host is the use of compiled (C/C++, etc.) plugins rather than interpreted script (Perl, etc) plugins. While Perl scripts and such are easy to write and work well, the fact that they are compiled/interpreted at every execution instance can significantly increase the load on your monitoring host if you have a lot of service checks. If you want to use Perl plugins, consider compiling them into true executables using perlcc(1) (a utility which is part of the standard Perl distribution) or compiling Nagios with an embedded Perl interpreter (see below).

    10. + + + +
  10. Use the embedded Perl interpreter. If you're using a lot of Perl scripts for service checks, etc., you will probably find that compiling the embedded Perl interpreter into the Nagios binary will speed things up.

    11. + + + +
  11. Optimize host check commands. If you're checking host states using the check_ping plugin you'll find that host checks will be performed much faster if you break up the checks. Instead of specifying a max_attempts value of 1 in the host definition and having the check_ping plugin send 10 ICMP packets to the host, it would be much faster to set the max_attempts value to 10 and only send out 1 ICMP packet each time. This is due to the fact that Nagios can often determine the status of a host after executing the plugin once, so you want to make the first check as fast as possible. This method does have its pitfalls in some situations (i.e. hosts that are slow to respond may be assumed to be down), but you'll see faster host checks if you use it. Another option would be to use a faster plugin (i.e. check_fping) as the host_check_command instead of check_ping.

    12. + + + +
  12. Schedule regular host checks. Scheduling regular checks of hosts can actually help performance in Nagios. This is due to the way the cached check logic works (see below). Prior to Nagios 3, regularly scheduled host checks used to result in a big performance hit. This is no longer the case, as host checks are run in parallel - just like service checks. To schedule regular checks of a host, set the check_interval directive in the host definition to something greater than 0.

    13. + + + +
  13. Enable cached host checks. Beginning in Nagios 3, on-demand host checks can benefit from caching. On-demand host checks are performed whenever Nagios detects a service state change. These on-demand checks are executed because Nagios wants to know if the host associated with the service changed state. By enabling cached host checks, you can optimize performance. In some cases, Nagios may be able to used the old/cached state of the host, rather than actually executing a host check command. This can speed things up and reduce load on monitoring server. In order for cached checks to be effective, you need to schedule regular checks of your hosts (see above). More information on cached checks can be found here.

    14. + + + +
  14. Don't use agressive host checking. Unless you're having problems with Nagios recognizing host recoveries, I would recommend not enabling the use_aggressive_host_checking option. With this option turned off host checks will execute much faster, resulting in speedier processing of service check results. However, host recoveries can be missed under certain circumstances when this it turned off. For example, if a host recovers and all of the services associated with that host stay in non-OK states (and don't "wobble" between different non-OK states), Nagios may miss the fact that the host has recovered. A few people may need to enable this option, but the majority don't and I would recommendnot using it unless you find it necessary...

    15. + + + +
  15. External command optimizations. If you're processing a lot of external commands (i.e. passive checks in a distributed setup, you'll probably want to set the command_check_interval variable to -1. This will cause Nagios to check for external commands as often as possible. You should also consider increasing the number of available external command buffer slots. Buffers slots are used to hold external commands that have been read from the external command file (by a separate thread) before they are processed by the Nagios daemon. If your Nagios daemon is receiving a lot of passive checks or external commands, you could end up in a situation where the buffers are always full. This results in child processes (external scripts, NSCA daemon, etc.) blocking when they attempt to write to the external command file. I would highly recommend that you graph external command buffer slot usage using MRTG and the nagiostats utility as described here, so you understand the typical external command buffer usage of your Nagios installation.

    16. + + + +
  16. Optimize hardware for maximum performance. NOTE: Hardware performance shouldn't be an issue unless: 1) you're monitoring thousands of services, 2) you're doing a lot of post-processing of performance data, etc. Your system configuration and your hardware setup are going to directly affect how your operating system performs, so they'll affect how Nagios performs. The most common hardware optimization you can make is with your hard drives. CPU and memory speed are obviously factors that affect performance, but disk access is going to be your biggest bottleneck. Don't store plugins, the status log, etc on slow drives (i.e. old IDE drives or NFS mounts). If you've got them, use UltraSCSI drives or fast IDE drives. An important note for IDE/Linux users is that many Linux installations do not attempt to optimize disk access. If you don't change the disk access parameters (by using a utility like hdparam), you'll loose out on a lot of the speedy features of the new IDE drives.

    17. + + + +
+ + + + + +
+ + + + + + + diff --git a/docs/upgrading.html b/docs/upgrading.html new file mode 100644 index 0000000..0e9aba1 --- /dev/null +++ b/docs/upgrading.html @@ -0,0 +1,371 @@ + + + + + + + + +Upgrading Nagios + + + + + + + + + + + + + + + +
+ +Nagios + +

Upgrading Nagios

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Quickstart Installation Guide + +

+ + + +

+ +Contents

+ +Upgrading from previous Nagios 3.x releases
+ +Upgrading from Nagios 2.x
+ +Upgrading from an RPM installation
+ +

+ + + +

+ + + +Upgrading From Previous Nagios 3.x Releases + +

+ + + +

+ +As newer alpha, beta, and stable releases of Nagios 3.x are released, you should strongly consider upgrading as soon as possible. Newer releases usually contain critical bug fixes, so its important to stay up to date. Assuming you've already installed Nagios from source code as described in the quickstart guide, you can install newer versions of Nagios 3.x easily. You don't even need root access to do it, as everything that needed to be done as root was done during the initial install. Here's the upgrade process... + +

+ + + +

+ +Make sure you have a good backup of your existing Nagios installation and configuration files. If anything goes wrong or doesn't work, this will allow you to rollback to your old version. + +

+ + + +

+ +Become the nagios user. Debian/Ubuntu users should use sudo -s nagios. + +

+ + + +
+
+su -l nagios
+
+
+ + +

+Removed the following old HTML files that were used by the web frontend. They have been replaced by PHP equivalents. +

+ +
+rm /usr/local/nagios/share/{main,side,index}.html
+
+ + + +

+ +Download the source code tarball of the latest version of Nagios (visit http://www.nagios.org/download/ for the link to the latest version). + +

+ + + +
+
+wget http://osdn.dl.sourceforge.net/sourceforge/nagios/nagios-3.x.tar.gz
+
+
+ + + +

+ +Extract the Nagios source code tarball. + +

+ + + +
+
+tar xzf nagios-3.x.tar.gz
+
+cd nagios-3.x
+
+
+ + + +

+ +Run the Nagios configure script, passing the name of the group used to control external command file permissions like so: + +

+ + + +
+
+./configure --with-command-group=nagcmd
+
+
+ + + +

+ +Compile the Nagios source code. + +

+ + + +
+
+make all
+
+
+ + + +

+ +Install updated binaries, documentation, and web web interface. Your existing configuration files will not be overwritten by this step. + +

+ + + +
+
+make install
+
+
+ + + +

+ +Verify your configuration files. Correct any errors shown here before proceeding with the next step. + +

+ + + +
+
+/usr/local/nagios/bin/nagios -v /usr/local/nagios/etc/nagios.cfg
+
+
+ + + +

+ +Restart Nagios. Debian/Ubuntu users should use /etc/init.d/nagios restart. + +

+ + + +
+
+/sbin/service nagios restart
+
+
+ + + +

+ +That's it - you're done! + +

+ + + + + +

+ + + +Upgrading From Nagios 2.x + +

+ + + +

+ +It shouldn't be too difficult to upgrade from Nagios 2.x to Nagios 3. The upgrade is essentially the same as what is described above for upgrading to newer 3.x releases. You will, however, have to change your configuration files a bit so they work with Nagios 3: + +

+ + + + + + + +

+ +Also make sure to read the "What's New" section of the documentation. It describes all the changes that were made to the Nagios 3 code since the latest stable release of Nagios 2.x. Quite a bit has changed, so make sure you read it over. + +

+ + + +

+ + + +Upgrading From an RPM Installation + +

+ + + +

+ +If you currently have an RPM- or Debian/Ubuntu APT package-based installation of Nagios and you would like to transition to installing Nagios from the official source code distribution, here's the basic process you should follow: + +

+ + + +
    + +
  1. Stop Nagios
    2. + +
  2. Backup your existing Nagios installation
    3. + + + +
  3. Uninstall the original RPM or APT package
    4. + +
  4. Install Nagios from source by following the quickstart guide
    5. + +
  5. Restore your original Nagios configuration files, retention file, and log files
    6. + +
  6. Verify your configuration and start Nagios
    7. + +
+ + + +

+ +Note that different RPMs or APT packages may install Nagios in different ways and in different locations. Make sure you've backed up all your critical Nagios files before removing the original RPM or APT package, so you can revert back if you encounter problems. + +

+ + + + + +
+ + + + + + + diff --git a/docs/verifyconfig.html b/docs/verifyconfig.html new file mode 100644 index 0000000..69516db --- /dev/null +++ b/docs/verifyconfig.html @@ -0,0 +1,114 @@ + + + + + + + + +Verifying Your Nagios Configuration + + + + + + + + + + + + + + + +
+ +Nagios + +

Verifying Your Configuration

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Configuration Overview, Starting and Stopping Nagios + +

+ + + +

+ +Verifying Your Configuration + +

+ + + +

+ +Every time you modify your configuration files, you should run a sanity check on them. It is important to do this before you (re)start Nagios, as Nagios will shut down if your configuration contains errors. + +

+ + + +

+ +In order to verify your configuration, run Nagios with the -v command line option like so: + +

+ + + +
+
+/usr/local/nagios/bin/nagios -v /usr/local/nagios/etc/nagios.cfg
+
+
+ + + +

+ +If you've forgotten to enter some critical data or misconfigured things, Nagios will spit out a warning or error message that should point you to the location of the problem. Error messages generally print out the line in the configuration file that seems to be the source of the problem. On errors, Nagios will often exit the pre-flight check and return to the command prompt after printing only the first error that it has encountered. This is done so that one error does not cascade into multiple errors as the remainder of the configuration data is verified. If you get any error messages you'll need to go and edit your configuration files to remedy the problem. Warning messages can generally be safely ignored, since they are only recommendations and not requirements. + +

+ + + +

+ +Once you've verified your configuration files and fixed any errors you can go ahead and (re)start Nagios. + +

+ + + +
+ + + + + + + diff --git a/docs/volatileservices.html b/docs/volatileservices.html new file mode 100644 index 0000000..0cce888 --- /dev/null +++ b/docs/volatileservices.html @@ -0,0 +1,314 @@ + + + + + + + + +Volatile Services + + + + + + + + + + + + + + + +
+ +Nagios + +

Volatile Services

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: State Stalking + +

+ + + +

+ +Introduction + +

+ + + +

+ +Nagios has the ability to distinguish between "normal" services and "volatile" services. The is_volatile option in each service definition allows you to specify whether a specific service is volatile or not. For most people, the majority of all monitored services will be non-volatile (i.e. "normal"). However, volatile services can be very useful when used properly... + +

+ + + +

+ +What Are They Useful For? + +

+ + + +

+ +Volatile services are useful for monitoring... + +

+ + + + + + + +

+ +What's So Special About Volatile Services? + +

+ + + +

+ +Volatile services differ from "normal" services in three important ways. Each time they are checked when they are in a hard non-OK state, and the check returns a non-OK state (i.e. no state change has occurred)... + +

+ + + + + + + +

+ +These events normally only occur for services when they are in a non-OK state and a hard state change has just occurred. In other words, they only happen the first time that a service goes into a non-OK state. If future checks of the service result in the same non-OK state, no hard state change occurs and none of the events mentioned take place again. + +

+ + + +

+ +Tip Tip: If you are only interested in logging, consider using stalking options instead. + +

+ + + +

+ +The Power Of Two + +

+ + + +

+ +If you combine the features of volatile services and passive service checks, you can do some very useful things. Examples of this include handling SNMP traps, security alerts, etc. + +

+ + + +

+ +How about an example... Let's say you're running PortSentry to detect port scans on your machine and automatically firewall potential intruders. If you want to let Nagios know about port scans, you could do the following... + +

+ + + +

+ +Nagios Configuration: + +

+ + + + + + + +

+ +PortSentry Configuration: + +

+ + + +

+ +Edit your PortSentry configuration file (portsentry.conf) and define a command for the KILL_RUN_CMD directive as follows: + +

+ +
+
+KILL_RUN_CMD="/usr/local/Nagios/libexec/eventhandlers/submit_check_result host_name 'Port Scans' 2 'Port scan from host $TARGET$ on port $PORT$.  Host has been firewalled.'"
+
+
+ +

+ +Make sure to replace host_name with the short name of the host that the service is associated with. + +

+ + + +

+ +Port Scan Script: + +

+ + + +

+ +Create a shell script in the /usr/local/nagios/libexec/eventhandlers directory named submit_check_result. The contents of the shell script should be something similiar to the following... + +

+ + + +
+
+	#!/bin/sh
+
+ 
+
+	# Write a command to the Nagios command file to cause
+
+	# it to process a service check result
+
+ 
+
+	echocmd="/bin/echo"
+
+ 
+
+	CommandFile="/usr/local/nagios/var/rw/nagios.cmd"
+
+ 
+
+	# get the current date/time in seconds since UNIX epoch
+
+	datetime=`date +%s`
+
+ 
+
+	# create the command line to add to the command file
+
+	cmdline="[$datetime] PROCESS_SERVICE_CHECK_RESULT;$1;$2;$3;$4"
+
+ 
+
+	# append the command to the end of the command file
+
+	`$echocmd $cmdline >> $CommandFile`
+
+
+ + + +

+ +What will happen when PortSentry detects a port scan on the machine in the future? + +

+ + + + + + + +

+ +Pretty neat, huh? + +

+ + + +
+ + + + + + + diff --git a/docs/whatsnew.html b/docs/whatsnew.html new file mode 100644 index 0000000..07833c9 --- /dev/null +++ b/docs/whatsnew.html @@ -0,0 +1,605 @@ + + + + + + + + +What's New + + + + + + + + + + + + + + + +
+ +Nagios + +

What's New in Nagios Core 3.x

+ +
+ + + +
+ + + +

+ +Up ToUp To: Contents
+ +See Also See Also: Known Issues +

+ + + +

+ +Tip Important: Make sure you read through the documentation and the FAQs at support.nagios.com before sending a question to the mailing lists. + +

+ + + + + + + +

+ +Change Log + +

+ + + +

+ +The change log for Nagios can be found online at http://www.nagios.org/development/history or in the Changelog file in the root directory of the source code distribution. + +

+ + + + + +

+ +Changes and New Features + +

+ + + +
    + + + +
  1. Documentation:
    + +
      + +
    • Doc updates - I'm slowly making my way through rewriting most all portions of the documentation. This is going to take a while, as (1) there's a lot of documentation and (2) writing documentation is not my favorite thing in the world. Expect some portions of the docs to be different than others for a while. I hope the changes I'm making will make things clearer/easier for new and seasoned Nagios users alike.
      • + +
    + +
    2. + +
    + + + +
  2. Macros:
    + +
      + +
    • New macros - New macros have been added, including: $TEMPPATH$, $LONGHOSTOUTPUT$, $LONGSERVICEOUTPUT$, $HOSTNOTIFICATIONID$, $SERVICENOTIFICATIONID$, $HOSTEVENTID$, $SERVICEEVENTID$, $SERVICEISVOLATILE$, $LASTHOSTEVENTID$, $LASTSERVICEEVENTID$, $HOSTDISPLAYNAME$, $SERVICEDISPLAYNAME$, $MAXHOSTATTEMPTS$, $MAXSERVICEATTEMPTS$, $TOTALHOSTSERVICES$, $TOTALHOSTSERVICESOK$, $TOTALHOSTSERVICESWARNING$, $TOTALHOSTSERVICESUNKNOWN$, $TOTALHOSTSERVICESCRITICAL$, $CONTACTGROUPNAME$, $CONTACTGROUPNAMES$, $CONTACTGROUPALIAS$, $CONTACTGROUPMEMBERS$, $NOTIFICATIONRECIPIENTS$, $NOTIFICATIONISESCALATED$, $NOTIFICATIONAUTHOR$, $NOTIFICATIONAUTHORNAME$, $NOTIFICATIONAUTHORALIAS$, $NOTIFICATIONCOMMENT$, $EVENTSTARTTIME$, $HOSTPROBLEMID$, $LASTHOSTPROBLEMID$, $SERVICEPROBLEMID$, $LASTSERVICEPROBLEMID$, $LASTHOSSTATE$, $LASTHOSTSTATEID$, $LASTSERVICESTATE$, $LASTSERVICESTATEID$. Two special on-demand time macros have also been added: $ISVALIDTIME:$ and $NEXTVALIDTIME:$.
      • + +
    • Removed macros - The old $NOTIFICATIONNUMBER$ macro has been deprecated in favor of new $HOSTNOTIFICATIONNUMBER$ and $SERVICENOTIFICATIONNUMBER$ macros.
      • + +
    • Changes - The $HOSTNOTES$ and $SERVICENOTES$ macros may now contain macros themselves, just like the $HOSTNOTESURL$, $HOSTACTIONURL$, $SERVICENOTESURL$ and $SERVICEACTIONURL$ macros.
      • + +
    • Macros are normally available as environment variables when check, event handler, notification, and other commands are run. This can be rather CPU intensive in large Nagios installations, so you can disable this behavior with the enable_environment_macros option.
      • + +
    • Macro information can be found here.
      • + +
    + +
    3. + +
    + + + +
  3. Scheduled Downtime:
    + +
      + +
    • Scheduled downtime entries are no longer stored in their own file (previously specified with a downtime_file directive in the main configuration file). Current and retained scheduled downtime entries are now stored in the status file and retention file, respectively.
      • + +
    + +
    4. + +
    + + + +
  4. Comments:
    + +
      + +
    • Host and service comments are no longer stored in their own file (previously specified with a comment_file directive in the main configuration file). Current and retained comments are now stored in the status file and retention file, respectively.
      • + +
    • Acknowledgement comments that are marked as non-persistent are now only deleted when the acknowledgement is removed. They were previously automatically deleted when Nagios restarted, which was not ideal.
      • + +
    + +
    5. + +
    + + + +
  5. State Retention Data:
    + + + +
    6. + +
    + + + +
  6. Flap Detection:
    + +
      + +
    • Added flap_detection_options directive to host and service definitions to allow you to specify what host/service states should be used by the flap detection logic (by default all states are used).
      • + +
    • Percent state change and state history are now retained and recorded even when flap detection is disabled.
      • + +
    • Hosts and services are immediately checked for flapping when flap detection is enabled program-wide.
      • + +
    • Hosts and services that are flapping when flap detection is disabled program-wide are now logged.
      • + +
    • More information on flap detection can be found here.
      • + +
    + +
    7. + +
    + + + +
  7. External Commands:
    + +
      + +
    • Added a new PROCESS_FILE external command to allow processing of external commands found in an external (regular) file. Useful for processing large amounts of passive checks with long output, or for scripting regular commands. More information can be found here.
      • + +
    • Custom commands may now be submitted to Nagios. Custom command names are prefixed with an underscore and are not processed internally by the Nagios daemon. They may, however, be processed by a loaded NEB module.
      • + +
    • The check_external_commands option is now enabled by default, which means Nagios is configured to check for external "commands out of the box". All 2.x and earlier versions of Nagios had this option disabled by default.
      • + +
    + +
    8. + +
    + + + +
  8. Status Data:
    + +
      + +
    • Contact status information (last notification times, notifications enabled/disabled, etc.) is now saved in the status and retention files, although it is not processed by the CGIs.
      • + +
    + +
    9. + +
    + + + +
  9. Embedded Perl:
    + +
      + +
    • Added new enable_embedded_perl and use_embedded_perl_implicitly variables to control use of the embedded Perl interpreter.
      • + +
    • Perl scripts/plugins can now explicitly tell Nagios whether or not they should be run under the embedded Pel interpreter. This is useful if you have troublesome scripts that don't function well under the ePN.
      • + +
    • More information about these new options can be found here.
      • + +
    + +
    10. + +
    + + + +
  10. Adaptive Monitoring:
    + +
      + +
    • The check timeperiod for hosts and services can now be modified on-the-fly with the appropriate external command (CHANGE_HOST_CHECK_TIMEPERIOD or CHANGE_SVC_CHECK_TIMEPERIOD). Look here for available adaptive monitoring commands.
      • + +
    + +
    11. + +
    + + + +
  11. Notifications:
    + +
      + +
    • A first_notification_delay option has been added to host and service definitions to (what else) introduce a delay between when a host/service problem first occurs and when the first problem notification goes out. In previous versions you had to use some mighty config-fu with escalations to accomplish this. Now this feature is available to normal mortals.
      • + +
    • Notifications are now sent out for hosts/services that are flapping when flap detection is disabled on a host- or service-specific basis or on a program-wide basis. The $NOTIFICATIONTYPE$ macro will be set to "FLAPPINGDISABLED" in this situation.
      • + +
    • Notifications can now be sent out when scheduled downtime start, ends, and is cancelled for hosts and services. The $NOTIFICATIONTYPE$ macro will be set to "DOWNTIMESTART", "DOWNTIMEEND", or "DOWNTIMECANCELLED", respectively. In order to receive notifications on scheduled downtime events, specify "s" or "downtime" in your contact, host, and/or service notification options.
      • + +
    • More information on notifications can be found here.
      • + +
    + +
    12. + +
    + + + +
  12. Object Definitions:
    + +
      + +
    • Service dependencies can now be created to easily define "same host" dependencies for different services on one or more hosts. (Read more)
      • + +
    • Extended host and service definitions (hostextinfo and serviceextinfo, respectively) have been deprecated. All values that from extended definitions have been merged with host or service definitions, as appropriate. Nagios 3 will continue to read and process older extended information definitions, but will log a warning. Future versions of Nagios (4.x and later) will not support separate extended info definitions.
      • + +
    • New hostgroup_members, servicegroup_members, and contactgroup_members directives have been added to hostgroup, servicegroup, and contactgroups definitions, respectively. This allows you to include hosts, services, or contacts from sub-groups in your group definitions.
      • + +
    • New notes, notes_url, and action_url have been added to hostgroup and servicegroup definition.
      • + +
    • Contact definitions have the new host_notifications_enabled, service_notifications_enabled, and can_submit_commands directives to better control notifications and determine whether or not they can submit commands through the web interface.
      • + +
    • Host and service dependencies now support an optional dependency_period directive. This allows you to limit the times during which dependencies are valid.
      • + +
    • The parallelize directive in service definitions is now deprecated and no longer used. All service checks are run in parallel in Nagios 3.
      • + +
    • There are no longer any inherent limitations on the length of host names or service descriptions.
      • + +
    • Extended regular expressions are now used if you enable the use_regexp_matching config option. Regular expression matching is only used in certain object definition directives that contain *, ?, +, or \..
      • + +
    • A new initial_state directive has been added to host and service definitions, so you can tell Nagios that a host/service should default to a specific state when Nagios starts, rather than UP or OK (which is still the default).
      • + +
    + +
    13. + +
    + + + +
  13. Object Inheritance:
    + +
      + +
    • You can now inherit object variables/values from multiple templates by specifying more than one template name in the use directive of object definitions. This can allow for some very powerful (and complex) inheritance setups. (Read more)
      • + +
    • Services now inherit contact groups, notification interval, and notification period from their associated host if not otherwise specified. (Read more)
      • + +
    • Host and service escalations now inherit contact groups, notification interval, and escalation timeperiod from their associated host or service if not otherwise specified. (Read more)
      • + +
    • String variables in host, service, and contact definitions can now be prevented from being inherited by specifying a value of "null" (without quotes) for the value of the variable. (Read more)
      • + +
    • Most string variables in local object definitions can now be appended to the string values that are inherited. This is quite handy in large configurations. (Read more)
      • + +
    + +
    14. + +
    + + + +
  14. Performance Improvements:
    + +
      + +
    • Add ability to precache object config files and exclude circular path detection checks from verification process. This can speed up Nagios start time immensely in large environments! Read more here.
      • + +
    • A new use_large_installation_tweaks option has been added that should improve performance in large Nagios installations. Read more about this here.
      • + +
    • A number of internal improvements have been made with regards to how Nagios deals with internal data structures and object (e.g. host and service) relationships. These improvements should result in a speedup for larger installations.
      • + +
    • New external_command_buffer_slots option has been added to allow you to more easily scale Nagios in large environments. For best results you should consider using MRTG to graph Nagios' usage of buffer slots over time.
      • + +
    + +
    15. + +
    + + + +
  15. Plugin Output:
    + +
      + +
    • Multiline plugin output is now supported for host and service checks. Hooray! The plugin API has been updated to support multiple lines of output in a manner that retains backward compatability with older plugins. Additional lines of output (aside from the first line) are now stored in new $LONGHOSTOUTPUT$ and $LONGSERVICEOUTPUT$ macros.
      • + +
    • The maximum length of plugin output has been increased to 4K (from around 350 bytes in previous versions). This 4K limit has been arbitrarily chosen to protect again runaway plugins that dump back too much data to Nagios.
      • + +
    • More information on the plugins, multiline output, and max plugin output length can be found here.
      • + +
    + +
    16. + +
    + + + +
  16. Service Checks:
    + +
      + +
    • Nagios now checks for orphaned service checks by default.
      • + +
    • Added a new enable_predictive_service_dependency_checks option to control whether or not Nagios will initiate predictive check of service that are being depended upon (in dependency definitions). Predictive checks help ensure that the dependency logic is as accurate as possible. (Read more)
      • + +
    • A new cached service check feature has been implemented that can significantly improve performance for many people Instead of executing a plugin to check the status of a service, Nagios can often use a cached service check result instead. More information on this can be found here.
      • + +
    + +
    17. + +
    + + + +
  17. Host Checks:
    + +
      + +
    • Host checks are now run in parallel! Host checks used to be run in a serial fashion, which meant they were a major holdup in terms of performance. No longer! (Read more)
      • + +
    • Host check retries are now performed like service check retries. That is to say, host definitions now have a new retry_interval that specifies how much time to wait before trying the host check again. :-)
      • + +
    • Regularly scheduled host checks now longer hinder performance. In fact, they can help to increase performance with the new cached check logic (see below).
      • + +
    • Added a new check_for_orphaned_hosts option to enable checks of orphaned host checks. This is need now that host checks are run in parallel.
      • + +
    • Added a new enable_predictive_host_dependency_checks option to control whether or not Nagios will initiate predictive check of hosts that are being depended upon (in dependency definitions). Predictive checks help ensure that the dependency logic is as accurate as possible. (Read more)
      • + +
    • A new cached host check feature has been implemented that can significantly improve performance for many people Instead of executing a plugin to check the status of a host, Nagios can often use a cached host check result instead. More information on this can be found here.
      • + +
    • Passive host checks that have a DOWN or UNREACHABLE result can now be automatically translated to their proper state from the point of view of the Nagios instance that receives them. This is very useful in failover and distributed monitoring setups. More information on passive host check state translation can be found here.
      • + +
    • Passive host checks normally put a host into a HARD state. This can now be changed by enabling the passive_host_checks_are_soft option.
      • + +
    + +
    18. + +
    + + + +
  18. Freshness checks:
    + +
      + +
    • A new freshness_threshold_latency option has been added to allow to you specify the number of seconds that should be added to any host or service freshness threshold that is automatically calculated by Nagios.
      • + +
    + +
    19. + +
    + + + +
  19. IPC:
    + +
      + +
    • The IPC mechanism that is used to transfer host/service check results back to the Nagios daemon from (grand)child processes has changed! This should help to reduce load/latency issues related to processing large numbers of passive checks in distributed monitoring environments.
      • + +
    • Check results are now transferred by writing check results to files in directory specified by the check_result_path option. Files that are older than the max_check_result_file_age option will be mercilessly deleted without further processing.
      • + +
    + +
    20. + +
    + + + +
  20. Timeperiods:
    + +
      + +
    • Timeperiods were overdue for a major overhaul and have finally been extended to allow for date exceptions, skip dates (every 3 days), etc! This should help you out when defining notification timeperiods for pager rotations.
      • + +
    • More information on the new timeperiod directives can be found here and here.
      • + +
    + +
    21. + +
    + + + +
  21. Event Broker:
    + +
      + +
    • Updated NEB API version
      • + +
    • Modified callback for adaptive program status data
      • + +
    • Added callback for adaptive contact status data
      • + +
    • Added precheck callbacks for hosts and services to allow modules to cancel/override internal host/service checks.
      • + +
    + +
    22. + +
    + + + +
  22. Web Interface:
    + +
      + +
    • The main splash pages of the web interface are now PHP pages. This will require that you install/enable PHP support on your system if it isn't already.
      • + +
    • Hostgroup and servicegroup summaries now show important/unimportant problem breakdowns like the TAC CGI.
      • + +
    • Minor layout changes to host and service detail views in extinfo CGI.
      • + +
    • New check statistics and have been added to the "Performance Info" screen.
      • + +
    • Added Splunk integration options to various CGIs. Integration is controlled by the enable_splunk_integration and splunk_url options in the CGI config file. + +
    • Added new notes_url_target and action_url_target options to control what frame notes and action URLs are opened in.
      • + +
    • Added new lock_author_names option to prevent alteration of author names when users submit comments, acknowledgements, and scheduled downtime.
      • + +
    + +
    23. + +
    + + + +
  23. Debugging Info:
    + +
      + +
    • The DEBUGx compile options available in the configure script have been removed.
      • + +
    • Debugging information can now be written to a separate debug file, which is automatically rotated when it reaches a user-defined size. This should make debugging problems much easier, as you don't need to recompile Nagios. Full support for writing debugging information to file is being added during the alpha development phase, so it may not be complete when you try it.
      • + +
    • Variables that affect the debug log are debug_file, debug_level, debug_verbosity, and max_debug_file_size.
      • + +
    + +
    24. + +
    + + + +
  24. Update Checks:
    + +
      + +
    • Nagios will now check approximately once a day to see if a new version is available. This is useful to keep on top of security patches and new releases. Update notices will appear in the web interface.
      • + +
    • Variables that affect the update check are check_for_updates and bare_update_check.
      • + +
    + +
    25. + +
    + + + +
  25. Misc:
    + +
      + +
    • Temp path variable - A new temp_path variable has been added to specify a scratch directory that Nagios can use for temporary scratch space.
      • + +
    • Unique notification and event ID numbers - A unique ID number is now assigned to each host and service notification. Another unique ID is now assigned to all host and service state changes as well. The unique IDs can be accessed using the following respective macros: $HOSTNOTIFICATIONID$, $SERVICENOTIFICATIONID$, $HOSTEVENTID$, $SERVICEEVENTID$, $LASTHOSTEVENTID$, $LASTSERVICEEVENTID$.
      • + +
    • New macros - A few new macros (other than those already mentioned elsewhere above) have been added. They include $HOSTGROUPNAMES$, $SERVICEGROUPNAMES$, $HOSTACKAUTHORNAME$, $HOSTACKAUTHORALIAS$, $SERVICEACKAUTHORNAME$, and $SERVICEACKAUTHORALIAS$.
      • + +
    • Reaper frequency - The old service_reaper_frequency variable has been renamed to check_result_reaper_frequency, as it is now also used to process host check results.
      • + +
    • Max reaper time - A new max_check_result_reaper_time variable has been added to limit the amount of time a single reaper event is allowed to run.
      • + +
    • Fractional intervals - Fractional notification and check intervals (e.g. "3.5" minutes) are now supported in host, service, host escalation, and service escalation definitions.
      • + +
    • Escaped command arguments - You can now pass bang (!) characters in your command arguments by escaping them with a backslash (\). If you need to include backslashes in your command arguments, they should also be escaped with a backslash.
      • + +
    • Multiline system command output - Nagios will now read multiple lines out output from system commands it runs (notification scripts, etc.), up to 4K. This matches the limits on plugin output mentioned earliar. Output from system commands is not directly processed by Nagios, but support for it is there nonetheless.
      • + +
    • Better scheduling information - More detailed information is given when Nagios is executed with the -s command line option. This information can be used to help reduce the time it takes to start/restart Nagios.
      • + +
    • Aggregated status file updates - The old aggregate_status_updates option has been removed. All status file updates are now aggregated at a minimum interval of 1 second.
      • + +
    • New performance data file mode - A new "p" option has been added to the host_perfdata_file_mode and service_perfdata_file_mode options. This new mode will open the file in non-blocking read/write mode, which is useful for pipes.
      • + +
    • Timezone offset - A new use_timezone option has been added to allow you to run different instances of Nagios in timezones different from the local zone.
      • + +
    + +
    26. + +
    + + + +
+ + + +
+ + + + + + + diff --git a/lib/PB/Nagios/Config.pm b/lib/PB/Nagios/Config.pm new file mode 100644 index 0000000..fad95e3 --- /dev/null +++ b/lib/PB/Nagios/Config.pm @@ -0,0 +1,131 @@ +package PB::Nagios::Config; + +# $Id$ +# $URL$ + +=head1 NAME + +PB::Nagios::Config + +=head1 DESCRIPTION + +Perl module for parsing Nagios configuration file + +=cut + +#--------------------------------------------------------------------------- + +use strict; +use 5.10.0; +use warnings; + +use Carp qw(:DEFAULT cluck); +use Exporter; +use Fcntl qw(:DEFAULT :flock); + +use Text::ParseWords 'parse_line'; +use File::Spec; +use File::Spec::Functions; +use Cwd 'abs_path'; + +our $errstr; + +#------------------------------------------------------------------------------------------ + +use constant DEFAULT_NAGIOS_CONF_DIR => catfile( '', 'etc', 'nagios' ); + +#------------------------------------------------------------------------------------------ + +sub new { + + my $class = shift; + $class = ref($class) || $class; + + my $self = { + _FILE_HANDLE => undef, # holds a reference to an opened cfg file + _FILE_NAME => undef, # holds the name of the read configuration file + _DATA => {}, # actual key/value pairs are stored in _DATA + _ARGS => {}, # holds all key/values passed to new() + }; + + bless ($self, $class); + $self->_init(@_) or return; + return $self; + +} + +#------------------------------------------------------------------------------------------ + +# initialize the object +sub _init { + + my $self = shift; + + if ( @_ == 1 ) { + return $self->read($_[0]); + } elsif ( @_ % 2 ) { + croak "new(): Illegal arguments detected"; + } else { + $self->{'_ARGS'} = { @_ }; + } + + # If filename was passed, call read() + if ( exists ($self->{'_ARGS'}->{'filename'}) ) { + return $self->read( $self->{'_ARGS'}->{'filename'} ); + } + + return 1; + +} + +#------------------------------------------------------------------------------------------ + +# takes a filename or a file handle and returns a filehandle +sub _get_fh { + + my ($self, $arg, $mode) = @_; + + unless ( defined $arg ) { + croak "_get_fh(): filename is missing"; + } + + if ( ref($arg) && (ref($arg) eq 'GLOB') ) { + return ($arg, 0); + } + + unless ( defined $mode ) { + $mode = O_RDONLY; + } + + unless ( sysopen( FH, $arg, $mode ) ) { + $self->error("couldn't open $arg: $!"); + return undef; + } + + return ( \*FH, 1 ); + +} + + +#------------------------------------------------------------------------------------------ + +sub error { + + my ($self, $msg) = @_; + + if ( $msg ) { + $errstr = $msg; + } + return $errstr; + +} + +#------------------------------------------------------------------------------------------ + +1; + +#------------------------------------------------------------------------------------------ + +__END__ + +# vim: noai : ts=4 fenc=utf-8 filetype=perl :