9 HTTP agent

概述

此监控项类型允许使用 HTTP/HTTPS 协议进行数据轮询。 也可以使用 Zabbix sender 工具或 Zabbix sender 协议 进行采集（用于向 Zabbix 服务器或 proxy 发送数据），或者使用 history.push API 方法（用于向 Zabbix 服务器发送数据）。

HTTP 监控项检查由 Zabbix 服务器执行。 但是，当主机由 Zabbix proxy 监控时，HTTP 监控项检查由 proxy 执行。

HTTP 监控项检查不需要被监控主机上运行任何 agent。

HTTP agent 同时支持 HTTP 和 HTTPS。 Zabbix 会按需跟随重定向（请参见下方 Follow redirects 选项）。 重定向的最大数量硬编码为 10（使用 cURL 选项 CURLOPT_MAXREDIRS）。

Zabbix 服务器/proxy 必须先配置为支持 cURL（libcurl）。

HTTP 检查以异步方式执行 - 在开始其他检查之前，不需要等待某个请求的响应。 DNS 解析同样是异步的。

异步检查的最大并发数为 1000（由 MaxConcurrentChecksPerPoller 定义）。

异步 HTTP agent poller 的数量由 StartHTTPAgentPollers 参数定义。

自 Zabbix 7.0 起，HTTP agent 检查已添加 cURL 持久连接功能。

配置

要配置 HTTP 监控项：

  1. 转到 数据采集 > 主机。
  2. 单击该主机所在行中的 监控项。
  3. 单击 创建监控项。
  4. 在表单中输入该监控项的参数。

所有必填输入字段都用红色星号标记。

HTTP 监控项需要填写的特定字段如下：

Parameter Description
Type 在此选择 HTTP agent。
Key 输入唯一的监控项键值。
URL 要连接并检索数据的 URL。例如：
https://www.example.com
http://www.example.com/download
域名可以使用 Unicode 字符指定。在执行 HTTP 检查时，它们会自动转换为 ASCII 的 punycode。
可使用 Parse 按钮将可选查询字段（如 ?name=Admin&password=mypassword）从 URL 中分离出来，并将属性和值移到 Query fields 中，以便自动进行 URL 编码。
长度限制为 2048 个字符。
支持的宏：{HOST.IP}、{HOST.CONN}、{HOST.DNS}、{HOST.HOST}、{HOST.NAME}、{HOST.PORT}、{ITEM.ID}、{ITEM.KEY}、{ITEM.KEY.ORIG}、用户宏、低级别发现宏。
这会设置 CURLOPT_URL cURL 选项。
Query fields URL 的变量（见上文）。
以属性和值对的形式指定。
值会自动进行 URL 编码。来自宏的值会先解析，然后自动进行 URL 编码。
支持的宏：{HOST.IP}、{HOST.CONN}、{HOST.DNS}、{HOST.HOST}、{HOST.NAME}、{HOST.PORT}、{ITEM.ID}、{ITEM.KEY}、{ITEM.KEY.ORIG}、用户宏、低级别发现宏。
这会设置 CURLOPT_URL cURL 选项。
Request type 选择请求方法类型：GET、POST、PUT 或 HEAD
Request body type 选择请求正文类型：
Raw data - 自定义 HTTP 请求正文，宏会被替换，但不会执行编码
JSON data - JSON 格式的 HTTP 请求正文。宏可用作字符串、数字、true 和 false；作为字符串使用的宏必须用双引号括起来。来自宏的值会先解析，然后自动转义。如果头中未指定 "Content-Type"，则默认使用 "Content-Type: application/json"
XML data - XML 格式的 HTTP 请求正文。宏可用作文本节点、属性或 CDATA 部分。来自宏的值会先解析，然后在文本节点和属性中自动转义。如果头中未指定 "Content-Type"，则默认使用 "Content-Type: application/xml"
Request body 输入请求正文。
支持的宏：{HOST.IP}、{HOST.CONN}、{HOST.DNS}、{HOST.HOST}、{HOST.NAME}、{HOST.PORT}、{ITEM.ID}、{ITEM.KEY}、{ITEM.KEY.ORIG}、用户宏、低级别发现宏。
Headers 执行请求时发送的自定义 HTTP 头。
以属性和值对的形式指定。
支持的宏：{HOST.IP}、{HOST.CONN}、{HOST.DNS}、{HOST.HOST}、{HOST.NAME}、{HOST.PORT}、{ITEM.ID}、{ITEM.KEY}、{ITEM.KEY.ORIG}、用户宏、低级别发现宏。
这会设置 CURLOPT_HTTPHEADER cURL 选项。
Required status codes 期望的 HTTP 状态码列表。如果 Zabbix 获取到不在列表中的状态码，该监控项将变为不受支持。如果留空，则不执行检查。
例如：200,201,210-299
列表中支持的宏：用户宏、低级别发现宏。
这会使用 CURLINFO_RESPONSE_CODE cURL 选项。
Follow redirects 勾选此复选框以跟随 HTTP 重定向。
这会设置 CURLOPT_FOLLOWLOCATION cURL 选项。
Retrieve mode 选择必须检索的响应部分：
Body - 仅正文
Headers - 仅头部
Body and headers - 正文和头部
Convert to JSON 如果 Retrieve mode 未设置为 Body，则头部会作为属性和值对保存在 "header" 键下。
如果检测到 'Content-Type: application/json'，则正文会保存为对象，否则会作为字符串存储，例如：
HTTP proxy 您可以使用格式 [protocol://][username[:password]@]proxy.example.com[:port] 指定要使用的 HTTP proxy。
可选的 protocol:// 前缀可用于指定其他 proxy 协议（例如 https、socks4、socks5；请参见文档；协议前缀支持是在 cURL 7.21.7 中添加的）。如果未指定协议，proxy 将被视为 HTTP proxy。如果指定了错误的协议，连接将失败，该监控项将变为不受支持。
默认使用 1080 端口。
如果指定了 proxy，它将覆盖与 proxy 相关的环境变量，如 http_proxy、HTTPS_PROXY。如果未指定，则 proxy 不会覆盖与 proxy 相关的环境变量。输入的值会按“原样”传递，不会进行有效性检查。
注意，HTTP proxy 仅支持简单认证。
支持的宏：{HOST.IP}、{HOST.CONN}、{HOST.DNS}、{HOST.HOST}、{HOST.NAME}、{HOST.PORT}、{ITEM.ID}、{ITEM.KEY}、{ITEM.KEY.ORIG}、用户宏、低级别发现宏。
这会设置 CURLOPT_PROXY cURL 选项。
HTTP authentication 选择认证选项：
None - 不使用认证；
Basic - 使用基本认证；
NTLM - 使用 NTLM (Windows NT LAN Manager) 认证；
Kerberos - 使用 Kerberos 认证（另请参见：使用 Zabbix 配置 Kerberos）；
Digest - 使用 Digest 认证。
这会设置 CURLOPT_HTTPAUTH cURL 选项。
User name 输入用户名（最多 255 个字符）。
当 HTTP authentication 设置为 Basic、NTLM、Kerberos 或 Digest 时，此字段可用。支持用户宏和低级别发现宏。
Password 输入用户密码（最多 255 个字符）。
当 HTTP authentication 设置为 Basic、NTLM、Kerberos 或 Digest 时，此字段可用。支持用户宏和低级别发现宏。
SSL verify peer 勾选此复选框以验证 web 服务器的 SSL 证书。服务器证书将自动从系统范围的证书颁发机构（CA）位置获取。您可以使用 Zabbix 服务器或 proxy 配置参数 SSLCALocation 覆盖 CA 文件位置。
这会设置 CURLOPT_SSL_VERIFYPEER cURL 选项。
SSL verify host 勾选此复选框以验证 web 服务器证书的 Common Name 字段或 Subject Alternate Name 字段是否匹配。
这会设置 CURLOPT_SSL_VERIFYHOST cURL 选项。
SSL certificate file 用于客户端认证的 SSL 证书文件名。证书文件必须为 PEM1 格式。如果证书文件中也包含私钥，请将 SSL key file 字段留空。如果密钥已加密，请在 SSL key password 字段中指定密码。包含此文件的目录由 Zabbix 服务器或 proxy 配置参数 SSLCertLocation 指定。
支持的宏：{HOST.IP}、{HOST.CONN}、{HOST.DNS}、{HOST.HOST}、{HOST.NAME}、{HOST.PORT}、{ITEM.ID}、{ITEM.KEY}、{ITEM.KEY.ORIG}、用户宏、低级别发现宏。
这会设置 CURLOPT_SSLCERT cURL 选项。
SSL key file 用于客户端认证的 SSL 私钥文件名。私钥文件必须为 PEM1 格式。包含此文件的目录由 Zabbix 服务器或 proxy 配置参数 SSLKeyLocation 指定。
支持的宏：{HOST.IP}、{HOST.CONN}、{HOST.DNS}、{HOST.HOST}、{HOST.NAME}、{HOST.PORT}、{ITEM.ID}、{ITEM.KEY}、{ITEM.KEY.ORIG}、用户宏、低级别发现宏。
这会设置 CURLOPT_SSLKEY cURL 选项。
SSL key password SSL 私钥文件密码。
支持的宏：用户宏、低级别发现宏。
这会设置 CURLOPT_KEYPASSWD cURL 选项。
Timeout Zabbix 处理该 URL 的时间不会超过设定值（1-600 秒）。实际上，此参数定义了连接到该 URL 的最大时间以及执行 HTTP 请求的最大时间。因此，Zabbix 在一次检查中花费的时间不会超过 2 x Timeout 秒。
这会设置 CURLOPT_TIMEOUT cURL 选项。
有关 Timeout 参数的更多信息，请参见通用监控项属性。
Enable trapping 勾选此复选框后，该监控项也将作为 trapper 监控项工作，并接受通过 Zabbix sender 工具或 Zabbix sender 协议发送到 Zabbix 服务器或 proxy 的数据，或者接受通过 history.push API 方法发送到 Zabbix 服务器的数据。有关发送数据的更多信息，请参见：Trapper 监控项。
Allowed hosts 仅在勾选 Enable trapping 复选框时可见。
以逗号分隔的 IP 地址列表（可选使用 CIDR 表示法）或 DNS 名称。

默认值为用户宏 {$TRAPPER.ALLOWED_HOSTS}。默认情况下，{$TRAPPER.ALLOWED_HOSTS} 为 127.0.0.1,::1。您可以直接在字段中输入地址，或更改宏值。如果留空，将拒绝来自所有主机的传入连接。如果指定，则仅接受此处列出的主机发起的传入连接。
如果启用了 IPv6 支持，则 127.0.0.1、::127.0.0.1、::ffff:127.0.0.1 视为相同，且 ::/0 将允许任何 IPv4 或 IPv6 地址。
0.0.0.0/0 可用于允许任何 IPv4 地址。
请注意，支持“IPv4-compatible IPv6 addresses”（0000::/96 前缀），但已被 RFC4291 弃用。
示例：127.0.0.1、192.168.1.0/24、192.168.3.1-255、192.168.1-10.1-255、::1、2001:db8::/32、mysqlserver1、zabbix.example.com、{HOST.HOST}
此字段允许使用空格和用户宏。
此字段允许使用主机宏：{HOST.HOST}、{HOST.NAME}、{HOST.IP}、{HOST.DNS}、{HOST.CONN}。

如果 HTTP proxy 字段留空，使用 HTTP proxy 的另一种方法是设置与 proxy 相关的环境变量。

对于 HTTP - 为 Zabbix 服务器用户设置 http_proxy 环境变量。 例如：
http_proxy=http://proxy_ip:proxy_port。

对于 HTTPS - 设置 HTTPS_PROXY 环境变量。 例如：
HTTPS_PROXY=http://proxy_ip:proxy_port。 更多详细信息可通过运行 shell 命令查看：# man curl。

[1] Zabbix 仅支持 PEM 格式的证书和私钥文件。 如果您的证书和私钥数据位于 PKCS #12 格式文件中（通常扩展名为 *.p12 或 *.pfx），可以使用以下命令从中生成 PEM 文件：

openssl pkcs12 -in ssl-cert.p12 -clcerts -nokeys -out ssl-cert.pem
openssl pkcs12 -in ssl-cert.p12 -nocerts -nodes  -out ssl-cert.key

示例

示例 1

发送简单的 GET 请求以从 Elasticsearch 等服务检索数据：

  • 创建一个 GET 监控项，URL 为：localhost:9200/?pretty
  • 注意响应：
    {
      "name" : "YQ2VAY-",
      "cluster_name" : "elasticsearch",
      "cluster_uuid" : "kH4CYqh5QfqgeTsjh2F9zg",
      "version" : {
        "number" : "6.1.3",
        "build_hash" : "af51318",
        "build_date" : "2018-01-26T18:22:55.523Z",
        "build_snapshot" : false,
        "lucene_version" : "7.1.0",
        "minimum_wire_compatibility_version" : "5.6.0",
        "minimum_index_compatibility_version" : "5.0.0"
      },
      "tagline" : "You know, for search"
    }
  • 现在使用 JSONPath 预处理步骤提取版本号：$.version.number
示例 2

发送简单的 POST 请求，从 Elasticsearch 等服务中检索数据：

  • 创建一个 POST 监控项，URL 为：http://localhost:9200/str/values/_search?scroll=10s
  • 配置以下 POST 请求体以获取处理器负载（每个核心 1 分钟平均值）
    {
        "query": {
            "bool": {
                "must": [{
                    "match": {
                        "itemid": 28275
                    }
                }],
                "filter": [{
                    "range": {
                        "clock": {
                            "gt": 1517565836,
                            "lte": 1517566137
                        }
                    }
                }]
            }
        }
    }
  • 返回结果：
    {
        "_scroll_id": "DnF1ZXJ5VGhlbkZldGNoBQAAAAAAAAAkFllRMlZBWS1UU1pxTmdEeGVwQjRBTFEAAAAAAAAAJRZZUTJWQVktVFNacU5nRHhlcEI0QUxRAAAAAAAAACYWWVEyVkFZLVRTWnFOZ0R4ZXBCNEFMUQAAAAAAAAAnFllRMlZBWS1UU1pxTmdEeGVwQjRBTFEAAAAAAAAAKBZZUTJWQVktVFNacU5nRHhlcEI0QUxR",
        "took": 18,
        "timed_out": false,
        "_shards": {
            "total": 5,
            "successful": 5,
            "skipped": 0,
            "failed": 0
        },
        "hits": {
            "total": 1,
            "max_score": 1.0,
            "hits": [{
                "_index": "dbl",
                "_type": "values",
                "_id": "dqX9VWEBV6sEKSMyk6sw",
                "_score": 1.0,
                "_source": {
                    "itemid": 28275,
                    "value": "0.138750",
                    "clock": 1517566136,
                    "ns": 25388713,
                    "ttl": 604800
                }
            }]
        }
    }
  • 现在使用 JSONPath 预处理步骤获取监控项值：$.hits.hits[0]._source.value
示例 3

使用 apiinfo.version 检查 Zabbix API 是否存活。

  • 监控项配置：

注意这里使用了带有 JSON 数据的 POST 方法，设置请求头，并要求仅返回响应头：

  • 使用正则表达式对监控项值进行预处理，以获取 HTTP 状态码：

  • 在 Latest data 中检查结果：

示例 4

通过连接 Openweathermap 公共服务获取天气信息。

  • 配置一个主监控项，用于在单个 JSON 中批量收集数据：

请注意在查询字段中使用宏。 有关如何填写，请参阅 Openweathermap API。

HTTP agent 返回的示例 JSON：

{
    "body": {
        "coord": {
            "lon": 40.01,
            "lat": 56.11
        },
        "weather": [{
            "id": 801,
            "main": "Clouds",
            "description": "few clouds",
            "icon": "02n"
        }],
        "base": "stations",
        "main": {
            "temp": 15.14,
            "pressure": 1012.6,
            "humidity": 66,
            "temp_min": 15.14,
            "temp_max": 15.14,
            "sea_level": 1030.91,
            "grnd_level": 1012.6
        },
        "wind": {
            "speed": 1.86,
            "deg": 246.001
        },
        "clouds": {
            "all": 20
        },
        "dt": 1526509427,
        "sys": {
            "message": 0.0035,
            "country": "RU",
            "sunrise": 1526432608,
            "sunset": 1526491828
        },
        "id": 487837,
        "name": "Stavrovo",
        "cod": 200
    }
}

下一步是配置依赖监控项，从 JSON 中提取数据。

  • 配置一个用于湿度的示例依赖监控项：

其他天气指标，例如“Temperature”，也以相同方式添加。

  • 使用 JSONPath 的示例依赖监控项值预处理：

  • 在 Latest data 中查看天气数据结果：

示例 5

连接到 Nginx 状态页面并批量获取其指标。

  • 按照 官方指南 配置 Nginx。
  • 配置一个用于批量数据采集的主监控项：

Nginx stub status 输出示例：

Active connections: 1 Active connections:
server accepts handled requests
 52 52 52 
Reading: 0 Writing: 1 Waiting: 0

下一步是配置用于提取数据的依赖监控项。

  • 配置一个每秒请求数的依赖监控项示例：

  • 使用正则表达式 server accepts handled requests\s+([0-9]+) ([0-9]+) ([0-9]+) 的依赖监控项值预处理示例：

  • 在 Latest data 中查看来自 stub 模块的完整结果：