| Title: | Send Errors and Messages to Sentry |
|---|---|
| Description: | Unofficial client for 'Sentry' <https://sentry.io>, a self-hosted or cloud-based error-monitoring service. It will inform about errors in real-time, and includes integration with the 'Plumber' package. |
| Authors: | Joao Santiago [aut, cre], Daniel Kirsch [aut] |
| Maintainer: | Joao Santiago <[email protected]> |
| License: | MIT + file LICENSE |
| Version: | 1.1.2 |
| Built: | 2025-03-11 04:00:31 UTC |
| Source: | https://github.com/jcpsantiago/sentryr |
Convert function call to a stack trace
calls_to_stacktrace(calls)calls_to_stacktrace(calls)
calls |
function calls, e.g. from sys.calls() |
a data.frame
Send a message to a Sentry server
capture(...)capture(...)
... |
named parameters |
sends message to Sentry
## Not run: capture(message = "oh hai there!") # send message to sentry ## End(Not run)## Not run: capture(message = "oh hai there!") # send message to sentry ## End(Not run)
Report an error or exception object
capture_exception(error, ..., level = "error")capture_exception(error, ..., level = "error")
error |
an error object |
... |
optional additional named parameters |
level |
the level of the message. Default: "error" |
nothing; sends error to Sentry
## Not run: capture_exception(simpleError("foo"), tags = list(version = "1.0")) ## End(Not run)## Not run: capture_exception(simpleError("foo"), tags = list(version = "1.0")) ## End(Not run)
Capture function calls
capture_function_calls(error)capture_function_calls(error)
error |
error object |
Report a message to Sentry
capture_message(message, ..., level = "info")capture_message(message, ..., level = "info")
message |
message text |
... |
optional additional named parameters |
level |
the level of the message. Default: "info" |
nothing; sends message to Sentry
## Not run: capture_message("this is an important message", logger = "my.logger") ## End(Not run)## Not run: capture_message("this is an important message", logger = "my.logger") ## End(Not run)
Configure Sentry
configure_sentry( dsn, app_name = NULL, app_version = NULL, environment = NULL, ... )configure_sentry( dsn, app_name = NULL, app_version = NULL, environment = NULL, ... )
dsn |
the DSN of a Sentry project. |
app_name |
name of your application (optional). Default: NULL |
app_version |
version of your application (optional). Default: NULL |
environment |
the environment name, such as production or staging (optional). Default: NULL |
... |
named lists as extra parameters for the Sentry payload |
populates the .sentry_env environment with character strings
## Not run: configure_sentry("https://[email protected]/1234567") sentry_env$host # sentry.io ## End(Not run)## Not run: configure_sentry("https://[email protected]/1234567") sentry_env$host # sentry.io ## End(Not run)
Default error handler for Plumber
default_error_handler(req, res, error)default_error_handler(req, res, error)
req |
a Plumber request object |
res |
a Plumber response object |
error |
an error object |
a list
Check if Sentry is configured
is_sentry_configured()is_sentry_configured()
boolean
## Not run: configure_sentry("https://[email protected]/1234567") is_sentry_configured() # TRUE ## End(Not run)## Not run: configure_sentry("https://[email protected]/1234567") is_sentry_configured() # TRUE ## End(Not run)
Parse a Sentry DSN into its components
parse_dsn(dsn)parse_dsn(dsn)
dsn |
the DSN of a Sentry project. |
a named list with parsed elements of the DSN
parse_dsn("https://[email protected]/1")parse_dsn("https://[email protected]/1")
Prepare JSON payload for Sentry
prepare_payload(...)prepare_payload(...)
... |
named parameters |
a JSON character string
## Not run: prepare_payload() # return only the core parameters prepare_payload(tags = list(foo = 123, bar = "meh")) # add tags ## End(Not run)## Not run: prepare_payload() # return only the core parameters prepare_payload(tags = list(foo = 123, bar = "meh")) # add tags ## End(Not run)
Error handler with Sentry reporting
sentry_error_handler(req, res, error, ...)sentry_error_handler(req, res, error, ...)
req |
a plumber request object |
res |
a plumber response object |
error |
an error object |
... |
extra named variables for Sentry |
a list with response payload
## Not run: sentryR::configure_sentry(Sys.getenv("SENTRY_DSN")) pr <- plumber::plumb("example_plumber.R") pr$setErrorHandler(sentryR::sentry_error_handler) pr$run() ## End(Not run)## Not run: sentryR::configure_sentry(Sys.getenv("SENTRY_DSN")) pr <- plumber::plumb("example_plumber.R") pr$setErrorHandler(sentryR::sentry_error_handler) pr$run() ## End(Not run)
Set the sentry.io call header
sentry_headers()sentry_headers()
a character vector
Build the sentry.io call URL
sentry_url()sentry_url()
a character string
Create safe function
with_captured_calls(z)with_captured_calls(z)
z |
the function whose errors we want to track |
a function
Wrap a plumber error handler such that it reports errors to Sentry
wrap_error_handler_with_sentry(error_handler = default_error_handler)wrap_error_handler_with_sentry(error_handler = default_error_handler)
error_handler |
a function to handle plumber errors |
a function