Sử dụng Logging trong Spring Boot

Xem thêm các chuyên mục:

1- Mục tiêu của bài học

Hiểu một cách đơn giản "Logging""ghi chép" lại các vấn đề trong quá trình ứng dụng hoạt động. Các vấn đề ở đây là các thông tin lỗi, các cảnh báo (warning), và các thông tin khác, ... Các thông tin này có thể được hiển thị trên màn hình Console hoặc ghi vào file.
Khi bạn chạy ứng dụng Spring Boot trực tiếp trên Eclipse bạn có thể nhìn thấy các thông tin trên cửa sổ Console, các thông tin này cho bạn biết tình trạng của ứng dụng, các lỗi xẩy ra trong quá trình ứng dụng chạy. Đó chính là Logging!.
Có nhiều thư viện Logging khác nhau như Logback, Log4j2, JUL,.. Spring Boot có thể làm việc với tất cả các thư viện này. Theo mặc định Spring Boot đã tự động cấu hình và sử dụng thư viện Logback cho logging của nó, và bạn không cần bất kỳ một cấu hình nào thêm, trừ khi bạn muốn tùy biến một vài thông số (argument). Các tùy biến ở đây có thể là chỉ định tên tập tin để ghi các thông tin, khuôn mẫu (pattern), ...
Trong bài học này, chúng ta sẽ thảo luận về nguyên tắc hoạt động của Logback trong ứng dụng Spring Boot, và tìm hiểu cách tùy biến cho Logback.
Các thuộc tính (properties) mà bạn có thể tùy biến:
logging.config
logging.exception-conversion-word
logging.file
logging.level.*
logging.path
logging.pattern.console
logging.pattern.file
logging.pattern.level
logging.register-shutdown-hook

2- Tạo dự án Spring Boot

Trên Eclipse tạo dự án Spring Boot.
Để sử dụng Logging, bạn cần sử dụng một trong các "Starter" sau:
  • spring-boot-starter-logging
  • spring-boot-starter-web
pom.xml
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
    http://maven.apache.org/xsd/maven-4.0.0.xsd">
    
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.o7planning</groupId>
    <artifactId>SpringBootDefaultLogging</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>SpringBootDefaultLogging</name>
    <description>Spring Boot +Default Logging</description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.0.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>
MainController.java
package org.o7planning.sblogging.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

@Controller
public class MainController {

    private static final Logger LOGGER = LoggerFactory.getLogger(MainController.class);

    @ResponseBody
    @RequestMapping(path = "/")
    public String home() {

        LOGGER.trace("This is TRACE");
        LOGGER.debug("This is DEBUG");
        LOGGER.info("This is INFO");
        LOGGER.warn("This is WARN");
        LOGGER.error("This is ERROR");

        return "Hi, show loggings in the console or file!";
    }
    
}
Chạy ứng dụng của bạn trực tiếp trên Spring Boot, sau đó truy cập vào đường dẫn dưới đây:
Trên cửa sổ Console của Eclipse bạn có thể nhìn thấy các thông tin Logs như sau:
2018-01-14 13:21:57.593  INFO 7980 --- [nio-8080-exec-6] o.o.sblogging.controller.MainController  : This is INFO
2018-01-14 13:21:57.593  WARN 7980 --- [nio-8080-exec-6] o.o.sblogging.controller.MainController  : This is WARN
2018-01-14 13:21:57.593 ERROR 7980 --- [nio-8080-exec-6] o.o.sblogging.controller.MainController  : This is ERROR
 

3- Logging Level

Dựa trên mức độ nghiêm trọng của vấn đề, Logback chia các thông tin cần ghi chép thành 5 mức độ (Level), loại ít nghiêm trọng nhất là TRACE, và loại nghiêm trọng nhất là ERROR. Chú ý: Có một số thư viện Logging phân chia các thông tin cần ghi chép thành 7 mức độ khác nhau.
 
  1. TRACE
  2. DEBUG
  3. INFO
  4. WARN
  5. ERROR
  6. FATAL
  7. OFF
Theo mặc định Spring Boot chỉ ghi lại các thông tin có độ nghiêm trọng từ mức INFO trở lên.
# Default:

logging.level.root=INFO
Thay đổi Logging Level trong application.properties:
* application.properties *
logging.level.root=WARN

# ..
Chạy lại ứng dụng của bạn, và xem thông tin được ghi ra trên cửa sổ Console:
2018-01-14 17:45:50.341  WARN 8500 --- [nio-8080-exec-1] o.o.sblogging.controller.MainController  : This is WARN
2018-01-14 17:45:50.342 ERROR 8500 --- [nio-8080-exec-1] o.o.sblogging.controller.MainController  : This is ERROR

4- Logging File

Các thông logging mặc định được ghi ra màn hình Console, tuy nhiên bạn có thể cấu hình để chúng được ghi ra file.
* application.properties *
logging.file=logs/mylog.log
Chạy lại ứng dụng của bạn trực tiếp trên Eclipse, sau đó truy cập vào đường dẫn sau:
Sau đó refresh lại project, bạn có thể thấy tập tin logging đã được tạo ra.

5- Logging Pattern

Các bản ghi Log (Log record) được ghi ra theo một mẫu (pattern), dưới đây là một mẫu (pattern) mặc định:
Và bạn có thể thay đổi "Logging pattern" bằng cách tùy biến các thuộc tính (properties) dưới đây:
  1. logging.pattern.console
  2. logging.pattern.file
# Pattern:

logging.pattern.console= %d{yyyy-MMM-dd HH:mm:ss.SSS} %-5level [%thread] %logger{15} - %msg%n

# Output:

2018-Jan-17 01:58:49.958 WARN  [http-nio-8080-exec-1] o.o.s.c.MainController - This is WARN
2018-Jan-17 01:58:49.960 ERROR [http-nio-8080-exec-1] o.o.s.c.MainController - This is ERROR
 
# Pattern:

logging.pattern.console= %d{dd/MM/yyyy HH:mm:ss.SSS} %-5level [%thread] %logger{115} - %msg%n

# Output:

17/01/2018 02:15:15.052 WARN  [http-nio-8080-exec-1] org.o7planning.sblogging.controller.MainController - This is WARN
17/01/2018 02:15:15.054 ERROR [http-nio-8080-exec-1] org.o7planning.sblogging.controller.MainController - This is ERROR
# Pattern:

logging.pattern.console=%d{yy-MMMM-dd HH:mm:ss:SSS} %5p %t %c{2}:%L - %m%n

# Output:

18-January-17 02:21:20:317  WARN http-nio-8080-exec-1 o.o.s.c.MainController:22 - This is WARN
18-January-17 02:21:20:320 ERROR http-nio-8080-exec-1 o.o.s.c.MainController:23 - This is ERROR
 

Xem thêm các chuyên mục: