理解和使用多目标 Exporter 模式

本指南将向您介绍多目标 Exporter 模式。为此，我们将：

  • 描述多目标 Exporter 模式及其使用原因；
  • 运行 blackbox exporter 作为该模式的示例；
  • 为 blackbox exporter 配置自定义查询模块；
  • 让 blackbox exporter 对 Prometheus 网站运行基本指标查询；
  • 检查一种流行的模式，即配置 Prometheus 使用 relabeling 抓取 Exporter。

多目标 Exporter 模式？

我们所说的多目标 exporter 模式是指一种特定的设计，其中：

  • Exporter 将通过网络协议获取目标的指标。
  • Exporter 不需要运行在获取指标的机器上。
  • Exporter 将目标和查询配置字符串作为 Prometheus GET 请求的参数。
  • Exporter 在收到 Prometheus GET 请求后开始抓取，并在抓取完成后返回结果。
  • Exporter 可以查询多个目标。

这种模式仅用于特定的 Exporter，例如 blackbox 和 SNMP exporter。

原因在于我们无法在目标上运行 Exporter，例如运行 SNMP 的网络设备；或者我们明确关注距离，例如从网络外部特定点到网站的延迟和可达性，这是 blackbox exporter 的常见用例。

运行多目标 Exporter

多目标 Exporter 对其环境具有灵活性，可以通过多种方式运行。作为常规程序、在容器中、作为后台服务、在裸金属上、在虚拟机上都可以。因为它们通过网络进行查询和被查询，所以需要开放适当的端口。除此之外，它们对资源要求不高。

现在就来亲自动手试试吧！

使用 Docker 在终端中运行此命令来启动 blackbox exporter 容器。根据您的系统配置，您可能需要在命令前加上 sudo。

docker run -p 9115:9115 prom/blackbox-exporter

您应该看到几行日志，如果一切顺利，最后一行应该报告 msg="Listening on address"，如下所示：

level=info ts=2018-10-17T15:41:35.4997596Z caller=main.go:324 msg="Listening on address" address=:9115

多目标 Exporter 的基本查询

有两种查询方式：

  1. 查询 Exporter 本身。它有自己的指标，通常在 /metrics 可用。
  2. 查询 Exporter 以抓取另一个目标。通常在一个“描述性”的端点可用，例如 /probe。这可能是您在使用多目标 Exporter 时主要感兴趣的功能。

您可以在另一个终端中使用 curl 手动尝试第一种查询类型，或者使用此链接。

curl 'localhost:9115/metrics'

响应应该类似于：

# HELP blackbox_exporter_build_info A metric with a constant '1' value labeled by version, revision, branch, and goversion from which blackbox_exporter was built.
# TYPE blackbox_exporter_build_info gauge
blackbox_exporter_build_info{branch="HEAD",goversion="go1.10",revision="4a22506cf0cf139d9b2f9cde099f0012d9fcabde",version="0.12.0"} 1
# HELP go_gc_duration_seconds A summary of the GC invocation durations.
# TYPE go_gc_duration_seconds summary
go_gc_duration_seconds{quantile="0"} 0
go_gc_duration_seconds{quantile="0.25"} 0
go_gc_duration_seconds{quantile="0.5"} 0
go_gc_duration_seconds{quantile="0.75"} 0
go_gc_duration_seconds{quantile="1"} 0
go_gc_duration_seconds_sum 0
go_gc_duration_seconds_count 0
# HELP go_goroutines Number of goroutines that currently exist.
# TYPE go_goroutines gauge
go_goroutines 9

[…]

# HELP process_cpu_seconds_total Total user and system CPU time spent in seconds.
# TYPE process_cpu_seconds_total counter
process_cpu_seconds_total 0.05
# HELP process_max_fds Maximum number of open file descriptors.
# TYPE process_max_fds gauge
process_max_fds 1.048576e+06
# HELP process_open_fds Number of open file descriptors.
# TYPE process_open_fds gauge
process_open_fds 7
# HELP process_resident_memory_bytes Resident memory size in bytes.
# TYPE process_resident_memory_bytes gauge
process_resident_memory_bytes 7.8848e+06
# HELP process_start_time_seconds Start time of the process since unix epoch in seconds.
# TYPE process_start_time_seconds gauge
process_start_time_seconds 1.54115492874e+09
# HELP process_virtual_memory_bytes Virtual memory size in bytes.
# TYPE process_virtual_memory_bytes gauge
process_virtual_memory_bytes 1.5609856e+07

这些是 Prometheus 格式的指标。它们来自 Exporter 的应用检测 (instrumentation)，并告诉我们 Exporter 运行时的状态。这被称为白盒监控，在日常运维实践中非常有用。如果您好奇，可以尝试我们的指南，了解如何检测 (instrument) 您自己的应用。

对于第二种查询类型，我们需要在 HTTP GET 请求中提供 target 和 module 作为参数。target 是一个 URI 或 IP，module 必须在 Exporter 的配置中定义。blackbox exporter 容器带有一个有意义的默认配置。
我们将使用 target prometheus.io 和预定义的 module http_2xx。这告诉 Exporter 像浏览器访问 prometheus.io 那样发出 GET 请求，并期望获得一个 200 OK 响应。

您现在可以在终端中使用 curl 命令让您的 blackbox exporter 查询 prometheus.io。

curl 'localhost:9115/probe?target=prometheus.io&module=http_2xx'

这将返回许多指标。

# HELP probe_dns_lookup_time_seconds Returns the time taken for probe dns lookup in seconds
# TYPE probe_dns_lookup_time_seconds gauge
probe_dns_lookup_time_seconds 0.061087943
# HELP probe_duration_seconds Returns how long the probe took to complete in seconds
# TYPE probe_duration_seconds gauge
probe_duration_seconds 0.065580871
# HELP probe_failed_due_to_regex Indicates if probe failed due to regex
# TYPE probe_failed_due_to_regex gauge
probe_failed_due_to_regex 0
# HELP probe_http_content_length Length of http content response
# TYPE probe_http_content_length gauge
probe_http_content_length 0
# HELP probe_http_duration_seconds Duration of http request by phase, summed over all redirects
# TYPE probe_http_duration_seconds gauge
probe_http_duration_seconds{phase="connect"} 0
probe_http_duration_seconds{phase="processing"} 0
probe_http_duration_seconds{phase="resolve"} 0.061087943
probe_http_duration_seconds{phase="tls"} 0
probe_http_duration_seconds{phase="transfer"} 0
# HELP probe_http_redirects The number of redirects
# TYPE probe_http_redirects gauge
probe_http_redirects 0
# HELP probe_http_ssl Indicates if SSL was used for the final redirect
# TYPE probe_http_ssl gauge
probe_http_ssl 0
# HELP probe_http_status_code Response HTTP status code
# TYPE probe_http_status_code gauge
probe_http_status_code 0
# HELP probe_http_version Returns the version of HTTP of the probe response
# TYPE probe_http_version gauge
probe_http_version 0
# HELP probe_ip_protocol Specifies whether probe ip protocol is IP4 or IP6
# TYPE probe_ip_protocol gauge
probe_ip_protocol 6
# HELP probe_success Displays whether or not the probe was a success
# TYPE probe_success gauge
probe_success 0

请注意，几乎所有指标的值都是 0。最后一个指标显示 probe_success 0。这意味着 prober 未能成功访问 prometheus.io。原因隐藏在指标 probe_ip_protocol 中，其值为 6。默认情况下，除非另有指定，prober 使用 IPv6。但是 Docker daemon 默认阻止 IPv6。因此，在 Docker 容器中运行的 blackbox exporter 无法通过 IPv6 连接。

现在我们可以告诉 Docker 允许 IPv6，或者告诉 blackbox exporter 使用 IPv4。在实际情况中，两者都有其合理性，并且像往常一样，问题的答案“该怎么办？”是“视情况而定”。由于这是一篇 Exporter 指南，我们将修改 Exporter 并借此机会配置一个自定义模块。

配置模块

模块在 docker 容器内一个名为 config.yml 的文件中预定义，该文件是 github 仓库中 blackbox.yml 的副本。

我们将复制此文件，根据自己的需求进行修改，并告诉 Exporter 使用我们的配置文件，而不是容器中包含的那个。

首先使用 curl 或您的浏览器下载该文件：

curl -o blackbox.yml https://raw.githubusercontent.com/prometheus/blackbox_exporter/master/blackbox.yml

在编辑器中打开它。前几行看起来像这样：

modules:
  http_2xx:
    prober: http
  http_post_2xx:
    prober: http
    http:
      method: POST

YAML 使用空格缩进来表示层级结构，因此您可以识别出定义了两个名为 http_2xx 和 http_post_2xx 的 module，它们都使用 http prober，并且其中一个的 method 值特别设置为 POST。
现在您将修改 http_2xx 模块，通过将 http prober 的 preferred_ip_protocol 显式设置为字符串 ip4。

modules:
  http_2xx:
    prober: http
    http:
      preferred_ip_protocol: "ip4"
  http_post_2xx:
    prober: http
    http:
      method: POST

如果您想了解更多关于可用的 prober 和选项的信息，请查阅文档。

现在我们需要告诉 blackbox exporter 使用我们刚刚修改的文件。您可以使用 --config.file="blackbox.yml" 标志来实现。但是由于我们正在使用 Docker，我们首先必须使用 --mount 命令使该文件在容器内部可用。

注意：如果您使用的是 macOS，则需要首先允许 Docker daemon 访问包含 blackbox.yml 的目录。您可以通过点击菜单栏中的 Docker 小鲸鱼图标，然后选择 Preferences->File Sharing->+ 来完成。之后点击 Apply & Restart。

首先，进入旧容器的终端并按下 ctrl+c 停止它。确保您位于包含 blackbox.yml 的目录中。然后运行此命令。它很长，但我们将解释它。

docker \
  run -p 9115:9115 \
  --mount type=bind,source="$(pwd)"/blackbox.yml,target=/blackbox.yml,readonly \
  prom/blackbox-exporter \
  --config.file="/blackbox.yml"

通过此命令，您告诉 docker：

  1. 运行一个容器，将容器外部的端口 9115 映射到容器内部的端口 9115。
  2. 挂载将您当前目录（$(pwd) 代表打印当前工作目录）的 blackbox.yml 文件以 readonly 模式挂载到容器内的 /blackbox.yml。
  3. 使用来自 Docker hub 的 prom/blackbox-exporter 镜像。
  4. 使用 --config.file 标志运行 blackbox-exporter，告诉它使用 /blackbox.yml 作为配置文件。

如果一切正确，您应该看到如下所示的内容：

level=info ts=2018-10-19T12:40:51.650462756Z caller=main.go:213 msg="Starting blackbox_exporter" version="(version=0.12.0, branch=HEAD, revision=4a22506cf0cf139d9b2f9cde099f0012d9fcabde)"
level=info ts=2018-10-19T12:40:51.653357722Z caller=main.go:220 msg="Loaded config file"
level=info ts=2018-10-19T12:40:51.65349635Z caller=main.go:324 msg="Listening on address" address=:9115

现在您可以在终端中尝试我们新的使用 IPv4 的 http_2xx 模块。

curl 'localhost:9115/probe?target=prometheus.io&module=http_2xx'

这应该会返回如下所示的 Prometheus 指标：

# HELP probe_dns_lookup_time_seconds Returns the time taken for probe dns lookup in seconds
# TYPE probe_dns_lookup_time_seconds gauge
probe_dns_lookup_time_seconds 0.02679421
# HELP probe_duration_seconds Returns how long the probe took to complete in seconds
# TYPE probe_duration_seconds gauge
probe_duration_seconds 0.461619124
# HELP probe_failed_due_to_regex Indicates if probe failed due to regex
# TYPE probe_failed_due_to_regex gauge
probe_failed_due_to_regex 0
# HELP probe_http_content_length Length of http content response
# TYPE probe_http_content_length gauge
probe_http_content_length -1
# HELP probe_http_duration_seconds Duration of http request by phase, summed over all redirects
# TYPE probe_http_duration_seconds gauge
probe_http_duration_seconds{phase="connect"} 0.062076202999999996
probe_http_duration_seconds{phase="processing"} 0.23481845699999998
probe_http_duration_seconds{phase="resolve"} 0.029594103
probe_http_duration_seconds{phase="tls"} 0.163420078
probe_http_duration_seconds{phase="transfer"} 0.002243199
# HELP probe_http_redirects The number of redirects
# TYPE probe_http_redirects gauge
probe_http_redirects 1
# HELP probe_http_ssl Indicates if SSL was used for the final redirect
# TYPE probe_http_ssl gauge
probe_http_ssl 1
# HELP probe_http_status_code Response HTTP status code
# TYPE probe_http_status_code gauge
probe_http_status_code 200
# HELP probe_http_uncompressed_body_length Length of uncompressed response body
# TYPE probe_http_uncompressed_body_length gauge
probe_http_uncompressed_body_length 14516
# HELP probe_http_version Returns the version of HTTP of the probe response
# TYPE probe_http_version gauge
probe_http_version 1.1
# HELP probe_ip_protocol Specifies whether probe ip protocol is IP4 or IP6
# TYPE probe_ip_protocol gauge
probe_ip_protocol 4
# HELP probe_ssl_earliest_cert_expiry Returns earliest SSL cert expiry in unixtime
# TYPE probe_ssl_earliest_cert_expiry gauge
probe_ssl_earliest_cert_expiry 1.581897599e+09
# HELP probe_success Displays whether or not the probe was a success
# TYPE probe_success gauge
probe_success 1
# HELP probe_tls_version_info Contains the TLS version used
# TYPE probe_tls_version_info gauge
probe_tls_version_info{version="TLS 1.3"} 1

您可以看到探测成功了，并获得了许多有用的指标，例如按阶段划分的延迟、状态码、SSL 状态或证书在Unix 时间下的过期时间。
blackbox exporter 还在 localhost:9115 提供了一个小巧的 Web 界面，供您查看最近的几次探测、加载的配置和调试信息。它甚至提供了一个直接链接来探测 prometheus.io。如果您想知道为什么某些功能不起作用，这非常方便。

使用 Prometheus 查询多目标 Exporter

到目前为止，一切顺利。恭喜您。blackbox exporter 正在工作，并且您可以手动让它查询远程目标。您已经快成功了。现在您需要告诉 Prometheus 为我们进行这些查询。

下面是一个最小的 Prometheus 配置。它告诉 Prometheus 抓取 Exporter 本身，就像我们之前使用 curl 'localhost:9115/metrics' 所做的那样。

注意：如果您使用 Docker for Mac 或 Docker for Windows，您不能在最后一行使用 localhost:9115，而必须使用 host.docker.internal:9115。这与在这些操作系统上实现 Docker 所使用的虚拟机有关。您不应在生产环境中使用此方法。

Linux 上的 prometheus.yml

global:
  scrape_interval: 5s

scrape_configs:
- job_name: blackbox # To get metrics about the exporter itself
  metrics_path: /metrics
  static_configs:
    - targets:
      - localhost:9115

macOS 和 Windows 上的 prometheus.yml

global:
  scrape_interval: 5s

scrape_configs:
- job_name: blackbox # To get metrics about the exporter itself
  metrics_path: /metrics
  static_configs:
    - targets:
      - host.docker.internal:9115

现在运行一个 Prometheus 容器，并告诉它挂载我们上面的配置文件。由于容器可以访问主机网络的特殊方式，在 Linux 上使用的命令与在 MacOS 和 Windows 上有所不同。

在 Linux 上运行 Prometheus (生产环境请勿使用 --network="host")

docker \
  run --network="host"\
  --mount type=bind,source="$(pwd)"/prometheus.yml,target=/prometheus.yml,readonly \
  prom/prometheus \
  --config.file="/prometheus.yml"

在 MacOS 和 Windows 上运行 Prometheus

docker \
  run -p 9090:9090 \
  --mount type=bind,source="$(pwd)"/prometheus.yml,target=/prometheus.yml,readonly \
  prom/prometheus \
  --config.file="/prometheus.yml"

此命令的工作方式与使用配置文件运行 blackbox exporter 类似。

如果一切顺利，您应该能够访问 localhost:9090/targets 并在 blackbox 下看到一个状态为绿色的 UP 端点。如果您看到红色的 DOWN，请确保您上面启动的 blackbox exporter 仍在运行。如果您什么也没看到或看到黄色的 UNKNOWN，那说明您动作非常快，需要再等几秒钟再刷新浏览器标签页。

要告诉 Prometheus 查询 "localhost:9115/probe?target=prometheus.io&module=http_2xx"，您需要在 Prometheus 配置文件 prometheus.yml 中添加另一个 scrape job blackbox-http，将 metrics_path 设置为 /probe，并将参数设置在 params: 下。

global:
  scrape_interval: 5s

scrape_configs:
- job_name: blackbox # To get metrics about the exporter itself
  metrics_path: /metrics
  static_configs:
    - targets:
      - localhost:9115   # For Windows and macOS replace with - host.docker.internal:9115

- job_name: blackbox-http # To get metrics about the exporter’s targets
  metrics_path: /probe
  params:
    module: [http_2xx]
    target: [prometheus.io]
  static_configs:
    - targets:
      - localhost:9115   # For Windows and macOS replace with - host.docker.internal:9115

保存配置文件后，切换到运行 Prometheus docker 容器的终端，按下 ctrl+C 停止它，然后使用现有的命令再次启动它以重新加载配置。

终端应该返回消息 "Server is ready to receive web requests."，几秒钟后您应该开始在您的 Prometheus 中看到多彩的图表。

这种方法可行，但有一些缺点：

  1. 实际的目标位于 param 配置中，这非常不寻常，并且以后难以理解。
  2. instance 标签的值是 blackbox exporter 的地址，从技术上讲这是正确的，但这并不是我们关心的。
  3. 我们无法看到我们探测的是哪个 URL。这很不实用，而且如果我们探测多个 URL，也会将不同的指标混淆在一起。

为了解决这个问题，我们将使用relabeling。Relabeling 在这里很有用，因为在 Prometheus 内部，许多事情都是通过内部标签配置的。细节很复杂，超出了本指南的范围。因此，我们将仅介绍必要的内容。但如果您想了解更多，请查看这个演讲。现在，您只需理解以下几点：

  • 所有以 __ 开头的标签在抓取后都会被丢弃。大多数内部标签都以 __ 开头。
  • 您可以设置名为 __param_<name> 的内部标签。这些标签为抓取请求设置键为 <name> 的 URL 参数。
  • 有一个内部标签 __address__，它由 static_configs 下的 targets 设置，其值是抓取请求的主机名。默认情况下，它稍后用于设置标签 instance 的值，该标签附加到每个指标上，告诉您指标来自哪里。

这是您将用于此目的的配置。如果感觉一下子信息量有点大，请不用担心，我们将逐步讲解：

global:
  scrape_interval: 5s

scrape_configs:
- job_name: blackbox # To get metrics about the exporter itself
  metrics_path: /metrics
  static_configs:
    - targets:
      - localhost:9115   # For Windows and macOS replace with - host.docker.internal:9115

- job_name: blackbox-http # To get metrics about the exporter’s targets
  metrics_path: /probe
  params:
    module: [http_2xx]
  static_configs:
    - targets:
      - https://prometheus.ac.cn    # Target to probe with http
      - https://prometheus.ac.cn   # Target to probe with https
      - http://example.com:8080 # Target to probe with http on port 8080
  relabel_configs:
    - source_labels: [__address__]
      target_label: __param_target
    - source_labels: [__param_target]
      target_label: instance
    - target_label: __address__
      replacement: localhost:9115  # The blackbox exporter’s real hostname:port. For Windows and macOS replace with - host.docker.internal:9115

那么与上一个配置相比有什么新内容？

params 不再包含 target。相反，我们将实际的目标添加在 static configs: targets 下。我们还使用了多个目标，因为现在我们可以这样做了。

  params:
    module: [http_2xx]
  static_configs:
    - targets:
      - https://prometheus.ac.cn    # Target to probe with http
      - https://prometheus.ac.cn   # Target to probe with https
      - http://example.com:8080 # Target to probe with http on port 8080

relabel_configs 包含新的 relabeling 规则。

  relabel_configs:
    - source_labels: [__address__]
      target_label: __param_target
    - source_labels: [__param_target]
      target_label: instance
    - target_label: __address__
      replacement: localhost:9115  # The blackbox exporter’s real hostname:port. For Windows and macOS replace with - host.docker.internal:9115

在应用 relabeling 规则之前，Prometheus 发出的请求 URI 将看起来像这样："https://prometheus.ac.cn/probe?module=http_2xx"。经过 relabeling 后，它将看起来像这样："http://localhost:9115/probe?target=https://prometheus.ac.cn&module=http_2xx"。

现在让我们看看每条规则是如何实现这一点的：

首先，我们获取标签 __address__（其中包含 targets 的值）中的值，并将它们写入一个新的标签 __param_target，这将为 Prometheus 抓取请求添加一个参数 target。

  relabel_configs:
    - source_labels: [__address__]
      target_label: __param_target

在此之后，我们设想的 Prometheus 请求 URI 现在包含一个 target 参数："https://prometheus.ac.cn/probe?target=https://prometheus.ac.cn&module=http_2xx"。

然后，我们获取标签 __param_target 中的值，并使用这些值创建一个 instance 标签。

  relabel_configs:
    - source_labels: [__param_target]
      target_label: instance

我们的请求不会改变，但从请求返回的指标现在将带有标签 instance="https://prometheus.ac.cn"。

之后，我们将值 localhost:9115（我们 Exporter 的 URI）写入标签 __address__。这将用作 Prometheus 抓取请求的主机名和端口。这样，Prometheus 就会查询 Exporter，而不是直接查询目标 URI。

  relabel_configs:
    - target_label: __address__
      replacement: localhost:9115  # The blackbox exporter’s real hostname:port. For Windows and macOS replace with - host.docker.internal:9115

我们的请求现在是 "localhost:9115/probe?target=https://prometheus.ac.cn&module=http_2xx"。通过这种方式，我们可以将实际的目标保留在那里，将它们作为 instance 标签的值，同时让 Prometheus 对 blackbox exporter 发出请求。

人们通常将这些与特定的服务发现机制结合使用。请查阅配置文档以获取更多信息。使用它们没有任何问题，因为它们像 static_configs 下定义的 targets 一样写入 __address__ 标签。

就是这样。重新启动 Prometheus docker 容器，并查看您的指标。请注意选择实际收集指标的时间段。

总结

在本指南中，您学习了多目标 Exporter 模式的工作原理，如何使用自定义模块运行 blackbox exporter，以及如何使用 relabeling 配置 Prometheus 来抓取带有 prober 标签的指标。

本文档是开源的。请通过提交 issue 或 pull request 来帮助改进它。