你居然还去服务器上捞日志,搭个日志收集系统难道不香么!
<timeZone>Asia/Shanghai</timeZone>
</timestamp>
<pattern>
<pattern>
{
"project": "mall-tiny",
"level": "%level",
"service": "${APP_NAME:-}",
"pid": "${PID:-}",
"thread": "%thread",
"class": "%logger",
"message": "%message",
"stack_trace": "%exception{20}"
}
</pattern>
</pattern>
</providers>
</encoder>
<connectionStrategy>
<roundRobin>
<connectionTTL>5 minutes</connectionTTL>
</roundRobin>
</connectionStrategy>
</appender>
<appender name="LOG_STASH_ERROR" class="net.logstash.logback.appender.LogstashTcpSocketAppender">
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>ERROR</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
<destination>${LOG_STASH_HOST}:4561</destination>
<encoder charset="UTF-8" class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder">
<providers>
<timestamp>
<timeZone>Asia/Shanghai</timeZone>
</timestamp>
<pattern>
<pattern>
{
"project": "mall-tiny",
"level": "%level",
"service": "${APP_NAME:-}",
"pid": "${PID:-}",
"thread": "%thread",
"class": "%logger",
"message": "%message",
"stack_trace": "%exception{20}"
}
</pattern>
</pattern>
</providers>
</encoder>
<connectionStrategy>
<roundRobin>
<connectionTTL>5 minutes</connectionTTL>
</roundRobin>
</connectionStrategy>
</appender>
<appender name="LOG_STASH_BUSINESS" class="net.logstash.logback.appender.LogstashTcpSocketAppender">
<destination>${LOG_STASH_HOST}:4562</destination>
<encoder charset="UTF-8" class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder">
<providers>
<timestamp>
<timeZone>Asia/Shanghai</timeZone>
</timestamp>
<pattern>
<pattern>
{
"project": "mall-tiny",
"level": "%level",
"service": "${APP_NAME:-}",
"pid": "${PID:-}",
"thread": "%thread",
"class": "%logger",
"message": "%message",
"stack_trace": "%exception{20}"
}
</pattern>
</pattern>
</providers>
</encoder>
<connectionStrategy>
<roundRobin>
<connectionTTL>5 minutes</connectionTTL>
</roundRobin>
</connectionStrategy>
</appender>
<appender name="LOG_STASH_RECORD" class="net.logstash.logback.appender.LogstashTcpSocketAppender">
<destination>${LOG_STASH_HOST}:4563</destination>
<encoder charset="UTF-8" class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder">
<providers>
<timestamp>
<timeZone>Asia/Shanghai</timeZone>
</timestamp>
<pattern>
<pattern>
{
"project": "mall-tiny",
"level": "%level",
"service": "${APP_NAME:-}",
"class": "%logger",
"message": "%message"
}
</pattern>
</pattern>
</providers>
</encoder>
<connectionStrategy>
<roundRobin>
<connectionTTL>5 minutes</connectionTTL>
</roundRobin>
</connectionStrategy>
</appender>
<logger name="
org.slf4j" level="INFO"/>
<logger name="springfox" level="INFO"/>
<logger name="io.swagger" level="INFO"/>
<logger name="org.springframework" level="INFO"/>
<logger name="org.hibernate.validator" level="INFO"/>
<root level="DEBUG">
<appender-ref ref="CONSOLE"/>
<appender-ref ref="LOG_STASH_DEBUG"/>
<appender-ref ref="LOG_STASH_ERROR"/>
</root>
<logger name="com.macro.mall.tiny.component" level="DEBUG">
<appender-ref ref="LOG_STASH_RECORD"/>
</logger>
<logger name="com.macro.mall" level="DEBUG">
<appender-ref ref="LOG_STASH_BUSINESS"/>
</logger>
</configuration>
配置要点解析
使用默认的日志配置
一般我们不需要自定义控制台输出,可以采用默认配置,具体配置参考
console-appender.xml
,该文件在spring-boot-${version}.jar
下面。
<include resource="org/springframework/boot/logging/logback/defaults.xml"/>
<include resource="org/springframework/boot/logging/logback/console-appender.xml"/>
springProperty
该标签可以从 SpringBoot 的配置文件中获取配置属性,比如说在不同环境下我们的 Logstash 服务地址是不一样的,我们就可以把该地址定义在
application.yml
来使用。
例如在application-dev.yml
中定义了这些属性:
logstash:
host: localhost
在logback-spring.xml
中就可以直接这样使用:
<springProperty scope="context" name="APP_NAME" source="spring.application.name" defaultValue="springBoot"/>
<springProperty name="LOG_STASH_HOST" scope="context" source="logstash.host" defaultValue="localhost"/>
filter
在 Logback 中有两种不同的过滤器,用来过滤日志输出。
ThresholdFilter:临界值过滤器,过滤掉低于指定临界值的日志,比如下面的配置将过滤掉所有低于 INFO 级别的日志。
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>INFO</level>
</filter>
LevelFilter:级别过滤器,根据日志级别进行过滤,比如下面的配置将过滤掉所有非 ERROR 级别的日志。
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>ERROR</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
appender
Appender 可以用来控制日志的输出形式,主要有下面三种。
ConsoleAppender:控制日志输出到控制台的形式,比如在
console-appender.xml
中定义的默认控制台输出。
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>${CONSOLE_LOG_PATTERN}</pattern>
</encoder>
</appender>
RollingFileAppender:控制日志输出到文件的形式,可以控制日志文件生成策略,比如文件名称格式、超过多大重新生成文件以及删除超过多少天的文件。
<appender name="FILE_ERROR"
class="ch.qos.logback.core.rolling.RollingFileAppender">
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<fileNamePattern>{APP_NAME}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
<maxFileSize>${LOG_FILE_MAX_SIZE:-10MB}</maxFileSize>
<maxHistory>${LOG_FILE_MAX_HISTORY:-30}</maxHistory>
</rollingPolicy>
</appender>
LogstashTcpSocketAppender:控制日志输出到 Logstash 的形式,可以用来配置 Logstash 的地址、访问策略以及日志的格式。
<appender name="LOG_STASH_ERROR" class="net.logstash.logback.appender.LogstashTcpSocketAppender">
<destination>${LOG_STASH_HOST}:4561</destination>
<encoder charset="UTF-8" class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder">
<providers>
<timestamp>
<timeZone>Asia/Shanghai</timeZone>
</timestamp>
<pattern>
<pattern>
{
"project": "mall-tiny",
"level": "%level",
"service": "${APP_NAME:-}",
"pid": "${PID:-}",
"thread": "%thread",
"class": "%logger",
"message": "%message",
"stack_trace": "%exception{20}"
}
</pattern>
</pattern>
</providers>
</encoder>
<connectionStrategy>
<roundRobin>
<connectionTTL>5 minutes</connectionTTL>
</roundRobin>
</connectionStrategy>
</appender>
logger
只有配置到 logger 节点上的 appender 才会被使用,logger 用于配置哪种条件下的日志被打印,root 是一种特殊的 appender,下面介绍下日志划分的条件。
调试日志:所有的 DEBUG 级别以上日志;
错误日志:所有的 ERROR 级别日志;
业务日志:
com.macro.mall
包下的所有 DEBUG 级别以上日志;记录日志:
com.macro.mall.tiny.component.WebLogAspect
类下所有 DEBUG 级别以上日志,该类是统计接口访问信息的 AOP 切面类。
控制框架输出日志
还有一些使用框架内部的日志,DEBUG 级别的日志对我们并没有啥用处,都可以设置为了 INFO 以上级别。
<logger name="org.slf4j" level="INFO"/>
<logger name="springfox" level="INFO"/>
<logger name="io.swagger" level="INFO"/>
<logger name="org.springframework" level="INFO"/>
<logger name="org.hibernate.validator" level="INFO"/>
Logstash 配置详解
接下来我们需要配置下 Logstash,让它可以分场景收集不同的日志,下面详细介绍下使用到的配置。
完全配置
input {
tcp {
mode => "server"
host => "0.0.0.0"
port => 4560
codec => json_lines
type => "debug"
}
tcp {
mode => "server"
host => "0.0.0.0"
port => 4561
codec => json_lines
type => "error"
}
tcp {
mode => "server"
host => "0.0.0.0"
port => 4562
codec => json_lines
type => "business"
}
tcp {
mode => "server"
host => "0.0.0.0"
port => 4563
codec => json_lines
type => "record"
}
}
filter{
if [type] == "record" {
mutate {
remove_field => "port"
remove_field => "host"
remove_field => "@version"
}
json {
source => "message"
remove_field => ["message"]
}
}
}
output {
elasticsearch {
hosts => ["es:9200"]
action => "index"
codec => json
index => "mall-tiny-%{type}-%{+YYYY.MM.dd}"
template_name => "mall-tiny"
}
}
配置要点
input:使用不同端口收集不同类型的日志,从 4560~4563 开启四个端口;
filter:对于记录类型的日志,直接将 JSON 格式的 message 转化到 source 中去,便于搜索查看;
output:按类型、时间自定义索引格式。
SpringBoot 配置
在 SpringBoot 中的配置可以直接用来覆盖 Logback 中的配置,比如
logging.level.root
就可以覆盖<root>
节点中的level
配置。
开发环境配置:application-dev.yml
logstash:
host: localhost
logging:
level:
root: debug
测试环境配置:application-test.yml
logstash:
host: 192.168.3.101
logging:
level:
root: debug
生产环境配置:application-prod.yml
logstash:
host: logstash-prod
logging:
level:
root: info
Kibana 进阶使用
进过上面 ELK 环境的搭建和配置以后,我们的日志收集系统终于可以用起来了,下面介绍下在 Kibana 中的使用技巧!
首先启动我们的测试 Demo,然后通用调用接口(可以使用 Swagger),产生一些日志信息;
调用完成后在
Management->Kibana->Index Patterns
中可以创建Index Patterns
,Kibana 服务访问地址:http://192.168.3.101:5601
创建完成后可以在
Discover
中查看所有日志,调试日志只需直接查看mall-tiny-debug*
模式的日志即可;
对于日志搜索,kibana 有非常强大的提示功能,可以通过搜索栏右侧的
Options
按钮打开;
记录日志只需直接查看
mall-tiny-record*
模式的日志即可,如果我们想要搜索 uri 为/brand/listAll
的记录日志,只需在搜索栏中输入uri : "/brand/listAll"
;
错误日志,只需直接查看
mall-tiny-error*
模式的日志即可;
评论