Ktor 不记录异常

Posted 2023-04-15

【中文标题】Ktor 不记录异常

【英文标题】：Ktor doesn't log exceptions

【发布时间】：2021-04-29 09:42:27

【问题描述】：

Ktor (1.4.2) 似乎正在抑制异常。根据documentation，我需要像这样重新抛出异常

install(StatusPages) 
    exception<Throwable>  ex ->
        val callstack: String = ....
        call.respond(HttpStatusCode.InternalServerError,
                ApiError(ex.javaClass.simpleName, ex.message ?: "Empty Message", callstack)
        )
        throw ex
    

我围绕Logger 接口编写了包装器，以确保它调用Logger.error()（它没有）并像这样配置它

install(CallLogging) 
            level = org.slf4j.event.Level.INFO
            logger = Log4j2Wrapper(logger2)
        

我可以看到INFO 级别的日志。我错过了什么？

【参考方案1】：

原来问题出在 ktor api 的相当笨拙的设计中。我的发现总结：

与看到指定日志级别及以上的日志事件的普遍预期相反，CallLogging 并非如此。 It expects 与日志级别完全匹配，从而最大限度地降低了此功能的实用性。

您需要覆盖ApplicationEnvironment.log 中指定的记录器。但是如果你按照官方的 ktor 示例并这样做

val server = embeddedServer(Netty, port) 
  applicationEngineEnvironment 
      log = YOUR_LOGGER
  

它不起作用，因为函数 io.ktor.server.engine.defaultEnginePipeline(env) 内的值 call.application.environment 仍然是原始值，是从配置文件中的记录器名称或 NOP 记录器创建的。

因此你需要像这样初始化你的服务器

val env = applicationEngineEnvironment 
    log = YOUR_LOGGER
    module 
        install(CallLogging) 
            level = org.slf4j.event.Level.INFO
        
        install(StatusPages) 
            exception<Throwable>  ex ->
                val callstack: String = ...
                call.respond(HttpStatusCode.InternalServerError,
                        ApiError(ex.javaClass.simpleName, ex.message ?: "Empty Message", callstack)
                )
                throw ex
            
        

        routing 
        
    

    connector 
        host = "0.0.0.0"
        port = ...
    


val server = embeddedServer(Netty, env)