Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 7. Visualizing activities in dashboards

Install the Red Hat build of Keycloak Grafana dashboards to visualize the metrics that capture the status and activities of your deployment.

Red Hat build of Keycloak provides metrics to observe what is happening inside the deployment. To understand how metrics evolve over time, it is helpful to collect and visualize them in graphs.

This guide provides instructions on how to visualize collected Red Hat build of Keycloak metrics in a running Grafana instance.

7.1. Prerequisites
Copy link

  • Red Hat build of Keycloak metrics are enabled. Follow Gaining insights with metrics chapter for more details.
  • Grafana instance is running and Red Hat build of Keycloak metrics are collected into a Prometheus instance.
  • For the HTTP request latency heatmaps to work, enable histograms for HTTP metrics by setting http-metrics-histograms-enabled to true.

7.2. Red Hat build of Keycloak Grafana dashboards
Copy link

Grafana dashboards are distributed in the form of a JSON file that is imported into a Grafana instance. JSON definitions of Red Hat build of Keycloak Grafana dashboards are available in the keycloak/keycloak-grafana-dashboard GitHub repository.

Follow these steps to download JSON file definitions.

  1. Identify the branch from keycloak-grafana-dashboards to use from the following table.

    Expand
    Red Hat build of Keycloak versionkeycloak-grafana-dashboards branch

    >= 26.1

    main

  2. Clone the GitHub repository 

    git clone -b BRANCH_FROM_STEP_1 https://github.com/keycloak/keycloak-grafana-dashboard.git
    Copy to Clipboard Toggle word wrap
  3. The dashboards are available in the directory keycloak-grafana-dashboard/dashboards.

The following sections describe the purpose of each dashboard.

This dashboard is available in the JSON file: keycloak-troubleshooting-dashboard.json.

On the top of the dashboard, graphs display the service level indicators as defined in Monitoring performance with Service Level Indicators. This dashboard can be also used while troubleshooting a Red Hat build of Keycloak deployment following the Troubleshooting using metrics chapter, for example, when SLI graphs do not show expected results.

Figure 7.1. Troubleshooting dashboard

Troubleshooting dashboard
View larger image
Troubleshooting dashboard

7.2.2. Keycloak capacity planning dashboard
Copy link

This dashboard is available in the JSON file: keycloak-capacity-planning-dashboard.json.

This dashboard shows metrics that are important when estimating the load handled by a Red Hat build of Keycloak deployment. For example, it shows the number of password validations or login flows performed by Red Hat build of Keycloak. For more detail on these metrics, see the chapter Self-provided metrics.

Note

Red Hat build of Keycloak event metrics must be enabled for this dashboard to work correctly. To enable them, see the chapter Monitoring user activities with event metrics.

Figure 7.2. Capacity planning dashboard

Capacity planning dashboard
View larger image
Capacity planning dashboard

7.3. Import a dashboard
Copy link

  1. Open the dashboard page from the left Grafana menu.
  2. Click New and Import.
  3. Click Upload dashboard JSON file and select the JSON file of the dashboard you want to import.
  4. Pick your Prometheus datasource.
  5. Click Import.

7.4. Export a dashboard
Copy link

Exporting a dashboard to JSON format may be useful. For example, you may want to suggest a change in our dashboard repository.

  1. Open a dashboard you would like to export.
  2. Click share in the top left corner next to the dashboard name.
  3. Click the Export tab.
  4. Enable Export for sharing externally.
  5. Click either Save to file or View JSON and Copy to Clipboard according to where you want to store the resulting JSON.

7.5. Further reading
Copy link

Continue reading on how to connect traces to dashboard in the Analyzing outliers and errors with exemplars chapter.

Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat