rocket-sentry 0.7.0

Simplifies integration between the Rocket web framework and Sentry application monitoring system.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

Rocket Sentry
=============

[![Crates.io version](https://img.shields.io/crates/v/rocket-sentry.svg)](https://crates.io/crates/rocket-sentry)
[![Documentation](https://docs.rs/rocket-sentry/badge.svg)](https://docs.rs/rocket-sentry/)
[![Tests status](https://github.com/intgr/rocket-sentry/workflows/Tests/badge.svg?branch=master)](https://github.com/intgr/rocket-sentry/actions?query=workflow:Tests)

`rocket-sentry` is a simple add-on for the **Rocket** web framework to simplify
integration with the **Sentry** application monitoring system.

Or maybe...

> "The Rocket Sentry is a static rocket-firing gun platform that is based on a
> Personality Construct and used in the Aperture Science Enrichment Center."
>
> -- [Half-Life wiki](https://half-life.fandom.com/wiki/Rocket_Sentry)

Features
--------

Currently, `rocket-sentry` only enables the Rust panic handler.

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

Usage
-----

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

```rust
use rocket_sentry::RocketSentry;

fn main() {
    rocket::ignite()
        .attach(RocketSentry::fairing())
        // ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^   add this line
        .launch();
}
```

Then, the Sentry integration can be enabled by adding a `sentry_dsn=` value to
the `Rocket.toml` file, for example:

```toml
[development]
sentry_dsn = ""  # Disabled
[staging]
sentry_dsn = "https://057006d7dfe5fff0fbed461cfca5f757@sentry.io/1111111"
[production]
sentry_dsn = "https://057006d7dfe5fff0fbed461cfca5f757@sentry.io/1111111"
```

Testing
-------

The functionality can be tested with the `examples/panic.rs` example. Just
change the `Rocket.toml` file and run it...

```shell script
rustup override set nightly
cargo run --example panic
```

Then try accessing this URL:
http://localhost:8012/panic?msg=Is+it+time+to+panic+yet?

Release history
---------------
##### 0.7.0 (2021-07-13)
* Update sentry requirement from 0.22 to 0.23 (#20)

##### 0.6.0 (2021-01-26)
* Update sentry requirement from 0.20 to 0.22 (#16)

##### 0.5.0 (2020-09-15)
* Update sentry requirement from 0.19 to 0.20 (#13)

##### 0.4.0 (2020-08-16)
* Use log crate instead of println (#11).
  Thanks to Afonso Bordado, @afonso360

##### 0.3.0 (2020-07-22)
* Update sentry requirement from 0.18.0 to 0.19.0 (#9)
  * Sentry now automatically installs panic handler, dropped from rocket-sentry.

##### 0.2.0 (2020-04-04)
* Update sentry requirement from 0.12.0 to 0.18.0 (#1)
* Add CI builds and basic test case (#3, #4)
* Add documentation for Rust doc (#5)

##### 0.1.0 (2019-11-25)
* Initial release