dontpanic 0.6.0

Get instant notifications about any panic!(); in your codebase.
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

<div align="center">
    <img src="https://raw.githubusercontent.com/peterprototypes/dontpanic-server/253282285864ef092281bc63be70f79bdb10670b/static/dontpanic-ferris-logo.svg" width="20%" />
    <h1>dontpanic</h1>
    <p>
        Send Rust panic!() and log::error!() messages to a backend server.
        See <a href="https://github.com/peterprototypes/dontpanic-server">dontpanic-server</a>
    </p>
</div>

[![crates.io](https://img.shields.io/crates/v/dontpanic?label=latest)](https://crates.io/crates/dontpanic)
[![Docs](https://docs.rs/dontpanic/badge.svg)](https://docs.rs/dontpanic)
![License](https://img.shields.io/crates/l/dontpanic.svg)

Client library for [Don't Panic Server](https://github.com/peterprototypes/dontpanic-server).
This crate registers a panic handler and send each panic from your application to a backend server.
If configured, the latest log messages before each panic are sent as well.
Supported logging facilities are log and tracing.

## Example Usage

To use `dontpanic`, add this to your `Cargo.toml`:

```toml
[dependencies]
dontpanic = "*"
```

```rust
use anyhow::Result;

fn main() -> Result<()> {
    let client = dontpanic::builder("<PROJECT_API_KEY>")
        .environment("production")
        .version(env!("CARGO_PKG_VERSION"))
        .build()?

    let logger = env_logger::Builder::from_default_env().build();
    client.set_logger(logger)?;

    log::info!("What's happening here?");
    log::error!("Booooom");

    Option::<u32>::None.unwrap();

    Ok(())
}
```

`<PROJECT_API_KEY>` can be obtained from [Don't Panic Server](https://github.com/peterprototypes/dontpanic-server). For more examples see the [Documentation](https://docs.rs/dontpanic).

## Contributing

All commit messages must follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.

## License

Licensed under either of

-   Apache License, Version 2.0
    ([LICENSE-APACHE](LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>)
-   MIT license
    ([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT>)

at your option.