Summary

• 상황

  • dev-be의 코드를 nCloud에 임시 배포를 한 상태에서, Frontend에서 서버에 보낸 요청으로 unknown 에러를 마주쳤을 때 Backend 담당자에게 말하면 확인하는 방식이었다.

• 불편함 감지

  • Backend에서 Error handling 처리한 문제는 Frontend에서 message를 통해 바로 알 수 있었으나
  • 그 외 bug나 DB 문제의 경우 Backend engineer가 직접 ncloud에 접속하여 로그 확인을 해야했다.

• 개선 방향

  • Error 발생 시, Log를 Slack 에 자동으로 전송해주면 ncloud에 일일히 접속안해도 되겠다! 에서 시작

  • nest interceptor를 통해 error 전달 시 sentry로 error report 및 slack message send

    

• 더 생각해볼 것

  • 요청한 사용자의 IP도 볼 수 있으면 누가 범인인지 찾을 수 있을 것 같다.
  • status code 별로 분류해서 error를 전송하는 것도 좋을 것 같다.

1. 기술 조사 전에 어떻게 만들지 상상해보자

• 이전에 github action을 통해 slack bot을 만들어서 알림을 보낼 수 있듯이, slack에 message를 보낼 수 있는 npm 라이브러리가 있을 것 같다.

• 현재 API Server에서 controller layer에서 try ~ catch로 error handling을 하고 있으니, logger로 error print를 하면서 그 때 slack bot도 message를 보내면 될 것 같다.

  @Get('followers')
    async getFollowers() {
      try {
        const _id = '~~~~';
        const result = await this.userService.getRelatedUsers(_id, 'followers');
        return responseForm(200, { followers: result });
      } catch (error) {
        this.logger.error(JSON.stringify(error.response));
  			// 여기에서 보내면 되지 않을까?
        return error.response ?? error;
      }
    }
  

2. 조사 과정

일단 nest Error slack bot, notification 의 키워드로 검색을 해본다.

• express용도 나오는데 난 가급적 nest와 결합된 것을 더 검색해서 사용할 것이다.
• nest slack module이 검색된다.
• sentry와 raven을 통한 인터셉터로 slack에 알리는 포스팅이 나온다. 역시 다른 사람들도 다 해봤다.

sentry가 뭔지 모르겠으니 알아본다.

• 어플리케이션에서 오류가 발생하면 알려주는 에러 트래킹 서비스이다.
• 클라이언트의 오류 발생 시 정보 파악을 가능하게 해주는 이점으로 많이 사용하는 것 같다.
• 무료로 5k개까지 에러 확인 가능하다.

Interceptor도 알아보자