Skip to content

docs(httpx): document response payload logging - #4862

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

euisuh wants to merge 5 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.

euisuh and others added 2 commits July 24, 2026 09:13
Clarify that the transport wrapper avoids reading the hook stream directly.

Assisted-by: Hermes Agent
@opentelemetry-pr-dashboard

opentelemetry-pr-dashboard Bot commented Aug 14, 2026 •

Copy link
Copy Markdown

Pull request dashboard status

Waiting on reviewers · refreshed 2026-10-04 14:02 UTC

Review the latest changes.

Status above doesn't look right?
  • Just replied or pushed? Anything around or after the refresh time above may not be picked up yet — give it a few minutes.
  • Anything look wrong? Report it with what you expected; it helps us improve the dashboard.

@emdneto emdneto moved this to Ready for review in Python PR digest Aug 18, 2026
@emdneto emdneto added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Aug 18, 2026
@github-actions

Copy link
Copy Markdown

This PR has been automatically marked as stale because it has not had any activity for 14 days. It will be closed if no further activity occurs within 14 days of this comment.
If you're still working on this, please add a comment or push new commits.

@github-actions github-actions Bot added Stale and removed Stale labels Sep 17, 2026
@github-actions

github-actions Bot commented Oct 2, 2026

Copy link
Copy Markdown

This PR has been automatically marked as stale because it has not had any activity for 14 days. It will be closed if no further activity occurs within 14 days of this comment.
If you're still working on this, please add a comment or push new commits.

@github-actions github-actions Bot added Stale and removed Stale labels Oct 2, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Skip Changelog PRs that do not require a CHANGELOG.md entry

Projects

Status: Ready for review

Development

Successfully merging this pull request may close these issues.

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

2 participants