Create a new Hosts / Services /... / Contactgroups¶

The creation of a new object is done via the Create a new ... instruction next to the Actions menu

Browse filesystem¶

A browser that allows you to navigate to the directory containing Naemon configuration files located in /etc/naemon/conf.d/ folder.

Objects Tree¶

An Objects Browser inside Naemon configuration files located folder in /etc/naemon/conf.d/ folder.

Create a host¶

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 available this could cause problems. When used properly, the $HOSTADDRESS$ macro will contain this address.

use: Link to the the template you use

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.

new attribute: A field used to add a new directive wich is filled with the add new attribute button.

A descrition of all directives is located here.

apply Click on apply to save.

Definition¶

A command is the definition of a line of command which uses a script or an application to perform an action. It is possible execute this command by specifying arguments.

There are three types of command:

• Verification commands are used by the schedulers to verify the status of a host or of a service.
• Notification commands are used by the schedulers to alert the contacts (via mail, SMS, etc.).
• Miscellaneous commands are used by the additional modules (to perform certain actions), by the scheduler for data processing, etc.

All the commands can be configured in the menu: Config Tool ==> Object Configuration ==> Commands ==> Create a new command.

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.

Time periods apply to two types of actions:

• Execution of check commands
• Sending of notifications

Configuration¶

The configuration of time periods is done in the menu: Config Tool ==> Object Configuration ==> Timeperiods ==> Create a new timeperiod.

Definition¶

The contacts in Naemon are used to:

• Log in to the Naemon web interface: each contact has its own rights of authentication to the web interface.
• Be warned in the event of a problem on your network (notification).

To add a contact, simply go to the menu: Config Tool ==> Object Configuration ==> Contacts ==> Create a new contact.

To display a contact, click on the Object Configuration field under Contacts, then click on the Show button.

According to your needs, add more attributes by clicking on add new attributes, fill the field you just selected and click on finish.

General information¶

• The contact_name field defined the login to access the web interface.
• The alias field is used to define a longer name or description for the contact.
• The use field allows us to link the contact to a Model of contact.
• The can_submit_commands directive is used to determine whether or not the contact can submit external commands to Naemon from the CGIs. Values: 0 = don’t allow contact to submit commands, 1 = allow contact to submit commands.
• The email field contain the e-mail address of the contact (to send out an alert email to the contact).
• The contactgroups is used to associated the contact to one or more groups of contacts.
• The host_notification_commands field serves to choose the notification command to a host.
• The host_notification_options field serves to define states for which notifications can be sent out to this contact..
• The host_notification_period field serves to choose the time period for which notifications can be sent.
• The host_notification_enable directive allows us to enable the sending of notifications to the user.
• The service_notification_commands field serves to choose the notification command to a service.
• The service_notification_options field serves to define states for which notifications can be sent out to this contact..
• minimum_value: This directive is used as the value that the host or service hourly value must equal before notification is sent to this contact.
• pager: This directive is used to define a pager number for the contact.
• addressx: Address directives are used to define additional “addresses” for the contact.
• retain_status_information: This directive is used to determine whether or not status-related information about the contact is retained across program restarts.
• retain_nonstatus_information: This directive is used to determine whether or not non-status information about the contact is retained across program restarts.

User Configuration¶

You can either edit or create, simply go to the menu: Config Tool ==> User settings.

• The Usernamed field serves to select an existing user to change or to create a new user (just type his name) to access the Naemon web interface.
• The Contact Exists field let us edit the user settings
• The Password and Confirm Password fields contain the user password.

You can now set to yes or no the global authorization functionality when determining what the users have access to. More information on how to setup authentication and configure authorization for the CGIs can be found here.

• 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).
• You must be authorized for configuration information in order to any kind of configuration information.

Host Groups¶

To add a host group:

1. Go to the menu: Config Tool ==> Object Configuration ==> Hostgroups
2. In the Action menu, click on Create a new hostgroups

• The Host Group Name and Alias defines the name and the alias of the host group.
• The Linked Hosts list allows us to add hosts in the hostgroup.
• The Notes field allows us to add optional notes concerning the host group.
• The Notes URL field defined a URL which can be used to give more information on the hostgroup.
• The Action URL field defined a URL normally use to give information on actions on the hostgroup (maintenance, etc.).
• The Icon field indicates the icon to be use for the host group.
• The Map Icon is the icon use for mapping.
• The RRD retention field is expressed in days, it serves to define the duration of retention of the services belonging to this hostgroup in the RRD database. It will be the default duration defined in the menu: “ Administration ==> Options ==> CentStorage ” if this value is not defined.
• The Status and Comments fields allow to enable or disable the host group and to make comments on it.

Service Groups¶

To add a service group:

1. Go into the menu: Config Tool ==> Object Configuration ==> Servicegroups
2. In the Action menu, click on Create a new servicegroup

• The Service Group Name and Description fields describes the name and the description of the service group.
• The Linked Host Services list allows us to choose the various services that will be included in this group.
• The Linked Host Group Services list allows us to choose the services linked to a host group that will be part of this group.
• The Linked Service Templates list allows to deploy a service based on this template on all hosts linked to this group.
• The Status and Comments fields allow to enable or disable the service group and to make comment on it.

Contact Groups¶

To add a group of contacts:

1. Go into the menu: Config Tool ==> Object Configuration ==> Contactgroups
2. In the Action menu, click on Create a new contactgroup

• The Contact Group Name and Alias fields define the name and the description of the contact group.
• The Linked Contacts list allows us to add contacts to the contact group.
• The Status and Comment fields allow to enable or disable the group of contacts and to make comment on it.

Introduction¶

This document describes how to monitor local and Windows machines attributes, such as:

• Memory Usage
• CPU load
• Disk Usage

Overview¶

Monitoring services or attributes of a Windows machine requires the installation of an agent. This agent acts as a proxy between the Nagios plugin and the actual service or attribute of the Windows machine to be monitored . Without installing an agent on the Windows machine, Naemon would be unable to monitor local services or attributes of the Windows machine.

For this example, we will install NSClient ++ on the Windows machine and using the plugin check_nrpe that will communicate with the addon NSClient .

Steps¶

There are several steps you need to follow in order to monitor a new Windows machine:

• Install a monitoring agent on the Windows machine
• Create new host and service definitions for monitoring the Windows machine
• Restart the Naemon Service

Introduction¶

One of the features of Naemon’ object configuration format is that you can create object definitions that inherit properties from other object definitions.

An explanation of how object inheritance works can be found here.

I strongly suggest that you familiarize yourself with object inheritance once you read over the documentation presented there, as it will make the job of creating and maintaining object definitions much easier than it otherwise would be.

Now it is time to create some configuration object definitions in order to monitor a new Windows machine. We will start by creating a basic host group for all Windows machines for one site.

Add an hostgroup¶

For editing , go through :

1. Naemon Setup menu Config Tool ==> Object settings ==> Hostgroups.
2. Create or Clone.
3. Make changes and click on Apply.

Add a command¶

Configuration

check_nt_uptime

We will add a “command / plugin ” check_nt_uptime that will be used by the system start service we will create for our “host” . For editing , go through

1. Config Tool Menu ==> Object Configuration ==> Commands
2. Create a new command

3. Enter the command name check_nt_uptime.
4. Enter the following command line $USER1$/check_nt -H $HOSTADDRESS$ -v UPTIME -s NsclientPassword -p 12489
5. Save, click on Apply.

The command is now present in Naemon configuration. We can now associate it to a service.

check_nt_cpu

We will add a “command / plugin ” check_nt_cpu that will be used by the cpu use service we will create for our “host” .

• Config Tool Menu / Object Configuration / Commands
• Enter the name of the command check_nt_cpu
• Enter the following command line $USER1$/check_nt -H $HOSTADDRESS$ -v CPULOAD -s NsclientPassword -p 12489
• Save and click on apply

The command is now present in Naemon configuration. We can now associate it to a service.

check_mysql

We will add a “command / plugin ” check_mysql that will be used by mysql service we will create for our “host” .

• Config Tool Menu / Object Configuration / Commands
• Enter the name of the command check_mysql
• Enter the following command line : $USER1$/check_mysql -H $HOSTADDRESS$ -u user -p Password
• Save and click on apply

The command is now present in Naemon configuration. We can now associate it to a service.

check_local_load

We will add a “command / plugin ” check_local_load that will be used by Current Load service we will create for our “host” .

• Config Tool Menu / Object Configuration / Commands
• Enter the name of the command check_local_load
• Enter the following command line $USER1$/check_load -H $HOSTADDRESS$ -w 5.0,4.0,3.0 -c 10.0,6.0,4.0
• Save and click on apply

The command is now present in Naemon configuration. We can now associate it to a service.

check_local_procs

We will add a “command / plugin ” check_local_procs that will be used by Total Processes service we will create for our “host” .

• Config Tool Menu / Object Configuration / Commands
• Enter the name of the command check_local_load
• Enter the following command line $USER1$/check_procs -w 250 -c 400 -s RSZDT
• Save and click on apply

The command is now present in Naemon configuration. We can now associate it to a service.

check_local_users

We will add a “command / plugin ” check_local_users that will be used by Current users service we will create for our “host” .

• Config Tool Menu / Object Configuration / Commands
• Enter the name of the command check_local_users
• Enter the following command line $USER1$/check_users -w 20 -c 50
• Save and click on apply

The command is now present in Naemon configuration. We can now associate it to a service.

check_local_swap

We will add a “command / plugin ” check_local_swap that will be used by swap usage service we will create for our “host” .

• Config Tool Menu / Object Configuration / Commands
• Enter the name of the command check_local_swap
• Enter the following command line $USER1$/check_procs -w 20 -c 10
• Save and click on apply

The command is now present in Naemon configuration. We can now associate it to a service.

Add a service¶

We will add a service “system start” to find out how long the system is started, to oversee our “host ”.

System Start

We will go through the Naemon Setup menu Config Tool > Object settings > Services.

• Completing the “system start” Service Description
• Enter the host name S34XXXXXXX
• Choose Systeme_Start service model
• Add a contact group Supervisors
• Save and click apply

The service is now present in Naemon configuration.

CPU Use To know the CPU load

We will go through the Naemon Setup menu Config Tool > Object settings > Services.

• Completing the “cpu_use” Service Description
• Enter the host name S34XXXXXXX
• Choose Win-Cpu_Use service model
• Add a contact group Supervisors
• Save and click apply

The service is now present in Naemon configuration.

CURRENT Load To know the local load

We will go through the Naemon Setup menu Config Tool > Object settings > Services.

• Completing the “local_load” Service Description
• Enter the host name S34XXXXXXX
• Choose generic-service service model
• Add a contact group Supervisors
• Save and click apply

The service is now present in Naemon configuration.

CURRENT Users To know the numbers of users connected

We will go through the Naemon Setup menu Config Tool > Object settings > Services.

• Completing the “Current_Users” Service Description
• Enter the host name S34XXXXXXX
• Choose generic-service service model
• Add a contact group Supervisors
• Save and click apply

The service is now present in Naemon configuration.

Network status¶

Each monitored server consists of several services ( DHCP - WINS - SQL - TINA etc ...). Each monitored service uses a command. To check a service on the server, take control of the server and start a NET START command line or open the Services management method

To monitor the McAfee status services , we create a template TMP-McAfee_Services that each host will be associated to McAfee_Service Setting the Service Template : TMP-McAfee_Services

• Name: TMP-McAfee_Services
• Service Description : McAfee_Services
• Service Model used : generic Service
• Command verification : check_nt_services
• Arguments: ‘McAfee Framework Service!McShield McAfee!McAfee Task Manager!McAfee Validation Trust Protection Service’

McAfee_Service Definition

This service uses the command check_nt_services

• Command name : check_nt_services
• Command line: $USER1$/check_nt -H $HOSTADDRESS$ -v SERVICESTATE -s NsclientPassword -p 12489 -d SHOWALL -l $ARG1$,$ARG2$,$ARG3$,$ARG4$

Macro $ARG1$ , $ARG2$ , $ARG3$ ... match the arguments placed in the command. eg: “McAfee Framework Service!McShield McAfee!McAfee Task Manager!McAfee Validation Trust Protection Service’

Service : traffic ( naemon ) To know the traffic up and down from the NIC

• In the Config Tool / Services menu.
• Completing the description (eg traffic )
• Choose a service model (eg generice-Service )
• Select the check command : check_traffic
• Arguments : eth0!80!90!1
• Save and click on apply

The service is now present in Naemon configuration, we need to export it to apply config changes

Export Naemon Configuration Files Menu Config Tool/Object settings and then click Apply to save your change to disk, check your configuration changes, reload your monitoring core

Add a host¶

We will add a Windows server-based host in our Naemon configuration. For editing , go through :

1. Naemon Setup menu Config Tool ==> Object settings ==> Hosts.
2. Create a new host.

3. Make changes and click on Apply.

• Host name ( “host name”) : S34XXXXXXX
• Host Description ( “Alias” ) : Web Server
• IP address / DNS : 10.xx.xxx.xxx
• Add a template (template) associated with this host . A Template is the centralization of characteristics common to a machine.
• Then select the template : Servers-Win2k3
• Fill the Control Period : 24x7
• Add a contact group : Supervisors
• Save and click on apply

At this point, the host www is in the Naemon configuration

We will now export the new configuration changes to Naemon by clicking on Apply. View diff of changed files compares files

• Save changes to disk dumps the configuration .
• Check your configuration checks changes if there is no error
• Reload your monitoring core recover Naemon .

access , authentication and authorization management¶

Create a host¶

• Click on the Config Tool menu/Object Configuration/Contact
• Click Create a new Contact

Fill the fields according to your criteria (full name , Alias ​​/ Login , generic contact, Email, Allow can_submit _commands )

User Configuration¶

• Click on the Setup menu Tool/User Configuration
• Select the account in the username field
• Create a password and confirm, then click “SAVE”

Editing the cgi.cfg file

By default, a contact will be entitled to access objects which it is associated , make change according to your needs :

• show_context_help=0
• use_authentication=1
• use_ssl_authentication=0
• default_user_name=nagiosadmin
• authorized_for_system_information=nagiosadmin,hotline,
• authorized_contactgroup_for_system_information=
• authorized_for_configuration_information=nagiosadmin
• authorized_contactgroup_for_configuration_information=
• authorized_for_system_commands=nagiosadmin
• authorized_contactgroup_for_system_commands=
• authorized_for_all_services=nagiosadmin,hotline
• authorized_contactgroup_for_all_services=
• authorized_for_all_hosts=nagiosadmin,hotline
• authorized_contactgroup_for_all_hosts=
• authorized_for_all_service_commands=nagiosadmin
• authorized_contactgroup_for_all_service_commands=
• authorized_for_all_host_commands=nagiosadmin
• authorized_contactgroup_for_all_host_commands=
• authorized_for_read_only=
• authorized_contactgroup_for_read_only=
• refresh_rate=90
• escape_html_tags=1
• action_url_target=_blank
• notes_url_target=_blank
• lock_author_names=1
• host_unreachable_sound=../media/critical.wav
• host_down_sound=../media/critical.wav
• service_critical_sound=../media/critical.wav
• service_warning_sound=../media/warning.wav
• service_unknown_sound=../media/unknown.wav

Classification availability¶

The classification of systems in terms of availability commonly leads to 7 classes, not taking into account class ( system available 90 % of the time , and therefore unavailable more than one month a year ) to the ultra class (available 99.99999 % of the time and therefore unavailable only three seconds per year) : these classes are the number 9 in the percentage of time that the class systems are available

Introduction¶

A server can fail, and so does the network. That’s why you can (should) define multiple processes as well as spares in the Naemonbox architecture. Monitoring complex environments has never been easier. Activate the built-in cluster feature and you can begin configuring your high availability and distributed monitoring setup.

High availability clusters¶

In Naemonbox, clustered instances assign an ‘active zone master’. This master writes to the Mysql database and manages configurations, notifications and check distribution for all nodes. Should the active zone master fail, another instance is automatically assigned to this role. Furthermore, each instance carries a unique ID to prevent conflicting database entries and split-brain behaviour. With continuous synchronisation of program states as well as check results, this design gives Naemonbox the edge over active-passive clusters using Pacemaker in Nagios. It also makes fail-safe monitoring much easier to scale in Naemonbox

Distributed monitoring¶

Where operations are dispersed across multiple sites, Naemonbox enables distributed monitoring too. Thanks to Naemonbox cluster zoning, satellite instances can be demarcated into their own secure zones to report to a central NOC. Satellites can be simple checkers or fully equipped with local MySQL database, user interface and other extensions too. Replication can be isolated to occur only between the master zone and each individual satellite, keeping satellite sites blind to one another. If a satellite goes rogue, check results are saved for retroactive replication access once the connection is restored.

Distributed, high availability monitoring¶

Combine high availability clusters with a distributed setup, and you have a best practice scenario for large and complex environments. Satellite nodes can be scaled to form high availability clusters and cordoned off into secure zones. Load balancing and replication within them can be managed by an active zone instance to reflect different levels of hierarchy. An instance in the satellite zone can be a simple checker, sending results to the active satellite node for replication and display on a local interface. In turn the active satellite node can relay results to the NOC master zone for global reports.

Important

TODO Put all of the Naemonbox supervisory parameters with formulas and examples.

Diagrams¶

FAQ Summary¶

Naemonbox users, developers, administrators possess a body of knowledge that usually provides a quick path to problem resolutions. The Frequently Asked Questions questions are compiled from user questions and issues developers may run into.

Have you consulted at all the resources available for users and developers.

__Before posting a question to the forum:__

• Read the through the Getting Started tutorials
• Search the documentation wiki
• Use this FAQ section.
• Bonus: Update this FAQ if you found the answer and think it would benefit someone else

Doing this will improve the quality of the answers and your own expertise.