문장 대신 필드로 남기는 구조화 로그, 실패를 설명할 단서 남기기
같은 요청의 실패를 찾는데 로그 문장마다 형식이 다르면 검색식이 복잡해진다. 사람이 읽는 설명과 기계가 집계할 필드를 나눌 필요가 있다. 결과와 원인을 구분하는 기록를 중심으로 작은 예제와 확인 기준을 정리합니다.
같은 요청의 실패를 찾는데 로그 문장마다 형식이 다르면 검색식이 복잡해진다. 사람이 읽는 설명과 기계가 집계할 필드를 나눌 필요가 있다.
실패했다는 사실만으로는 다음 행동을 정하기 어렵다. 어떤 입력으로 어디까지 진행했으며 무엇을 기대했는지가 함께 있어야 한다. 이번에는 성공 여부를 표시하는 데서 한 걸음 더 나아가, 다음 사람이 같은 조건을 확인할 수 있도록 관찰 항목을 정리한다.
결과와 원인을 구분하는 기록
이벤트 이름을 고정하고 상태, 소요 시간, 요청 식별자를 별도 필드로 남긴다. 메시지를 바꿔도 관측의 기준 필드가 유지되도록 한다.
이번에 확인할 질문: 결과만 전달받은 사람이 원래 입력과 기대 동작을 복원할 수 있는가?
작게 확인하는 예제
다음 예제는 핵심 조건을 드러내기 위한 출발점이다. 서비스의 전체 구현을 대신하지 않으므로 실제 입력 범위와 실패 처리 규칙을 함께 읽어야 한다.
{
"event": "request_completed",
"request_id": "example-request",
"route": "/posts",
"status": 200,
"duration_ms": 24
}
성공과 실패 로그를 같은 필드 이름으로 검색하고 숫자 필드가 문자열로 저장되지 않는지 확인한다.
놓치기 쉬운 조건
사용자가 입력한 URL 전체를 메트릭 라벨로 쓰면 값의 종류가 무한히 늘 수 있다. 로그 필드도 개인정보와 보존 기간을 고려해 선택한다.
| 확인할 부분 | 살펴볼 내용 |
|---|---|
| 기준 동작 | 성공과 실패 로그를 같은 필드 이름으로 검색하고 숫자 필드가 문자열로 저장되지 않는지 확인한다. |
| 비교 조건 | 입력과 실행 순서를 고정하고 한 번에 한 조건만 바꾼다. |
| 적용 범위 | 예제가 생략한 의존성과 실제 서비스의 제약을 구분한다. |
다음 변경에 적용할 순서
- 기대 결과와 실제 결과를 서로 다른 칸에 적는다.
- 개인정보나 비밀값을 제외하고 재현에 필요한 조건만 남긴다.
- 관찰 사실과 원인에 대한 가설을 구분해 후속 확인을 정한다.
기록을 많이 남기는 것과 유용하게 남기는 것은 다르다. 원인을 좁히는 데 쓰이지 않는 항목은 줄이고, 누락 때문에 다시 묻게 되는 조건은 보완한다. 관찰할 수 있는 범위가 분명해지면 실패한 상황에서도 다음 실험을 작게 잡을 수 있다.
이 이야기가 도움이 되었나요?