lgr: basic_config – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

basic_config

Basic Setup for the Logging System

Description

A quick and easy way to configure the root logger. This is less powerful then using lgr$config() or lgr$set_*() (see Logger), but reduces the most common configurations to a single line of code.

Usage

basic_config(
  file = NULL,
  fmt = "%L [%t] %m",
  timestamp_fmt = "%Y-%m-%d %H:%M:%OS3",
  threshold = "info",
  appenders = NULL,
  console = if (is.null(appenders)) "all" else FALSE,
  console_fmt = "%L [%t] %m %f",
  console_timestamp_fmt = "%H:%M:%OS3",
  memory = FALSE
)

Arguments

`file`	`character` scalar: If not `NULL` a AppenderFile will be created that logs to this file. If the filename ends in `.jsonl`, the Appender will be set up to use the JSON Lines format instead of plain text (see AppenderFile and AppenderJson).
`fmt`	`character` scalar: Format to use if `file` is supplied and not a `.jsonl` file. If `NULL` it defaults to `"%L [%t] %m"` (see format.LogEvent)
`timestamp_fmt`	see `format.POSIXct()`
`threshold`	`character` or `integer` scalar. The minimum log level that should be processed by the root logger.
`appenders`	a single Appender or a list thereof.
`console`	`logical` scalar or a `threshold` (see above). Add an appender logs to the console (i.e. displays messages in an interactive R session)
`console_fmt`	`character` scalar: like `fmt` but used for console output
`console_timestamp_fmt`	`character` scalar: like `timestamp_fmt` but used for console output
`memory`	`logical` scalar. or a `threshold` (see above). Add an Appender that logs to a memory buffer, see also `show_log()` and AppenderBuffer

Value

the root Logger (lgr)

Examples

# log to a file
basic_config(file = tempfile())
unlink(lgr$appenders$file$file)  # cleanup

basic_config(file = tempfile(fileext = "jsonl"))
unlink(lgr$appenders$file$file)  # cleanup

# log debug messages to a memory buffer
basic_config(threshold = "all", memory = "all", console = "info")
lgr$info("an info message")
lgr$debug("a hidden message")
show_log()

# reset to default config
basic_config()

lgr

A Fully Featured Logging Framework

v0.4.2

MIT + file LICENSE

Authors

Stefan Fleck [aut, cre] (<https://orcid.org/0000-0003-3344-9851>)

Initial release