docs(requests): clarify hook mutation and propagation order - #4992
Open
jstar0 wants to merge 2 commits into
Open
docs(requests): clarify hook mutation and propagation order#4992jstar0 wants to merge 2 commits into
jstar0 wants to merge 2 commits into
Conversation
Document that request hooks operate on the live PreparedRequest before propagation injection, and that mutations affect the outbound request. Assisted-by: ChatGPT 5.2
Pull request dashboard statusWaiting on reviewers · refreshed 2026-08-29 12:26 UTC Review the latest changes. Status above doesn't look right?
|
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
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.
Summary
Fixes #4990.
Clarify that
request_hookreceives the liverequests.PreparedRequest, that mutations affect the outbound request, and that propagation injection runs afterward and may replace propagation headers. Add the same guidance to the package README and API documentation, including a small header-mutation example.Testing
env -u HTTP_PROXY -u HTTPS_PROXY -u ALL_PROXY -u http_proxy -u https_proxy -u all_proxy tox -e py312-test-instrumentation-requests(80 passed)libmysqlclient.24.dylibwhile importing the unchanged MySQL instrumentationgit diff --checkDocumentation-only change; no core repository change or changelog fragment is required.