요청 식별자로 여러 서비스의 기록 연결하기, 실패를 설명할 단서 남기기

요청이 프록시와 API, 작업 큐를 거치면 한 줄의 오류만으로 전체 흐름을 찾기 어렵다. 각 구간이 같은 상관 식별자를 공유하면 조사 범위를 좁힐 수 있다.

실패했다는 사실만으로는 다음 행동을 정하기 어렵다. 어떤 입력으로 어디까지 진행했으며 무엇을 기대했는지가 함께 있어야 한다. 이번에는 성공 여부를 표시하는 데서 한 걸음 더 나아가, 다음 사람이 같은 조건을 확인할 수 있도록 관찰 항목을 정리한다.

결과와 원인을 구분하는 기록

경계에서 식별자를 검증하거나 생성하고 이후 호출과 로그에 전달한다. 외부 입력은 길이와 문자 범위를 제한하며 인증이나 권한 판단에는 사용하지 않는다.

이번에 확인할 질문: 결과만 전달받은 사람이 원래 입력과 기대 동작을 복원할 수 있는가?

작게 확인하는 예제

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

incoming request
  request_id = validated header or new identifier
  -> application log: request_id
  -> downstream header: request_id
  -> response header: request_id

하나의 요청이 여러 구간을 통과했을 때 공통 식별자로 관련 로그를 모두 찾을 수 있는지 확인한다.

놓치기 쉬운 조건

클라이언트가 보낸 식별자를 신뢰해서 계정 정보와 연결하면 안 된다. 비동기 작업은 최초 요청 식별자와 작업 자체의 식별자를 함께 보관하는 편이 낫다.

확인할 부분	살펴볼 내용
기준 동작	하나의 요청이 여러 구간을 통과했을 때 공통 식별자로 관련 로그를 모두 찾을 수 있는지 확인한다.
비교 조건	입력과 실행 순서를 고정하고 한 번에 한 조건만 바꾼다.
적용 범위	예제가 생략한 의존성과 실제 서비스의 제약을 구분한다.

다음 변경에 적용할 순서

1. 기대 결과와 실제 결과를 서로 다른 칸에 적는다.
2. 개인정보나 비밀값을 제외하고 재현에 필요한 조건만 남긴다.
3. 관찰 사실과 원인에 대한 가설을 구분해 후속 확인을 정한다.

기록을 많이 남기는 것과 유용하게 남기는 것은 다르다. 원인을 좁히는 데 쓰이지 않는 항목은 줄이고, 누락 때문에 다시 묻게 되는 조건은 보완한다. 관찰할 수 있는 범위가 분명해지면 실패한 상황에서도 다음 실험을 작게 잡을 수 있다.