From 6e91f02f9ab29ec02a67c80f59c1bb7863bdb54a Mon Sep 17 00:00:00 2001 From: gohonsen Date: Mon, 4 Sep 2023 17:44:21 +0800 Subject: [PATCH] Create java-springboot-logback.md (#1114) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Java Springboot 项目使用 Logback 写日志采集示例 --- .../user_contrib/java-springboot-logback.md | 224 ++++++++++++++++++ 1 file changed, 224 insertions(+) create mode 100644 example_config/user_contrib/java-springboot-logback.md diff --git a/example_config/user_contrib/java-springboot-logback.md b/example_config/user_contrib/java-springboot-logback.md new file mode 100644 index 0000000000..42ff03cf05 --- /dev/null +++ b/example_config/user_contrib/java-springboot-logback.md @@ -0,0 +1,224 @@ +# Java Spring Boot Logback 日志 + +## 提供者 + +[`gohonsen`](https://github.com/gohonsen) + +## 描述 + +Java Spring Boot 项目大多使用 Logback 日志框架写日志, Logback 配置比较灵活，可通过配置文件自定义配置日志路径、日志字段内容，有些字段如异常信息在日志中是一条日志对应多行内容，此时我们需要用到 iLogtail 的 processor_split_log_regex 多行采集插件进行采集。Spring Boot 已经集成了 Logback 日志框架，默认会读取 logback-spring.xml 配置文件，如果想自定义配置文件的名称，可以在 Spring Boot 配置文件中配置 logging.config 参数指定 Logback 配置文件。 +以下为 Logback 配置日志输出和 iLogtail 配置日志采集并写入 Kafka 集群的示例： + +## 项目配置 + +```plain +logging.config = /home/tomcat/conf/logback-spring.xml +``` + +## Logback 配置 + +```xml + + + + + + + + + + + + + + ${APP_LOG_HOME}/app.${HOSTNAME}.ing + + ${APP_LOG_HOME}/${APP_LOG_TABLE_NAME}.${HOSTNAME}.%d{yyyy-MM-dd_HH}.log.%i + + 168 + + 300MB + + 2GB + true + + + ${CHARSET} + ${APP_PATTERN} + + + true + + + + + WARN + + ${ERR_LOG_HOME}/err.${HOSTNAME}.ing + + ${ERR_LOG_HOME}/err.${HOSTNAME}.%d{yyyy-MM-dd}.log.%i + 7 + + 300MB + + 2GB + true + + + ${CHARSET} + ${ERR_PATTERN} + + true + + + + + 1024 + + true + 512 + + true + + + + + 1024 + 512 + true + + + + + + + + + + + +``` + + +## 日志输出样例 +### App 日志 + +```log +2023-09-04 11:00:00.885||INFO|putMethod|com.xxx.yyy.ClassName:99|JobThread-893-1693796400023|写本地日志内容|"" +2023-09-04 11:13:50.565|de8139bf-b013-499f-acde-245f9798e73e|WARN|preHandMethod|com.xxx.yyy.ClassName:108|HTTP-exec-21|校验登陆失败，跳转到 login|"" +``` + +### Err 日志 + +```log +2023-09-04 00:00:08.212|2148dd19-c0ff-4ef3-b32e-cd59602ec44e|ERROR|internalMethod|com.alibaba.druid.filter.stat.StatFilter:523|JobThread-893-1693756800039|slow sql 5676 millis. SELECT SUM(VERIFY_NUM) as totalNum, SUM(VERIFY_MONEY) as totalMoney FROM tb_pay_table[]|"" +2023-09-04 00:00:43.079|ed0be4c8-974d-4bf5-9154-1b0ac4edf0b5|ERROR|postMethod|com.xxl.job.core.util.XxlJobRemotingUtil:143|xxl-job, executor ExecutorRegistryThread|Read timed out|"java.net.SocketTimeoutException: Read timed out + at java.net.SocketInputStream.socketRead0(Native Method) + at java.net.SocketInputStream.socketRead(SocketInputStream.java:116) + at java.net.SocketInputStream.read(SocketInputStream.java:171) + at java.net.SocketInputStream.read(SocketInputStream.java:141) + at java.io.BufferedInputStream.fill(BufferedInputStream.java:246) + at java.io.BufferedInputStream.read1(BufferedInputStream.java:286) + at java.io.BufferedInputStream.read(BufferedInputStream.java:345) + at sun.net.www.http.HttpClient.parseHTTPHeader(HttpClient.java:735) + at sun.net.www.http.HttpClient.parseHTTP(HttpClient.java:678) + at sun.net.www.protocol.http.HttpURLConnection.getInputStream0(HttpURLConnection.java:1593) + at sun.net.www.protocol.http.HttpURLConnection.getInputStream(HttpURLConnection.java:1498) + at java.net.HttpURLConnection.getResponseCode(HttpURLConnection.java:480) + at com.xxl.job.core.util.XxlJobRemotingUtil.postBody(XxlJobRemotingUtil.java:119) + at com.xxl.job.core.biz.client.AdminBizClient.registry(AdminBizClient.java:42) + at com.xxl.job.core.thread.ExecutorRegistryThread$1.run(ExecutorRegistryThread.java:48) + at java.lang.Thread.run(Thread.java:748) +" +``` + +## 采集配置 + +### App 日志采集 +```yaml +enable: true +inputs: + - Type: file_log + LogPath: /home/tomcat/logs/app + FilePattern: app.*.ing +processors: + - Type: processor_split_log_regex + SplitRegex: \d+-\d+-\d+\s\d+:\d+:\d+\.\d+\|.* + SplitKey: content + PreserveOthers: true + - Type: processor_split_char + SourceKey: content + SplitSep: "|" + SplitKeys: + - timestamp + - uuid + - level + - method + - class_line + - thread + - message + - exception + - Type: processor_split_char + SourceKey: class_line + SplitSep: ":" + SplitKeys: + - class + - line + - Type: processor_add_fields + Fields: + service: logtail-example-app + IgnoreIfExist: false +flushers: + - Type: flusher_kafka_v2 + Brokers: + - 192.168.0.101:9092 + - 192.168.0.102:9092 + - 192.168.0.103:9092 + Topic: APP_LOG +``` + + +### Err 日志采集 +```yaml +enable: true +inputs: + - Type: file_log + LogPath: /home/tomcat/logs/err + FilePattern: err.*.ing +processors: + - Type: processor_split_log_regex + SplitRegex: \d+-\d+-\d+\s\d+:\d+:\d+\.\d+\|.* + SplitKey: content + PreserveOthers: true + - Type: processor_split_char + SourceKey: content + SplitSep: "|" + SplitKeys: + - timestamp + - uuid + - level + - method + - class_line + - thread + - message + - exception + - Type: processor_split_char + SourceKey: class_line + SplitSep: ":" + SplitKeys: + - class + - line + - Type: processor_add_fields + Fields: + service: logtail-example-app + IgnoreIfExist: false +flushers: + - Type: flusher_kafka_v2 + Brokers: + - 192.168.0.101:9092 + - 192.168.0.102:9092 + - 192.168.0.103:9092 + Topic: ERR_LOG +```