문장 대신 필드로 남기는 구조화 로그, 대안을 선택하는 기준 정리

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

문제를 푸는 방법이 둘 이상이면 기능의 개수만 비교하기 쉽다. 하지만 운영 중 설명할 수 있는지, 실패했을 때 되돌릴 수 있는지, 다음 동료가 고칠 수 있는지도 선택의 일부다. 이번에는 현재 조건에서 필요한 성질과 감수할 비용을 나누어 적는다.

장점과 비용을 함께 보기

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

이번에 확인할 질문: 선택한 방법의 장점이 지금의 제약과 실제로 연결되어 있는가?

작게 확인하는 예제

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

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

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

놓치기 쉬운 조건

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

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

다음 변경에 적용할 순서

1. 필수 조건과 있으면 좋은 조건을 분리한다.
2. 선택하지 않은 대안이 유리해지는 상황도 한 가지 적는다.
3. 조건이 바뀌면 결정을 다시 검토할 시점을 남긴다.

다른 방법을 배제한 이유가 기록되어 있으면 같은 논의를 처음부터 반복하지 않아도 된다. 선택은 환경에 따라 달라질 수 있다. 무엇을 포기했는지 설명하는 문장이 구현을 이해하는 데 오히려 더 직접적인 도움이 될 때가 많다.