문장 대신 필드로 남기는 구조화 로그, 유지보수할 때 남겨 둘 예제

같은 요청의 실패를 찾는데 로그 문장마다 형식이 다르면 검색식이 복잡해진다. 사람이 읽는 설명과 기계가 집계할 필드를 나눌 필요가 있다.

시간이 지나면 왜 이렇게 구현했는지보다 어떻게 실행하는지만 남기기 쉽다. 옵션과 제약을 잊은 채 코드를 정리하면 의도했던 동작까지 바뀔 수 있다. 이번에는 작은 예제를 실행 가능한 설명으로 남기고, 구현이 달라져도 유지할 부분을 분리한다.

다시 읽을 수 있는 최소 맥락

이벤트 이름을 고정하고 상태, 소요 시간, 요청 식별자를 별도 필드로 남긴다. 메시지를 바꿔도 관측의 기준 필드가 유지되도록 한다.

이번에 확인할 질문: 내부 구조를 바꾸더라도 이 예제가 설명하는 결과는 그대로 유지되어야 하는가?

작게 확인하는 예제

다음 예제는 핵심 조건을 드러내기 위한 출발점이다. 서비스의 전체 구현을 대신하지 않으므로 실제 입력 범위와 실패 처리 규칙을 함께 읽어야 한다.

{
  "event": "request_completed",
  "request_id": "example-request",
  "route": "/posts",
  "status": 200,
  "duration_ms": 24
}

성공과 실패 로그를 같은 필드 이름으로 검색하고 숫자 필드가 문자열로 저장되지 않는지 확인한다.

놓치기 쉬운 조건

사용자가 입력한 URL 전체를 메트릭 라벨로 쓰면 값의 종류가 무한히 늘 수 있다. 로그 필드도 개인정보와 보존 기간을 고려해 선택한다.

확인할 부분	살펴볼 내용
기준 동작	성공과 실패 로그를 같은 필드 이름으로 검색하고 숫자 필드가 문자열로 저장되지 않는지 확인한다.
비교 조건	입력과 실행 순서를 고정하고 한 번에 한 조건만 바꾼다.
적용 범위	예제가 생략한 의존성과 실제 서비스의 제약을 구분한다.

다음 변경에 적용할 순서

1. 구현 세부 사항보다 외부에서 관찰하는 결과를 적는다.
2. 예제가 의존하는 입력과 환경을 가까이에 둔다.
3. 설명이 실제 동작과 달라지면 코드와 예제를 같은 변경에서 고친다.

오래 남는 문서는 가장 긴 문서가 아니라 다시 확인할 수 있는 문서다. 선택의 이유와 작동하는 예제가 함께 있으면 새로운 구현으로 옮길 때도 기준을 잃지 않는다. 중복 설명을 늘리기보다 정본이 어디인지 분명히 하는 편이 유지 비용을 줄인다.