Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/atheriel/rsyslog
An R interface to syslog, the POSIX system logger API
https://github.com/atheriel/rsyslog
logging posix r syslog
Last synced: 9 days ago
JSON representation
An R interface to syslog, the POSIX system logger API
- Host: GitHub
- URL: https://github.com/atheriel/rsyslog
- Owner: atheriel
- Created: 2018-06-25T15:23:12.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-05-08T13:32:12.000Z (over 1 year ago)
- Last Synced: 2024-10-11T23:18:54.784Z (27 days ago)
- Topics: logging, posix, r, syslog
- Language: R
- Size: 26.4 KB
- Stars: 26
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.Rmd
Awesome Lists containing this project
- jimsghstars - atheriel/rsyslog - An R interface to syslog, the POSIX system logger API (R)
README
---
output: github_document
---
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
library(rsyslog)
```
# rsyslog
[](https://cran.r-project.org/package=rsyslog)
**rsyslog** is a very simple R package to interface with [syslog](https://en.wikipedia.org/wiki/Syslog) --
a system logging interface available on all POSIX-compatible operating systems.
## Installation
To get the latest stable version from CRAN:
```{r, eval = FALSE}
install.packages("rsyslog")
```
If you need access to in-development features, you can install the package
directly from GitHub:
```r
# install.packages("devtools")
devtools::install_github("atheriel/rsyslog")
```
## Usage
Using **rsyslog** closely resembles using the [syslog
API](https://man7.org/linux/man-pages/man3/openlog.3.html), 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()`.
```{r example}
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:
```shell
$ 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:
```{r brief-example}
# 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()`:
```{r mask-example}
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.