Skip to content

Commit e3a005b

Browse files
cijothomascijothomas
authored
Merge branch 'main' into cijothomas/ci-example
2 parents 8ea7553 + edb0d58 commit e3a005b

File tree

8 files changed

+152
-24
lines changed

8 files changed

+152
-24
lines changed

‎examples/tracing-grpc/Cargo.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ opentelemetry_sdk = { path = "../../opentelemetry-sdk", features = ["rt-tokio"]
1919
opentelemetry-stdout = { workspace = true, features = ["trace"] }
2020
prost = { workspace = true }
2121
tokio = { workspace = true, features = ["full"] }
22-
tonic = { workspace = true, features = ["server"] }
22+
tonic = { workspace = true, features = ["server", "codegen", "channel", "prost"] }
2323

2424
[build-dependencies]
2525
tonic-build = { workspace = true }

‎examples/tracing-grpc/src/client.rs‎

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ fn init_tracer() -> sdktrace::SdkTracerProvider {
1313
global::set_text_map_propagator(TraceContextPropagator::new());
1414
// Install stdout exporter pipeline to be able to retrieve the collected spans.
1515
let provider = sdktrace::SdkTracerProvider::builder()
16-
.with_batch_exporter(SpanExporter::default())
16+
.with_simple_exporter(SpanExporter::default())
1717
.build();
1818

1919
global::set_tracer_provider(provider.clone());
@@ -43,10 +43,14 @@ async fn greet() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static
4343
let span = tracer
4444
.span_builder("Greeter/client")
4545
.with_kind(SpanKind::Client)
46-
.with_attributes([KeyValue::new("component", "grpc")])
46+
.with_attributes([
47+
KeyValue::new("rpc.system", "grpc"),
48+
KeyValue::new("server.port", 50052),
49+
KeyValue::new("rpc.method", "say_hello"),
50+
])
4751
.start(&tracer);
4852
let cx = Context::current_with_span(span);
49-
let mut client = GreeterClient::connect("http://[::1]:50051").await?;
53+
let mut client = GreeterClient::connect("http://[::1]:50052").await?;
5054

5155
let mut request = tonic::Request::new(HelloRequest {
5256
name: "Tonic".into(),
@@ -58,16 +62,23 @@ async fn greet() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static
5862

5963
let response = client.say_hello(request).await;
6064

65+
let span = cx.span();
6166
let status = match response {
62-
Ok(_res) => "OK".to_string(),
67+
Ok(_res) => {
68+
span.set_attribute(KeyValue::new("response", "OK"));
69+
"OK".to_string()
70+
}
6371
Err(status) => {
6472
// Access the status code
6573
let status_code = status.code();
74+
span.set_attribute(KeyValue::new(
75+
"response_code_desc",
76+
status_code.description(),
77+
));
6678
status_code.to_string()
6779
}
6880
};
69-
cx.span()
70-
.add_event("Got response!", vec![KeyValue::new("status", status)]);
81+
span.add_event("Got response!", vec![KeyValue::new("status", status)]);
7182

7283
Ok(())
7384
}

‎examples/tracing-grpc/src/server.rs‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
use hello_world::greeter_server::{Greeter, GreeterServer};
22
use hello_world::{HelloReply, HelloRequest};
3+
use opentelemetry::KeyValue;
34
use opentelemetry::{
45
global,
56
propagation::Extractor,
@@ -13,7 +14,7 @@ fn init_tracer() -> SdkTracerProvider {
1314
global::set_text_map_propagator(TraceContextPropagator::new());
1415
// Install stdout exporter pipeline to be able to retrieve the collected spans.
1516
let provider = SdkTracerProvider::builder()
16-
.with_batch_exporter(SpanExporter::default())
17+
.with_simple_exporter(SpanExporter::default())
1718
.build();
1819

1920
global::set_tracer_provider(provider.clone());
@@ -65,6 +66,11 @@ impl Greeter for MyGreeter {
6566
let mut span = tracer
6667
.span_builder("Greeter/server")
6768
.with_kind(SpanKind::Server)
69+
.with_attributes([
70+
KeyValue::new("rpc.system", "grpc"),
71+
KeyValue::new("server.port", 50052),
72+
KeyValue::new("rpc.method", "say_hello"),
73+
])
6874
.start_with_context(&tracer, &parent_cx);
6975

7076
let name = request.into_inner().name;
@@ -83,7 +89,7 @@ impl Greeter for MyGreeter {
8389
async fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
8490
let provider = init_tracer();
8591

86-
let addr = "[::1]:50051".parse()?;
92+
let addr = "[::1]:50052".parse()?;
8793
let greeter = MyGreeter::default();
8894

8995
Server::builder()

‎examples/tracing-http-propagator/src/server.rs‎

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,22 @@ use http_body_util::{combinators::BoxBody, BodyExt, Full};
22
use hyper::{body::Incoming, service::service_fn, Request, Response, StatusCode};
33
use hyper_util::rt::{TokioExecutor, TokioIo};
44
use opentelemetry::{
5-
global,
5+
global::{self, BoxedTracer},
66
trace::{FutureExt, Span, SpanKind, TraceContextExt, Tracer},
77
Context, KeyValue,
88
};
99
use opentelemetry_http::{Bytes, HeaderExtractor};
1010
use opentelemetry_sdk::{propagation::TraceContextPropagator, trace::SdkTracerProvider};
1111
use opentelemetry_semantic_conventions::trace;
1212
use opentelemetry_stdout::SpanExporter;
13-
use std::{convert::Infallible, net::SocketAddr};
13+
use std::{convert::Infallible, net::SocketAddr, sync::OnceLock};
1414
use tokio::net::TcpListener;
1515

16+
fn get_tracer() -> &'static BoxedTracer {
17+
static TRACER: OnceLock<BoxedTracer> = OnceLock::new();
18+
TRACER.get_or_init(|| global::tracer("example/server"))
19+
}
20+
1621
// Utility function to extract the context from the incoming request headers
1722
fn extract_context_from_request(req: &Request<Incoming>) -> Context {
1823
global::get_text_map_propagator(|propagator| {
@@ -24,11 +29,11 @@ fn extract_context_from_request(req: &Request<Incoming>) -> Context {
2429
async fn handle_health_check(
2530
_req: Request<Incoming>,
2631
) -> Result<Response<BoxBody<Bytes, hyper::Error>>, Infallible> {
27-
let tracer = global::tracer("example/server");
32+
let tracer = get_tracer();
2833
let mut span = tracer
2934
.span_builder("health_check")
3035
.with_kind(SpanKind::Internal)
31-
.start(&tracer);
36+
.start(tracer);
3237
span.add_event("Health check accessed", vec![]);
3338

3439
let res = Response::new(
@@ -44,11 +49,11 @@ async fn handle_health_check(
4449
async fn handle_echo(
4550
req: Request<Incoming>,
4651
) -> Result<Response<BoxBody<Bytes, hyper::Error>>, Infallible> {
47-
let tracer = global::tracer("example/server");
52+
let tracer = get_tracer();
4853
let mut span = tracer
4954
.span_builder("echo")
5055
.with_kind(SpanKind::Internal)
51-
.start(&tracer);
56+
.start(tracer);
5257
span.add_event("Echoing back the request", vec![]);
5358

5459
let res = Response::new(req.into_body().boxed());
@@ -63,11 +68,11 @@ async fn router(
6368
let parent_cx = extract_context_from_request(&req);
6469
let response = {
6570
// Create a span parenting the remote client span.
66-
let tracer = global::tracer("example/server");
71+
let tracer = get_tracer();
6772
let mut span = tracer
6873
.span_builder("router")
6974
.with_kind(SpanKind::Server)
70-
.start_with_context(&tracer, &parent_cx);
75+
.start_with_context(tracer, &parent_cx);
7176

7277
span.add_event("dispatching request", vec![]);
7378

@@ -88,7 +93,7 @@ async fn router(
8893
response
8994
}
9095

91-
fn init_tracer() {
96+
fn init_tracer() -> SdkTracerProvider {
9297
global::set_text_map_propagator(TraceContextPropagator::new());
9398

9499
// Setup tracerprovider with stdout exporter
@@ -97,14 +102,15 @@ fn init_tracer() {
97102
.with_simple_exporter(SpanExporter::default())
98103
.build();
99104

100-
global::set_tracer_provider(provider);
105+
global::set_tracer_provider(provider.clone());
106+
provider
101107
}
102108

103109
#[tokio::main]
104110
async fn main() {
105111
use hyper_util::server::conn::auto::Builder;
106112

107-
init_tracer();
113+
let provider = init_tracer();
108114
let addr = SocketAddr::from(([127, 0, 0, 1], 3000));
109115
let listener = TcpListener::bind(addr).await.unwrap();
110116

@@ -116,4 +122,6 @@ async fn main() {
116122
eprintln!("{err}");
117123
}
118124
}
125+
126+
provider.shutdown().expect("Shutdown provider failed");
119127
}

‎opentelemetry-sdk/Cargo.toml‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,12 +83,15 @@ harness = false
8383
[[bench]]
8484
name = "trace"
8585
harness = false
86-
required-features = ["testing"]
8786

8887
[[bench]]
8988
name = "log_processor"
9089
harness = false
9190

91+
[[bench]]
92+
name = "tracer_creation"
93+
harness = false
94+
9295
[[bench]]
9396
name = "log_exporter"
9497
harness = false

‎opentelemetry-sdk/benches/tracer_creation.rs‎

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
use criterion::{black_box, criterion_group, criterion_main, Criterion};
2+
use opentelemetry::{
3+
global::{self, BoxedTracer},
4+
InstrumentationScope, KeyValue,
5+
};
6+
use opentelemetry_sdk::trace as sdktrace;
7+
use std::sync::OnceLock;
8+
9+
#[cfg(not(target_os = "windows"))]
10+
use pprof::criterion::{Output, PProfProfiler};
11+
12+
/*
13+
Adding results in comments for a quick reference.
14+
Apple M4 Pro
15+
Total Number of Cores: 14 (10 performance and 4 efficiency)
16+
17+
Tracer_With_Name/new_each_time 20 ns
18+
Tracer_With_Name/reuse_existing 383 ps
19+
Tracer_With_Name_And_Scope_Attrs/new_each_time 63 ns
20+
Tracer_With_Name_And_Scope_Attrs/reuse_existing 385 ps
21+
*/
22+
23+
fn get_tracer() -> &'static BoxedTracer {
24+
static TRACER: OnceLock<BoxedTracer> = OnceLock::new();
25+
TRACER.get_or_init(|| global::tracer("tracer"))
26+
}
27+
28+
fn get_tracer_with_scope_attrs() -> &'static BoxedTracer {
29+
static TRACER_WITH_ATTRS: OnceLock<BoxedTracer> = OnceLock::new();
30+
TRACER_WITH_ATTRS.get_or_init(|| {
31+
let scope = InstrumentationScope::builder("tracer")
32+
.with_attributes([KeyValue::new("key", "value")])
33+
.build();
34+
global::tracer_with_scope(scope)
35+
})
36+
}
37+
38+
fn create_provider() -> sdktrace::SdkTracerProvider {
39+
// Provider is empty, no exporters, no processors etc.
40+
// as the goal is measurement of tracer creation time.
41+
sdktrace::SdkTracerProvider::builder().build()
42+
}
43+
44+
fn criterion_benchmark(c: &mut Criterion) {
45+
let mut group = c.benchmark_group("Tracer_With_Name");
46+
group.bench_function("new_each_time", |b| {
47+
let provider = create_provider();
48+
global::set_tracer_provider(provider);
49+
b.iter(|| {
50+
black_box(global::tracer("tracer"));
51+
});
52+
});
53+
54+
group.bench_function("reuse_existing", |b| {
55+
let provider = create_provider();
56+
global::set_tracer_provider(provider);
57+
b.iter(|| {
58+
black_box(get_tracer());
59+
});
60+
});
61+
62+
group.finish();
63+
64+
let mut group = c.benchmark_group("Tracer_With_Name_And_Scope_Attrs");
65+
group.bench_function("new_each_time", |b| {
66+
let provider = create_provider();
67+
global::set_tracer_provider(provider);
68+
b.iter(|| {
69+
let scope = InstrumentationScope::builder("tracer")
70+
.with_attributes([KeyValue::new("key", "value")])
71+
.build();
72+
black_box(global::tracer_with_scope(scope));
73+
});
74+
});
75+
76+
group.bench_function("reuse_existing", |b| {
77+
let provider = create_provider();
78+
global::set_tracer_provider(provider);
79+
b.iter(|| {
80+
black_box(get_tracer_with_scope_attrs());
81+
});
82+
});
83+
group.finish();
84+
}
85+
86+
#[cfg(not(target_os = "windows"))]
87+
criterion_group! {
88+
name = benches;
89+
config = Criterion::default().with_profiler(PProfProfiler::new(100, Output::Flamegraph(None)));
90+
targets = criterion_benchmark
91+
}
92+
93+
#[cfg(target_os = "windows")]
94+
criterion_group! {
95+
name = benches;
96+
config = Criterion::default();
97+
targets = criterion_benchmark
98+
}
99+
100+
criterion_main!(benches);

‎opentelemetry/src/context.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -339,7 +339,7 @@ impl fmt::Debug for Context {
339339
}
340340
}
341341

342-
dbg.field("entries", &entries).finish()
342+
dbg.field("entries count", &entries).finish()
343343
}
344344
}
345345

‎opentelemetry/src/trace/span_context.rs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -400,7 +400,7 @@ mod tests {
400400
let cx = Context::current();
401401
assert_eq!(
402402
format!("{:?}", cx),
403-
"Context { span: \"None\", entries: 0 }"
403+
"Context { span: \"None\", entries count: 0 }"
404404
);
405405
let cx = Context::current().with_remote_span_context(SpanContext::NONE);
406406
assert_eq!(
@@ -413,7 +413,7 @@ mod tests {
413413
is_remote: false, \
414414
trace_state: TraceState(None) \
415415
}, \
416-
entries: 1 \
416+
entries count: 1 \
417417
}"
418418
);
419419
}

0 commit comments

Comments
 (0)