HTTP 指标

了解有关监控 Keycloak HTTP 请求处理的指标

这是使用指标进行故障排除指南的一部分。

先决条件

指标

处理时间

处理时间通过这些指标公开,用于监控 Keycloak 性能以及处理请求所需的时间。

在健康的集群上,平均处理时间将保持稳定。 处理时间出现峰值或增加可能是某些节点负载过高的早期迹象。

标签

method

HTTP 方法。

outcome

更通用的结果标签。

status

HTTP 状态代码。

uri

请求的 URI。

指标 描述

http_server_requests_seconds_count

已处理的请求总数。

http_server_requests_seconds_sum

所有已处理请求的总持续时间。

您可以通过将 http-metrics-histograms-enabled 设置为 true 来为此指标启用直方图,并使用选项 http-metrics-slos 为服务级别目标添加额外的桶。

当启用直方图时,可以使用百分位桶。 这些桶对于创建热图和分析延迟非常有用,但收集和公开百分位桶仍会增加监控系统的负载。

活跃请求

当前的活跃请求数也可用。

指标 描述

http_server_active_requests

当前的活跃请求数

带宽

以下指标有助于监控 Keycloak 使用的带宽和消耗的流量,以及请求和响应接收或发送所消耗的带宽和流量。

指标 描述

http_server_bytes_written_count

发送的响应总数。

http_server_bytes_written_sum

发送的总字节数。

http_server_bytes_read_count

接收的请求总数。

http_server_bytes_read_sum

接收的总字节数。

当启用直方图时,可以使用百分位桶。 这些桶对于创建热图和分析延迟非常有用,但收集和公开百分位桶仍会增加监控系统的负载。

下一步

相关选项

http-metrics-histograms-enabled

为 HTTP 服务器请求的持续时间启用带有默认桶的直方图。

CLI: --http-metrics-histograms-enabled
Env: KC_HTTP_METRICS_HISTOGRAMS_ENABLED

仅当启用指标时可用

true, false (默认)

http-metrics-slos

HTTP 服务器请求的服务级别目标。

使用此选项代替默认直方图,或将其组合使用以添加额外的桶。 指定以逗号分隔的毫秒值列表。 例如,桶从 5 毫秒到 10 秒:5,10,25,50,250,500,1000,2500,5000,10000

CLI: --http-metrics-slos
Env: KC_HTTP_METRICS_SLOS

仅当启用指标时可用

在此页