网站地图 RSS订阅 TAGS标签
您的位置:  首页 > 技术杂谈 > 正文

告警消息何去何从？在飞书中飞起来

2022-06-09 15:00 https://my.oschina.net/rancher/blog/5536398 RancherLabs 次阅读 条评论

作者简介
袁振，SUSE Rancher 技术支持经理，负责订阅客户售后技术支持团队，为订阅客户提供技术支持服务。2016 年开始接触容器、Kubernetes 技术，对自动化运维、Devops、Kubernetes、prometheus 和其他云原生相关技术具有较深入的研究，对 SRE 运维体系建设、SRE 运维系统架构设计有着丰富的实践经验。

背景

通过《Prometheus 监控实战》这本书，我们认识到一个良好的监控系统应该提供以下服务：

  • 全局视角，从最高层（业务）依次展开；
  • 协助故障诊断；
  • 作为基础设施、应用程序开发和业务人员的信息源；
  • 内置于应用程序设计、开发和部署的生命周期中；
  • 尽可能的自动化，并提供自服务。

拥有良好的监控系统还不够，我们还需要一个告警消息。告警消息可以为我们提供一些指示，表明我们环境中的某些状态已经发生了变化，而且通常是一些更糟糕的情况。好的告警消息的关键应该是能够在正确的时间、以正确的理由和正确的速度发送，并且其中应该包含有用且重要的信息。

告警消息发送的目的地也成为了其中一个关键环节。从传统的 E-mail、电话、短信通知到现在层出不穷的企业办公通信软件，如钉钉、企业微信、飞书等，选择合适的工具来发送通知，以保证处理人员能够及时收到消息变得尤为重要。

以 SUSE Rancher 企业版为例，除了 E-mail、slack 等常用的通知平台外，它还特别针对中国企业用户集成了钉钉、企业微信、阿里云短信等通知平台。即使是这样，仍然无法满足某些企业用户的需求，比如说飞书用户，就没办法直接进行对接。本文将介绍如何使用 SUSE Rancher 告警通知中的 Webhook，结合另一个优秀的开源项目 PrometheusAlert，实现多种通知平台的告警发送。

PrometheusAlert全家桶

PrometheusAlert 是开源的运维告警中心消息转发系统，支持主流的监控系统 Prometheus、Zabbix，日志系统 Graylog2、Graylog3，数据可视化系统 Grafana、SonarQube。阿里云-云监控，以及所有支持 WebHook 接口的系统发出的预警消息，支持将收到的这些消息发送到钉钉、微信、email、飞书、腾讯短信、腾讯电话、阿里云短信、阿里云电话、华为短信、百度云短信、容联云电话、七陌短信、七陌语音、TeleGram、百度 Hi（如流）等。

以上内容引用自 PrometheusAlert 项目简介，可以看到这个项目可以对接多种主流监控系统，并且支持通过 webhook 接口发送的告警消息，推送到多种接收平台。该项目还在不断更新，未来将接入更多平台，感兴趣的同学可以查看并参与其中。

项目地址：https://github.com/feiyu563/PrometheusAlert

让告警飞起来

本文将使用 SUSE Rancher 和 PrometheusAlert，将 SUSE Rancher 产生的告警通知发送到飞书中进行演示，更多配置可以查看 PrometheusAlert 项目文档。

创建飞书机器人

  • 创建一个飞书群组，并添加一个自定义机器人；

创建自定义机器人

  • 记录生成的 Webhook 地址；这一步可以根据需求定义安全相关配置；

记录 webhook 地址

更多关于飞书机器人请查看链接：https://open.feishu.cn/document/ukTMukTMukTM/ucTM5YjL3ETO24yNxkjN

部署 PrometheusAlert

本文中将 PrometheusAlert 部署在 SUSE Rancher 创建的自定 kubernetes 集群中，使用 yaml 文件进行部署。

创建 Configmap

这一步骤中创建 PrometheusAlert 的 Configmap 配置，PrometheusAlert 也提供了通过环境变量的方式注入配置，但是为了方便管理，这里使用 Configmap 的方式：

apiVersion: v1
data:
  app.conf: |-
    #---------------------↓全局配置-----------------------
    appname = PrometheusAlert
    #登录用户名
    login_user=prometheusalert
    #登录密码
    login_password=prometheusalert
    #监听地址
    httpaddr = "0.0.0.0"
    #监听端口
    httpport = 8080
    runmode = dev
    #设置代理 proxy = http://123.123.123.123:8080
    proxy =
    #开启JSON请求
    copyrequestbody = true
    #告警消息标题
    title=PrometheusAlert
    #链接到告警平台地址
    GraylogAlerturl=http://graylog.org
    #钉钉告警 告警logo图标地址
    logourl=https://raw.githubusercontent.com/feiyu563/PrometheusAlert/master/doc/alert-center.png
    #钉钉告警 恢复logo图标地址
    rlogourl=https://raw.githubusercontent.com/feiyu563/PrometheusAlert/master/doc/alert-center.png
    #短信告警级别(等于3就进行短信告警) 告警级别定义 0 信息,1 警告,2 一般严重,3 严重,4 灾难
    messagelevel=3
    #电话告警级别(等于4就进行语音告警) 告警级别定义 0 信息,1 警告,2 一般严重,3 严重,4 灾难
    phonecalllevel=4
    #默认拨打号码(页面测试短信和电话功能需要配置此项)
    defaultphone=xxxxxxxx
    #故障恢复是否启用电话通知0为关闭,1为开启
    phonecallresolved=0
    #是否前台输出file or console
    logtype=file
    #日志文件路径
    logpath=logs/prometheusalertcenter.log
    #转换Prometheus,graylog告警消息的时区为CST时区(如默认已经是CST时区，请勿开启)
    prometheus_cst_time=0
    #数据库驱动，支持sqlite3，mysql,postgres如使用mysql或postgres，请开启db_host,db_port,db_user,db_password,db_name的注释
    db_driver=sqlite3
    #db_host=127.0.0.1
    #db_port=3306
    #db_user=root
    #db_password=root
    #db_name=prometheusalert
    #是否开启告警记录 0为关闭,1为开启
    AlertRecord=0
    #是否开启告警记录定时删除 0为关闭,1为开启
    RecordLive=0
    #告警记录定时删除周期，单位天
    RecordLiveDay=7
    # 是否将告警记录写入es7，0为关闭，1为开启
    alert_to_es=0
    # es地址，是[]string
    # beego.Appconfig.Strings读取配置为[]string，使用";"而不是","
    to_es_url=http://localhost:9200
    # to_es_url=http://es1:9200;http://es2:9200;http://es3:9200
    # es用户和密码
    # to_es_user=username
    # to_es_pwd=password 
    #---------------------↓webhook-----------------------
    #是否开启钉钉告警通道,可同时开始多个通道0为关闭,1为开启
    open-dingding=1
    #默认钉钉机器人地址
    ddurl=https://oapi.dingtalk.com/robot/send?access_token=xxxxx
    #是否开启 @所有人(0为关闭,1为开启)
    dd_isatall=1

    #是否开启微信告警通道,可同时开始多个通道0为关闭,1为开启
    open-weixin=1
    #默认企业微信机器人地址
    wxurl=https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxxxx

    #是否开启飞书告警通道,可同时开始多个通道0为关闭,1为开启
    open-feishu=0
    #默认飞书机器人地址
    fsurl=https://open.feishu.cn/open-apis/bot/hook/xxxxxxxxx

    #---------------------↓腾讯云接口-----------------------
    #是否开启腾讯云短信告警通道,可同时开始多个通道0为关闭,1为开启
    open-txdx=0
    #腾讯云短信接口key
    TXY_DX_appkey=xxxxx
    #腾讯云短信模版ID 腾讯云短信模版配置可参考 prometheus告警:{1}
    TXY_DX_tpl_id=xxxxx
    #腾讯云短信sdk app id
    TXY_DX_sdkappid=xxxxx
    #腾讯云短信签名 根据自己审核通过的签名来填写
    TXY_DX_sign=腾讯云

    #是否开启腾讯云电话告警通道,可同时开始多个通道0为关闭,1为开启
    open-txdh=0
    #腾讯云电话接口key
    TXY_DH_phonecallappkey=xxxxx
    #腾讯云电话模版ID
    TXY_DH_phonecalltpl_id=xxxxx
    #腾讯云电话sdk app id
    TXY_DH_phonecallsdkappid=xxxxx

    #---------------------↓华为云接口-----------------------
    #是否开启华为云短信告警通道,可同时开始多个通道0为关闭,1为开启
    open-hwdx=0
    #华为云短信接口key
    HWY_DX_APP_Key=xxxxxxxxxxxxxxxxxxxxxx
    #华为云短信接口Secret
    HWY_DX_APP_Secret=xxxxxxxxxxxxxxxxxxxxxx
    #华为云APP接入地址(端口接口地址)
    HWY_DX_APP_Url=https://rtcsms.cn-north-1.myhuaweicloud.com:10743
    #华为云短信模板ID
    HWY_DX_Templateid=xxxxxxxxxxxxxxxxxxxxxx
    #华为云签名名称，必须是已审核通过的，与模板类型一致的签名名称,按照自己的实际签名填写
    HWY_DX_Signature=华为云
    #华为云签名通道号
    HWY_DX_Sender=xxxxxxxxxx

    #---------------------↓阿里云接口-----------------------
    #是否开启阿里云短信告警通道,可同时开始多个通道0为关闭,1为开启
    open-alydx=0
    #阿里云短信主账号AccessKey的ID
    ALY_DX_AccessKeyId=xxxxxxxxxxxxxxxxxxxxxx
    #阿里云短信接口密钥
    ALY_DX_AccessSecret=xxxxxxxxxxxxxxxxxxxxxx
    #阿里云短信签名名称
    ALY_DX_SignName=阿里云
    #阿里云短信模板ID
    ALY_DX_Template=xxxxxxxxxxxxxxxxxxxxxx

    #是否开启阿里云电话告警通道,可同时开始多个通道0为关闭,1为开启
    open-alydh=0
    #阿里云电话主账号AccessKey的ID
    ALY_DH_AccessKeyId=xxxxxxxxxxxxxxxxxxxxxx
    #阿里云电话接口密钥
    ALY_DH_AccessSecret=xxxxxxxxxxxxxxxxxxxxxx
    #阿里云电话被叫显号，必须是已购买的号码
    ALY_DX_CalledShowNumber=xxxxxxxxx
    #阿里云电话文本转语音（TTS）模板ID
    ALY_DH_TtsCode=xxxxxxxx

    #---------------------↓容联云接口-----------------------
    #是否开启容联云电话告警通道,可同时开始多个通道0为关闭,1为开启
    open-rlydh=0
    #容联云基础接口地址
    RLY_URL=https://app.cloopen.com:8883/2013-12-26/Accounts/
    #容联云后台SID
    RLY_ACCOUNT_SID=xxxxxxxxxxx
    #容联云api-token
    RLY_ACCOUNT_TOKEN=xxxxxxxxxx
    #容联云app_id
    RLY_APP_ID=xxxxxxxxxxxxx

    #---------------------↓邮件配置-----------------------
    #是否开启邮件
    open-email=0
    #邮件发件服务器地址
    Email_host=smtp.qq.com
    #邮件发件服务器端口
    Email_port=465
    #邮件帐号
    Email_user=xxxxxxx@qq.com
    #邮件密码
    Email_password=xxxxxx
    #邮件标题
    Email_title=运维告警
    #默认发送邮箱
    Default_emails=xxxxx@qq.com,xxxxx@qq.com

    #---------------------↓七陌云接口-----------------------
    #是否开启七陌短信告警通道,可同时开始多个通道0为关闭,1为开启
    open-7moordx=0
    #七陌账户ID
    7MOOR_ACCOUNT_ID=Nxxx
    #七陌账户APISecret
    7MOOR_ACCOUNT_APISECRET=xxx
    #七陌账户短信模板编号
    7MOOR_DX_TEMPLATENUM=n
    #注意：七陌短信变量这里只用一个var1，在代码里写死了。
    #-----------
    #是否开启七陌webcall语音通知告警通道,可同时开始多个通道0为关闭,1为开启
    open-7moordh=0
    #请在七陌平台添加虚拟服务号、文本节点
    #七陌账户webcall的虚拟服务号
    7MOOR_WEBCALL_SERVICENO=xxx
    # 文本节点里被替换的变量，我配置的是text。如果被替换的变量不是text，请修改此配置
    7MOOR_WEBCALL_VOICE_VAR=text

    #---------------------↓telegram接口-----------------------
    #是否开启telegram告警通道,可同时开始多个通道0为关闭,1为开启
    open-tg=0
    #tg机器人token
    TG_TOKEN=xxxxx
    #tg消息模式 个人消息或者频道消息 0为关闭(推送给个人)，1为开启(推送给频道)
    TG_MODE_CHAN=0
    #tg用户ID
    TG_USERID=xxxxx
    #tg频道name或者id, 频道name需要以@开始
    TG_CHANNAME=xxxxx
    #tg api地址, 可以配置为代理地址
    #TG_API_PROXY="https://api.telegram.org/bot%s/%s"

    #---------------------↓workwechat接口-----------------------
    #是否开启workwechat告警通道,可同时开始多个通道0为关闭,1为开启
    open-workwechat=0
    # 企业ID
    WorkWechat_CropID=xxxxx
    # 应用ID
    WorkWechat_AgentID=xxxx
    # 应用secret
    WorkWechat_AgentSecret=xxxx
    # 接受用户
    WorkWechat_ToUser="zhangsan|lisi"
    # 接受部门
    WorkWechat_ToParty="ops|dev"
    # 接受标签
    WorkWechat_ToTag=""
    # 消息类型, 暂时只支持markdown
    # WorkWechat_Msgtype = "markdown"

    #---------------------↓百度云接口-----------------------
    #是否开启百度云短信告警通道,可同时开始多个通道0为关闭,1为开启
    open-baidudx=0
    #百度云短信接口AK(ACCESS_KEY_ID)
    BDY_DX_AK=xxxxx
    #百度云短信接口SK(SECRET_ACCESS_KEY)
    BDY_DX_SK=xxxxx
    #百度云短信ENDPOINT（ENDPOINT参数需要用指定区域的域名来进行定义，如服务所在区域为北京，则为）
    BDY_DX_ENDPOINT=http://smsv3.bj.baidubce.com
    #百度云短信模版ID,根据自己审核通过的模版来填写(模版支持一个参数code：如prometheus告警:{code})
    BDY_DX_TEMPLATE_ID=xxxxx
    #百度云短信签名ID，根据自己审核通过的签名来填写
    TXY_DX_SIGNATURE_ID=xxxxx

    #---------------------↓百度Hi(如流)-----------------------
    #是否开启百度Hi(如流)告警通道,可同时开始多个通道0为关闭,1为开启
    open-ruliu=0
    #默认百度Hi(如流)机器人地址
    BDRL_URL=https://api.im.baidu.com/api/msg/groupmsgsend?access_token=xxxxxxxxxxxxxx
    #百度Hi(如流)群ID
    BDRL_ID=123456
    #---------------------↓bark接口-----------------------
    #是否开启telegram告警通道,可同时开始多个通道0为关闭,1为开启
    open-bark=0
    #bark默认地址, 建议自行部署bark-server
    BARK_URL=https://api.day.app
    #bark key, 多个key使用分割
    BARK_KEYS=xxxxx
    # 复制, 推荐开启
    BARK_COPY=1
    # 历史记录保存,推荐开启
    BARK_ARCHIVE=1
    # 消息分组
    BARK_GROUP=PrometheusAlert
kind: ConfigMap
metadata:
  name: prometheus-alert-center-conf
  namespace: kube-system

根据实际需要进行配置文件的修改，这里我们对接飞书，主要有以下几个参数需要修改：

login_user=prometheusalert ## UI登陆用户名
login_password=prometheusalert  ##UI登陆密码
open-feishu=1 ##修改为1，启用飞书告警
fsurl=https://open.feishu.cn/open-apis/bot/hook/xxxxxxxxx ##飞书机器人webhook地址(也可以在后续页面中填写)

部署工作负载

通过 yaml 部署 PrometheusAlert 工作负载和 Nodeport 类型的 Service 以用于访问PrometheusAlert UI(SUSE Rancher UI 可以直接导入)：

apiVersion: apps/v1
kind: Deployment
metadata:
  labels:
    app: prometheus-alert-center
    alertname: prometheus-alert-center
  name: prometheus-alert-center
  namespace: kube-system
spec:
  replicas: 1
  selector:
    matchLabels:
     app: prometheus-alert-center
     alertname: prometheus-alert-center
  strategy:
    rollingUpdate:
      maxSurge: 1
      maxUnavailable: 0
    type: RollingUpdate
  template:
    metadata:
      labels:
       app: prometheus-alert-center
       alertname: prometheus-alert-center
    spec:
      containers:
      - env:
        - name: TZ
          value: Asia/Shanghai
        image: feiyu563/prometheus-alert
        imagePullPolicy: IfNotPresent
        name: prometheus-alert-center
        resources:
          limits:
            cpu: 500m
            memory: 512Mi
          requests:
            cpu: 200m
            memory: 128Mi
        volumeMounts:
        - mountPath: /app/conf/
          name: vol1
      dnsPolicy: ClusterFirst
      restartPolicy: Always
      schedulerName: default-scheduler
      securityContext: {}
      terminationGracePeriodSeconds: 30
      volumes:
      - configMap:
          defaultMode: 256
          name: prometheus-alert-center-conf
          optional: false
        name: vol1
---
apiVersion: v1
kind: Service
metadata:
  name: prometheus-alert-center
  namespace: kube-system
spec:
  type: NodePort
  selector:
    app: prometheus-alert-center
  ports:
    - port: 8080
      targetPort: 8080
      nodePort: 30080
  • 部署完成后通过访问http://<node_ip>:30080 即可访问 PrometheusAlert UI，用户名和密码为 Configmap 中的配置；至此，PrometheusAlert 全家桶部署完毕。除了以上基础配置以外，PrometheusAlert 全家桶还有更多的部署方式和配置，比如使用后端 mysql存储进行模版的存储等，更多部署细节可以查看项目文档链接：https://feiyu563.gitbook.io/prometheusalert/base-install

PrometheusAlert UI

创建自定义告警模版

PrometheusAlert 全家桶部署完成后，因为使用 SUSE Rancher 通知发送出去的 Webhook 消息与原生的有所不同，因此我们需要添加 PrometheusAlert 全家桶中的自定义告警模版。

注意：SUSE Rancher 告警通知模版和 PrometheusAlert 全家桶自定义模版需要有一定的 Go template 基础。

添加自定义 PrometheusAlert 告警模版

在 PrometheusAlert 全家桶中添加自定义模版，以下内容为必填项

  • 模版名称
  • 模版类型
  • 模版内容
  • 模版用途

这里我们选择模版类型为飞书，模版用途为 Prometheus，模版内容如下：

{
  { $var := .externalURL}}{
  { range $k,$v:=.alerts }}
{
  {if eq $v.status "resolved"}}
**[Rancher容器云平台恢复告警信息]({
  {$v.labels.server_url}})**
*[{
  {$v.labels.alertname}}]({
  {$var}})*
告警级别：{
  {$v.labels.severity}}
开始时间：{
  {TimeFormat $v.startsAt "2006-01-02 15:04:05 UTC"}}
结束时间：{
  {TimeFormat $v.endsAt "2006-01-02 15:04:05 UTC"}}
集群ID: {
  {$v.labels.cluster_name}} 
故障主机IP: {
  {$v.labels.instance}}
PromQL: {
  {$v.alert.expression}}
触发告警持续时间: {
  {$v.labels.duration}}
当前值为：**{
  {$v.annotations.current_value}}**
{
  {else}}
**[Rancher容器云平台告警信息]({
  {$v.labels.server_url}})**
*[{
  {$v.labels.alertname}}]({
  {$var}})*
告警级别：{
  {$v.labels.severity}}
开始时间：{
  {TimeFormat $v.startsAt "2006-01-02 15:04:05 UTC"}}
{
  {if eq $v.endsAt "0001-01-01T00:00:00Z"}}
结束时间: {
  { printf "告警当前仍然存在!"}}
{
  {else}}
结束时间: {
  {TimeFormat $v.endsAt "2006-01-02 15:04:05 UTC"}}
{
  {end}}
集群ID: {
  {$v.labels.cluster_name}}
故障主机IP: {
  {$v.labels.instance}}
PromQL: {
  {$v.labels.expression}}
触发告警持续时间: {
  {$v.labels.duration}}
当前值为：**{
  {$v.annotations.current_value}}**
{
  {end}}
{
  { end }}

添加自定义模板

这里的模版内容均为 go template 编写，在本文中仅以 SUSE Rancher 发出的默认 webhook 消息作为示例。对于有 go template 基础或者 SUSE Rancher 使用基础的用户，可以基于 SUSE Rancher 企业版的自定义告警功能和自定义告警通知模版功能对告警消息进行深度定制，然后在 PrometheusAlert 全家桶自定义模版中定义更高级的告警消息。

SUSE Rancher 告警对接

首先在集群/项目–工具–通知中添加 Webhook 类型的通知，URL 填写如下：

http://<PrometheusAlert_url>/prometheusalert?type=fs&tpl=RancherTofs&fsurl=https://open.feishu.cn/open-apis/bot/v2/hook/xxxxxxxxx
  • <PrometheusAlert_url> PrometheusAlert 地址
  • typt=fs 类型为飞书
  • tpl=RancherTofs 上一步创建的 PrometheusAlert 模版名称
  • fsurl 飞书机器人的 webhook 地址

PrometheusAlert 有自己的接口格式，更多接口细节请参考 PrometheusAlert 文档，本文仅以飞书举例

配置通知

这里需要注意的是，与以往的对接方式不通，点击测试通过后，飞书并不会收到测试消息，这是因为消息格式体与 PrometheusAlert 中的自定义模版不匹配。我们可以通过查看 PrometheusAlert 组件的日志查看 webhook 消息是否发送到了 PrometheusAlert 组件，日志内容如下：

[{"labels":{"test_msg":"Webhook setting validated"},"annotations":null,"startsAt":"0001-01-01T00:00:00Z","endsAt":"0001-01-01T00:00:00Z","generatorURL":""}]

SUSE Rancher 配置告警通知

上述步骤完成后，我们就可以对告警进行通知配置了。在 SUSE Rancher UI 上进入集群/项目–工具–告警中我们可以对告警/告警组进行通知配置，在接收者中配置刚刚添加的 Webhook 通知

保存后触发告警后就可以发送到飞书进行告警通知了。

告警测试

故障排查

  • SUSE Rancher UI 测试不通过：检查 Rancher Server 服务到 PrometheusAlert 服务的网络是否能通讯；
  • 飞书收不到告警信息：检查 PrometheusAlert 组件日志，查看是否正常发送告警消息到飞书；
  • 飞书收到的告警消息有空白字段：检查 PrometheusAlert 中的自定义模版，通过测试发送检查告警内容是否错误。

总结

PrometheusAlert 全家桶能够对市面上快速迭代的企业沟通工具提供告警支持，无论通过 SUSE Rancher 的告警功能或者其他的监控平台，都能很好地实现不同客户的自定义需求。稍微了解 Webhook 和 go template 的用户都能很快上手，但想要更好地使用 PrometheusAlert 全家桶，可能需要对监控告警体系和 go template 技能有所要求。

在作者看来，监控/告警体系的构建不是一蹴而就的，需要一定的时间慢慢累积，不断调整。“狼来了”的告警不应该被视为工作失误，反而能够促进监控/告警体系的完善。监控/告警从最开始的后知后觉，慢慢演变为先知先觉，这其中有很长的路要走。部分团队可能会觉得运维工程师无非就是上线部署、重启服务器，但正是有了这些运维工程师，通过正确的预警/监控/告警和深夜里处理告警的精神，才避免了一次又一次重大的事故。善待运维，完善监控体系，对技术永怀敬畏之心！

参考链接

  • prometheusalert 文档：https://feiyu563.gitbook.io/prometheusalert/
  • prometheusalert 项目：https://github.com/feiyu563/PrometheusAlert/
  • SUSE Rancher 通知：https://docs.rancher.cn/docs/rancher2.5/monitoring-alerting/configuration/receiver/_index#webhook
  • SUSE Rancher 告警表达式参考：https://docs.rancher.cn/docs/rancher2.5/monitoring-alerting/expression/_index
展开阅读全文
  • 0人
    感动
  • 0人
    路过
  • 0人
    高兴
  • 0人
    难过
  • 0人
    搞笑
  • 0人
    无聊
  • 0人
    愤怒
  • 0人
    同情
相关文章
热度排行
技术杂谈
专题
OpenHarmony是开放原子开源基金会（OpenAtom Foundation）旗下开源... [详细]
友情链接
粤ICP备2021091832号