AM 7.5.0

Monitor with Prometheus

Prometheus is third-party software used for gathering and processing monitoring data. AM exposes an endpoint which Prometheus uses to gather metrics from the AM instance. For more information about installing and running Prometheus, refer to the Prometheus documentation.

When enabled, AM makes the Prometheus-formatted metrics available at the /json/metrics/prometheus endpoint.

Configure Prometheus to monitor the AM endpoint, using the prometheus.yml configuration file. For more information on configuring Prometheus, refer to the Prometheus configuration documentation.

Prometheus provides monitoring and processing for the information provided by AM, but further analysis and visualization may be desired. In this case, you can use tools such as Grafana to create customized charts and graphs based on the information collected by Prometheus.

For more information on installing and running Grafana, refer to the Grafana website.

For monitoring metrics reference, refer to Monitoring metrics.

Enable Prometheus monitoring

  1. Ensure you have enabled monitoring.

  2. Go to Configure > Global Services > Monitoring.

  3. On Secondary Configurations tab, click prometheus, then select Enabled.

  4. In the Authentication Type drop-down menu, select one of the following options:

    • None. Prometheus doesn’t need to authenticate when accessing the endpoint.

    • HTTP Basic. Prometheus must authenticate using a username and a password when accessing the endpoint.

  5. If you selected HTTP Basic, specify a Username and Password.

    If you set a Secret Label Identifier and AM finds a matching secret in a secret store, the Password is ignored.

  6. For greater security, define a Secret Label Identifier to use a secret in a secret store and rotate the secret periodically.

    AM uses this identifier to create a specific secret label, using the template where identifier is the value of Secret Label Identifier.

    The identifier can only contain alphanumeric characters a-z, A-Z, 0-9, and periods (.). It can’t start or end with a period.

    Learn more about using secrets in Map and rotate secrets.

  7. Save your work.

Copyright © 2010-2024 ForgeRock, all rights reserved.