Skip to content

Commit

Permalink
feat: 에러 발생 시 slack Alarm보내는 기능 추가
Browse files Browse the repository at this point in the history
  • Loading branch information
minsu20 committed Nov 20, 2023
1 parent 8cb6d1a commit 4f74feb
Show file tree
Hide file tree
Showing 3 changed files with 74 additions and 1 deletion.
2 changes: 2 additions & 0 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,8 @@ dependencies {
implementation platform('software.amazon.awssdk:bom:2.17.230')
implementation 'software.amazon.awssdk:s3'

//slack
implementation 'com.slack.api:slack-api-client:1.30.0'

}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

import com.moing.backend.global.response.ErrorCode;
import com.moing.backend.global.response.ErrorResponse;
import com.moing.backend.global.util.SlackService;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
Expand All @@ -12,15 +14,18 @@
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.context.support.DefaultMessageSourceResolvable;

import javax.servlet.http.HttpServletRequest;
import java.util.function.Consumer;
import java.util.regex.PatternSyntaxException;
import java.util.stream.Collectors;

@RestControllerAdvice
@Slf4j
@RequiredArgsConstructor
public class GlobalExceptionHandler {

private static final String LOG_FORMAT = "Class : {}, Code : {}, Message : {}";
private final SlackService slackService;

@ExceptionHandler(ApplicationException.class)
public ResponseEntity<ErrorResponse> handleApplicationException(ApplicationException ex) {
Expand Down Expand Up @@ -51,7 +56,8 @@ public ResponseEntity<ErrorResponse> httpRequestNotSupportedExceptionHandler(Htt
}

@ExceptionHandler(Exception.class)
public ResponseEntity<ErrorResponse> internalServerErrorHandler(Exception ex) {
public ResponseEntity<ErrorResponse> internalServerErrorHandler(Exception ex, HttpServletRequest request) {
slackService.sendSlackAlertErrorLog(ex, request);
return handleException(ex, ErrorCode.INTERNAL_SERVER_ERROR, ErrorCode.INTERNAL_SERVER_ERROR.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR, log::error);
}

Expand Down
65 changes: 65 additions & 0 deletions src/main/java/com/moing/backend/global/util/SlackService.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
package com.moing.backend.global.util;

import com.slack.api.Slack;
import com.slack.api.model.Attachment;
import com.slack.api.model.Field;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Service;

import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
import java.util.List;

import static com.slack.api.webhook.WebhookPayloads.payload;

@Service
@Slf4j
public class SlackService {

@Value("${webhook.slack.error_url}")
private String errorWebhookUrl;

private final Slack slackClient = Slack.getInstance();

// 슬랙 에러 알림 보내는 메서드
public void sendSlackAlertErrorLog(Exception e, HttpServletRequest request) {
try {
slackClient.send(errorWebhookUrl, payload(p -> p
.text("[500 에러가 발생했습니다.]")
.attachments(
List.of(generateSlackAttachment(e, request))
)
));
} catch (IOException slackError) {
log.debug("Slack 통신과의 예외 발생");
}
}

// attachment 생성 메서드
private Attachment generateSlackAttachment(Exception e, HttpServletRequest request) {
String requestTime = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss.SSS").format(LocalDateTime.now());
String xffHeader = request.getHeader("X-FORWARDED-FOR");
return Attachment.builder()
.color("ff0000")
.title(requestTime + " 발생 에러 로그")
.fields(List.of(
generateSlackField("Request IP", xffHeader == null ? request.getRemoteAddr() : xffHeader),
generateSlackField("Request URL", request.getRequestURL() + " " + request.getMethod()),
generateSlackField("Error Message", e.getMessage())
)
)
.build();
}

private Field generateSlackField(String title, String value) {
return Field.builder()
.title(title)
.value(value)
.valueShortEnough(false)
.build();
}

}

0 comments on commit 4f74feb

Please sign in to comment.