开源项目 `log-aggregation-spring-boot-elastic-stack` 使用教程

开源项目 log-aggregation-spring-boot-elastic-stack 使用教程

log-aggregation-spring-boot-elastic-stack Example on how to use Elastic Stack with Docker to collect, process, store, index and visualize logs of Spring Boot microservices. 项目地址: https://gitcode.com/gh_mirrors/lo/log-aggregation-spring-boot-elastic-stack

1. 项目的目录结构及介绍

log-aggregation-spring-boot-elastic-stack/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/
│   │   │       └── example/
│   │   │           └── logaggregation/
│   │   │               ├── LogAggregationApplication.java
│   │   │               ├── controller/
│   │   │               ├── model/
│   │   │               ├── repository/
│   │   │               └── service/
│   │   └── resources/
│   │       ├── application.yml
│   │       ├── logback-spring.xml
│   │       └── static/
│   └── test/
│       └── java/
│           └── com/
│               └── example/
│                   └── logaggregation/
│                       └── LogAggregationApplicationTests.java
├── .gitignore
├── LICENSE
├── README.md
└── pom.xml

目录结构介绍

• src/main/java/com/example/logaggregation/: 包含项目的Java源代码。
  • LogAggregationApplication.java: 项目的启动类。
  • controller/: 存放控制器类，处理HTTP请求。
  • model/: 存放数据模型类。
  • repository/: 存放数据访问层类。
  • service/: 存放业务逻辑层类。
• src/main/resources/: 存放项目的配置文件和静态资源。
  • application.yml: Spring Boot 配置文件。
  • logback-spring.xml: Logback 日志配置文件。
  • static/: 存放静态资源文件。
• src/test/java/com/example/logaggregation/: 存放项目的测试代码。
  • LogAggregationApplicationTests.java: 项目的测试类。
• .gitignore: Git忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• pom.xml: Maven项目配置文件。

2. 项目的启动文件介绍

LogAggregationApplication.java

package com.example.logaggregation;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class LogAggregationApplication {

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

启动文件介绍

• LogAggregationApplication.java 是项目的启动类，使用 @SpringBootApplication 注解标记，表示这是一个Spring Boot应用程序。
• main 方法是应用程序的入口，通过 SpringApplication.run 方法启动Spring Boot应用。

3. 项目的配置文件介绍

application.yml

spring:
  application:
    name: log-aggregation
  datasource:
    url: jdbc:h2:mem:testdb
    username: sa
    password: password
    driver-class-name: org.h2.Driver
  jpa:
    hibernate:
      ddl-auto: update
    show-sql: true

server:
  port: 8080

logging:
  level:
    root: INFO
    com.example.logaggregation: DEBUG

配置文件介绍

• spring.application.name: 设置应用程序的名称。
• spring.datasource: 配置数据源，包括数据库URL、用户名、密码和驱动类名。
• spring.jpa.hibernate.ddl-auto: 配置Hibernate的DDL自动更新策略。
• spring.jpa.show-sql: 配置是否显示SQL语句。
• server.port: 配置应用程序的端口号。
• logging.level: 配置日志级别，root 为全局日志级别，com.example.logaggregation 为特定包的日志级别。

logback-spring.xml

<configuration>
    <include resource="org/springframework/boot/logging/logback/base.xml"/>

    <logger name="com.example.logaggregation" level="DEBUG" additivity="false">
        <appender-ref ref="CONSOLE"/>
    </logger>

    <root level="INFO">
        <appender-ref ref="CONSOLE"/>
    </root>
</configuration>

日志配置文件介绍

• include resource="org/springframework/boot/logging/logback/base.xml": 引入Spring Boot默认的Logback配置。
• logger name="com.example.logaggregation": 配置特定包的日志级别为 DEBUG，并禁用日志的传递性。
• root level="INFO": 配置全局日志级别为 INFO。
• appender-ref ref="CONSOLE": 配置日志输出到控制台。

log-aggregation-spring-boot-elastic-stack Example on how to use Elastic Stack with Docker to collect, process, store, index and visualize logs of Spring Boot microservices. 项目地址: https://gitcode.com/gh_mirrors/lo/log-aggregation-spring-boot-elastic-stack