This is Cacti's Services monitoring plugin. Based on Webseer plugin. This plugin allows you to add service monitoring to Cacti. You simply add service check, allow service specific test (like certificate check, long duration check, ...) and you can add the expected response. Servcheck periodically run test and notify if a service check fails. The plugin records statistics about the connection and service response. Servcheck can send email notification or run script when the status changes.
This plugin, like many others, integrates with Cacti's Maintenance or 'maint' plugin so you can setup maintenance schedules so that known times when a service is going to be down can be configured so that escallation does not needlessly take place during maintenance periods.
Setvcheck try to run test once or more than once (you can configure it). If successful on the first attempt, no further tests will be performed. Main result is ok/error. A lot of information are returned with main result. After the test is completed, statistics are generated. Based on the statistics, email notifications can be sent:
- service state change
- search text in result change
- certificate expiration
- long duration of test
Retuned data are stored too.
Each tests return specific data: HTTP and HTTPS - returns webpage SMTP, SMTPS - connect to SMTP server and displays banner and EHLO/HELO or authentication result POP3, POP3S - try to server connection and eventually login and display first unread message IMAP, IMAPS - try to server connection and eventually login and display unread messages in inbox DNS, DOH - try to resolve A record and return answer LDAP and LDAPS - do searching in LDAP FTP, FTPS, SFTP - try to login and return directory listing TFTP - try to download specific file SCP - try to login and download specific file SMB, SMBS - try to login and download specific file MQTT - try to subscribe topic or wait for any message and print result SNMP - get or walk specified OID and return answer SSH_COMMAND - ssh connect, run command and return output
Servcheck has great debug output. If you have any problem, try to run your test: /path/to/php servcheck_process.php --id= --force --debug
Example_script.sh shows you how to use returned variables in own script.
Recommendation for tests with download - please download only small not binary files.
Default Libcurl build doesn't compile all services. You have to compile again for SMB, LDAP, ...
For POP3 and IMAP tests is better insert correct username and password. Without credentials, curl can will return incorrect result.
SCP is in insecure mode - doesn't check SSH server key!
MQTT is only plaintext. You can specify username and password. MQTT test waits for the first messase from a given topic or for any message if the topic has not been specified.
For SFTP, SCP or remote command you can use SSH key.
Do not test other servers without permission!
Servcheck uses a file of certificates from common root CAs to check certificates. This will work for certificates issued by common CAs. If you are using a custom CA (for example, in a Microsoft AD environment), the test for that certificate will fail because servcheck does not know your CA. You must upload the entire chain (CA certificate and intermediate certificates). You then associate these with the test where the certificate issued by your CA
To install the servcheck plugin, simply copy the plugin_servcheck directory to Cacti's plugins directory and rename it to simply 'servcheck'. Once you have done this, goto Cacti's Plugin Management page, Install and Enable the servcheck. Once this is complete, you can grant users permission to create service checks for various services.
Go to Management -> Service Checker
For some tests you need install libcurl library. For more information about Curl/libcurl visit https://www.php.net/manual/en/book.curl.php
Bug and feature enhancements for the servcheck plugin are handled in GitHub. If you find a first search the Cacti forums for a solution before creating an issue in GitHub - https://github.com/Cacti/plugin_servcheck
You can find more information on our forum - http://forums.cacti.net/viewtopic.php?t=62934
Copyright (c) 2004-2025 - The Cacti Group, Inc.