R包logger函数内调用时日志写入文件失败问题排查

问题场景 #

我在维护使用logger包的代码时，编写了.start_logger()函数来配置同时输出到控制台和文件的日志，调用方式为my_logfile = .start_logger()，但遇到两个问题：

• 全新R会话中，在函数内调用时执行logger::log_with_separator()会报错：Error in force(file) : object 'my_logfile' not found，但直接逐行运行相同代码却正常；
• 成功运行一次非函数封装的配置代码后，函数版本就能正常工作。

我尝试过用<<-将my_logfile赋值到全局环境来解决，但希望找到更优雅的实现方式。后续确认这是logger包的已知bug。

原因分析 #

这个问题是logger包v0.3.0版本的已知问题，核心是log_with_separator()在解析日志文件路径时，会尝试在当前调用环境而非配置时的环境中查找文件对象，导致函数内定义的my_logfile无法被正确识别。

优雅解决方案 #

方案1：显式指定日志文件路径给log_with_separator #

调用log_with_separator()时不再依赖隐式的文件对象，而是直接传入文件路径参数：

.start_logger <- function() {
  my_logfile <- tempfile(fileext = ".log")
  logger::log_appender(logger::appender_file(my_logfile))
  logger::log_appender(logger::appender_console(), index = 2)
  # 显式传入文件路径
  logger::log_with_separator(file = my_logfile)
  return(my_logfile)
}

方案2：利用logger配置上下文传递路径 #

通过给日志追加器附加属性存储路径，避免直接污染全局环境：

.start_logger <- function() {
  my_logfile <- tempfile(fileext = ".log")
  # 给文件追加器附加日志路径属性
  file_appender <- logger::appender_file(my_logfile)
  attr(file_appender, "logfile_path") <- my_logfile
  logger::log_appender(file_appender)
  logger::log_appender(logger::appender_console(), index = 2)
  # 从追加器属性中读取路径
  logger::log_with_separator(file = attr(logger::log_appender(1), "logfile_path"))
  return(my_logfile)
}

方案3：升级logger包到修复版本 #

该bug已在logger后续版本中修复，直接升级包即可彻底解决：

install.packages("logger")

临时应急方案 #

如果暂时无法升级包，且不想修改太多代码，可以将文件对象存入logger的命名空间环境，而非全局环境：

.start_logger <- function() {
  my_logfile <- tempfile(fileext = ".log")
  logger::log_appender(logger::appender_file(my_logfile))
  logger::log_appender(logger::appender_console(), index = 2)
  # 将对象存入logger包的命名空间环境
  assign("my_logfile", my_logfile, envir = as.environment("package:logger"))
  logger::log_with_separator()
  return(my_logfile)
}

内容的提问来源于stack exchange，提问作者Richi W