文档文档

Kapacitor

设置事件处理程序

通过将告警消息发送到支持的事件处理程序，将 Kapacitor 集成到您的监控系统中。目前，Kapacitor 可以将告警消息发送到特定的日志文件和特定的 URL，以及诸如 Slack 和 HipChat 等应用程序。

本文档提供了使用 Kapacitor 设置事件处理程序的逐步说明，包括相关的配置选项和 TICKscript 语法。目前，本文档并未涵盖所有支持的事件处理程序，但我们将随着时间的推移继续向此页面添加内容。有关支持的事件处理程序的完整列表和更多信息，请参阅事件处理程序参考文档。

HipChat 设置
Telegram 设置

HipChat 设置

HipChat 是 Atlassian 提供的用于群聊、视频聊天和屏幕共享的 Web 服务。配置 Kapacitor 以将告警消息发送到 HipChat 聊天室。

要求

要使用 HipChat 配置 Kapacitor，您需要：

  • 您的 HipChat 子域名名称
  • 您的 HipChat 聊天室名称
  • 用于发送通知的 HipChat API 访问令牌

HipChat API 访问令牌

以下步骤描述了如何创建 API 访问令牌。

  1. 从 HipChat 主页，点击右上角的人物图标访问帐户设置。

  2. 从左侧菜单栏的项目中选择 API 访问。

  3. 在 创建新令牌 下，输入令牌的标签（可以是任何内容）。

  4. 在 创建新令牌 下，选择 发送通知 作为范围。

  5. 点击 创建。

    您的令牌将出现在 创建新令牌 部分上方的表格中

    HipChat token

配置

在 Kapacitor 配置文件的 [hipchat] 部分中，设置：

  • enabled 为 true
  • url 设置中的 subdomain 为您的 HipChat 子域名

可选配置设置包括：

room
设置为您的 HipChat 聊天室。如果 TICKscript 未指定聊天室 ID，则此项用作默认聊天室 ID。

token
设置为您的 HipChat API 访问令牌。如果 TICKscript 未指定 API 访问令牌，则此项用作默认令牌。

global
设置为 true 以将所有告警发送到 HipChat，而无需在 TICKscript 中指定 HipChat。

state-changes-only
设置为 true 以仅在告警状态更改时才向 HipChat 发送告警。此设置仅在 global 设置也设置为 true 时适用。

示例配置

[hipchat]
  enabled = true
  url = "https://my-subdomain.hipchat.com/v2/room"
  room = "my-room"
  token = "mytokentokentokentoken"
  global = false
  state-changes-only = false

TICKscript 语法

|alert()
  .hipChat()
    .room('<HipChat-room>')
    .token('<HipChat-API-token>')

.room() 和 .token() 规范是可选的。如果未在 TICKscript 中设置，则它们默认为 kapacitor.conf 的 [hipchat] 部分中的 room 和 token 设置。

如果在配置文件中将 global 设置为 true，则无需在 TICKscript 中指定 .hipChat()。Kapacitor 默认将所有告警发送到 HipChat。

.room('<HipChat-room>')
设置 HipChat 聊天室。

.token('<HipChat-API-token>')
设置 HipChat API 访问令牌。

示例

将告警发送到配置文件中设置的 HipChat 聊天室

配置文件

[hipchat]
  enabled = true
  url = "https://testtest.hipchat.com/v2/room"
  room = "my-alerts"
  token = "tokentokentokentokentoken"
  global = false
  state-changes-only = true

TICKscript

stream
  |from()
    .measurement('cpu')
  |alert()
    .crit(lambda: "usage_idle" <  97)
    .message('Hey, check your CPU')
    .hipChat()

此设置将 Hey, check your CPU 发送到与 testest 子域名关联的 my-alerts 聊天室。

将告警发送到 TICKscript 中设置的 HipChat 聊天室

配置文件

[hipchat]
  enabled = true
  url = "https://testtest.hipchat.com/v2/room"
  room = "my-alerts"
  token = "tokentokentokentokentoken"
  global = false
  state-changes-only = true

TICKscript

stream
  |from()
    .measurement('cpu')
  |alert()
    .crit(lambda: "usage_idle" <  97)
    .message('Hey, check your CPU')
    .hipChat()
    .room('random')

此设置将 Hey, check your CPU 发送到与 testest 子域名关联的 random 聊天室。请注意，TICKscript 中的 .room() 会覆盖配置文件中的 room 设置。

Telegram 设置

Telegram 是一款消息应用程序。配置 Kapacitor 以将告警消息发送到 Telegram 机器人。

要求

要使用 Telegram 配置 Kapacitor，您需要：

  • 一个 Telegram 机器人
  • 一个 Telegram API 访问令牌
  • 您的 Telegram 聊天 ID

Telegram 机器人

以下步骤描述了如何创建一个新的 Telegram 机器人。

  1. 在您的 Telegram 应用程序中搜索 @BotFather 用户名。

  2. 点击 开始 以开始与 @BotFather 对话。

  3. 发送 /newbot 给 @BotFather。

    @BotFather 回复：

    好的，一个新的机器人。我们打算怎么称呼它？请为您的机器人选择一个名称。

    @BotFather 将提示您完成机器人创建过程的其余部分；您可以随意按照他的指示或继续执行我们提供的步骤版本。这两种设置都会成功！

  4. 将您的机器人的名称发送给 @BotFather。

    您机器人的名称可以是任何名称。请注意，这不是您机器人的 Telegram @username；您将在步骤 5 中创建用户名。

    @BotFather 回复：

    好的。现在让我们为您的机器人选择一个用户名。它必须以 bot 结尾。例如，像这样：TetrisBot 或 tetris_bot。

  5. 将您的机器人的用户名发送给 @BotFather。

    您机器人的用户名必须以 bot 结尾。例如：mushroomKap_bot。

    BotFather 回复：

    完成！祝贺您创建了新的机器人。您可以在 t.me/ 找到它。您现在可以为您的机器人添加描述、关于部分和个人资料图片，请参阅 /help 以获取命令列表。顺便说一句，当您完成创建酷炫机器人后，如果您想要更好的用户名，请 ping 我们的机器人支持。在您执行此操作之前，请确保机器人完全运行。

    使用此令牌访问 HTTP API

    有关 Bot API 的描述，请参阅此页面：https://core.telegram.org/bots/api

  6. 开始与您的机器人对话。

    点击 @BotFather 回复中的 t.me/<bot-username> 链接，然后在您的 Telegram 应用程序底部点击 开始。

    您新创建的机器人将出现在应用程序左侧的聊天列表中。

Telegram API 访问令牌

以下部分描述了如何识别或创建 API 访问令牌。

当您创建机器人时，Telegram 的 @BotFather 机器人会向您发送一个 API 访问令牌。请参阅上一节的步骤 5 中的 @BotFather 回复，以查找您的令牌的位置。如果您找不到 API 访问令牌，请使用以下步骤创建新令牌。

  1. 发送 /token 给 @BotFather

  2. 在您的 Telegram 应用程序底部选择相关的机器人。

    @BotFather 回复一个新的 API 访问令牌

    您可以使用此令牌访问 HTTP API

    有关 Bot API 的描述，请参阅此页面：https://core.telegram.org/bots/api

Telegram 聊天 ID

以下步骤描述了如何识别您的聊天 ID。

  1. 将以下链接粘贴到您的浏览器中。将 <API-access-token> 替换为您在上一步中识别或创建的 API 访问令牌

    https://api.telegram.org/bot<API-access-token>/getUpdates?offset=0

  2. 在 Telegram 应用程序中向您的机器人发送消息。消息文本可以是任何内容；您的聊天记录必须至少包含一条消息才能获取您的聊天 ID。

  3. 刷新您的浏览器。

  4. 在浏览器中提供的 JSON 中识别数字聊天 ID。在下面格式化的示例中，聊天 ID 为 123456789。

    {
  "ok": true,
  "result": [
    {
      "update_id": 101010101,
      "message": {
        "message_id": 2,
        "from": {
          "id": 123456789,
          "first_name": "Mushroom",
          "last_name": "Kap"
        },
        "chat": {
          "id": 123456789,
          "first_name": "Mushroom",
          "last_name": "Kap",
          "type": "private"
        },
        "date": 1487183963,
        "text": "hi"
      }
    }
  ]
}

配置

在 Kapacitor 配置文件的 [telegram] 部分中设置：

默认的 url 设置 (https://api.telegram.org/bot) 不需要额外的配置。

可选配置设置包括：

chat_id

设置为您的 Telegram 聊天 ID。如果 TICKscript 未指定聊天 ID，则此项用作默认聊天 ID。

parse-mode

对于 Markdown 格式或 HTML 格式的告警消息，设置为 Markdown 或 HTML。默认的 parse-mode 为 Markdown。

disable-web-page-preview

设置为 true 以禁用告警消息中的链接预览。

disable-notification

设置为 true 以禁用 iOS 设备上的通知并禁用 Android 设备上的声音。当设置为 true 时，Android 用户将继续接收通知。

global

设置为 true 以将所有告警发送到 Telegram，而无需在 TICKscript 中指定 Telegram。

state-changes-only

设置为 true 以仅在告警状态更改时才向 Telegram 发送告警。此设置仅在 global 设置也设置为 true 时适用。

示例配置

[telegram]
  enabled = true
  url = "https://api.telegram.org/bot"
  token = "abcdefghi:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  chat-id = "123456789"
  parse-mode = Markdown
  disable-web-page-preview = true
  disable-notification = false
  global = true
  state-changes-only = true

TICKscript 语法

|alert()
  .telegram()
    .chatId('<chat_id>')
    .disableNotification()
    .disableWebPagePreview()
    .parseMode(['Markdown' | 'HTML'])

.chatId()、.disableNotification()、.disableWebPagePreview() 和 .parseMode() 规范是可选的。如果未在 TICKscript 中设置，则它们默认为配置文件 [telegram] 部分中的 chat-id、disable-notification、disable-web-page-preview 和 parse-mode 设置。请注意，如果在配置文件中将 global 设置为 true，则无需在 TICKscript 中指定 .telegram()；Kapacitor 默认将所有告警发送到 Telegram。

.chatId('<chat_id>')
设置 Telegram 聊天 ID。

.disableNotification()
禁用 iOS 设备上的通知并禁用 Android 设备上的声音。Android 用户将继续接收通知。

.disableWebPagePreview()
禁用告警消息中的链接预览。

.parseMode(['Markdown' | 'HTML'])
将 Markdown 或 HTML 设置为告警消息的格式。

示例

将告警发送到配置文件中设置的 Telegram 聊天 ID

配置文件

[telegram]
  enabled = true
  url = "https://api.telegram.org/bot"
  token = "abcdefghi:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  chat-id = "123456789"
  parse-mode  = "Markdown"
  disable-web-page-preview = false
  disable-notification = false
  global = false
  state-changes-only = false

TICKscript

stream
  |from()
    .measurement('cpu')
  |alert()
    .crit(lambda: "usage_idle" < 97)
    .message('Might want to check your CPU')
    .telegram()

此设置将 Might want to check your CPU 发送到与聊天 ID 123456789 和 API 访问令牌 abcdefghi:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 关联的 Telegram 机器人。

将告警发送到 TICKscript 中设置的 Telegram 聊天 ID

配置文件

[telegram]
  enabled = true
  url = "https://api.telegram.org/bot"
  token = "abcdefghi:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  chat-id = ""
  parse-mode  = "Markdown"
  disable-web-page-preview = false
  disable-notification = false
  global = false
  state-changes-only = false

TICKscript

stream
  |from()
    .measurement('cpu')
  |alert()
    .crit(lambda: "usage_idle" < 97)
    .message('Might want to check your CPU')
    .telegram()
      .chatId('123456789')

此设置将 Might want to check your CPU 发送到与聊天 ID 123456789 和 API 访问令牌 abcdefghi:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 关联的 Telegram 机器人。

此页面是否对您有帮助？

感谢您的反馈！

© 2025 InfluxData, Inc.

您在哪里运行 InfluxDB？

选择您的 InfluxDB Cloud 区域和集群 或您的 InfluxDB OSS URL，我们将为您自定义代码示例。识别您的 InfluxDB Cloud 集群。

  • InfluxDB Cloud
  • InfluxDB OSS 或 Enterprise
AWS

  • 美国西部（俄勒冈）

GCP
Azure
默认
自定义

有关更多信息，请参阅 InfluxDB Cloud 区域 或 InfluxDB OSS URL。

感谢您的反馈！

请告诉我们如何做得更好

谢谢！

不用了，谢谢

Flux 的未来

Flux 即将进入维护模式。您可以继续像现在一样使用它，而无需对代码进行任何更改。

阅读更多

InfluxDB 3 开源版本现已公开发布 Alpha 版

InfluxDB 3 开源版本现已可用于 Alpha 测试，根据 MIT 或 Apache 2 许可获得许可。

我们正在发布两个作为 Alpha 版本一部分的产品。

InfluxDB 3 Core 是我们新的开源产品。它是一个用于时间序列和事件数据的最新数据引擎。InfluxDB 3 Enterprise 是一个商业版本，它建立在 Core 的基础上，增加了历史查询功能、读取副本、高可用性、可扩展性和细粒度的安全性。

有关如何开始使用的更多信息，请查看：