Integration Monitor – Athento

Athento allows you to monitor integrations with third-party web services. This way we will be able to know which integrations are working and which are producing errors.

The integration services to be monitored must be configured from the administration. For each one of them a name for the monitor must be specified.

Types of services

Services configured in the settings

SMTP configured in Athento settings. They are configured in the “Health > Smtp settings service monitors” section.

Services configured in objects

The server to be monitored must be specified for each of them.

SMTP configured in the “SMTPServer” model. They are configured in the “Health > Smtp service monitors” section.

SFTP configured in the “SFTPServer” model. They are configured in the “Health > Sftp service monitors” section.
LDAP configured in the “LDAPServer” model. They are configured in the “Health > Ldap service monitors” section.
EWS configured in the “EWSMailboxConnection” model. They are configured in the “Health > EWS service monitors” section.

HTTP/HTTPS services

They are configured in the section “Health > Http service monitors” and we must specify the following data:

URL. URL that we want to monitor.
Method. Connection method.
Timeout. Response timeout of the service to be monitored.
SSL verification. Indicates whether the SSL certificate of the URL will be verified.
Username. To perform authentication if necessary. It is not required.
Password. For authentication if required. Not required.

Customized services

Additionally, you can configure the monitoring of custom integration services. For this we need to specify the following data:

Connection method path. It is the path to a method defined in the Athento server, in charge of performing the connection check.
- If the connection is successful, it must return two values: True, None.
- If the connection is not successful, it must return two values: False, exception returned.
Connection configuration. Data that will reach the connection method.

Example of method:

Monitor display

Once all monitors have been configured, users with superuser permission will be able to view the status within the “Health” section.

Within this we will find a new tab “Service monitor”.

In this tab we will be able to see all the configured monitors, with their name, their type of service and their status. In addition we will be able to access to its configuration by clicking on the administration symbol that appears in the upper right part of each monitor.

From time to time a command will be launched to check the status of the monitors and update the status of each one of them, showing in the interface which of them are working well and which of them are causing an error. This command is “check_services_status” and in order to send a notification to support with the monitors that are down we must indicate the parameter “send-support-notification”.

Execution of the command without sending notification to support:

python manage.py check_services_status

Execution of the command sending notification to support:

python manage.py check_services_status --send-support-notification

After launching this command we will be able to see the status of each of the monitors.

From the status of each one of them we will be able to know which servers we should check to keep each and every one of them working.