Spring Logging Custom

Deskripsi

Logging adalah aspek paling penting dalam pengembangan software dengan adanya log memudahkan kita sebagai programmer untuk menerawang error, monitor dan memastikan aplikasi kita berjalan dengan seharusnya.

"log itu penting, programmer bukan dukun" - Programmer Zaman Know

Spring sudah menyediakan liblary untuk logging secara default memudahkan kita untuk memproduce log, namun adakalanya kita ingin meng-custom logging sesuai selera dan kebutuhan kita.

Cara

1. Buka application.properties atau application.yaml dan tambahkan pattern sebagai berikut : 
   
   logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss.SSS} %5p %c{1}:%L - %m%n
   Logging Format Parameter
   %d : date
   %p : log level (seperti DEBUG, INFO, WARN, ERROR, dll)
   %t : nama threat yang menjalankan proses
   %c : class yang dieksekusi
   %m : pesan dari log.info(), log.debug(), dll
   %n : buat baris baru
   %L : bari code yang dieksekusi
   %M : method yang eksekusi
   %X : nilai yang di custom yang disimpan didalam MDC
   
   lengkapnya Logging Format Parameter temen-temen bisa lihat di link ini : https://logging.apache.org/log4j/2.x/manual/layouts.html#patterns
   
   
2. Custom propertie menggunakan MDC
   
   cara menyimpan 
   
   MDC.put("userId", "12345");
   
   cara hapus by key
   
   MDC.remove("userId");
   
   hapus semua key 
   MDC.clear();
   
   cara memanggil MDC di application.properties
   
   logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss.SSS} %5p [%X{userId}] %c{1}:%L - %m%n
   
   

Contoh

logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss.SSS} %5p %c{1}:%L - %m%n

import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.slf4j.MDC;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;

import java.util.UUID;

@Component
public class CustomizeApplicationLoggingInterceptor implements HandlerInterceptor {

    private static final Logger LOGGER = LoggerFactory.getLogger(CustomizeApplicationLoggingInterceptor.class);
    private static final String REQUEST_ID = "requestId";


    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
       String requestId = UUID.randomUUID().toString().substring(0,6);
       MDC.put(REQUEST_ID, requestId);
       LOGGER.info("Received request with ID: {}", requestId);
       return true;
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
       String requestId = MDC.get(REQUEST_ID);
       LOGGER.info("Request with ID {} completed", requestId);
       MDC.remove(REQUEST_ID);
    }

}

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
       registry.addInterceptor(new CustomizeApplicationLoggingInterceptor());
    }
}

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class CustomizeApplicationLoggingController {

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

    @GetMapping("/hello")
    public String sendGreetings() {
       LOGGER.info("Sending greeting to user");
       return "Hello User!";
    }
}