5.8 로그와 로그 메시지

로깅 (Logging)

로깅은 프로그램을 실행하는 동안 발생하는 이벤트를 이해하는 데 중요하다. 예를 들어 모델을 밤새 실행했는데 다음 날 아침 결과가 예상과 다를 경우 로그 메시지를 통해 발생한 결과에 대한 컨텍스트를 더 잘 이해할 수 있다. 

 

---

로그 메시지

로깅은 소프트웨어를 실행하는 동안 발생한 이벤트를 설명하기 위해 메시지를 기록하는 프로세스이다. 몇 가지 예를 보고 좋은 로그 메시지 작성을 위한 팁을 소개한다.

 

• 팁: 전문적이고 명확해야 한다.

Bad: Hmmm... this isn't working???
Bad: idk.... :(
Good: Couldn't parse file.

 

팁: 간결하고 일반적인 대문자를 사용한다.

Bad: Start Product Recommendation Process
Bad: We have completed the steps necessary and will now proceed with the recommendation process for the records in our product database.
Good: Generating product recommendations.

 

팁: 적절한 로깅 수준을 선택한다.

디버그: 프로그램에서 발생하는 모든 작업에 이 수준을 사용한다.

오류: 이 수준을 사용하여 발생한 오류를 기록한다.

정보: 이 수준을 사용하여 정기 예약 작업과 같이 사용자 중심 또는 시스템별 작업을 모두 기록한다.

 

팁: 유용한 정보를 제공한다.

Bad: Failed to read location data
Good: Failed to read location data: store_id 8324971