{"Type":"Package","Package":"logger","Authors@R":"c(\nperson(\"Gergely\", \"Darczi\", , \"daroczig@rapporter.net\", role = c(\"aut\", \"cre\"), comment = c(ORCID = \"0000-0003-3149-8537\")),\nperson(\"System1\", role = c(\"fnd\"))\n)","Title":"A Lightweight, Modern and Flexible Logging Utility","Description":"Inspired by the the 'futile.logger' R package and 'logging' Python module, this utility provides a flexible and extensible way of formatting and delivering log messages with low overhead.","Version":"0.1","Date":"2018-12-20","URL":"https://github.com/daroczig/logger","Encoding":"UTF-8","RoxygenNote":"6.1.0","License":"AGPL-3","Imports":"utils","Suggests":"glue, jsonlite, crayon, slackr, RPushbullet, testthat, covr,\nknitr, rmarkdown, devtools, roxygen2, parallel","Enhances":"logging, futile.logger, log4r","VignetteBuilder":"knitr","NeedsCompilation":"no","Packaged":"2019-01-02 14:50:01 UTC; daroczig","Author":"Gergely Darczi [aut, cre] (),\nSystem1 [fnd]","Maintainer":"Gergely Darczi ","Repository":"CRAN","Date/Publication":"2019-01-02 15:30:03 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/logger_0.1.tar.gz","jsonAuthors":[{"name":"Gergely Darczi","email":"daroczig@rapporter.net","maintainer":true},{"name":"System1 ","email":null,"maintainer":false}],"readme":"# logger\n\n[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)\n ![CRAN](https://www.r-pkg.org/badges/version/logger) [![Build Status](https://travis-ci.org/daroczig/logger.svg?branch=master)](https://travis-ci.org/daroczig/logger) [![Code Coverage](https://codecov.io/gh/daroczig/logger/branch/master/graph/badge.svg)](https://codecov.io/gh/daroczig/logger)\n\nA lightweight, modern and flexibly logging utility for R -- heavily inspired by the `futile.logger` R package and `logging` Python module.\n\n## Installation\n\n`logger` is not on CRAN yet, please install from GitHub:\n\n```r\nremotes::install_github('daroczig/logger')\n```\n\n## Quick example\n\nSetting the log level threshold to something low and logging various messages in ad-hoc and programmatic ways:\n\n```r\nlibrary(logger)\nlog_threshold(DEBUG)\nlog_info('Script starting up...')\n#> INFO [2018-20-11 22:49:36] Script starting up...\n\npkgs <- available.packages()\nlog_info('There are {nrow(pkgs)} R packages hosted on CRAN!')\n#> INFO [2018-20-11 22:49:37] There are 13433 R packages hosted on CRAN!\n\nfor (letter in letters) {\n lpkgs <- sum(grepl(letter, pkgs[, 'Package'], ignore.case = TRUE))\n log_level(if (lpkgs < 5000) TRACE else DEBUG,\n '{lpkgs} R packages including the {shQuote(letter)} letter')\n}\n#> DEBUG [2018-20-11 22:49:38] 6300 R packages including the 'a' letter\n#> DEBUG [2018-20-11 22:49:38] 6772 R packages including the 'e' letter\n#> DEBUG [2018-20-11 22:49:38] 5412 R packages including the 'i' letter\n#> DEBUG [2018-20-11 22:49:38] 7014 R packages including the 'r' letter\n#> DEBUG [2018-20-11 22:49:38] 6402 R packages including the 's' letter\n#> DEBUG [2018-20-11 22:49:38] 5864 R packages including the 't' letter\n\nlog_warn('There might be many, like {1:2} or more warnings!!!')\n#> WARN [2018-20-11 22:49:39] There might be many, like 1 or more warnings!!!\n#> WARN [2018-20-11 22:49:39] There might be many, like 2 or more warnings!!!\n```\n\nSetting a custom log layout to render the log records with colors:\n\n```r\nlibrary(logger)\nlog_layout(layout_glue_colors)\nlog_threshold(TRACE)\nlog_info('Starting the script...')\nlog_debug('This is the second log line')\nlog_trace('Note that the 2nd line is being placed right after the 1st one.')\nlog_success('Doing pretty well so far!')\nlog_warn('But beware, as some errors might come :/')\nlog_error('This is a problem')\nlog_debug('Note that getting an error is usually bad')\nlog_error('This is another problem')\nlog_fatal('The last problem')\n```\n\nOr simply run the related demo:\n\n```r\ndemo(colors, package = 'logger', echo = FALSE)\n```\n\n $\"colored$ \n\nBut you could set up any custom colors and layout, eg using custom colors only for the log levels, make it grayscale, include the calling function or R package namespace with specific colors etc. For more details, see the related vignettes.\n\n## Why yet another logging R package?\n\nAlthough there are multiple pretty good options already hosted on CRAN when it comes to logging in R, such as\n\n- [`futile.logger`](https://cran.r-project.org/package=futile.logger): probably the most popular `log4j` variant (and I'm a big fan)\n- [`logging`](https://cran.r-project.org/package=logging): just like Python's `logging` package\n- [`loggit`](https://cran.r-project.org/package=loggit): capture `message`, `warning` and `stop` function messages in a JSON file\n- [`log4r`](https://cran.r-project.org/package=log4r): `log4j`-based, object-oriented logger\n- [`rsyslog`](https://cran.r-project.org/package=rsyslog): logging to `syslog` on 'POSIX'-compatible operating systems\n- [`lumberjack`](https://cran.r-project.org/package=lumberjack): provides a special operator to log changes in data\n\nAlso many more work-in-progress R packages hosted on eg GitHub, such as \n\n- https://github.com/smbache/loggr\n- https://github.com/nfultz/tron\n- https://github.com/metrumresearchgroup/logrrr\n- https://github.com/lorenzwalthert/drogger\n- https://github.com/s-fleck/yog\n\nBut some/most of these packages are\n\n- not actively maintained any more, and/or maintainers are not being open for new features / patches\n- not being modular enough for extensions\n- prone to scoping issues\n- using strange syntax elements, eg dots in function names or object-oriented approaches not being very familiar to most R users\n- requires a lot of typing and code repetitions\n\nSo based on all the above subjective opinions, I decided to write the `n+1`th extensible `log4j` logger that fits my liking -- and hopefully yours as well -- with the focus being on:\n\n- keep it close to `log4j`\n- respect the most recent function / variable naming conventions and general R coding style\n- by default, rely on `glue` when it comes to formatting / rendering log messages, but keep it flexible if others prefer `sprintf` (eg for performance reasons) or other functions\n- support vectorization (eg passing a vector to be logged on multiple lines)\n- make it easy to extend with new features (eg custom layouts, message formats and output)\n- prepare for writing to various services, streams etc\n- provide support for namespaces, preferably automatically finding and creating a custom namespace for all R packages writing log messages, each with optionally configurable log level threshold, message and output formats\n- allow stacking loggers to implement logger hierarchy -- even within a namespace, so that the very same `log` call can write all the `TRACE` log messages to the console, while only pushing `ERROR`s to DataDog and eg `INFO` messages to CloudWatch\n- optionally colorize log message based on the log level\n- make logging fun\n\nWelcome to the [Bazaar](https://en.wikipedia.org/wiki/The_Cathedral_and_the_Bazaar), and if you have happened to already use any of the above mentioned R packages for logging, you might find useful the [Migration Guide](https://daroczig.github.io/logger/articles/migration.html).\n\n## Interested in more details?\n\nCheck out the main documentation site at https://daroczig.github.io/logger or the vignettes on the below topics:\n\n* [Introduction to logger](https://daroczig.github.io/logger/articles/Intro.html)\n* [The Anatomy of a Log Request](https://daroczig.github.io/logger/articles/anatomy.html)\n* [Customizing the Format and the Destination of a Log Record](https://daroczig.github.io/logger/articles/customize_logger.html)\n* [Writing Custom Logger Extensions](https://daroczig.github.io/logger/articles/write_custom_extensions.html)\n* [Migration Guide from other logging packages](https://daroczig.github.io/logger/articles/migration.html)\n* [Logging from R Packages](https://daroczig.github.io/logger/articles/r_packages.html)\n* [Simple Benchmarks on Performance](https://daroczig.github.io/logger/articles/performance.html)","jobInfo":{"package":"logger","version":"0.1","parsingStatus":"success","parserVersion":1,"parsedAt":"2021-03-04T09:30:37+0000"}}

Description

Usage

Arguments

Value

See Also