写了个自动巡检多个接口地址的脚本！

Posted 2023-01-03

没错，这次我结合工作运用场景在现网环境服务器上部署了一个自动巡检多个接口地址是否正常并按 crontab 定时任务通过企业微信机器人以文本的形式发送到告警群的脚本。

思路需求很明确，目前接口服务器为固定设备、固定 IP。首先，我们可以先创建一个接口地址检查的目录以及需要输出的日志文件。

第一步：
# mkdir -p /opt/interface-check

第二步：
# cd /opt/interface-check/
# touch interface.log

mkdir [-p] DirName：确保目录名称存在，如果目录名称不存在，则需要新创建一个。

接着，我们只需在这一台服务器上将对接过的省份、企业的接口地址，以及包括自身回调地址、涉及相关内部网络可以互通的各种接口地址全部收集起来。

第三步：

vim jkdz-check.sh

#!/bin/bash

#1、北京接口地址
http_beijing_addr=接口地址
#2、xxx企业接口地址
http_xxxqiye_addr=接口地址

# 企业微信机器人地址（需要根据实际机器人地址配置）
WEBHOOK_URL=企业微信机器人地址

# 循环执行检测方法
while :
do
       date=$(date +%Y-%m-%d-%H:%M:%S)

       #1、北京接口地址检测
       beijing_status_code=`curl -m 20 -s -o /dev/null -w %http_code $http_beijing_addr`
       if [ "$beijing_status_code" -ne 200 ]
       then

        curl --location --request POST $WEBHOOK_URL \\
--header Content-Type: application/json \\
-d "msgtype": "text","text": "content": "$date 北京-接口连接异常"
       echo "$date 北京-接口连接异常" >>/opt/interface-check/interface.log

       else

       echo "$date 北京-接口连接正常" >>/opt/interface-check/interface.log
       fi

       #2、xxx企业接口地址检测
       xxxqiye_status_code=`curl -m 20 -s -o /dev/null -w %http_code $http_xxxqiye_addr`
       if [ "$xxxqiye_status_code" -ne 200 ]
       then

        curl --location --request POST $WEBHOOK_URL \\
--header Content-Type: application/json \\
-d "msgtype": "text","text": "content": "$date xxx企业-接口连接异常"
       echo "$date xxx企业-接口连接异常" >>/opt/interface-check/interface.log

       else

       echo "$date xxx企业-接口连接正常" >>/opt/interface-check/interface.log
       fi

exit

done

通过 while 循环语句进行多次循环接口地址检测、if 判断语句来判断省份、企业的接口正常 / 异常情况并输出打印日志至 /opt/interface-check/interface.log 文件中。

企业微信添加群机器人方法：

1、需先建一个群，建好后，通过聊天信息找到添加群机器人。

2、新建机器人，填写好机器人名称，保存。

3、添加成功后，创建者可以在机器人详情页看到该机器人特有的 webhookurl，可以按说明 a 向这个地址发起 HTTP POST 请求，即可实现给该群组发送消息。

根据机器人配置说明，可以看到有用 curl 工具往群组推送文本消息的示例：

curl webhookurl地址 \\
   -H Content-Type: application/json \\
   -d 
   
        "msgtype": "text",
        "text": 
            "content": "hello world"
        
   

注意要将 webhookurl 替换成你的机器人 webhook 地址，content 必须是 utf8 编码。

当前自定义机器人支持文本（text）、markdown（markdown）、图片（image）、图文（news）四种消息类型。

机器人的 text/markdown 类型消息支持在 content 中使用 <@userid> 扩展语法来 @群成员。

除此之外，还有消息类型及数据格式（文本类型、markdown类型、图片类型、图文类型、文件类型）模版卡片类型（文本通知模版卡片、图文展示模版卡片）消息发送频率限制、文件上传接口等配置说明，可根据实际需求参考进行配置。

第三步脚本中需根据实际情况更新接口地址、企业微信机器人地址、$http_beijing_addr、beijing_status_code、$date 北京-接口连接异常、$date 北京-接口连接正常字段。

配置无误后，可以先手动验证下脚本的语法是否无误，避免出现语法错误：未预期的文件结尾提示。

脚本中未加 &> /dev/null 相关参数配置，因此在验证脚本时，会有打印信息提示，我们可以放后台运行。

# nohup bash /opt/interface-check/jkdz-check.sh &

# more nohup.out
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   134  100    27  100   107     64    254 --:--:-- --:--:-- --:--:--   254
"errcode":0,"errmsg":"ok"  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   140  100    27  100   113     63    267 --:--:-- --:--:-- --:--:--   267
"errcode":0,"errmsg":"ok"  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   134  100    27  100   107     61    244 --:--:-- --:--:-- --:--:--   245
"errcode":0,"errmsg":"ok"  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   134  100    27  100   107     58    232 --:--:-- --:--:-- --:--:--   232
"errcode":0,"errmsg":"ok"  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   140  100    27  100   113     56    235 --:--:-- --:--:-- --:--:--   235
"errcode":0,"errmsg":"ok"  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   140  100    27  100   113     58    244 --:--:-- --:--:-- --:--:--   244

写个 crontab 定时任务，每 2 小时执行该脚本。

第四步：
crontab -e
0 */2 * * * sh /opt/interface-check/jkdz-check.sh

最后，我们可以通过企业微信群查看机器人发送的告警信息，效果如下：

输出的 log 日志情况如下：

---

以上就是今天所要分享的全部内容了。

如果你觉得这篇文章对你有点用的话，为本文点个赞、留个言或者转发一下，让更多的朋友看到，因为这将是我持续输出更多优质文章的最强动力！