Skip to content
Client Plugin

Ktor Client でのロギング

必要な依存関係: io.ktor:ktor-client-logging

コード例: client-logging

ロギングは、重要なイベント、エラー、または情報メッセージを記録することによって、プログラムの動作を追跡し、問題を診断するための手段です。

Ktor は、Logging プラグインを使用して HTTP コールをログに記録する機能を提供します。 このプラグインは、プラットフォームごとに異なるロガータイプを提供します。

サーバー側では、Ktor はアプリケーションロギング用の Logging プラグインと、クライアントリクエストをログに記録するための CallLogging プラグインを提供しています。

JVM ​

JVM 上で、Ktor はロギングの抽象化レイヤーとして Simple Logging Facade for Java (SLF4J) を使用します。SLF4J はロギング API を基盤となるロギング実装から分離し、アプリケーションの要件に最も適したロギングフレームワークを統合できるようにします。一般的な選択肢としては、Logback や Log4j があります。フレームワークが指定されていない場合、SLF4J はデフォルトで NOP (no-operation) 実装を使用し、ロギングは実質的に無効化されます。

ロギングを有効にするには、Logback などの必要な SLF4J 実装を含むアーティファクトを追加してください。

kotlin
implementation("ch.qos.logback:logback-classic:$logback_version")
groovy
implementation "ch.qos.logback:logback-classic:$logback_version"
xml
<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>${logback_version}</version>
</dependency>

Android ​

Android では、SLF4J Android ライブラリの使用を推奨します。

kotlin
implementation("org.slf4j:slf4j-android:$slf4j_version")
groovy
implementation "org.slf4j:slf4j-android:$slf4j_version"

Native ​

Native ターゲット向けには、Logging プラグインが標準出力ストリーム (STDOUT) にすべてを出力するロガーを提供します。

マルチプラットフォーム ​

マルチプラットフォームプロジェクトでは、Napier などのカスタムロガーを指定できます。

依存関係の追加 ​

Logging プラグインを追加するには、ビルドスクリプトに以下のアーティファクトを含めます。

kotlin
implementation(ktorLibs.client.logging)
上記のコードスニペットでは、Ktor の依存関係を指定するために Ktor バージョンカタログを使用しています。
groovy
implementation ktorLibs.client.logging
上記のコードスニペットでは、Ktor の依存関係を指定するために Ktor バージョンカタログを使用しています。
xml
<dependency>
    <groupId>io.ktor</groupId>
    <artifactId>ktor-client-logging-jvm</artifactId>
    <version>${ktor_version}</version>
</dependency>
Ktor クライアントで必要なアーティファクトの詳細については、クライアント依存関係の追加既存のプロジェクトにクライアントの依存関係を追加する方法を学びます。を参照してください。

Logging のインストール ​

Logging をインストールするには、クライアント設定ブロック内で install 関数に渡します。

kotlin
import io.ktor.client.*
import io.ktor.client.engine.cio.*
import io.ktor.client.plugins.logging.*
//...
val client = HttpClient(CIO) {
    install(Logging)
}

Logging の設定 ​

Logging プラグインの設定は、Logging.Config クラスによって提供されます。以下の例に設定サンプルを示します。

logger : ロガーインスタンスを指定します。Logger.DEFAULT は SLF4J ロギングフレームワークを使用します。Native ターゲットの場合は、このプロパティを Logger.SIMPLE に設定してください。

level : ロギングレベルを指定します。LogLevel.HEADERS はリクエスト/レスポンスのヘッダーのみをログに記録します。

filter() : 指定された述語(プレディケート)に一致するリクエストのログメッセージをフィルタリングできます。以下の例では、ktor.io へのリクエストのみがログに記録されます。

sanitizeHeader() : 機密性の高いヘッダーをサニタイズし、ログにその値が表示されないようにできます。以下の例では、ログ出力時に Authorization ヘッダーの値が「***」に置き換えられます。

kotlin
package com.example

import io.ktor.client.*
import io.ktor.client.engine.cio.*
import io.ktor.client.plugins.logging.*
import io.ktor.client.request.*
import io.ktor.client.statement.*
import io.ktor.http.*
import kotlinx.coroutines.runBlocking

fun main() {
    runBlocking {
        val client = HttpClient(CIO) {
            install(Logging) {
                logger = Logger.DEFAULT
                level = LogLevel.HEADERS
                filter { request ->
                    request.url.host.contains("ktor.io")
                }
                sanitizeHeader { header -> header == HttpHeaders.Authorization }
            }
        }

        val response1: HttpResponse = client.get("https://ktor.io/")
        val response2: HttpResponse = client.get("https://jetbrains.com/")
    }
}

完全な例については、client-logging を参照してください。

カスタムロガーの提供 ​

クライアントアプリケーションでカスタムロガーを使用するには、Logger インスタンスを作成し、log 関数をオーバーライドする必要があります。 以下の例は、Napier ライブラリを使用して HTTP コールをログに記録する方法を示しています。

kotlin
package com.example

import io.github.aakira.napier.DebugAntilog
import io.github.aakira.napier.Napier
import io.ktor.client.*
import io.ktor.client.engine.cio.*
import io.ktor.client.plugins.logging.*
import io.ktor.client.request.*
import io.ktor.client.statement.*
import kotlinx.coroutines.runBlocking

fun main() {
    runBlocking {
        val client = HttpClient(CIO) {
            install(Logging) {
                logger = object: Logger {
                    override fun log(message: String) {
                        Napier.v("HTTP Client", null, message)
                    }
                }
                level = LogLevel.HEADERS
            }
        }.also { Napier.base(DebugAntilog()) }

        val response: HttpResponse = client.get("https://ktor.io/")
    }
}

完全な例については、client-logging-napier を参照してください。