-
Notifications
You must be signed in to change notification settings - Fork 707
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
opentelemetry: clarify otel.kind field usage in docs #1218
Conversation
This patch resolves the field value capitalization ambiguity currently in `otel.kind` by instead recommending an enum value. This also brings type safety to the value, further reducing the risk of typos and other misuse.
//! | ||
//! ### Semantic Conventions | ||
//! | ||
//! OpenTelemetry defines conventional names for attributes of common | ||
//! operations. These names can be assigned directly as fields, e.g. | ||
//! `trace_span!("request", "otel.kind" = "client", "http.url" = ..)`, and they | ||
//! `trace_span!("request", "otel.kind" = %SpanKind::Client, "http.url" = ..)`, and they |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit/TIOLI: it might be worth changing this example so that it's formatted as Rust code? but we can do that later.
This patch resolves the field value capitalization ambiguity currently in `otel.kind` by instead recommending an enum value. This also brings type safety to the value, further reducing the risk of typos and other misuse. Resolves #1209
This patch resolves the field value capitalization ambiguity currently in `otel.kind` by instead recommending an enum value. This also brings type safety to the value, further reducing the risk of typos and other misuse. Resolves #1209
The Display implementation for Building against opentelemetry-0.17.2 is fine, but I just wanted to share that this will break the examples in the readme at some point. |
Some notable changes: - Upgrade to latest tracing/openteletetry dependencies: - opentelemetry 0.18.0 - opentelemetry-otlp 0.11.0 - opentelemetry-semantic-conventions 0.10.0 - tracing-opentelemetry 0.18.0 - Due to updates in opentelemetry-api dropping some Display trait implementations some changes had to be made to preserve the string representations (in one case static strings is used, and in another case a wrapping unit type is used to ship a similar Display impl) References: open-telemetry/opentelemetry-rust#758 References: tokio-rs/tracing#1218 Signed-off-by: Fletcher Nichol <fletcher@systeminit.com>
Some notable changes: - Upgrade to latest tracing/openteletetry dependencies: - opentelemetry 0.18.0 - opentelemetry-otlp 0.11.0 - opentelemetry-semantic-conventions 0.10.0 - tracing-opentelemetry 0.18.0 - Due to updates in opentelemetry-api dropping some Display trait implementations some changes had to be made to preserve the string representations (in one case static strings is used, and in another case a wrapping unit type is used to ship a similar Display impl) References: open-telemetry/opentelemetry-rust#758 References: tokio-rs/tracing#1218 Signed-off-by: Fletcher Nichol <fletcher@systeminit.com>
1295: build(deps): update Rust dependencies (2022-W39) r=nickgerace a=fnichol Some notable changes: - Upgrade to latest tracing/openteletetry dependencies: - opentelemetry 0.18.0 - opentelemetry-otlp 0.11.0 - opentelemetry-semantic-conventions 0.10.0 - tracing-opentelemetry 0.18.0 - Due to updates in opentelemetry-api dropping some Display trait implementations some changes had to be made to preserve the string representations (in one case static strings is used, and in another case a wrapping unit type is used to ship a similar Display impl) - The `protoc` (i.e. Protobuf compiler) is now required on build/ci/development systems due to updates with the tonic Rust crate References: open-telemetry/opentelemetry-rust#758 References: tokio-rs/tracing#1218 Co-authored-by: Fletcher Nichol <fletcher@systeminit.com>
Some notable changes: - Upgrade to latest tracing/openteletetry dependencies: - opentelemetry 0.18.0 - opentelemetry-otlp 0.11.0 - opentelemetry-semantic-conventions 0.10.0 - tracing-opentelemetry 0.18.0 - Due to updates in opentelemetry-api dropping some Display trait implementations some changes had to be made to preserve the string representations (in one case static strings is used, and in another case a wrapping unit type is used to ship a similar Display impl) References: open-telemetry/opentelemetry-rust#758 References: tokio-rs/tracing#1218 Signed-off-by: Fletcher Nichol <fletcher@systeminit.com>
1295: build(deps): update Rust dependencies (2022-W39) r=fnichol a=fnichol Some notable changes: - Upgrade to latest tracing/openteletetry dependencies: - opentelemetry 0.18.0 - opentelemetry-otlp 0.11.0 - opentelemetry-semantic-conventions 0.10.0 - tracing-opentelemetry 0.18.0 - Due to updates in opentelemetry-api dropping some Display trait implementations some changes had to be made to preserve the string representations (in one case static strings is used, and in another case a wrapping unit type is used to ship a similar Display impl) - The `protoc` (i.e. Protobuf compiler) is now required on build/ci/development systems due to updates with the tonic Rust crate References: open-telemetry/opentelemetry-rust#758 References: tokio-rs/tracing#1218 Co-authored-by: Fletcher Nichol <fletcher@systeminit.com>
This patch resolves the field value capitalization ambiguity currently in `otel.kind` by instead recommending an enum value. This also brings type safety to the value, further reducing the risk of typos and other misuse. Resolves tokio-rs#1209
This patch resolves the field value capitalization ambiguity currently in
otel.kind
by instead recommending an enum value. This also brings type safety to the value, further reducing the risk of typos and other misuse.Resolves #1209