Skip to content

Add alarm target type lark / 支持飞书报警通知 #634

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
EricZhengH wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add alarm target type lark / 支持飞书报警通知 #634

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion efak-api/src/main/java/org/smartloli/kafka/eagle/api/im/IMService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@
*/
public interface IMService {

/** Send post request alert message by dingding. */
void sendPostMsgByLark(String data, String url);

/** Send post request alert message by dingding. */
public void sendPostMsgByDingDing(String data, String url);

/** Send alert message by wechat. */
Expand Down
14 changes: 12 additions & 2 deletions efak-api/src/main/java/org/smartloli/kafka/eagle/api/im/IMServiceImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,15 @@
*/
package org.smartloli.kafka.eagle.api.im;

import java.util.Date;

import org.smartloli.kafka.eagle.api.im.queue.DingDingJob;
import org.smartloli.kafka.eagle.api.im.queue.LarkJob;
import org.smartloli.kafka.eagle.api.im.queue.MailJob;
import org.smartloli.kafka.eagle.api.im.queue.WeChatJob;
import org.smartloli.kafka.eagle.common.protocol.alarm.queue.BaseJobContext;
import org.smartloli.kafka.eagle.common.util.QuartzManagerUtils;

import java.util.Date;

/**
* Implements IMService all method.
*
Expand All @@ -36,6 +37,15 @@ public class IMServiceImpl implements IMService {

private static final String KE_JOB_ID = "ke_job_id_";

/** Send Json msg by Lark. */
@Override
public void sendPostMsgByLark(String data, String url) {
BaseJobContext jobContext = new BaseJobContext();
jobContext.setData(data);
jobContext.setUrl(url);
QuartzManagerUtils.addJob(jobContext, KE_JOB_ID + new Date().getTime(), LarkJob.class, QuartzManagerUtils.getCron(new Date(), 5));
}

/** Send Json msg by dingding. */
@Override
public void sendPostMsgByDingDing(String data, String url) {
Expand Down
73 changes: 73 additions & 0 deletions efak-api/src/main/java/org/smartloli/kafka/eagle/api/im/queue/LarkJob.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
* <p>
* http://www.apache.org/licenses/LICENSE-2.0
* <p>
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.smartloli.kafka.eagle.api.im.queue;

import com.alibaba.fastjson.JSONObject;
import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import org.smartloli.kafka.eagle.common.protocol.alarm.queue.BaseJobContext;
import org.smartloli.kafka.eagle.common.util.HttpClientUtils;
import org.smartloli.kafka.eagle.common.util.KConstants.AlarmQueue;
import org.smartloli.kafka.eagle.common.util.LoggerUtils;

import java.util.HashMap;
import java.util.Map;

/**
* Add alarm message to lark job queue.
*
* @author Baiye.
* <p>
* Created by Aug 10, 2022
*/
public class LarkJob implements Job {

/**
* Send alarm information by Lark.
*/
public void execute(JobExecutionContext jobContext) throws JobExecutionException {
BaseJobContext bjc = (BaseJobContext) jobContext.getJobDetail().getJobDataMap().get(AlarmQueue.JOB_PARAMS);
sendMsg(bjc.getData(), bjc.getUrl());
}

private int sendMsg(String data, String url) {
try {
Map<String, Object> larkMessage = getLarkMessage(data);
String result = HttpClientUtils.doPostJson(url, JSONObject.toJSONString(larkMessage));
LoggerUtils.print(this.getClass()).info("Lark SendMsg Result: " + result);
} catch (Exception e) {
LoggerUtils.print(this.getClass()).error("Send alarm message has error by Lark, msg is ", e);
return 0;
}
return 1;
}

private static Map<String, Object> getLarkMessage(String text) {
Map<String, Object> map = new HashMap<>();
map.put("msg_type", "text");

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


return map;
}

}
17 changes: 17 additions & 0 deletions efak-api/src/main/java/org/smartloli/kafka/eagle/api/util/AlertUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,11 @@ private AlertUtils() {

}

public static String sendTestMsgByLark(String url, String data) {
Map<String, Object> larkMessage = getLarkMessage(data);
return HttpClientUtils.doPostJson(url, JSONObject.toJSONString(larkMessage));
}

/**
* Send Json msg by wechat.
*/
Expand All @@ -51,6 +56,18 @@ public static String sendTestMsgByWeChat(String url, String data) {
return HttpClientUtils.doPostJson(url, JSONObject.toJSONString(wechatMarkdownMessage));
}

private static Map<String, Object> getLarkMessage(String text) {
Map<String, Object> map = new HashMap<>();
map.put("msg_type", "text");

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


return map;
}

private static Map<String, Object> getWeChatMarkdownMessage(String text) {
Map<String, Object> map = new HashMap<>();
map.put("msgtype", MARKDOWN);
Expand Down
21 changes: 19 additions & 2 deletions efak-api/src/test/java/org/smartloli/kafka/eagle/api/sms/TestIM.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,29 @@
*/
public class TestIM {
public static void main(String[] args) {
testAlarmClusterByDingDingMarkDownNewStyle();
// testAlarmClusterByDingDingMarkDownNewStyle();
// testAlarmClusterByDingDingMarkDown();
// testAlarmClusterByWeChatMarkDown();
testAlarmClusterByLark();

}

private static void testAlarmClusterByLark() {
AlarmMessageInfo alarmMsg = new AlarmMessageInfo();
// FF0000 (red), 008000(green), FFA500(yellow)
alarmMsg.setTitle("`Kafka Eagle Alarm Notice`\n");
alarmMsg.setAlarmContent("<font color=\"warning\">node.shutdown [ localhost:9092 ]</font>");
// alarmMsg.setAlarmContent("<font color=\"#008000\">node.alive [
// localhost:9092 ]</font>");
alarmMsg.setAlarmDate("2019-10-07 21:43:22");
alarmMsg.setAlarmLevel("P0");
alarmMsg.setAlarmProject("Kafka");
alarmMsg.setAlarmStatus("<font color=\"warning\">PROBLEM</font>");
// alarmMsg.setAlarmStatus("<font color=\"#008000\">NORMAL</font>");
alarmMsg.setAlarmTimes("current(1), max(7)");

IMServiceImpl im = new IMServiceImpl();
im.sendPostMsgByLark(alarmMsg.toMail(), "xxx");
}
/**
* New alarm im api.
*/
Expand Down
3 changes: 2 additions & 1 deletion efak-common/src/main/java/org/smartloli/kafka/eagle/common/util/KConstants.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -345,14 +345,15 @@ private Component() {
}

public interface AlarmType {
public static String[] TYPE = new String[]{"DingDing", "WeChat", "Email"};
public static String[] TYPE = new String[]{"DingDing", "WeChat", "Email","Lark"};
public static String[] CLUSTER = new String[]{"Kafka", "Zookeeper", "Topic", "Producer"};
public static String[] LEVEL = new String[]{"P0", "P1", "P2", "P3"};
public static int[] MAXTIMES = new int[]{-1, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10};
public static String EMAIL = "Email";
public static String EMAIL_TEST_TITLE = "Kafka Eagle Send Test MSG";
public static String DingDing = "DingDing";
public static String WeChat = "WeChat";
public static String LARK = "Lark";
public static String HTTP_GET = "get";
public static String HTTP_POST = "post";
public static String DISABLE = "N";
Expand Down
2 changes: 2 additions & 0 deletions efak-web/src/main/java/org/smartloli/kafka/eagle/web/controller/AlarmController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -985,6 +985,8 @@ public void sendTestMsgAlarmConfig(@RequestBody AlarmEmailMockInfo emailMock, Ht
result = AlertUtils.sendTestMsgByDingDing(url, msg);
} else if (AlarmType.WeChat.equals(type)) {
result = AlertUtils.sendTestMsgByWeChat(url, msg);
} else if (AlarmType.LARK.equals(type)) {
result = AlertUtils.sendTestMsgByLark(url, msg);
}
byte[] output = result.getBytes();
BaseController.response(output, response);
Expand Down
54 changes: 54 additions & 0 deletions ...in/java/org/smartloli/kafka/eagle/web/quartz/shard/task/alert/ClusterStrategyContext.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,33 @@ public static void sendAlarmClusterError(AlarmConfigInfo alarmConfing, AlarmClus
alarmMsg.setAlarmTimes("current(" + cluster.getAlarmTimes() + "), max(" + cluster.getAlarmMaxTimes() + ")");
IMServiceImpl im = new IMServiceImpl();
im.sendPostMsgByWeChat(alarmMsg.toWeChatMarkDown(), alarmConfing.getAlarmUrl());
} else if (alarmConfing.getAlarmType().equals(KConstants.AlarmType.LARK)) {
AlarmMessageInfo alarmMsg = new AlarmMessageInfo();
alarmMsg.setAlarmId(cluster.getId());
alarmMsg.setAlarmCluster(alarmConfing.getCluster());
alarmMsg.setTitle("`EFAK - Alert Cluster Error`\n");
if (KConstants.AlarmType.TOPIC.equals(cluster.getType())) {
JSONObject alarmTopicMsg = JSON.parseObject(server);
String topic = alarmTopicMsg.getString("topic");
long alarmCapacity = alarmTopicMsg.getLong("alarmCapacity");
long realCapacity = alarmTopicMsg.getLong("realCapacity");
alarmMsg.setAlarmContent("topic.capacity.overflow [topic(" + topic + "), real.capacity(" + StrUtils.stringify(realCapacity) + "), alarm.capacity(" + StrUtils.stringify(alarmCapacity) + ")]");
} else if (KConstants.AlarmType.PRODUCER.equals(cluster.getType())) {
JSONObject alarmTopicMsg = JSON.parseObject(server);
String topic = alarmTopicMsg.getString("topic");
String alarmSpeeds = alarmTopicMsg.getString("alarmSpeeds");
long realSpeeds = alarmTopicMsg.getLong("realSpeeds");
alarmMsg.setAlarmContent("producer.speed.overflow [topic(" + topic + "), real.speeds(" + realSpeeds + "), alarm.speeds.range(" + alarmSpeeds + ")]");
} else {
alarmMsg.setAlarmContent("node.shutdown [ " + server + " ]");
}
alarmMsg.setAlarmDate(CalendarUtils.getDate());
alarmMsg.setAlarmLevel(cluster.getAlarmLevel());
alarmMsg.setAlarmProject(cluster.getType());
alarmMsg.setAlarmStatus("PROBLEM");
alarmMsg.setAlarmTimes("current(" + cluster.getAlarmTimes() + 1 + "), max(" + cluster.getAlarmMaxTimes() + ")");
IMServiceImpl im = new IMServiceImpl();
im.sendPostMsgByLark(alarmMsg.toMail(), alarmConfing.getAlarmUrl());
}
}

Expand Down Expand Up @@ -271,6 +298,33 @@ public static void sendAlarmClusterNormal(AlarmConfigInfo alarmConfing, AlarmClu
alarmMsg.setAlarmTimes("current(" + cluster.getAlarmTimes() + "), max(" + cluster.getAlarmMaxTimes() + ")");
IMServiceImpl im = new IMServiceImpl();
im.sendPostMsgByWeChat(alarmMsg.toWeChatMarkDown(), alarmConfing.getAlarmUrl());
} else if (alarmConfing.getAlarmType().equals(KConstants.AlarmType.LARK)) {
AlarmMessageInfo alarmMsg = new AlarmMessageInfo();
alarmMsg.setAlarmId(cluster.getId());
alarmMsg.setAlarmCluster(alarmConfing.getCluster());
alarmMsg.setTitle("`EFAK - Alert Cluster Error`\n");
if (KConstants.AlarmType.TOPIC.equals(cluster.getType())) {
JSONObject alarmTopicMsg = JSON.parseObject(server);
String topic = alarmTopicMsg.getString("topic");
long alarmCapacity = alarmTopicMsg.getLong("alarmCapacity");
long realCapacity = alarmTopicMsg.getLong("realCapacity");
alarmMsg.setAlarmContent("topic.capacity.overflow [topic(" + topic + "), real.capacity(" + StrUtils.stringify(realCapacity) + "), alarm.capacity(" + StrUtils.stringify(alarmCapacity) + ")]");
} else if (KConstants.AlarmType.PRODUCER.equals(cluster.getType())) {
JSONObject alarmTopicMsg = JSON.parseObject(server);
String topic = alarmTopicMsg.getString("topic");
String alarmSpeeds = alarmTopicMsg.getString("alarmSpeeds");
long realSpeeds = alarmTopicMsg.getLong("realSpeeds");
alarmMsg.setAlarmContent("producer.speed.overflow [topic(" + topic + "), real.speeds(" + realSpeeds + "), alarm.speeds.range(" + alarmSpeeds + ")]");
} else {
alarmMsg.setAlarmContent("node.shutdown [ " + server + " ]");
}
alarmMsg.setAlarmDate(CalendarUtils.getDate());
alarmMsg.setAlarmLevel(cluster.getAlarmLevel());
alarmMsg.setAlarmProject(cluster.getType());
alarmMsg.setAlarmStatus("PROBLEM");
alarmMsg.setAlarmTimes("current(" + cluster.getAlarmTimes() + 1 + "), max(" + cluster.getAlarmMaxTimes() + ")");
IMServiceImpl im = new IMServiceImpl();
im.sendPostMsgByLark(alarmMsg.toMail(), alarmConfing.getAlarmUrl());
}
}
}
12 changes: 12 additions & 0 deletions ...c/main/java/org/smartloli/kafka/eagle/web/quartz/shard/task/sub/AlertConsumerSubTask.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,12 @@ private void sendAlarmConsumerError(AlarmConfigInfo alarmConfing, AlarmConsumerI
alarmMsg.setAlarmStatus("<font color=\"warning\">PROBLEM</font>");
IMServiceImpl im = new IMServiceImpl();
im.sendPostMsgByWeChat(alarmMsg.toWeChatMarkDown(), alarmConfing.getAlarmUrl());
} else if (alarmConfing.getAlarmType().equals(KConstants.AlarmType.LARK)) {
alarmMsg.setTitle("`EFAK - Alert Consumer Notice`\n");
alarmMsg.setAlarmContent("lag.overflow [ cluster(" + alarmConsumer.getCluster() + "), group(" + alarmConsumer.getGroup() + "), topic(" + alarmConsumer.getTopic() + "), current(" + lag + "), max(" + alarmConsumer.getLag() + ") ]");
alarmMsg.setAlarmStatus("PROBLEM");
IMServiceImpl im = new IMServiceImpl();
im.sendPostMsgByLark(alarmMsg.toMail(), alarmConfing.getAlarmUrl());
}
}

Expand Down Expand Up @@ -176,6 +182,12 @@ private void sendAlarmConsumerNormal(AlarmConfigInfo alarmConfing, AlarmConsumer
alarmMsg.setAlarmStatus("<font color=\"#008000\">NORMAL</font>");
IMServiceImpl im = new IMServiceImpl();
im.sendPostMsgByWeChat(alarmMsg.toWeChatMarkDown(), alarmConfing.getAlarmUrl());
} else if (alarmConfing.getAlarmType().equals(KConstants.AlarmType.LARK)) {
alarmMsg.setTitle("`EFAK - Alert Consumer Notice`\n");
alarmMsg.setAlarmContent("lag.normal [ cluster(" + alarmConsumer.getCluster() + "), group(" + alarmConsumer.getGroup() + "), topic(" + alarmConsumer.getTopic() + "), current(" + lag + "), max(" + alarmConsumer.getLag() + ") ]");
alarmMsg.setAlarmStatus("NORMAL");
IMServiceImpl im = new IMServiceImpl();
im.sendPostMsgByLark(alarmMsg.toMail(), alarmConfing.getAlarmUrl());
}
}
}
Expand Down
2 changes: 2 additions & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
<project.version>3.0.0</project.version>
<endorsed.dir>${project.build.directory}/endorsed</endorsed.dir>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.source>1.8</maven.compiler.source>
<maven.compiler.target>1.8</maven.compiler.target>
</properties>

<modules>
Expand Down