Ktor Server 中的日志记录

代码示例： logging

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

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

  你还可以安装并配置 CallLogging 插件来记录客户端请求。

• 对于原生服务器，Ktor 提供了一个将所有内容打印到标准输出的记录器。

JVM

添加记录器依赖项

要启用日志记录，你需要包含所需日志记录框架的构件。 例如，Logback 需要以下依赖项：

Gradle (Kotlin)Gradle (Groovy)Maven

要使用 Log4j，你需要添加 org.apache.logging.log4j:log4j-core 和 org.apache.logging.log4j:log4j-slf4j-impl 构件。

配置记录器

要了解如何配置选定的日志记录框架，请参阅其文档，例如：

• Logback 配置
• Log4j 配置

例如，要配置 Logback，你需要将 logback.xml 文件放在类路径的根目录中（例如 src/main/resources）。 下面的示例展示了一个带有 STDOUT appender 的 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 appender。

<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

要配置原生服务器的日志级别， 请在运行应用程序时为 KTOR_LOG_LEVEL 环境变量分配以下值之一：

• TRACE
• DEBUG
• INFO
• WARN
• ERROR

例如，TRACE 级别启用了路由跟踪， 这可以帮助你确定为什么某些路由未被执行。

在代码中访问记录器

记录器实例由实现 Logger 接口的类表示。你可以使用 Application.log 属性在 Application 内部访问记录器实例。例如，下面的代码片段展示了如何在模块内向日志添加一条消息。

import io.ktor.server.application.*

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

你还可以使用 call.application.environment.log 属性从 ApplicationCall 访问记录器。

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

在插件和文件中记录日志

不建议在插件和文件内部使用应用日志。最好为每个插件或文件使用单独的记录器。为此，你可以使用任何日志库。

对于多平台项目，你可以使用 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}")
    }
}