帮助手册

事件参数

Site24x7 中的事件参数是预定义的令牌(宏),可将上下文数据动态插入第三方通知、告警消息、通知及 IT 自动化中。这些令牌可检索实时的监视器和中断详情,如监视器名称、告警状态、事件时间和根本原因,帮助您创建内容丰富的自定义告警。

事件参数可应用于:

  • IT 自动化模板:在自动化修复过程中动态传入特定事件的详细信息。
  • 第三方集成:与 Slack、Teams 或工单系统等外部工具共享事件上下文。
  • 邮件模板:使用实时事件数据自定义告警通知。

使用场景

  • 通过自动将实时事件数据填入 Jira 或 Webhook 等第三方集成工具,加速事件沟通与响应。
  • 通过将状态或原因等相关值传递给 Webhook 和脚本,触发精准的 IT 自动化。
  • 使用上下文信息增强告警清晰度,加快分类和解决速度。

配置事件参数

  1. 登录 Site24x7。
  2. 导航至 Admin > IT Automation Templates > Add Automation Templates
  3. 添加自动化模板页面,将类型选择为 Invoke URL/REST API
  4. 输入合适的显示名称并填写目标 URL
  5. POST、GET、PUT、DELETEPATCH 中选择所需的 HTTP 方法
  6. 标头名称标头值字段中指定键值对,添加 HTTP 请求标头
  7. 点击 + 图标添加更多 HTTP 请求标头
  8. 如果外部系统有要求,请填写所需的用户代理字符串。
  9. 选择认证方法——Basic/NTLMOAuth——并根据需要填写对应的用户名密码
  10. 如需在请求中包含实时告警数据,请选择发送事件参数。这将自动填充请求负载中的预定义字段。
  11. 使用 & 作为分隔符添加多个键值对。
  12. 为请求设置超时时间(例如 15 秒)。
  13. 通过切换,选择是否通过邮件发送自动化结果
  14. 点击保存,完成并激活自动化。

Site24x7 支持的事件参数

以下是 Site24x7 支持的令牌及其含义:

参数 显示内容
$STATUS  监视器状态(DOWN、UP、CRITICALTROUBLE
$MONITORTYPE  监视器类型(URL、PING、FTP、DNS 等)
$MONITORNAME  监视器的显示名称
$MONITORURL  受监控的 URL 或资源
$INCIDENT_TIME  事件发生时间
$INCIDENT_REASON  根本原因或错误消息
$INCIDENT_DETAILS 任何附加上下文信息
$FAILED_LOCATIONS  监视器失败的位置
$MONITOR_DASHBOARD_LINK  指向特定监视器仪表板的直接链接
$TAGS  添加到监视器的标签
$MONITOR_GROUPNAME  告警时的监视器组名称
$OUTAGE_TIME_UNIX_FORMAT 中断的 UNIX 时间戳
$FAILED_CHILD_RESOURCE 失败的子资源(如接口名称)
$RCA_LINK  根本原因分析链接
$OUTAGE_DURATION 状态变更时上次中断的持续时长
$ALERT_TIME 告警触发的时间
$ALERT_TIME_IN_TEXT 告警触发时间的文本格式
$FAILED_ATTRIBUTES 当前轮询中失败属性的属性信息
$STATUS_CHANGE_ATTRIBUTES 当前轮询中状态发生变化的属性信息
$ALARM_CATEGORY 告警类别
$ATTRIBUTE_NAMES 属性名称

事件参数最佳实践

  • 严格遵守格式:键和值均应加引号,并采用正确的 JSON 格式。
  • 仅在相关场景中使用:在需要实时上下文的模板(如邮件主题、Webhook 负载或自动化操作)中使用事件参数——例如监视器名称、状态和事件时间。
  • 选择具体令牌:仅选择所需的参数,保持输出简洁,避免冗余。
  • 验证令牌兼容性:确保第三方工具能够解析 Site24x7 令牌传递的值。
  • 部署前进行测试:使用测试监视器触发告警,确认令牌在发出的请求中能正确解析。
  • 使用有意义的组合:例如,在 Webhook 消息中组合使用 $MONITORNAME、$STATUS 和 $INCIDENT_TIME,可在日志或外部工具中提供更好的清晰度。

什么是事件参数和自定义参数?

本文档对您有帮助吗?

您愿意帮助我们改进文档吗?请告诉我们哪些方面可以做得更好。


很抱歉本文档未能让您满意。我们希望了解可以从哪些方面改进您的体验。


感谢您抽出时间分享反馈。我们将利用您的反馈来改进在线帮助资源。

短链接已复制!