Skip to content

Commit 5556577

Browse files
authored
chore(tracing): prepare v0.7.21 release (#644)
1 parent 5679f09 commit 5556577

File tree

7 files changed

+18
-105
lines changed

7 files changed

+18
-105
lines changed

Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

tracing-actix-web/.github/workflows/general.yml

Lines changed: 0 additions & 90 deletions
This file was deleted.

tracing-actix-web/.gitignore

Lines changed: 0 additions & 3 deletions
This file was deleted.

tracing-actix-web/CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,10 @@
22

33
## Unreleased
44

5+
## 0.7.21
6+
7+
- The repository has been moved under the [actix](https://github.com/actix/actix-extras) organization. The future development will happen there.
8+
9+
## 0.7.20
10+
511
- Support Opentelemetry 0.31

tracing-actix-web/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "tracing-actix-web"
3-
version = "0.7.19"
3+
version = "0.7.21"
44
authors = ["Luca Palmieri <rust@lpalmieri.com>"]
55
documentation = "https://docs.rs/tracing-actix-web/"
66
readme = "README.md"

tracing-actix-web/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ fn main() {
8585
}
8686
```
8787

88-
Check out [the examples on GitHub](https://github.com/actix/tracing-actix-web/tree/main/examples) to get a taste of how [`TracingLogger`] can be used to observe and monitor your
88+
Check out [the examples on GitHub](https://github.com/actix/actix-extras/tree/main/tracing-actix-web/examples) to get a taste of how [`TracingLogger`] can be used to observe and monitor your
8989
application.
9090

9191
# From zero to hero: a crash course in observability
@@ -112,24 +112,24 @@ All the spans created _while_ processing the request will be children of the roo
112112
Those properties can then be queried in a variety of tools (e.g. ElasticSearch, Honeycomb, DataDog) to
113113
understand what is happening in your system.
114114

115-
## Customisation via [`RootSpanBuilder`]
115+
## Customization via [`RootSpanBuilder`]
116116

117117
Troubleshooting becomes much easier when the root span has a _rich context_ - e.g. you can understand most of what
118118
happened when processing the request just by looking at the properties attached to the corresponding root span.
119119

120120
You might have heard of this technique as the [canonical log line pattern](https://stripe.com/blog/canonical-log-lines),
121-
popularised by Stripe. It is more recently discussed in terms of [high-cardinality events](https://www.honeycomb.io/blog/observability-a-manifesto/)
121+
popularized by Stripe. It is more recently discussed in terms of [high-cardinality events](https://www.honeycomb.io/blog/observability-a-manifesto/)
122122
by Honeycomb and other vendors in the observability space.
123123

124-
[`TracingLogger`] gives you a chance to use the very same pattern: you can customise the properties attached
124+
[`TracingLogger`] gives you a chance to use the very same pattern: you can customize the properties attached
125125
to the root span in order to capture the context relevant to your specific domain.
126126

127127
[`TracingLogger::default`] is equivalent to:
128128

129129
```rust
130130
use tracing_actix_web::{TracingLogger, DefaultRootSpanBuilder};
131131

132-
// Two ways to initialise TracingLogger with the default root span builder
132+
// Two ways to initialize TracingLogger with the default root span builder
133133
let default = TracingLogger::default();
134134
let another_way = TracingLogger::<DefaultRootSpanBuilder>::new();
135135
```
@@ -138,7 +138,7 @@ We are delegating the construction of the root span to [`DefaultRootSpanBuilder`
138138
[`DefaultRootSpanBuilder`] captures, out of the box, several dimensions that are usually relevant when looking at an HTTP
139139
API: method, version, route, etc. - check out its documentation for an extensive list.
140140

141-
You can customise the root span by providing your own implementation of the [`RootSpanBuilder`] trait.
141+
You can customize the root span by providing your own implementation of the [`RootSpanBuilder`] trait.
142142
Let's imagine, for example, that our system cares about a client identifier embedded inside an authorization header.
143143
We could add a `client_id` property to the root span using a custom builder, `DomainRootSpanBuilder`:
144144

@@ -199,7 +199,7 @@ We need to use a macro because `tracing` requires all the properties attached to
199199
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
200200
composition.
201201

202-
[`root_span!`] exposes more or less the same knob you can find on `tracing`'s `span!` macro. You can, for example, customise
202+
[`root_span!`] exposes more or less the same knob you can find on `tracing`'s `span!` macro. You can, for example, customize
203203
the span level:
204204

205205
```rust
@@ -313,7 +313,7 @@ You can then find all logs for the same request across all the services it touch
313313
If you add [`tracing-opentelemetry::OpenTelemetryLayer`](https://docs.rs/tracing-opentelemetry/0.17.0/tracing_opentelemetry/struct.OpenTelemetryLayer.html)
314314
in your `tracing::Subscriber` you will be able to export the root span (and all its children) as OpenTelemetry spans.
315315

316-
Check out the [relevant example in the GitHub repository](https://github.com/actix/tracing-actix-web/tree/main/examples/opentelemetry) for reference.
316+
Check out the [relevant example in the GitHub repository](https://github.com/actix/actix-extras/tree/main/tracing-actix-web/examples/opentelemetry) for reference.
317317

318318
# License
319319

tracing-actix-web/src/lib.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
//! });
5656
//! ```
5757
//!
58-
//! Check out [the examples on GitHub](https://github.com/actix/tracing-actix-web/tree/main/examples) to get a taste of how [`TracingLogger`] can be used to observe and monitor your
58+
//! Check out [the examples on GitHub](https://github.com/actix/actix-extras/tree/main/tracing-actix-web/examples) to get a taste of how [`TracingLogger`] can be used to observe and monitor your
5959
//! application.
6060
//!
6161
//! # From zero to hero: a crash course in observability
@@ -282,7 +282,7 @@
282282
//! If you add [`tracing-opentelemetry::OpenTelemetryLayer`](https://docs.rs/tracing-opentelemetry/0.17.0/tracing_opentelemetry/struct.OpenTelemetryLayer.html)
283283
//! in your `tracing::Subscriber` you will be able to export the root span (and all its children) as OpenTelemetry spans.
284284
//!
285-
//! Check out the [relevant example in the GitHub repository](https://github.com/actix/tracing-actix-web/tree/main/examples/opentelemetry) for reference.
285+
//! Check out the [relevant example in the GitHub repository](https://github.com/actix/actix-extras/tree/main/tracing-actix-web/examples/opentelemetry) for reference.
286286
//!
287287
//! [root span]: crate::RootSpan
288288
//! [`actix-web`]: https://docs.rs/actix-web/4.0.0-beta.13/actix_web/index.html

0 commit comments

Comments
 (0)