Set up Monitoring
IDM includes the following tools for monitoring metrics:
A Dropwizard dashboard widget, for viewing metrics within IDM.
A Prometheus endpoint, for viewing metrics through external resources such as Prometheus and Grafana.
The tool that you choose will depend on the metrics you monitor and on what you plan to use the metrics for.
IDM does not gather metrics by default. To enable metrics gathering, open
conf/metrics.json and set the
enabled property to
To verify that metrics are successfully enabled, run:
curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --header "Accept-API-Version: resource=1.0" \ --request GET \ 'http://localhost:8080/openidm/metrics/api?_queryFilter=true'
If you have enabled metrics, this command returns information about the metrics that are being collected. Otherwise, the command returns a bad request response.
Metrics are reported only after they have been triggered by activity in IDM, such as a reconciliation.
For a list of available metrics, see Metrics Reference.