About Checker
Checker is designed for monitoring HAProxy, NGINX, Apache and Keepalived services as well as HAProxy backends. If a backend or a service is down, Checker will send an alert via Telegram and/or Slack. Real-time alerting via Roxy-WI panel is also supported. Checker keeps the history of incidents.
The checker service consists of the following parts:
- Master сhecker
- Worker checker for HAProxy
- Worker checker for NGINX
- Worker checker for Apache
- Worker checker for Keepalived
The Master сhecker runs the Worker checkers. It must always be running.
In order for you to monitor HAProxy,NGINX, Apache, Keepalived services the Master сhecker will start the local worker for each of these services.
Checker Features
The Worker checker for HAProxy performs the following operations:
- verifying the status of HAProxy service;
- verifying the status of backends;
- verifying if the number of connections is about to reach the limit;
- sending alerts via Telegram and Slack.
The Worker checker for NGINX can perform the following operations:
- verifying the status of NGINX service;
- sending alerts via Telegram and Slack.
The Worker checker for Apache can perform the following operations:
- verifying the status of Apache service;
- sending alerts via Telegram and Slack.
The Worker checker for Keepalived performs the following functions:
- verifying the Keepalived service;
- verifying the Keepalived status;
- sending alerts via Telegram and Slack.
Installation
Execute the following command to install Checker:
All information concerning RPM packages can be found here.
Telegram parameters
Since version 6.1.0 Checker can send Telegram alerts for NGINX, HAProxy, Apache and Keepalived servers events. Go to Admin area-Сhecker to specify the Telegram settings.
You should see the list of Telegram channels:Click the Add button to add a new channel. Specify the parameters in the new window according to the table below:
Parameter: | Description: |
Token | Token received from @father_bot. |
Channel name | Name of your channel. The channel must be public. |
Group | You can specify one of the existing groups. A group is equal to a namespace. Members of one group cannot see the servers from the other groups. |
Slack parameters
Slack notifications for each server are available since version 6.1.0. The interface for specifying Slack parameters is quite the same as the one for Telegram. Click the Add button to add a new channel, then specify the parameters according the table below.
Parameter: | Description: |
Token | Token received via the Slack API |
Channel name | Name of your channel. The channel must be public. |
Group | You can specify one of the existing groups. A group is equal to a namespace. Members of one group cannot see the servers from the other groups. |
Notifications settings
You can manage Telegram and Slack notifications for all NGINX, HAProxy, Apache and Keepalived servers on the Settings tab.
Select a channel in the dropdown menu to enable notifications or select Disabled to stop sending notifications. If you need to send notifications by e-mail to all members of a group, tick the E-mail checkbox.
You may tick other checkboxes (Service, Backend, Maxconn, Status) as well. Notifications can include the information on:
- the availability of the service (the Service checkbox);
- server status changes (the Status checkbox);
- HAProxy backend servers availability (the Backend checkbox);
- the Maxconn parameter value for HAproxy; e.g. when the value is about to reach the specified threshold, а notification is sent (the Backend checkbox).
Logs
The Master сhecker and the Worker checker have their own log in Admin area-Internal logs.
All further information concerning the Internal logs can be found here.Updating
Execute the following command to update Checker:
Was this article helpful?
You may also be interested in:
How to create a Telegram bot and use it with Roxy-WI