Improve instrumentation middleware option naming and documentation #1146
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
Use "event" rather than "span" for the Rack AbstractMiddleware config option naming to be consistent with the rest of the Ruby gem. This is a (still) private API change so no backwards compatibility has been added. [skip changeset] as it's a private change.
Add documentation for the InstrumentationMiddleware for the API documentation. This InstrumentationMiddleware is a public API so let's document it a little. I've also linked to our Rack instrumentation documentation page for more information.
This is a message from the daily scheduled checks. |
luismiramirez
approved these changes
Jul 8, 2024
jeffkreeftmeijer
approved these changes
Jul 8, 2024
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.
Use Transaction API naming in middleware option
Use "event" rather than "span" for the Rack AbstractMiddleware config option naming to be consistent with the rest of the Ruby gem.
This is a (still) private API change so no backwards compatibility has been added.
[skip changeset] as it's a private change.
Document Rack InstrumentationMiddleware
Add documentation for the InstrumentationMiddleware for the API documentation.
This InstrumentationMiddleware is a public API so let's document it a little. I've also linked to our Rack instrumentation documentation page for more information.