Improve telemetry output #186
Merged
Conversation
This file contains hidden or 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
meaganewaller
approved these changes
Feb 11, 2025
1. Actions and groups are now marked as errored when they fail 2. Set the otel.name so it includes the group or action name This lets us easily query/aggregate which groups or actions are failing most often. This fixes oscope-dev#185 and improves on the solution for oscope-dev#154 implemented in oscope-dev#157. We accomplish the dynamic span naming by leveraging one of the "special fields" detailed here https://docs.rs/tracing-opentelemetry/latest/tracing_opentelemetry/ The naming convention is loosely based on the OTEL http semantic convention of "{method} {url}". Several other of the semantic convention standards are similar as well. https://opentelemetry.io/docs/specs/semconv/http/http-spans/ In order to access the OTEL Span's `set_status()` method, I needed to upgrade all of our opentelemetry dependencies to the latest version. When I did this, traces were no longer being properly flushed before exiting the application, so I updated the implementation based off of this example from the opentelemetry-otlp crate. https://github.com/tokio-rs/tracing-opentelemetry/blob/v0.1.x/examples/opentelemetry-otlp.rs
rubberduck203
force-pushed
the
cmac/telemetry
branch
from
6175c84 to
9a4fba0
Compare
rubberduck203
added a commit
to rubberduck203/scope
that referenced
this pull request
Mar 17, 2025
Between opentelemetry-otlp v0.15 and 0.16 a breaking change landed. - https://github.com/pitoniak32/opentelemetry-rust/blob/main/opentelemetry-otlp/CHANGELOG.md#v0160 - open-telemetry/opentelemetry-rust#1706 So when we upgraded to 0.27 (oscope-dev#186), we inadvertantly broke people using `SCOPE_OTEL_PROTOCOL=http`. It did not affect people using `grpc`. To maintain consistency with grpc (and compatibility with version prior to PR oscope-dev#186), we append `v1/traces` to the `SCOPE_OTEL_ENDPOINT`.
rubberduck203
added a commit
that referenced
this pull request
Mar 18, 2025
Between opentelemetry-otlp v0.15 and 0.16 a breaking change landed. - https://github.com/pitoniak32/opentelemetry-rust/blob/main/opentelemetry-otlp/CHANGELOG.md#v0160 - open-telemetry/opentelemetry-rust#1706 So when we upgraded to 0.27 (#186), we inadvertantly broke people using `SCOPE_OTEL_PROTOCOL=http`. It did not affect people using `grpc`. To maintain consistency with grpc (and compatibility with version prior to PR #186), we append `v1/traces` to the `SCOPE_OTEL_ENDPOINT` when the protocol is set to `http`.
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.
otel.nameso it includes the group or action nameThis lets us easily query/aggregate which groups or actions are failing most often.
This fixes #185 and improves on the solution for #154 implemented in #157.
We accomplish the dynamic span naming by leveraging one of the "special fields" detailed here
https://docs.rs/tracing-opentelemetry/latest/tracing_opentelemetry/
The naming convention is loosely based on the OTEL http semantic convention of
{method} {url}.Several other of the semantic convention standards are similar as well. https://opentelemetry.io/docs/specs/semconv/http/http-spans/
In order to access the OTEL Span's
set_status()method, I needed to upgrade all of ouropentelemetrydependencies to the latest version.When I did this, traces were no longer being properly flushed before exiting the application, so I updated the implementation based off of this example from the
opentelemetry-otlpcrate.https://github.com/tokio-rs/tracing-opentelemetry/blob/v0.1.x/examples/opentelemetry-otlp.rs
Screenshot of what the traces look like now
