So implementieren Sie einen abnormalen Protokollalarm in JAVA basierend auf Slack

1. Funktionseinführung

Implementierungslogik: Unter normalen Umständen wird es eine geben Um mit Ausnahmen umzugehen, ist es am einfachsten, das Protokoll zu drucken. In diesem Artikel wird erläutert, dass beim Drucken des Protokolls gleichzeitig die Ausnahmeinformationen an den Slack-Kanal gesendet werden Slack-Konto und Treten Sie dem Kanal bei, um in Echtzeit eine Benachrichtigung über ungewöhnliche Informationen zu erhalten.

2. Einführung in Slack

Slack Es ist ein webbasiertes Echtzeit-Kommunikationstool, das als einzelne Anwendung für Desktops/Laptops, mobile Geräte und als Web verfügbar ist Anwendungsnutzung. Im Grunde ist es Ihr privater Chat- und Kollaborationsraum. Für viele Unternehmen hat es E-Mail/private Foren/Chatrooms als primären internen textbasierten Kommunikationskanal ersetzt.

kann als Chat-Gruppe + umfangreiche Tool-Integration + Dateiintegration + einheitliche Suche verstanden werden. Mit Stand Ende 2014 hat Slack 65 Tools und Dienste wie E-Mail, Textnachrichten, Google Drives, Twitter, Trello, Asana, GitHub usw. integriert, die verschiedene fragmentierte Unternehmenskommunikation und -zusammenarbeit zusammenführen können. Mehrere wichtige Konzepte:

WORKSPACE: Benutzer können verschiedenen Arbeitsbereichen beitreten oder diese erstellen. Der Name und die URL des Arbeitsbereichs sind häufig der Firmenname .

Channel: Kanäle können in verschiedene Teams oder Themen unterteilt werden und können auch als Äquivalent zu WeChat verstanden werden, wo Mitglieder im Kanal Informationen im Kanal teilen.

3. Vorbereitende Vorbereitung

Slack-Konfiguration

• Erstellen Sie ein Konto und melden Sie sich an. Sie können die App verwenden oder Browser Melden Sie sich bei der Webversion an

• um Ihren eigenen Arbeitsbereich zu erstellen, und Sie können auch andere einladen, dem Arbeitsbereich beizutreten.

• Erstellen Sie einen Kanal und laden Sie Kollegen zum Beitritt ein. Zu diesem Zeitpunkt können Sie Nachrichten an den Kanal senden, und jeder, der dem Kanal beitritt, kann die Nachricht #🎜🎜 sehen #

  # 🎜🎜#
Anwendung zum Arbeitsbereich hinzufügen

Eingehender WebHook

, wählen Sie den Kanal aus, speichern Sie die Webhook-URL und senden Sie später Nachrichten über das Webhook-Implementierungsprogramm an den Kanal .

# 🎜 🎜#

pom.xml

<dependencies>
    <dependency>
        <groupId>org.apache.httpcomponents</groupId>
        <artifactId>httpclient</artifactId>
        <version>4.5.2</version>
    </dependency>
    <dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>fastjson</artifactId>
        <version>1.2.83</version>
    </dependency>
    <dependency>
        <groupId>commons-configuration</groupId>
        <artifactId>commons-configuration</artifactId>
        <version>1.10</version>
    </dependency>
    <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.10</version>
        <scope>test</scope>
    </dependency>
</dependencies>

4. Spezifische Implementierung

1. Implementieren Sie Slack zum Senden von Nachrichten

SlackUtil-Tool zum Senden von Nachrichten zur Slack-Klasse

package com.yy.operation;
import com.yy.common.CommonThreadFactory;
import com.yy.common.ConnUtil;
import org.apache.commons.lang.StringUtils;
import java.text.MessageFormat;
import java.text.SimpleDateFormat;
import java.util.concurrent.*;
import java.util.logging.Level;
import java.util.logging.Logger;
/**
 * @author ：Max
 * @date ：Created in 2022/8/26 下午12:54
 * @description：
 */
public class SlackUtil {
    private static final Logger logger = Logger.getLogger(SlackUtil.class.getCanonicalName());
    private static SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    private static final String SEND_USER_NAME ="运维机器人";
    private static int MAX_RETRY =3;
    /**
     * 线程池 抛弃策略DiscardPolicy：这种策略，会默默的把新来的这个任务给丢弃；不会得到通知
      */
    private static ExecutorService executor = new ThreadPoolExecutor(10,30,60,TimeUnit.MILLISECONDS,new ArrayBlockingQueue<Runnable>(200),new CommonThreadFactory("Slack"), new ThreadPoolExecutor.DiscardPolicy());
    private static String MSG_FORMAT ="payload=&#39;{&#39;"channel": "{0}", "username": "{1}", "text": "{2}", "icon_emoji": ":ghost:"&#39;}&#39;" ;
    /**
     * 保存的Webhook URL ，需要初始化
     */
    private static String WEBHOOK_URL ;
    private static boolean SLACK_ABLE;
    public static void setSlackConfig(String webhookUrl){
        WEBHOOK_URL = webhookUrl;
        SLACK_ABLE = true;
    }
    /**
     * slack异步发消息，保证不能影响到主功能
      * @param channel
     * @param msg
     */
    public static void send(final String channel, final String msg){
        if(!SLACK_ABLE){
            return;
        }
        if(StringUtils.isBlank(msg)){
            return;
        }
        executor.submit(new Runnable() {
            @Override
            public void run() {
                try {
                    SlackUtil.send(channel,sdf.format(System.currentTimeMillis())+"   "+msg,MAX_RETRY);
                } catch (Exception e) {
                    logger.log(Level.SEVERE, e.getMessage(), e);
                }
            }
        });
    }
    /**
     * 如果slask发消息失败，会最多尝试发三次，三次都失败，会打印异常信息
      * @param channel
     * @param msg
     * @param retry
     * @throws Exception
     */
    public static void send(String channel, String msg, int retry) throws Exception {
        if(msg.indexOf(""")>=0 ||msg.indexOf("{")>=0 ||msg.indexOf("}")>=0){
            msg =msg.replace(""","&#39;").replace("{","[").replace("}","]");
        }
        String payload = MessageFormat.format(MSG_FORMAT, channel,SEND_USER_NAME,msg);
        String result = ConnUtil.getContentByPostWithUrlencode(WEBHOOK_URL,payload);
        logger.info("result:"+result);
        if(StringUtils.isEmpty(result) ||!result.startsWith("ok")){
            --retry;
            if(retry>0){
                try {
                    TimeUnit.SECONDS.sleep(retry*5);
                } catch (InterruptedException e) {
                    e.printStackTrace();
                }
                send(channel,msg,retry);
            }else{
                throw new Exception("Fail to send slack:"+result+"\nmsg:"+msg);
            }
        }
    }
}

Initiiert eine Anfrage zum Webhook über Urlencode

package com.yy.common;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.HttpClientBuilder;
import java.io.BufferedReader;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.logging.Level;
import java.util.logging.Logger;
/**
 * @author ：Max
 * @date ：Created in 2022/8/26 下午1:44
 * @description：
 */
public class ConnUtil {
    private static final Logger logger = Logger.getLogger(ConnUtil.class.getCanonicalName());
    public static String getContentByPostWithUrlencode(String url,String msg){
        StringEntity entity = new StringEntity(msg, "UTF-8");
        entity.setContentEncoding("UTF-8");
        entity.setContentType(" application/x-www-form-urlencoded");
        HttpClient httpClient = HttpClientBuilder.create().build();
        HttpPost request = new HttpPost(url);
        request.setEntity(entity);
        HttpResponse response = null;
        try {
            response = httpClient.execute(request);
            HttpEntity responseEntity = response.getEntity();
            if (responseEntity != null) {
                InputStream instream = responseEntity.getContent();
                BufferedReader reader = new BufferedReader(new InputStreamReader(instream));
                StringBuffer contents = new StringBuffer();
                String line = null;
                while ((line = reader.readLine()) != null) {
                    contents.append(line);
                    contents.append("\n");
                }
                return contents.toString();
            }
        } catch (Exception ex) {
            logger.log(Level.SEVERE, ex.getMessage(), ex);
        }
        return null;
    }
}

SlackUtil-Test

package com.yy.test;
import com.yy.common.SlackChannelEnum;
import com.yy.operation.SlackUtil;
import org.junit.Assert;
import org.junit.Test;
import java.util.concurrent.TimeUnit;
/**
 * @author ：Max
 * @date ：Created in 2022/8/28 下午2:37
 * @description：
 */
public class SlackTest {
    static {
        SlackUtil.setSlackConfig("https://hooks.slack.com/services/*******");
    }
    @Test
    public void test(){
        SlackUtil.send(SlackChannelEnum.EXCEPTION.channel,"test ~");
        try {
            TimeUnit.MINUTES.sleep(1);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        Assert.assertTrue(true);
    }
}

Die Anfrage wurde erfolgreich gesendet und die Informationen können angezeigt werden im Kanal

2. Schreiben Sie die Druckprotokollklasse neu

Verarbeitung der allgemeinen Ausnahmeprotokollierung

public class LoggerTest {
    private static final Logger logger = Logger.getLogger(LoggerTest.class.getCanonicalName());
    @Test
    public void test() {
        try {
            int i = 1 / 0;
        } catch (Exception e) {
            logger.log(Level.SEVERE, e.getMessage(), e);
        }
    }
}

#🎜🎜 #Schreiben Sie das gekapselte Druckprotokoll neu. Die Methode

package com.yy.operation;
import com.yy.common.SlackChannelEnum;
import org.apache.commons.lang.StringUtils;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.net.Inet4Address;
import java.net.InetAddress;
import java.text.MessageFormat;
import java.util.logging.Level;
import java.util.logging.LogRecord;
import java.util.logging.Logger;
/**
 * @author  Max
 * @date ：Created in 2022/8/4 下午5:14
 * @description：
 */
public class CommonLogger {
    private Logger logger;
    private CommonLogger(String className) {
        logger = Logger.getLogger(className);
    }
    private static String SERVER;
    private static String EXCEPTION_ALARM_FORMAT = "EXCEPTION 发生异常！\n环境 :{0}\n信息 :{1}\n详情 :{2}";
    private static String WARNING_ALARM_FORMAT = "WARNING 发生告警！\n环境 :{0}\n信息 :{1}";
    private static String SEVERE_ALARM_FORMAT = "SEVERE 发生告警！\n环境 :{0}\n信息 :{1}";
    private static String LOG_ALARM_FORMAT = "LOG 发生告警！\n环境 :{0}\n信息 :{1}";
    private static String USER_BEHAVIOR_FORMAT = "CUSTOMER \n环境 :{0}\n信息 :{1}";
    static {
        try{
            InetAddress ip4 = Inet4Address.getLocalHost();
            SERVER = ip4.getHostAddress();
        }catch (Exception e){
            SERVER ="undefined server";
        }
    }
    public static CommonLogger getLogger(String name) {
        return new CommonLogger(name);
    }
    /**
     * Print exception information, send slack
     *
     * @param level
     * @param msg
     * @param e
     */
    public void log(Level level, String msg, Throwable e) {
        if(StringUtils.isBlank(msg)){
            return;
        }
        msg =dolog(level,msg, e);
        msg = MessageFormat.format(EXCEPTION_ALARM_FORMAT, SERVER, formatMsg(msg), getErrmessage(e));
        SlackUtil.send(SlackChannelEnum.EXCEPTION.channel, msg);
    }
    /**
     * Print user behavior information, send slack
     *
     * @param msg
     */
    public void userBehaviorInfo(String msg) {
        if(StringUtils.isBlank(msg)){
            return;
        }
        msg =dolog(Level.INFO,msg);
        msg = MessageFormat.format(USER_BEHAVIOR_FORMAT, SERVER, formatMsg(msg));
        SlackUtil.send(SlackChannelEnum.EXCEPTION.channel, msg);
    }
    public String formatMsg(String msg){
        StringBuilder source =new StringBuilder(logger.getName());
        msg=transferMsgSource(source,msg);
        return source.toString()+" "+msg;
    }
    /**
     * Print warning severe information, send slack
     *
     * @param msg
     */
    public void severe(String msg) {
        if(StringUtils.isBlank(msg)){
            return;
        }
        msg = dolog(Level.SEVERE,msg);
        msg = MessageFormat.format(SEVERE_ALARM_FORMAT, SERVER, formatMsg(msg));
        SlackUtil.send(SlackChannelEnum.EXCEPTION.channel, msg);
    }
    /**
     * Print warning severe information, send slack
     *
     * @param msg
     */
    public void warning(String msg) { 
        if(StringUtils.isBlank(msg)){
            return;
         }
        msg = dolog(Level.WARNING,msg);
        msg = MessageFormat.format(WARNING_ALARM_FORMAT, SERVER, formatMsg(msg));
        SlackUtil.send(SlackChannelEnum.EXCEPTION.channel, msg);
    }
    /**
     * Print warning log information, send slack
     *
     * @param msg
     */
    public void log(Level severe, String msg) {
        if(StringUtils.isBlank(msg)){
            return;
        }
        msg =dolog(severe,msg);
        msg = MessageFormat.format(LOG_ALARM_FORMAT, SERVER, formatMsg(msg));
        SlackUtil.send(SlackChannelEnum.EXCEPTION.channel, msg);
    }
    public static String getErrmessage(Throwable t) {
        return getThrowable(t);
    }
    public void info(String msg) {
        dolog(Level.INFO,msg);
    }
    public void fine(String msg) {
        logger.fine(msg);
    }
    public void setLevel(Level level) {
        logger.setLevel(level);
    }
    public String dolog(Level level, String msg) {
        return dolog(level,msg,null);
    }
    /**
     *
      * @param level
     * @param msg
     * @param thrown
     * @return msg="["+currentThread.getName()+"] "+a.getMethodName()+" "+msg;
     */
    public String dolog(Level level, String msg, Throwable thrown) {
        LogRecord lr = new LogRecord(level, msg);
        lr.setLevel(level);
        if(thrown!=null){
            lr.setThrown(thrown);
        }
        Thread currentThread = Thread.currentThread();
        StackTraceElement[] temp=currentThread.getStackTrace();
        StackTraceElement a=(StackTraceElement)temp[3];
        lr.setThreadID((int) currentThread.getId());
        lr.setSourceClassName(logger.getName());
        lr.setSourceMethodName(a.getMethodName());
        lr.setLoggerName(logger.getName());
        logger.log(lr);
        return "["+currentThread.getName()+"] "+a.getMethodName()+" "+msg;
    }
    public static String getThrowable(Throwable e) {
        String throwable = "";
        if (e != null) {
            StringWriter sw = new StringWriter();
            PrintWriter pw = new PrintWriter(sw);
            pw.println();
            e.printStackTrace(pw);
            pw.close();
            throwable = sw.toString();
        }
        return throwable;
    }
    public static String transferMsgSource(StringBuilder source,String msg){
        if(msg.indexOf(" ")>0){
            String threadName = msg.substring(0,msg.indexOf(" "))+ " ";
            msg=msg.substring(threadName.length());
            source.insert(0,threadName);
            if(msg.indexOf(" ")>0) {
                String method = msg.substring(0, msg.indexOf(" "));
                source.append( "." + method);
                msg = msg.substring(method.length()+1);
            }
        }
        return msg;
    }
}

package com.yy.operation;
import java.text.MessageFormat;
import java.util.concurrent.ConcurrentHashMap;
import java.util.logging.Level;
import java.util.logging.Logger;
public class LoggerUtil {
   private static Logger curLogger = Logger.getLogger(LoggerUtil.class.getCanonicalName());
   private static ConcurrentHashMap<String, CommonLogger> loggers = new ConcurrentHashMap<String, CommonLogger>();
   public static CommonLogger getLogger(Class<?> clazz) {
      String className = clazz.getCanonicalName();
      CommonLogger logger = loggers.get(className);
      if (logger == null) {
         logger = CommonLogger.getLogger(className);
         curLogger.fine(MessageFormat.format("Register logger for {0}", className));
         loggers.put(className, logger);
      }
      return logger;
   }
}

Protokollklasse testen

ändert sich beim Definieren der Protokollklasse, der aufgerufene Code muss nicht geändert werden und die Ausnahmealarmfunktion ist gegen geringe Kosten integriert

public class LoggerTest {
    private static final Logger logger = Logger.getLogger(LoggerTest.class.getCanonicalName());
    @Test
    public void test() {
        try {
            int i = 1 / 0;
        } catch (Exception e) {
            logger.log(Level.SEVERE, e.getMessage(), e);
        }
    }
}

Testergebnisse, abnormale Informationen im Kanal gedruckt, bequem für Entwicklungs- und Betriebspersonal zu finden

# 🎜🎜# 5. Optimierungs- und Erweiterungsideen#🎜🎜 #

Sie können nicht nur Ausnahmeprotokolle drucken, sondern auch einige wichtige Benutzerverhaltensweisen wie Aufladen usw. Drucken. Mehrere Kanäle kann so eingerichtet werden, dass Nachrichten mit unterschiedlichen Themen gesendet werden Überprüfen Sie den Slack rechtzeitig, E-Mail kann ebenfalls integriert werden und Mailclark kann zur Slack-Anwendung hinzugefügt werden (separate Gebühr). Nach der Konfiguration können die Informationen im Startkanal automatisch an jedes Postfach gesendet werden, und der Empfänger muss kein Postfach erstellen Slack-Konto. Bitte beachten Sie den Link für die spezifische Konfiguration.

Andere Codes

• package com.yy.common;
  import java.util.concurrent.ThreadFactory;
  import java.util.concurrent.atomic.AtomicInteger;
  /**
   * @author ：Max
   * @date ：Created in 2022/8/26 下午1:51
   * @description：
   */
  public class CommonThreadFactory implements ThreadFactory {
      private static final AtomicInteger poolNumber = new AtomicInteger(1);
      private final ThreadGroup group;
      private final AtomicInteger threadNumber = new AtomicInteger(1);
      private final String threadNamePrefix;
      private final String nameSpecific;
      private final boolean isDaemon;
      public CommonThreadFactory(String nameSpecific) {
          this(nameSpecifihttps://juejin.cn/post/7136858841756467230#heading-4c, false);
      }
      public CommonThreadFactory(String nameSpecific, boolean isDaemon) {
          SecurityManager s = System.getSecurityManager();
          this.group = (s != null) ? s.getThreadGroup() :
                  Thread.currentThread().getThreadGroup();
          this.threadNamePrefix = "eg-pool-" + poolNumber.getAndIncrement() + "-thread";
          this.nameSpecific = nameSpecific;
          this.isDaemon = isDaemon;
      }
      @Override
      public Thread newThread(Runnable r) {
          Thread t = new Thread(group, r, String.format("%s-%d-%s",
                  this.threadNamePrefix, threadNumber.getAndIncrement(), this.nameSpecific), 0);
          t.setDaemon(isDaemon);
          t.setPriority(Thread.NORM_PRIORITY);
          return t;
      }
  }

  public enum SlackChannelEnum {
      EXCEPTION("#test-example");
      public String channel;
      SlackChannelEnum(String channel) {
          this.channel = channel;
      }
  }

Das obige ist der detaillierte Inhalt vonSo implementieren Sie einen abnormalen Protokollalarm in JAVA basierend auf Slack. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!