这里直接分享日志上报 [钉钉]和飞书的解决方案
还是直接上代码
logback-spring.xml 文件 修改
<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="10 seconds">
<!-- 日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果设置为WARN，则低于WARN的信息都不会输出 -->
<!-- scan:当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true -->
<!-- scanPeriod:设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。 -->
<!-- debug:当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。 -->
<springProperty scope="context" name="serviceName" source="spring.application.name" />
<contextName>logback</contextName>
<!-- name的值是变量的名称，value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后，可以使“${}”来使用变量。 -->
<!-- 日志输出位置-->
<property name="log.path" value="/home/logs/xxx" />
<!-- 按照日期一个文件夹-->
<timestamp key="datetime" datePattern="yyyy-MM-dd"/>
<!-- 彩色日志 -->
<!-- 配置格式变量：CONSOLE_LOG_PATTERN 彩色日志格式 -->
<!-- magenta:洋红 -->
<!-- boldMagenta:粗红-->
<!-- cyan:青色 -->
<!-- white:白色 -->
<!-- magenta:洋红 -->
<property name="CONSOLE_LOG_PATTERN"
value="%yellow(%date{yyyy-MM-dd HH:mm:ss}) |%highlight(%-5level) |%blue(%thread) |%blue(%file:%line) |%green(%logger) |%magenta(%msg%n)"/>
<!--输出到控制台-->
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<!--此日志appender是为开发使用，只配置最底级别，控制台输出的日志级别是大于或等于此级别的日志信息-->
<!-- 例如：如果此处配置了INFO级别，则后面其他位置即使配置了DEBUG级别的日志，也不会被输出 -->
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>INFO</level>
</filter>
<encoder>
<Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
<!-- 设置字符集 -->
<charset>UTF-8</charset>
</encoder>
</appender>
<!--输出到文件-->
<!-- 时间滚动输出 level为 INFO 日志 -->
<appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 正在记录的日志文件的路径及文件名 -->
<file>${log.path}/${datetime}/log_info.log</file>
<!--日志文件输出格式-->
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
<charset>UTF-8</charset>
</encoder>
<!-- 日志记录器的滚动策略，按日期，按大小记录 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!-- 每天日志归档路径以及格式 -->
<fileNamePattern>${log.path}/${datetime}/info/log-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
<!--日志文件保留天数-->
<maxHistory>7</maxHistory>
</rollingPolicy>
<!-- 此日志文件只记录info级别的 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>INFO</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!-- 时间滚动输出 level为 WARN 日志 -->
<appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 正在记录的日志文件的路径及文件名 -->
<file>${log.path}/${datetime}/log_warn.log</file>
<!--日志文件输出格式-->
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
<charset>UTF-8</charset> <!-- 此处设置字符集 -->
</encoder>
<!-- 日志记录器的滚动策略，按日期，按大小记录 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${log.path}/${datetime}/warn/log-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
<!--日志文件保留天数-->
<maxHistory>7</maxHistory>
</rollingPolicy>
<!-- 此日志文件只记录warn级别的 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>warn</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!-- 时间滚动输出 level为 ERROR 日志 -->
<appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 正在记录的日志文件的路径及文件名 -->
<file>${log.path}/${datetime}/log_error.log</file>
<!--日志文件输出格式-->
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
<charset>UTF-8</charset> <!-- 此处设置字符集 -->
</encoder>
<!-- 日志记录器的滚动策略，按日期，按大小记录 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${log.path}/${datetime}/error/log-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
<!--日志文件保留天数-->
<maxHistory>7</maxHistory>
</rollingPolicy>
<!-- 此日志文件只记录ERROR级别的 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>ERROR</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<appender name="SendErrorMsgAppender" class="com.xxx.init.exception.SendErrorMsgAppender">
<!-- 此日志文件只记录ERROR级别的 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>ERROR</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!--
<logger>用来设置某一个包或者具体的某一个类的日志打印级别、以及指定<appender>。
<logger>仅有一个name属性，
一个可选的level和一个可选的addtivity属性。
name:用来指定受此logger约束的某一个包或者具体的某一个类。
level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，
如果未设置此属性，那么当前logger将会继承上级的级别。
-->
<!--
使用mybatis的时候，sql语句是debug下才会打印，而这里我们只配置了info，所以想要查看sql语句的话，有以下两种操作：
第一种把<root level="INFO">改成<root level="DEBUG">这样就会打印sql，不过这样日志那边会出现很多其他消息
第二种就是单独给mapper下目录配置DEBUG模式，代码如下，这样配置sql语句会打印，其他还是正常DEBUG级别：
-->
<!--开发环境:打印控制台-->
<springProfile name="dev">
<!--可以输出项目中的debug日志，包括mybatis的sql日志-->
<logger name="com.xxx" level="INFO" />
<!--
root节点是必选节点，用来指定最基础的日志输出级别，只有一个level属性
level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，默认是DEBUG
可以包含零个或多个appender元素。
-->
<root level="INFO">
<appender-ref ref="CONSOLE" />
<appender-ref ref="INFO_FILE" />
<appender-ref ref="WARN_FILE" />
<appender-ref ref="ERROR_FILE" />
<!-- <appender-ref ref="SendErrorMsgAppender"/>-->
</root>
</springProfile>
<!--生产环境:输出到文件-->
<springProfile name="prd">
<!-- 写这 只有 com.xxx包下的日志 会发送到飞书 -->
<!-- <logger name="com.xxx" level="INFO" >-->
<!-- <appender-ref ref="SendErrorMsgAppender"/>-->
<!-- </logger>-->
<!-- 写这 所有的ERROR错误日志都会发送到飞书 -->
<root level="INFO">
<appender-ref ref="CONSOLE" />
<!-- <appender-ref ref="DEBUG_FILE" />-->
<appender-ref ref="INFO_FILE" />
<appender-ref ref="ERROR_FILE" />
<appender-ref ref="WARN_FILE" />
<appender-ref ref="SendErrorMsgAppender"/>
</root>
</springProfile>
</configuration>
xml中核心的 代码 我单独显示
第一部分 重点是 ：
name=“SendErrorMsgAppender” class=“com.xxx.init.exception.SendErrorMsgAppender”
让 日志 触发我们自定义的 SendErrorMsgAppender 这个类 然后再这个类里 接收数据 处理 发送到飞书或钉钉
<appender name="SendErrorMsgAppender" class="com.xxx.init.exception.SendErrorMsgAppender">
<!-- 此日志文件只记录ERROR级别的 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>ERROR</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
第二部分 ：重点是 这个
<root level="INFO">
<appender-ref ref="CONSOLE" />
<!-- <appender-ref ref="DEBUG_FILE" />-->
<appender-ref ref="INFO_FILE" />
<appender-ref ref="ERROR_FILE" />
<appender-ref ref="WARN_FILE" />
<appender-ref ref="SendErrorMsgAppender"/>
</root>
SendErrorMsgAppender 类编写
package com.xxx.init.exception;
import ch.qos.logback.classic.spi.ILoggingEvent;
import ch.qos.logback.classic.spi.StackTraceElementProxy;
import ch.qos.logback.classic.spi.ThrowableProxy;
import ch.qos.logback.core.Context;
import ch.qos.logback.core.UnsynchronizedAppenderBase;
import com.xxx.init.utils.FeiShuUtil;
import com.xxx.init.utils.LocalDateTimeUtils;
import com.xxx.init.utils.RequestUtils;
import com.xxx.init.utils.WlUtils;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.springframework.core.env.Environment;
import org.springframework.context.ApplicationContext;
import org.springframework.util.StringUtils;
/**
* User:Json
* Date: 2024/5/17
**/
@Slf4j
@Component
public class SendErrorMsgAppender extends UnsynchronizedAppenderBase<ILoggingEvent> {
// log 类 不能自动 读取配置文件 需要通过logback-spring.xml 传入进来
public String getServiceName() {
Context context = getContext();
if (context != null) {
return context.getProperty("serviceName");
}
return null;
}
@Override
protected void append(ILoggingEvent iLoggingEvent) {
// 获取日志级别
String level = iLoggingEvent.getLevel().toString();
if (FeiShuUtil.checkConfig() && level.equals("ERROR")) {
// 获取日志消息
String message = iLoggingEvent.getFormattedMessage();
// 获取异常信息
ThrowableProxy throwableProxy = (ThrowableProxy) iLoggingEvent.getThrowableProxy();
String stackTrace = null;
String traceAsString = null;
if (throwableProxy != null) {
stackTrace = throwableProxy.getThrowable().toString();
StackTraceElementProxy[] stackTraceElementProxy = throwableProxy.getStackTraceElementProxyArray();
int i = 0;
StringBuilder stringBuilder = new StringBuilder();
for (StackTraceElementProxy proxy : stackTraceElementProxy) {
//只打印40行的堆栈
if (i < 40) {
stringBuilder.append(proxy.getSTEAsString()).append("\n");
} else {
break;
}
i++;
}
traceAsString = stringBuilder.toString();
}
String title = "java线上代码错误（" + RequestUtils.getClientDomain() + "）";
// 构建数据结构
Map<String, String> serviceNameMap = new HashMap<>();
serviceNameMap.put("tag", "text");
serviceNameMap.put("text", "服务名：" + getServiceName());
List<Map<String, String>> serviceNameList = new ArrayList<>();
serviceNameList.add(serviceNameMap);
Map<String, String> errorTimeMap = new HashMap<>();
errorTimeMap.put("tag", "text");
errorTimeMap.put("text", String.format("报错时间：[%s]", LocalDateTimeUtils.formatNow("yyyy-MM-dd HH:mm:ss")));
List<Map<String, String>> errorTimeList = new ArrayList<>();
errorTimeList.add(errorTimeMap);
Map<String, String> errorRouteMap = new HashMap<>();
errorRouteMap.put("tag", "text");
errorRouteMap.put("text", String.format("访问路由：[%s] %s", WlUtils.getRequest().get("method")==null?"":WlUtils.getRequest().get("method"), WlUtils.getRequest().get("requestUrl")==null?"":WlUtils.getRequest().get("requestUrl")));
List<Map<String, String>> errorRouteList = new ArrayList<>();
errorRouteList.add(errorRouteMap);
Map<String, String> errorIpMap = new HashMap<>();
errorIpMap.put("tag", "text");
errorIpMap.put("text", String.format("用户IP：%s", WlUtils.getClientIp()==null?"":WlUtils.getClientIp()));
List<Map<String, String>> errorIpList = new ArrayList<>();
errorIpList.add(errorIpMap);
Map<String, String> requestDataMap = new HashMap<>();
requestDataMap.put("tag", "text");
requestDataMap.put("text", String.format("访问参数：%s", WlUtils.getAndPostData()==null?"":WlUtils.getAndPostData()));
List<Map<String, String>> requestDataList = new ArrayList<>();
requestDataList.add(requestDataMap);
Map<String, String> errorMsgMap = new HashMap<>();
errorMsgMap.put("tag", "text");
errorMsgMap.put("text", "错误概要：" + (stackTrace==null?"":stackTrace));
List<Map<String, String>> errorMsgList = new ArrayList<>();
errorMsgList.add(errorMsgMap);
Map<String, String> errorTraceAsStringMap = new HashMap<>();
errorTraceAsStringMap.put("tag", "text");
errorTraceAsStringMap.put("text", "详细错误：" + (traceAsString==null?"":traceAsString));
List<Map<String, String>> errorTraceAsStringList = new ArrayList<>();
errorTraceAsStringList.add(errorTraceAsStringMap);
List<List<Map<String, String>>> nestedList = new ArrayList<>();
nestedList.add(serviceNameList);
nestedList.add(errorTimeList);
nestedList.add(errorRouteList);
nestedList.add(errorIpList);
nestedList.add(requestDataList);
nestedList.add(errorMsgList);
nestedList.add(errorTraceAsStringList);
if (level.equals("ERROR") && !StringUtils.isEmpty(traceAsString)) {
//这个地方就是发送飞书 或者钉钉 这里的代码 就不分享了
// 可查看 钉钉 和飞书 自动机器人 api 的文档 进行编写
// 我用的是 飞书的机器人
// 根据需求 自行修改 即可
FeiShuUtil.sendMarkDown(title,nestedList);
}
}
}
}
实现 UnsynchronizedAppenderBase 接口 和 继承 AppenderBase 都可以 区别是什么 可以百度一下
利用多线程 进行日志发送也行 提高效率 不影响主线程 这里也不分享了
关于 logback-spring.xml 代码有点小问题
补充篇：
请看下面这个链接： juejin.cn/post/751971…
