Merge branch 'release/0.24.1'

getsentry · Jan 21, 2022 · c75d62a · c75d62a
2 parents 6ec32bc + a8d822c
commit c75d62a
Show file tree

Hide file tree

Showing 23 changed files with 182 additions and 123 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,6 @@
 # Changelog
 
-## Unreleased
+## 0.24.1
 
 **Breaking Changes**:
 

diff --git a/sentry-actix/Cargo.toml b/sentry-actix/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "sentry-actix"
-version = "0.23.0"
+version = "0.24.1"
 authors = ["Sentry <hello@sentry.io>"]
 license = "Apache-2.0"
 readme = "README.md"
@@ -12,7 +12,7 @@ Sentry client extension for actix-web 3.
 edition = "2018"
 
 [dependencies]
-sentry-core = { version = "0.23.0", path = "../sentry-core", default-features = false }
+sentry-core = { version = "0.24.1", path = "../sentry-core", default-features = false }
 actix-web = { version = "3", default-features = false }
 futures-util = { version = "0.3.5", default-features = false }
 

diff --git a/sentry-actix/README.md b/sentry-actix/README.md
@@ -17,11 +17,9 @@ such as breadcrumbs do not work unless you bind the actix hub.
 ## Example
 
 ```rust
-use std::env;
 use std::io;
 
 use actix_web::{get, App, Error, HttpRequest, HttpServer};
-use sentry::Level;
 
 #[get("/")]
 async fn failing(_req: HttpRequest) -> Result<String, Error> {
@@ -31,7 +29,7 @@ async fn failing(_req: HttpRequest) -> Result<String, Error> {
 #[actix_web::main]
 async fn main() -> io::Result<()> {
     let _guard = sentry::init(());
-    env::set_var("RUST_BACKTRACE", "1");
+    std::env::set_var("RUST_BACKTRACE", "1");
 
     HttpServer::new(|| {
         App::new()
@@ -46,14 +44,27 @@ async fn main() -> io::Result<()> {
 }
 ```
 
+## Using Release Health
+
+The actix middleware will automatically start a new session for each request
+when `auto_session_tracking` is enabled and the client is configured to
+use `SessionMode::Request`.
+
+```rust
+let _sentry = sentry::init(sentry::ClientOptions {
+    session_mode: sentry::SessionMode::Request,
+    auto_session_tracking: true,
+    ..Default::default()
+});
+```
+
 ## Reusing the Hub
 
-This integration will automatically update the current Hub instance. For example,
-the following will capture a message in the current request's Hub:
+This integration will automatically create a new per-request Hub from the main Hub, and update the
+current Hub instance. For example, the following will capture a message in the current request's Hub:
 
 ```rust
-use sentry::Level;
-sentry::capture_message("Something is not well", Level::Warning);
+sentry::capture_message("Something is not well", sentry::Level::Warning);
 ```
 
 ## Resources

diff --git a/sentry-anyhow/Cargo.toml b/sentry-anyhow/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "sentry-anyhow"
-version = "0.23.0"
+version = "0.24.1"
 authors = ["Sentry <hello@sentry.io>"]
 license = "Apache-2.0"
 readme = "README.md"
@@ -16,8 +16,8 @@ default = ["backtrace"]
 backtrace = ["anyhow/backtrace"]
 
 [dependencies]
-sentry-backtrace = { version = "0.23.0", path = "../sentry-backtrace" }
-sentry-core = { version = "0.23.0", path = "../sentry-core" }
+sentry-backtrace = { version = "0.24.1", path = "../sentry-backtrace" }
+sentry-core = { version = "0.24.1", path = "../sentry-core" }
 anyhow = "1.0.39"
 
 [dev-dependencies]

diff --git a/sentry-anyhow/README.md b/sentry-anyhow/README.md
@@ -1,4 +1,10 @@
-# sentry-anyhow
+<p align="center">
+    <a href="https://sentry.io" target="_blank" align="center">
+        <img src="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" width="280">
+    </a>
+</p>
+
+# Sentry Rust SDK: sentry-anyhow
 
 Adds support for capturing Sentry errors from [`anyhow::Error`].
 
@@ -36,11 +42,11 @@ if let Err(err) = function_that_might_fail() {
 The `backtrace` feature will enable the corresponding feature in anyhow and allow you to
 capture backtraces with your events.  It is enabled by default.
 
-## Resources
-
-- [Discord](https://discord.gg/ez5KZN7) server for project discussions.
-- Follow [@getsentry](https://twitter.com/getsentry) on Twitter for updates.
-
 [`anyhow::Error`]: https://docs.rs/anyhow/*/anyhow/struct.Error.html
 
+## Resources
+
 License: Apache-2.0
+
+- [Discord](https://discord.gg/ez5KZN7) server for project discussions.
+- Follow [@getsentry](https://twitter.com/getsentry) on Twitter for updates
diff --git a/sentry-backtrace/Cargo.toml b/sentry-backtrace/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "sentry-backtrace"
-version = "0.23.0"
+version = "0.24.1"
 authors = ["Sentry <hello@sentry.io>"]
 license = "Apache-2.0"
 readme = "README.md"
@@ -12,7 +12,7 @@ Sentry integration and utilities for dealing with stacktraces.
 edition = "2018"
 
 [dependencies]
-sentry-core = { version = "0.23.0", path = "../sentry-core" }
+sentry-core = { version = "0.24.1", path = "../sentry-core" }
 lazy_static = "1.4.0"
 backtrace = "0.3.44"
 regex = "1.3.4"
diff --git a/sentry-contexts/Cargo.toml b/sentry-contexts/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "sentry-contexts"
-version = "0.23.0"
+version = "0.24.1"
 authors = ["Sentry <hello@sentry.io>"]
 license = "Apache-2.0"
 readme = "README.md"
@@ -13,7 +13,7 @@ build = "build.rs"
 edition = "2018"
 
 [dependencies]
-sentry-core = { version = "0.23.0", path = "../sentry-core" }
+sentry-core = { version = "0.24.1", path = "../sentry-core" }
 libc = "0.2.66"
 hostname = "0.3.0"
 

diff --git a/sentry-contexts/README.md b/sentry-contexts/README.md
@@ -6,10 +6,10 @@
 
 # Sentry Rust SDK: sentry-contexts
 
-Adds Contexts to Sentry Events
+Adds Contexts to Sentry Events.
 
 This integration is enabled by default in `sentry` and adds `device`, `os`
-and `rust` contexts to Events, as well as sets a `server_name` if not
+and `rust` contexts to Events, and also sets a `server_name` if it is not
 already defined.
 
 See the [Contexts Interface] documentation for more info.

diff --git a/sentry-core/Cargo.toml b/sentry-core/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "sentry-core"
-version = "0.23.0"
+version = "0.24.1"
 authors = ["Sentry <hello@sentry.io>"]
 license = "Apache-2.0"
 readme = "README.md"
@@ -27,7 +27,7 @@ debug-logs = ["log_"]
 test = ["client"]
 
 [dependencies]
-sentry-types = { version = "0.23.0", path = "../sentry-types" }
+sentry-types = { version = "0.24.1", path = "../sentry-types" }
 serde = { version = "1.0.104", features = ["derive"] }
 lazy_static = "1.4.0"
 rand = { version = "0.8.1", optional = true }

diff --git a/sentry-core/README.md b/sentry-core/README.md
@@ -6,14 +6,14 @@
 
 # Sentry Rust SDK: sentry-core
 
-This crate provides the core of the [Sentry](https://sentry.io/) SDK, which
-can be used to log events and errors.
+This crate provides the core of the [Sentry] SDK, which can be used to log
+events and errors.
 
-This crate is meant for integration authors and third party library authors
+`sentry-core` is meant for integration authors and third-party library authors
 that want to instrument their code for sentry.
 
 Regular users who wish to integrate sentry into their applications should
-rather use the [`sentry`] crate, which comes with a default transport, and
+instead use the [`sentry`] crate, which comes with a default transport and
 a large set of integrations for various third-party libraries.
 
 ## Core Concepts
@@ -34,24 +34,25 @@ functionality.
 
 ## Features
 
-* `feature = "client"`: Activates the [`Client`] type and certain
+- `feature = "client"`: Activates the [`Client`] type and certain
   [`Hub`] functionality.
-* `feature = "test"`: Activates the [`test`] module, which can be used to
+- `feature = "test"`: Activates the [`test`] module, which can be used to
   write integration tests. It comes with a test transport which can capture
   all sent events for inspection.
-* `feature = "debug-logs"`: Uses the `log` crate for debug output, instead
+- `feature = "debug-logs"`: Uses the `log` crate for debug output, instead
   of printing to `stderr`. This feature is **deprecated** and will be
   replaced by a dedicated log callback in the future.
 
+[Sentry]: https://sentry.io/
 [`sentry`]: https://crates.io/crates/sentry
 [Unified API]: https://develop.sentry.dev/sdk/unified-api/
-[`Client`]: https://docs.rs/sentry-core/0.21.0/sentry_core/struct.Client.html
-[`Hub`]: https://docs.rs/sentry-core/0.21.0/sentry_core/struct.Hub.html
-[`Scope`]: https://docs.rs/sentry-core/0.21.0/sentry_core/struct.Scope.html
-[`Integration`]: https://docs.rs/sentry-core/0.21.0/sentry_core/trait.Integration.html
-[`Transport`]: https://docs.rs/sentry-core/0.21.0/sentry_core/trait.Transport.html
-[`TransportFactory`]: https://docs.rs/sentry-core/0.21.0/sentry_core/trait.TransportFactory.html
-[`test`]: https://docs.rs/sentry-core/0.21.0/sentry_core/test/index.html
+[`Client`]: https://docs.rs/sentry-core/0.24.1/sentry_core/struct.Client.html
+[`Hub`]: https://docs.rs/sentry-core/0.24.1/sentry_core/struct.Hub.html
+[`Scope`]: https://docs.rs/sentry-core/0.24.1/sentry_core/struct.Scope.html
+[`Integration`]: https://docs.rs/sentry-core/0.24.1/sentry_core/trait.Integration.html
+[`Transport`]: https://docs.rs/sentry-core/0.24.1/sentry_core/trait.Transport.html
+[`TransportFactory`]: https://docs.rs/sentry-core/0.24.1/sentry_core/trait.TransportFactory.html
+[`test`]: https://docs.rs/sentry-core/0.24.1/sentry_core/test/index.html
 
 ## Resources
 

diff --git a/sentry-debug-images/Cargo.toml b/sentry-debug-images/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "sentry-debug-images"
-version = "0.23.0"
+version = "0.24.1"
 authors = ["Sentry <hello@sentry.io>"]
 license = "Apache-2.0"
 readme = "README.md"
@@ -12,6 +12,6 @@ Sentry integration that adds the list of loaded libraries to events.
 edition = "2018"
 
 [dependencies]
-sentry-core = { version = "0.23.0", path = "../sentry-core" }
+sentry-core = { version = "0.24.1", path = "../sentry-core" }
 lazy_static = "1.4.0"
 findshlibs = "=0.10.2"
diff --git a/sentry-debug-images/README.md b/sentry-debug-images/README.md
@@ -6,12 +6,12 @@
 
 # Sentry Rust SDK: sentry-debug-images
 
-The Sentry Debug Images Integration.
+The Sentry Debug Images integration.
 
 The [`DebugImagesIntegration`] adds metadata about the loaded shared
 libraries to Sentry [`Event`]s.
 
-This Integration only works on Unix-like OSs right now. Support for Windows
+This Integration only works on Unix-like OSes right now. Support for Windows
 will be added in the future.
 
 ## Configuration
@@ -25,7 +25,7 @@ let integration = sentry_debug_images::DebugImagesIntegration::new()
     .filter(|event| event.level >= Level::Warning);
 ```
 
-[`Event`]: https://docs.rs/sentry-debug-images/0.21.0/sentry_debug-images/sentry_core::protocol::Event
+[`Event`]: https://docs.rs/sentry-debug-images/0.24.1/sentry_debug-images/sentry_core::protocol::Event
 
 ## Resources
 

diff --git a/sentry-log/Cargo.toml b/sentry-log/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "sentry-log"
-version = "0.23.0"
+version = "0.24.1"
 authors = ["Sentry <hello@sentry.io>"]
 license = "Apache-2.0"
 readme = "README.md"
@@ -12,7 +12,7 @@ Sentry integration for log and env_logger crates.
 edition = "2018"
 
 [dependencies]
-sentry-core = { version = "0.23.0", path = "../sentry-core" }
+sentry-core = { version = "0.24.1", path = "../sentry-core" }
 log = { version = "0.4.8", features = ["std"] }
 
 [dev-dependencies]

diff --git a/sentry-log/README.md b/sentry-log/README.md
@@ -10,7 +10,7 @@ Adds support for automatic Breadcrumb and Event capturing from logs.
 
 The `log` crate is supported in two ways. First, logs can be captured as
 breadcrumbs for later. Secondly, error logs can be captured as events to
-Sentry. By default anything above `Info` is recorded as breadcrumb and
+Sentry. By default anything above `Info` is recorded as a breadcrumb and
 anything above `Error` is captured as error event.
 
 ## Examples

diff --git a/sentry-panic/Cargo.toml b/sentry-panic/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "sentry-panic"
-version = "0.23.0"
+version = "0.24.1"
 authors = ["Sentry <hello@sentry.io>"]
 license = "Apache-2.0"
 readme = "README.md"
@@ -12,8 +12,8 @@ Sentry integration for capturing panics.
 edition = "2018"
 
 [dependencies]
-sentry-core = { version = "0.23.0", path = "../sentry-core" }
-sentry-backtrace = { version = "0.23.0", path = "../sentry-backtrace" }
+sentry-core = { version = "0.24.1", path = "../sentry-core" }
+sentry-backtrace = { version = "0.24.1", path = "../sentry-backtrace" }
 
 [dev-dependencies]
 sentry = { path = "../sentry", default-features = false, features = ["test"] }
diff --git a/sentry-panic/README.md b/sentry-panic/README.md
@@ -6,7 +6,7 @@
 
 # Sentry Rust SDK: sentry-panic
 
-The Sentry Panic handler Integration.
+The Sentry Panic handler integration.
 
 The `PanicIntegration`, which is enabled by default in `sentry`, installs a
 panic handler that will automatically dispatch all errors to Sentry that

diff --git a/sentry-slog/Cargo.toml b/sentry-slog/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "sentry-slog"
-version = "0.23.0"
+version = "0.24.1"
 authors = ["Sentry <hello@sentry.io>"]
 license = "Apache-2.0"
 readme = "README.md"
@@ -12,7 +12,7 @@ Sentry integration for the slog crate.
 edition = "2018"
 
 [dependencies]
-sentry-core = { version = "0.23.0", path = "../sentry-core" }
+sentry-core = { version = "0.24.1", path = "../sentry-core" }
 slog = { version = "2.5.2", features = ["nested-values"] }
 serde_json = "1.0.46"