Log calls, results, and errors of a function

Wraps f with a lightweight logger emitting "call", "success", and "error" events. The default logger uses cli alerts. Errors are logged and re-raised unchanged.

Usage

with_logging(
  f,
  ...,
  .logger = NULL,
  .log_args = TRUE,
  .log_result = FALSE,
  .name = NULL
)

Arguments

f

A function to wrap.

...

Reserved for future extension.

.logger

Optional user function function(event, data); event is one of "call", "success", "error"; data is a list with at least name, plus event-specific fields. Default NULL uses cli.

.log_args

Logical. Whether to include a short deparse of the arguments in the "call" event. Default TRUE.

.log_result

Logical. Whether to include a short deparse of the return value in the "success" event. Default FALSE.

.name

Optional character name to display for the function. Defaults to the deparsed f symbol.

Value

A function that forwards its arguments to f.

See also

Other decorators: cache_clear(), decorate(), fmisc_decorators, is_decorated(), print.fmisc_decorated(), undecorate(), with_cache(), with_rate_limit(), with_retry(), with_timing()

Examples

# \donttest{
g <- with_logging(function(x, y) x + y, .log_result = TRUE)
g(1, 2)
#> ℹ call function(x, y) x + y(1, 2)
#> ✔ function(x, y) x + y -> 3
#> [1] 3
# }