Ktor Server でのロギング
コード例: logging
Ktor は、使用するプラットフォームに応じてアプリケーションのログを記録するさまざまな手段を提供します。
- JVM 上では、Ktor はさまざまなロギングフレームワーク(例えば Logback や Log4j)のファサードとして SLF4J API を使用し、アプリケーションイベントのログ出力を可能にします。 ログ出力を有効にするには、目的のフレームワークの依存関係を追加し、そのフレームワークに応じた設定を行う必要があります。
クライアントリクエストをログに記録するために、CallLogging プラグインをインストールして構成することもできます。
- Native サーバーの場合、Ktor はすべてを標準出力に出力するロガーを提供します。
JVM
ロガーの依存関係の追加
ログ出力を有効にするには、目的のロギングフレームワークのアーティファクトを含める必要があります。 例えば、Logback には以下の依存関係が必要です。
implementation("ch.qos.logback:logback-classic:$logback_version")implementation "ch.qos.logback:logback-classic:$logback_version"<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>${logback_version}</version>
</dependency>Log4j を使用するには、org.apache.logging.log4j:log4j-core および org.apache.logging.log4j:log4j-slf4j2-impl アーティファクトを追加する必要があります。
ロガーの設定
選択したロギングフレームワークの設定方法については、該当するドキュメントを参照してください。例えば以下があります。
例えば、Logback を設定するには、クラスパスのルート(例: src/main/resources)に logback.xml ファイルを配置する必要があります。 以下の例は、ログをコンソールに出力する STDOUT アペンダーを備えた Logback 設定のサンプルを示しています。
<configuration>
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
</encoder>
</appender>
<root level="trace">
<appender-ref ref="STDOUT"/>
</root>
<logger name="io.netty" level="INFO"/>
</configuration>ログをファイルに出力したい場合は、FILE アペンダーを使用できます。
<configuration>
<appender name="FILE" class="ch.qos.logback.core.FileAppender">
<file>testFile.log</file>
<append>true</append>
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
</encoder>
</appender>
<root level="trace">
<appender-ref ref="FILE"/>
</root>
<logger name="io.netty" level="INFO"/>
</configuration>完全なコード例はこちらで確認できます: logging
Native
Native サーバーのログレベルを設定するには、アプリケーションの実行時に KTOR_LOG_LEVEL 環境変数に以下のいずれかの値を割り当てます。
- TRACE
- DEBUG
- INFO
- WARN
- ERROR
例えば、TRACE レベルを有効にすると、一部のルートが実行されない理由を特定するのに役立つルートトレース(route tracing)が有効になります。
コード内でロガーにアクセスする
Logger インスタンスは、Logger インターフェースを実装するクラスによって表されます。Application 内では、Application.log プロパティを使用して Logger インスタンスにアクセスできます。例えば、以下のコードスニペットは、モジュール内でログにメッセージを追加する方法を示しています。
import io.ktor.server.application.*
fun Application.module() {
log.info("Hello from module!")
}また、call.application.environment.log プロパティを使用して ApplicationCall から Logger にアクセスすることもできます。
routing {
get("/api/v1") {
call.application.environment.log.info("Hello from /api/v1!")
}
}プラグインやファイルでのロギング
プラグインやファイル内でアプリケーションのログ(Application.log)を使用することは推奨されません。各プラグインまたはファイルごとに個別のロガーを使用することをお勧めします。これを行うには、任意のロギングライブラリを使用できます。
マルチプラットフォームプロジェクトの場合は、KtorSimpleLogger クラスを使用できます。
package com.example
import io.ktor.server.application.*
import io.ktor.server.request.*
import io.ktor.util.logging.*
internal val LOGGER = KtorSimpleLogger("com.example.RequestTracePlugin")
val RequestTracePlugin = createRouteScopedPlugin("RequestTracePlugin", { }) {
onCall { call ->
LOGGER.trace("Processing call: ${call.request.uri}")
}
}