3 Star 12 Fork 6

Rey Wong / OpenLinkLog

加入 Gitee
与超过 800 万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README.md

LinkLog简介

linkLog内容

linkLog使用教程

日志体系最佳实践

linkLog链路跟踪功能描述

linkLog通过拦截主流框架请求,添加traceId的进行系统间传导,然后通过slf4j的MDC功能打印到日志中,从而达到日志链路跟踪的效果

链路跟踪主要有traceId和spanId两个组成,traceId为单次请求的全局唯一ID,spanId为所在请求的节点ID(为树结构)。

如图:

linkLog支持的框架

  • 支持Disconf,Apollo等配置中心动态修改日志级别

说明:修改/添加 linklog.properties 文件

### k=v 键值对  k=logger的名称  v=日志级别
### k:LoggerFactory.getLogger(LinkLog.class)获取logger的时候 k为LinkLog全路径类名
### v: 日志级别包含 OFF>FATAL>ERROR>WARN>INFO>DEBUG>TRACE>ALL
   cn.ry.LinkLog=DEBUG
  • 支持的日志框架:logback,log4j,log4j2

  • 自动适配的框架:SpringBoot,SpringMVC,Fegin,Spring GateWay,Dubbo

  • HttpClient接入方式:

  //添加LinkLogHttpRequestInterceptor拦截器
  CloseableHttpClient httpClient = HttpClientBuilder.create()
                .addInterceptorFirst(new LinkLogHttpRequestInterceptor())   
                .build();
  • RestTempate接入方式:
  //添加LinkLogRestTemplateFilter拦截器
  RestTemplate restTemplate = new RestTemplate();
  restTemplate.setInterceptors(Collections.singletonList(new LinkLogRestTemplateFilter()));
  • OkHttp接入方式
  //添加LinkLogOkHttpInterceptor拦截器
  OkHttpClient client = new OkHttpClient.Builder()
  .addInterceptor(new LinkLogOkHttpInterceptor())
  .build();

  • Jersey接入方式

ClientBuilder clientBuilder = ClientBuilder.newBuilder();
Client client=clientBuilder.withConfig(new ClientConfig(LinkLogJerseyFilter.class)).build();

linkLog特点

  • 一键接入,系统零添加
  • 轻量,不会依赖三方jar
  • 自动适配,根据系统jar自动适配拦截器

linkLog使用

添加依赖 pom.xml

  <dependency>
      <groupId>io.gitee.reywong</groupId>
      <artifactId>ry-linklog</artifactId>
      <version>1.0.1-releases</version>
  </dependency>
展示traceId log配置文件中添加

pattern中添加 %X{linkLog}

如:


 <appender name="messageText_console" class="ch.qos.logback.core.ConsoleAppender">
     <encoder>
         <pattern>[%X{linkLog}] [%date{yyyy-MM-dd HH:mm:ss.SSS}] [%thread] [%-5level] [%logger:%line] %msg%n</pattern>
         <charset>UTF-8</charset>
     </encoder>
 </appender>
展示效果

A系统 调用 B系统

A系统代码


public String linklog(HttpServletRequest request, HttpServletResponse response) {
        StringBuilder stringBuilder = new StringBuilder();
        logger.info("1.请求参数{}", "reywong");
        List<String> sayList = demoServer.sayHello("reywong");
        if (sayList != null) {
            for (String say : sayList) {
                stringBuilder.append(say);
            }
        }
        String result = stringBuilder.toString();
        logger.info(result);

        logger.info("2.请求参数{}", "reywong");
        demoServer.sayHello("reywong");

        logger.info("3.httpclient 请求接口");
        httpClient();

        return result;
    }

    
    public String httpClient() {
        String msg = "";
        // 获得Http客户端(可以理解为:你得先有一个浏览器;注意:实际上HttpClient与浏览器是不一样的)
        CloseableHttpClient httpClient = HttpClientBuilder
                .create()
                .addInterceptorFirst(new LinkLogHttpRequestInterceptor())
                .build();


        // 创建Get请求
        HttpGet httpGet = new HttpGet("http://localhost:8082/springMvc");
        // 响应模型
        CloseableHttpResponse response = null;
        try {
            Thread.sleep(1000);
            // 由客户端执行(发送)Get请求
            logger.info("request springMVC");
            response = httpClient.execute(httpGet);
            // 从响应模型中获取响应实体
            HttpEntity responseEntity = response.getEntity();
            msg = responseEntity.toString();
            if (responseEntity != null) {
                logger.info("reponse get springMVC");
            }
        } catch (ClientProtocolException e) {
            e.printStackTrace();
        } catch (ParseException e) {
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        } catch (InterruptedException e) {
            e.printStackTrace();
        } finally {
            try {
                // 释放资源
                if (httpClient != null) {
                    httpClient.close();
                }
                if (response != null) {
                    response.close();
                }
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
        return msg;
    }
}

A系统日志

B系统代码

  @RequestMapping("/springMvc")
    public String springMvc(HttpServletRequest request, HttpServletResponse response) {
        logger.info("linkLog-Server springMvc");
        return "springMvc";
    }

B系统日志

测试方案

项目中提供了测试项目,可以直接运行

LinkLog-example/link-example-dubbo 提供了springMvc和dubbo的测试用例。

步骤如下:

  1. 启动linklog-example-dubbo-server
  2. 启用linklog-example-dubbo-client
  3. 执行dubbo.http中的请求(idea支持http请求类似postman)

备注

  1. 项目目前通过SPI的方式加载,支持tomcat spi,springboot spi,dubbo spi
  2. 如果springmvc无法拦截,可以在配置一个拦截器<bean class="cn.com.ry.framework.linklog.LinkLogInit"></bean>
  3. java8以后开启空指针堆栈,jvm启动参数添加-XX:-OmitStackTraceInFastThrow

最佳实践

日志体系最佳实践

其它开源项目

Meteor-基于Arthas的线上故障诊断神器

仓库评论 ( 1 )

你可以在登录后,发表评论

简介

linkLog通过拦截主流框架请求,添加traceId的进行系统间传导,然后通过slf4j的MDC功能打印到日志中,从而达到日志链路跟踪的效果 展开 收起
Java 等 2 种语言
Apache-2.0
取消

发行版

暂无发行版

OpenLinkLog

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/reywong/OSSRH-71430.git
git@gitee.com:reywong/OSSRH-71430.git
reywong
OSSRH-71430
OpenLinkLog
master

搜索帮助