Skip to content

Ktor 伺服器中的記錄 ​

程式碼範例: logging

Ktor 根據所使用的平台,提供了不同的應用程式記錄方式:

  • 在 JVM 上,Ktor 使用 SLF4J API 作為各種記錄架構(例如 Logback 或 Log4j)的 facade,讓您能夠記錄應用程式事件。 若要啟用記錄功能,您需要為所需的架構新增相依性,並提供該架構專用的配置。

    您也可以安裝並配置 CallLogging 外掛程式來記錄用戶端請求。

  • 對於 Native 伺服器,Ktor 提供了一個會將所有內容輸出至標準輸出的記錄器。

JVM ​

新增記錄器相依性 ​

若要啟用記錄功能,您需要加入所需記錄架構的構件。 例如,Logback 需要以下相依性:

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>

若要使用 Log4j,您需要新增 org.apache.logging.log4j:log4j-core 與 org.apache.logging.log4j:log4j-slf4j2-impl 構件。

配置記錄器 ​

若要了解如何配置所選的記錄架構,請參閱其說明文件,例如:

例如,若要配置 Logback,您需要將 logback.xml 檔案放置在 classpath 的根目錄下(例如 src/main/resources)。 以下範例展示了包含 STDOUT appender 的 Logback 配置範例,它會將記錄輸出至主控台。

xml
<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 appender。

xml
<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 層級會啟用路由追蹤,這有助於您判斷為何某些路由未被執行。

在程式碼中存取記錄器 ​

Logger 執行個體由實作 Logger 介面的類別表示。您可以使用 Application.log 屬性在 Application 內部存取 Logger 執行個體。例如,下方的程式碼片段展示了如何在模組內將訊息新增至記錄中。

kotlin
import io.ktor.server.application.*

fun Application.module() {
    log.info("Hello from module!")
}

您也可以使用 call.application.environment.log 屬性從 ApplicationCall 存取 Logger。

kotlin
routing {
    get("/api/v1") {
        call.application.environment.log.info("Hello from /api/v1!")
    }
}

在外掛程式與檔案中進行記錄 ​

不建議在外掛程式與檔案內部使用應用程式記錄。最好為每個外掛程式或檔案使用獨立的記錄器。為此,您可以使用任何記錄程式庫。

對於多平台專案,您可以使用 KtorSimpleLogger 類別:

kotlin
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}")
    }
}