{"Package":"sentryR","Type":"Package","Title":"Send Errors and Messages to Sentry","Version":"1.1.2","Authors@R":"c(\nperson(\"Joao\", \"Santiago\", email = \"me@jcpsantiago.xyz\", role = c(\"aut\", \"cre\")),\nperson(\"Daniel\", \"Kirsch\", role = \"aut\", email = \"daniel@billie.io\"))","Description":"Unofficial client for 'Sentry' ,\na self-hosted or cloud-based error-monitoring service. It will inform about\nerrors in real-time, and includes integration with the 'Plumber' package.","License":"MIT + file LICENSE","Encoding":"UTF-8","ByteCompile":"true","URL":"https://github.com/jcpsantiago/sentryR","BugReports":"https://github.com/jcpsantiago/sentryR/issues","RoxygenNote":"7.2.3","Imports":"httr, jsonlite, stringr, stats, tibble, uuid","Suggests":"httptest, mockery, testthat (>= 2.1.0)","NeedsCompilation":"no","Packaged":"2023-12-18 05:11:05 UTC; santi","Author":"Joao Santiago [aut, cre],\nDaniel Kirsch [aut]","Maintainer":"Joao Santiago ","Repository":"CRAN","Date/Publication":"2023-12-18 07:50:03 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/sentryR_1.1.2.tar.gz","jsonAuthors":[{"name":"Joao Santiago","email":"me@jcpsantiago.xyz","maintainer":true},{"name":"Daniel Kirsch","email":"daniel@billie.io","maintainer":false}],"readme":"[![R-CMD-check](https://github.com/ozean12/sentryR/workflows/R-CMD-check/badge.svg)](https://github.com/jcpsantiago/sentryR/actions)\n[![CRAN status](https://www.r-pkg.org/badges/version/sentryR)](https://CRAN.R-project.org/package=sentryR)\n[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)\n[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/license/mit/)\n\n# sentryR

\n\n`sentryR` is an unofficial R client for [Sentry](https://sentry.io).\nIt includes an error handler for Plumber for uncaught exceptions.\n\n## Installation\nYou can install the latest development version of `sentryR` with:\n\n``` r\n# install.packages(\"remotes\")\nremotes::install_github(\"ozean12/sentryR\")\n```\n\nor the stable version in CRAN with:\n\n```r\ninstall.packages(\"sentryR\")\n```\n\n\n## Using sentryR\n\n`configure_sentry` and `capture` are the two core functions of `sentryR`.\nThe first sets up an isolated environment with your Sentry project's DSN,\noptionally your app's name, version and the environment it's running in.\nBoth `configure_sentry` and any of the `capture_` functions accept \nadditional fields to pass on to Sentry as named lists. \n`NULL`ifying a field will remove it.\n\n```r\nlibrary(sentryR)\n\nconfigure_sentry(dsn = Sys.getenv(\"SENTRY_DSN\"),\n app_name = \"myapp\", app_version = \"8.8.8\",\n environment = Sys.getenv(\"APP_ENV\"),\n tags = list(foo = \"tag1\", bar = \"tag2\"),\n runtime = NULL)\n\ncapture(message = \"my message\", level = \"info\")\n```\n\nYou are encouraged to use the two wrappers around `capture` included:\n`capture_exception`, which handles the error object and then reports the error\nto Sentry, and `capture_message` for transmitting messages.\nRefer to the [Sentry docs](https://docs.sentry.io/development/sdk-dev/event-payloads/)\nfor a full list of available fields.\n\nBy default `sentryR` will send the following fields to Sentry:\n```r\nlist(\n logger = \"R\",\n platform = \"R\", # Sentry will ignore this for now\n sdk = list(\n name = \"SentryR\",\n version = ...\n ),\n contexts = list(\n os = list(\n name = ...,\n version = ...,\n kernel_version = ...\n ),\n runtime = list(\n version = ...,\n type = \"runtime\",\n name = \"R\",\n build = ...\n )\n ),\n timestamp = ...,\n event_id = ...\n)\n```\n\n`capture_exception` further adds the `exception` field to the payload.\n\n\n## Example with Plumber\n\nIn a Plumber API, besides the initial configuration for Sentry, \nyou'll also have to set the error handler.\n\n`sentryR` ships with the default `plumber` error handler wrapped\nin the convenience function `sentry_error_handler`, but you can use\nyour own function and wrap it as below:\n\n```r\nlibrary(plumber)\nlibrary(sentryR)\n\n# add list of installed packages and their versions.\n# this can be slow in systems with a high number of packages installed,\n# so it is not the default behavior\ninstalled_pkgs_df <- as.data.frame(utils::installed.packages(),\nstringsAsFactors = FALSE\n)\nversions <- installed_pkgs_df$Version\nnames(versions) <- installed_pkgs_df$Package\npackages <- as.list(versions)\n\nconfigure_sentry(dsn = Sys.getenv('SENTRY_DSN'), \n app_name = \"myapp\", app_version = \"1.0.0\",\n modules = packages)\n\nmy_sentry_error_handler <- wrap_error_handler_with_sentry(my_error_handler)\n\nr <- plumb(\"R/api.R\")\nr$setErrorHandler(my_sentry_error_handler)\nr$run(host = \"0.0.0.0\", port = 8000)\n```\n\nand wrap your endpoint functions with `with_captured_calls`\n\n```r\n#* @get /error\napi_error <- with_captured_calls(function(res, req){\n stop(\"error\")\n})\n```\n\nonce this is done, Plumber will handle any errors, send them to Sentry using\n`capture_exception`, and respond with status `500` and the error message.\nYou don't need to do any further configuration.\n\n## Example with Shiny\n\nYou can also use `sentryR` to capture exceptions in your Shiny applications\nby providing a callback function to the `shiny.error` option.\n\n```r\nlibrary(shiny)\nlibrary(sentryR)\n\nconfigure_sentry(dsn = Sys.getenv('SENTRY_DSN'), \n app_name = \"myapp\", app_version = \"1.0.0\",\n\t\t modules = packages)\n\nerror_handler <- function() {\n capture_exception(error = geterrmessage())\n}\n\noptions(shiny.error = error_handler)\n\nshinyServer(function(input, output) {\n # Define server logic\n ...\n}\n```\n\n## TODO\n* test the error handling functions, needs mocking?\n* posting to sentry asynchronously\n* vignettes\n\n## Acknowledgements\n\n`sentryR` took inspiration from\n[raven-clj](https://github.com/sethtrain/raven-clj) a Clojure interface to Sentry.\n\n## Contributing\n\nPRs and issues are welcome! :tada:","jobInfo":{"package":"sentryR","version":"1.1.2","parsingStatus":"success","parserVersion":2,"parsedAt":"2023-12-18T09:30:41+0000"}}

Description

Usage

Arguments

Value

Examples