Package 'lgrExtra'

Description

Log to AWS CloudWatch Logs.

Value

The ⁠$new()⁠ method returns an R6::R6 that inherits from lgr::Appender and can be uses as an appender by a lgr::Logger.

Buffered Logging

By default, AppenderAWSCloudWatchLog writes each LogEvent which can be relatively slow. To improve performance it is possible to tell AppenderAWSCloudWatchLog to buffer db writes by setting buffer_size to something greater than 0. This buffer is written to AWS CloudWatch whenever it is full (buffer_size), whenever a LogEvent with a level of fatal or error is encountered (flush_threshold), or when the Appender is garbage collected (flush_on_exit), i.e. when you close the R session or shortly after you remove the Appender object via rm().

Creating a New Appender

An AppenderAWSCloudWatchLog is linked to an AWS Account using the paws sdk package. If the log group does not exist it is created either when the Appender is first instantiated or (more likely) when the first LogEvent would be written to that table.

Super classes

lgr::Filterable -> lgr::Appender -> lgr::AppenderMemory -> AppenderAWSCloudWatchLog

Active bindings

Methods

Public methods

• AppenderAWSCloudWatchLog$new()

• AppenderAWSCloudWatchLog$set_client()

• AppenderAWSCloudWatchLog$set_log_group_name()

• AppenderAWSCloudWatchLog$set_log_stream_name()

• AppenderAWSCloudWatchLog$set_log_group_retention_days()

• AppenderAWSCloudWatchLog$flush()

Method new()

Usage

AppenderAWSCloudWatchLog$new(
  log_group_name,
  log_stream_name = paste(log_group_name, Sys.Date(), sep = "/"),
  log_group_retention_days = NULL,
  paws_config = list(),
  threshold = NA_integer_,
  layout = LayoutFormat$new(fmt = "%L: %m", colors = list()),
  buffer_size = 0,
  flush_threshold = "error",
  flush_on_exit = TRUE,
  flush_on_rotate = TRUE,
  should_flush = NULL,
  filters = NULL
)

Arguments

Method set_client()

set paws.management cloudwatchlogs client

Usage

AppenderAWSCloudWatchLog$set_client(client)

Arguments

Method set_log_group_name()

set log group name for AWS CloudWatch

Usage

AppenderAWSCloudWatchLog$set_log_group_name(log_group_name)

Arguments

Method set_log_stream_name()

set log stream name within AWS CloudWatch log group

Usage

AppenderAWSCloudWatchLog$set_log_stream_name(log_stream_name)

Arguments

Method set_log_group_retention_days()

set log group retention days for AWS CloudWatch Log Group.

Usage

AppenderAWSCloudWatchLog$set_log_group_retention_days(log_group_retention_days)

Arguments

Method flush()

Usage

AppenderAWSCloudWatchLog$flush()

See Also

Other Appenders: AppenderDbi, AppenderDynatrace, AppenderElasticSearch, AppenderGmail, AppenderPool, AppenderPushbullet, AppenderSendmail, AppenderSyslog

Examples

## Not run: 
  library(lgrExtra)
  app <- AppenderAWSCloudWatchLog$new(log_group_name = "lgrExtra")
  lg <- lgr::get_logger("lgrExtra")$add_appender(app)$set_propagate(FALSE)
  lg$info("test")
  print(lg$appenders[[1]]$data)

  invisible(lg$config(NULL))  # cleanup

## End(Not run)

Description

Log to a database table with any DBI compatible backend. Please be aware that AppenderDbi does not support case sensitive / quoted column names, and you advised to only use all-lowercase names for custom fields (see ... argument of lgr::LogEvent). When appending to a database table all LogEvent values for which a column exists in the target table will be appended, all others are ignored.

NOTE: AppenderDbi works reliable for most databases, but is still considered experimental, especially because the configuration is excessively complicated. Expect breaking changes to AppenderDbi in the future.

Value

The ⁠$new()⁠ method returns an R6::R6 that inherits from lgr::Appender and can be uses as an appender by a lgr::Logger.

Buffered Logging

By default, AppenderDbi writes each LogEvent directly to the target database which can be relatively slow. To improve performance it is possible to tell AppenderDbi to buffer db writes by setting buffer_size to something greater than 0. This buffer is written to the database whenever it is full (buffer_size), whenever a LogEvent with a level of fatal or error is encountered (flush_threshold), or when the Appender is garbage collected (flush_on_exit), i.e. when you close the R session or shortly after you remove the Appender object via rm().

Creating a New Appender

An AppenderDbi is linked to a database table via its table argument. If the table does not exist it is created either when the Appender is first instantiated or (more likely) when the first LogEvent would be written to that table. Rather than to rely on this feature, it is recommended that you create the target table first using an ⁠SQL CREATE TABLE⁠ statement as this is safer and more flexible. See also LayoutDbi.

Choosing the correct DBI Layout

Layouts for relational database tables are tricky as they have very strict column types and further restrictions. On top of that implementation details vary between database backends.

To make setting up AppenderDbi as painless as possible, the helper function select_dbi_layout() tries to automatically determine sensible LayoutDbi settings based on conn and - if it exists in the database already - table. If table does not exist in the database and you start logging, a new table will be created with the col_types from layout.

Super classes

lgr::Filterable -> lgr::Appender -> lgr::AppenderMemory -> AppenderDbi

Active bindings

Methods

Public methods

• AppenderDbi$new()

• AppenderDbi$set_close_on_exit()

• AppenderDbi$set_conn()

• AppenderDbi$show()

• AppenderDbi$flush()

Method new()

Usage

AppenderDbi$new(
  conn,
  table,
  threshold = NA_integer_,
  layout = select_dbi_layout(conn, table),
  close_on_exit = TRUE,
  buffer_size = 0,
  flush_threshold = "error",
  flush_on_exit = TRUE,
  flush_on_rotate = TRUE,
  should_flush = NULL,
  filters = NULL
)

Arguments

Method set_close_on_exit()

Usage

AppenderDbi$set_close_on_exit(x)

Method set_conn()

Usage

AppenderDbi$set_conn(conn)

Method show()

Usage

AppenderDbi$show(threshold = NA_integer_, n = 20)

Method flush()

Usage

AppenderDbi$flush()

See Also

Other Appenders: AppenderAWSCloudWatchLog, AppenderDynatrace, AppenderElasticSearch, AppenderGmail, AppenderPool, AppenderPushbullet, AppenderSendmail, AppenderSyslog

Examples

if (requireNamespace("RSQLite")){
  app <- AppenderDbi$new(
    conn = DBI::dbConnect(RSQLite::SQLite(), dbname = ":memory:"),
    table = "log"
   )

  lg <- lgr::get_logger("test/dbi")$
    add_appender(app, "db")$
    set_propagate(FALSE)
  lg$info("test")
  print(lg$appenders[[1]]$data)

  invisible(lg$config(NULL))  # cleanup
}

Description

Digests is an abstract class for report-like output that contain several log messages and a title; e.g. an E-mail containing the last 10 log messages before an error was encountered or a push notification.

Abstract classes, only exported for package developers.

Value

Abstract classes cannot be instantiated with ⁠$new()⁠ and therefore do not return anything. They are solely for developers that want to write their own extension to lgr.

Super classes

lgr::Filterable -> lgr::Appender -> lgr::AppenderMemory -> AppenderDigest

Active bindings

Methods

Public methods

• AppenderDigest$new()

• AppenderDigest$set_subject_layout()

Method new()

Usage

AppenderDigest$new(...)

Method set_subject_layout()

Usage

AppenderDigest$set_subject_layout(layout)

See Also

lgr::LayoutFormat, lgr::LayoutGlue

Other abstract classes: AppenderMail

Other Digest Appenders: AppenderMail, AppenderPushbullet, AppenderSendmail

Description

Log to Dynatrace via the Dynatrace log ingestion API.

Value

The ⁠$new()⁠ method returns an R6::R6 that inherits from lgr::Appender and can be uses as an appender by a lgr::Logger.

Super classes

lgr::Filterable -> lgr::Appender -> lgr::AppenderMemory -> AppenderDynatrace

Active bindings

Methods

Public methods

• AppenderDynatrace$new()

• AppenderDynatrace$set_url()

• AppenderDynatrace$set_api_key()

• AppenderDynatrace$get_data()

• AppenderDynatrace$show()

• AppenderDynatrace$flush()

Method new()

Usage

AppenderDynatrace$new(
  url,
  api_key,
  threshold = NA_integer_,
  layout = DynatraceLayout,
  buffer_size = 0,
  flush_threshold = "error",
  flush_on_exit = TRUE,
  flush_on_rotate = TRUE,
  should_flush = NULL,
  filters = NULL
)

Arguments

Method set_url()

Usage

AppenderDynatrace$set_url(url)

Method set_api_key()

Usage

AppenderDynatrace$set_api_key(api_key)

Method get_data()

Get log as data.frame: Not supported for Dynatrace

Usage

AppenderDynatrace$get_data(n = 20L, threshold = NA, result_type = "data.frame")

Method show()

Show log in console: Not supported for Dynatrace

Usage

AppenderDynatrace$show(threshold = NA_integer_, n = 20)

Method flush()

Usage

AppenderDynatrace$flush()

See Also

https://docs.dynatrace.com/docs/analyze-explore-automate/logs/lma-log-ingestion/lma-log-ingestion-via-api

Other Appenders: AppenderAWSCloudWatchLog, AppenderDbi, AppenderElasticSearch, AppenderGmail, AppenderPool, AppenderPushbullet, AppenderSendmail, AppenderSyslog

Description

NOTE: Maturing; not yet fully documented but well tested in a production scenario

Value

The ⁠$new()⁠ method returns an R6::R6 that inherits from lgr::Appender and can be uses as an appender by a lgr::Logger.

Super classes

lgr::Filterable -> lgr::Appender -> lgr::AppenderMemory -> AppenderElasticSearch

Active bindings

Methods

Public methods

• AppenderElasticSearch$new()

• AppenderElasticSearch$set_conn()

• AppenderElasticSearch$get_data()

• AppenderElasticSearch$show()

• AppenderElasticSearch$flush()

Method new()

Usage

AppenderElasticSearch$new(
  conn,
  index,
  threshold = NA_integer_,
  layout = ElasticSearchLayout,
  index_create_body = NULL,
  buffer_size = 0,
  flush_threshold = "error",
  flush_on_exit = TRUE,
  flush_on_rotate = TRUE,
  should_flush = NULL,
  filters = NULL
)

Arguments

Method set_conn()

Usage

AppenderElasticSearch$set_conn(conn)

Method get_data()

Usage

AppenderElasticSearch$get_data(
  n = 20L,
  threshold = NA,
  result_type = "data.frame"
)

Arguments

Returns

see result_type

Method show()

Usage

AppenderElasticSearch$show(threshold = NA_integer_, n = 20)

Method flush()

Usage

AppenderElasticSearch$flush()

See Also

Other Appenders: AppenderAWSCloudWatchLog, AppenderDbi, AppenderDynatrace, AppenderGmail, AppenderPool, AppenderPushbullet, AppenderSendmail, AppenderSyslog

Description

Send mails via gmailr::gm_send_message(). This Appender keeps an in-memory buffer like lgr::AppenderBuffer. If the buffer is flushed, usually because an event of specified magnitude is encountered, all buffered events are concatenated to a single message. The default behavior is to push the last 30 log events in case a fatal event is encountered.

NOTE: This Appender requires that you set up google API authorization, please refer to the documentation of gmailr for details.

Value

The ⁠$new()⁠ method returns an R6::R6 that inherits from lgr::Appender and can be uses as an appender by a lgr::Logger.

Super classes

lgr::Filterable -> lgr::Appender -> lgr::AppenderMemory -> lgrExtra::AppenderDigest -> lgrExtra::AppenderMail -> AppenderGmail

Methods

Public methods

• AppenderGmail$new()

• AppenderGmail$flush()

Method new()

see AppenderMail for details

Usage

AppenderGmail$new(
  to,
  threshold = NA_integer_,
  flush_threshold = "fatal",
  layout = LayoutFormat$new(fmt = "%L [%t] %m %f", timestamp_fmt = "%H:%M:%S"),
  subject_layout = LayoutFormat$new(fmt = "[LGR] %L: %m"),
  buffer_size = 30,
  from = get_user(),
  cc = NULL,
  bcc = NULL,
  html = FALSE,
  filters = NULL
)

Method flush()

Usage

AppenderGmail$flush()

See Also

lgr::LayoutFormat, lgr::LayoutGlue

Other Appenders: AppenderAWSCloudWatchLog, AppenderDbi, AppenderDynatrace, AppenderElasticSearch, AppenderPool, AppenderPushbullet, AppenderSendmail, AppenderSyslog

Description

Abstract classes, only exported for package developers.

Value

Abstract classes cannot be instantiated with ⁠$new()⁠ and therefore do not return anything. They are solely for developers that want to write their own extension to lgr.

Super classes

lgr::Filterable -> lgr::Appender -> lgr::AppenderMemory -> lgrExtra::AppenderDigest -> AppenderMail

Active bindings

Methods

Public methods

• AppenderMail$new()

• AppenderMail$set_to()

• AppenderMail$set_from()

• AppenderMail$set_cc()

• AppenderMail$set_bcc()

• AppenderMail$set_html()

• AppenderMail$format()

Method new()

Usage

AppenderMail$new(...)

Method set_to()

Usage

AppenderMail$set_to(x)

Method set_from()

Usage

AppenderMail$set_from(x)

Method set_cc()

Usage

AppenderMail$set_cc(x)

Method set_bcc()

Usage

AppenderMail$set_bcc(x)

Method set_html()

Usage

AppenderMail$set_html(x)

Method format()

Usage

AppenderMail$format(color = FALSE, ...)

See Also

Other abstract classes: AppenderDigest

Other Digest Appenders: AppenderDigest, AppenderPushbullet, AppenderSendmail

Description

Log to a database table using a connection pool from the pool package. This provides better performance and connection management compared to direct DBI connections, especially for applications with concurrent users. Like AppenderDbi, it does not support case sensitive / quoted column names, and you are advised to only use all-lowercase names for custom fields (see ... argument of lgr::LogEvent).

Value

The ⁠$new()⁠ method returns an R6::R6 that inherits from lgr::Appender and can be uses as an appender by a lgr::Logger.

Benefits of Pooled Connections

Using connection pools instead of direct DBI connections provides several advantages:

• Connections are reused rather than created for each query

• Connection management is automated (creation, validation, destruction)

• Better handles concurrent requests in multi-user applications

• Improves overall performance by reducing connection overhead

Buffered Logging

Like AppenderDbi, AppenderPool supports buffered logging by setting buffer_size to something greater than 0. This buffer is written to the database whenever it is full (buffer_size), whenever a LogEvent with a level of fatal or error is encountered (flush_threshold), or when the Appender is garbage collected (flush_on_exit).

Creating a New Appender

An AppenderPool is linked to a database table via its table argument. If the table does not exist it is created either when the Appender is first instantiated or when the first LogEvent would be written to that table. It is recommended to create the target table first using an ⁠SQL CREATE TABLE⁠ statement for more control and safety.

Super classes

lgr::Filterable -> lgr::Appender -> lgr::AppenderMemory -> AppenderPool

Active bindings

Methods

Public methods

• AppenderPool$new()

• AppenderPool$set_close_on_exit()

• AppenderPool$set_pool()

• AppenderPool$show()

• AppenderPool$flush()

Method new()

Usage

AppenderPool$new(
  pool,
  table,
  threshold = NA_integer_,
  layout = select_dbi_layout(pool::poolCheckout(pool), table),
  close_on_exit = FALSE,
  buffer_size = 0,
  flush_threshold = "error",
  flush_on_exit = TRUE,
  flush_on_rotate = TRUE,
  should_flush = NULL,
  filters = NULL
)

Arguments

Method set_close_on_exit()

Usage

AppenderPool$set_close_on_exit(x)

Method set_pool()

Usage

AppenderPool$set_pool(pool)

Method show()

Usage

AppenderPool$show(threshold = NA_integer_, n = 20)

Method flush()

Usage

AppenderPool$flush()

See Also

Other Appenders: AppenderAWSCloudWatchLog, AppenderDbi, AppenderDynatrace, AppenderElasticSearch, AppenderGmail, AppenderPushbullet, AppenderSendmail, AppenderSyslog

Examples

if (requireNamespace("RSQLite") && requireNamespace("pool")){
  pool <- pool::dbPool(
    drv = RSQLite::SQLite(),
    dbname = ":memory:"
  )

  app <- AppenderPool$new(
    pool = pool,
    table = "log"
  )

  lg <- lgr::get_logger("test/pool")$
    add_appender(app, "db")$
    set_propagate(FALSE)
  lg$info("test")
  print(lg$appenders[[1]]$data)

  invisible(lg$config(NULL)) # cleanup
  pool::poolClose(pool)
}

Description

Send push notifications via Pushbullet. This Appender keeps an in-memory buffer like lgr::AppenderBuffer. If the buffer is flushed, usually because an event of specified magnitude is encountered, all buffered events are concatenated to a single message that is sent to RPushbullet::pbPost(). The default behavior is to push the last 7 log events in case a fatal event is encountered.

Value

The ⁠$new()⁠ method returns an R6::R6 that inherits from lgr::Appender and can be uses as an appender by a lgr::Logger.

Super classes

lgr::Filterable -> lgr::Appender -> lgr::AppenderMemory -> lgrExtra::AppenderDigest -> AppenderPushbullet

Active bindings

Methods

Public methods

• AppenderPushbullet$new()

• AppenderPushbullet$flush()

• AppenderPushbullet$set_apikey()

• AppenderPushbullet$set_recipients()

• AppenderPushbullet$set_email()

• AppenderPushbullet$set_channel()

• AppenderPushbullet$set_devices()

Method new()

Usage

AppenderPushbullet$new(
  threshold = NA_integer_,
  flush_threshold = "fatal",
  layout = LayoutFormat$new(fmt = "%K  %t> %m %f", timestamp_fmt = "%H:%M:%S"),
  subject_layout = LayoutFormat$new(fmt = "[LGR] %L: %m"),
  buffer_size = 6,
  recipients = NULL,
  email = NULL,
  channel = NULL,
  devices = NULL,
  apikey = getOption("rpushbullet.key"),
  filters = NULL
)

Arguments

Method flush()

Usage

AppenderPushbullet$flush()

Method set_apikey()

Usage

AppenderPushbullet$set_apikey(x)

Method set_recipients()

Usage

AppenderPushbullet$set_recipients(x)

Method set_email()

Usage

AppenderPushbullet$set_email(x)

Method set_channel()

Usage

AppenderPushbullet$set_channel(x)

Method set_devices()

Usage

AppenderPushbullet$set_devices(x)

See Also

lgr::LayoutFormat, lgr::LayoutGlue

Other Appenders: AppenderAWSCloudWatchLog, AppenderDbi, AppenderDynatrace, AppenderElasticSearch, AppenderGmail, AppenderPool, AppenderSendmail, AppenderSyslog

Other Digest Appenders: AppenderDigest, AppenderMail, AppenderSendmail

Examples

if (requireNamespace("RPushbullet") && !is.null(getOption("rpushbullet.key")) ){
  app <- AppenderPushbullet$new()

  lg <- lgr::get_logger("test/dbi")$
    add_appender(app, "pb")$
    set_propagate(FALSE)

  lg$fatal("info")
  lg$fatal("test")

 invisible(lg$config(NULL))
}

Description

Send mails via sendmailR::sendmail(), which requires that you have access to an SMTP server that does not require authentication. This Appender keeps an in-memory buffer like lgr::AppenderBuffer. If the buffer is flushed, usually because an event of specified magnitude is encountered, all buffered events are concatenated to a single message. The default behavior is to push the last 30 log events in case a fatal event is encountered.

Value

The ⁠$new()⁠ method returns an R6::R6 that inherits from lgr::Appender and can be uses as an appender by a lgr::Logger.

Super classes

lgr::Filterable -> lgr::Appender -> lgr::AppenderMemory -> lgrExtra::AppenderDigest -> lgrExtra::AppenderMail -> AppenderSendmail

Active bindings

Methods

Public methods

• AppenderSendmail$new()

• AppenderSendmail$flush()

• AppenderSendmail$set_control()

• AppenderSendmail$set_headers()

Method new()

see AppenderMail for details

Usage

AppenderSendmail$new(
  to,
  control,
  threshold = NA_integer_,
  flush_threshold = "fatal",
  layout = LayoutFormat$new(fmt = "   %L [%t] %m %f", timestamp_fmt = "%H:%M:%S"),
  subject_layout = LayoutFormat$new(fmt = "[LGR] %L: %m"),
  buffer_size = 29,
  from = get_user(),
  cc = NULL,
  bcc = NULL,
  html = FALSE,
  headers = NULL,
  filters = NULL
)

Method flush()

Usage

AppenderSendmail$flush()

Method set_control()

Usage

AppenderSendmail$set_control(x)

Method set_headers()

Usage

AppenderSendmail$set_headers(x)

Note

The default Layout's fmt indents each log entry with 3 blanks. This is a workaround so that Microsoft Outlook does not mess up the line breaks.

See Also

lgr::LayoutFormat, lgr::LayoutGlue

Other Appenders: AppenderAWSCloudWatchLog, AppenderDbi, AppenderDynatrace, AppenderElasticSearch, AppenderGmail, AppenderPool, AppenderPushbullet, AppenderSyslog

Other Digest Appenders: AppenderDigest, AppenderMail, AppenderPushbullet

Examples

## Not run: 
lgr::AppenderSendmail$new(
  to = "[email protected]",
  control = list(smtpServer = "mail.ecorp.com"),
  from = "[email protected]"
)

## End(Not run)

if (requireNamespace("sendmailR")){
# requires that you have access to an SMTP server

  lg <- lgr::get_logger("lgrExtra/test/mail")$
    set_propagate(FALSE)$
    add_appender(AppenderSendmail$new(
      from = "[email protected]",
      to = "[email protected]",
    control = list(smtpServer = "mail.somesmptserver.com")
  ))
  # cleanup
  invisible(lg$config(NULL))
}

Description

An Appender that writes to the syslog on supported POSIX platforms. Requires the rsyslog package.

Value

The ⁠$new()⁠ method returns an R6::R6 that inherits from lgr::Appender and can be uses as an appender by a lgr::Logger.

Super classes

lgr::Filterable -> lgr::Appender -> AppenderSyslog

Public fields

Active bindings

Methods

Public methods

• AppenderSyslog$new()

• AppenderSyslog$append()

• AppenderSyslog$set_syslog_levels()

• AppenderSyslog$set_identifier()

Method new()

Usage

AppenderSyslog$new(
  identifier = NULL,
  threshold = NA_integer_,
  layout = LayoutFormat$new("%m"),
  filters = NULL,
  syslog_levels = c(CRITICAL = "fatal", ERR = "error", WARNING = "warn", INFO = "info",
    DEBUG = "debug", DEBUG = "trace")
)

Method append()

Usage

AppenderSyslog$append(event)

Method set_syslog_levels()

Define conversion between lgr and syslog log levels

Usage

AppenderSyslog$set_syslog_levels(x)

Arguments

Method set_identifier()

Set a string to identify the process.

Usage

AppenderSyslog$set_identifier(x)

See Also

lgr::LayoutFormat, lgr::LayoutGlue

Other Appenders: AppenderAWSCloudWatchLog, AppenderDbi, AppenderDynatrace, AppenderElasticSearch, AppenderGmail, AppenderPool, AppenderPushbullet, AppenderSendmail

Examples

if (requireNamespace("rsyslog", quietly = TRUE) && Sys.info()[["sysname"]] == "Linux") {
  lg <- lgr::get_logger("rsyslog/test")
  lg$add_appender(AppenderSyslog$new(), "syslog")
  lg$info("A test message")
  print(system("journalctl -t 'rsyslog/test'"))

  invisible(lg$config(NULL))  # cleanup
}

Description

Convert POSIXct to Unix Epoch milliseconds

Usage

as_unix_epoch_ms(x)

Arguments

Description

LayoutDbi can contain col_types that AppenderDbi can use to create new database tables; however, it is safer and more flexible to set up the log table up manually with an ⁠SQL CREATE TABLE⁠ statement instead.

Details

The LayoutDbi parameters fmt, timestamp_fmt, colors and pad_levels are only applied for for console output via the ⁠$show()⁠ method and do not influence database inserts in any way. The inserts are pre-processed by the methods ⁠$format_data()⁠, ⁠$format_colnames⁠ and ⁠$format_tablenames⁠.

It does not format LogEvents directly, but their data.table representations (see lgr::as.data.table.LogEvent), as well as column- and table names.

Value

The ⁠$new()⁠ method returns an R6::R6 that inherits from lgr::Layout and can used as a Layout by an lgr::Appender.

Database Specific Layouts

Different databases have different data types and features. Currently the following LayoutDbi subclasses exist that deal with specific databases, but this list is expected to grow as lgrExtra matures:

• LayoutSqlite: For SQLite databases

• LayoutPostgres: for Postgres databases

• LayoutMySql: for MySQL databases

• LayoutDb2: for DB2 databases

The utility function select_dbi_layout() tries returns the appropriate Layout for a DBI connection, but this does not work for odbc and JDBC connections where you have to specify the layout manually.

For creating custom DB-specific layouts it should usually be enough to create an R6::R6 class that inherits from LayoutDbi and choosing different defaults for ⁠$format_table_name⁠, ⁠$format_colnames⁠ and ⁠$format_data⁠.

Super classes

lgr::Layout -> lgr::LayoutFormat -> LayoutDbi

Public fields

Active bindings

Methods

Public methods

• LayoutDbi$new()

• LayoutDbi$set_col_types()

• LayoutDbi$set_serialized_cols()

• LayoutDbi$sql_create_table()

• LayoutDbi$toString()

• LayoutDbi$clone()

Method new()

Usage

LayoutDbi$new(
  col_types = c(level = "integer", timestamp = "timestamp", logger = "varchar(256)",
    caller = "varchar(256)", msg = "varchar(2048)", rawMsg = "varchar(2048)"),
  serialized_cols = NULL,
  fmt = "%L [%t] %m  %f",
  timestamp_fmt = "%Y-%m-%d %H:%M:%S",
  colors = getOption("lgr.colors", list()),
  pad_levels = "right",
  format_table_name = identity,
  format_colnames = identity,
  format_data = data.table::as.data.table
)

Method set_col_types()

Usage

LayoutDbi$set_col_types(x)

Method set_serialized_cols()

Usage

LayoutDbi$set_serialized_cols(x)

Method sql_create_table()

Usage

LayoutDbi$sql_create_table(table)

Method toString()

Usage

LayoutDbi$toString()

Method clone()

The objects of this class are cloneable with this method.

Usage

LayoutDbi$clone(deep = FALSE)

Arguments

See Also

select_dbi_layout(), DBI::DBI,

Other Layout: LayoutElasticSearch

Description

Similar to lgr::LayoutJson, but with some modifications to prepare data for ElasticSearch.

Value

The ⁠$new()⁠ method returns an R6::R6 that inherits from lgr::Layout and can used as a Layout by an lgr::Appender.

Super class

lgr::Layout -> LayoutElasticSearch

Active bindings

Methods

Public methods

• LayoutElasticSearch$new()

• LayoutElasticSearch$format_event()

• LayoutElasticSearch$set_toJSON_args()

• LayoutElasticSearch$set_transform_event()

• LayoutElasticSearch$clone()

Method new()

Usage

LayoutElasticSearch$new(
  toJSON_args = list(auto_unbox = TRUE),
  transform_event = function(event) get("values", event)
)

Method format_event()

Usage

LayoutElasticSearch$format_event(event)

Method set_toJSON_args()

Usage

LayoutElasticSearch$set_toJSON_args(x)

Method set_transform_event()

Usage

LayoutElasticSearch$set_transform_event(x)

Method clone()

The objects of this class are cloneable with this method.

Usage

LayoutElasticSearch$clone(deep = FALSE)

Arguments

See Also

Other Layout: LayoutDbi

Description

Selects an appropriate Layout for a database table based on a DBI connection and - if it already exists in the database - the table itself.

Usage

select_dbi_layout(conn, table, ...)

Arguments

Description

Serializers are used by AppenderDbi to store multiple values in a single text column in a Database table. Usually you just want to use the default SerializerJson. Please not that AppenderDbi as well as Serializers are still experimental.

Value

a Serializer R6::R6 object for AppenderDbi.

Methods

Public methods

• Serializer$clone()

Method clone()

The objects of this class are cloneable with this method.

Usage

Serializer$clone(deep = FALSE)

Arguments

Super class

lgrExtra::Serializer -> SerializerJson

Methods

Public methods

• SerializerJson$new()

• SerializerJson$serialize()

• SerializerJson$clone()

Method new()

Usage

SerializerJson$new(
  cols = "*",
  cols_exclude = c("level", "timestamp", "logger", "caller", "msg"),
  col_filter = is.atomic,
  max_nchar = 2048L,
  auto_unbox = TRUE
)

Method serialize()

Usage

SerializerJson$serialize(event)

Method clone()

The objects of this class are cloneable with this method.

Usage

SerializerJson$clone(deep = FALSE)

Arguments

Examples

# The defaul Serializer for 'custom fields' columns
SerializerJson$new()

Description

Transforms a lgr::LogEvent object into a list suitable for Dynatrace ingestion.

Usage

transform_event_dynatrace(event)

DynatraceLayout

Arguments

Format

An object of class LayoutJson (inherits from Layout, R6) of length 17.

Value

A list of key-value pairs ready to be serialized to JSON for Dynatrace.

See Also

https://docs.dynatrace.com/docs/discover-dynatrace/references/semantic-dictionary/fields#service

Description

Transforms a lgr::LogEvent object into a list suitable for ElasticSearch ingestion.

Usage

transform_event_elasticsearch(event)

ElasticSearchLayout

Arguments

Format

An object of class LayoutJson (inherits from Layout, R6) of length 17.

Value

A list of key-value pairs ready to be serialized to JSON for ElasticSearch

See Also

https://www.elastic.co/docs/reference/ecs

Description

Unserialize data frame columns that contain JSON

Usage

unpack_json_cols(x, cols)

## S3 method for class 'data.table'
unpack_json_cols(x, cols)

## S3 method for class 'data.frame'
unpack_json_cols(x, cols)

Arguments

Value

a data.frame with additional columns expanded from the columns containing JSON

Examples

x <- data.frame(
  name = "example data",
  fields = '{"letters":["a","b","c"], "LETTERS":["A","B","C"]}',
  stringsAsFactors = FALSE
)
res <- unpack_json_cols(x, "fields")
res
res$letters[[1]]