1
0
mirror of https://github.com/actix/actix-extras.git synced 2025-02-22 18:33:18 +01:00

Support otel 0.22 (#122)

* Support otel 0.22

* Update Cargo.toml

* Fix examples

* revert needed spaces at EOLs
This commit is contained in:
Omid Rad 2024-03-10 17:57:16 +01:00 committed by GitHub
parent 58f8c58708
commit c173c386de
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
8 changed files with 36 additions and 20 deletions

View File

@ -56,6 +56,8 @@ jobs:
- opentelemetry_0_18 - opentelemetry_0_18
- opentelemetry_0_19 - opentelemetry_0_19
- opentelemetry_0_20 - opentelemetry_0_20
- opentelemetry_0_21
- opentelemetry_0_22
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v2
- name: Cache dependencies - name: Cache dependencies

View File

@ -29,6 +29,7 @@ opentelemetry_0_18 = ["opentelemetry_0_18_pkg", "tracing-opentelemetry_0_18_pkg"
opentelemetry_0_19 = ["opentelemetry_0_19_pkg", "tracing-opentelemetry_0_19_pkg"] opentelemetry_0_19 = ["opentelemetry_0_19_pkg", "tracing-opentelemetry_0_19_pkg"]
opentelemetry_0_20 = ["opentelemetry_0_20_pkg", "tracing-opentelemetry_0_21_pkg"] opentelemetry_0_20 = ["opentelemetry_0_20_pkg", "tracing-opentelemetry_0_21_pkg"]
opentelemetry_0_21 = ["opentelemetry_0_21_pkg", "tracing-opentelemetry_0_22_pkg"] opentelemetry_0_21 = ["opentelemetry_0_21_pkg", "tracing-opentelemetry_0_22_pkg"]
opentelemetry_0_22 = ["opentelemetry_0_22_pkg", "tracing-opentelemetry_0_23_pkg"]
emit_event_on_error = [] emit_event_on_error = []
uuid_v7 = ["uuid/v7"] uuid_v7 = ["uuid/v7"]
@ -47,15 +48,17 @@ opentelemetry_0_18_pkg = { package = "opentelemetry", version = "0.18", optional
opentelemetry_0_19_pkg = { package = "opentelemetry", version = "0.19", optional = true } opentelemetry_0_19_pkg = { package = "opentelemetry", version = "0.19", optional = true }
opentelemetry_0_20_pkg = { package = "opentelemetry", version = "0.20", optional = true } opentelemetry_0_20_pkg = { package = "opentelemetry", version = "0.20", optional = true }
opentelemetry_0_21_pkg = { package = "opentelemetry", version = "0.21", optional = true } opentelemetry_0_21_pkg = { package = "opentelemetry", version = "0.21", optional = true }
tracing-opentelemetry_0_12_pkg = { package = "tracing-opentelemetry",version = "0.12", optional = true } opentelemetry_0_22_pkg = { package = "opentelemetry", version = "0.22", optional = true }
tracing-opentelemetry_0_12_pkg = { package = "tracing-opentelemetry", version = "0.12", optional = true }
tracing-opentelemetry_0_13_pkg = { package = "tracing-opentelemetry", version = "0.13", optional = true } tracing-opentelemetry_0_13_pkg = { package = "tracing-opentelemetry", version = "0.13", optional = true }
tracing-opentelemetry_0_14_pkg = { package = "tracing-opentelemetry",version = "0.14", optional = true } tracing-opentelemetry_0_14_pkg = { package = "tracing-opentelemetry", version = "0.14", optional = true }
tracing-opentelemetry_0_16_pkg = { package = "tracing-opentelemetry",version = "0.16", optional = true } tracing-opentelemetry_0_16_pkg = { package = "tracing-opentelemetry", version = "0.16", optional = true }
tracing-opentelemetry_0_17_pkg = { package = "tracing-opentelemetry",version = "0.17", optional = true } tracing-opentelemetry_0_17_pkg = { package = "tracing-opentelemetry", version = "0.17", optional = true }
tracing-opentelemetry_0_18_pkg = { package = "tracing-opentelemetry",version = "0.18", optional = true } tracing-opentelemetry_0_18_pkg = { package = "tracing-opentelemetry", version = "0.18", optional = true }
tracing-opentelemetry_0_19_pkg = { package = "tracing-opentelemetry",version = "0.19", optional = true } tracing-opentelemetry_0_19_pkg = { package = "tracing-opentelemetry", version = "0.19", optional = true }
tracing-opentelemetry_0_21_pkg = { package = "tracing-opentelemetry",version = "0.21", optional = true } tracing-opentelemetry_0_21_pkg = { package = "tracing-opentelemetry", version = "0.21", optional = true }
tracing-opentelemetry_0_22_pkg = { package = "tracing-opentelemetry",version = "0.22", optional = true } tracing-opentelemetry_0_22_pkg = { package = "tracing-opentelemetry", version = "0.22", optional = true }
tracing-opentelemetry_0_23_pkg = { package = "tracing-opentelemetry", version = "0.23", optional = true }
[dev-dependencies] [dev-dependencies]
actix-web = { version = "4", default-features = false, features = ["macros"] } actix-web = { version = "4", default-features = false, features = ["macros"] }

View File

@ -55,6 +55,7 @@ actix-web = "4"
- `opentelemetry_0_19`: same as above but using `opentelemetry` 0.19; - `opentelemetry_0_19`: same as above but using `opentelemetry` 0.19;
- `opentelemetry_0_20`: same as above but using `opentelemetry` 0.20; - `opentelemetry_0_20`: same as above but using `opentelemetry` 0.20;
- `opentelemetry_0_21`: same as above but using `opentelemetry` 0.21; - `opentelemetry_0_21`: same as above but using `opentelemetry` 0.21;
- `opentelemetry_0_22`: same as above but using `opentelemetry` 0.22;
- `emit_event_on_error`: emit a [`tracing`] event when request processing fails with an error (enabled by default). - `emit_event_on_error`: emit a [`tracing`] event when request processing fails with an error (enabled by default).
- `uuid_v7`: use the UUID v7 implementation inside [`RequestId`] instead of UUID v4 (disabled by default). - `uuid_v7`: use the UUID v7 implementation inside [`RequestId`] instead of UUID v4 (disabled by default).
## Quickstart ## Quickstart

View File

@ -8,9 +8,9 @@ edition = "2018"
[dependencies] [dependencies]
actix-web = "4" actix-web = "4"
opentelemetry = { version = "0.19", features = ["rt-tokio-current-thread"] } opentelemetry = "0.22"
opentelemetry-jaeger = { version = "0.18", features = ["rt-tokio-current-thread"] } opentelemetry-jaeger = { version = "0.21", features = ["rt-tokio-current-thread"] }
tracing-opentelemetry = { version = "0.19" } tracing-opentelemetry = { version = "0.23" }
tracing = "0.1.19" tracing = "0.1.19"
tracing-subscriber = { version = "0.3", features = ["registry", "env-filter"] } tracing-subscriber = { version = "0.3", features = ["registry", "env-filter"] }
tracing-bunyan-formatter = "0.3" tracing-bunyan-formatter = "0.3"

View File

@ -9,9 +9,9 @@ license = "MIT/Apache-2.0"
[dependencies] [dependencies]
actix-web = "4" actix-web = "4"
tracing = "0.1.19" tracing = "0.1.19"
opentelemetry = { version = "0.19", features = ["rt-tokio-current-thread"] } opentelemetry = "0.22"
opentelemetry-jaeger = { version = "0.18", features = ["rt-tokio-current-thread"] } opentelemetry-jaeger = { version = "0.21", features = ["rt-tokio-current-thread"] }
tracing-opentelemetry = { version = "0.19" } tracing-opentelemetry = { version = "0.23" }
tracing-subscriber = { version = "0.3", features = ["registry", "env-filter"] } tracing-subscriber = { version = "0.3", features = ["registry", "env-filter"] }
tracing-bunyan-formatter = "0.3" tracing-bunyan-formatter = "0.3"
tracing-actix-web = { path = "../..", features = ["opentelemetry_0_19"] } tracing-actix-web = { path = "../..", features = ["opentelemetry_0_22"] }

View File

@ -28,6 +28,7 @@
//! - `opentelemetry_0_19`: same as above but using `opentelemetry` 0.19; //! - `opentelemetry_0_19`: same as above but using `opentelemetry` 0.19;
//! - `opentelemetry_0_20`: same as above but using `opentelemetry` 0.20; //! - `opentelemetry_0_20`: same as above but using `opentelemetry` 0.20;
//! - `opentelemetry_0_21`: same as above but using `opentelemetry` 0.21; //! - `opentelemetry_0_21`: same as above but using `opentelemetry` 0.21;
//! - `opentelemetry_0_22`: same as above but using `opentelemetry` 0.22;
//! - `emit_event_on_error`: emit a [`tracing`] event when request processing fails with an error (enabled by default). //! - `emit_event_on_error`: emit a [`tracing`] event when request processing fails with an error (enabled by default).
//! - `uuid_v7`: use the UUID v7 implementation inside [`RequestId`] instead of UUID v4 (disabled by default). //! - `uuid_v7`: use the UUID v7 implementation inside [`RequestId`] instead of UUID v4 (disabled by default).
//! //!
@ -46,7 +47,7 @@
//! ``` //! ```
//! //!
//! Check out [the examples on GitHub](https://github.com/LukeMathWalker/tracing-actix-web/tree/main/examples) to get a taste of how [`TracingLogger`] can be used to observe and monitor your //! Check out [the examples on GitHub](https://github.com/LukeMathWalker/tracing-actix-web/tree/main/examples) to get a taste of how [`TracingLogger`] can be used to observe and monitor your
//! application. //! application.
//! //!
//! # From zero to hero: a crash course in observability //! # From zero to hero: a crash course in observability
//! //!
@ -70,12 +71,12 @@
//! //!
//! [`tracing`] empowers us to attach structured properties to a span as a collection of key-value pairs. //! [`tracing`] empowers us to attach structured properties to a span as a collection of key-value pairs.
//! Those properties can then be queried in a variety of tools (e.g. ElasticSearch, Honeycomb, DataDog) to //! Those properties can then be queried in a variety of tools (e.g. ElasticSearch, Honeycomb, DataDog) to
//! understand what is happening in your system. //! understand what is happening in your system.
//! //!
//! ## Customisation via [`RootSpanBuilder`] //! ## Customisation via [`RootSpanBuilder`]
//! //!
//! Troubleshooting becomes much easier when the root span has a _rich context_ - e.g. you can understand most of what //! Troubleshooting becomes much easier when the root span has a _rich context_ - e.g. you can understand most of what
//! happened when processing the request just by looking at the properties attached to the corresponding root span. //! happened when processing the request just by looking at the properties attached to the corresponding root span.
//! //!
//! You might have heard of this technique as the [canonical log line pattern](https://stripe.com/blog/canonical-log-lines), //! You might have heard of this technique as the [canonical log line pattern](https://stripe.com/blog/canonical-log-lines),
//! popularised by Stripe. It is more recently discussed in terms of [high-cardinality events](https://www.honeycomb.io/blog/observability-a-manifesto/) //! popularised by Stripe. It is more recently discussed in terms of [high-cardinality events](https://www.honeycomb.io/blog/observability-a-manifesto/)
@ -125,7 +126,7 @@
//! //!
//! There is an issue, though: `client_id` is the _only_ property we are capturing. //! There is an issue, though: `client_id` is the _only_ property we are capturing.
//! With `DomainRootSpanBuilder`, as it is, we do not get any of that useful HTTP-related information provided by //! With `DomainRootSpanBuilder`, as it is, we do not get any of that useful HTTP-related information provided by
//! [`DefaultRootSpanBuilder`]. //! [`DefaultRootSpanBuilder`].
//! //!
//! We can do better! //! We can do better!
//! //!
@ -153,7 +154,7 @@
//! ``` //! ```
//! //!
//! [`root_span!`] is a macro provided by `tracing-actix-web`: it creates a new span by combining all the HTTP properties tracked //! [`root_span!`] is a macro provided by `tracing-actix-web`: it creates a new span by combining all the HTTP properties tracked
//! by [`DefaultRootSpanBuilder`] with the custom ones you specify when calling it (e.g. `client_id` in our example). //! by [`DefaultRootSpanBuilder`] with the custom ones you specify when calling it (e.g. `client_id` in our example).
//! //!
//! We need to use a macro because `tracing` requires all the properties attached to a span to be declared upfront, when the span is created. //! We need to use a macro because `tracing` requires all the properties attached to a span to be declared upfront, when the span is created.
//! You cannot add new ones afterwards. This makes it extremely fast, but it pushes us to reach for macros when we need some level of //! You cannot add new ones afterwards. This makes it extremely fast, but it pushes us to reach for macros when we need some level of
@ -303,6 +304,7 @@ mutually_exclusive_features::none_or_one_of!(
"opentelemetry_0_19", "opentelemetry_0_19",
"opentelemetry_0_20", "opentelemetry_0_20",
"opentelemetry_0_21", "opentelemetry_0_21",
"opentelemetry_0_22",
); );
#[cfg(any( #[cfg(any(
@ -315,5 +317,6 @@ mutually_exclusive_features::none_or_one_of!(
feature = "opentelemetry_0_19", feature = "opentelemetry_0_19",
feature = "opentelemetry_0_20", feature = "opentelemetry_0_20",
feature = "opentelemetry_0_21", feature = "opentelemetry_0_21",
feature = "opentelemetry_0_22",
))] ))]
mod otel; mod otel;

View File

@ -18,6 +18,8 @@ use opentelemetry_0_19_pkg as opentelemetry;
use opentelemetry_0_20_pkg as opentelemetry; use opentelemetry_0_20_pkg as opentelemetry;
#[cfg(feature = "opentelemetry_0_21")] #[cfg(feature = "opentelemetry_0_21")]
use opentelemetry_0_21_pkg as opentelemetry; use opentelemetry_0_21_pkg as opentelemetry;
#[cfg(feature = "opentelemetry_0_22")]
use opentelemetry_0_22_pkg as opentelemetry;
#[cfg(feature = "opentelemetry_0_13")] #[cfg(feature = "opentelemetry_0_13")]
use tracing_opentelemetry_0_12_pkg as tracing_opentelemetry; use tracing_opentelemetry_0_12_pkg as tracing_opentelemetry;
@ -37,6 +39,8 @@ use tracing_opentelemetry_0_19_pkg as tracing_opentelemetry;
use tracing_opentelemetry_0_21_pkg as tracing_opentelemetry; use tracing_opentelemetry_0_21_pkg as tracing_opentelemetry;
#[cfg(feature = "opentelemetry_0_21")] #[cfg(feature = "opentelemetry_0_21")]
use tracing_opentelemetry_0_22_pkg as tracing_opentelemetry; use tracing_opentelemetry_0_22_pkg as tracing_opentelemetry;
#[cfg(feature = "opentelemetry_0_22")]
use tracing_opentelemetry_0_23_pkg as tracing_opentelemetry;
use opentelemetry::propagation::Extractor; use opentelemetry::propagation::Extractor;
@ -76,6 +80,7 @@ pub(crate) fn set_otel_parent(req: &ServiceRequest, span: &tracing::Span) {
feature = "opentelemetry_0_19", feature = "opentelemetry_0_19",
feature = "opentelemetry_0_20", feature = "opentelemetry_0_20",
feature = "opentelemetry_0_21", feature = "opentelemetry_0_21",
feature = "opentelemetry_0_22",
)))] )))]
let trace_id = span.context().span().span_context().trace_id().to_hex(); let trace_id = span.context().span().span_context().trace_id().to_hex();
@ -85,6 +90,7 @@ pub(crate) fn set_otel_parent(req: &ServiceRequest, span: &tracing::Span) {
feature = "opentelemetry_0_19", feature = "opentelemetry_0_19",
feature = "opentelemetry_0_20", feature = "opentelemetry_0_20",
feature = "opentelemetry_0_21", feature = "opentelemetry_0_21",
feature = "opentelemetry_0_22",
))] ))]
let trace_id = { let trace_id = {
let id = span.context().span().span_context().trace_id(); let id = span.context().span().span_context().trace_id();

View File

@ -165,6 +165,7 @@ pub mod private {
feature = "opentelemetry_0_19", feature = "opentelemetry_0_19",
feature = "opentelemetry_0_20", feature = "opentelemetry_0_20",
feature = "opentelemetry_0_21", feature = "opentelemetry_0_21",
feature = "opentelemetry_0_22",
))] ))]
crate::otel::set_otel_parent(req, span); crate::otel::set_otel_parent(req, span);
} }