Skip to content

로그를 이용해 디버깅하는 법

로그를 이용해 디버깅하는 법 published on 로그를 이용해 디버깅하는 법에 댓글 없음

로깅은 로그라고 하는 정보성 기록을 만들어도록 시스템을 작성하는 실천법입니다. 임시 코드 출력(Printlining)은 간단하고, 대개 임시로 쓸 로그를 만들어내는 것입니다. 초보자는 프로그래밍 지식이 제한적이기 때문에 로그를 이해하고 사용해야 하고, 시스템 아키텍트는 시스템의 복잡성 때문에 로그를 이해하고 사용해야 합니다. 로그에서 제공하는 정보의 양은 설정 가능해야 합니다(이상적인 경우 프로그램이 실행 중인 동안에도). 일반적으로 로그는 세 가지 기본적인 이점을 제공합니다.

  • 로그는 재현하기 힘든 버그(배포 환경에서는 발생하지만 테스트 환경에서는 재현할 수 없는 것과 같은)에 관한 유용한 정보를 제공할 수 있습니다.
  • 로그는 성능과 관련된 통계와 데이터를 제공할 수 있습니다(예: 두 문장 사이에 소요된 시간).
  • 로그를 설정할 수 있는 경우, 예상치 못한 특정 문제를 디버깅하기 위해 해당 문제만를 해결하는 코드를 수정 및(또는) 재배포할 필요 없이 일반적인 정보를 확보할 수 있습니다.

로그에 출력하는 내용의 양은 정보와 간결성 사이에서 절충 가능합니다. 정보가 너무 많으면 로그를 처리하는 비용이 높아지고 스크롤의 압박이 생겨서 원하는 정보를 찾기가 힘들어집니다. 반면 정보가 너무 적으면 필요한 정보가 포함돼 있지 않을지도 모릅니다. 이러한 이유로 로그에 출력하는 내용을 설정 가능하게 만들면 아주 유용합니다. 대개 로그상의 각 레코드는 소스 코드 상의 위치, 실행된 스레드, 정확한 실행 시간, 그리고 공통적으로 특정 변수의 값, 여유 메모리의 양, 데이터 객체의 수 등과 같이 추가적인 유용한 정보를 파악하게 해줍니다. 이러한 로그문은 소스코드 도처에 흩어져 있으며, 특히 주요 기능 지점과 위험성 있는 코드 주변에 지정돼 있습니다. 각 로그문에는 레벨을 할당할 수 있고 시스템이 현재 해당 레벨로 설정돼 있는 경우에만 로그 레코드를 출력할 것입니다. 로그문은 예상되는 문제를 해결하도록 설계해야 합니다. 성능 측정의 필요성을 예상해 보십시오.

영구적인 로그가 있다면 로그 레코드 측면에서 임시 코드 출력(Printlining)을 해볼 수 있으며, 아마도 그러한 디버깅 문장의 일부는 영구적으로 로깅 시스템에 추가될 것입니다.

오류를 제거하는 법

오류를 제거하는 법 published on 오류를 제거하는 법에 댓글 없음

지금까지는 일부러 프로그램 실행을 검사하는 활동과 오류를 고치는 활동을 나눴습니다. 하지만 물론 디버깅은 버그를 제거하는 것을 의미하기도 합니다. 이상적인 경우라면 코드를 완벽하게 이해하고 오류와 그것을 고치는 방법이 훤히 드러나는 ‘아하!’라고 깨닫는 순간에 도달해야 할 것입니다. 하지만 프로그램은 여러분이 명확하게 알기 힘든, 불충분하게 문서화된 시스템을 사용하는 경우도 있을 것이므로 이러한 순간이 늘 오지는 않을 것입니다. 어떤 경우에는 코드가 너무 복잡해서 완벽하게 이해하지 못하는 경우도 있을 것입니다.

버그를 고칠 때는 가장 작은 부분만 변경해서 해당 버그를 고치고 싶을 것입니다. 개선이 필요한 다른 부분이 보일지도 모릅니다. 하지만 그것들을 동시에 고치지는 마십시오. 한 번에 딱 하나만 변경하는 과학적 방법론을 활용하려고 하십시오. 이를 위한 최선의 방법은 버그를 손쉽게 재현한 다음, 고친 코드를 올바른 자리에 놓고, 프로그램을 다시 실행해서 버그가 더는 존재하지 않는지 관찰하는 것입니다. 물론 때로는 한 줄 이상을 변경해야 하겠지만 그럼에도 개념적으로는 단 하나의 최소한의 변경사항을 적용해 버그를 고쳐야 합니다.

간혹 여러 개의 버그가 하나로 보일 때도 있습니다. 버그를 정의하고 그것을 한번에 고치는 것은 여러분에게 달려 있습니다. 때로는 프로그램이 어떻게 동작해야 하거나 원 제작자가 의도한 바가 명확하지 않은 경우도 있습니다. 이 경우 경험과 판단을 발휘해 해당 코드에 여러분만의 의미를 부여해야 합니다. 프로그램이 어떻게 동작해야 할지를 결정하고 그것을 주석으로 남기거나 다른 어떤 방법으로 분명히 밝힌 다음 코드가 여러분이 의미한 바를 따르게 하십시오. 이는 맨 처음에 원래의 함수를 작성하는 것보다 더 어려운 중급 또는 고급 기술이며, 현실 세계는 깔끔하게 맞아떨어지지 않을 때가 많습니다. 어쩌면 재작성할 수 없는 시스템을 고쳐야 할 수도 있습니다.

문제 영역을 나누는 식으로 디버깅하는 법

문제 영역을 나누는 식으로 디버깅하는 법 published on 문제 영역을 나누는 식으로 디버깅하는 법에 댓글 없음

디버깅이 재미있는 이유는 그것이 미스터리와 함께 시작하기 때문입니다. 즉, 프로그램이 어떤 일을 할 거라 생각하지만 다른 일을 하는 것이죠. 그런데 항상 그렇게 간단하지만은 않습니다(때때로 현장에서 일어나는 문제와 비교했을 때 제가 사례로 제시할 수 있는 것들은 부자연스러울 겁니다). 디버깅할 때는 창의성과 독창성이 필요합니다. 디버깅에서 가장 핵심적인 것을 하나 꼽자면 그것은 바로 미스터리에 대해 분할 정복(divide and conquer) 기법을 사용하는 것입니다.

예를 들어, 10가지 일을 순차적으로 하는 프로그램을 만들었다고 해봅시다. 프로그램을 실행하자 프로그램이 충돌하네요. 프로그램이 충돌하게끔 만들지는 않았기 때문에 이제 미스터리가 하나 생긴 셈입니다. 출력 결과를 보니 순서대로 처음 7개의 작업은 성공적으로 실행됐습니다. 마지막 세 개는 출력 결과에 보이지 않으므로 이제 미스터리는 “#8, #9, #10 중 하나에서 충돌했다”로 더 작아집니다.

어느 작업이 충돌했는지 확인하는 실험을 고안할 수 있겠습니까? 물론 그럴 것입니다. 디버거를 사용하거나 printline 문(또는 사용 중인 언어에서 그에 해당하는 것이라면 무엇이든)을 #8과 #9 다음에 추가하면 됩니다. 프로그램을 다시 실행하면 “프로그램이 #9에서 충돌함”과 같이 미스터리가 더 작아질 것입니다. 언제라도 미스터리가 정확히 무엇인지 염두에 두고 있으면 초점을 유지하는 데 도움이 되죠. 어떤 문제를 해결하기 여러 사람들이 함께 머리를 맞대고 있다 보면 가장 중요한 미스터리가 무엇인지 잊어버리기 쉽습니다.

분할 정복(divide and conquer)을 디버깅 기법으로 사용할 때의 핵심은 그것을 알고리즘 설계에 사용하는 경우와 동일합니다. 즉, 미스터리를 가운데로 잘 나누기만 하면 그것을 너무 자주 나누지 않아도 될 것이고 디버깅을 더 신속하게 할 수 있을 겁니다. 그런데 미스터리의 가운데란 무엇일까요? 바로 이 부분에서 진정한 창의성과 실험이 빛을 발합니다.

초보자에게는 모든 발생 가능한 오류가 소스코드의 모든 줄에서 일어날 것처럼 보입니다. 초보자에게는 실행된 코드 영역이나 자료 구조, 메모리 관리, 외부 코드와의 상호작용, 위험성 있는 코드, 단순한 코드와 같이 나중에 프로그램의 다른 측면을 볼 수 있게 해줄 안목이 없습니다. 반면 숙련된 프로그래머의 경우에는 이러한 다른 차원을 통해 무언가 잘못될 가능성이 있는 모든 것들에 대해 완벽하진 않지만 아주 유용한 멘탈 모델이 만들어집니다. 그러한 멘탈 모델을 갖추고 있으면 미스터리의 한가운데를 효과적으로 찾는 데 도움이 되죠.

무언가 잘못될 가능성이 있는 모든 영역을 똑같이 나누고 나면 어느 부분에서 오류가 발생했는지 판단해야 합니다. ‘어떤 라인에서 프로그램이 충돌했을까?’처럼 미스터리가 간단한 경우에는 ‘오류가 발생한 줄이 지금 실행 중인 프로그램의 가운데에서 실행된 것으로 판단하는 이 줄보다 앞에서 실행됐을까, 아니면 그다음에 실행됐을까?’라고 자문해볼 수 있습니다. 대개 오류가 단 한 줄이나 단 하나의 블록에 존재한다는 사실을 알게 되는 것처럼 운이 좋은 경우는 드뭅니다. 대신 ‘그래프 내에 잘못된 노드를 가리키는 포인터가 있든지 해당 그래프 내에서 변수를 합산하는 알고리즘이 동작하지 않는군’과 같은 경우가 더 많을 것입니다. 이 경우 더 작은 부분으로 나눈 미스터리에서 어느 부분을 제거할 수 있는지 판단하기 위해 그래프 내의 포인터가 모두 올바른지 검사하는 자그마한 프로그램을 작성해야 할지도 모릅니다.

다음 항목: 오류를 제거하는 법