通知媒介

通知媒介

通知媒介主要功能有两个

  1. 控制哪些通知媒介在告警规则中展示，可以关闭不会用到的联系方式，让通知媒介配置更简洁
  2. 用户可以自己创建新的通知媒介，适配公司自己的通知通道，在自定义通知脚本中根据是否配置了新增的通知媒介来进行相应的通知发送

通知媒介

配置说明

名称：前台显示名称

标识：调用唯一标识

隐藏：是否在告警规则的通知配置中展示

启用：该通知媒介是否启用

注意：如果未启用，则在告警规则配置里默认不显示。

使用场景

用户自己创建的通知媒介和联系方式主要在自定义通知脚本中使用，下面是一个脚本调用举例，可以参考样例脚本，对接自己的内部通信工具。

系统会把告警事件的内容 encode 成 json，然后通过 stdin 的方式传给通知脚本，脚本示例如下：

  1. #!/usr/bin/env python
  2. # -*- coding: UTF-8 -*-
  3. import sys
  4. import json
  5. import urllib2
  7. reload(sys)
  8. sys.setdefaultencoding('utf8')  # 设置默认编码为utf-8
  10. class Sender(object):
  11.     @classmethod
  12.     # 方法send_newtalk，newtalk要和配置的通知媒介一致；
  13.     def send_newtalk(cls, payload):
  14.         try:
  15.             #print("Starting send_newtalk".encode('utf-8'))
  16.             # 从payload中获取事件数据
  17.             event = payload.get('event')
  18.             # 获取通知用户对象
  19.             users = event.get("notify_users_obj")
  20.             # 获取告警规则名称
  21.             rule_name = event.get("rule_name")
  22.             # 默认事件状态为 触发
  23.             event_state = "Triggered"
  24.             # 如果事件已恢复，则状态为“恢复”
  25.             if event.get("is_recovered"):
  26.                 event_state = "Recovered"
  27.             # 用于存储Dingtalk机器人令牌和用户电话
  28.             tokens = {}
  29.             phones = {}
  31.             #print("Extracting user information".encode('utf-8'))
  32.             # 遍历用户，收集电话和Dingtalk令牌
  33.             for u in users:
  34.                 if u.get("phone"):
  35.                     phones[u.get("phone")] = 1
  37.                 contacts = u.get("contacts")
  38.                 # dingtalk_robot_token，需要根据需求替换对应名称，在夜莺通知设置-联系方式设定名称，用户里面配置参数
  39.                 if contacts.get("dingtalk_robot_token", ""):
  40.                     tokens[contacts.get("dingtalk_robot_token", "")] = 1
  41.             # 设置请求头
  42.             headers = {
  43.                 "Content-Type": "application/json;charset=utf-8"
  44.             }
  46.             #print("Tokens: {}".format(tokens).encode('utf-8'))
  47.             #print("Phones: {}".format(phones).encode('utf-8'))
  48.             # 遍历令牌，构建请求并发送到Dingtalk
  49.             for t in tokens:
  50.                 url = "https://oapi.dingtalk.com/robot/send?access_token={}".format(t)
  51.                 body = {
  52.                     "msgtype": "markdown",
  53.                     "markdown": {
  54.                         "title": "{} - {}".format(event_state, rule_name),
  55.                         "text": "{} {}".format(payload.get('tpls').get("dingtalk.tpl", "dingtalk.tpl not found"), ' '.join(["@"+i for i in phones.keys()]))
  56.                     },
  57.                     "at": {
  58.                         "atMobiles": list(phones.keys()),
  59.                         "isAtAll": False
  60.                     }
  61.                 }
  63.                 #print("Sending request to URL: {}".format(url).encode('utf-8'))
  64.                 #print("Request body: {}".format(body).encode('utf-8'))
  66.                 data = json.dumps(body)
  67.                 req = urllib2.Request(url, data=data, headers=headers)
  68.                 req.get_method = lambda: "POST"
  69.                 response = urllib2.urlopen(req)
  70.                 result = response.read()
  71.                 #print("Response status code: {}".format(response.getcode()).encode('utf-8'))
  72.                 #print("Response text: {}".format(result).encode('utf-8'))
  73.         # 捕获所有异常，防止程序崩溃
  74.         except Exception as e:
  75.             #print("Error in send_newtalk: {}".format(e).encode('utf-8'))
  77. def main():
  78.     try:
  79.         #print("Reading payload from stdin".encode('utf-8'))
  80.         payload = json.load(sys.stdin)
  81.         with open(".payload", 'w') as f:
  82.             f.write(json.dumps(payload, indent=4))
  83.         #print("Payload written to .payload file".encode('utf-8'))
  85.         for ch in payload.get('event').get('notify_channels'):
  86.             send_func_name = "send_{}".format(ch.strip())
  87.             #print("Processing channel: {}, function name: {}".format(ch, send_func_name).encode('utf-8'))
  88.             if not hasattr(Sender, send_func_name):
  89.                 #print("Function {} not found".format(send_func_name).encode('utf-8'))
  90.                 continue
  91.             send_func = getattr(Sender, send_func_name)
  92.             send_func(payload)
  94.     except Exception as e:
  95.         print("Error in main: {}".format(e).encode('utf-8'))
  97. def hello():
  98.     print("hello nightingale".encode('utf-8'))
  100. if __name__ == "__main__":
  101.     if len(sys.argv) == 1:
  102.         main()
  103.     elif sys.argv[1] == "hello":
  104.         hello()
  105.     else:
  106.         print("I am confused".encode('utf-8'))

示例脚本中有很多 print 打印的输出，主要是为了方便调试使用。如果开启，可通过 n9e 的日志进行查看，日志调试在 INFO.log，报错状态在 ERROR.log，过滤关键词 event_script_notify。

脚本日志