feat: make the install of rack instrumentation by grape instrumentation optional #1043
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
In some circumstances we may want to defer the installation of the rack instrumentation that is orchestrated during the grape instrumentation installation. For example, we may want to customise the installation of the rack instrumentation or we can rely on the installation being orchestrated by another framework's instrumentation (such as when Grape is mounted with Rails). This change allows for Grape to skip the installation of the Rack instrumentation so that it can manually installed at a later time.
chrisholmes
requested review from
ahayworth,
arielvalentin,
dazuma,
ericmustin,
fbogsany,
kaylareopelle,
mwear,
plantfansam,
robbkidd,
robertlaurin,
simi and
xuan-cao-swi
as code owners
kaylareopelle
requested changes
Jun 27, 2024
Comment on lines
29
to
39
| # # Configuration keys and options | ||
| # ## `:ignored_events` | ||
| # | ||
| # Default is `[]`. Specifies which ActiveSupport::Notifications events published by Grape to ignore. | ||
| # Ignored events will not be published as Span events. | ||
| option :ignored_events, default: [], validate: :array | ||
| # ## `:install_rack` | ||
| # | ||
| # Default is `true`. Specifies whether or not to install the Rack instrumentation as part of installing the Grape instrumentation. | ||
| # This is useful in cases where you have multiple Rack applications but want to manually specify where to insert the tracing middleware. | ||
| option :install_rack, default: true, validate: :boolean |
Contributor
There was a problem hiding this comment.
Thanks for adding this documentation!
Though this is helpful when reading the code, this won't appear in the RubyDocs. Would you mind moving it above the class Instrumentation line?
Here's an example for what we're doing for Sidekiq:
Contributor
Author
There was a problem hiding this comment.
does the new change work?
Contributor
There was a problem hiding this comment.
It looks great! Thank you!
simi
approved these changes
Jul 1, 2024
kaylareopelle
approved these changes
Jul 1, 2024
This was referenced Jul 2, 2024
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
In some circumstances we may want to defer the installation of the rack instrumentation that is orchestrated during the grape instrumentation installation. For example, we may want to customise the installation of the rack instrumentation or we can rely on the installation being orchestrated by another framework's instrumentation (such as when Grape is mounted with Rails).
This change allows for Grape to skip the installation of the Rack instrumentation so that it can manually installed at a later time.