9 HTTP agent

概述

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

HTTP 监控项 检查由 Zabbix server 执行。然而，当由 Zabbix proxy 监控 主机 时，HTTP 监控项 检查则由 proxy 执行。

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

HTTP agent 同时支持 HTTP 和 HTTPS。Zabbix 可选择性地跟随重定向（参见下面的“跟随重定向”选项）。最大重定向次数硬编码为 10（使用 cURL 选项 CURLOPT_MAXREDIRS）。

Zabbix server/proxy 必须首先配置 cURL（libcurl）支持。

HTTP 检查是异步执行的 —— 不需要等待一个请求的响应完成后再启动其他检查。DNS 解析也是异步的。

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

异步 HTTP agent 轮询器的数量由 starthttpagentpollers 参数定义。

自 Zabbix 7 起，HTTP agent 检查中引入了持久连接的 cURL 特性。0

配置

要配置 HTTP 监控项：

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

所有必填输入字段均以红色星号标记。

HTTP 监控项需要特定信息的字段如下：

参数 描述
类型 在此处选择 HTTP agent。
键值 输入唯一的监控项键值。
URL 要连接并从中检索数据的 URL。例如：
https://www.example.com
http://www.example.com/download
域名可以使用 Unicode 字符指定。执行 HTTP 检查时，域名会自动转换为 ASCII 格式的 punycode。
可以使用 解析 按钮将可选查询字段（例如 ?key=value&limit=10）与 URL 分离，并将属性和值移至 查询字段，以便自动进行 URL 编码。
出于安全原因，请勿在 URL 中包含实际的用户名或密码。请改用用户宏，以避免凭据泄露。
限制为 2048 个字符。
支持的宏：{HOST.IP}、{HOST.CONN}、{HOST.DNS}、{HOST.HOST}、{HOST.NAME}、{HOST.PORT}、{ITEM.ID}、{ITEM.KEY}、{ITEM.KEY.ORIG}、用户宏、低级别发现宏。
此项设置 CURLOPT_URL cURL 选项。
查询字段 URL 的变量（见上文）。
指定为属性和值对。
值会自动进行 URL 编码。宏中的值会先解析，然后自动进行 URL 编码。
支持的宏：{HOST.IP}、{HOST.CONN}、{HOST.DNS}、{HOST.HOST}、{HOST.NAME}、{ITEM.ID}、{ITEM.KEY}、{ITEM.KEY.ORIG}、用户宏、低级别发现宏。
此项设置 CURLOPT_URL cURL 选项。
请求类型 选择请求方法类型：GET、POST、PUT 或 HEAD。
请求正文类型 选择请求正文类型：
原始数据 - 自定义 HTTP 请求正文，会替换宏，但不会执行编码
JSON 数据 - JSON 格式的 HTTP 请求正文。宏可以用作字符串、数字、true 和 false；用作字符串的宏必须用双引号括起来。宏中的值会先解析，然后自动进行转义。如果标头中未指定 "Content-Type"，则默认为 "Content-Type: application/json"
XML 数据 - XML 格式的 HTTP 请求正文。宏可以用作文本节点、属性或 CDATA 部分。宏中的值会先解析，然后在文本节点和属性中自动进行转义。如果标头中未指定 "Content-Type"，则默认为 "Content-Type: application/xml"
请注意，选择 XML 数据 需要 libxml2。
请求正文 输入请求正文。
支持的宏：{HOST.IP}、{HOST.CONN}、{HOST.DNS}、{HOST.HOST}、{HOST.NAME}、{ITEM.ID}、{ITEM.KEY}、{ITEM.KEY.ORIG}、用户宏、低级别发现宏。
标头 执行请求时将发送的自定义 HTTP 标头。
指定为属性和值对。
支持的宏：{HOST.IP}、{HOST.CONN}、{HOST.DNS}、{HOST.HOST}、{HOST.NAME}、{ITEM.ID}、{ITEM.KEY}、{ITEM.KEY.ORIG}、用户宏、低级别发现宏。
此项设置 CURLOPT_HTTPHEADER cURL 选项。
所需状态码 预期 HTTP 状态码列表。如果 Zabbix 获取的状态码不在列表中，监控项将变为不支持。如果为空，则不执行检查。
例如：200,201,210-299
列表中支持的宏：用户宏、低级别发现宏。
此项使用 CURLINFO_RESPONSE_CODE cURL 选项。
跟随重定向 选中此复选框以跟随 HTTP 重定向。
此项设置 CURLOPT_FOLLOWLOCATION cURL 选项。
检索模式 选择必须检索的响应部分：
正文 - 仅正文
标头 - 仅标头
正文和标头 - 正文和标头。
转换为 JSON 如果 检索模式 未设置为 正文，则标头会作为属性和值对保存在 "header" 键下。
如果遇到 'Content-Type: application/json'，则正文会保存为对象，否则会保存为字符串，例如：
HTTP proxy 可以指定要使用的 HTTP proxy，格式为 [protocol://][username[:password]@]proxy.example.com[:port]。
可选的 protocol:// 前缀可用于指定其他 proxy 协议（例如 https、socks4、socks5；请参阅文档；cURL 7.21.7 添加了协议前缀支持）。如果未指定协议，proxy 将被视为 HTTP proxy。如果指定了错误的协议，连接将失败，监控项将变为不支持。
默认使用端口 1080。
如果指定了 proxy，它将覆盖 http_proxy、HTTPS_PROXY 等与 proxy 相关的环境变量。如果未指定 proxy，则不会覆盖与 proxy 相关的环境变量。输入的值会按“原样”传递，不会执行合理性检查。
请注意，HTTP proxy 仅支持简单身份验证。
支持的宏：{HOST.IP}、{HOST.CONN}、{HOST.DNS}、{HOST.HOST}、{HOST.NAME}、{ITEM.ID}、{ITEM.KEY}、{ITEM.KEY.ORIG}、用户宏、低级别发现宏。
此项设置 CURLOPT_PROXY cURL 选项。
HTTP 身份验证 选择身份验证选项：
无 - 不使用身份验证；
Basic - 使用基本身份验证；
NTLM - 使用 NTLM（Windows NT LAN Manager）身份验证；
Kerberos - 使用 Kerberos 身份验证（另请参阅：使用 Zabbix 配置 Kerberos）；
Digest - 使用摘要身份验证。
此项设置 CURLOPT_HTTPAUTH cURL 选项。
用户名 输入用户名（最多 255 个字符）。
当 HTTP 身份验证 设置为 Basic、NTLM、Kerberos 或 Digest 时，此字段可用。支持用户宏和低级别发现宏。
密码 输入用户密码（最多 255 个字符）。
当 HTTP 身份验证 设置为 Basic、NTLM、Kerberos 或 Digest 时，此字段可用。支持用户宏和低级别发现宏。
SSL 验证对等方 选中此复选框以验证 web 服务器的 SSL 证书。服务器证书会根据系统范围 CA 位置中的受信任证书颁发机构（CA）证书进行验证。可以使用 Zabbix 服务器或 proxy 配置参数 SSLCALocation 覆盖 CA 文件的位置。
此项设置 CURLOPT_SSL_VERIFYPEER cURL 选项。
SSL 验证主机 选中此复选框以验证 web 服务器证书的 Common Name 字段或 Subject Alternate Name 字段是否匹配。
此项设置 CURLOPT_SSL_VERIFYHOST cURL 选项。
SSL 证书文件 用于客户端身份验证的 SSL 证书文件名称。证书文件必须采用 PEM1 格式。如果证书文件还包含私钥，请将 SSL 密钥文件 字段留空。如果密钥已加密，请在 SSL 密钥密码 字段中指定密码。包含此文件的目录由 Zabbix 服务器或 proxy 配置参数 SSLCertLocation 指定。
支持的宏：{HOST.IP}、{HOST.CONN}、{HOST.DNS}、{HOST.HOST}、{HOST.NAME}、{ITEM.ID}、{ITEM.KEY}、{ITEM.KEY.ORIG}、用户宏、低级别发现宏。
此项设置 CURLOPT_SSLCERT cURL 选项。
SSL 密钥文件 用于客户端身份验证的 SSL 私钥文件名称。私钥文件必须采用 PEM1 格式。包含此文件的目录由 Zabbix 服务器或 proxy 配置参数 SSLKeyLocation 指定。
支持的宏：{HOST.IP}、{HOST.CONN}、{HOST.DNS}、{HOST.HOST}、{HOST.NAME}、{ITEM.ID}、{ITEM.KEY}、{ITEM.KEY.ORIG}、用户宏、低级别发现宏。
此项设置 CURLOPT_SSLKEY cURL 选项。
SSL 密钥密码 SSL 私钥文件密码。
支持的宏：用户宏、低级别发现宏。
此项设置 CURLOPT_KEYPASSWD cURL 选项。
超时 Zabbix 处理 URL 所用的时间不会超过设定值（1-600 秒）。实际上，此参数定义了与 URL 建立连接的最长时间以及执行 HTTP 请求的最长时间。因此，Zabbix 对一次检查所用的时间不会超过 2 x 超时 秒。
此项设置 CURLOPT_TIMEOUT cURL 选项。
有关 超时 参数的更多信息，请参阅监控项常规属性。
启用捕获 选中此复选框后，该监控项还将作为 trapper 监控项运行，并接受使用 Zabbix sender 工具或 Zabbix sender 协议发送到 Zabbix 服务器或 proxy 的数据，或者接受使用 history.push API 方法发送到 Zabbix 服务器的数据。有关发送数据的更多信息，请参阅：Trapper 监控项。
允许的主机 仅当选中 启用捕获 复选框时可见。
以逗号分隔的 IP 地址列表（可选择使用 CIDR 表示法）或 DNS 名称。
如果指定了此项，则仅接受来自此处列出的主机的传入连接。
如果启用了 IPv6 支持，则 127.0.0.1、::127.0.0.1、::ffff:127.0.0.1 将被视为相同，并且 ::/0 将允许任何 IPv4 或 IPv6 地址。
可以使用 0.0.0.0/0 允许任何 IPv4 地址。
请注意，RFC4291 支持但已弃用“IPv4 兼容的 IPv6 地址”（0000::/96 前缀）。
示例：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 字段留空，还可以通过设置与 proxy 相关的环境变量来使用 HTTP 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 数值： $.version.number
示例2

向类似 Elasticsearch 的服务发送简单的 POST 请求以检索数据：

  • 创建一个带有如下 URL 的 POST 监控项： 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 预处理步骤来 get 监控项 值： $.hits.hits[0]._source.value
示例3

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

  • 监控项 配置：

请注意使用带有 JSON 数据的 POST 方法，设置请求头并要求仅返回头信息：

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

  • 在 最新数据 中检查结果：

示例4

通过连接到Openweathermap公共服务检索天气信息。

  • 配置一个主监控项以在单个JSON中进行批量数据收集：

请注意query字段中宏的使用。有关如何填写它们，请参阅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中提取数据的依赖项监控项。

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

其他天气指标如'温度'以相同方式添加。

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

  • 在最新数据中检查天气数据的结果：

示例5

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

  • 按照 official guide 中的说明配置 nginx。
  • 配置一个主 监控项 用于批量数据收集：

示例 nginx stub 状态输出：

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 模块的完整结果：