<Spring> WARN 레벨 이상 로그 Slack 알림 보내기

📌 도입 배경

원래 WARN 레벨 이상 로그를 Sentry로 보냈었다.

하지만 Sentry 무료 라이선스를 이용 중이라서 도입한 지 10일 만에 용량 초과로 이메일이 왔다.

그래서 찾은 대안이 슬랙이었다.

 

어떻게 해야할까?

먼저 spring에서 log를 어떻게 처리할 수 있는지 알아보자.

📌 Log

🔵 System.out.printIn()

자바에서 로그를 표시하는 기본 중의 기본 함수이다.

 

하지만 이는 아래와 같은 이유로 쓰면 안 된다.

1. 휘발된다
   로그를 단지 콘솔에 띄우기만 하고, 다른 파일에 저장하지 않는다.
   실제로 저장되는 것이 없으므로, 추후 로그를 이용한 시스템 관련 작업이 불가능하다.
2. 로그만 나온다
   로그가 잘 나오는데 무슨 문제가 있는가?라는 질문이 나올 수 있다.
   하지만 이는 문제로 작용한다.
   로그뿐만이 아니라 시간, 스레드 이름 등 다양한 정보가 디버깅에 어려움이 있을 수 있다.
3. 성능 저하의 원인이 될 수 있다.
   이 함수는 synchronized로 작동한다.
   스프링과 같이 멀티 스레드를 지원하는 환경이고 다량의 스레드가 로그를 표시하길 원한다면,
   동기적인 작동 때문에 성능에 문제가 생길 가능성이 있다.

 

🔵  slf4j

Simple Logging Facade for Java의 줄임말이다.

로그를 처리해 주는 프레임워크이다.

 

스프링을 이용해 개발하다 보면 많이 봤을 거라 생각한다.

롬복 어노테이션 중 @Slf4j 가 바로 이것을 말하는 것이다.

하지만 이것은 구현체가 아니다.

인터페이스이다.

 

그렇다면 이것의 구현체가 무엇일까?

log4 j, logback, log4j2 가 위의 구현체이다.

 

log4j -> logback -> log4j2 순서로 발표되었다.

하나하나 알아보자.

 

log4j

• 에러 레벨 기능 지원
• 로그 출력 파일 지원 및 다양한 로그 출력 형식 지원

logback

• log4j 후속 버전
• Spring의 spring-boot-starter-logging에서 지원해 주는 디폴트 구현체
• 필터 정책 사용 가능
• XML, groovy 설정 지원

log4j2

• logback 후속 버전
• 멀티스레드 환경에서 async logger 성능이 logback보다 좋음
• lambda, lazy evaluation 지원
• 임시 개체가 가능한 많이 할당되지 않는 가비지 없는 모드에서 실행 가능

위를 봤을 때, log4j2가 가장 좋아 보인다.

하지만 이는 보안 관련 이슈 있었다.

현재는 해결되었다고 한다.

필자는 이를 사용하지 않고 spring 기본인 logback을 사용했다.

 

📌 Logback

🔵 Logback

이는 로깅 시스템이다.

 

logback은 아래와 같은 구성 요소를 가진다.

• appender
  : logging 이벤트 처리 역할을 담당. Appender 인터페이스를 구현해 이벤트를 처리
• logger
  : 이벤트의 대상, 어떤 내용을 log로 남길 것인지 정의하며 log level을 선택적으로 설정할 수 있음
• root
  : 최상단의 logger를 root라 칭함

위 구성요소 중, 우리가 원하는 것을 구현하기 위해선 appender를 커스텀해야 한다.

 

📌 Appender, Slack 연동

🔵 Appender 커스텀

class SlackAppender : AppenderBase<ILoggingEvent>() {
    private var token: String = ""

    fun setToken(token: String) {
        this.token = token
    }

    override fun append(event: ILoggingEvent) {
        val message = SlackMessageModel(
            text = """
                        $event
            """.trimIndent()
        )

        WarningLogService.sendLog(message, token)
    }
}

커스텀 appender를 만들기 위해선 AppenderBase의 구현체를 만들면 된다.

그리고 이를 logback.xml에 등록하면 사용할 수 있다.

 

이때, logback은 스프링이 시작되기 이전에 초기화된다.

즉, 빈, IoC 등 스프링의 장점을 이용하지 못한다.

그러므로 다른 클래스의 함수를 이용하고 싶다면, 해당 클래스의 정적 함수로 선언해야 한다.

 

슬랙 전송 주소는 외부로 노출하면 안 되므로, xml 파일에서 받을 수 있게 했다.

 

🔵 Slack 전송 서비스

class WarningLogService {
    companion object {
        private const val SLACK_WEBHOOKS_DOMAIN = "https://hooks.slack.com/services"
        private val webClient = WebClientFactory.generate(baseUrl = SLACK_WEBHOOKS_DOMAIN)

        fun sendLog(message: SlackMessageModel, token: String) {
            CoroutineScope(Dispatchers.IO).launch {
                webClient.post()
                    .uri("/$token")
                    .contentType(MediaType.APPLICATION_JSON)
                    .bodyValue(message)
                    .retrieve()
                    .awaitBody()
            }
        }
    }
}

위에서 설명한 이유로 정적 함수로 슬랙 메시지 전송 함수를 만들었다.

webclient를 생성하여 메시지를 보내주는 역할을 해준다.

 

로깅은 동기적으로 작동한다.

이때, 한 로깅 프로세스가 slack과의 통신을 이유로 block 하면,

다음 메시지는 앞선 메시지의 통신이 끝나는 시점까지 기다려야 한다.

그래서 비동기 처리를 꼭 해줘야 한다.

AsyncAppender를 사용하는 방법도 있으나, 현 프로젝트에서는 코루틴을 사용하므로 AsyncAppender를 사용하지 않았다.

 

🔵 Slack 전송 서비스

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true">
    <include resource="org/springframework/boot/logging/logback/base.xml"/>

    <springProperty scope="context" name="logLevel" source="logging.level.root" defaultValue="INFO"/>
    <springProperty scope="context" name="warningLogToken" source="slack.warning-log-token" defaultValue=""/>

	...

    <appender name="SLACK_WARNING_LOG" class="com.oksusu.susu.client.appender.SlackAppender">
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>WARN</level>
        </filter>
        <token>${warningLogToken}</token>
    </appender>

    <springProfile name="default, dev">
        <root level="${logLevel}">
        </root>
    </springProfile>

    <springProfile name="prod">
        <root level="${logLevel}">
            <appender-ref ref="SLACK_WARNING_LOG"/>
            <!--            <appender-ref ref="SENTRY"/>-->
        </root>
    </springProfile>
</configuration>

logback의 설정 파일이다. 

여기에 위에서 만든 appender를 등록하고 사용하면 된다.

 

위에서 설명한 것처럼, slack 주소를 가져와서 appender에 주입해줘야 한다.

그러므로 <springProperty...>를 이용하여 주소를 가져와서 appender에 주입해 줬다.

 

이 프로젝트에서는 prod 환경에서만 작동하도록 할 예정이므로, 프로파일이 prod일 경우 실행되는 부분에 적어뒀다.

 

🔵 결과

이 글을 쓰는 지금까지 정상적으로 작동하고 있다.