Abstract class for logging to memory buffers
AppenderMemory is extended by Appenders that retain an in-memory event
buffer, such as AppenderBuffer and AppenderPushbullet
from the
lgrExtra package.
lgr::Filterable
-> lgr::Appender
-> AppenderMemory
flush_on_exit
A logical
scalar. Should the buffer be flushed if
the Appender is destroyed (e.g. because the R session is terminated)?
flush_on_rotate
A logical
scalar. Should the buffer be flushed when it is
rotated because $buffer_size
is exceeded?
should_flush
A function
with exactly one arguments: event
.
$append()
calls this function internally on the current LogEvent
and flushes the buffer if it evaluates to TRUE
.
buffer_size
integer
scalar >= 0
. Maximum number of LogEvents
to buffer.
flush_threshold
A numeric
or character
threshold. LogEvents
with a log_level equal to or lower than this threshold trigger
flushing the buffer.
buffer_events
A list
of LogEvents. Contents of the buffer.
buffer_events
A data.frame
. Contents of the buffer converted
to a data.frame
.
buffer_events
A data.frame
. Contents of the buffer converted
to a data.table
.
new()
AppenderMemory$new(...)
append()
AppenderMemory$append(event)
flush()
Sends the buffer's contents to all attached Appenders and then clears the Buffer
AppenderMemory$flush()
clear()
Clears the buffer, discarding all buffered Events
AppenderMemory$clear()
set_buffer_size()
Set the maximum size of the buffer
AppenderMemory$set_buffer_size(x)
x
an integer
scalar >= 0
. Number of LogEvents to buffer.
set_should_flush()
Set function that can trigger flushing the buffer
AppenderMemory$set_should_flush(x)
x
A function
with the single argument event
. Setting x
to
NULL
is a shortcut for function(event) FALSE
. See active bindings.
set_flush_on_exit()
Should the buffer be flushed when the Appender is destroyed?
AppenderMemory$set_flush_on_exit(x)
x
A logical
scalar. See active bindings.
set_flush_on_rotate()
Should the buffer be flushed if buffer_size
is exceeded?
AppenderMemory$set_flush_on_rotate(x)
x
A logical
scalar. See active bindings.
set_flush_threshold()
Set threshold that triggers flushing
AppenderMemory$set_flush_threshold(level)
level
A numeric
or character
threshold. See
active bindings.
show()
Display the contents of the log table. Relies on the
$format_event
method of the Layout attached to this Appender.
AppenderMemory$show(threshold = NA_integer_, n = 20L)
threshold
character
or integer
scalar. The minimum log level
that should be displayed.
n
integer
scalar. Show only the last n
log entries that match
threshold
.
format()
AppenderMemory$format(color = FALSE, ...)
Other abstract classes:
AppenderTable
,
Appender
,
Filterable
Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.