mirror of
https://github.com/keycloak/keycloak.git
synced 2026-02-22 07:09:03 -06:00
Rework observability page titles and summaries
Closes #38583 Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
This commit is contained in:
Alexander Schwartz
committed by
GitHub
GitHub
parent
5583155802
commit
b3b30a8620
@@ -4,8 +4,8 @@
|
||||
<#import "/templates/links.adoc" as links>
|
||||
|
||||
<@tmpl.guide
|
||||
title="Enabling {project_name} Metrics"
|
||||
summary="Learn how to enable and expose metrics from the server"
|
||||
title="Gaining insights with metrics"
|
||||
summary="Collect metrics to gain insights about state and activities of a running instance of {project_name}."
|
||||
includedOptions="metrics-enabled http-metrics-* cache-metrics-*">
|
||||
|
||||
{project_name} has built in support for metrics. This {section} describes how to enable and configure server metrics.
|
||||
|
||||
@@ -4,11 +4,10 @@
|
||||
<#import "/templates/links.adoc" as links>
|
||||
|
||||
<@tmpl.guide
|
||||
title="Enabling {project_name} Event Metrics"
|
||||
summary="Learn how to enable and use {project_name} Event Metrics"
|
||||
title="Monitoring user activities with event metrics"
|
||||
summary="Event metrics provide admins an aggregated view of the different user activities in a {project_name} instance."
|
||||
includedOptions="metrics-enabled event-metrics-user-*">
|
||||
|
||||
Event metrics can provide admins an overview of the different activities in a {project_name} instance.
|
||||
For now, only metrics for user events are captured.
|
||||
For example, you can monitor the number of logins, login failures, or token refreshes performed.
|
||||
|
||||
|
||||
@@ -2,13 +2,12 @@
|
||||
<#import "/templates/links.adoc" as links>
|
||||
|
||||
<@tmpl.guide
|
||||
title="{project_name} Grafana dashboards"
|
||||
summary="Learn how to import {project_name} provided Grafana dashboards to your Grafana instance" >
|
||||
title="Visualizing activities in a dashboard"
|
||||
summary="Install the {project_name} Grafana dashboards to vitualize the metrics that capture the status and activities of your deployment.">
|
||||
|
||||
{project_name} provides metrics to observe what is happening inside the deployment.
|
||||
To understand how metrics evolve over time, it is helpful to collect them and visualize in graphs.
|
||||
|
||||
|
||||
This guide provides instructions on how to visualize collected {project_name} metrics in a running Grafana instance.
|
||||
|
||||
== Prerequisites
|
||||
|
||||
@@ -4,8 +4,8 @@
|
||||
<#import "/templates/links.adoc" as links>
|
||||
|
||||
<@tmpl.guide
|
||||
title="Enabling {project_name} Health checks"
|
||||
summary="Learn how to enable and use {project_name} health checks"
|
||||
title="Tracking instance status with health checks"
|
||||
summary="Check if an instance has finished its start up and is ready to serve requests by calling its health REST endpoints."
|
||||
includedOptions="health-enabled">
|
||||
|
||||
{project_name} has built in support for health checks. This {section} describes how to enable and use the {project_name} health checks.
|
||||
|
||||
@@ -2,8 +2,8 @@
|
||||
<#import "/templates/links.adoc" as links>
|
||||
|
||||
<@tmpl.guide
|
||||
title="{project_name} service level indicators (SLIs)"
|
||||
summary="Learn about the Service Level Indicators to monitor your {project_name} deployment's performance"
|
||||
title="Monitoring performance with Service Level Indicators"
|
||||
summary="Track performance and reliability as perceived by users with Service Level Indicators (SLIs) and Service Level Objectives (SLOs)."
|
||||
>
|
||||
|
||||
Service Level Indicators (SLIs) and Service Level Objectives (SLOs) are essential components in monitoring and maintaining the performance and reliability of {project_name} in production environments.
|
||||
|
||||
@@ -2,8 +2,8 @@
|
||||
<#import "/templates/links.adoc" as links>
|
||||
|
||||
<@tmpl.guide
|
||||
title="Clustering and network metrics"
|
||||
summary="Learn about metrics monitoring communication between {project_name} nodes"
|
||||
title="Clustering metrics"
|
||||
summary="Learn about metrics monitoring communication between {project_name} nodes."
|
||||
tileVisible="false"
|
||||
>
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
<#import "/templates/links.adoc" as links>
|
||||
|
||||
<@tmpl.guide
|
||||
title="{project_name} Database Metrics"
|
||||
title="Database Metrics"
|
||||
summary="Learn about metrics describing {project_name}'s connection to the database"
|
||||
tileVisible="false"
|
||||
>
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
<#import "/templates/links.adoc" as links>
|
||||
|
||||
<@tmpl.guide
|
||||
title="Embedded Infinispan metrics for multiple sites deployments"
|
||||
title="Embedded Infinispan metrics for multi-site deployments"
|
||||
summary="Learn about metrics monitoring caching health"
|
||||
tileVisible="false"
|
||||
>
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
<#import "/templates/links.adoc" as links>
|
||||
|
||||
<@tmpl.guide
|
||||
title="{project_name} HTTP metrics"
|
||||
title="HTTP metrics"
|
||||
summary="Learn about metrics for monitoring the {project_name} HTTP requests processing"
|
||||
tileVisible="false"
|
||||
>
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
<#import "/templates/links.adoc" as links>
|
||||
|
||||
<@tmpl.guide
|
||||
title="{project_name} JVM metrics"
|
||||
title="JVM metrics"
|
||||
summary="Learn about key JVM metrics for observing performance of {project_name}"
|
||||
tileVisible="false"
|
||||
>
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
<#import "/templates/links.adoc" as links>
|
||||
|
||||
<@tmpl.guide
|
||||
title="{project_name} self-provided metrics"
|
||||
title="Self-provided metrics"
|
||||
summary="Learn about key metrics that {project_name} provides"
|
||||
tileVisible="false"
|
||||
>
|
||||
|
||||
@@ -2,8 +2,8 @@
|
||||
<#import "/templates/links.adoc" as links>
|
||||
|
||||
<@tmpl.guide
|
||||
title="Metrics for troubleshooting {project_name} deployment"
|
||||
summary="Learn about metrics that can indicate where the issue is, for example, when service level objective is not met"
|
||||
title="Troubleshooting using metrics"
|
||||
summary="Learn which metrics exist and how to use them for troubleshooting errors and performance issues."
|
||||
>
|
||||
|
||||
For a running {project_name} deployment it is important to understand how the system performs and whether it meets your service level objectives (SLOs).
|
||||
|
||||
@@ -3,5 +3,13 @@ configuration-metrics
|
||||
event-metrics
|
||||
keycloak-service-level-indicators
|
||||
metrics-for-troubleshooting
|
||||
metrics-for-troubleshooting-keycloak
|
||||
metrics-for-troubleshooting-jvm
|
||||
metrics-for-troubleshooting-database
|
||||
metrics-for-troubleshooting-http
|
||||
metrics-for-troubleshooting-clustering-and-network
|
||||
metrics-for-troubleshooting-embedded-caches
|
||||
metrics-for-troubleshooting-embedded-caches-multi-site
|
||||
metrics-for-troubleshooting-external-infinispan-multi-site
|
||||
tracing
|
||||
grafana-dashboards
|
||||
|
||||
@@ -4,14 +4,14 @@
|
||||
<#import "/templates/links.adoc" as links>
|
||||
<#import "/templates/profile.adoc" as profile>
|
||||
|
||||
<@tmpl.guide title="Enabling Tracing"
|
||||
summary="Learn how to enable distributed tracing in {project_name}"
|
||||
<@tmpl.guide title="Root cause analysis with tracing"
|
||||
summary="Record information during the request lifecycle with OpenTelementry tracing to identify root cases for latencies and errors in {project_name} and connected systems."
|
||||
includedOptions="tracing-* log-*-include-trace">
|
||||
|
||||
This {section} explains how you can enable and configure distributed tracing in {project_name} by utilizing https://opentelemetry.io/[OpenTelemetry] (OTel).
|
||||
Tracing allows for detailed monitoring of each request's lifecycle, which helps quickly identify and diagnose issues, leading to more efficient debugging and maintenance.
|
||||
|
||||
It also provides valuable insights into performance bottlenecks and can help optimize the system's overall efficiency.
|
||||
It provides valuable insights into performance bottlenecks and can help optimize the system's overall efficiency and across system boundaries.
|
||||
{project_name} uses a supported https://quarkus.io/guides/opentelemetry-tracing[Quarkus OTel extension] that provides smooth integration and exposure of application traces.
|
||||
|
||||
== Enable tracing
|
||||
|
||||
Reference in New Issue
Block a user