Numbered Headings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
OverviewPrivateServer appliances can be monitored remotely. Currently, a set of Nagios commands is provided to check the reachability, health and resource usage of PrivateServer appliances. Nagios commands for PrivateServer appliancesRemotely monitoring PrivateServer appliances is best done with the PrivateServer-specific Nagios commands. This section describes how to add these commands to your monitoring host, how to enable them on the appliance and the meaning of their outputs.Configuring the monitoring host for PrivateServer monitoringOn the monitoring host, the configuration of Nagios has to be modified. This is a simple process in a few steps:
Defining PrivateServer-specific commandsDownload
Include privateserver.commands.cfg from nagios.cfg with a line like the following: # replace with the full path to your privateserver.commands.cfg Listing PrivateServer appliances on your networkDownload
Configuration files created from the template require the following definitions to be already present in your Nagios configuration:
All of the above definitions are present in the default Nagios configuration, but they may be absent in your installation of Nagios Verifying the Nagios configurationRun the following command: nagios -v /etc/nagios/nagios.cfg Review the output, and correct any errors reported by Nagios. Nagios only reports the first error it finds, so you will need to verify the configuration after every change, until it reports no errors. Restarting Nagios
Run the following command: /etc/init.d/nagios restart Nagios will restart with the new configuration. The changes should be immediately visible in the web interface. Configuring the appliance for Nagios monitoringFor remote monitoring to work, the appliance must be reachable from the monitoring host. Additionally, most commands need a specific appliance service to be assigned to the network interface used for management (for each command, it will be documented whether this is the case, and which service affects it). The service assignment UI can be found in the web console, under Server Configuration → Applications. Reachability checksThe commands in this category check for the reachability of the appliance's administration interfaces.
|
Info |
---|
This command sends 5 ping requests. |
Warning |
---|
This command can fail with 100% packet loss if ICMP pings are blocked between the monitoring host and the appliance. |
Status
Status | Meaning |
---|---|
The appliance is alive | |
Average RTT is larger than 3 seconds, or packet loss is 80% or more | |
Average RTT is larger than 5 seconds, or packet loss is 100% |
Output
A typical, healthy output is similar to:
PING OK - Packet loss = 0%, RTA = 33.22 ms
Service health checks
The commands in this category check whether the appliance's services, internal or external, are up and working correctly.
check_privateserver_sip
Performs a test call on the PrivateServer appliance to ensure that the SIP service can handle calls correctly. Requires the nrpe
service to be enabled on the management network interface.
Status
Status | Meaning |
---|---|
The SIP service is up and running normally, and can currently handle calls correctly. | |
Both participants to the test call completed the call succesfully, but the call was hung up immediately. This can mean the SIP service is responding too slowly, or that the appliance is low on resources. See the output for more information. | |
One or both participants to the test call encountered an error. See the output for more information. |
Output
If the status is CRITICAL, the output contains the exit code of both participants to the test call. At least one will be non-zero, indicating an error. ...
check_privateserver_web_console
Checks that the web-based administration interface of the PrivateServer appliance is reachable and running correctly. Requires the http
service to be enabled on the management network interface.
Status
Status | Meaning |
---|---|
The web console is reachable and appears to be running correctly. | |
| |
|
check_privateserver_ssh_console
Checks that the PrivateServer appliance is reachable through SSH. Requires the ssh
service to be enabled on the management network interface.
Status
Status | Meaning |
---|---|
The SSH server is reachable and appears to be running correctly. | |
Should never happen. | |
Fatal error connecting to the SSH server, or malformed response from the SSH server. |
check_privateserver_db_status
Checks that the database service on the PrivateServer appliance is running correctly. Requires the nrpe
service to be enabled on the management network interface.
Status
Status | Meaning |
---|---|
The database is up and running correctly. | |
Non-fatal error connecting to the server, or no server status available. | |
Fatal error connecting to the server, or error querying server status. |
check_privateserver_db_data
Checks that the database service on the PrivateServer appliance is responding to queries. Requires the nrpe
service to be enabled on the management network interface.
Status
Status | Meaning |
---|---|
The database is up and running correctly and responding to simple queries. | |
Non-fatal error connecting to the server. | |
Fatal error connecting to the server, or error executing the query. |
Resource usage checks
The commands in this category monitor the usage of the appliance's finite resources (CPU, memory, etc.).
check_privateserver_cpu
Checks the CPU usage on the PrivateServer appliance. Requires the nrpe
service to be enabled on the management network interface.
Status
Status | Meaning |
---|---|
CPU usage normal. | |
CPU usage between 90% and 95%. | |
CPU usage 95% or above. |
check_privateserver_memory
Checks the user and swap memory usage on the PrivateServer appliance. User memory is calculated as total memory usage minus buffers and cache. Requires the nrpe
service to be enabled on the management network interface.
Status
Status | Meaning |
---|---|
Memory usage normal. | |
User memory or swap usage between 90% and 95%. | |
User memory or swap usage above 95%. |
check_privateserver_disk
Checks the disk space usage on the PrivateServer appliance. Requires the nrpe
service to be enabled on the management network interface.
Status
Status | Meaning |
---|---|
Free disk space normal. | |
Free disk space is 5% or less on any filesystem. | |
Free disk space is 0% on any filesystem. |
check_privateserver_bandwidth
Checks the network bandwidth usage on the PrivateServer appliance. Requires the nrpe
service to be enabled on the management network interface.
Status
Status | Meaning |
---|---|
Network bandwidth usage normal. | |
Network bandwidth usage between 20 Mb/s and 100 Mb/s on any network interface. | |
Network bandwidth usage above 100 Mb/s on any network interface. |
Appendix: Attachments
Attachments | ||||||
---|---|---|---|---|---|---|
|
...