调用日志记录
所需依赖项:io.ktor:ktor-server-call-logging
代码示例: logging
Native 服务器Ktor 支持 Kotlin/Native,并允许您在无需额外运行时或虚拟机的情况下运行服务器。支持:✖️
Ktor 提供了使用 SLF4J 库记录应用程序事件的功能。您可以从 Ktor Server 中的日志记录主题了解常规日志记录配置。
CallLogging 插件允许您记录传入的客户端请求。
添加依赖项
要使用 CallLogging,请将 ktor-server-call-logging 工件添加到构建脚本中:
implementation(ktorLibs.server.callLogging)implementation ktorLibs.server.callLogging<dependency>
<groupId>io.ktor</groupId>
<artifactId>ktor-server-call-logging-jvm</artifactId>
<version>${ktor_version}</version>
</dependency>安装 CallLogging
要在应用程序中安装 CallLogging 插件,请将其传递给指定 模块模块允许您通过对路由进行分组来构建应用程序结构。 中的 install 函数。以下示例展示了如何安装 CallLogging:
- 在
embeddedServer()函数调用中。 - 在
Application类上显式定义的module()扩展函数中。
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)
}import io.ktor.server.application.*
import io.ktor.server.plugins.calllogging.*
// ...
fun Application.module() {
install(CallLogging)
// ...
}配置日志记录设置
您可以通过多种方式配置 CallLogging:指定日志级别、根据指定条件过滤请求、自定义日志消息等。您可以在 CallLoggingConfig 中查看可用的配置设置。
设置日志级别
默认情况下,Ktor 使用 Level.INFO 日志级别。要更改该级别,请使用 level 属性:
install(CallLogging) {
level = Level.INFO
}过滤日志请求
filter 属性允许您添加过滤请求的条件。在以下示例中,只有对 /api/v1 发起的请求才会记录到日志中:
install(CallLogging) {
filter { call ->
call.request.path().startsWith("/api/v1")
}
}自定义日志消息格式
通过使用 format 函数,您可以将与请求/响应相关的任何数据放入日志中。以下示例展示了如何为每个请求记录响应状态、请求 HTTP 方法以及 User-Agent 标头值。
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:
install(CallLogging) {
mdc("name-parameter") { call ->
call.request.queryParameters["name"]
}
}您可以在 ApplicationCall 的生命周期内访问添加的值:
import org.slf4j.MDC
// ...
MDC.get("name-parameter")