feat!: Custom ActiveSupport Span Names #1014
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
| @@ -19,11 +21,13 @@ def self.subscribe( | |||
| tracer, | |||
| pattern, | |||
| notification_payload_transform = nil, | |||
| disallowed_notification_payload_keys = [] | |||
| disallowed_notification_payload_keys = nil, | |||
| span_name_formatter = nil | |||
There was a problem hiding this comment.
I wonder if the intent might be more clear if we defaulted this to a passthrough rather than nil? Something like:
PASSTHROUGH_NAME_FORMATTER = =>(name) { name.dup.freeze }
# …
span_name_formatter = PASSTHROUGH_NAME_FORMATTERMaybe it doesn't matter. Six of one, half a dozen of the other, as they say?
There was a problem hiding this comment.
I think even though it is symmetric, I am going choose to minimize allocations.
| # | ||
| # It wraps the user supplied formatter in a rescue block and returns the original name if a StandardError is raised by the formatter | ||
| def safe_span_name_for(span_name_formatter, name) | ||
| span_name_formatter&.call(name) || name |
There was a problem hiding this comment.
If we're going to go this route, should we #dup#freeze the name that we fall back to for consistency with how the legacy formatter now works?
There was a problem hiding this comment.
I added dup.freeze to the result of the method call.
6aa3ec0 to
a649c5a
Compare
The current implementation of ActiveSupport instrumentation sets the span name to the reverse tokenized name, e.g. `render_template.action_view` is converted to `action_view render_template` This default behavior can sometimes seem counter intuitive for users who use ActiveSupport Notifications to instrument their own code or users who are familiar with Rails instrumentation names. This change does a few things to address the issues listed above: 1. Uses the notification name by default as oppossed to the legacy span name 2. Allows users to provide a custom span name formatter lambda 3. Provides a proc with backward compatible span name formatter `OpenTelemetry::Instrumentation::ActiveSupport::LEGACY_NAME_FORMATTER` See open-telemetry#957
9d7f17f to
c304028
Compare
stevenharman
approved these changes
Jun 21, 2024
7 tasks
|
gentle ping @open-telemetry/ruby-contrib-approvers |
xuan-cao-swi
approved these changes
Jun 24, 2024
Closed
arielvalentin
added a commit
to arielvalentin/opentelemetry-ruby-contrib
that referenced
this pull request
Jun 24, 2024
It also allows users to rollback to legacy span name format. Follow up to open-telemetry#1014
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.
The current implementation of ActiveSupport instrumentation sets the span name to the reverse tokenized name, e.g.
render_template.action_viewis converted toaction_view render_templateThis default behavior can sometimes seem counter intuitive for users who use ActiveSupport Notifications to instrument their own code or users who are familiar with Rails instrumentation names.
This change does a few things to address the issues listed above:
OpenTelemetry::Instrumentation::ActiveSupport::LEGACY_NAME_FORMATTERSee #957