Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ subprojects {
dependencies { // 모든 하위 모듈에 추가 될 의존성 목록입니다.
implementation 'org.springframework.boot:spring-boot-starter-web'

// log
implementation 'org.springframework.boot:spring-boot-starter-logging'
implementation 'org.springframework.boot:spring-boot-starter-aop'

// Test
testImplementation 'org.springframework.boot:spring-boot-starter-test'
testImplementation 'com.h2database:h2'
Expand Down
68 changes: 68 additions & 0 deletions module-api/src/main/resources/logback-spring.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<property name="LOG_PATH" value="logs"/>

<!-- MDC로 traceId 사용 -->
<conversionRule conversionWord="X" converterClass="ch.qos.logback.classic.pattern.MDCConverter"/>

<!-- 콘솔 로그 (색상 출력) -->
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %highlight(%-5level) %logger{36} - %msg%n%throwable</pattern>
</encoder>
</appender>

<!-- Request 로그 -->
<appender name="REQUEST_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${LOG_PATH}/request.log</file>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${LOG_PATH}/request.%d{yyyy-MM}.log</fileNamePattern>
<maxHistory>12</maxHistory>
</rollingPolicy>
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - [TRACE_ID:%X{traceId}] %msg%n</pattern>
</encoder>
</appender>

<!-- Response 로그 -->
<appender name="RESPONSE_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${LOG_PATH}/response.log</file>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${LOG_PATH}/response.%d{yyyy-MM}.log</fileNamePattern>
<maxHistory>12</maxHistory>
</rollingPolicy>
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - [TRACE_ID:%X{traceId}] %msg%n</pattern>
</encoder>
</appender>

<!-- Error 로그 -->
<appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${LOG_PATH}/error.log</file>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${LOG_PATH}/error.%d{yyyy-MM}.log</fileNamePattern>
<maxHistory>12</maxHistory>
</rollingPolicy>
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - [TRACE_ID:%X{traceId}] %msg%n</pattern>
</encoder>
</appender>

<!-- 로그 레벨 별로 분기 -->
<logger name="com.fourcut.diary.logging.request" level="INFO" additivity="false">
<appender-ref ref="REQUEST_FILE"/>
</logger>

<logger name="com.fourcut.diary.logging.response" level="INFO" additivity="false">
<appender-ref ref="RESPONSE_FILE"/>
</logger>

<logger name="com.fourcut.diary.logging.error" level="ERROR" additivity="false">
<appender-ref ref="ERROR_FILE"/>
</logger>

<!-- 공통 출력 -->
<root level="INFO">
<appender-ref ref="CONSOLE"/>
</root>
</configuration>
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
package com.fourcut.diary.constant;

public class SensitiveKeyword {

public static final String[] SENSITIVE_KEYWORDS = {"authorizationCode", "fcmToken", "accessToken", "refreshToken", "presignedUrl"};
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
package com.fourcut.diary.logging;

import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.EnableAspectJAutoProxy;

@Configuration
@EnableAspectJAutoProxy
public class LoggingConfig {
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
package com.fourcut.diary.logging;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fourcut.diary.util.StringUtil;
import jakarta.servlet.http.HttpServletRequest;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.slf4j.MDC;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import java.util.Arrays;
import java.util.Collections;
import java.util.UUID;
import java.util.stream.Collectors;

@Aspect
@Component
@Slf4j
public class RequestResponseLoggingAspect {

private final ObjectMapper objectMapper = new ObjectMapper();
private static final Logger requestLogger = LoggerFactory.getLogger("com.fourcut.diary.logging.request");
private static final Logger responseLogger = LoggerFactory.getLogger("com.fourcut.diary.logging.response");
private static final Logger errorLogger = LoggerFactory.getLogger("com.fourcut.diary.logging.error");

@Around("execution(* com.fourcut.diary..*Controller.*(..))")
public Object logRequestAndResponse(ProceedingJoinPoint joinPoint) throws Throwable {
String traceId = UUID.randomUUID().toString();
MDC.put("traceId", traceId);

HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.currentRequestAttributes()).getRequest();

String method = request.getMethod();
String uri = request.getRequestURI();
String queryString = request.getQueryString();
String clientIP = request.getRemoteAddr();

String headers = Collections.list(request.getHeaderNames()).stream()
.map(header -> header + "=" + request.getHeader(header))
.collect(Collectors.joining(", "));

String params = Arrays.stream(joinPoint.getArgs())
.map(arg -> {
try {
return StringUtil.maskSensitiveFields(objectMapper.writeValueAsString(arg));
} catch (JsonProcessingException e) {
return arg.toString();
}
})
.collect(Collectors.joining(", "));

long start = System.currentTimeMillis();

try {
requestLogger.info("[REQUEST] {} {}{} | IP: {} | Headers: {} | Params: {}",
method, uri, queryString != null ? "?" + queryString : "", clientIP, headers, params);

Object result = joinPoint.proceed();

String responseJson = objectMapper.writeValueAsString(result);
responseJson = StringUtil.maskSensitiveFields(responseJson);
long duration = System.currentTimeMillis() - start;

responseLogger.info("[RESPONSE] {} {} | IP: {} | Response: {} | Time: {}ms",
method, uri, clientIP, responseJson, duration);

return result;
} catch (Throwable e) {
long duration = System.currentTimeMillis() - start;
errorLogger.error("[ERROR] {} {} | IP: {} | Error: {} | Time: {}ms",
method, uri, clientIP, e.getMessage(), duration);
throw e;
} finally {
MDC.clear();
}
}
}
13 changes: 13 additions & 0 deletions module-common/src/main/java/com/fourcut/diary/util/StringUtil.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
package com.fourcut.diary.util;

import com.fourcut.diary.constant.SensitiveKeyword;

public class StringUtil {

public static String maskSensitiveFields(String json) {
for (String key : SensitiveKeyword.SENSITIVE_KEYWORDS) {
json = json.replaceAll("(\"" + key + "\"\\s*:\\s*\")[^\"]*\"", "$1****\"");
}
return json;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
import org.springframework.data.redis.serializer.StringRedisSerializer;

@Configuration
@EnableRedisRepositories
@EnableRedisRepositories(basePackages = "com.fourcut.diary.auth.repository")
public class RedisConfig {

@Value("${spring.data.redis.host}")
Expand Down