Skip to content

Ktor Server 中的日志记录 ​

代码示例: logging

Ktor 根据所使用的平台提供不同的应用程序日志记录方式:

  • 在 JVM 上,Ktor 使用 SLF4J API 作为各种日志框架(例如 Logback 或 Log4j)的门面,并允许你记录应用程序事件。 要启用日志记录,你需要为所需的框架添加依赖项并提供该框架特有的配置。

    你还可以安装并配置 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 内部使用 Application.log 属性访问 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}")
    }
}