release: 0.28.0

getsentry-bot · getsentry-bot · commit dc048f5d2d2c · 2022-11-04T14:12:48.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,6 @@
 # Changelog
 
-## Unreleased
+## 0.28.0
 
 **Breaking Changes**:
 
diff --git a/sentry-actix/Cargo.toml b/sentry-actix/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "sentry-actix"
-version = "0.27.0"
+version = "0.28.0"
 authors = ["Sentry <hello@sentry.io>"]
 license = "Apache-2.0"
 readme = "README.md"
@@ -15,7 +15,7 @@ rust-version = "1.60"
 [dependencies]
 actix-web = { version = "4", default-features = false }
 futures-util = { version = "0.3.5", default-features = false }
-sentry-core = { version = "0.27.0", path = "../sentry-core", default-features = false, features = ["client"] }
+sentry-core = { version = "0.28.0", path = "../sentry-core", default-features = false, features = ["client"] }
 
 [dev-dependencies]
 actix-web = { version = "4" }
diff --git a/sentry-anyhow/Cargo.toml b/sentry-anyhow/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "sentry-anyhow"
-version = "0.27.0"
+version = "0.28.0"
 authors = ["Sentry <hello@sentry.io>"]
 license = "Apache-2.0"
 readme = "README.md"
@@ -17,8 +17,8 @@ default = ["backtrace"]
 backtrace = ["anyhow/backtrace"]
 
 [dependencies]
-sentry-backtrace = { version = "0.27.0", path = "../sentry-backtrace" }
-sentry-core = { version = "0.27.0", path = "../sentry-core" }
+sentry-backtrace = { version = "0.28.0", path = "../sentry-backtrace" }
+sentry-core = { version = "0.28.0", path = "../sentry-core" }
 anyhow = "1.0.39"
 
 [dev-dependencies]
diff --git a/sentry-backtrace/Cargo.toml b/sentry-backtrace/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "sentry-backtrace"
-version = "0.27.0"
+version = "0.28.0"
 authors = ["Sentry <hello@sentry.io>"]
 license = "Apache-2.0"
 readme = "README.md"
@@ -16,4 +16,4 @@ rust-version = "1.60"
 backtrace = "0.3.44"
 once_cell = "1"
 regex = "1.5.5"
-sentry-core = { version = "0.27.0", path = "../sentry-core" }
+sentry-core = { version = "0.28.0", path = "../sentry-core" }
diff --git a/sentry-contexts/Cargo.toml b/sentry-contexts/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "sentry-contexts"
-version = "0.27.0"
+version = "0.28.0"
 authors = ["Sentry <hello@sentry.io>"]
 license = "Apache-2.0"
 readme = "README.md"
@@ -14,7 +14,7 @@ edition = "2021"
 rust-version = "1.60"
 
 [dependencies]
-sentry-core = { version = "0.27.0", path = "../sentry-core" }
+sentry-core = { version = "0.28.0", path = "../sentry-core" }
 libc = "0.2.66"
 hostname = "0.3.0"
 
diff --git a/sentry-core/Cargo.toml b/sentry-core/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "sentry-core"
-version = "0.27.0"
+version = "0.28.0"
 authors = ["Sentry <hello@sentry.io>"]
 license = "Apache-2.0"
 readme = "README.md"
@@ -33,7 +33,7 @@ frame-pointer = ["pprof?/frame-pointer"]
 log = { version = "0.4.8", optional = true, features = ["std"] }
 once_cell = "1"
 rand = { version = "0.8.1", optional = true }
-sentry-types = { version = "0.27.0", path = "../sentry-types" }
+sentry-types = { version = "0.28.0", path = "../sentry-types" }
 serde = { version = "1.0.104", features = ["derive"] }
 serde_json = { version = "1.0.46" }
 uuid = { version = "1.0.0", features = ["v4", "serde"], optional = true }
diff --git a/sentry-core/README.md b/sentry-core/README.md
@@ -22,6 +22,62 @@ This crate follows the [Unified API] guidelines and is centered around
 the concepts of [`Client`], [`Hub`] and [`Scope`], as well as the extension
 points via the [`Integration`], [`Transport`] and [`TransportFactory`] traits.
 
+## Parallelism, Concurrency and Async
+
+The main concurrency primitive is the [`Hub`]. In general, all concurrent
+code, no matter if multithreaded parallelism or futures concurrency, needs
+to run with its own copy of a [`Hub`]. Even though the [`Hub`] is internally
+synchronized, using it concurrently may lead to unexpected results up to
+panics.
+
+For threads or tasks that are running concurrently or outlive the current
+execution context, a new [`Hub`] needs to be created and bound for the computation.
+
+```rust
+use rayon::prelude::*;
+use sentry::{Hub, SentryFutureExt};
+use std::sync::Arc;
+
+// Parallel multithreaded code:
+let outer_hub = Hub::current();
+let results: Vec<_> = [1_u32, 2, 3]
+    .into_par_iter()
+    .map(|num| {
+        let thread_hub = Arc::new(Hub::new_from_top(&outer_hub));
+        Hub::run(thread_hub, || num * num)
+    })
+    .collect();
+
+assert_eq!(&results, &[1, 4, 9]);
+
+// Concurrent futures code:
+let futures = [1_u32, 2, 3]
+    .into_iter()
+    .map(|num| async move { num * num }.bind_hub(Hub::new_from_top(Hub::current())));
+let results = futures::future::join_all(futures).await;
+
+assert_eq!(&results, &[1, 4, 9]);
+```
+
+For tasks that are not concurrent and do not outlive the current execution
+context, no *new* [`Hub`] needs to be created, but the current [`Hub`] has
+to be bound.
+
+```rust
+use sentry::{Hub, SentryFutureExt};
+
+// Spawned thread that is being joined:
+let hub = Hub::current();
+let result = std::thread::spawn(|| Hub::run(hub, || 1_u32)).join();
+
+assert_eq!(result.unwrap(), 1);
+
+// Spawned future that is being awaited:
+let result = tokio::spawn(async { 1_u32 }.bind_hub(Hub::current())).await;
+
+assert_eq!(result.unwrap(), 1);
+```
+
 ## Minimal API
 
 By default, this crate comes with a so-called "minimal" mode. This mode will
@@ -46,13 +102,7 @@ functionality.
 [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.27.0/sentry_core/struct.Client.html
-[`Hub`]: https://docs.rs/sentry-core/0.27.0/sentry_core/struct.Hub.html
-[`Scope`]: https://docs.rs/sentry-core/0.27.0/sentry_core/struct.Scope.html
-[`Integration`]: https://docs.rs/sentry-core/0.27.0/sentry_core/trait.Integration.html
-[`Transport`]: https://docs.rs/sentry-core/0.27.0/sentry_core/trait.Transport.html
-[`TransportFactory`]: https://docs.rs/sentry-core/0.27.0/sentry_core/trait.TransportFactory.html
-[`test`]: https://docs.rs/sentry-core/0.27.0/sentry_core/test/index.html
+[`test`]: https://docs.rs/sentry-core/0.28.0/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.27.0"
+version = "0.28.0"
 authors = ["Sentry <hello@sentry.io>"]
 license = "Apache-2.0"
 readme = "README.md"
@@ -15,4 +15,4 @@ rust-version = "1.60"
 [dependencies]
 findshlibs = "=0.10.2"
 once_cell = "1"
-sentry-core = { version = "0.27.0", path = "../sentry-core" }
+sentry-core = { version = "0.28.0", path = "../sentry-core" }
diff --git a/sentry-debug-images/README.md b/sentry-debug-images/README.md
@@ -22,7 +22,7 @@ let integration = sentry_debug_images::DebugImagesIntegration::new()
     .filter(|event| event.level >= Level::Warning);
 ```
 
-[`Event`]: https://docs.rs/sentry-debug-images/0.27.0/sentry_debug-images/sentry_core::protocol::Event
+[`Event`]: https://docs.rs/sentry-debug-images/0.28.0/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.27.0"
+version = "0.28.0"
 authors = ["Sentry <hello@sentry.io>"]
 license = "Apache-2.0"
 readme = "README.md"
@@ -13,7 +13,7 @@ edition = "2021"
 rust-version = "1.60"
 
 [dependencies]
-sentry-core = { version = "0.27.0", path = "../sentry-core" }
+sentry-core = { version = "0.28.0", path = "../sentry-core" }
 log = { version = "0.4.8", features = ["std"] }
 
 [dev-dependencies]
diff --git a/sentry-panic/Cargo.toml b/sentry-panic/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "sentry-panic"
-version = "0.27.0"
+version = "0.28.0"
 authors = ["Sentry <hello@sentry.io>"]
 license = "Apache-2.0"
 readme = "README.md"
@@ -13,8 +13,8 @@ edition = "2021"
 rust-version = "1.60"
 
 [dependencies]
-sentry-core = { version = "0.27.0", path = "../sentry-core" }
-sentry-backtrace = { version = "0.27.0", path = "../sentry-backtrace" }
+sentry-core = { version = "0.28.0", path = "../sentry-core" }
+sentry-backtrace = { version = "0.28.0", path = "../sentry-backtrace" }
 
 [dev-dependencies]
 sentry = { path = "../sentry", default-features = false, features = ["test"] }
diff --git a/sentry-slog/Cargo.toml b/sentry-slog/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "sentry-slog"
-version = "0.27.0"
+version = "0.28.0"
 authors = ["Sentry <hello@sentry.io>"]
 license = "Apache-2.0"
 readme = "README.md"
@@ -13,7 +13,7 @@ edition = "2021"
 rust-version = "1.60"
 
 [dependencies]
-sentry-core = { version = "0.27.0", path = "../sentry-core" }
+sentry-core = { version = "0.28.0", path = "../sentry-core" }
 slog = { version = "2.5.2", features = ["nested-values"] }
 serde_json = "1.0.46"
 
diff --git a/sentry-tower/Cargo.toml b/sentry-tower/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "sentry-tower"
-version = "0.27.0"
+version = "0.28.0"
 authors = ["Sentry <hello@sentry.io>"]
 license = "Apache-2.0"
 readme = "README.md"
@@ -20,7 +20,7 @@ tower-layer = "0.3"
 tower-service = "0.3"
 http = { version = "0.2.6", optional = true }
 pin-project = { version = "1.0.10", optional = true }
-sentry-core = { version = "0.27.0", path = "../sentry-core", default-features = false, features = ["client"] }
+sentry-core = { version = "0.28.0", path = "../sentry-core", default-features = false, features = ["client"] }
 url = { version = "2.2.2", optional = true }
 
 [dev-dependencies]
diff --git a/sentry-tower/README.md b/sentry-tower/README.md
@@ -101,7 +101,7 @@ transaction based on the incoming HTTP headers.
 The created transaction will automatically use the request URI as its name.
 This is sometimes not desirable in case the request URI contains unique IDs
 or similar. In this case, users should manually override the transaction name
-in the request handler using the [`Scope::set_transaction`](https://docs.rs/sentry-tower/0.27.0/sentry_tower/sentry_core::Scope::set_transaction)
+in the request handler using the [`Scope::set_transaction`](https://docs.rs/sentry-tower/0.28.0/sentry_tower/sentry_core::Scope::set_transaction)
 method.
 
 When combining both layers, take care of the ordering of both. For example
diff --git a/sentry-tracing/Cargo.toml b/sentry-tracing/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "sentry-tracing"
-version = "0.27.0"
+version = "0.28.0"
 authors = ["Sentry <hello@sentry.io>"]
 license = "Apache-2.0"
 readme = "README.md"
@@ -13,7 +13,7 @@ edition = "2021"
 rust-version = "1.60"
 
 [dependencies]
-sentry-core = { version = "0.27.0", path = "../sentry-core", features = ["client"] }
+sentry-core = { version = "0.28.0", path = "../sentry-core", features = ["client"] }
 tracing-core = "0.1"
 tracing-subscriber = { version = "0.3.1", default-features = false, features = ["std"] }
 
diff --git a/sentry-types/Cargo.toml b/sentry-types/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "sentry-types"
-version = "0.27.0"
+version = "0.28.0"
 authors = ["Sentry <hello@sentry.io>"]
 license = "Apache-2.0"
 readme = "README.md"
diff --git a/sentry/Cargo.toml b/sentry/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "sentry"
-version = "0.27.0"
+version = "0.28.0"
 authors = ["Sentry <hello@sentry.io>"]
 license = "Apache-2.0"
 readme = "README.md"
@@ -52,16 +52,16 @@ native-tls = ["dep:native-tls", "reqwest?/default-tls", "ureq?/native-tls"]
 rustls =     ["dep:rustls",     "reqwest?/rustls-tls",  "ureq?/tls",        "webpki-roots"]
 
 [dependencies]
-sentry-core = { version = "0.27.0", path = "../sentry-core", features = ["client"] }
-sentry-anyhow = { version = "0.27.0", path = "../sentry-anyhow", optional = true }
-sentry-backtrace = { version = "0.27.0", path = "../sentry-backtrace", optional = true }
-sentry-contexts = { version = "0.27.0", path = "../sentry-contexts", optional = true }
-sentry-debug-images = { version = "0.27.0", path = "../sentry-debug-images", optional = true }
-sentry-log = { version = "0.27.0", path = "../sentry-log", optional = true }
-sentry-panic = { version = "0.27.0", path = "../sentry-panic", optional = true }
-sentry-slog = { version = "0.27.0", path = "../sentry-slog", optional = true }
-sentry-tower = { version = "0.27.0", path = "../sentry-tower", optional = true }
-sentry-tracing = { version = "0.27.0", path = "../sentry-tracing", optional = true }
+sentry-core = { version = "0.28.0", path = "../sentry-core", features = ["client"] }
+sentry-anyhow = { version = "0.28.0", path = "../sentry-anyhow", optional = true }
+sentry-backtrace = { version = "0.28.0", path = "../sentry-backtrace", optional = true }
+sentry-contexts = { version = "0.28.0", path = "../sentry-contexts", optional = true }
+sentry-debug-images = { version = "0.28.0", path = "../sentry-debug-images", optional = true }
+sentry-log = { version = "0.28.0", path = "../sentry-log", optional = true }
+sentry-panic = { version = "0.28.0", path = "../sentry-panic", optional = true }
+sentry-slog = { version = "0.28.0", path = "../sentry-slog", optional = true }
+sentry-tower = { version = "0.28.0", path = "../sentry-tower", optional = true }
+sentry-tracing = { version = "0.28.0", path = "../sentry-tracing", optional = true }
 log = { version = "0.4.8", optional = true, features = ["std"] }
 reqwest = { version = "0.11", optional = true, features = ["blocking", "json"], default-features = false }
 curl = { version = "0.4.25", optional = true }
diff --git a/sentry/README.md b/sentry/README.md
@@ -16,7 +16,8 @@ system in Rust as well as a few popular error handling setups.
 
 The most convenient way to use this library is via the [`sentry::init`] function,
 which starts a sentry client with a default set of integrations, and binds
-it to the current [`Hub`].
+it to the current [`Hub`]. More Information on how to use Sentry in parallel,
+concurrent and async scenarios can be found on the [`Hub`] docs as well.
 
 The [`sentry::init`] function returns a guard that when dropped will flush Events that were not
 yet sent to the sentry service. It has a two second deadline for this so shutdown of
@@ -33,8 +34,8 @@ sentry::capture_message("Hello World!", sentry::Level::Info);
 More complex examples on how to use sentry can also be found in [examples]. Extended instructions
 may also be found on [Sentry itself].
 
-[`sentry::init`]: https://docs.rs/sentry/0.27.0/sentry/fn.init.html
-[`Hub`]: https://docs.rs/sentry/0.27.0/sentry/struct.Hub.html
+[`sentry::init`]: https://docs.rs/sentry/0.28.0/sentry/fn.init.html
+[`Hub`]: https://docs.rs/sentry/0.28.0/sentry/struct.Hub.html
 [examples]: https://github.com/getsentry/sentry-rust/tree/master/sentry/examples
 [Sentry itself]: https://docs.sentry.io/platforms/rust
 
@@ -46,17 +47,17 @@ the ecosystem require a feature flag. For available integrations and how to use
 [integrations] and [apply_defaults].
 
 [Features]: #features
-[integrations]: https://docs.rs/sentry/0.27.0/sentry/integrations/index.html
-[apply_defaults]: https://docs.rs/sentry/0.27.0/sentry/fn.apply_defaults.html
+[integrations]: https://docs.rs/sentry/0.28.0/sentry/integrations/index.html
+[apply_defaults]: https://docs.rs/sentry/0.28.0/sentry/fn.apply_defaults.html
 
 ## Minimal API
 
 This crate comes fully-featured. If the goal is to instrument libraries for usage
 with sentry, or to extend sentry with a custom [`Integration`] or a [`Transport`],
 one should use the [`sentry-core`] crate instead.
 
-[`Integration`]: https://docs.rs/sentry/0.27.0/sentry/trait.Integration.html
-[`Transport`]: https://docs.rs/sentry/0.27.0/sentry/trait.Transport.html
+[`Integration`]: https://docs.rs/sentry/0.28.0/sentry/trait.Integration.html
+[`Transport`]: https://docs.rs/sentry/0.28.0/sentry/trait.Transport.html
 [`sentry-core`]: https://crates.io/crates/sentry-core
 
 ## Features
