配置轻量级监控

type
("http" | "icmp" | "tcp")

必需。要运行的监控类型。以下之一

id
(字符串)

必需。此配置的唯一标识符。无论对任何配置字段进行更改，都不应随监控配置的编辑而更改。

示例:

id: uploader-service

id: https://example.net

name
(字符串)

此监控的人工可读名称。

示例:

name: Uploader service

name: Example website

service.name
(字符串)

此监控的 APM 服务名称。对应于 service.name ECS 字段。在监控也使用 APM 的应用程序时设置此项，以启用 Kibana 中 Synthetics 和 APM 数据之间的集成。

enabled
(布尔值)

是否启用监控。

默认值: true

示例:

enabled: false

schedule
(持续时间)

必需。任务计划。

示例:
从监控启动时起每 5 分钟运行一次任务。

schedule: @every 5m

timeout
(持续时间)

每次 ping 测试的总运行时间。这是允许测试连接和交换数据的总时间。

默认值: 16s

示例:

timeout: 2m

tags
(字符串列表)

将与监控事件一起发送的标签列表。

示例:

tags:
  - tag one
  - tag two

tags: ["tag one", "tag two"]

mode
("any" | "all")

运行监控的两种模式之一

默认值: any

示例:
如果您使用的是 DNS 负载均衡器并且想要 ping 指定主机名的每个 IP 地址，则应使用 all。

ipv4
(布尔值)

如果配置了主机名，是否使用 ipv4 协议进行 ping。

默认值: true

示例:

ipv4: false

ipv6
(布尔值)

如果配置了主机名，是否使用 ipv6 协议进行 ping。

默认值: true

示例:

ipv6: false

alert

启用或禁用此监控上的警报。阅读警报中的更多警报信息。

retest_on_failure
(布尔值)

在监控失败时启用或禁用重新测试。默认值为 true。

默认情况下，如果监控从“正常”变为“异常”，则会自动重新测试监控。如果重新测试的结果也为“异常”，则会创建一个错误，并且如果已配置，则会发送警报。然后，监控将按照定义的计划恢复运行。使用 retestOnFailure 可以减少与瞬时问题相关的噪音。

示例:

retest_on_failure: false

locations
(SyntheticsLocationsType 列表)

在何处部署监控。您可以在多个位置部署监控，以检测这些位置之间的可用性和响应时间的差异。

要列出可用位置，您可以

示例:

locations: ["japan", "india"]

locations:
  - japan
  - india

private_locations
(字符串列表)

监视器将部署到的私有位置。这些私有位置是指您托管和管理的地点，而 locations 由 Elastic 托管。您可以使用位置的名称指定私有位置。

要列出可用的私有位置，您可以

示例:

private_locations: ["Private Location 1", "Private Location 2"]

private_locations:
  - Private Location 1
  - Private Location 2

fields

将随每个监视器事件发送的键值对列表。
fields 作为 labels 附加到 Elasticsearch 文档中，
这些标签显示在 Kibana 的监视器详细信息面板中的
各个监视器的概览选项卡中.

示例:

fields:
  foo: bar
  team: synthetics

fields.foo: bar
fields.team: synthetics

urls
(字符串)

必需。要 ping 的 URL。

max_redirects
(数字)

Synthetics 将遵循的总重定向次数。

默认情况下，Synthetics 不会遵循重定向，但会报告重定向的状态。如果设置为大于 0 的数字，Synthetics 将遵循该数字的重定向。

当此选项设置为大于 0 的值时，将不再报告 monitor.ip 字段，因为跨多个 IP 的多个 DNS 请求可能会返回多个 IP。也不会记录精细的网络计时数据，因为使用重定向，该数据将跨越多个请求。具体来说，将省略 http.rtt.content.us、http.rtt.response_header.us、http.rtt.total.us、http.rtt.validate.us、http.rtt.write_request.us 和 dns.rtt.us 字段。

默认值：0

proxy_headers

在 CONNECT 请求期间发送到代理的其他标头。

proxy_url
(字符串)

HTTP 代理 URL。此设置是可选的。

示例:

https://proxy.mydomain.com:3128

username
(字符串)

用于向服务器进行身份验证的用户名。凭据随请求一起传递。此设置是可选的。

当您的 check.response 设置需要时，您需要指定凭据。例如，您可以在不设置凭据的情况下检查 403 响应 (check.response.status: [403])。

password
(字符串)

用于向服务器进行身份验证的密码。此设置是可选的。

ssl
(SSL)

用于 HTTPS 端点的 TLS/SSL 连接设置。如果您不指定设置，则使用系统默认值。

示例:

- type: http
  id: my-http-service
  name: My HTTP Service
  urls: "https://myhost:443"
  schedule: '@every 5s'
  ssl:
    certificate_authorities: ['/etc/ca.crt']
    supported_protocols: ["TLSv1.0", "TLSv1.1", "TLSv1.2"]

headers
(布尔值)

控制 HTTP 响应标头 http.response.body.headers 字段的索引。将 response.include_headers 设置为 false 以禁用。

默认值: true

response

控制 HTTP 响应正文内容到 http.response.body.contents 字段的索引。

check

hosts
(字符串)

必需。要 ping 的主机。

示例:

hosts: "myhost"

wait
(持续时间)

如果未收到响应，则在发出另一个 ICMP 回显请求之前等待的时间。

默认值：1s

示例:

wait: 1m

hosts
(字符串)

必需。要 ping 的主机。该值可以是

示例:

hosts: "localhost:8000"

hosts: "tcp://127.0.0.1:8000"

check

要发送到远程主机的可选负载字符串和预期的答案。如果未指定负载，则如果连接尝试成功，则假定端点可用。如果在没有 receive 的情况下指定 send，则任何响应都被视为 OK。如果在没有 send 的情况下指定 receive，则不发送任何负载，但客户端希望在连接时接收“hello 消息”或“banner”形式的负载。

示例:

check.send: 'Hello World'
check.receive: 'Hello World'

check:
  send: 'Hello World'
  receive: 'Hello World'

proxy_url

连接到服务器时要使用的 SOCKS5 代理的 URL。该值必须是 scheme 为 socks5:// 的 URL。

如果 SOCKS5 代理服务器需要客户端身份验证，则可以将用户名和密码嵌入到 URL 中。

使用代理时，主机名在代理服务器上解析，而不是在客户端上解析。您可以通过设置 proxy_use_local_resolver 选项来更改此行为。

示例:

需要客户端身份验证的代理 URL

proxy_url: socks5://user:password@socks5-proxy:2233

proxy_use_local_resolver
(布尔值)

一个布尔值，用于确定主机名是在本地解析还是在代理服务器上解析。默认值为 false，这意味着名称解析发生在代理服务器上。

默认值：false

ssl
(SSL)

TLS/SSL 连接设置。如果监视器配置为使用 SSL，它将尝试 SSL 握手。如果未配置 check，则监视器只会检查是否可以建立 SSL/TLS 连接。此检查可能在 TCP 级别或证书验证期间失败。

示例:

ssl:
  certificate_authorities: ['/etc/ca.crt']
  supported_protocols: ["TLSv1.0", "TLSv1.1", "TLSv1.2"]

另请参阅 配置 SSL，了解有关 ssl 选项的完整说明。