[Spring] Slack API 활용하여 에러 모니터링하기

서비스를 배포한 후, 프로젝트를 유지 관리하기 위해서 에러 대응은 필수적입니다. 에러를 모니터링하기 위한 수단은 다양하지만, 이번 글에서는 Spring Boot 에서 슬랙을 활용하여 에러를 확인할 수 있는 방법을 소개하고자 합니다.

 

해당 글에서 소개한 방법을 따라오시면 다음과 같이 슬랙으로 에러를 확인하실 수 있습니다! 😎

 

 

 

🎯 1. Slack 연동을 위한 토큰 발급

 

1. 먼저 Slack 봇을 생성하기 위해 https://api.slack.com/apps/ 에 접속합니다.

2. Create New App 클릭 -> From scratch 클릭

 

3. App Name 을 자유롭게 설정하고 슬랙 알림을 받을 워크스페이스를 설정합니다.

 

4. Permissions 클릭

 

5. Bot Token Scopes 에서 Add an Oauth Scope 를 클릭해 다음과 같이 3가지 권한을 부여합니다.

 

6. OAuth Tokens for Your Workspace 에서 Install to Workspace 를 선택하여 워크스페이스에 등록이 완료되면 다음과 같이 토큰이 발급됩니다. 해당 토큰은 Spring 애플리케이션 yml 설정 파일에 사용되기 때문에 복사해둡니다.

 

 

🎯 2. build.gradle 에 Slack API 의존성 추가

 

dependencies {
    // slack
    implementation "com.slack.api:slack-api-client:1.25.1"
}

 

Slack API 를 활용하기 위해 위와 같이 의존성을 추가해줍니다.

 

 

🎯 3. application.yml 에 토큰, 채널명 등록

 

slack:
  token: {발급 받은 토큰값}
  channel:
    monitor: '#server-error-dev'

 

다음과 같이 token 에는 발급 받은 토큰값을 입력해주고

slack.channel.monitor 에는 ‘#{설정한 워크스페이스에서 에러 알림을 받을 채널명}’ 을 입력해줍니다.

 

 

🎯 4. SlackService, SlackServiceUtils 구현

 

SlackService

@Slf4j
@Service
public class SlackService {

	@Value(value = "${spring.profiles.active}")
	String profile;
	@Value(value = "${slack.token}")
	String token;
	@Value(value = "${slack.channel.monitor}")
	String channelProductError;

	private static final String LOCAL = "local";
	private static final String PROD_ERROR_MESSAGE_TITLE = "🤯 *500 에러 발생*";
	private static final String ATTACHMENTS_ERROR_COLOR = "#eb4034";

	public void sendSlackMessageProductError(Exception exception) {
		if (!profile.equals(LOCAL)) {
			try {
				List<LayoutBlock> layoutBlocks = SlackServiceUtils.createProdErrorMessage(exception);
				List<Attachment> attachments = SlackServiceUtils.createAttachments(ATTACHMENTS_ERROR_COLOR,
					layoutBlocks);
				Slack.getInstance().methods(token).chatPostMessage(request ->
					request.channel(channelProductError)
						.attachments(attachments)
						.text(PROD_ERROR_MESSAGE_TITLE));
			} catch (SlackApiException | IOException e) {
				log.error(e.getMessage(), e);
			}
		}
	}
}

 

SlackServiceUtils

public class SlackServiceUtils {

	private static final String ERROR_MESSAGE = "*Error Message:*\n";
	private static final String ERROR_STACK = "*Error Stack:*\n";
	private static final String FILTER_STRING = "blossom";

	public static List<Attachment> createAttachments(String color, List<LayoutBlock> data) {
		List<Attachment> attachments = new ArrayList<>();
		Attachment attachment = new Attachment();
		attachment.setColor(color);
		attachment.setBlocks(data);
		attachments.add(attachment);
		return attachments;
	}

	public static List<LayoutBlock> createProdErrorMessage(Exception exception) {
		StackTraceElement[] stacks = exception.getStackTrace();

		List<LayoutBlock> layoutBlockList = new ArrayList<>();

		List<TextObject> sectionInFields = new ArrayList<>();
		sectionInFields.add(markdownText(ERROR_MESSAGE + exception.getMessage()));
		sectionInFields.add(markdownText(ERROR_STACK + exception));
		layoutBlockList.add(section(section -> section.fields(sectionInFields)));

		layoutBlockList.add(divider());
		layoutBlockList.add(section(section -> section.text(markdownText(filterErrorStack(stacks)))));
		return layoutBlockList;
	}

	private static String filterErrorStack(StackTraceElement[] stacks) {
		StringBuilder stringBuilder = new StringBuilder();
		stringBuilder.append("```");
		for (StackTraceElement stack : stacks) {
			if (stack.toString().contains(FILTER_STRING)) {
				stringBuilder.append(stack).append("\n");
			}
		}
		stringBuilder.append("```");
		return stringBuilder.toString();
	}
}

 

이제 위와 같이 슬랙 알림을 전송하기 위한 서비스 로직을 구현해줍니다.

 

SlackService 에서는 Slack 에 알림 전송을 요청하는 Request 를 생성해서 보내는 역할을 담당하고,

SlackServiceUtils 에서는 Slack 에 표시될 알림의 형태를 만드는 역할을 담당합니다.

알림을 다른 형태로 커스텀하기 위해서는 하단의 공식문서를 참고해서 진행해보시면 됩니다.

 

또한 상단 코드의 경우 배포 환경인 dev, prod 환경에서만 슬랙 알림이 동작하도록 구현되어있습니다.

local 환경에서는 Slack 알림이 요청되지 않기 때문에 테스트 하실 때 해당 부분을 주석 처리하고 진행해주세요.

 

Reference: Secondary message attachments

 

 

🎯 5. ControllerAdvice 에서 SlackService 호출

 

ControllerAdvice

@Slf4j
@RequiredArgsConstructor
@RestControllerAdvice
public class ControllerAdvice {

	private final SlackService slackService;

	/**
	 * 500 Internal Server Error
	 */
	@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
	@ExceptionHandler(Exception.class)
	protected ApiResponse<Object> handleException(final Exception exception) {
		log.error(exception.getMessage(), exception);
		slackService.sendSlackMessageProductError(exception);
		return ApiResponse.error(INTERNAL_SERVER_EXCEPTION);
	}
}

 

이제 서버가 예상하지 못한 에러에 대해 Slack 알림을 전송하기 위해 위와 같이 500번대 에러가 발생하면 SlackService 를 호출합니다.

 

 

실제 서비스 로직에서 테스트하기 위해 Runtime Exception 을 발생시켜보면 위와 같이 에러 알림을 확인할 수 있습니다.