Include group and action names in traces #157
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
smacfarlane
approved these changes
Oct 17, 2024
rubberduck203
added a commit
to rubberduck203/scope
that referenced
this pull request
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
added a commit
to rubberduck203/scope
that referenced
this pull request
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
added a commit
that referenced
this pull request
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 #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 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 Screenshot of what the traces look like now 
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 PR adds group and action names to the traces emitted, making it possible to determine which actions are taking the most time to run, or fail the most often. Resolves #154
Dynamic trace names are discouraged by
tracing'sconsttrace name argument, so names are provided as fields.