SpringBoot+Docker+Graylog - 让错误自动报警

01 Spring Boot 默认日志框架解析

Spring Boot 默认采用 SLF4J（Simple Logging Facade for Java）作为日志门面，并搭配 Logback 作为默认日志实现框架。

• SLF4J ：作为日志门面，SLF4J 好比一个 “中间翻译官”，为开发者提供了统一的日志接口。
这使得开发者能够在不修改代码的情况下，轻松切换不同的日志实现。

• Logback ：作为 Log4j 的继任者，Logback 凭借其优越的性能、丰富的功能以及灵活的配置，成为 Spring Boot 日志模块的得力 “助手”。

02 Spring Boot 日志级别详解

Spring Boot 提供了多种日志级别，按从低到高依次为：

• TRACE ：包含最详细的信息，主要用于深入的程序调试。
• DEBUG ：用于记录开发阶段的调试信息，帮助开发者快速定位问题。
• INFO ：记录常规的运行信息，如应用程序启动、配置加载等，能让开发者清晰了解程序运行状态。
• WARN ：用于提醒潜在的问题，虽然这些问题暂时不会影响程序正常运行，但值得开发者关注。
• ERROR ：记录错误信息，表明程序运行过程中出现了需要解决的问题。
• FATAL ：表示严重的错误，通常会导致应用程序终止（Logback 中使用 ERROR 代替 FATAL）。

可以通过配置文件或命令行参数灵活设置日志级别，以便在不同场景下获取合适的日志信息。

03 Spring Boot 日志配置全面攻略

Spring Boot 日志配置的灵活性，体现在多种配置方式上。

（一）配置文件配置
Spring Boot 支持在 application.properties 或 application.yml 中配置日志，常见配置项如下：

• 设置日志级别 ：

# 设置根日志级别为 INFO
logging.level.root=INFO
# 设置 org.springframework 包相关的日志级别为 DEBUG
logging.level.org.springframework=DEBUG
# 设置 com.example 包相关的日志级别为 TRACE
logging.level.com.example=TRACE
• 指定日志文件路径 ：
# 指定日志文件名为 app.log
logging.file.name=app.log
# 指定日志文件存放路径为 /var/logs
logging.file.path=/var/logs
• 配置日志格式 ：
# 设置控制台日志格式
logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss} - %msg%n
# 设置文件日志格式
logging.pattern.file=%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n

（二）Logback 自定义配置

对于复杂的日志配置需求，可直接使用 Logback 的配置文件。

在 src/main/resources 目录下创建 logback-spring.xml 文件，示例如下：

<configuration>
    <!-- 定义一个控制台输出的 appender -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <!-- 设置日志输出格式 -->
            <pattern>%d{yyyy-MM-dd HH:mm:ss} - %msg%n</pattern>
        </encoder>
    </appender>

    <!-- 设置根日志级别为 INFO，并引用 STDOUT appender -->
    <root level="INFO">
        <appender-ref ref="STDOUT" />
    </root>
</configuration>

注解：

1. 定义了一个名为 STDOUT 的 ConsoleAppender，用于将日志输出到控制台。
2. 通过 encoder 中的 pattern 设置了日志输出的格式，包括日期时间、日志信息等。
3. 设置根日志级别为 INFO，并将 STDOUT appender 与根日志相关联，实现日志的输出与控制。

（三）环境配置
Spring Boot 支持根据不同环境（开发、测试、生产）配置不同的日志行为。

例如：

• 在 application-dev.properties 中设置开发环境日志级别为 DEBUG，以获取更详细的调试信息 ：
logging.level.root=DEBUG
• 在 application-online.properties 中设置生产环境日志级别为 WARN，减少日志对性能的影响 ：
logging.level.root=WARN

04 Spring Boot 日志输出多样化方案

Spring Boot 支持将日志输出到多种目标，满足不同场景下的日志需求。

• 控制台 ：默认情况下，日志会输出到控制台，方便开发者在开发和调试过程中实时查看日志信息。
• 文件 ：通过配置 logging.file.name 或 logging.file.path，可以将日志输出到文件，便于后续的日志分析和问题排查。
例如，将日志输出到 app.log 文件中，方便查看一段时间内的程序运行日志。
• 远程服务器 ：利用 Logback 或 Log4j 的配置，可将日志发送到远程服务器（如 ELK 堆栈，Graylog），实现日志的集中管理和分析，有助于大规模分布式系统的日志监控。

05 日志分组与监控集成策略

Spring Boot 日志分组 ：可将相关的日志记录器分组并统一设置日志级别。

例如：

# 将 org.springframework.web 和 org.springframework.security 分组为 web
logging.group.web=org.springframework.web, org.springframework.security
# 设置 web 分组的日志级别为 DEBUG
logging.level.web=DEBUG

Spring Boot 日志与监控集成 ：Spring Boot 日志模块能够与监控工具（如 Prometheus、Grafana）集成，实现日志的集中管理和分析。

其中，ELK（Elasticsearch、Logstash、Kibana）和 Graylog 堆栈是常用的日志收集、存储和可视化解决方案。

06 Spring Boot 与 Graylog 集成实战案例

（一）Spring Boot 应用配置
• 使用 Logback 配置示例 ：在 logback-spring.xml 中配置，将日志发送到 Graylog：

<appender name="GELF" class="de.siegmar.logbackgelf.GelfUdpAppender">
    <!-- 设置 Graylog 的主机地址为 localhost -->
    <graylogHost>localhost</graylogHost>
    <!-- 设置 Graylog 的端口为 12201 -->
    <graylogPort>12201</graylogPort>
</appender>

<root level="debug">
    <appender-ref ref="GELF" />
</root>

注解：

1. 定义了一个名为 GELF 的 GelfUdpAppender，用于将日志通过 UDP 协议发送到 Graylog。
2. 指定了 Graylog 的主机地址和端口，确保日志能够正确地发送到目标服务器。
3. 设置根日志级别为 debug，并将 GELF appender 与根日志关联，实现日志向 Graylog 的传输。

• 添加依赖 ：在 pom.xml 中添加以下依赖：

<dependency>
    <groupId>de.siegmar</groupId>
    <artifactId>logback-gelf</artifactId>
    <version>6.1.1</version>
</dependency>

（二）Graylog 安装与配置
1、安装 Docker ：从官网下载 Docker Desktop，点击安装。
若在安装过程中遇到网络问题，可配置源。

也可参考官网命令行安装（https://docs.docker.com/engine/install/centos/ ）。

2、安装 Graylog ：Graylog 官网提供了 docker-compose.yml 的配置。
在安装时，要注意选择合适的版本，避免使用企业版还是 open edition 的混淆。

使用 Graylog 官网提供的 “install graylog in Docker” 配置，执行 docker-compose up 命令，启动 Graylog 服务。

2、进入 Graylog 服务页面 ：顺利进入后，配置完 CA，正式进入 Graylog 系统。
特别要注意配置 inputs，选择 GELF UDP，以确保 Spring Boot 应用的日志能够顺利传输到 Graylog 服务器。

对应的 logback-spring.xml 文件配置如下：

<configuration>
    <appender name="GELF" class="de.siegmar.logbackgelf.GelfUdpAppender">
        <!-- 设置 Graylog 的主机地址为 127.0.0.1 -->
        <graylogHost>127.0.0.1</graylogHost>
        <!-- 设置 Graylog 的端口为 12201 -->
        <graylogPort>12201</graylogPort>
    </appender>

    <root level="info">
        <appender-ref ref="GELF"/>
    </root>
</configuration>

通过以上配置，Spring Boot 应用的日志将顺利上传到 Graylog 服务器，无需再去 Docker 服务器里寻找对应的日志文件，大大提高了日志管理的便捷性和效率。