Skip to content
Server Plugin

コールロギング

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

コード例: logging

Native サーバーKtorはKotlin/Nativeをサポートしており、追加のランタイムや仮想マシンなしでサーバーを実行できます。のサポート: ✖️

Ktor は SLF4J ライブラリを使用してアプリケーションイベントをログに記録する機能を提供します。一般的なロギング構成については、Ktor Server でのロギングのトピックを参照してください。

CallLogging プラグインを使用すると、受信したクライアントリクエストをログに記録できます。

依存関係の追加 ​

CallLogging を使用するには、ビルドスクリプトに ktor-server-call-logging アーティファクトを追加します。

kotlin
implementation(ktorLibs.server.callLogging)
上記のコードスニペットでは、Ktor の依存関係を指定するために Ktor バージョンカタログを使用しています。
groovy
implementation ktorLibs.server.callLogging
上記のコードスニペットでは、Ktor の依存関係を指定するために Ktor バージョンカタログを使用しています。
xml
<dependency>
    <groupId>io.ktor</groupId>
    <artifactId>ktor-server-call-logging-jvm</artifactId>
    <version>${ktor_version}</version>
</dependency>

CallLogging のインストール ​

アプリケーションに CallLogging プラグインをインストールするには、指定したモジュールモジュールを使用すると、ルートをグループ化してアプリケーションを構造化できます。内の install 関数に渡します。 以下の例は、CallLogging をインストールする方法を示しています。

  • embeddedServer() 関数の呼び出し内。
  • Application クラスに明示的に定義された module() 拡張関数内。
kotlin
import io.ktor.server.engine.*
import io.ktor.server.netty.*
import io.ktor.server.application.*
import io.ktor.server.plugins.calllogging.*

fun main() {
    embeddedServer(Netty, port = 8080) {
        install(CallLogging)
        // ...
    }.start(wait = true)
}
kotlin
import io.ktor.server.application.*
import io.ktor.server.plugins.calllogging.*
// ...
fun Application.module() {
    install(CallLogging)
    // ...
}

ロギング設定の構成 ​

CallLogging はさまざまな方法で構成できます。ログレベルの指定、指定した条件に基づくリクエストのフィルタリング、ログメッセージのカスタマイズなどがあります。利用可能な構成設定は CallLoggingConfig で確認できます。

ログレベルの設定 ​

デフォルトでは、Ktor は Level.INFO ログレベルを使用します。これを変更するには、level プロパティを使用します。

kotlin
install(CallLogging) {
    level = Level.INFO
}

ログリクエストのフィルタリング ​

filter プロパティを使用すると、リクエストをフィルタリングするための条件を追加できます。以下の例では、/api/v1 に対して行われたリクエストのみがログに記録されます。

kotlin
install(CallLogging) {
    filter { call ->
        call.request.path().startsWith("/api/v1")
    }
}

ログメッセージ形式のカスタマイズ ​

format 関数を使用すると、リクエスト/レスポンスに関連する任意のデータをログに含めることができます。以下の例では、各リクエストのレスポンスステータス、リクエストの HTTP メソッド、および User-Agent ヘッダー値をログに記録する方法を示しています。

kotlin
install(CallLogging) {
    format { call ->
        val status = call.response.status()
        val httpMethod = call.request.httpMethod.value
        val userAgent = call.request.headers["User-Agent"]
        "Status: $status, HTTP method: $httpMethod, User agent: $userAgent"
    }
}

完全な例はここで確認できます: logging

コールパラメータを MDC に配置する ​

CallLogging プラグインは MDC (Mapped Diagnostic Context) をサポートしています。mdc 関数を使用することで、指定した名前で任意のコンテキスト値を MDC に配置できます。たとえば、以下のコードスニペットでは、name クエリパラメータが MDC に追加されます。

kotlin
install(CallLogging) {
    mdc("name-parameter") { call ->
        call.request.queryParameters["name"]
    }
}

追加された値には、ApplicationCall のライフタイム中にアクセスできます。

kotlin
import org.slf4j.MDC
// ...
MDC.get("name-parameter")