Skip to content

docs(httpx): document response payload logging#4862

Open
euisuh wants to merge 2 commits into
open-telemetry:mainfrom
euisuh:docs/httpx-response-hook-payload-2556
Open

docs(httpx): document response payload logging#4862
euisuh wants to merge 2 commits into
open-telemetry:mainfrom
euisuh:docs/httpx-response-hook-payload-2556

Conversation

@euisuh

@euisuh euisuh commented Jul 24, 2026

Copy link
Copy Markdown

Description

Adds HTTPX documentation for inspecting response payload chunks without consuming the response stream inside response_hook.

Fixes #2556

Type of change

  • This change requires a documentation update

How Has This Been Tested?

  • Parsed instrumentation/opentelemetry-instrumentation-httpx/README.rst with docutils.
  • Ran the documented transport-wrapping pattern against httpx.MockTransport and verified the application can still read the response body.
  • Ran python -m tox -e lint-instrumentation-httpx.

Does This PR Require a Core Repo Change?

  • No.

Checklist:

  • Followed the style guidelines of this project
  • Changelogs have been updated
  • Unit tests have been added
  • Documentation has been updated

Document how to inspect HTTPX response payload chunks without consuming the response stream inside response_hook.

Assisted-by: Hermes Agent
@linux-foundation-easycla

linux-foundation-easycla Bot commented Jul 24, 2026

Copy link
Copy Markdown

CLA Signed
The committers listed above are authorized under a signed CLA.

Clarify that the transport wrapper avoids reading the hook stream directly.

Assisted-by: Hermes Agent
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

HTTPX instrumentation - document how to log request payload and response on response_hook

1 participant