Log to the console

An Appender that outputs to the R console. If you have the package crayon installed log levels will be coloured by default (but you can modify this behaviour by passing a custom Layout).

See also

LayoutFormat

Other Appenders: AppenderBuffer, AppenderFileRotatingDate, AppenderFileRotatingTime, AppenderFileRotating, AppenderFile, AppenderTable, Appender

Super classes

lgr::Filterable -> lgr::Appender -> AppenderConsole

Methods

Public methods

• AppenderConsole$new()

• AppenderConsole$append()

• AppenderConsole$set_connection()

Inherited methods

• lgr::Filterable$add_filter()
• lgr::Filterable$filter()
• lgr::Filterable$remove_filter()
• lgr::Filterable$set_filters()
• lgr::Appender$format()
• lgr::Appender$set_layout()
• lgr::Appender$set_threshold()

---

Method new()

Usage

AppenderConsole$new(
  threshold = NA_integer_,
  layout = LayoutFormat$new(fmt = "%L [%t] %m %f", timestamp_fmt = "%H:%M:%OS3",
    colors = getOption("lgr.colors", list())),
  filters = NULL,
  connection = NULL
)

Arguments

connection

A connection or a character scalar. See the file argument of cat() for more details. Defaults to stdout(), except inside knitr rendering processes where it defaults to stderr().

---

Method append()

Usage

AppenderConsole$append(event)

---

Method set_connection()

Usage

AppenderConsole$set_connection(connection)

Arguments

connection

A connection or a character scalar. See the file argument of cat() for more details. Defaults to stdout(), except inside knitr rendering processes where it defaults to stderr().

Examples

# create a new logger with propagate = FALSE to prevent routing to the root
# logger. Please look at the section "Logger Hirarchies" in the package
# vignette for more info.
lg  <- get_logger("test")$set_propagate(FALSE)

lg$add_appender(AppenderConsole$new())
lg$add_appender(AppenderConsole$new(
  layout = LayoutFormat$new("[%t] %c(): [%n] %m", colors = getOption("lgr.colors"))))

# Will output the message twice because we attached two console appenders
lg$warn("A test message")
#> WARN  [20:04:21.465] A test message
#> [2023-03-04 20:04:21.465] eval(): [300] A test message
lg$config(NULL) # reset config
#> <Logger> [info] test
#> 
#> inherited appenders:
#>   console: <AppenderConsole> [all] -> console