<Infra> Slack 이용하여 Error 알림 구현하기

📌이걸 왜?

서버를 배포하게 되면 로그를 켜보지 않는 이상 에러 발생 여부에 관해 알기 힘들다

로그를 보는 것보다 더 편하게 알 수 있는 방법이 있을까?

에러를 슬랙이나 디스코드 알림처럼 볼 수 있으면 어떨까?

에러가 발생하면 슬랙 알람이 오도록 구현해 보도록 하자

 

📌 알림 구현하기

🔵 어떤 방식으로 구현했나?

Global Exception Handler에서 500번대 에러를 처리하는 곳에 slack 메시지를 보내는 로직을 추가했다.

이를 통해 500번대 error가 발생하면, 에러 내용과 request 정보에 관해 slack 메시지로 보내지도록 했다.

또한 dev와 prod를 구분했다. 

사실 실 서버에서만 작동하도록 구현해도 된다.

하지만 개발 상황에서도 500번 에러를 발견하기 어렵다고 생각해서, 두 상황을 구분 지어 알람을 보낼 수 있도록 했다.

 

🔵  GlobalExceptionHandler

@Slf4j
@ControllerAdvice
public class GlobalExceptionHandler {

    // ... 생략
    
    // 위에서 따로 처리하지 않은 에러를 모두 처리해줍니다.
    @ExceptionHandler(Exception.class)
    protected ResponseEntity<ErrorResponse> handleException(Exception exception, HttpServletRequest httpServletRequest) {
        log.error("handleException", exception);
        final ContentCachingRequestWrapper contentCachingRequestWrapper
                = new ContentCachingRequestWrapper(httpServletRequest);
        Event.raise(SlackErrorMessage.of(exception, contentCachingRequestWrapper));
        return new ResponseEntity<>(ErrorResponse.onFailure(ErrorCode._INTERNAL_SERVER_ERROR),
                null, INTERNAL_SERVER_ERROR);
    }
}

기존 로직은 Exception class를 통해 에러가 처리될 경우 500번 에러가 발생하도록 구현했다.

이 부분에 Slack 알림을 보낼 수 있는 event를 발생할 수 있도록 했다.

HttpServletRequest 값을 읽을 때, 같은 값을 여러 번 조회할 수 없다.

그래서 HttpServletRequest를 캐싱해줄 수 있는 ContentCachingRequestWrapper를 이용했다.

 

🔵 SlackSendMessageHandler

@Component
@RequiredArgsConstructor
@Slf4j
public class SlackSendMessageHandler {
    private final SlackMessageGenerater slackMessageGenerater;
    private final SlackHelper slackHelper;

    @Async
    @EventListener(SlackErrorMessage.class)
    public void Handle(SlackErrorMessage slackErrorMessage) throws IOException {

        final Exception exception = slackErrorMessage.getException();
        final ContentCachingRequestWrapper contentCachingRequestWrapper
                = slackErrorMessage.getContentCachingRequestWrapper();

        final Payload payload = slackMessageGenerater.generate(exception, contentCachingRequestWrapper);

        slackHelper.sendNotification(payload);
    }
}

event가 발생할 경우 위 클래스의 handle 함수가 작동된다.

slackMessageGenerater를 통해 메시지를 만든 후, slackHelper를 통해 메시지를 전송한다.

 

🔵 SlackMessageGenerator

@Component
@AllArgsConstructor
@Slf4j
public class SlackMessageGenerater {
    private final int MaxLen = 500;

    private final ObjectMapper objectMapper;


    public List<LayoutBlock> generate(Exception e, ContentCachingRequestWrapper cachedRequest) throws IOException {
        List<LayoutBlock> layoutBlocks = new ArrayList<>();
        // 제목
        layoutBlocks.add(HeaderBlock.builder().text(plainText("에러 알림")).build());
        // 구분선
        layoutBlocks.add(new DividerBlock());
        // IP + Method, Addr
        layoutBlocks.add(makeSection(getIP(cachedRequest), getAddr(cachedRequest)));
        // RequestBody + RequestParam
        layoutBlocks.add(makeSection(getBody(cachedRequest), getParam(cachedRequest)));
        // 구분선
        layoutBlocks.add(new DividerBlock());
        // IP + Method, Addr
        layoutBlocks.add(makeSection(getErrMessage(e), getErrStack(e)));
        return layoutBlocks;
    }

    private LayoutBlock makeSection(TextObject first, TextObject second ) {
        return Blocks.section(section -> section.fields(List.of(first, second)));
    }

    private MarkdownTextObject getIP(ContentCachingRequestWrapper c) {
        final String errorIP = c.getRemoteAddr();
        return MarkdownTextObject.builder().text("* User IP :*\n" + errorIP).build();
    }

    private MarkdownTextObject getAddr(ContentCachingRequestWrapper c) {
        final String method = c.getMethod();
        final String url = c.getRequestURL().toString();
        return MarkdownTextObject.builder()
                .text("* Request Addr :*\n" + method + " : " + url)
                .build();
    }

    private MarkdownTextObject getBody(ContentCachingRequestWrapper c) throws IOException {
        final String body = objectMapper.readTree(c.getContentAsByteArray()).toString();
        return MarkdownTextObject.builder().text("* Request Body :*\n" + body).build();
    }

    private MarkdownTextObject getParam(ContentCachingRequestWrapper c) {
        final String queryString = c.getQueryString();
        return MarkdownTextObject.builder().text("* Request Param :*\n" + queryString).build();
    }

    private MarkdownTextObject getErrMessage(Exception e) {
        final String errorMessage = e.getMessage();
        return MarkdownTextObject.builder().text("* Message :*\n" + errorMessage).build();
    }

    private MarkdownTextObject getErrStack(Throwable throwable) {
        String exceptionAsString = Arrays.toString(throwable.getStackTrace());
        int cutLength = Math.min(exceptionAsString.length(), MaxLen);
        String errorStack = exceptionAsString.substring(0, cutLength);
        return MarkdownTextObject.builder().text("* Stack Trace :*\n" + errorStack).build();
    }
}

이것을 통해 메세지를 만들게 된다.

감사하게도 Slack API 패키지에 이미 Object가 다 구현되어 있어서, 

우린 채워 넣기만 하면 된다!

위 코드대로 하면 이런 알림을 만들 수 있다.

 

🔵 SlackHelper

@Component
@RequiredArgsConstructor
public class SlackHelper {
    private final SpringEnvironmentHelper springEnvironmentHelper;

    @Value("${slack.webhook.dev_url}")
    String devUrl;

    @Value("${slack.webhook.prod_url}")
    String prodUrl;

    public void sendNotification(Payload payload) {
        final Slack slack = Slack.getInstance();

        try {
            if (springEnvironmentHelper.isProdProfile()) {
                slack.send(prodUrl, payload);
            }
            else {
                slack.send(devUrl, payload);
            }
        } catch (IOException e) {
        throw new RuntimeException(e);
        }
    }
}

여기서 슬랙 메세지를 보내게 된다.

앞에서 말한 것과 같이 우린 dev와 prod를 구분해야 한다.

커스텀 유틸 클래스인 springEnvironmentHelper이 이를 구분해 준다. 

아래는 SpringEnvironmentHelper 코드이다.

@Component
@RequiredArgsConstructor
public class SpringEnvironmentHelper {
    private final Environment environment;

    private final String PROD = "prod";
    private final String DEV = "dev";

    public Boolean isProdProfile() {
        String[] activeProfiles = environment.getActiveProfiles();
        List<String> currentProfile = Arrays.stream(activeProfiles).collect(Collectors.toList());
        return currentProfile.contains(PROD);
    }

    public Boolean isDevProfile() {
        String[] activeProfiles = environment.getActiveProfiles();
        List<String> currentProfile = Arrays.stream(activeProfiles).collect(Collectors.toList());
        return currentProfile.contains(DEV);
    }
}

현재 환경에 따라 url을 구분하여 메시지를 전송하도록 구현했다.

slack.send에 url과 message를 넣고 호출하면, 알람이 전송된다!