1. 概述

日志记录是每个应用程序中的重要组成部分。当我们在应用程序中使用日志记录机制时,我们可以将日志存储在文件或数据库中。此外,我们可以将日志记录数据发送到集中式日志管理应用程序,例如GraylogSyslog

第5页人物

在本教程中,我们将描述如何在Spring Boot应用程序中使用Log4j2将日志记录信息发送到 Syslog 服务器。

2.Log4j2

Log4j2 是 Log4j 的最新版本。它是高性能日志记录的常见选择,并用于许多生产应用程序。

2.1. Maven依赖

让我们首先将 spring-boot-starter-log4j2 依赖项添加到 pom.xml 中:

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

为了在 Spring Boot 应用程序中配置 Log4j2,我们需要从 pom.xml 中的任何入门库中排除默认的 Logback 日志记录框架。在我们的项目中,只有 spring-boot-starter-web 启动器依赖项。让我们从中排除默认日志记录:

<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 项目在类路径中搜索 log4j2-spring.xmllog4j2.xml 文件。我们在 资源 目录下配置一个简单的 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>

该配置有一个 控制台 附加器,用于将日志记录数据显示到控制台。

2.3.系统日志附加程序

Appender 是日志框架中的主要组件,用于将日志数据传送到目的地。 Log4j2 支持许多附加程序,例如 Syslog 附加程序。让我们更新 log4j2-spring.xml 文件以添加 Syslog 附加程序,用于将日志记录数据发送到 Syslog 服务器:

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

Syslog 附加程序有许多属性:

  • name : 附加器的名称
  • 格式 :可以设置为 BSD 或 RFC5424
  • host : Syslog 服务器的地址
  • port : Syslog 服务器的端口
  • 协议 :是否使用 TCP 或 UPD
  • appName :正在记录的应用程序的名称
  • facility : 消息的类别

3.系统日志服务器

现在,让我们设置 Syslog 服务器。在许多 Linux 发行版中, rsyslog 是主要的日志记录机制。它包含在大多数 Linux 发行版中,例如 Ubuntu 和 CentOS。

3.1.系统日志配置

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

# provides UDP syslog reception
module(load="imudp")
input(type="imudp" port="514")

在本例中,我们设置 module(load=”imudp”) 来加载 imudp 模块以通过 UDP 接收 Syslog 消息。然后,我们使用 输入 配置将 端口 设置为 514。 输入 将端口分配给模块。之后,我们应该重新启动 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/ 目录中。让我们检查一下 系统日志 文件:

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 中的 Syslog 配置。此外,我们将 rsyslog 服务器配置为 Syslog 服务器。像往常一样,完整的源代码可以在 GitHub 上找到。