Prometheus-compliant Metrics#

This chapter of the Operation and Monitoring guide contains information about the Prometheus-compliant metrics available in the Curity Identity Server.

Each run-time and admin node exposes an endpoint where certain information is published in a Prometheus-compliant format (i.e., Prometheus’ OpenMetrics format). This allows the Prometheus monitoring tool (or others that can process data in this format) to monitor certain metrics about the behavior of the node. This endpoint is exposed over HTTP and listening on the same interface as the Status Endpoint . The port used is one greater than the status endpoint (4466 by default). The URI is /metrics, so, for example, the URL of the data would be https://localhost:4466/metrics.

The metrics exposed and their meanings is described in the following table:

In addition to the global metrics described above, some plugins may contribute with metrics related to their particular usage. Namely, the JDBC data source plugin exposes metrics of the underlying connection pool.

The labels in the previous table have the meanings described in the following table:

Gathering of data can be disabled. If this is set when the node starts, no data will be published. To disable gathering of data, in the admin UI, go to System > General. There, toggle off Enable Reporting. Once that change is committed, all nodes will stop gathering data.

Common Alerts#

If you want to setup certain alerts when things go wrong in the Curity Identity Server, you can simply setup the following:

• If datasource_*_sum / datasource_*_count >= 800 since the last poll to the metrics endpoint, your database is having issues. The result of this arithmetic is the average response time from the Curity Identity Server to the database (for the given period).
• If log4j2_appender_total with a label of error is > 0, call support!
• If log4j2_appender_total with a label of warn is greater than the last poll, look into the issue immediately, and raise a support case if you can’t figure out the problem.
• If cpu_usage is >= 95% at an unexpected time or for a prolonged period of time, you should take action.
• If http_server_request_time_sum / http_server_request_time_count >= 1000 since the last poll to the metrics endpoint. The result of this arithmetic is the average HTTP response time to the Curity Identity Server Web server (for the given period).

Configuration#

Configuring Prometheus metrics is done under configuration-reference/environments/environment/reporting section.

A configured reporting shown in the CLI

% show environments environment reporting
enable             true;
include-profile-id true;