Skip to content

Commit 54de957

Browse files
committed
📝 update doc for 0.4
1 parent d0337ef commit 54de957

File tree

2 files changed

+22
-15
lines changed

2 files changed

+22
-15
lines changed

README.md

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,20 +19,19 @@ For examples, you can look at:
1919
```rust
2020
//...
2121
use axum_tracing_opentelemetry::opentelemetry_tracing_layer;
22-
use axum_tracing_opentelemetry::{
23-
// optional tools to init tracer (may require features)
24-
init_tracer,
25-
make_resource,
26-
CollectorKind,
27-
};
2822

2923
fn init_tracing() {
30-
31-
let otel_tracer = init_tracer(
32-
CollectorKind::Otlp,
33-
make_resource(env!("CARGO_PKG_NAME"), env!("CARGO_PKG_VERSION")),
34-
)
35-
.expect("setup of Tracer");
24+
use axum_tracing_opentelemetry::{
25+
make_resource,
26+
otlp,
27+
//stdio,
28+
};
29+
30+
let otel_rsrc = make_resource(env!("CARGO_PKG_NAME"), env!("CARGO_PKG_VERSION"));
31+
let otel_tracer = otlp::init_tracer(otel_rsrc, otlp::identity).expect("setup of Tracer");
32+
// let otel_tracer =
33+
// stdio::init_tracer(otel_rsrc, stdio::identity, stdio::WriteNoWhere::default())
34+
// .expect("setup of Tracer");
3635
let otel_layer = tracing_opentelemetry::layer().with_tracer(otel_tracer);
3736

3837
let subscriber = tracing_subscriber::registry()
@@ -58,9 +57,10 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
5857
fn app() -> Router {
5958
// build our application with a route
6059
Router::new()
61-
.route("/health", get(health))
60+
.route("/", get(health)) // request processed inside span
6261
// opentelemetry_tracing_layer setup `TraceLayer`, that is provided by tower-http so you have to add that as a dependency.
6362
.layer(opentelemetry_tracing_layer())
63+
.route("/health", get(health)) // request processed without span / trace
6464
}
6565

6666
async fn shutdown_signal() {
@@ -78,6 +78,13 @@ To retrieve the current `trace_id` (eg to add it into error message (as header o
7878

7979
## History
8080

81+
### 0.4
82+
83+
- allow customization of tracer
84+
- add tracer to export on stdout or stderr
85+
- add tracer to export to nowhere (like `/dev/null`) to allow to have trace_id
86+
and the opentelemetry span & metadata on log and http response (without collector)
87+
8188
### 0.3
8289

8390
- Allow customization of exporter pipeline

examples/oltp/src/main.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,11 +55,11 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
5555
fn app() -> Router {
5656
// build our application with a route
5757
Router::new()
58-
.route("/", get(health))
58+
.route("/", get(health)) // request processed inside span
5959
// opentelemetry_tracing_layer setup `TraceLayer`,
6060
// that is provided by tower-http so you have to add that as a dependency.
6161
.layer(opentelemetry_tracing_layer())
62-
.route("/health", get(health))
62+
.route("/health", get(health)) // request processed without span / trace
6363
}
6464

6565
async fn health() -> impl IntoResponse {

0 commit comments

Comments
 (0)