You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: tracing-actix-web/README.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -85,7 +85,7 @@ fn main() {
85
85
}
86
86
```
87
87
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
89
89
application.
90
90
91
91
# 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
112
112
Those properties can then be queried in a variety of tools (e.g. ElasticSearch, Honeycomb, DataDog) to
113
113
understand what is happening in your system.
114
114
115
-
## Customisation via [`RootSpanBuilder`]
115
+
## Customization via [`RootSpanBuilder`]
116
116
117
117
Troubleshooting becomes much easier when the root span has a _rich context_ - e.g. you can understand most of what
118
118
happened when processing the request just by looking at the properties attached to the corresponding root span.
119
119
120
120
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/)
122
122
by Honeycomb and other vendors in the observability space.
123
123
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
125
125
to the root span in order to capture the context relevant to your specific domain.
@@ -138,7 +138,7 @@ We are delegating the construction of the root span to [`DefaultRootSpanBuilder`
138
138
[`DefaultRootSpanBuilder`] captures, out of the box, several dimensions that are usually relevant when looking at an HTTP
139
139
API: method, version, route, etc. - check out its documentation for an extensive list.
140
140
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.
142
142
Let's imagine, for example, that our system cares about a client identifier embedded inside an authorization header.
143
143
We could add a `client_id` property to the root span using a custom builder, `DomainRootSpanBuilder`:
144
144
@@ -199,7 +199,7 @@ We need to use a macro because `tracing` requires all the properties attached to
199
199
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
200
200
composition.
201
201
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
203
203
the span level:
204
204
205
205
```rust
@@ -313,7 +313,7 @@ You can then find all logs for the same request across all the services it touch
313
313
If you add [`tracing-opentelemetry::OpenTelemetryLayer`](https://docs.rs/tracing-opentelemetry/0.17.0/tracing_opentelemetry/struct.OpenTelemetryLayer.html)
314
314
in your `tracing::Subscriber` you will be able to export the root span (and all its children) as OpenTelemetry spans.
315
315
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.
Copy file name to clipboardExpand all lines: tracing-actix-web/src/lib.rs
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -55,7 +55,7 @@
55
55
//! });
56
56
//! ```
57
57
//!
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
59
59
//! application.
60
60
//!
61
61
//! # From zero to hero: a crash course in observability
@@ -282,7 +282,7 @@
282
282
//! If you add [`tracing-opentelemetry::OpenTelemetryLayer`](https://docs.rs/tracing-opentelemetry/0.17.0/tracing_opentelemetry/struct.OpenTelemetryLayer.html)
283
283
//! in your `tracing::Subscriber` you will be able to export the root span (and all its children) as OpenTelemetry spans.
284
284
//!
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.
0 commit comments