| Type: | Package |
| Title: | Send Errors and Messages to Sentry |
| Version: | 1.1.2 |
| 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. |
| 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], Daniel Kirsch [aut] |
| Maintainer: | Joao Santiago <me@jcpsantiago.xyz> |
| Repository: | CRAN |
| Date/Publication: | 2023-12-18 07:50:03 UTC |
Convert function call to a stack trace
Description
Convert function call to a stack trace
Usage
calls_to_stacktrace(calls)
Arguments
calls |
function calls, e.g. from sys.calls() |
Value
a data.frame
Send a message to a Sentry server
Description
Send a message to a Sentry server
Usage
capture(...)
Arguments
... |
named parameters |
Value
sends message to Sentry
Examples
## Not run:
capture(message = "oh hai there!") # send message to sentry
## End(Not run)
Report an error or exception object
Description
Report an error or exception object
Usage
capture_exception(error, ..., level = "error")
Arguments
error |
an error object |
... |
optional additional named parameters |
level |
the level of the message. Default: "error" |
Value
nothing; sends error to Sentry
Examples
## Not run:
capture_exception(simpleError("foo"), tags = list(version = "1.0"))
## End(Not run)
Capture function calls
Description
Capture function calls
Usage
capture_function_calls(error)
Arguments
error |
error object |
Report a message to Sentry
Description
Report a message to Sentry
Usage
capture_message(message, ..., level = "info")
Arguments
message |
message text |
... |
optional additional named parameters |
level |
the level of the message. Default: "info" |
Value
nothing; sends message to Sentry
Examples
## Not run:
capture_message("this is an important message", logger = "my.logger")
## End(Not run)
Configure Sentry
Description
Configure Sentry
Usage
configure_sentry(
dsn,
app_name = NULL,
app_version = NULL,
environment = NULL,
...
)
Arguments
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 |
Value
populates the .sentry_env environment with character strings
Examples
## Not run:
configure_sentry("https://12345abcddbc45e49773bb1ca8d9c533@sentry.io/1234567")
sentry_env$host # sentry.io
## End(Not run)
Default error handler for Plumber
Description
Default error handler for Plumber
Usage
default_error_handler(req, res, error)
Arguments
req |
a Plumber request object |
res |
a Plumber response object |
error |
an error object |
Value
a list
Check if Sentry is configured
Description
Check if Sentry is configured
Usage
is_sentry_configured()
Value
boolean
Examples
## Not run:
configure_sentry("https://12345abcddbc45e49773bb1ca8d9c533@sentry.io/1234567")
is_sentry_configured() # TRUE
## End(Not run)
Parse a Sentry DSN into its components
Description
Parse a Sentry DSN into its components
Usage
parse_dsn(dsn)
Arguments
dsn |
the DSN of a Sentry project. |
Value
a named list with parsed elements of the DSN
Examples
parse_dsn("https://1234@sentry.io/1")
Prepare JSON payload for Sentry
Description
Prepare JSON payload for Sentry
Usage
prepare_payload(...)
Arguments
... |
named parameters |
Value
a JSON character string
Examples
## Not run:
prepare_payload() # return only the core parameters
prepare_payload(tags = list(foo = 123, bar = "meh")) # add tags
## End(Not run)
sentryR package
Description
SDK for 'sentry.io', a cross-platform application monitoring service
Error handler with Sentry reporting
Description
Error handler with Sentry reporting
Usage
sentry_error_handler(req, res, error, ...)
Arguments
req |
a plumber request object |
res |
a plumber response object |
error |
an error object |
... |
extra named variables for Sentry |
Value
a list with response payload
Examples
## 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
Description
Set the sentry.io call header
Usage
sentry_headers()
Value
a character vector
Build the sentry.io call URL
Description
Build the sentry.io call URL
Usage
sentry_url()
Value
a character string
Create safe function
Description
Create safe function
Usage
with_captured_calls(z)
Arguments
z |
the function whose errors we want to track |
Value
a function
Wrap a plumber error handler such that it reports errors to Sentry
Description
Wrap a plumber error handler such that it reports errors to Sentry
Usage
wrap_error_handler_with_sentry(error_handler = default_error_handler)
Arguments
error_handler |
a function to handle plumber errors |
Value
a function