Skip to content

docs(exceptions): explain request URL redaction #589

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nijel merged 1 commit into from
Oct 19, 2026
Merged

docs(exceptions): explain request URL redaction #589

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion docs/exceptions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,15 @@ HTTP header; applications must interpret it before using it.
``str(exception)`` and ``exception.args`` contain a safe default message.
Provider descriptions are available separately in ``detail``. ``context`` is
an explicitly supplied mapping for diagnostic identifiers, such as user ID and
provider UID. Original exceptions remain available through exception chaining.
provider UID. Original exception objects remain available through exception
chaining. HTTP and transport exception messages have request URLs replaced with
``<redacted-url>``, including URL paths and query strings. Other diagnostic text
and attached request and response objects remain available.

This redaction covers ordinary formatted tracebacks. Attached request and
response objects and captured traceback local variables can still contain
credentials; configure error trackers to scrub these separately.

Do not send diagnostics, raw responses, or identifying context to client URLs
or flash messages. Do not log tokens, cookies, or full authentication assertions.

Expand Down
Loading