Skip to content

Commit 3c9a151

Browse files
committed
Nit fixes to Resource docs
1 parent 66b00d6 commit 3c9a151

File tree

4 files changed

+9
-9
lines changed

4 files changed

+9
-9
lines changed

.cspell.json

+1
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@
5252
"reqwest",
5353
"runtimes",
5454
"rustc",
55+
"shoppingcart",
5556
"Tescher",
5657
"tracerprovider",
5758
"Zhongyang",

opentelemetry-sdk/src/resource/env.rs

+3-5
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,9 @@ use std::time::Duration;
1010
const OTEL_RESOURCE_ATTRIBUTES: &str = "OTEL_RESOURCE_ATTRIBUTES";
1111
const OTEL_SERVICE_NAME: &str = "OTEL_SERVICE_NAME";
1212

13-
/// Resource detector implements ResourceDetector and is used to extract
14-
/// general SDK configuration from environment.
15-
///
16-
/// See
17-
/// [semantic conventions](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/sdk.md#specifying-resource-information-via-an-environment-variable)
13+
/// EnvResourceDetector extract resource from environment variable
14+
/// OTEL_RESOURCE_ATTRIBUTES. See [OpenTelemetry Resource
15+
/// Spec](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/sdk.md#specifying-resource-information-via-an-environment-variable)
1816
/// for details.
1917
#[derive(Debug)]
2018
pub struct EnvResourceDetector {

opentelemetry-sdk/src/resource/mod.rs

+4-2
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@
1818
//! - [`EnvResourceDetector`] - detect resource from environmental variables.
1919
//! - [`TelemetryResourceDetector`] - detect telemetry SDK's information.
2020
//!
21-
//! The OS and Process resource detectors are now packaged separately in the `opentelemetry-resource-detector` [crate](https://github.com/open-telemetry/opentelemetry-rust-contrib/tree/main/opentelemetry-resource-detectors).
21+
//! The OS and Process resource detectors are packaged separately in the
22+
//! `opentelemetry-resource-detector`
23+
//! [crate](https://github.com/open-telemetry/opentelemetry-rust-contrib/tree/main/opentelemetry-resource-detectors).
2224
mod env;
2325
mod telemetry;
2426

@@ -208,7 +210,7 @@ impl Resource {
208210
self.inner.attrs.is_empty()
209211
}
210212

211-
/// Gets an iterator over the attributes of this resource, sorted by key.
213+
/// Gets an iterator over the attributes of this resource.
212214
pub fn iter(&self) -> Iter<'_> {
213215
Iter(self.inner.attrs.iter())
214216
}

opentelemetry-sdk/src/resource/telemetry.rs

+1-2
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,8 @@ use std::time::Duration;
1010
/// - The language of the telemetry SDK(`telemetry.sdk.language`). It will be `rust` for this SDK.
1111
/// - The version of the telemetry SDK(`telemetry.sdk.version`). It will be current `opentelemetry_sdk` crate version.
1212
///
13-
/// Note that the `telemetry.auto.version` is not provided as of now.
1413
///
15-
/// See [semantic conventions](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/semantic_conventions/README.md#telemetry-sdk) for details.
14+
/// See [semantic conventions](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/resource/README.md#telemetry-sdk) for details.
1615
#[derive(Debug)]
1716
pub struct TelemetryResourceDetector;
1817

0 commit comments

Comments
 (0)