요청 식별자로 여러 서비스의 기록 연결하기, 작은 재현 예제로 좁혀 가기

요청이 프록시와 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. 원인을 설명하는 가장 작은 차이를 회귀 확인 항목으로 남긴다.

재현 예제의 목적은 짧은 코드를 자랑하는 데 있지 않다. 설명에 필요한 조건을 남기는 것이 목적이다. 실제 경로로 돌아왔을 때도 같은 원인과 해결책이 성립하는지 마지막으로 확인해야 재현 과정이 유용한 기록이 된다.