opentelemetry: clarify otel.kind field usage in docs #1218
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
jtescher
added
the
crate/opentelemetry
hawkw
approved these changes
Jan 30, 2021
| //! | ||
| //! ### 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.
nit/TIOLI: it might be worth changing this example so that it's formatted as Rust code? but we can do that later.
hawkw
pushed a commit
that referenced
this pull request
Feb 4, 2021
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
Merged
hawkw
pushed a commit
that referenced
this pull request
Feb 4, 2021
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. |
fnichol
added a commit
to systeminit/si
that referenced
this pull request
Sep 20, 2022
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>
fnichol
added a commit
to systeminit/si
that referenced
this pull request
Sep 20, 2022
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>
si-bors-ng bot
added a commit
to systeminit/si
that referenced
this pull request
Sep 21, 2022
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>
fnichol
added a commit
to systeminit/si
that referenced
this pull request
Sep 21, 2022
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>
si-bors-ng bot
added a commit
to systeminit/si
that referenced
this pull request
Sep 21, 2022
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>
kaffarell
pushed a commit
to kaffarell/tracing
that referenced
this pull request
May 22, 2024
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This patch resolves the field value capitalization ambiguity currently in
otel.kindby instead recommending an enum value. This also brings type safety to the value, further reducing the risk of typos and other misuse.Resolves #1209