로그 파일에 포함되어야 하는 항목

이 글에서는 로그파일에 포함되어야 하는 항목에 대해서 알아보도록 하겠습니다.

로그파일의 항목을 설정하는 것이 중요한 이유는 로그파일은 유지보수에 아주 중요한 부분을 담당하고 있습니다.

로그파일의 내용 얼마나 이해하기 쉽고 정확한 데이터가 있느냐에 따라 소프트웨어 생명주기에서 가장 많은 비용이 소모되는 유지보수 비용을 줄일 수 있기 때문입니다.

 

1. 서버 이름 및 프로세스 ID

- 서버 이름 및 프로세스 ID를 출력하는 이유는 분산환경에서 발생한 이슈의 정확한 서버를 확인하기 위해서입니다. 

2. Timestamp

- 시간값은 해당 에러, 작업 내용이 발생한 시간을 추적하기 위해서 필요합니다. 

3. 클래스명 및 함수, 라인번호

- 클래스명, 함수, 라인번호를 통해 발생한 작업을 소스코드에서 추적할 수 있습니다. (DB의 경우 서버, Table, 파라미터등)

4. 상세 메시지

- 성공, 실패등의 작업내용에 대한 상세메시지를 통해 시스템엔지니어가 개발자에게 이슈가 전달되기 전에 해결할 수 있게 해줍니다. 

5. Log Level

- Log4j등의 라이브러리에서 지원하는 것 처럼 로그레벨을 설정하여 시스템에서 특정장애에 대한 Debug를 할 수 있게 합니다.