Client Plugin

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

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

코드 예제: client-call-id

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

호출 범위(calling scope)의 코루틴 컨텍스트(coroutine context)에 이미 호출 ID가 포함되어 있을 수 있습니다. 기본적으로 플러그인은 현재 컨텍스트를 사용하여 호출 ID를 검색하고, HttpHeaders.XRequestId 헤더를 사용하여 이를 특정 호출의 컨텍스트에 추가합니다.

또한, 범위에 호출 ID가 없는 경우 플러그인을 설정하여 새 호출 ID를 생성하고 적용하도록 할 수 있습니다.

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

의존성 추가

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

Gradle (Kotlin)Gradle (Groovy)Maven

CallId 설치

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

모듈(module)

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

의 install 함수에 해당 플러그인을 전달하세요. 아래의 코드 스니펫은 CallId을 설치하는 방법을 보여줍니다...

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

embeddedServermodule

CallId 설정

CallIdConfig 클래스에서 제공하는 CallId 플러그인 설정을 사용하면 호출 ID를 생성하고 호출 컨텍스트에 추가할 수 있습니다.

호출 ID 생성

다음 중 한 가지 방법을 사용하여 특정 요청에 대한 호출 ID를 생성합니다:

• 기본적으로 활성화되어 있는 useCoroutineContext 프로퍼티는 현재 CoroutineContext를 사용하여 호출 ID를 검색하는 생성기(generator)를 추가합니다. 이 기능을 비활성화하려면 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를 참조하세요.