Interface to the 'syslog' System Logger

Functions to write messages to the 'syslog' system logger API, available on all 'POSIX'-compatible operating systems. Features include tagging messages with a priority level and application type, as well as masking (hiding) messages below a given priority level.


CRAN status

rsyslog is a very simple R package to interface with syslog -- a system logging interface available on all POSIX-compatible operating systems.

Installation

To get the latest stable version from CRAN:

install.packages("rsyslog")

If you need access to in-development features, you can install the package directly from GitHub:

devtools::install_github("atheriel/rsyslog")

Usage

Using rsyslog closely resembles using the syslog API, so it should be familiar if you have previous experience with syslog.

Messages are sent to the system log with the syslog() function. You can also (optionally) configure how messages are written with open_syslog() and close any open connection with close_syslog().

open_syslog("my_script")
syslog("Running script.", level = "INFO")
syslog("Possible issue.", level = "WARNING")
close_syslog()

To see what this has printed to the system log on systemd-based Linux distributions (including Ubuntu), you can use the journalctl program:

$ journalctl --identifier my_script
-- Logs begin at Mon 2018-06-25 14:48:12 UTC, end at Mon 2018-06-25 15:35:02 UTC. --
Jun 25 15:10:18 user my_script[4467]: Running script.
Jun 25 15:10:18 user my_script[4467]: Possible issue.

Opening and closing the system log is not strictly necessary (though it is good practice). The following will work as well:

# Uses the process name (likely "R" or "rsession") as the identifier.
syslog("Hello from R!", level = "WARNING")

If you wish to control the visibility of messages by priority level (for example, to hide debug messages), use set_syslog_mask():

open_syslog("my_script")
syslog("This message is visible.", level = "INFO")
set_syslog_mask("WARNING")
syslog("No longer visible.", level = "INFO")
syslog("Still visible.", level = "WARNING")
close_syslog()

License

The package is licensed under the GPL, version 2 or later.

News

rsyslog 1.0.1

  • Fixes an issue where compilation would fail on some POSIX platforms that do not support the LOG_PERROR option (notably Solaris). Calling open_syslog(echo = TRUE) on those platforms will now issue a warning.

rsyslog 1.0.0

  • Initial public release. Allows R users to write messages to the 'syslog' system logger API, available on all 'POSIX'-compatible operating systems.
  • Features include tagging messages with a priority level and application type, as well as masking (hiding) messages below a given priority level.

Reference manual

It appears you don't have a PDF plugin for this browser. You can click here to download the reference manual.

install.packages("rsyslog")

1.0.1 by Aaron Jacobs, a year ago


https://github.com/atheriel/rsyslog


Report a bug at https://github.com/atheriel/rsyslog/issues


Browse source code at https://github.com/cran/rsyslog


Authors: Aaron Jacobs [aut, cre] , Crescendo Technology Ltd. [cph]


Documentation:   PDF Manual  


GPL (>= 2) license


System requirements: POSIX.1-2001


See at CRAN