Spring Boot 使用 Log4j2 将日志数据写入 Syslog

2023-11-12

教程

1、概览

日志是每个应用的重要组成部分。在应用中，可以将日志存储在文件或数据库中。除此以外，还可以将日志数据发送到集中式日志管理应用，如 Graylog 或 Syslog。

应用中的日志系统架构

本文将带你了解如何在 Spring Boot 应用中使用 Log4j2 将日志信息发送到 Syslog 服务器。

2、Log4j2

Log4j2 是 Log4j 的最新版本。它是高性能日志记录的常见选择，并被广泛应用于许多生产应用中。

2.1、Maven 依赖

在 pom.xml 中添加 spring-boot-starter-log4j2 依赖。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j2</artifactId>
    <version>2.5.2</version>
</dependency>

要在 Spring Boot 应用中配置 Log4j2，需要从 pom.xml 中的任何 Starter 中排除默认的 Logback 日志框架。

在本文示例项目中，只有 spring-boot-starter-web Starter 依赖。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <exclusions>
        <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-logging</artifactId>
        </exclusion>
    </exclusions>
</dependency>

2.2、Log4j2 配置

现在，创建 Log4j2 配置文件。Spring Boot 会在 classpath 中搜索 log4j2-spring.xml 或 log4j2.xml 文件。

在 resource 目录中配置一个示例 log4j2-spring.xml：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration>
    <Appenders>
        <Console name="ConsoleAppender" target="SYSTEM_OUT">
            <PatternLayout
                pattern="%style{%date{DEFAULT}}{yellow} %highlight{%-5level}{FATAL=bg_red, ERROR=red, WARN=yellow, INFO=green} %message"/>
        </Console>
    </Appenders>
    <Loggers>
        <Root level="info">
            <AppenderRef ref="ConsoleAppender"/>
        </Root>
    </Loggers>
</Configuration>

配置中有一个 Console appender，用于向控制台输出日志数据。

2.3、Syslog Appender

Appender 是日志框架的主要组件，用于将日志数据传送到目的地。Log4j2 支持许多 Appender，如 Syslog Appender。

更新 log4j2-spring.xml 文件，添加 Syslog Appender，将日志数据发送到 Syslog 服务器：

<Syslog name="Syslog" format="RFC5424" host="localhost" port="514"
    protocol="UDP" appName="baeldung" facility="LOCAL0" />

Syslog Appender 有许多属性：

name：appender 名称。
format：可以设置为 BSD 或 RFC5424。
host：Syslog 服务器地址。
port：Syslog 服务器的端口。
protocol：使用 TCP 还是 UPD。
appName：记录日志的应用名称。
facility：消息的类别。

3、Syslog 服务器

现在，设置 Syslog Server。在许多 Linux 发行版中，rsyslog 是主要的日志机制。它包含在大多数 Linux 发行版中，如 Ubuntu 和 CentOS。

3.1、Syslog 配置

rsyslog 配置应与 Log4j2 设置相匹配。rsyslog 配置在 /etc/rsyslog.conf 文件中定义。在 Log4j2 配置中，分别使用 UDP 和 514 作为协议和端口。因此，在 rsyslog.conf 文件中添加或取消注释以下几行：

# 提供 UDP 日志接收
module(load="imudp")
input(type="imudp" port="514")

如上，设置 module(load="imudp") 加载 imudp 模块，以便通过 UDP 接收 Syslog 消息。然后，使用 input 配置将 port 设置为 514。input 将端口分配给 imudp 模块。然后，重启 rsyslog 服务器：

sudo service rsyslog restart

现在，配置就绪了。

3.2、测试

创建一个简单的 Spring Boot 应用，记录一些日志：

@SpringBootApplication
public class SpringBootSyslogApplication {

    private static final Logger logger = LogManager.getLogger(SpringBootSyslogApplication.class);

    public static void main(String[] args) {
        SpringApplication.run(SpringBootSyslogApplication.class, args);

        logger.debug("Debug log message");
        logger.info("Info log message");
        logger.error("Error log message");
        logger.warn("Warn log message");
        logger.fatal("Fatal log message");
        logger.trace("Trace log message");
    }
}

日志信息存储在 /var/log/ 目录中。

查看 syslog 文件：

tail -f /var/log/syslog

运行 Spring Boot 应用时，可以看到如下日志信息：

Jun 30 19:49:35 baeldung[16841] Info log message
Jun 30 19:49:35 baeldung[16841] Error log message
Jun 30 19:49:35 baeldung[16841] Warn log message
Jun 30 19:49:35 baeldung[16841] Fatal log message

4、总结

本文介绍了如何在 Spring Boot 中使用 Log4j2 把日志输出到 rsyslog 服务器。

Ref：https://www.baeldung.com/log4j-to-syslog