Monitoring Zimbra with Nagios - Revision history

Sstrutt: /* Clam AV Service */ Updated for Zimbra v8

2012-10-05T14:48:52Z

Clam AV Service: Updated for Zimbra v8

← Older revision		Revision as of 14:48, 5 October 2012
Line 100:		Line 100:
	Checks that the Clam Anti Virus service is running. Requires [[Nagios#NRPE\|NRPE]] to be installed and running 1st.		Checks that the Clam Anti Virus service is running. Requires [[Nagios#NRPE\|NRPE]] to be installed and running 1st.

	On the Zimbra server, add the following to <code>/etc/nagios/nrpe.cfg</code>		On the Zimbra server, '''if you're running Zimbra v7 or earlier''', add the following to <code>/etc/nagios/nrpe.cfg</code>
	command[check_clamd]=/usr/lib/nagios/plugins/check_clamd -H localhost		command[check_clamd]=/usr/lib/nagios/plugins/check_clamd -H localhost

			On the Zimbra server, '''if you're running Zimbra v8''', add the following to <code>/etc/nagios/nrpe.cfg</code>
			command[check_clamd]=/usr/lib/nagios/plugins/check_clamd /opt/zimbra/data/clamav/clamav.sock

	Add a new service (on Nagios server)...		Add a new service (on Nagios server)...

Sstrutt: /* LMTP */ Corrected link

2012-10-02T07:53:10Z

LMTP: Corrected link

← Older revision		Revision as of 07:53, 2 October 2012
Line 141:		Line 141:

	=== LMTP ===		=== LMTP ===
	Checks that [[~~Acronymns~~#L\|LMTP]] (used internal routing of emails through Clam, to mailboxes, etc) is functioning. Requires [[Nagios#NRPE\|NRPE]] to be installed and running 1st		Checks that [[Acronyms#L\|LMTP]] (used internal routing of emails through Clam, to mailboxes, etc) is functioning. Requires [[Nagios#NRPE\|NRPE]] to be installed and running 1st

	On the Zimbra server, add the following to <code>/etc/nagios/nrpe.cfg</code>. Note that you need to update the FQDN for your server in the expected return field.		On the Zimbra server, add the following to <code>/etc/nagios/nrpe.cfg</code>. Note that you need to update the FQDN for your server in the expected return field.
Line 153:		Line 153:
	check_command check_nrpe!check_zimbra_lmtp		check_command check_nrpe!check_zimbra_lmtp
	}		}


	=== Spellcheck ===		=== Spellcheck ===

Sstrutt: Moved TOC

2012-09-20T13:20:00Z

Moved TOC

← Older revision		Revision as of 13:20, 20 September 2012
Line 1:		Line 1:
	This page covers Zimbra application specific monitoring checks, OS specific checks (eg low disk space, or high CPU) are not included. The majority of it was gleamed from this forum thread - http://www.zimbra.com/forums/administrators/20029-zimbra-monitoring-nagios.html		This page covers Zimbra application specific monitoring checks, OS specific checks (eg low disk space, or high CPU) are not included. The majority of it was gleamed from this forum thread - http://www.zimbra.com/forums/administrators/20029-zimbra-monitoring-nagios.html

			__TOC__

	All my Zimbra specific checks are applied to specific hosts via a <code>zimbra-servers</code> hostgroup. Create a group in your <code>hostgroups_nagios2.cfg</code> file to contain you Zimbra hosts, for example...		All my Zimbra specific checks are applied to specific hosts via a <code>zimbra-servers</code> hostgroup. Create a group in your <code>hostgroups_nagios2.cfg</code> file to contain you Zimbra hosts, for example...

Sstrutt: Added Spellcheck and DNS checks

2012-09-20T13:18:37Z

Added Spellcheck and DNS checks

← Older revision		Revision as of 13:18, 20 September 2012
Line 14:		Line 14:
	** Restarts the Nagios service		** Restarts the Nagios service

	== ~~Basic~~ Service Checks ==		== Core Service Checks ==
	Note that not all checks will be appropriate for your installation. For example, if you only allow user access over secure links then the [[#IMAP\|IMAP]] and [[#HTTP / Web Client\|HTTP / Web Client]] checks will not apply.		Note that not all checks will be appropriate for your installation. For example, if you only allow user access over secure links then the [[#IMAP\|IMAP]] and [[#HTTP / Web Client\|HTTP / Web Client]] checks will not apply.

Line 96:		Line 96:
	== System Checks ==		== System Checks ==
	=== Clam AV Service ===		=== Clam AV Service ===
	Checks that the Clam Anti Virus service is running. Requires [[Nagios#NRPE\|NRPE]] to installed and running 1st.		Checks that the Clam Anti Virus service is running. Requires [[Nagios#NRPE\|NRPE]] to be installed and running 1st.

	On the Zimbra server, add the following to <code>/etc/nagios/nrpe.cfg</code>		On the Zimbra server, add the following to <code>/etc/nagios/nrpe.cfg</code>
Line 110:		Line 110:

	=== Clam AV Updates ===		=== Clam AV Updates ===
	Requires both [[Nagios#NRPE\|NRPE]] to installed and running 1st, and also a 3rd party script to perform the check.		Requires both [[Nagios#NRPE\|NRPE]] to be installed and running 1st, and also a 3rd party script to perform the check.

	On the Zimbra server		On the Zimbra server
Line 139:		Line 139:

	=== LMTP ===		=== LMTP ===
	Requires [[Nagios#NRPE\|NRPE]] to installed and running 1st		Checks that [[Acronymns#L\|LMTP]] (used internal routing of emails through Clam, to mailboxes, etc) is functioning. Requires [[Nagios#NRPE\|NRPE]] to be installed and running 1st

	On the Zimbra server, add the following to <code>/etc/nagios/nrpe.cfg</code>. Note that you need to update the FQDN for your server in the expected return field.		On the Zimbra server, add the following to <code>/etc/nagios/nrpe.cfg</code>. Note that you need to update the FQDN for your server in the expected return field.
Line 152:		Line 152:
	}		}


			=== Spellcheck ===
			Checks that the spelling checker service is available. Requires [[Nagios#NRPE\|NRPE]] to installed and running 1st.

			On the Zimbra server, add the following to <code>/etc/nagios/nrpe.cfg</code>
			command[check_zimbra_spell]=/usr/lib/nagios/plugins/check_http -H localhost -p 7780

			Add a new service (on Nagios server)...
			define service {
			use zimbra-svc-template
			hostgroup_name zimbra-servers
			service_description Zimbra Spelling
			check_command check_nrpe!check_spell
			}


			== Dependency Checks ==
			=== DNS ===
			Checks that your Zimbra server is able to make DNS lookups. Requires [[Nagios#NRPE\|NRPE]] to installed and running 1st.

			Note that if you need to consider which DNS server(s) it is most appropriate to check against. For example, if you run a local Bind instance on your Zimbra server, you may want to test both that, and the DNS server which it forwards requests to.

			On the Zimbra server, add the following to <code>/etc/nagios/nrpe.cfg</code>
			command[check_dns]=/usr/lib/nagios/plugins/check_dns -H google.com

			If you need to resolution again a DNS server different to the default (as specified in <code>/etc/resolv.conf</code> use the <code>-s</code> option, for example...
			command[check_dns]=/usr/lib/nagios/plugins/check_dns -H google.com -s 8.8.8.8

			Add a new service (on Nagios server)...
			define service {
			use zimbra-svc-template
			hostgroup_name zimbra-servers
			service_description DNS Resolution
			check_command check_nrpe!check_dns
			}

	[[Category:Zimbra]]		[[Category:Zimbra]]
	[[Category:Nagios]]		[[Category:Nagios]]
	[[Category:Monitoring]]		[[Category:Monitoring]]

Sstrutt: Initial creation

2012-09-18T09:03:02Z

Initial creation

New page

This page covers Zimbra application specific monitoring checks, OS specific checks (eg low disk space, or high CPU) are not included. The majority of it was gleamed from this forum thread - http://www.zimbra.com/forums/administrators/20029-zimbra-monitoring-nagios.html

All my Zimbra specific checks are applied to specific hosts via a <code>zimbra-servers</code> hostgroup. Create a group in your <code>hostgroups_nagios2.cfg</code> file to contain you Zimbra hosts, for example...
define hostgroup {
hostgroup_name zimbra-servers
alias Zimbra servers
members mail.domain.com,mail2.domain.com
}

To apply any changes to Nagios configuration, run the following commands
* <code> nagios3 -v /etc/nagios3/nagios.cfg </code>
** Performs basic validation of the config
* <code> service nagios3 restart </code>
** Restarts the Nagios service

== Basic Service Checks ==
Note that not all checks will be appropriate for your installation. For example, if you only allow user access over secure links then the [[#IMAP|IMAP]] and [[#HTTP / Web Client|HTTP / Web Client]] checks will not apply.

=== SMTP ===
Checks that your server can receive incoming email.
define service{
use zimbra-svc-template ; Inherit default values from a template
hostgroup_name zimbra-servers
service_description SMTP
check_command check_smtp
}

=== Postfix ===
Checks that your server doesn't have queued outgoing email. Requires [[Nagios#NRPE|NRPE]] to installed and running 1st.

On the Zimbra server...
# Update the path to postfix used by NRPE, in <code>/usr/lib/nagios/plugins/utils.pm</code>
#* EG <code>$PATH_TO_MAILQ = "/opt/zimbra/postfix/sbin/mailq";</code>
# Add to NRPE config <code>/etc/nagios/nrpe.cfg</code>, update the warning and critical thresholds to suit your environment
#* <code>command[check_zimbra_mailq]=/usr/lib/nagios/plugins/check_mailq -w 10 -c 20 -M postfix</code>
# Restart NRPE to apply config change
#* <code>service nagios-nrpe-server restart</code>

Add a new service (on Nagios server)...
define service {
use zimbra-svc-template
hostgroup_name zimbra-servers
service_description Postfix MailQ
check_command check_nrpe!check_zimbra_mailq
}

=== IMAP ===
Checks that your server can be accessed by [[Acronyms#I|IMAP]] clients (eg mobile device, desktop email client)
define service{
use zimbra-svc-template ; Inherit default values from a template
hostgroup_name zimbra-servers
service_description IMAP
check_command check_imap
}

=== IMAP over SSL ===
Checks that your server can be accessed by IMAP clients (eg mobile device, desktop email client) over [[Acronyms#S|SSL]].
define command{
command_name check_imaps
command_line /usr/lib/nagios/plugins/check_imap -H $HOSTADDRESS$ -p 993 -S
}

define service{
use zimbra-svc-template ; Inherit default values from a template
hostgroup_name zimbra-servers
service_description IMAP SSL
check_command check_imaps
}

=== HTTP / Web Client ===
Checks that the web-mail interface is accessible to users.

You'll probably already have a basic HTTP service check defined, in which case just add your Zimbra servers to the <code>http-servers</code> hostgroup in <code>hostgroups_nagios2.cfg</code>

=== HTTPS / Web Client ===
Checks that the web-mail interface is accessible to users.

You may already have a basic HTTP service check defined, in which case just add your Zimbra servers to the <code>https-servers</code> hostgroup in <code>hostgroups_nagios2.cfg</code>

If not create a new service...
define service {
hostgroup_name https-servers
service_description HTTPS
check_command check_https
use generic-service
notification_interval 0 ; set > 0 if you want to be renotified
}

Then create a <code>http-servers</code> hostgroup in <code>hostgroups_nagios2.cfg</code>, for example...
define hostgroup {
hostgroup_name https-servers
alias HTTPS servers
members mail.domain.com,mail2.domain.com
}

== System Checks ==
=== Clam AV Service ===
Checks that the Clam Anti Virus service is running. Requires [[Nagios#NRPE|NRPE]] to installed and running 1st.

On the Zimbra server, add the following to <code>/etc/nagios/nrpe.cfg</code>
command[check_clamd]=/usr/lib/nagios/plugins/check_clamd -H localhost

Add a new service (on Nagios server)...
define service {
use zimbra-svc-template
hostgroup_name zimbra-servers
service_description ClamAV Svc
check_command check_nrpe!check_clamd
}

=== Clam AV Updates ===
Requires both [[Nagios#NRPE|NRPE]] to installed and running 1st, and also a 3rd party script to perform the check.

On the Zimbra server
# Install Perl Net::DNS module
#* <code> apt-get install libnet-dns-perl </code>
# Download the script to <code>/usr/lib/nagios/plugins/</code> and make executable
#* <code> wget https://www.monitoringexchange.org/attachment/download/Check-Plugins/Software/Virusscan/ClamAV-check-plugin/check_clamav </code>
#* <code> chmod +x check_clamav </code>
# Edit the following script lines to suit the paths on your server
#* Line 31: <code> use lib "/usr/lib/nagios/plugins"; </code>
#* Line 39: <code> my $clamd_cmd = "/opt/zimbra/clamav/sbin/clamd"; </code>
#* Line 166: <code> chomp(my $clamd_ver = `$clamd_cmd -V -c /opt/zimbra/conf/clamd.conf`);</code>
# Edit <code> /etc/sudoers </code> so that it can be run successfully by nagios sudoed to zimbra
#* <code> nagios ALL=(zimbra) NOPASSWD: /usr/lib/nagios/plugins/check_clamav </code>
#* If you need to add write access, use <code> chmod o+w /etc/sudoers </code>, then revert back with <code> chmod 0440 /etc/sudoers </code>
# Add to NRPE config <code>/etc/nagios/nrpe.cfg</code>
#* <code>command[check_zimbra_clam_ud]=sudo -u zimbra /usr/lib/nagios/plugins/check_clamav -w 2 -c 5</code>
# Restart NRPE to apply config change
#* <code>service nagios-nrpe-server restart</code>

Add a new service (on Nagios server)...
define service {
use zimbra-svc-template
hostgroup_name zimbra-servers
service_description ClamAV Updates
check_command check_nrpe!check_zimbra_clam_ud
}

=== LMTP ===
Requires [[Nagios#NRPE|NRPE]] to installed and running 1st

On the Zimbra server, add the following to <code>/etc/nagios/nrpe.cfg</code>. Note that you need to update the FQDN for your server in the expected return field.
command[check_zimbra_lmtp]=/usr/lib/nagios/plugins/check_smtp -H localhost -p 7025 -e '220 mail.domain.com Zimbra LMTP server ready'

Add a new service (on Nagios server)...
define service {
use zimbra-svc-template
hostgroup_name zimbra-servers
service_description LMTP
check_command check_nrpe!check_zimbra_lmtp
}

[[Category:Zimbra]]
[[Category:Nagios]]
[[Category:Monitoring]]