Docs/clarify ignore outgoing request hook #5792
Open
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
…s), deprecate metricReader, and add tests
Co-authored-by: Marc Pichler <[email protected]>
Co-authored-by: Marc Pichler <[email protected]>
nidhiisinghh
force-pushed
the
docs/clarify-ignoreOutgoingRequestHook
branch
from
3a56d83 to
45d0986
Compare
dyladan
requested changes
Jul 18, 2025
| sdk.start(); | ||
|
|
||
| // Verify deprecation warning was shown | ||
| sinon.assert.calledWith( |
| */ | ||
| reader?: IMetricReader; | ||
| readers?: IMetricReader[]; |
There was a problem hiding this comment.
This is a breaking change. Fine because this package is experimental but make sure it is noted in the changelog.
There was a problem hiding this comment.
This doesn't seem to have anything to do with documenting or clarifying...
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.
Which problem is this PR solving?
This PR improves the documentation for the ignoreOutgoingRequestHook option in the HTTP instrumentation package.
Previously, the documentation did not clearly explain:
• How the function should be used.
• What parameters it receives.
• What its return value means.
This update provides:
• A clear and concise explanation in the options table.
• A dedicated section below the table describing the function’s usage, parameters, return values, and error behavior.
Following the existing README style, no code examples were added.
Fixes: #5516