shell 操作钉钉机器人实现告警提醒的方法

lianshaohua 2020-05-08

我们知道,之前的运维告警多通过mail 等方式通知到相应的人员,难以实现随时随地的查看。随着手机APP的发展,很多告警开始发送到IM软件上去。目前比较常用的是发送到微信和钉钉上,今天我们将重点放在钉钉上。群机器人是钉钉群的高级扩展功能,群机器人可以将第三方服务的信息聚合到群聊中,实现自动化的信息同步。借助钉钉机器人,通过官方提供的API,可以很方便的post数据到相应的接收人 。群机器人支持Webhook协议的自定义接入,支持更多可能性,例如:你可将运维报警通过自定义机器人聚合到钉钉群实现提醒功能。

Shell 脚本语言是实现Linux系统管理及自动化所必须的重要工具。熟练地编写Shell语言可以提升运维人员的工作效率,适应复杂的工作环境。

在本文,我们聚焦通过shell脚本语言实现借助钉钉机器人发送告警信息。

1: 了解更多群机器人的信息,大家可登入官网学习

https://ding-doc.dingtalk.com/doc

2.给自己的机器人起个好听的名字

操作如下:

shell 操作钉钉机器人实现告警提醒的方法

3.使用命令行工具curl

curl是一个命令行工具,通过指定的URL来上传或下载数据,并将数据展示出来。curl中的c表示client,而URL,就是URL。

3.1 与curl一起使用的协议,最多的还是HTTP

在每一个HTTP请求中,都有一个对应的方法,常用的方法有:GETPOSTHEADPUT。如果在一个curl命令中不指定具体的方法,那么默认的就是使用GET方法。对于其它的方法,可以在curl命令中指定:

method option
POST -d或-F
HEAD -I
PUT -T

POST是HTTP中向服务端提交数据的一种方法。在浏览器中,可以在表单中填写完数据后,浏览器就会默认将填写的数据使用key=value串的形式进行转化。在curl中,我们可以使用-d--data选项来指定具体的数据。

3.2 钉钉使用curl工具主要相关的两个参数

参数(短形式) 参数(长形式) 解释 具体描述
-d --data  HTTP POST data (H) 把指定的数据发送到服务器上.
-H --header Custom header to pass to server (H)

当使用POST方法提交数据时,对于提交的数据主要有如下四种形式:

  • application/x-www-form-urlencoded:默认的形式,即key1=value1&key2=value2的形式;
  • multipart/form-data:使用表单上传文件时使用这个形式;
  • application/json:提交JSON格式的数据;
  • text/xml:提交XML格式的数据。

Content-Type是一个Header,如果不指定的话,默认使用application/x-www-form-urlencoded形式传输数据,当需要使用别的形式进行数据传输的话,需要指定Header。

3.3 调用格式(案例)

curl 'https://oapi.dingtalk.com/robot/send?access_token=xxxxxxxx' \
  -H 'Content-Type: application/json' \
  -d '{"msgtype": "text", 
    "text": {
       "content": "我就是我, 是不一样的烟火"
    }
   }'

测试过程中,请将上面命令直接复制到命令行,再将xxxxxxxx替换为真实access_token。

4.不一样的markdown类型

官网中除markdown类型,其它的消息类型的 测试例子(脚本) 都可以直接在shell中演示

官网markdown类型的测试案例

{
   "msgtype": "markdown",
   "markdown": {
     "title":"杭州天气",
     "text": "#### 杭州天气 @156xxxx8827\n" +
         "> 9度,西北风1级,空气良89,相对温度73%\n\n" +
         "> ![screenshot](https://gw.alicdn.com/tfs/TB1ut3xxbsrBKNjSZFpXXcXhFXa-846-786.png)\n" +
         "> ###### 10点20分发布 [天气](http://www.thinkpage.cn/) \n"
   },
  "at": {
    "atMobiles": [
      "156xxxx8827",
      "189xxxx8325"
    ],
    "isAtAll": false
  }
 }

在shell中执行报错信息,错误信息为:

{"errcode":40035,"errmsg":"缺少参数 json"}

shell 操作钉钉机器人实现告警提醒的方法

报错原因是 "text" 栏位对应的 value 值中的 “+” 运算符导致,将中间的

" +
"

删除。

即可执行代码更新为:

{
   "msgtype": "markdown",
   "markdown": {
     "title":"杭州天气",
     "text": "#### 杭州天气 @156xxxx8827\n> 9度,西北风1级,空气良89,相对温度73%\n\n> ![screenshot](https://gw.alicdn.com/tfs/TB1ut3xxbsrBKNjSZFpXXcXhFXa-846-786.png)\n> ###### 10点20分发布 [天气](http://www.thinkpage.cn/) \n"
   },
  "at": {
    "atMobiles": [
      "156xxxx8827", 
      "189xxxx8325"
    ], 
    "isAtAll": false
  }
 }

执行OK,错误消失。

执行情况如下:

shell 操作钉钉机器人实现告警提醒的方法

成功收到的信息,内容截图如下:

 shell 操作钉钉机器人实现告警提醒的方法

5. 将钉钉机器人代码放到文件中,方便调用

例如:创建用于监控当QQOrder_ERP集群的VIP漂移时,调用用来发送钉钉告警的可执行文件ddalarm.sh。

其主要代码如下:

#!/bin/bash

webhook='https://oapi.dingtalk.com/robot/send?access_token=34XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
cluster='QQOrder_ERP'
host=`hostname -I | awk '{print $1}'`
vip=$1

function SendMsgToDingding() {
  curl $webhook -H 'Content-Type: application/json' -d "
  {
    'msgtype': 'text',
    'text': {
      'content': '集群名称:$cluster\n告警信息:虚拟IP<$vip>已漂移至节点<$host>,请注意\n'
    },
    'at': {
      'isAtAll': true
    }
  }"
}
SendMsgToDingding

此测试文件,调用执行时需要传入一个参数(VIP)。

触发执行,案例如下:

shell 操作钉钉机器人实现告警提醒的方法

手机钉钉收到的告警信息

shell 操作钉钉机器人实现告警提醒的方法

参考资料:

1.钉钉群机器人

https://ding-doc.dingtalk.com/doc#/serverapi2/krgddi

2.curl使用指南

https://www.jianshu.com/p/fc0eb6c60816

相关推荐