使用 Prometheus 指标监控 Caddy

无论您是在云端运行数千个 Caddy 实例，还是在嵌入式设备上运行单个 Caddy 服务器，您都很可能在某个时候希望对 Caddy 的运行情况以及运行时间有一个高级概览。换句话说，您将希望能够监控 Caddy。

启用指标

您需要开启指标。

如果使用 Caddyfile，请在全局选项中启用指标

{
	metrics
}

如果使用 JSON，请将 "metrics": {} 添加到您的 apps > http > servers 配置。

要添加每个主机的指标，您可以插入 per_host 选项。现在，主机特定的指标将具有主机标签。

{
	metrics {
		per_host
	}
}

Prometheus

Prometheus 是一个监控平台，它通过抓取这些目标上的指标 HTTP 端点来收集来自受监控目标的指标。除了帮助您使用诸如 Grafana 之类的仪表板工具显示指标外，Prometheus 还用于 告警。

与 Caddy 一样，Prometheus 使用 Go 编写，并作为单个二进制文件分发。要安装它，请参阅 Prometheus 安装文档，或者在 MacOS 上只需运行 brew install prometheus。

如果您是 Prometheus 的新手，请阅读 Prometheus 文档，否则请继续阅读！

要配置 Prometheus 从 Caddy 抓取指标，您需要一个类似于这样的 YAML 配置文件

# prometheus.yaml
global:
  scrape_interval: 15s # default is 1 minute

scrape_configs:
  - job_name: caddy
    static_configs:
      - targets: ['localhost:2019']

然后您可以像这样启动 Prometheus

$ prometheus --config.file=prometheus.yaml

Caddy 的指标

与任何使用 Prometheus 监控的进程一样，Caddy 公开了一个 HTTP 端点，该端点以 Prometheus exposition 格式响应。Caddy 的 Prometheus 客户端也被配置为在协商时（即，如果 Accept 标头设置为 application/openmetrics-text; version=0.0.1）以 OpenMetrics exposition 格式响应。

默认情况下，在 admin API (即 https://127.0.0.1:2019/metrics) 上有一个 /metrics 端点可用。但是，如果 admin API 被禁用，或者您希望在不同的端口或路径上监听，您可以使用 metrics 处理程序来配置它。

您可以使用任何浏览器或 HTTP 客户端（如 curl）查看指标

$ curl https://127.0.0.1:2019/metrics
# HELP caddy_admin_http_requests_total Counter of requests made to the Admin API's HTTP endpoints.
# TYPE caddy_admin_http_requests_total counter
caddy_admin_http_requests_total{code="200",handler="metrics",method="GET",path="/metrics"} 2
# HELP caddy_http_request_duration_seconds Histogram of round-trip request durations.
# TYPE caddy_http_request_duration_seconds histogram
caddy_http_request_duration_seconds_bucket{code="308",handler="static_response",method="GET",server="remaining_auto_https_redirects",le="0.005"} 1
caddy_http_request_duration_seconds_bucket{code="308",handler="static_response",method="GET",server="remaining_auto_https_redirects",le="0.01"} 1
caddy_http_request_duration_seconds_bucket{code="308",handler="static_response",method="GET",server="remaining_auto_https_redirects",le="0.025"} 1
...

您将看到许多指标，它们大致分为 4 类

• 运行时指标
• Admin API 指标
• HTTP 中间件指标
• 反向代理指标

运行时指标

这些指标涵盖了 Caddy 进程的内部结构，并由 Prometheus Go Client 自动提供。它们以 go_* 和 process_* 为前缀。

请注意，process_* 指标仅在 Linux 和 Windows 上收集。

请参阅 Go Collector、Process Collector 和 BuildInfo Collector 的文档。

Admin API 指标

这些指标有助于监控 Caddy admin API。每个 admin 端点都经过仪表化，以跟踪请求计数和错误。

这些指标以 caddy_admin_* 为前缀。

例如

$ curl -s https://127.0.0.1:2019/metrics | grep ^caddy_admin
caddy_admin_http_requests_total{code="200",handler="admin",method="GET",path="/config/"} 1
caddy_admin_http_requests_total{code="200",handler="admin",method="GET",path="/debug/pprof/"} 2
caddy_admin_http_requests_total{code="200",handler="admin",method="GET",path="/debug/pprof/cmdline"} 1
caddy_admin_http_requests_total{code="200",handler="load",method="POST",path="/load"} 1
caddy_admin_http_requests_total{code="200",handler="metrics",method="GET",path="/metrics"} 3

caddy_admin_http_requests_total

由 admin 端点处理的请求总数的计数器，包括 admin.api.* 命名空间中的模块。

caddy_admin_http_request_errors_total

在 admin 端点中遇到的错误数的计数器，包括 admin.api.* 命名空间中的模块。

HTTP 中间件指标

所有 Caddy HTTP 中间件处理程序都已自动进行仪表化，用于确定请求延迟、首字节时间、错误以及请求/响应主体大小。

对于下面的直方图指标，bucket 当前不可配置。对于持续时间，使用默认的 (prometheus.DefBuckets) bucket 集 (5ms、10ms、25ms、50ms、100ms、250ms、500ms、1s、2.5s、5s 和 10s)。对于大小，bucket 为 256b、1kiB、4kiB、16kiB、64kiB、256kiB、1MiB 和 4MiB。

caddy_http_requests_in_flight

当前正在由此服务器处理的请求数的仪表。

caddy_http_request_errors_total

处理请求时遇到的中间件错误数的计数器。

caddy_http_requests_total

发出的 HTTP(S) 请求数的计数器。

caddy_http_request_duration_seconds

往返请求持续时间的直方图。

caddy_http_request_size_bytes

请求总大小（估计值）的直方图。包括主体。

caddy_http_response_size_bytes

返回的响应主体大小的直方图。

caddy_http_response_duration_seconds

响应的首字节时间的直方图。

反向代理指标

caddy_reverse_proxy_upstreams_healthy

反向代理上游健康状况的仪表。

值 0 表示上游不健康，而 1 表示上游健康。

示例查询

一旦您让 Prometheus 抓取 Caddy 的指标，您就可以开始看到一些关于 Caddy 性能的有趣指标。

例如，要查看每秒请求速率，以 5 分钟的平均值计算

rate(caddy_http_requests_total{handler="file_server"}[5m])

要查看超过 100 毫秒延迟阈值的速率

sum(rate(caddy_http_request_duration_seconds_count{server="srv0"}[5m])) by (handler)
-
sum(rate(caddy_http_request_duration_seconds_bucket{le="0.100", server="srv0"}[5m])) by (handler)

要在 file_server 处理程序上查找第 95 个百分位数的请求持续时间，您可以使用如下查询

histogram_quantile(0.95, sum(caddy_http_request_duration_seconds_bucket{handler="file_server"}) by (le))

或者查看 file_server 处理程序上成功 GET 请求的响应大小中位数（以字节为单位）

histogram_quantile(0.5, caddy_http_response_size_bytes_bucket{method="GET", handler="file_server", code="200"})