diff --git a/.cspell.json b/.cspell.json index 613c082c22..be20dea3d4 100644 --- a/.cspell.json +++ b/.cspell.json @@ -50,6 +50,7 @@ "reqwest", "rustc", "Tescher", + "tracerprovider", "Zhongyang", "zipkin" ], diff --git a/README.md b/README.md index 95492a2e3f..58530c62d2 100644 --- a/README.md +++ b/README.md @@ -137,7 +137,6 @@ above, please let us know! We'd love to add your project to the list! [`open-telemetry/opentelemetry-rust`]: https://github.com/open-telemetry/opentelemetry-rust [`opentelemetry-jaeger`]: https://crates.io/crates/opentelemetry-jaeger -[`Jaeger`]: https://www.jaegertracing.io [`opentelemetry-otlp`]: https://crates.io/crates/opentelemetry-otlp [`opentelemetry-http`]: https://crates.io/crates/opentelemetry-http [`opentelemetry-prometheus`]: https://crates.io/crates/opentelemetry-prometheus @@ -157,7 +156,7 @@ above, please let us know! We'd love to add your project to the list! [`actix-web-opentelemetry`]: https://crates.io/crates/actix-web-opentelemetry [`actix-web`]: https://crates.io/crates/actix-web [`opentelemetry-application-insights`]: https://crates.io/crates/opentelemetry-application-insights -[Azure Application Insights]: https://docs.microsoft.com/en-us/azure/azure-monitor/app/app-insights-overview +[Azure Application Insights]: https://docs.microsoft.com/azure/azure-monitor/app/app-insights-overview [`opentelemetry-tide`]: https://crates.io/crates/opentelemetry-tide [`Tide`]: https://crates.io/crates/tide [`opentelemetry-stackdriver`]: https://crates.io/crates/opentelemetry-stackdriver diff --git a/examples/README.md b/examples/README.md index 4984d12298..08b29620cc 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,5 +1,5 @@ # Examples -This folder contains some examples that should help you get start crates from `opentelemetry-rust`. +This directory contains some examples that should help you get start crates from `opentelemetry-rust`. ## log-basic **Logs** diff --git a/examples/tracing-http-propagator/README.md b/examples/tracing-http-propagator/README.md index a351e24623..0d872f8415 100644 --- a/examples/tracing-http-propagator/README.md +++ b/examples/tracing-http-propagator/README.md @@ -24,4 +24,4 @@ $ cargo run --bin http-server $ cargo run --bin http-client # The spans should be visible in stdout in the order that they were exported. -``` \ No newline at end of file +``` diff --git a/examples/tracing-http-propagator/src/server.rs b/examples/tracing-http-propagator/src/server.rs index a126db749c..1ad924c766 100644 --- a/examples/tracing-http-propagator/src/server.rs +++ b/examples/tracing-http-propagator/src/server.rs @@ -76,9 +76,8 @@ async fn router(req: Request) -> Result, Infallible> { fn init_tracer() { global::set_text_map_propagator(TraceContextPropagator::new()); - // Install stdout exporter pipeline to be able to retrieve the collected spans. - // For the demonstration, use `Sampler::AlwaysOn` sampler to sample all traces. In a production - // application, use `Sampler::ParentBased` or `Sampler::TraceIdRatioBased` with a desired ratio. + // Setup tracerprovider with stdout exporter + // that prints the spans to stdout. let provider = TracerProvider::builder() .with_simple_exporter(SpanExporter::default()) .build(); diff --git a/opentelemetry-sdk/README.md b/opentelemetry-sdk/README.md index 067392dfef..c75e1ab2a4 100644 --- a/opentelemetry-sdk/README.md +++ b/opentelemetry-sdk/README.md @@ -29,7 +29,7 @@ observability tools. ## OpenTelemetry Benchmarks -From the root folder, run the following command: +From the root directory, run the following command: ```sh cargo bench diff --git a/opentelemetry/src/logs/mod.rs b/opentelemetry/src/logs/mod.rs index 67f2611949..2207ff45ed 100644 --- a/opentelemetry/src/logs/mod.rs +++ b/opentelemetry/src/logs/mod.rs @@ -1,5 +1,6 @@ -//! # OpenTelemetry Logs API - +//! # OpenTelemetry Logs Bridge API +/// This API is not intended to be called by application developers directly. It +/// is provided for logging library authors to build log appenders. use crate::ExportError; use std::{sync::PoisonError, time::Duration}; diff --git a/stress/README.md b/stress/README.md index c2dc1948f2..975fd6f0af 100644 --- a/stress/README.md +++ b/stress/README.md @@ -10,7 +10,7 @@ ## Usage -Open a console, run the following command from the current folder: +Open a console, run the following command from the current directory: ```sh cargo run --release --bin X