knitr::opts_chunk$set( collapse = TRUE, comment = "#>" )
The following vignette presents benchmarks for log4r against all general-purpose logging packages available on CRAN:
Each logging package features slightly different capabilities, but these benchmarks are focused on the two situations common to using all of them:
The first of these is likely the most common kind of logging done by end users, although some may chose to log to files, over HTTP, or to the system log (among others). Yet a benchmark of these other scenarios would largely show the relative expense of these operations, instead of the overhead of the logic performed by the logging packages themselves.
The second measures the performance impact of leaving logging messages in running code, even if they are below the current threshold of visibility. This is another measure of overhead for each logging package.
cat()
As a reference point, we can measure how long it takes R itself to write a simple message to the console:
cat_debug <- function() { cat() # Print nothing. } cat_info <- function() cat( "INFO [", format(Sys.time(), "%Y-%m-%d %H:%M:%S", usetz = FALSE), "] Info message.", sep = "" )
The following is a typical log4r setup:
log4r_logger <- log4r::logger(threshold = "INFO") log4r_info <- function() { log4r::info(log4r_logger, "Info message.") } log4r_debug <- function() { log4r::debug(log4r_logger, "Debug message.") }
The following is a typical futile.logger setup:
requireNamespace("futile.logger") futile.logger::flog.logger() fl_info <- function() { futile.logger::flog.info("Info message.") } fl_debug <- function() { futile.logger::flog.debug("Debug message.") }
The following is what I believe to be a typical logging setup:
requireNamespace("logging") logging::basicConfig() logging_info <- function() { logging::loginfo("Info message.") } logging_debug <- function() { logging::logdebug("Debug message.") }
The following is what I believe to be a typical logger setup:
requireNamespace("logger") # Match the behaviour of other logging packages and write to the console. logger::log_appender(logger::appender_stdout) logger_info <- function() { logger::log_info("Info message.") } logger_debug <- function() { logger::log_debug("Debug message.") }
The following is what I believe to be a typical lgr setup:
requireNamespace("lgr") lgr_logger <- lgr::get_logger("perf-test") lgr_logger$set_appenders(list(cons = lgr::AppenderConsole$new())) lgr_logger$set_propagate(FALSE) lgr_info <- function() { lgr_logger$info("Info message.") } lgr_debug <- function() { lgr_logger$debug("Debug message.") }
The following is what I believe to be a typical loggit setup. Since we only
want to log to the console, set the output file to /dev/null
. In addition,
loggit does not have a notion of thresholds, so there is no "do nothing"
operation to test.
requireNamespace("loggit") if (.Platform$OS.type == "unix") { loggit::set_logfile("/dev/null") } else { loggit::set_logfile("nul") } loggit_info <- function() { loggit::loggit("INFO", "Info message.") }
The rlog package currently has no configuration options other than the threshold, which is controlled via an environment variable and defaults to hiding debug-level messages:
requireNamespace("rlog") rlog_info <- function() { rlog::log_info("Info message.") } rlog_debug <- function() { rlog::log_debug("Debug message.") }
Debug messages should print nothing.
log4r_debug() cat_debug() logging_debug() fl_debug() logger_debug() lgr_debug() rlog_debug()
Info messages should print to the console. Small differences in output format are to be expected.
log4r_info() cat_info() logging_info() fl_info() logger_info() lgr_info() loggit_info() rlog_info()
The following benchmarks all loggers defined above:
info_bench <- microbenchmark::microbenchmark( cat = cat_info(), log4r = log4r_info(), futile.logger = fl_info(), logging = logging_info(), logger = logger_info(), lgr = lgr_info(), loggit = loggit_info(), rlog = rlog_info(), times = 500, control = list(warmups = 50) ) debug_bench <- microbenchmark::microbenchmark( cat = cat_debug(), log4r = log4r_debug(), futile.logger = fl_debug(), logging = logging_debug(), logger = logger_debug(), lgr = lgr_debug(), rlog = rlog_debug(), times = 500, control = list(warmups = 50) )
print(info_bench, order = "median")
print(debug_bench, order = "median")
Any scripts or data that you put into this service are public.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.