sentry
Sentry (OCaml) - WORK IN PROGRESS
This is an unofficial work-in-progress Sentry library for
OCaml.
This currently requires the Async scheduler to be running or data will not
be uploaded
Missing features:
Only supports Async (pull requests to factor out Lwt/Unix are welcome!)
Global unhandled exception handler isn't implemented yet.
Probably other things
Example
See the example program.
In general, you should use this like:
let () =
let spec = Command.Spec.(...) in
Command.async_spec ~summary:"..." spec @@ fun args () ->
(* Using [SENTRY_DSN] from the environment *)
Sentry.with_exn_handler @@ fun () ->
(* your normal code here *)
To release the warning above: The Async schedule must be running.
This will execute your code as usual, and if it throws an exception, it will be
uploaded to Sentry:
Then the exception will be re-thrown so your program will exit and print the
backtrace to stderr as usual (if you want to continue after errors, wrapSentry.with_exn_handler
in another error handler or use Sentry.with_exn_handler_ignore
).
Note that Sentry.with_error_and_exn_handler
exists (which handles both exceptions andOr_error.t
), but using exceptions exclusively is recommended because they have
backtraces (and wrapping exceptions in Error.t
loses whatever backtrace did
exist in most cases).
Tags
We upload some data by default. From environment variables, we get:
SENTRY_ENVIRONMENT
->environment
SENTRY_RELEASE
->release
From Sys
or Unix
:
Sys.argv
->argv
Sys.backend_type
->backend_type
Sys.executable_name
->executable_name
Sys.gethostname
->server_name
Sys.os_type
->os_type
You can override any of these with Sentry.merge_extra
,Sentry.set_environment
, and Sentry.set_release
.
You can also upload custom tags using either Sentry.merge_tags
or by passing~tags
to a capture
function. Tags will be merged for the
current async job, so you only need to pass additional tags:
Sentry.merge_tags [ "app_name", "http_server" ];
Sentry.with_exn_handler @@ fun () ->
...
Sentry.merge_tags [ "method", "GET", "path", "/example" ];
...
(* This will upload with default tags + app_name, method, path, and user_id *)
Sentry.capture_message ~tags:[ "user_id", user_id ] "invalid login"
sha256=f475f3b68fb7386da82ba2fa7d45bf19ab5d08c535b27d38d0b3699251ec05c2
sha512=aa37df63286cb744acb5ccd2923ce2e812f448ce80dac125f4985cf2aad31982c242bb222102c78ed9eb4af7d2f5452bad8b21ac55339adf9c4e55ce0a46e779
>= "v0.13.0"
>= "4.08.0"
>= "1.2.0"
>= "1.11.0"
>= "2.0.0"
>= "2.0.0"
dev & >= "2.0.0"
>= "v0.13.0"