WMLUG July Nagios, PNP4Nagios, and NConf by Patrick TenHoopen

Transcription

1 WMLUG July 2015 Nagios, PNP4Nagios, and NConf by Patrick TenHoopen

2 What is Nagios? Nagios is an IT infrastructure monitoring and alerting tool. The free Nagios DIY Core provides the central monitoring engine and the basic web interface. Current Version: 4.08 ( ) Download:

3 Nagios Demo Demo

4 Installation Prerequisites gcc apache2 perl php rrdtool php5-gd php5-zlib php5-socket

5 Installation Follow Quick-Start Guides ocs/nagioscore/4/en/quickstart.html After install, don't forget to configure the firewall on the Nagios server to allow http access if one is running.

6 Installation, cont. tar xf nagios tar.gz cd nagios /configure --with-command-group=nagcmd make all make install make install-init make install-config make install-commandmode make install-webconf htpasswd2 -c /usr/local/nagios/etc/htpasswd.users nagiosadmin

7 Nagios Plugins Download: tar xf nagios-plugins tar.gz cd nagios-plugins /configure --with-nagios-user=nagios --with-nagios-group=nagios make make install

8 Configuration Nagios comes with a default configuration for monitoring the localhost that Nagios is installed on (localhost.cfg) plus some other examples. The configuration files are stored at /usr/local/nagios/etc/objects/ and are plain text files formatted in a proprietary format. Detailed description of configuration files and options: /en/objectdefinitions.html

9 Default Configuration Files commands.cfg Check commands that are used in service definitions contacts.cfg - Who to contact if an alert is generated hosts.cfg - Hosts to monitor localhost.cfg - Basic config for Nagios host printer.cfg Sample config for printers services.cfg - Things on hosts to monitor switch.cfg - Sample config for switches templates.cfg - Definition templates used by hosts, services, etc. timeperiods.cfg Notification times/hours of alerting windows.cfg - Sample config for a Windows machine

10 Configuration File Organization You don't need to separate the definitions into separate files, and you can have just one large configuration file. The cfg_file line(s) in the /usr/local/nagios/etc/nagios.cfg file controls what files are used. Note: If you want to import existing Nagios conf files into NConf (discussed later), it will work better if they are separated out by function/type.

11 Templates Templates are used by configuration definitions to provide default values for settings. It keeps the actual definition smaller and easy to update. If you modify a template, all definitions that use it get updated.

12 Generic Linux Host Template # Linux host definition template - This is NOT a real host, just a template! define host{ name linux-server ; The name of this host template use generic-host ; Inherits other values from generic-host template check_period 24x7 ; By default, Linux hosts are checked round the clock check_interval 5 ; Actively check the host every 5 minutes retry_interval 1 ; Schedule host check retries at 1 minute intervals max_check_attempts 10 ; Check each Linux host 10 times (max) check_command check-host-alive ; Default command to check Linux hosts notification_period workhours ; Only notify during the day ; Note that the notification_period variable is being ; overridden from the value that is inherited from the ; generic-host template! notification_interval 120 ; Resend notifications every 2 hours notification_options d,u,r ; Only send notifications for specific host states contact_groups admins ; Notifications get sent to the admins by default register 0 ; DONT REGISTER THIS DEFINITION }

13 Generic Service Template # Generic service definition template - This is NOT a real service, just a template! define service{ name generic-service ; The 'name' of this service template active_checks_enabled 1 ; Active service checks are enabled passive_checks_enabled 1 ; Passive service checks are enabled/accepted parallelize_check 1 ; Active service checks should be parallelized ; (disabling this can lead to major performance problems) obsess_over_service 1 ; We should obsess over this service (if necessary) check_freshness 0 ; Default is to NOT check service 'freshness' notifications_enabled 1 ; Service notifications are enabled event_handler_enabled 1 ; Service event handler is enabled flap_detection_enabled 1 ; Flap detection is enabled process_perf_data 1 ; Process performance data retain_status_information 1 ; Retain status information across program restarts retain_nonstatus_information 1 ; Retain non-status information across program restarts is_volatile 0 ; The service is not volatile check_period 24x7 ; The service can be checked at any time of the day max_check_attempts 3 ; Re-check the service up to 3 times in order to determine its final (hard) state normal_check_interval 10 ; Check the service every 10 minutes under normal conditions retry_check_interval 2 ; Re-check the service every two minutes until a hard state can be determined contact_groups admins ; Notifications get sent out to everyone in the 'admins' group notification_options w,u,c,r ; Send notifications about warning, unknown, critical, and recovery events notification_interval 60 ; Re-notify about service problems every hour notification_period 24x7 ; Notifications can be sent out at any time register 0 ; DONT REGISTER THIS DEFINITION - ITS NOT A REAL SERVICE, JUST A TEMPLATE! }

14 Commands Nagios comes with several commands for checking services and more are installed with the Nagios plugins. They are located in the /usr/local/nagios/lib/ directory. Some examples: check_disk, check_http, check_log, check_nt, check_ping

15 Community Check Commands You can download command definitions created by the Nagios community by perusing the plugin exchange at:

16 Custom Commands You can also create custom check commands using scripts or custom programs. The script/program just needs to return one of the exit statuses that Nagios expects: UNKNOWN = 3, CRITICAL = 2, WARNING = 1, OK = 0

17 Example Check Definition The $USER1$, $HOSTADDRESS$, $ARG1$, and $ARG2$ are Nagios macros. They are substituted for the values passed into the check when it is called from the service definition. -W is warning threshold. -C is critical threshold. # 'check_ping' command definition define command{ command_name check_ping command_line $USER1$/check_ping -H $HOSTADDRESS$ -w $ARG1$ -c $ARG2$ -p 5 }

18 Example Host Definition define host{ use linux-server ; Name of host templates to use ; This host definition will ; inherit all variables that are ; defined in (or inherited by) ; the linux-server host template ; definition. host_name localhost alias localhost address }

19 Example Service Note that the command parameters are delimited by an "!". The parameters are used in the check definition ($ARG1$, $ARG2$, etc). # Define a service to "ping" the local machine define service{ use host_name service_description check_command } local-service ; Name of service ; template to use localhost PING check_ping!100.0,20%!500.0,60%

20 Host Groups By using host groups, you can easily set up checks for a set of hosts with one service definition. You can create a new config file named hostgroups.cfg. define hostgroup{ hostgroup_name linux-servers ; Name of the hostgroup alias Linux Servers ; Long name of the group members localhost,linuxbox1,linuxbox2 ; Comma separated list of ; hosts that belong to this group } define service{ use local-service ; Name of service template to use hostgroup_name linux-servers service_description PING-LINUX-HOSTS check_command check_ping!100.0,20%!500.0,60% }

21 Parent/Child Relationships By defining what other hosts a host depends on, Nagios can distinguish between down and unreachable states for the host. For example if Nagios is monitoring a host connected to another switch and the switch is down, preventing Nagios from pinging it, Nagios only alerts that the switch is offline and doesn't alert that the other host is down too.

22 Parents Setting When defining a host, use the "parents" setting to establish the parent/child relationship. define host{ host_name Nagios } ; Nagios host has no parent define host{ host_name Switch1 parents Nagios } define host{ host_name OtherHost parents Switch1 }

23 Parent/Child Relationship Picture Pictorial representation: ocs/nagioscore/4/en/networkreachability.html

24 NSClient++ With the NSClient++ add-on, you can easily set up checks on Windows servers. itoring-agents/nsclient%2b%2b/details

25 NRPE The NRPE (Nagios Remote Plugin Executor) addon runs checks on a remote Linux host. It also acts as an NRPE listener on the Windows server. itoring-agents/nrpe--2d-nagios-remote-plugin-ex ecutor/details

26 File Count Example Using NSClient++ and a community-created command (Check Filecount), you can monitor the number of files in a directory on a Windows computer.

27 File Count Example Service Definition From services.cfg: # Service definition define service { use generic-service host_name WINSERVER service_description Temp File Count check_command check_temp_files }

28 File Count Example Command Definition From commands.cfg: # 'check_temp_files' command definition define command{ command_name command_line check_temp_files $USER1$/check_nrpe -H $HOSTADDRESS$ -c check_temp_files }

29 File Count Example NSClient++ Definition From the NSClient++ nsclient.ini file on Windows server being monitored: [/settings/external scripts/scripts] check_temp_files=c:\windows\system32\cscript.exe //NoLogo //T:30 C:\nrpe\directory_file_count\directory_file_count.wsf c: \\windows\\temp

30 Pre-Flight Check Configuration changes don't go into affect until Nagios is restarted. You should run a Nagios pre-flight check after making configuration changes and before restarting Nagios to make sure it doesn't find anything wrong with the configuration. /usr/local/nagios/bin/nagios -v /usr/local/nagios/etc/nagios.cfg

31 Starting Nagios You'll need to restart webserver and start Nagios: systemctl restart apache2 systemctl start nagios

32 Logging Into Nagios Goto Nagios web page and log in:

33 PNP4Nagios PNP4Nagios is an add-on to Nagios which analyzes and graphs performance data provided by Nagios plugins and stores them in Round Robin Database (RRD) files.

34 Prerequisites Perl 5.x or higher, without additional modules RRDtool 1.x or higher, better with 1.2 Nagios 2.x or higher

35 Installation tar xf pnp4nagios tar.gz cd pnp4nagios /configure make all make fullinstall

36 Configuration Choose Mode The Bulk-Mode + NCPD mode seems to be the only mode that works with Nagios core 4. Also, this is the best way of processing because Nagios will not be blocked. The NPCD daemon (Nagios Performance C Daemon) will monitor the directory for new files and process them.

37 Configuration - Enable Processing Enable processing of performance data in /usr/local/nagios/etc/nagios.cfg process_performance_data=1 # service performance data service_perfdata_file=/usr/local/pnp4nagios/var/service-perfdata service_perfdata_file_template=datatype::serviceperfdata\ttimet::$timet$\thostname::$hostname$\tservicedesc:: $SERVICEDESC$\tSERVICEPERFDATA::$SERVICEPERFDATA$\tSERVICECHECKCOMMAND::$SERVICECHECKCOMMAND$\tHOSTSTATE:: $HOSTSTATE$\tHOSTSTATETYPE::$HOSTSTATETYPE$\tSERVICESTATE::$SERVICESTATE$\tSERVICESTATETYPE::$SERVICESTATETYPE$ service_perfdata_file_mode=a service_perfdata_file_processing_interval=15 service_perfdata_file_processing_command=process-service-perfdata-file # host performance data host_perfdata_file=/usr/local/pnp4nagios/var/host-perfdata host_perfdata_file_template=datatype::hostperfdata\ttimet::$timet$\thostname::$hostname$\thostperfdata:: $HOSTPERFDATA$\tHOSTCHECKCOMMAND::$HOSTCHECKCOMMAND$\tHOSTSTATE::$HOSTSTATE$\tHOSTSTATETYPE::$HOSTSTATETYPE$ host_perfdata_file_mode=a host_perfdata_file_processing_interval=15 host_perfdata_file_processing_command=process-host-perfdata-file

38 Configuration Add Commands Add new commands to /usr/local/nagios/etc/objects/commands.cfg # 'process-host-perfdata' command definition define command{ command_name process-host-perfdata-file command_line /bin/mv /usr/local/pnp4nagios/var/host-perfdata /usr/local/pnp4nagios/var/spool/host-perfdata.$timet$ } # 'process-service-perfdata' command definition define command{ command_name process-service-perfdata-file command_line /bin/mv /usr/local/pnp4nagios/var/service-perfdata /usr/local/pnp4nagios/var/spool/service-perfdata.$timet$ }

39 Configuration - Templates Add new templates to /usr/local/nagios/etc/objects/templates.cfg define host { name host-pnp action_url /pnp4nagios/index.php/graph?host=$hostname$&srv=_host_ register 0 } define service { name srv-pnp action_url /pnp4nagios/index.php/graph?host=$hostname$&srv=$servicedesc$ register 0 }

40 Verify Configuration Download the verify_pnp_config Perl script from: Run it, specifying the mode, location of Nagios config file, and the pnp config file: perl verify_pnp_config --mode=bulk+npcd --config=/usr/local/nagios/etc/nagios.cfg --pnpcfg=/usr/local/pnp4nagios/etc

41 Starting PNP4Nagios Start PNP4Nagios as a daemon: /usr/local/pnp4nagios/bin/npcd -d -f /usr/local/pnp4nagios/etc/npcd.cfg You'll also need to restart webserver and Nagios: systemctl restart apache2 systemctl restart nagios

42 Using PNP4Nagios Click the graph icon next to hosts and services in the Nagios page to see the graphs of performance data.

43 PNP4Nagios Demo Demo

44 NConf NConf is a PHP-based web-tool for configuring Nagios. It has features like templates, service to hostgroup assignment, and dependencies.

45 Prerequisites PHP 5.x or higher php-mysql php-ldap (only if using LDAP auth) MySQL or higher (with InnoDB!) Perl 5.6 or higher perl-dbi perl-dbd-mysql

46 Installation - Prep Note your webserver document root, user and group: Apache document root: /srv/www/htdocs/ User: wwwrun Group: www

47 Installation Guide elp:documentation:start:installation

48 Installation - Extract Copy the tar file to the document root and expand it. tar xf nconf tgz Grant permissions to webserver user: chown wwwrun: chown wwwrun: chown wwwrun: chown wwwrun:

49 Installation Create Database Start the MySQL prompt then create the database: mysql -u root -p If the MySQL install is new, follow this to set password: html mysql> CREATE DATABASE NConf; mysql> GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, ALTER, DROP ON `NConf`.* TO IDENTIFIED BY 'nconfp'; mysql> quit

50 GUI Installation Method GUI (easy): 1. Enter MySQL information. 2. Enter NConf and Nagios paths. 3. Set up authentication (use defaults). 4. Remove INSTALL, INSTALL.php, UPDATE, and UPDATE.php from NConf directory.

51 Manual Installation Method 1. CD into the extracted NConf folder. 2. Create database structure: mysql -u nconf -D NConf -p < INSTALL/create_database.sql 3. Configure NConf. 1. Copy the contents of./config.orig to./config. 2. Edit./config/mysql.php, and set values for DBHOST, DBNAME, DBUSER, and DBPASS. 3. Edit./config/nconf.php, and set values for NCONFDIR and NAGIOS_BIN. 4. Remove INSTALL, INSTALL.php, UPDATE, and UPDATE.php from NConf directory.

52 NConf Nagios Configuration Check In order to enable NConf to check the Nagios configuration files, make sure your webserver user has access to your Nagios binary, or copy the binary to the '/srv/www/htdocs/nconf/bin/' folder and make the webserver user the owner.

53 Using NConf Open NConf page:

54 NConf Demo Demo