Client Plugin

Ktor 클라이언트에서 요청 추적하기

필수 의존성: io.ktor:ktor-client-call-id

코드 예시: client-call-id

CallId 플러그인을 사용하면 고유한 호출 ID를 통해 클라이언트 요청을 엔드투엔드로 추적할 수 있습니다. 이는 요청이 거치는 서비스의 수와 관계없이 호출을 추적하는 데 마이크로서비스 아키텍처에서 특히 유용합니다.

호출 스코프에는 이미 코루틴 컨텍스트에 호출 ID가 있을 수 있습니다. 기본적으로 플러그인은 현재 컨텍스트를 사용하여 호출 ID를 검색하고, 이를 HttpHeaders.XRequestId 헤더를 사용하여 특정 호출의 컨텍스트에 추가합니다.

또한, 스코프에 호출 ID가 없는 경우, 플러그인 구성을 통해 새 호출 ID를 생성하고 적용할 수 있습니다.

서버 측에서는 Ktor가 클라이언트 요청을 추적하기 위해 CallId 플러그인을 제공합니다.

의존성 추가

CallId을(를) 사용하려면 빌드 스크립트에 ktor-client-call-id 아티팩트를 포함해야 합니다.

Gradle (Kotlin)Gradle (Groovy)Maven

CallId 설치

애플리케이션에 CallId 플러그인을 설치하려면, 지정된

모듈

모듈을 사용하면 경로를 그룹화하여 애플리케이션을 구조화할 수 있습니다.

의 install 함수에 전달하세요. 아래 코드 스니펫은 CallId을(를) 설치하는 방법을 보여줍니다...

• ... embeddedServer 함수 호출 내부에서.
• ... Application 클래스의 확장 함수인 명시적으로 정의된 module 내부에서.

embeddedServermodule

CallId 구성

CallId 플러그인 구성은 CallIdConfig 클래스에 의해 제공되며, 호출 ID를 생성하여 호출 컨텍스트에 추가할 수 있도록 합니다.

호출 ID 생성

다음 방법 중 하나로 특정 요청에 대한 호출 ID를 생성할 수 있습니다:

• useCoroutineContext 속성은 기본적으로 활성화되어 있으며, 현재 CoroutineContext를 사용하여 호출 ID를 검색하는 제너레이터를 추가합니다. 이 기능을 비활성화하려면 useCoroutineContext를 false로 설정하세요:

install(CallId) {
    useCoroutineContext = false
}

Ktor 서버에서는 CallId 플러그인을 사용하여 CoroutineContext에 호출 ID를 추가하세요.

• generate() 함수를 사용하면 나가는 요청에 대한 호출 ID를 생성할 수 있습니다. 호출 ID 생성에 실패하면 null을 반환합니다.

install(CallId) {
    generate { "call-id-client-2" }
}

여러 방법을 사용하여 호출 ID를 생성할 수 있습니다. 이 경우 첫 번째 null이 아닌 값이 적용됩니다.

호출 ID 추가

호출 ID를 검색한 후, 요청에 추가하기 위해 다음 옵션을 사용할 수 있습니다:

• intercept() 함수를 사용하면 CallIdInterceptor를 사용하여 요청에 호출 ID를 추가할 수 있습니다.

install(ClientCallId) {
    intercept { request, callId ->
        request.header(HttpHeaders.XRequestId, callId)
    }
}

• addToHeader() 함수는 지정된 헤더에 호출 ID를 추가합니다. 이 함수는 매개변수로 헤더를 받으며, 기본값은 HttpHeaders.XRequestId입니다.

install(CallId) {
    addToHeader(HttpHeaders.XRequestId)
}

예시

다음 예제에서는 Ktor 클라이언트용 CallId 플러그인이 새로운 호출 ID를 생성하고 이를 헤더에 추가하도록 구성되어 있습니다:

val client = HttpClient(CIO) {
    install(CallId) {
        generate { "call-id-client" }
        addToHeader(HttpHeaders.XRequestId)
    }
}

이 플러그인은 코루틴 컨텍스트를 사용하여 호출 ID를 가져오고, generate() 함수를 활용하여 새 호출 ID를 생성합니다. 그런 다음 첫 번째 null이 아닌 호출 ID가 addToHeader() 함수를 사용하여 요청 헤더에 적용됩니다.

Ktor 서버에서는 서버용 CallId 플러그인의 retrieve 함수를 사용하여 헤더에서 호출 ID를 검색할 수 있습니다.

install(CallId) {
    retrieveFromHeader(HttpHeaders.XRequestId)
}

이러한 방식으로 Ktor 서버는 요청의 지정된 헤더에서 ID를 검색하고 이를 호출의 callId 속성에 적용합니다.

전체 예제는 client-call-id를 참조하세요.