Red Hat SummitDieser Inhalt ist in der von Ihnen ausgewählten Sprache nicht verfügbar.
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
- 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-enabledtotrue.
7.2. Red Hat build of Keycloak Grafana dashboards
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.
Identify the branch from
keycloak-grafana-dashboardsto use from the following table.Expand Red Hat build of Keycloak version keycloak-grafana-dashboardsbranch>= 26.1
mainClone the GitHub repository
git clone -b BRANCH_FROM_STEP_1 https://github.com/keycloak/keycloak-grafana-dashboard.git
git clone -b BRANCH_FROM_STEP_1 https://github.com/keycloak/keycloak-grafana-dashboard.gitCopy to Clipboard Copied! Toggle word wrap Toggle overflow -
The dashboards are available in the directory
keycloak-grafana-dashboard/dashboards.
The following sections describe the purpose of each dashboard.
7.2.1. Red Hat build of Keycloak troubleshooting 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
7.2.2. Keycloak capacity planning dashboard
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.
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
7.3. Import a dashboard
- Open the dashboard page from the left Grafana menu.
- Click New and Import.
- Click Upload dashboard JSON file and select the JSON file of the dashboard you want to import.
- Pick your Prometheus datasource.
- Click Import.
7.4. Export a dashboard
Exporting a dashboard to JSON format may be useful. For example, you may want to suggest a change in our dashboard repository.
- Open a dashboard you would like to export.
- Click share in the top left corner next to the dashboard name.
- Click the Export tab.
- Enable Export for sharing externally.
- 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
Continue reading on how to connect traces to dashboard in the Analyzing outliers and errors with exemplars chapter.
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}