mica-logging（logback 的日志扩展）

规则

1. 默认情况下，打印 console 日志、all.log、error.log。
2. 设置为 json 格式化，打印 console 日志（非 json）、all.log（json 格式，可用于 filebeat 收集）。
3. 开启 logstash，打印 console 日志，并将日志输出到 logstash（建议关闭掉 file 输出）。
4. 可配置启动完成关闭 console 日志。

功能

1. 默认日志配置。
2. 打印 json 日志文件。
3. logstash 日志收集。
4. 启动完成关闭控制台日志。

依赖引用

maven

<dependency>
  <groupId>net.dreamlu</groupId>
  <artifactId>mica-logging</artifactId>
  <version>${version}</version>
</dependency>

gradle

compile("net.dreamlu:mica-logging:${version}")

可选依赖

注意： 开启 json 文件或 logstash 必须添加该依赖！！！

<dependency>
    <groupId>net.logstash.logback</groupId>
    <artifactId>logstash-logback-encoder</artifactId>
    <version>${version}</version>
</dependency>

配置

特别注意： 需要配置服务名和环境，例如：

spring:
  application:
    name: mica-test
  profiles:
    active: dev

配置项	默认值	说明
mica.logging.console.close-after-start	false	是否启动完成后将自动关闭控制台日志，默认false。非开发环境建议设置为 true
mica.logging.files.enabled	true	是否开启日志文件 all.log 和 error.log
mica.logging.files.use-json-format	false	使用 json 格式化，设置后文件打印 json 日志，可用于 filebeat 收集日志文件
mica.logging.logstash.enabled	false	是否开启 logstash 日志收集，直接收集到 logstash
mica.logging.logstash.host	localhost	logstash host
mica.logging.logstash.port	5000	logstash port
mica.logging.logstash.queue-size	512	logstash 队列大小

日志示例

文件日志

2021-03-25 21:03:55.275  INFO 2354 --- [XNIO-1 task-3] n.d.mica.mybatis.logger.SqlLogFilter     :

======= Sql Logger ======================
select id, parent_id, title, name, seq , path, permission, component, icon, is_frame , type, cache, hidden, status, remark , created_by, created_at, updated_by, updated_at from sys_menu where type in (0, 1) and hidden = false and status = 0
======= Sql Execute Time: 3.438ms =======

json 日志

{"loggingLevelRoot":"info","appName":"mica-fast","profile":"dev","level":"INFO","logger_name":"o.s.b.w.e.u.UndertowWebServer","message":"Undertow started on port(s) 8080 (http)","thread_name":"main","@timestamp":"2021-03-25T13:10:34.371Z"}

logstash 日志（stdout）

{
                "port" => 57146,
            "@version" => "1",
             "profile" => "dev",
         "logger_name" => "net.dreamlu.mica.mybatis.logger.SqlLogFilter",
             "appName" => "mica-fast",
         "thread_name" => "XNIO-1 task-3",
               "level" => "INFO",
         "level_value" => 20000,
             "message" => "\n\n======= Sql Logger ======================\nselect id, parent_id, title, name, seq , path, permission, component, icon, is_frame , type, cache, hidden, status, remark , created_by, created_at, updated_by, updated_at from sys_menu where type in (0, 1) and hidden = false and status = 0\n======= Sql Execute Time: 3.438ms =======\n",
    "loggingLevelRoot" => "info",
                "host" => "localhost",
           "requestId" => "d17d635f0a479f01f846199231008ec9",
          "@timestamp" => 2021-03-25T13:03:55.275Z
}

参考

• jhipster