How to monitor Athento?

Athento has mechanisms that allow us to control the availability and status of some services and/or functionalities in our clients' instances. Below you will find how to obtain performance information of the platform, to access this information you must have advanced administration permissions.

How to monitor the instance in general?

Athento has a page that shows generalized status information, you can monitor this page to see the general status of the instance. If the word WARNING appears on this page, it means that some revision of the environment must be done. If the word WARNING does not appear and the page loads correctly, it means that the instance should be fine.

You can visit:

https://{host}/health/status/monit/api/ 

How can I get the monitor information for API?

You can visit:
https://{host}/health/status/monit/api/

In this view the call answering times and 500 errors are monitored. In case none of these indicators are detected the page is loaded as follows:

If these indicators are found, the word WARNING (Will be available for integration in the second phase) will be displayed followed by the number of incidents found:

Notifications on the status of API requests

It is possible to activate the monitor_ecm_log command to receive warnings if slow ECM API requests or requests with error are detected.

This command has the following parameters:

• check_amount: The number of requests to analyze, by default 20,000.
• time_spent_threshold: The number of seconds after which a request is considered particularly slow, default 20.
• slow_request_threshold: The number of slow requests that must be detected for an alert to be triggered, default 50.
• mail_for_report: This is the email to which the alert will be sent in case there are more than the slow_request_threshold value in slow or error queries.

Jaeger connection

IMPORTANT: Athento does not offer Jaeger support or perform installations of this software.

This view is designed to be compatible with OpenTelemetry, to obtain these metrics based on the active time the view needs to be installed in the environment you need to configure an Exporter to the backend, in this case Jaeger was configured, which must be running locally to receive the metrics. Jaeger installation:

Download the Jaeger binary: Visit the Jaeger releases page on GitHub (Releases - jaegertracing/jaeger ) and download the Jaeger binary for your operating system. Make sure you choose the version that best suits your needs (for example, the all-in-one version is useful for local testing).

Extract the archive: Once the archive is downloaded, extract it to a location of your choice on your system.

Run Jaeger: Open a terminal and navigate to the directory where you extracted the Jaeger binary. Then, run the binary to start Jaeger.

For example, if you are on Linux or macOS, you can run the following command:

sqlCopy code

./jaeger-all-in-one

If you are on Windows, run the corresponding .exe binary:

cssCopy code

jaeger-all-in-one.exe

This will start Jaeger and start listening on the default port (6831 for the agent server and 16686 for the user interface).

How can I get the information from the processing monitor?

You can visit:

https://{host}/health/status/monit/processing

In this view the number of documents is monitored according to the processing status. As reference values, we have:

> 50 documents in processing

> 200 documents in pending

When the number of documents in pending or processing is below the reference values, the page loads as shown below:

If documents are identified above the reference values, we obtain:

The word WARNING is displayed (Will be available for a second phase integration).

How can I get the information from the performance monitor?

You can visit:

https://{host}/health/status/monit/performance

In this view APM data is monitored, displaying specific system performance metrics. In the following example we can see the metric configured by default system.cpu.user (The percentage of time the CPU spent running user space processes):

The average percentage used in the last hour is displayed, as well as a graph with the percentages of the last hour.

The possible metrics to consult are: https://docs.datadoghq.com/integrations/system/