任务告警组件模块化:如果需要新增一种告警方式,只需要新增一个实现 "com.xxl.job.admin.core.alarm.JobAlarm" 接口的告警实现即可,更加灵活、方便定制;
This commit is contained in:
parent
4e1123aad1
commit
882a439ef1
|
@ -1245,7 +1245,8 @@ API服务请求参考代码:com.xxl.job.executor.ExecutorBizTest
|
||||||
- 2、提供基于HTTP的任务Handler(Bean任务,JobHandler="HttpJobHandler");业务方只需要提供HTTP链接即可,不限制语言、平台;
|
- 2、提供基于HTTP的任务Handler(Bean任务,JobHandler="HttpJobHandler");业务方只需要提供HTTP链接即可,不限制语言、平台;
|
||||||
|
|
||||||
### 5.18 任务失败告警
|
### 5.18 任务失败告警
|
||||||
默认提供邮件失败告警,可扩展短信、钉钉等方式,扩展代码位置为 "JobFailMonitorHelper.failAlarm";
|
默认提供邮件失败告警,可扩展短信、钉钉等方式,扩展代码位置为 "com.xxl.job.admin.core.alarm.JobAlarmer"。
|
||||||
|
如果需要新增一种告警方式,只需要新增一个实现 "com.xxl.job.admin.core.alarm.JobAlarm" 接口的告警实现即可
|
||||||
|
|
||||||
### 5.19 调度中心Docker镜像构建
|
### 5.19 调度中心Docker镜像构建
|
||||||
可以通过以下命令快速构建调度中心,并启动运行;
|
可以通过以下命令快速构建调度中心,并启动运行;
|
||||||
|
@ -1691,6 +1692,7 @@ public ReturnT<String> execute(String param) {
|
||||||
- 3、SQL脚本编码默认utf8mb4执行,避免小概率下容器环境中乱码问题;
|
- 3、SQL脚本编码默认utf8mb4执行,避免小概率下容器环境中乱码问题;
|
||||||
- 4、多个项目依赖升级至较新稳定版本,如mybatis、groovy和mysql驱动等;
|
- 4、多个项目依赖升级至较新稳定版本,如mybatis、groovy和mysql驱动等;
|
||||||
- 5、默认数据库连接池调整为hikari,移除tomcat-jdbc依赖;
|
- 5、默认数据库连接池调整为hikari,移除tomcat-jdbc依赖;
|
||||||
|
- 6、任务告警组件模块化:如果需要新增一种告警方式,只需要新增一个实现 "com.xxl.job.admin.core.alarm.JobAlarm" 接口的告警实现即可,更加灵活、方便定制;
|
||||||
|
|
||||||
|
|
||||||
### TODO LIST
|
### TODO LIST
|
||||||
|
|
|
@ -0,0 +1,20 @@
|
||||||
|
package com.xxl.job.admin.core.alarm;
|
||||||
|
|
||||||
|
import com.xxl.job.admin.core.model.XxlJobInfo;
|
||||||
|
import com.xxl.job.admin.core.model.XxlJobLog;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @author xuxueli 2020-01-19
|
||||||
|
*/
|
||||||
|
public interface JobAlarm {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* job alarm
|
||||||
|
*
|
||||||
|
* @param info
|
||||||
|
* @param jobLog
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public boolean doAlarm(XxlJobInfo info, XxlJobLog jobLog);
|
||||||
|
|
||||||
|
}
|
|
@ -0,0 +1,36 @@
|
||||||
|
package com.xxl.job.admin.core.alarm;
|
||||||
|
|
||||||
|
import com.xxl.job.admin.core.alarm.impl.EmailJobAlarm;
|
||||||
|
import com.xxl.job.admin.core.model.XxlJobInfo;
|
||||||
|
import com.xxl.job.admin.core.model.XxlJobLog;
|
||||||
|
import org.springframework.stereotype.Component;
|
||||||
|
|
||||||
|
import javax.annotation.Resource;
|
||||||
|
|
||||||
|
@Component
|
||||||
|
public class JobAlarmer {
|
||||||
|
|
||||||
|
@Resource
|
||||||
|
private EmailJobAlarm emailJobAlarm;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* job alarm
|
||||||
|
*
|
||||||
|
* @param info
|
||||||
|
* @param jobLog
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public boolean alarm(XxlJobInfo info, XxlJobLog jobLog) {
|
||||||
|
|
||||||
|
// alarm by email
|
||||||
|
boolean emailResult = emailJobAlarm.doAlarm(info, jobLog);
|
||||||
|
|
||||||
|
// do something, custom alarm strategy, such as sms
|
||||||
|
// ...
|
||||||
|
|
||||||
|
return emailResult;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
}
|
|
@ -0,0 +1,117 @@
|
||||||
|
package com.xxl.job.admin.core.alarm.impl;
|
||||||
|
|
||||||
|
import com.xxl.job.admin.core.alarm.JobAlarm;
|
||||||
|
import com.xxl.job.admin.core.conf.XxlJobAdminConfig;
|
||||||
|
import com.xxl.job.admin.core.model.XxlJobGroup;
|
||||||
|
import com.xxl.job.admin.core.model.XxlJobInfo;
|
||||||
|
import com.xxl.job.admin.core.model.XxlJobLog;
|
||||||
|
import com.xxl.job.admin.core.util.I18nUtil;
|
||||||
|
import com.xxl.job.core.biz.model.ReturnT;
|
||||||
|
import org.slf4j.Logger;
|
||||||
|
import org.slf4j.LoggerFactory;
|
||||||
|
import org.springframework.mail.javamail.MimeMessageHelper;
|
||||||
|
import org.springframework.stereotype.Component;
|
||||||
|
|
||||||
|
import javax.mail.internet.MimeMessage;
|
||||||
|
import java.text.MessageFormat;
|
||||||
|
import java.util.Arrays;
|
||||||
|
import java.util.HashSet;
|
||||||
|
import java.util.Set;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* job alarm by email
|
||||||
|
*
|
||||||
|
* @author xuxueli 2020-01-19
|
||||||
|
*/
|
||||||
|
@Component
|
||||||
|
public class EmailJobAlarm implements JobAlarm {
|
||||||
|
private static Logger logger = LoggerFactory.getLogger(EmailJobAlarm.class);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* fail alarm
|
||||||
|
*
|
||||||
|
* @param jobLog
|
||||||
|
*/
|
||||||
|
public boolean doAlarm(XxlJobInfo info, XxlJobLog jobLog){
|
||||||
|
boolean alarmResult = true;
|
||||||
|
|
||||||
|
// send monitor email
|
||||||
|
if (info!=null && info.getAlarmEmail()!=null && info.getAlarmEmail().trim().length()>0) {
|
||||||
|
|
||||||
|
// alarmContent
|
||||||
|
String alarmContent = "Alarm Job LogId=" + jobLog.getId();
|
||||||
|
if (jobLog.getTriggerCode() != ReturnT.SUCCESS_CODE) {
|
||||||
|
alarmContent += "<br>TriggerMsg=<br>" + jobLog.getTriggerMsg();
|
||||||
|
}
|
||||||
|
if (jobLog.getHandleCode()>0 && jobLog.getHandleCode() != ReturnT.SUCCESS_CODE) {
|
||||||
|
alarmContent += "<br>HandleCode=" + jobLog.getHandleMsg();
|
||||||
|
}
|
||||||
|
|
||||||
|
// email info
|
||||||
|
XxlJobGroup group = XxlJobAdminConfig.getAdminConfig().getXxlJobGroupDao().load(Integer.valueOf(info.getJobGroup()));
|
||||||
|
String personal = I18nUtil.getString("admin_name_full");
|
||||||
|
String title = I18nUtil.getString("jobconf_monitor");
|
||||||
|
String content = MessageFormat.format(loadEmailJobAlarmTemplate(),
|
||||||
|
group!=null?group.getTitle():"null",
|
||||||
|
info.getId(),
|
||||||
|
info.getJobDesc(),
|
||||||
|
alarmContent);
|
||||||
|
|
||||||
|
Set<String> emailSet = new HashSet<String>(Arrays.asList(info.getAlarmEmail().split(",")));
|
||||||
|
for (String email: emailSet) {
|
||||||
|
|
||||||
|
// make mail
|
||||||
|
try {
|
||||||
|
MimeMessage mimeMessage = XxlJobAdminConfig.getAdminConfig().getMailSender().createMimeMessage();
|
||||||
|
|
||||||
|
MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true);
|
||||||
|
helper.setFrom(XxlJobAdminConfig.getAdminConfig().getEmailUserName(), personal);
|
||||||
|
helper.setTo(email);
|
||||||
|
helper.setSubject(title);
|
||||||
|
helper.setText(content, true);
|
||||||
|
|
||||||
|
XxlJobAdminConfig.getAdminConfig().getMailSender().send(mimeMessage);
|
||||||
|
} catch (Exception e) {
|
||||||
|
logger.error(">>>>>>>>>>> xxl-job, job fail alarm email send error, JobLogId:{}", jobLog.getId(), e);
|
||||||
|
|
||||||
|
alarmResult = false;
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return alarmResult;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* load email job alarm template
|
||||||
|
*
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
private static final String loadEmailJobAlarmTemplate(){
|
||||||
|
String mailBodyTemplate = "<h5>" + I18nUtil.getString("jobconf_monitor_detail") + ":</span>" +
|
||||||
|
"<table border=\"1\" cellpadding=\"3\" style=\"border-collapse:collapse; width:80%;\" >\n" +
|
||||||
|
" <thead style=\"font-weight: bold;color: #ffffff;background-color: #ff8c00;\" >" +
|
||||||
|
" <tr>\n" +
|
||||||
|
" <td width=\"20%\" >"+ I18nUtil.getString("jobinfo_field_jobgroup") +"</td>\n" +
|
||||||
|
" <td width=\"10%\" >"+ I18nUtil.getString("jobinfo_field_id") +"</td>\n" +
|
||||||
|
" <td width=\"20%\" >"+ I18nUtil.getString("jobinfo_field_jobdesc") +"</td>\n" +
|
||||||
|
" <td width=\"10%\" >"+ I18nUtil.getString("jobconf_monitor_alarm_title") +"</td>\n" +
|
||||||
|
" <td width=\"40%\" >"+ I18nUtil.getString("jobconf_monitor_alarm_content") +"</td>\n" +
|
||||||
|
" </tr>\n" +
|
||||||
|
" </thead>\n" +
|
||||||
|
" <tbody>\n" +
|
||||||
|
" <tr>\n" +
|
||||||
|
" <td>{0}</td>\n" +
|
||||||
|
" <td>{1}</td>\n" +
|
||||||
|
" <td>{2}</td>\n" +
|
||||||
|
" <td>"+ I18nUtil.getString("jobconf_monitor_alarm_type") +"</td>\n" +
|
||||||
|
" <td>{3}</td>\n" +
|
||||||
|
" </tr>\n" +
|
||||||
|
" </tbody>\n" +
|
||||||
|
"</table>";
|
||||||
|
|
||||||
|
return mailBodyTemplate;
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
|
@ -1,5 +1,6 @@
|
||||||
package com.xxl.job.admin.core.conf;
|
package com.xxl.job.admin.core.conf;
|
||||||
|
|
||||||
|
import com.xxl.job.admin.core.alarm.JobAlarmer;
|
||||||
import com.xxl.job.admin.core.scheduler.XxlJobScheduler;
|
import com.xxl.job.admin.core.scheduler.XxlJobScheduler;
|
||||||
import com.xxl.job.admin.dao.*;
|
import com.xxl.job.admin.dao.*;
|
||||||
import org.springframework.beans.factory.DisposableBean;
|
import org.springframework.beans.factory.DisposableBean;
|
||||||
|
@ -81,6 +82,8 @@ public class XxlJobAdminConfig implements InitializingBean, DisposableBean {
|
||||||
private JavaMailSender mailSender;
|
private JavaMailSender mailSender;
|
||||||
@Resource
|
@Resource
|
||||||
private DataSource dataSource;
|
private DataSource dataSource;
|
||||||
|
@Resource
|
||||||
|
private JobAlarmer jobAlarmer;
|
||||||
|
|
||||||
|
|
||||||
public String getI18n() {
|
public String getI18n() {
|
||||||
|
@ -144,4 +147,8 @@ public class XxlJobAdminConfig implements InitializingBean, DisposableBean {
|
||||||
return dataSource;
|
return dataSource;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public JobAlarmer getJobAlarmer() {
|
||||||
|
return jobAlarmer;
|
||||||
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,22 +1,14 @@
|
||||||
package com.xxl.job.admin.core.thread;
|
package com.xxl.job.admin.core.thread;
|
||||||
|
|
||||||
import com.xxl.job.admin.core.conf.XxlJobAdminConfig;
|
import com.xxl.job.admin.core.conf.XxlJobAdminConfig;
|
||||||
import com.xxl.job.admin.core.model.XxlJobGroup;
|
|
||||||
import com.xxl.job.admin.core.model.XxlJobInfo;
|
import com.xxl.job.admin.core.model.XxlJobInfo;
|
||||||
import com.xxl.job.admin.core.model.XxlJobLog;
|
import com.xxl.job.admin.core.model.XxlJobLog;
|
||||||
import com.xxl.job.admin.core.trigger.TriggerTypeEnum;
|
import com.xxl.job.admin.core.trigger.TriggerTypeEnum;
|
||||||
import com.xxl.job.admin.core.util.I18nUtil;
|
import com.xxl.job.admin.core.util.I18nUtil;
|
||||||
import com.xxl.job.core.biz.model.ReturnT;
|
|
||||||
import org.slf4j.Logger;
|
import org.slf4j.Logger;
|
||||||
import org.slf4j.LoggerFactory;
|
import org.slf4j.LoggerFactory;
|
||||||
import org.springframework.mail.javamail.MimeMessageHelper;
|
|
||||||
|
|
||||||
import javax.mail.internet.MimeMessage;
|
|
||||||
import java.text.MessageFormat;
|
|
||||||
import java.util.Arrays;
|
|
||||||
import java.util.HashSet;
|
|
||||||
import java.util.List;
|
import java.util.List;
|
||||||
import java.util.Set;
|
|
||||||
import java.util.concurrent.TimeUnit;
|
import java.util.concurrent.TimeUnit;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -71,7 +63,7 @@ public class JobFailMonitorHelper {
|
||||||
if (info!=null && info.getAlarmEmail()!=null && info.getAlarmEmail().trim().length()>0) {
|
if (info!=null && info.getAlarmEmail()!=null && info.getAlarmEmail().trim().length()>0) {
|
||||||
boolean alarmResult = true;
|
boolean alarmResult = true;
|
||||||
try {
|
try {
|
||||||
alarmResult = failAlarm(info, log);
|
alarmResult = XxlJobAdminConfig.getAdminConfig().getJobAlarmer().alarm(info, log);
|
||||||
} catch (Exception e) {
|
} catch (Exception e) {
|
||||||
alarmResult = false;
|
alarmResult = false;
|
||||||
logger.error(e.getMessage(), e);
|
logger.error(e.getMessage(), e);
|
||||||
|
@ -121,89 +113,4 @@ public class JobFailMonitorHelper {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
// ---------------------- alarm ----------------------
|
|
||||||
|
|
||||||
// email alarm template
|
|
||||||
private static final String mailBodyTemplate = "<h5>" + I18nUtil.getString("jobconf_monitor_detail") + ":</span>" +
|
|
||||||
"<table border=\"1\" cellpadding=\"3\" style=\"border-collapse:collapse; width:80%;\" >\n" +
|
|
||||||
" <thead style=\"font-weight: bold;color: #ffffff;background-color: #ff8c00;\" >" +
|
|
||||||
" <tr>\n" +
|
|
||||||
" <td width=\"20%\" >"+ I18nUtil.getString("jobinfo_field_jobgroup") +"</td>\n" +
|
|
||||||
" <td width=\"10%\" >"+ I18nUtil.getString("jobinfo_field_id") +"</td>\n" +
|
|
||||||
" <td width=\"20%\" >"+ I18nUtil.getString("jobinfo_field_jobdesc") +"</td>\n" +
|
|
||||||
" <td width=\"10%\" >"+ I18nUtil.getString("jobconf_monitor_alarm_title") +"</td>\n" +
|
|
||||||
" <td width=\"40%\" >"+ I18nUtil.getString("jobconf_monitor_alarm_content") +"</td>\n" +
|
|
||||||
" </tr>\n" +
|
|
||||||
" </thead>\n" +
|
|
||||||
" <tbody>\n" +
|
|
||||||
" <tr>\n" +
|
|
||||||
" <td>{0}</td>\n" +
|
|
||||||
" <td>{1}</td>\n" +
|
|
||||||
" <td>{2}</td>\n" +
|
|
||||||
" <td>"+ I18nUtil.getString("jobconf_monitor_alarm_type") +"</td>\n" +
|
|
||||||
" <td>{3}</td>\n" +
|
|
||||||
" </tr>\n" +
|
|
||||||
" </tbody>\n" +
|
|
||||||
"</table>";
|
|
||||||
|
|
||||||
/**
|
|
||||||
* fail alarm
|
|
||||||
*
|
|
||||||
* @param jobLog
|
|
||||||
*/
|
|
||||||
private boolean failAlarm(XxlJobInfo info, XxlJobLog jobLog){
|
|
||||||
boolean alarmResult = true;
|
|
||||||
|
|
||||||
// send monitor email
|
|
||||||
if (info!=null && info.getAlarmEmail()!=null && info.getAlarmEmail().trim().length()>0) {
|
|
||||||
|
|
||||||
// alarmContent
|
|
||||||
String alarmContent = "Alarm Job LogId=" + jobLog.getId();
|
|
||||||
if (jobLog.getTriggerCode() != ReturnT.SUCCESS_CODE) {
|
|
||||||
alarmContent += "<br>TriggerMsg=<br>" + jobLog.getTriggerMsg();
|
|
||||||
}
|
|
||||||
if (jobLog.getHandleCode()>0 && jobLog.getHandleCode() != ReturnT.SUCCESS_CODE) {
|
|
||||||
alarmContent += "<br>HandleCode=" + jobLog.getHandleMsg();
|
|
||||||
}
|
|
||||||
|
|
||||||
// email info
|
|
||||||
XxlJobGroup group = XxlJobAdminConfig.getAdminConfig().getXxlJobGroupDao().load(Integer.valueOf(info.getJobGroup()));
|
|
||||||
String personal = I18nUtil.getString("admin_name_full");
|
|
||||||
String title = I18nUtil.getString("jobconf_monitor");
|
|
||||||
String content = MessageFormat.format(mailBodyTemplate,
|
|
||||||
group!=null?group.getTitle():"null",
|
|
||||||
info.getId(),
|
|
||||||
info.getJobDesc(),
|
|
||||||
alarmContent);
|
|
||||||
|
|
||||||
Set<String> emailSet = new HashSet<String>(Arrays.asList(info.getAlarmEmail().split(",")));
|
|
||||||
for (String email: emailSet) {
|
|
||||||
|
|
||||||
// make mail
|
|
||||||
try {
|
|
||||||
MimeMessage mimeMessage = XxlJobAdminConfig.getAdminConfig().getMailSender().createMimeMessage();
|
|
||||||
|
|
||||||
MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true);
|
|
||||||
helper.setFrom(XxlJobAdminConfig.getAdminConfig().getEmailUserName(), personal);
|
|
||||||
helper.setTo(email);
|
|
||||||
helper.setSubject(title);
|
|
||||||
helper.setText(content, true);
|
|
||||||
|
|
||||||
XxlJobAdminConfig.getAdminConfig().getMailSender().send(mimeMessage);
|
|
||||||
} catch (Exception e) {
|
|
||||||
logger.error(">>>>>>>>>>> xxl-job, job fail alarm email send error, JobLogId:{}", jobLog.getId(), e);
|
|
||||||
|
|
||||||
alarmResult = false;
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// do something, custom alarm strategy, such as sms
|
|
||||||
|
|
||||||
|
|
||||||
return alarmResult;
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue