Monitor Your Tenant

Identity Cloud lets you monitor uptime status and system performance.

Monitor uptime status

Tenant status page

You can monitor uptime and historical trends for your staging and production tenant environments using your tenant status page.

  1. In a browser, go to https://forgerock.statuspage.io/.

  2. On the sign-in page, enter the credentials you received when you registered with Identity Cloud.
    If you don’t have access to this page, submit a support ticket: Go to Backstage, and click Support.

  3. Click Authenticate.

Services monitored in the status page include:

  • Access Management

  • Identity Management

  • End User UI

  • Login UI

  • Admin UI

  • Logs

400

Add more Admins to the tenant status page

If monitoring Identity Cloud uptime status is part of a particular admin’s role, submit a support request to give the individual access to the tenant status page.

  • To submit a support request, go to Backstage, and click Support.

  • You can request access on behalf of one or more admins, including yourself.

  • In the request, provide the email address of each admin you want to have status page access.

You can view real-time status of your staging and production environments, and a listing of service incidents.

400

For more details, click View historical uptime. Then click Filter Components to view reports on incidents in selected Identity Cloud components.

400

Identity Cloud also provides APIs for extracting log data. For more information, see View Audit Logs.

Monitor system performance

Identity Cloud provides monitoring endpoints you can use with Prometheus.

Endpoint Purpose

/monitoring/prometheus/am

Produces Prometheus-formatted metrics for Access Management

/monitoring/prometheus/idm

Produces Prometheus-formatted metrics for Identity Management

You must obtain API credentials to authenticate to these endpoints. See Obtaining API Credentials.

You can download and run a Docker-based example of a Grafana dashboard. The demo requires that you have Docker Desktop installed, and requires macOS.

To try the demo:

  1. Download and extract the ForgeRock Identity Cloud Monitoring Demo ZIP file.

  2. Edit the setup_monitoring_config.sh file:

    1. In the TENANT_DOMAIN variable, enter the domain name of your tenant.

      Do not include the protocol, and do not add a trailing slash.

      For example:

      TENANT_DOMAIN="mytenant-01.forgeblocks.com"
    2. In the API_KEY_ID and API_KEY_SECRET variables, enter the API credentials you obtained earlier.

      For example:

      API_KEY_ID="b977d5724ef...562e4c57"
      API_KEY_SECRET="d3628be865ce152f49...870e5fd3506c4"
    3. Save your changes.

  3. Run the setup_monitoring_config.sh script.

    The Shell script will set up the following config files:

    Config File Description

    prometheus/prometheus.yml

    The script populates the tenant domain and API credentials.

    docker/docker-compose.yml

    The script populates the working directory path.

  4. Run the following Docker command:

    docker-compose -f docker/docker-compose.yml up

    The command downloads a Prometheus Docker image and configures it for your tenant. It also downloads a Grafana Docker image, and configures it to use the Prometheus image as a data source.

  5. When the command output for the "grafana_1" container displays a message that contains "HTTP Server Listen", open http://localhost:3000 in a web browser.

  6. Log in with username "admin", password "admin".

  7. Enter a new password to use for the administrator, or click Skip.

  8. On the Grafana Home page, select Dashboards, and then select Manage.

  9. On the Dashboards page, select AM Overview.

    The AM Overview dashboard opens:

    Sample AM Grafana Dashboard

    View the Prometheus dashboard at http://localhost:9090.