日志规范 LinkLog体系

-Drocketmq.client.log.loadconfig=false  
-Dlinklog.env=sit   
-Dlinklog.kafka.json=kafkaJson   
-Dlinklog.kafka.servers=10.201.1.46:9092  
-Dlinklog.kafka.topic=linklog_std_log  
-Dlinklog.kafka.errortopic=linklog_common_error  

注：使用ELK模式

<!--如果本地有logback就不用配置-->
<!--start logback 必须为1.2.2以上-->
    <!--  <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>${slf4j.version}</version>
        </dependency>

      l
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <version>${logback.version}</version>
        </dependency>
    -->  
<!--end logback-->

<!--start linklog-->
  <dependency>
      <groupId>io.gitee.reywong</groupId>
      <artifactId>ry-linklog</artifactId>
      <version>1.0.1-releases</version>
  </dependency>
<!--end linklog-->

<!--logback-kafka插件-->
    <dependency>
            <groupId>com.github.danielwegener</groupId>
            <artifactId>logback-kafka-appender</artifactId>
            <version>0.2.0-RC2</version>
            <exclusions>
                <!--如果项目中已经存在kafka-clients 则排除-->
                <!--<exclusion>-->
                    <!--<groupId>org.apache.kafka</groupId>-->
                    <!--<artifactId>kafka-clients</artifactId>-->
                <!--</exclusion>-->
                <exclusion>
                    <groupId>org.slf4j</groupId>
                    <artifactId>slf4j-api</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

<!--logback-json插件-->
        <dependency>
            <groupId>net.logstash.logback</groupId>
            <artifactId>logstash-logback-encoder</artifactId>
            <version>6.6</version>
            <exclusions>
                <!--如果项目中已经存在jackson-databind则排除-->
                <exclusion>
                    <groupId>com.fasterxml.jackson.core</groupId>
                    <artifactId>jackson-databind</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

注：logback 和 kafka-client 的版本按系统目前使用的版本，不要重复引入   
    

<!--
                date: 日志打印时间
                ip : 主机ip java.rmi.server.hostname
                env: 应用环境 test | sit | pre | pro
                appname:应用名称
                logtype: 日志类型  LinkLogTrace | LinkLogMonitor | LinkLogData
                level: 日志等级
                linkLog: 日志链路信息
                thread: 线程名称
                class: 输出Logger 的名字
                method:方法名称
                line: 行数
                message: 内容
                stack_trace "%exception{5}",
                -->

// xxxx.java
//代码中获取logger对象
  private static final Logger linkLog=LoggerFactory.getLogger("LinkLogMonitor");
 
// logback.xml 配置

 <!--
  name为 代码中logger的名称  
  level: off 为关闭日志   
  additivity：false  为root不再传递 LinkLogMonitor 的日志的配置
  -->
 <logger name="LinkLogMonitor" level="off" additivity="false">
        <appender-ref ref="${kafkaJson}messageText_async_rollingFile"/>
        <appender-ref ref="${kafkaJson}messageText_async_kafka"/>
 </logger>
 

//相当于 LoggerFactory.getLogger("ry.linkLog.LinkLogMonitor");
private static final Logger logger= LoggerFactory.getLogger(TestLinkLog.class);

// 打印日志

 public ResponseParam addUserInfoNew(RequestParam requestParam) {
     logger.info(JSON.toJSONString(requestParam));
 }
class RequestParam {
        String userId;
        String age;

        public String getUserId() {
            return userId;
        }

        public void setUserId(String userId) {
            this.userId = userId;
        }

        public String getAge() {
            return age;
        }

        public void setAge(String age) {
            this.age = age;
        }
    }

//其中 userId,age 被分拆成字段
{
    "ip": "127.0.0.1",
    "type": "linklog_std",
    "message": "{\"userId\":\"linkLog\",\"age\":1}",
    "age": 1,
    "appname": ".",
    "logtype": "LinkLogTrace",
    "stack_trace": "",
    "span": "",
    "userId": "linkLog",
    "class": "cn.ry.LinkLogMonitor",
    "parent": "",
    "traceId": "",
    "date": "2021-03-15T15:22:04.102+0800",
    "method": "?",
    "@version": "1",
    "line": "?",
    "@timestamp": "2021-03-15T07:22:07.222Z",
    "level": "INFO ",
    "env": ".",
    "thread": "main"
  }
    
    

##修改方式如下  key=logger名称（默认为类名/包名）， value = 日志级别

com.ry=INFO

# true开启日志 false 关闭日志
linklog.accesslog=false

  linkLog.traceId: 日志链路的id,贯穿全局
  linkLog.spanId: 当前节点id,如0.1,具体规则见 备注中的命名规则
  linkLog.preApp： 请求方应用名称
  linkLog.preHost： 请求方主机名
  linkLog.preIp ： 请求方IP
  class: 为linkLog，标识linkLog打印的日志
  linkLogAccessType: client为请求方打印 server为接收方打印
  requestURLStr： 请求地址
  linkLogMethod: 请求方式 POST GET DUBBO EDS-RPC 
  filterName: 打印类，判断拦截器类型
  content: 发送的内容