요청 식별자로 여러 서비스의 기록 연결하기, 먼저 지킬 계약을 적어 보기

요청이 프록시와 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. 설명이 달라지는 부분을 코드나 문서의 명시적인 규칙으로 옮긴다.

처음 정한 계약은 영원한 정답이 아니다. 다만 바꾸려면 어떤 사용자가 영향을 받는지 함께 설명할 수 있어야 한다. 오늘의 기준을 짧게 남겨 두면 다음 변경에서 구현 취향과 제품의 약속을 구분하기 쉬워진다.