xxl-job集成钉钉告警

xxl-job集成钉钉告警

本地启动xxl-job项目：

• 官方地址：官方地址
• 下载项目：gitee code地址，github code 地址
• 修改xxl-job-admin下的application.properties文件：
  1. 增加钉钉配置信息alarm.baseDingWebhook=https://oapi.dingtalk.com/robot/send?
  2. 修改mysql配置信息（url，username，password）
     
• 添加下面的钉钉告警类DingJobAlarm.java
• 启动项目：
  1. 先启动xxl-job-admin，执行XxlJobAdminApplication.java文件
  2. 再启动xxl-job-executor-samples下的xxl-job-executor-sample-springboot项目，执行xxl-job-executor-sample-springboot下的XxlJobExecutorApplication.java文件
  3. 打开web页面：http://localhost:8080/xxl-job-admin/， 登录名：admin，密码123456
  4. 修改调度执行器的ip地址，修改成127.0.0.1:9999，然后就可以执行任务了。

增加钉钉告警类：

• DingJobAlarm.java (钉钉告警类)

package com.xxl.job.admin.core.alarm.impl;

import com.xxl.job.admin.core.alarm.JobAlarm;
import com.xxl.job.admin.core.model.XxlJobInfo;
import com.xxl.job.admin.core.model.XxlJobLog;
import com.xxl.job.admin.core.scheduler.XxlJobScheduler;
import com.xxl.job.core.biz.ExecutorBiz;
import com.xxl.job.core.biz.model.LogParam;
import com.xxl.job.core.biz.model.LogResult;
import com.xxl.job.core.biz.model.ReturnT;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
import org.springframework.web.client.RestTemplate;

import java.text.SimpleDateFormat;
import java.util.*;

/**
 * 钉钉告警
 *
 * @author
 */
@Component
public class DingJobAlarm implements JobAlarm {

    private static Logger logger = LoggerFactory.getLogger(DingJobAlarm.class);

    @Value("${alarm.baseDingWebhook}")
    private String baseDingWebhook;

    private final RestTemplate restTemplate = new RestTemplate();

    /**
     * fail alarm
     *
     * @param info
     * @param jobLog
     * @return
     */
    @Override
    public boolean doAlarm(XxlJobInfo info, XxlJobLog jobLog) {
        boolean alarmResult = true;
        logger.info("ding----------------");

        if(info!=null && info.getAlarmEmail()!=null && info.getAlarmEmail().trim().length()>0){
			// 如果不包含access_token，则直接退出，调用email告警任务
            if (!info.getAlarmEmail().contains("access_token")){
                return alarmResult;
            }

            // 读取Webhook
            Set<String> dingWebhookSet = new HashSet<String>(Arrays.asList(info.getAlarmEmail().split(",")));
            Map<String, Object> map = loadEmailJobAlarmTemplate(info,jobLog);

            // 发送钉钉消息
            for (String dingWebhook: dingWebhookSet) {
                try {
                    restTemplate.postForEntity(baseDingWebhook + dingWebhook,map,Object.class);
                } catch (Exception e) {
                    logger.error(">>>>>>>>>>> xxl-job, job fail alarm email send error, JobLogId:{}", jobLog.getId(), e);
                    alarmResult = false;
                }

            }
        }

        return alarmResult;
    }

    /**
     * 封装消息内容
     * @param info
     * @param jobLog
     * @return
     */
    private static Map<String, Object> loadEmailJobAlarmTemplate(XxlJobInfo info, XxlJobLog jobLog) {

        HashMap<String, Object> requestMap = new HashMap<>();
        ExecutorBiz executorBiz = null;
        try {
            executorBiz = XxlJobScheduler.getExecutorBiz(jobLog.getExecutorAddress());
        } catch (Exception e) {
            e.printStackTrace();
        }
        
        // 获取执行日志信息
        ReturnT<LogResult> logResult = executorBiz.log(new LogParam(jobLog.getTriggerTime().getTime(), jobLog.getId(), 1));
        String errorMsg = logResult.getContent().getLogContent();

        // 消息类型
        requestMap.put("msgtype", "text");
        // 消息内容
        String content = "【数仓调度任务告警信息】 \t\n" +
                "任务id : \t" + info.getId() + "\t\n" +
                "任务名称 : \t" + info.getJobDesc() + "\t\n" +
                "TriggerMsg : \t" + jobLog.getTriggerMsg().replace("<br>","\n") + "\t\n" +
                "errorMsg : \t" + errorMsg + "\t\n" +
                "报警时间 : \t" + new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()) + "\t\n";

//        String content = "【告警信息】 \t\n" +
//                "负责人 : \t" + info.getAuthor() + "\t\n" +
//                "任务id : \t" + info.getId() + "\t\n" +
//                "任务名称 : \t" + info.getJobDesc() + "\t\n" +
//                "执行器名称 : \t" + info.getExecutorHandler() + "\t\n" +
//                "执行器ip : \t" + jobLog.getExecutorAddress() + "\t\n" +
//                "任务参数 : \t" + jobLog.getExecutorParam() + "\t\n" +
//                "LogId : \t" + jobLog.getId() + "\t\n" +
//                "TriggerMsg : \t" + jobLog.getTriggerMsg().replace("<br>","\n") + "\t\n" +
//                "HandleCode : \t" + jobLog.getHandleMsg() + "\t\n" +
//                "报警时间 : \t" + new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()) + "\t\n";

        HashMap<String, Object> map = new HashMap<>();
        map.put("content",content);
        requestMap.put("text", map);

        // 设置是否@指定人
//        Map<String, Object> atmap = new HashMap<String, Object>();
//        String[] authorList = info.getAuthor().split(",");
//        ArrayList arrayList = new ArrayList();
//        for (String author : authorList){
//            if ("".equals(author) || author.split("-").length<2){
//                continue;
//            }
//            arrayList.add(author.split("-")[1]);
//        }
//        if (arrayList.size() > 0){
//            atmap.put("atMobiles",arrayList.toArray());
//            requestMap.put("at",atmap);
//        }

        return requestMap;
    }
}

注意：

• RestTemplate 使用@autowired注解初始化为NULL的问题，我们需要在类中定义初始化restTemplate的方法。详细解决方法可见：解决RestTemplate @autowired为null问题。

  // 本文直接new，可以使用注解进行初始化
  private final RestTemplate restTemplate = new RestTemplate();
  

• jobLog.getTriggerMsg()：该方法其实获取的是 “执行备注” 信息，如果想获取的执行日志信息，则需要执行executorBiz.log()来获取LogResult，然后通过logResult.getContent().getLogContent()来获取详细的报错日志信息。

  // 获取执行日志信息
  ReturnT<LogResult> logResult = executorBiz.log(new LogParam(jobLog.getTriggerTime().getTime(), jobLog.getId(), 1));
  String errorMsg = logResult.getContent().getLogContent();
  

• 判断是否包含access_token信息，如果包含则执行钉钉告警，如果不包含，则直接退出，并调用邮箱告警。

  // 如果不包含access_token，则直接退出，调用email告警任务
  if (!info.getAlarmEmail().contains("access_token")){
     return alarmResult;
  }
  

• 告警信息必须包含钉钉机器人设置的关键词，例如 【数仓调度任务告警信息】。否则不会产生告警，这个根据自己的机器人进行调整。

结果展示：

1. 创建任务，并填写钉钉机器人的access_token信息。
   
2. 报警展示：