Skip to content

Commit 8688e7e

Browse files
authored
Minor readme fixes for examples (#1513)
1 parent aba0af5 commit 8688e7e

File tree

3 files changed

+35
-9
lines changed

3 files changed

+35
-9
lines changed

examples/README.md

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,67 @@
11
# Examples
2+
23
This directory contains some examples that should help you get start crates from `opentelemetry-rust`.
34

45
## log-basic
5-
**Logs**
66

77
This example uses following crates from this repo:
8+
89
- opentelemetry(log)
910
- opentelemetry-appender-log
1011
- opentelemetry-stdout
1112

1213
Check this example if you want to understand *how to instrument logs using opentelemetry*.
1314

1415
## metrics-basic
15-
**Metrics**
1616

1717
This example uses following crates from this repo:
18+
1819
- opentelemetry(metrics)
1920
- opentelemetry-stdout
2021

2122
Check this example if you want to understand *how to instrument metrics using opentelemetry*.
2223

24+
## metrics-advanced
25+
26+
This example uses following crates from this repo:
27+
28+
- opentelemetry(metrics)
29+
- opentelemetry-stdout
30+
31+
This builds on top of the metrics-basic,
32+
and shows advanced features in Metrics SDK like using Views.
33+
34+
## tracing-grpc
35+
36+
This example uses following crates from this repo:
37+
38+
- opentelemetry(tracing)
39+
- opentelemetry-stdout
40+
41+
The application is built using `tokio`.
42+
43+
Check this example if you want to understand *how to create spans and
44+
propagate/restore context in OpenTelemetry* in a gRPC client-server application.
45+
2346
## tracing-http-propagator
24-
**Tracing**
2547

2648
This example uses following crates from this repo:
49+
2750
- opentelemetry(tracing)
2851
- opentelemetry-http
2952
- opentelemetry-stdout
3053

31-
## tracing-grpc
32-
**Tracing**
54+
Check this example if you want to understand *how to create spans and
55+
propagate/restore context in OpenTelemetry* in an HTTP client-server
56+
application.
57+
58+
## tracing-jaeger
3359

3460
This example uses following crates from this repo:
3561

3662
- opentelemetry(tracing)
37-
- opentelemetry-stdout
63+
- opentelemetry-otlp
3864

3965
The application is built using `tokio`.
4066

41-
Check this example if you want to understand *how to create spans and propagate/restore context in OpenTelemetry*.
67+
Check this example if you want to understand *how to use OTLP Exporter to export traces to Jaeger*.

opentelemetry-sdk/benches/attribute_set.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ use opentelemetry::KeyValue;
33
use opentelemetry_sdk::AttributeSet;
44

55
// Run this benchmark with:
6-
// cargo bench --bench metric_counter
6+
// cargo bench --bench attribute_set --features=metrics
77

88
fn criterion_benchmark(c: &mut Criterion) {
99
attribute_set(c);

opentelemetry/src/common.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ use std::{fmt, hash};
66
///
77
/// See the [attribute naming] spec for guidelines.
88
///
9-
/// [attribute naming]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.9.0/specification/common/attribute-naming.md
9+
/// [attribute naming]: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/general/attribute-naming.md
1010
#[derive(Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
1111
pub struct Key(OtelString);
1212

0 commit comments

Comments
 (0)