고수들이 절대 가르쳐 주지 않는 C/C++ 프로그래밍 팁 #5 - 로깅 라이브러리 요구 사항

고절가주팁 다섯번째 글입니다. 저번 글에서는 로깅 라이브러리를 구현하기 위한 기본적인 지식을 소개해 드렸습니다. 지난 글에서 소개한 팁을 다시 소개하자면,

1. 매크로 함수 정의에서 인자 x 에 대해 #x 라고 쓰면 x 가 문자열 리터럴로 바뀝니다.
2. __FUNCTION__ 또는 __func__ 는 현재 함수명을 출력하는 데 사용할 수 있습니다. 단, __FUNCTION__, __func__ 모두 portability 측면에서 약간 문제가 있으므로 주의해서 사용해야 합니다.
3. __FILE__ 은 현재 파일명을 출력하는 데 사용할 수 있습니다.
4. __LINE__ 은 현재 라인번호를 출력하는 데 사용할 수 있습니다.
5. 조건부 컴파일을 이용해서 디비깅용 빌드와 Production 빌드를 구분하는 방법을 사용할 수 있어야 합니다.
6. 컴파일러 옵션 중 preprocessing 만 하는 옵션을 알아두면 매크로 함수를 디비겅하는데 유용하게 사용될 수 있습니다(GCC 에서는 -E).

이 지식은 일단 가슴 속에 담아 두고, 이번 글에서는 로깅 라이브러리 요구사항을 한 번 정리해 보도록 하겠습니다.

여러분이 일상적인 프로그래밍을 하면서 디버깅 정보 또는 프로그램 실행 정보를 출력할 때 가장 필요로 하는 것이 어떤 것인가요 ? 제가 생각하기에 로깅의 가장 기본적인 목적은 첫번째로 개발자 입장에서 생각한다면 문제점을 빨리 파악해서 디버깅을 쉽게하기 위한 것이라고 생각합니다. 디버깅을 쉽게 하려면 가장 먼저 필요한 것이 어떤 모듈, 어떤 소스 파일의 어느 함수, 어느 위치에서 문제점을 발생했는지를 알아야할 필요가 있겠지요.

두번째로 로깅 정보가 화면으로도 출력되고, 파일로도 저장되고, 어떤 때는 원격 로깅 목적지로도 전송되는 등 여러 목적지로 보낼 수 있으면 좋을 것 같습니다. 화면으로만 출력된다면 개발 단계에서는 도움이 되겠지만, 릴리즈 단계에서는 화면에 너무 많은 정보가 출력되는게 좋지 않을 것이기 때문입니다. 그리고, 원격지에서 중앙 집중식으로 여러 서버의 로깅 정보를 수집하고자 하는 경우도 있으므로 로깅 정보를 원격 목적지로 보낼 수 있다면 좋을 것입니다.

세번째로 모듈별로 로깅을 활성화시키거나 비활성화시키거나 할 수 있으면 좋을 것입니다. 이렇게 하면 문제점을 파악해 갈 때 점점 범위를 좁혀 가면서 작업할 수 있기 때문입니다.

네번째로 로깅을 얼마나 상세하게 할 것인지 조정할 수 있는 기능이 있으면 좋을 것입니다. 이렇게 하면 평소에는 대략적인 정보만 로깅하다가 어떤 문제점이 발생했을 때, 로깅을 상세하게 함으로써 문제점을 빨리 파악하는 데 도움이 될 것이기 때문입니다.

다섯번째로 개발단계에서만 출력할 필요가 있는 아주 상세한 디버깅 정보들은 Production 단계에서는 자동으로 코드에서 없어지면 좋을 것입니다. 이렇게 하면 프로그램 수행 성능과 코드 크기 측면에서 모두 이득이 될 것이기 때문입니다.

여섯번째로 모듈별 로깅의 활성화나 로깅 수준은 프로그램 실행 중에도 변경할 수 있으면 좋을 것입니다. 이렇게 하면 프로그램을 종료시키지 않은 채로 문제점을 찾을 수 있을 것입니다.

제가 생각하는 로깅 라이브러리의 요구 사항은 이 정도입니다. 로깅 라이브러리 요구 사항이 이 정도로 많은 줄 모르셨다구요 ? 그러게 말입니다. 저도 프로그래밍 초짜 시절에는 그냥 printf() 로 찍으면 되지 뭐~ 그렇게 생각했습니다. 근데 이런 저런 프로젝트를 하다 보니 이런 요구사항을 만족하는 로깅 라이브러리가 있으면 좋겠다는 생각이 많이 들더군요. 이 외에도 생각나는 요구사항이 있으시면 한 번 댓글이나 트랙백 날려 주시면 감사하겠습니다.

그럼 위와 같은 요구사항을 만족하는 로깅 라이브러리의 인터페이스는 어떻게 작성하면 좋을까요 ? 이번 글은 요구사항을 정리해보는 것으로 마무리하고, 다음 글에서 본격적으로 로깅 라이브러리의 인터페이스를 설계해 보도록 하겠습니다. 여러분도 한 번 위와 같은 요구사항을 만족하는 로깅 라이브러리의 인터페이스를 나름대로 설계해 보시면 좋을 것 같습니다.

고절가주팁이 쭉~ 갈 수 있도록 많은 관심 부탁드리고, 혹시 잘못된 부분이나 보완할 부분이 있으면 언제라도 알려주세요.

제 글이 유익하셨다면 오른쪽 버튼을 눌러 제 블로그를 구독하세요. ->
블로그를 구독하는 방법을 잘 모르시는 분은 2. RSS 활용을 클릭하세요.
RSS에 대해 잘 모르시는 분은 1. RSS란 무엇인가를 클릭하세요.