配置

Alertmanager 通过命令行标志和配置文件进行配置。命令行标志配置不可变的系统参数，配置文件定义抑制规则，通知路由和通知接收者。

visual editor 可以帮助构建路由树。

要查看所有可用的命令行标志，请运行alertmanager -h.

Alertmanager 可以在运行时重新加载配置。如果新配置格式不正确，则不会应用更改，且错误会被输出。通过发送SIGHUP信号到 Alertmanager 进程或发送 HTTP POST 请求到/-/reload端点触发配置重新加载。

配置文件

要指定要加载的配置文件，请使用--config.file标志。

  1. ./alertmanager --config.file=alertmanager.yml

该文件是 YAML 格式 的，由以下所述格式进行定义。方括号表示参数是可选的。对于非列表参数，该值设置为指定的默认值。

通用占位符定义如下:

  • <duration>: 可被正则表达式[0-9]+(ms|[smhdwy]匹配的一段时间
  • <labelname>: 可被正则表达式[a-zA-Z_][a-zA-Z0-9_]*匹配的字符串
  • <labelvalue>: unicode 字符串
  • <filename>: 当前工作目录中的合法的路径
  • <boolean>: 值为 true 或 false 的布尔值
  • <string>: 常规字符串
  • <secret>: 加密后的常规字符串，例如密码
  • <tmpl_string>: 使用前已被模版扩展的字符串
  • <tmpl_secret>: 使用前已被模版扩展的加密字符串

其他占位符分别指定。

提供的合法示例文件显示了上下文中的用法。

全局配置指定在所有其他配置上下文中有效的参数。它们还用作其他配置部分的默认设置。

  1. global:
  2.   # 默认的 SMTP From 头字段
  3.   [ smtp_from: <tmpl_string> ]
  4.   # 用于发送邮件的默认 SMTP 主机，包括端口号。
  5.   # 端口号通常为25，对于支持 TLS 的 SMTP(有时称为STARTTLS)为587
  6.   # 示例: smtp.example.org:587
  7.   [ smtp_smarthost: <string> ]
  8.   # 标识到 SMTP 服务器的默认主机名
  9.   [ smtp_hello: <string> | default = "localhost" ]
  10.   # SMTP 身份认证相关
  11.   # SMTP Auth using CRAM-MD5, LOGIN and PLAIN. If empty, Alertmanager doesn't authenticate to the SMTP server.
  12.   [ smtp_auth_username: <string> ]
  13.   # SMTP Auth using LOGIN and PLAIN.
  14.   [ smtp_auth_password: <secret> ]
  15.   # SMTP Auth using PLAIN.
  16.   [ smtp_auth_identity: <string> ]
  17.   # SMTP Auth using CRAM-MD5. 
  18.   [ smtp_auth_secret: <secret> ]
  19.   # SMTP 默认使用 TLS
  20.   # 请注意，Go不支持与远程 SMTP 端点的未加密连接
  21.   [ smtp_require_tls: <bool> | default = true ]
  23.   # 用于 Slack 通知的API URL
  24.   [ slack_api_url: <secret> ]
  25.   [ victorops_api_key: <secret> ]
  26.   [ victorops_api_url: <string> | default = "https://alert.victorops.com/integrations/generic/20131114/alert/" ]
  27.   [ pagerduty_url: <string> | default = "https://events.pagerduty.com/v2/enqueue" ]
  28.   [ opsgenie_api_key: <secret> ]
  29.   [ opsgenie_api_url: <string> | default = "https://api.opsgenie.com/" ]
  30.   [ hipchat_api_url: <string> | default = "https://api.hipchat.com/" ]
  31.   [ hipchat_auth_token: <secret> ]
  32.   [ wechat_api_url: <string> | default = "https://qyapi.weixin.qq.com/cgi-bin/" ]
  33.   [ wechat_api_secret: <secret> ]
  34.   [ wechat_api_corp_id: <string> ]
  36.   # 默认的 HTTP 配置
  37.   [ http_config: <http_config> ]
  39.   # 如果警报不设置 EndsAt，则 ResolveTimeout 是 Alertmanager 使用的默认值，经过此时间后，如果告警尚未更新，则可以将告警声明为已解决
  40.   # 这对 Prometheus 的告警没有任何影响，因为它们始终包含 EndsAt
  41.   [ resolve_timeout: <duration> | default = 5m ]
  43. # 从中读取自定义通知模板定义的文件.
  44. # 最后一个组件可以使用通配符匹配器,如 'templates/*.tmpl'.
  45. templates:
  46.   [ - <filepath> ... ]
  48. # 路由树的根节点
  49. route: <route>
  51. # 通知接收者列表.
  52. receivers:
  53.   - <receiver> ...
  55. # 告警抑制规则列表.
  56. inhibit_rules:
  57.   [ - <inhibit_rule> ... ]

<route>

路由配置块定义了路由树种的节点及其子节点。如果未设置，则其可选配置参数将从父节点继承。

每个警报都会在已配置的顶级路由处进入路由树，该路由树必须与所有警报匹配(即没有任何已配置的匹配器)。然后，它遍历子节点。如果continue设置为 false，它将在第一个匹配的子项之后停止。如果continue设置为 true，则告警将继续与后续的同级进行匹配。如果告警与节点的任何子节点都不匹配(不匹配的子节点或不存在子节点)，则根据当前节点的配置参数来处理告警。

  1. [ receiver: <string> ]
  2. # 用于将传入警报分组在一起的标签. 例如, 对于 cluster = A 和 alertname = LatencyHigh 的多个警报将被分为一个组
  3. #
  4. # 要按所有可能的标签进行汇总,请使用特殊值 '...' 作为唯一的标签名称.例如: 
  5. # group_by：['...']
  6. # 这样可以有效地完全禁用聚合,并按原样传递所有警报.除非您的警报量非常低或上游通知系统执行自己的分组规则,否则这不太可能是您想要的
  7. [ group_by: '[' <labelname>, ... ']' ]
  9. # 告警是否应继续匹配后续的同级节点
  10. [ continue: <boolean> | default = false ]
  12. # 告警必须满足等值匹配才能匹配节点
  13. match:
  14.   [ <labelname>: <labelvalue>, ... ]
  16. # 警必须满足正则匹配才能匹配节点
  17. match_re:
  18.   [ <labelname>: <regex>, ... ]
  20. # 为一组警报发送通知的最初等待时间.等待抑制告警到达或为同一组收集更多初始警报
  21. [ group_wait: <duration> | default = 30s ]
  23. # 发送有关新告警的通知之前要等待的时间.该通知将添加到已为其发送了初始通知的一组警报中
  24. [ group_interval: <duration> | default = 5m ]
  26. # 如果已成功发送告警通知,等待多长时间才能再次发送通知.
  27. [ repeat_interval: <duration> | default = 4h ]
  29. # 0 个或多个子路由.
  30. routes:
  31.   [ - <route> ... ]

示例 

  1. # 具有所有参数的根路由.如果未覆盖,则由子路由继承
  2. route:
  3.   receiver: 'default-receiver'
  4.   group_wait: 30s
  5.   group_interval: 5m
  6.   repeat_interval: 4h
  7.   group_by: [cluster, alertname]
  8.   # 与以下子路由不匹配的所有告警将保留在根节点上,并分派给 'default-receiver'.
  9.   routes:
  10.   # 所有带有 service = mysql或 service = cassandra 的告警都将分派到 'database-pager'
  11.   - receiver: 'database-pager'
  12.     group_wait: 10s
  13.     match_re:
  14.       service: mysql|cassandra
  15.   # 所有带有 team = frontend 标签的警报均与此子路由匹配.它们按 product 和 environment 分组,而不是按群集和警报名称分组
  16.   - receiver: 'frontend-pager'
  17.     group_by: [product, environment]
  18.     match:
  19.       team: frontend

<inhibit_rule>

当存在与另一组匹配器匹配的告警(source)时，抑制规则会使与一组匹配器匹配的告警(target)静音。目标告警和源告警在equal列表中的标签名称都必须具有相同的标签值。

从语义上说，缺少标签和带有空值的标签是同一件事。因此，如果源警报和目标警报都缺少所有equal列出的标签名称，则应用抑制规则。

为了防止告警抑制自身，抑制规则将永远不会抑制与规则的目标和源侧匹配的告警。但是，我们建议选择目标匹配器和源匹配器，以使警报永远不会匹配双方。这更加方便，并且不会触发这种特殊情况。

  1. # 必须在警报中满足的匹配器才能静音
  2. target_match:
  3.   [ <labelname>: <labelvalue>, ... ]
  4. target_match_re:
  5.   [ <labelname>: <regex>, ... ]
  7. # 必须存在一个或多个告警能使抑制生效的匹配器
  8. source_match:
  9.   [ <labelname>: <labelvalue>, ... ]
  10. source_match_re:
  11.   [ <labelname>: <regex>, ... ]
  13. # 必须在源告警和目标告警中具有相等值的标签才能使抑制生效
  14. [ equal: '[' <labelname>, ... ']' ]

<http_config>

http_config允许配置接收者用来与基于 HTTP API 服务进行通信的 HTTP 客户端。

  1. # 注意 `basic_auth`, `bearer_token` 和 `bearer_token_file` 选项是互斥的
  3. # 使用配置的用户名和密码设置 `Authorization` 请求头
  4. # password 和 password_file 是互斥的
  5. basic_auth:
  6.   [ username: <string> ]
  7.   [ password: <secret> ]
  8.   [ password_file: <string> ]
  10. # 使用配置的承载令牌设置 `Authorization` 请求头
  11. [ bearer_token: <secret> ]
  13. # 使用配置的承载令牌文件设置 `Authorization` 请求头
  14. [ bearer_token_file: <filepath> ]
  16. # TLS 配置
  17. tls_config:
  18.   [ <tls_config> ]
  20. # 可选的代理 URL.
  21. [ proxy_url: <string> ]

<tls_config>

tls_config允许配置 TLS 连接

  1. # 用于验证服务器证书的 CA 证书
  2. [ ca_file: <filename> ]
  4. # 用于服务器的客户端证书认证的证书和密钥文件
  5. [ cert_file: <filename> ]
  6. [ key_file: <filename> ]
  8. # ServerName 指定服务器的名称
  9. # https://tools.ietf.org/html/rfc4366#section-3.1
  10. [ server_name: <string> ]
  12. # 禁用服务器证书的验证
  13. [ insecure_skip_verify: <boolean> ]

<receiver>

receiver是一个或多个通知集成的命名配置。

我们不会积极添加新的接收器，我们建议通过 webhook receiver 实现自定义通知集成。

  1. # receiver 的唯一名称
  2. name: <string>
  4. # 多个通知集成的配置
  5. email_configs:
  6.   [ - <email_config>, ... ]
  7. hipchat_configs:
  8.   [ - <hipchat_config>, ... ]
  9. pagerduty_configs:
  10.   [ - <pagerduty_config>, ... ]
  11. pushover_configs:
  12.   [ - <pushover_config>, ... ]
  13. slack_configs:
  14.   [ - <slack_config>, ... ]
  15. opsgenie_configs:
  16.   [ - <opsgenie_config>, ... ]
  17. webhook_configs:
  18.   [ - <webhook_config>, ... ]
  19. victorops_configs:
  20.   [ - <victorops_config>, ... ]
  21. wechat_configs:
  22.   [ - <wechat_config>, ... ]

<email_config> 

  1. # 是否通知告警已解决.
  2. [ send_resolved: <boolean> | default = false ]
  4. # 发送通知的电子邮件地址.
  5. to: <tmpl_string>
  7. # 发件人地址.
  8. [ from: <tmpl_string> | default = global.smtp_from ]
  10. # 发送邮件的 SMTP 主机.
  11. [ smarthost: <string> | default = global.smtp_smarthost ]
  13. # SMTP 服务器的主机名标识.
  14. [ hello: <string> | default = global.smtp_hello ]
  16. # SMTP 认证信息.
  17. [ auth_username: <string> | default = global.smtp_auth_username ]
  18. [ auth_password: <secret> | default = global.smtp_auth_password ]
  19. [ auth_secret: <secret> | default = global.smtp_auth_secret ]
  20. [ auth_identity: <string> | default = global.smtp_auth_identity ]
  22. # SMTP TLS要求.
  23. # 请注意，Go不支持与远程 SMTP 端点的未加密连接
  24. [ require_tls: <bool> | default = global.smtp_require_tls ]
  26. # TLS 配置.
  27. tls_config:
  28.   [ <tls_config> ]
  30. # 邮件通知的HTML正文.
  31. [ html: <tmpl_string> | default = '{{ template "email.default.html" . }}' ]
  32. # 邮件通知的文本正文.
  33. [ text: <tmpl_string> ]
  35. # 电子邮件头键/值对。 覆盖先前由通知实现设置的所有请求头
  36. [ headers: { <string>: <tmpl_string>, ... } ]

<hipchat_config>

HipChat 通知使用 Build Your Own 集成.

  1. # 是否通知告警已解决.
  2. [ send_resolved: <boolean> | default = false ]
  4. # The HipChat Room ID.
  5. room_id: <tmpl_string>
  6. # The auth token.
  7. [ auth_token: <secret> | default = global.hipchat_auth_token ]
  8. # The URL to send API requests to.
  9. [ api_url: <string> | default = global.hipchat_api_url ]
  11. # See https://www.hipchat.com/docs/apiv2/method/send_room_notification
  12. # 除了发送人名称之外,还将显示的标签
  13. [ from:  <tmpl_string> | default = '{{ template "hipchat.default.from" . }}' ]
  14. # 消息体.
  15. [ message:  <tmpl_string> | default = '{{ template "hipchat.default.message" . }}' ]
  16. # 此消息是否应触发用户通知.
  17. [ notify:  <boolean> | default = false ]
  18. # 确定该消息如何被 alertmanager 处理并在 HipChat 中呈现.可选值是 'text' 和 'html'.
  19. [ message_format:  <string> | default = 'text' ]
  20. # 消息的背景色.
  21. [ color:  <tmpl_string> | default = '{{ if eq .Status "firing" }}red{{ else }}green{{ end }}' ]
  23. # HTTP 客户端的配置
  24. [ http_config: <http_config> | default = global.http_config ]

<pagerduty_config>

PagerDuty 通知是通过 PagerDuty API 发送的。PagerDuty 提供了有关如何集成的文档。Alertmanager v0.11 之后的版本重要的区别在于对PagerDuty的 Events API v2 的支持。

  1. # 是否通知告警已解决.
  2. [ send_resolved: <boolean> | default = true ]
  4. # 以下两个选项是互斥的
  5. # The PagerDuty integration key (when using PagerDuty integration type `Events API v2`).
  6. routing_key: <tmpl_secret>
  7. # The PagerDuty integration key (when using PagerDuty integration type `Prometheus`).
  8. service_key: <tmpl_secret>
  10. # The URL to send API requests to
  11. [ url: <string> | default = global.pagerduty_url ]
  13. # Alertmanager 的客户端标识
  14. [ client:  <tmpl_string> | default = '{{ template "pagerduty.default.client" . }}' ]
  15. # 到通知发送者的反向链接.
  16. [ client_url:  <tmpl_string> | default = '{{ template "pagerduty.default.clientURL" . }}' ]
  18. # 事件的描述.
  19. [ description: <tmpl_string> | default = '{{ template "pagerduty.default.description" .}}' ]
  21. # 通知时间的严重程度.
  22. [ severity: <tmpl_string> | default = 'error' ]
  24. # 一组任意键/值对,可提供有关事件的更多详细信息
  25. [ details: { <string>: <tmpl_string>, ... } | default = {
  26.   firing:       '{{ template "pagerduty.default.instances" .Alerts.Firing }}'
  27.   resolved:     '{{ template "pagerduty.default.instances" .Alerts.Resolved }}'
  28.   num_firing:   '{{ .Alerts.Firing | len }}'
  29.   num_resolved: '{{ .Alerts.Resolved | len }}'
  30. } ]
  32. # 附加到通知的图片.
  33. images:
  34.   [ <image_config> ... ]
  36. # 附加到通知的链接.
  37. links:
  38.   [ <link_config> ... ]
  40. # HTTP 客户端配置.
  41. [ http_config: <http_config> | default = global.http_config ]

<image_config>

这些字段记录在 PagerDuty API 文档中

  1. href: <tmpl_string>
  2. source: <tmpl_string>
  3. alt: <tmpl_string>

<link_config>

这些字段记录在 PagerDuty API 文档中

  1. href: <tmpl_string>
  2. text: <tmpl_string>

<pushover_config>

Pushover 通知是通过 Pushover API 发送的。

  1. # 是否通知告警已解决.
  2. [ send_resolved: <boolean> | default = true ]
  4. # 收件人的用户密钥
  5. user_key: <secret>
  7. # 您注册的应用程序的 API 令牌, 参阅 https://pushover.net/apps
  8. token: <secret>
  10. # 通知标题.
  11. [ title: <tmpl_string> | default = '{{ template "pushover.default.title" . }}' ]
  13. # 通知消息.
  14. [ message: <tmpl_string> | default = '{{ template "pushover.default.message" . }}' ]
  16. # 消息旁边显示的补充 URL
  17. [ url: <tmpl_string> | default = '{{ template "pushover.default.url" . }}' ]
  19. # 优先级, 参阅 https://pushover.net/api#priority
  20. [ priority: <tmpl_string> | default = '{{ if eq .Status "firing" }}2{{ else }}0{{ end }}' ]
  22. # Pushover 服务器多久发送一次相同的通知给用户
  23. # 必须至少 30 秒
  24. [ retry: <duration> | default = 1m ]
  26. # 除非用户确认通知,否则将继续重试通知的时间
  27. [ expire: <duration> | default = 1h ]
  29. # HTTP 客户端配置.
  30. [ http_config: <http_config> | default = global.http_config ]

<slack_config>

Slack 通知是通过 Slack Webhooks 发送的。通知包含附件。

  1. # 是否通知告警已解决.
  2. [ send_resolved: <boolean> | default = false ]
  4. # The Slack webhook URL.
  5. [ api_url: <secret> | default = global.slack_api_url ]
  7. # 发送通知的频道或用户
  8. channel: <tmpl_string>
  10. # Slack webhook API 定义的 API 请求数据
  11. [ icon_emoji: <tmpl_string> ]
  12. [ icon_url: <tmpl_string> ]
  13. [ link_names: <boolean> | default = false ]
  14. [ username: <tmpl_string> | default = '{{ template "slack.default.username" . }}' ]
  15. # 以下参数定义附件.
  16. actions:
  17.   [ <action_config> ... ]
  18. [ callback_id: <tmpl_string> | default = '{{ template "slack.default.callbackid" . }}' ]
  19. [ color: <tmpl_string> | default = '{{ if eq .Status "firing" }}danger{{ else }}good{{ end }}' ]
  20. [ fallback: <tmpl_string> | default = '{{ template "slack.default.fallback" . }}' ]
  21. fields:
  22.   [ <field_config> ... ]
  23. [ footer: <tmpl_string> | default = '{{ template "slack.default.footer" . }}' ]
  24. [ mrkdwn_in: '[' <string>, ... ']' | default = ["fallback", "pretext", "text"] ]
  25. [ pretext: <tmpl_string> | default = '{{ template "slack.default.pretext" . }}' ]
  26. [ short_fields: <boolean> | default = false ]
  27. [ text: <tmpl_string> | default = '{{ template "slack.default.text" . }}' ]
  28. [ title: <tmpl_string> | default = '{{ template "slack.default.title" . }}' ]
  29. [ title_link: <tmpl_string> | default = '{{ template "slack.default.titlelink" . }}' ]
  30. [ image_url: <tmpl_string> ]
  31. [ thumb_url: <tmpl_string> ]
  33. # HTTP 客户端配置.
  34. [ http_config: <http_config> | default = global.http_config ]

<action_config>

这些字段记录在 Slack API 文档中，用于附件消息和交互式消息.

  1. text: <tmpl_string>
  2. type: <tmpl_string>
  3. # url 或名称和值都是必需的
  4. [ url: <tmpl_string> ]
  5. [ name: <tmpl_string> ]
  6. [ value: <tmpl_string> ]
  8. [ confirm: <action_confirm_field_config> ]
  9. [ style: <tmpl_string> | default = '' ]

<action_confirm_field_config>

这些字段记录在 Slack API 文档中。

  1. [ dismiss_text: <tmpl_string> | default '' ]
  2. [ ok_text: <tmpl_string> | default '' ]
  3. [ title: <tmpl_string> | default '' ]
  4. text: <tmpl_string>

<field_config>

这些字段记录在 Slack API 文档中。

  1. title: <tmpl_string>
  2. value: <tmpl_string>
  3. [ short: <boolean> | default = slack_config.short_fields ]

<opsgenie_config>

OpsGenie 通知是通过 OpsGenie API 发送的。

  1. # 是否通知告警已解决.
  2. [ send_resolved: <boolean> | default = true ]
  4. # 与 OpsGenie API 通信时使用的 API 密钥
  5. [ api_key: <secret> | default = global.opsgenie_api_key ]
  7. # 将 OpsGenie API 请求发送到
  8. [ api_url: <string> | default = global.opsgenie_api_url ]
  10. # 告警文本不得超过130个字符.
  11. [ message: <tmpl_string> ]
  13. # 事件描述.
  14. [ description: <tmpl_string> | default = '{{ template "opsgenie.default.description" . }}' ]
  16. # 到通知发送者的反向链接.
  17. [ source: <tmpl_string> | default = '{{ template "opsgenie.default.source" . }}' ]
  19. # 一组任意键/值对,它们提供有关事件的更多详细信息
  20. [ details: { <string>: <tmpl_string>, ... } ]
  22. # 负责通知的响应者列表
  23. responders:
  24.   [ - <responder> ... ]
  26. # 逗号分隔的附加到通知的标记列表
  27. [ tags: <tmpl_string> ]
  29. # 附加警报提示
  30. [ note: <tmpl_string> ]
  32. # 告警优先级,可能的值是 P1, P2, P3, P4, P5
  33. [ priority: <tmpl_string> ]
  35. # HTTP 客户端配置.
  36. [ http_config: <http_config> | default = global.http_config ]

<responder> 

  1. # 应该定义这些字段之一
  2. [ id: <tmpl_string> ]
  3. [ name: <tmpl_string> ]
  4. [ username: <tmpl_string> ]
  6. # "team", "user", "escalation" 或 schedule".
  7. type: <tmpl_string>

<victorops_config>

VictorOps 通知通过 VictorOps API 发送。

  1. # 是否通知告警已解决.
  2. [ send_resolved: <boolean> | default = true ]
  4. # 与 VictorOps API 通信时使用的 API 密钥
  5. [ api_key: <secret> | default = global.victorops_api_key ]
  7. # The VictorOps API URL.
  8. [ api_url: <string> | default = global.victorops_api_url ]
  10. #  A key used to map the alert to a team.
  11. routing_key: <tmpl_string>
  13. # 描述告警级别(CRITICAL, WARNING, INFO).
  14. [ message_type: <tmpl_string> | default = 'CRITICAL' ]
  16. # 包含警报问题的摘要
  17. [ entity_display_name: <tmpl_string> | default = '{{ template "victorops.default.entity_display_name" . }}' ]
  19. # 包含有关告警问题的详细说明
  20. [ state_message: <tmpl_string> | default = '{{ template "victorops.default.state_message" . }}' ]
  22. # 来自监控工具的状态消息
  23. [ monitoring_tool: <tmpl_string> | default = '{{ template "victorops.default.monitoring_tool" . }}' ]
  25. # HTTP 客户端配置.
  26. [ http_config: <http_config> | default = global.http_config ]

<webhook_config>

Webhook receiver 允许配置通用 receiver.

  1. # 是否通知告警已解决.
  2. [ send_resolved: <boolean> | default = true ]
  4. # 发送 HTTP POST 请求的端点
  5. url: <string>
  7. # HTTP 客户端配置.
  8. [ http_config: <http_config> | default = global.http_config ]

Alertmanager 将以以下 JSON 格式将 HTTP POST 请求发送到配置的端点

  1. {
  2.   "version": "4",
  3.   "groupKey": <string>,    // key identifying the group of alerts (e.g. to deduplicate)
  4.   "status": "<resolved|firing>",
  5.   "receiver": <string>,
  6.   "groupLabels": <object>,
  7.   "commonLabels": <object>,
  8.   "commonAnnotations": <object>,
  9.   "externalURL": <string>,  // backlink to the Alertmanager.
  10.   "alerts": [
  11.     {
  12.       "status": "<resolved|firing>",
  13.       "labels": <object>,
  14.       "annotations": <object>,
  15.       "startsAt": "<rfc3339>",
  16.       "endsAt": "<rfc3339>",
  17.       "generatorURL": <string> // identifies the entity that caused the alert
  18.     },
  19.     ...
  20.   ]
  21. }

此功能的集成列表

<wechat_config>

微信通知通过微信 API 发送。

  1. # 是否通知告警已解决.
  2. [ send_resolved: <boolean> | default = false ]
  4. # 与微信 API 通信时使用的 API 密钥
  5. [ api_secret: <secret> | default = global.wechat_api_secret ]
  7. # The WeChat API URL.
  8. [ api_url: <string> | default = global.wechat_api_url ]
  10. # 用于身份验证的公司 ID
  11. [ corp_id: <string> | default = global.wechat_api_corp_id ]
  13. # 由微信 API 定义的 API 请求数据
  14. [ message: <tmpl_string> | default = '{{ template "wechat.default.message" . }}' ]
  15. [ agent_id: <string> | default = '{{ template "wechat.default.agent_id" . }}' ]
  16. [ to_user: <string> | default = '{{ template "wechat.default.to_user" . }}' ]
  17. [ to_party: <string> | default = '{{ template "wechat.default.to_party" . }}' ]
  18. [ to_tag: <string> | default = '{{ template "wechat.default.to_tag" . }}' ]