Skip to content

Commit db3270f

Browse files
svrnmchalin
andauthored
[IA] Auto-Update rust versions in docs from registry (#3944)
Signed-off-by: svrnm <[email protected]> Co-authored-by: Patrice Chalin <[email protected]>
1 parent 4178a5d commit db3270f

File tree

4 files changed

+28
-5
lines changed

4 files changed

+28
-5
lines changed

content/en/docs/languages/rust/exporters.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,12 @@ cSpell:ignore: chrono millis ostream
99
## OTLP endpoint
1010

1111
To send trace data to a OTLP endpoint (like the [collector](/docs/collector) or
12-
Jaeger) you'll want to use an exporter crate, such as `opentelemetry_otlp`:
12+
Jaeger) you'll want to use an exporter crate, such as
13+
[opentelemetry-otlp](https://crates.io/crates/opentelemetry-otlp):
1314

1415
```toml
1516
[dependencies]
16-
opentelemetry-otlp = { version = "0.13", features = ["default"] }
17+
opentelemetry-otlp = { version = "{{% version-from-registry exporter-rust-otlp %}}", features = ["default"] }
1718
```
1819

1920
Next, configure the exporter to point at an OTLP endpoint. For example you can

content/en/docs/languages/rust/getting-started.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -103,11 +103,14 @@ Listening on 127.0.0.1:8080
103103
## Instrumentation
104104

105105
To add OpenTelemetry to your application, update the `Cargo.toml` with the
106-
following additional dependencies:
106+
dependencies for the OpenTelemetry Rust SDK
107+
[`opentelemetry`](https://crates.io/crates/opentelemetry) and the OpenTelemetry
108+
Stdout Exporter
109+
[`opentelemetry-stdout`](https://crates.io/crates/opentelemetry-stdout):
107110

108111
```toml
109-
opentelemetry = { version = "0.20", features = ["trace"] }
110-
opentelemetry-stdout = { version = "0.1", features = ["trace"] }
112+
opentelemetry = { version = "{{% version-from-registry otel-rust %}}", features = ["trace"] }
113+
opentelemetry-stdout = { version = "{{% version-from-registry exporter-rust-stdout %}}", features = ["trace"] }
111114
```
112115

113116
Update the `dice_server.rs` file with code to initialize a tracer and to emit

data/registry/otel-rust.yml

+4
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,7 @@ authors:
1010
urls:
1111
repo: https://github.com/open-telemetry/opentelemetry-rust
1212
createdAt: 2020-02-04
13+
package:
14+
registry: crates
15+
name: opentelemetry
16+
version: 0.21.0
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{{ $name := (.Get 0) -}}
2+
3+
{{ with $name -}}
4+
{{ with index $.Site.Data.registry . -}}
5+
{{ with .package.version -}}
6+
{{ . -}}
7+
{{ else -}}
8+
{{ errorf "No 'package.version' in registry entry %q: %s" $name $.Position -}}
9+
{{ end -}}
10+
{{ else -}}
11+
{{ errorf "Registry entry %q not found: %s" $name $.Position -}}
12+
{{ end -}}
13+
{{ else -}}
14+
{{ errorf "Shortcode parameter 'name' is missing %s: " $.Position -}}
15+
{{ end -}}

0 commit comments

Comments
 (0)