Skip to content

Commit

Permalink
docs: Improvements to features/usage documentation (#66)
Browse files Browse the repository at this point in the history
  • Loading branch information
intgr committed Nov 19, 2023
1 parent 16d3461 commit 1aae6e6
Showing 1 changed file with 17 additions and 12 deletions.
29 changes: 17 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,24 +19,29 @@ Or maybe...
Features
--------

Currently `rocket-sentry` enables the Rust panic handler and support basic [transactions](https://docs.sentry.io/product/performance/transaction-summary/).
Transactions fields supported are:
- [X] HTTP method
- [X] GET query_string
- [X] headers
- [ ] POST data
- [ ] cookies
- [ ] environment
- [ ] url
Currently `rocket-sentry` includes two integrations:

Pull requests welcome!
* **Rust panic handler:** when a panic happens, it is reported as a Sentry event.
* **Performance Monitoring:** HTTP requests are reported as [Transactions](https://docs.sentry.io/product/performance/transaction-summary/),
if the `sentry_traces_sample_rate` setting is configured.

`rocket-sentry` can be configured via `Rocket.toml` (`sentry_dsn=`) or
environment variable `ROCKET_SENTRY_DSN`.
Transactions currently include the following fields:
- [X] HTTP method
- [X] GET query string
- [X] headers
- [ ] POST data
- [ ] cookies
- [ ] environment
- [ ] URL

Pull requests welcome!

Usage
-----

`rocket-sentry` can be configured via `Rocket.toml` (`sentry_dsn=`) or
environment variable `ROCKET_SENTRY_DSN`.

To use this, add the dependency to your `Cargo.toml`, and add the fairing
to your code:

Expand Down

0 comments on commit 1aae6e6

Please sign in to comment.