心跳输出插件
此插件通过 POST 以固定间隔向 HTTP 端点发送心跳信号。这对于跟踪大型部署中现有的 Telegraf 实例很有用。
引入于: Telegraf v1.37.0 标签: applications 操作系统支持: all
全局配置选项
插件支持其他全局和插件配置设置,用于修改指标、标签和字段,创建别名以及配置插件顺序等任务。更多详情请参阅 CONFIGURATION.md。
Secret-store 支持
此插件支持从 secret-stores 中获取 url, token 和 headers 选项的 secret。有关如何使用它们的更多详细信息,请参阅 secret-store 文档。
配置
# A plugin that can transmit heartbeats over HTTP
[[outputs.heartbeat]]
## URL of heartbeat endpoint
url = "http://monitoring.example.com/heartbeat"
## Unique identifier to submit for the Telegraf instance (required)
instance_id = "agent-123"
## Token for bearer authentication
# token = ""
## Interval for sending heartbeat messages
# interval = "1m"
## Information to include in the message, available options are
## hostname -- hostname of the instance running Telegraf
## statistics -- number of metrics, logged errors and warnings, etc
## configs -- redacted list of configs loaded by this instance
# include = ["hostname"]
## Additional HTTP headers
# [outputs.heartbeat.headers]
# User-Agent = "telegraf"每条心跳消息,每 interval 发送一次,至少包含指定的 Telegraf instance_id、Telegraf 版本以及用于消息的 JSON-Schema 版本。最新的 schema 可以在 插件目录 中找到。
可以通过 include 设置将额外信息包含在消息中。
某些信息,例如指标数量,仅在第一个刷新周期后更新,在解释消息时必须考虑这一点。
包含在心跳消息中的统计信息是自上次成功心跳以来累积的。如果无法发送心跳,数据累积将继续,直到下次成功发送。此外,在发送失败后的消息中,last 字段包含上次成功心跳的 Unix 时间戳,这允许您识别报告中的差距并计算速率。
配置信息
在消息中包含 configs 时,心跳消息将包含用于设置当前运行的 Telegraf 实例的配置源。
由于配置源包含路径或 URL,因此产生的心跳消息可能会很大。如果网络流量受限,请谨慎使用此选项!
在监视例如配置目录时,配置信息可能会发生变化,例如添加或删除新的配置。
配置 URL 会被重写,以删除用户名和密码信息。但是,敏感信息可能仍然包含在 URL 或发送的路径中。请谨慎使用!
此页面是否有帮助?
感谢您的反馈!
支持和反馈
感谢您成为我们社区的一员!我们欢迎并鼓励您对 Telegraf 和本文档提出反馈和 bug 报告。要获取支持,请使用以下资源
具有年度合同或支持合同的客户可以 联系 InfluxData 支持。