프로젝트에서 어떤 요청들이 오고 가는지를 확인하고, 에러가 났을때 확인하기 위해서 로그를 남기기로 했다. 명확하게 어떤 상황에 로그를 남기면 좋을지는 잘 모르겠어서, 우선은 컨트롤러로 오는 요청이 들어올 때, 그 요청이 끝날때, 그리고 에러가 발생했을시 총 3개로 나누어서 로그를 찍기로 했다.

요청에 대한것은 인터셉터를 활용하여 로그를 찍도록하였다. NestJS에서 인터셉터는 request와 response를 수행할시에 중간에서 값을 가져와서 추가적인 로직을 수행할 수 있도록 도와준다.

logging-interceptor.ts

import { CallHandler, ExecutionContext, Injectable, Logger, NestInterceptor } from '@nestjs/common';
import { catchError, from, Observable, tap } from 'rxjs';
import { EMessage } from '../response/ecustom-code.jenum';
import axios from 'axios';

@Injectable()
export class LoggingInterceptor implements NestInterceptor {
  private readonly logger = new Logger(LoggingInterceptor.name);

  intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
    const req = context.switchToHttp().getRequest();
    const { method, url, body, query } = req;
    const errorWebHook: string = process.env.ERR_WEB_HOOK;
    this.logger.log(`[IN] ${method} ${url} ${JSON.stringify(body)} ${JSON.stringify(query)}`);

    return next.handle().pipe(
      tap(), // 응답이 정상적으로 끝나면 tap 안에서 수행되지만, exception 을 날리므로 error 로 처리해야함.
      catchError((exception) => from(this.handleException(exception, method, url, errorWebHook))),
    );
  }

  async handleException(exception, method, url, errorWebHook) {
    if (exception.message !== EMessage.SUCCESS) {
      this.logger.error(`[OUT] ${method} ${url}: ${exception.message}`);
      await axios.post(errorWebHook, {
        embeds: [
          {
            title: `[${method}] ${url}`,
            description: exception.message,
            color: 16711680,
          },
        ],
      });
    } else {
      this.logger.log(`[OUT] ${method} ${url}: ${exception.message}`);
    }
    throw exception;
  }
}

• LoggingInterceptor
  • NestJS의 인터셉터를 구현한다.
• intercept
  • NestJS의 인터셉터가 반드시 구현해야하는 메서드이다.
  • context는 현재 실행되는 요청의 컨텍스트를 가진다.
  • next는 요청을 처리하는 다음 핸들러를 참조한다.
• next.handle()
  • 다음 핸들러를 호출하여 요청을 처리한다. 이 메서드는 Obeservable을 반환함.
• tap
  • Obeservable 항목을 내보낼때마다 부수효과를 가지는 함수를 실행한다.
  • 정상적으로 response를 내뱉는다면 이쪽에서 로직을 수행해야 하지만 우리 프로젝트를 정상적일 때도 exception을 날려주기에 이 부분에서 처리할 수 없다.
• catchError
  • 위와 같은 이유로 catchError를 해서 수행할 로직을 작성한다.
  • 단 나는 에러가 발생했을 때, discord로 axios 요청을 날리기에 async await처리가 필요했다.
  • 이때 Promise를 반환하기 때문에 이를 다시 Obeservalbe하게 변환 시켜야 한다. 이 때 RxJS의 from 연산자를 사용하여 변환시킬 수 있다.

aap.module.ts

providers: [
    AppService,
    {
      provide: APP_INTERCEPTOR,
      useClass: LoggingInterceptor,
    },
  ],

• 위에서 만든 인터셉터를 글로벌하게 적용하기 위해서 app module에 추가해주었다.

Discord Webhook