Skip to content

common_http.transports.redaction

Credential-safe engine logging: mask credential query values in log records.

Engines such as HTTPX log each request URL at INFO. Provider API keys often travel in the query string, so those records must never carry their values.

Classes

QueryRedactor

Bases: logging.Filter

Mask credential query values in positional log-record arguments.

Carried state: a live view of credential parameter NAMES (the transport’s concealed set) beside QUERY_CREDENTIALS. Values are never retained. Everything else in the URL keeps its exact spelling.

__init__

def __init__(concealed: AbstractSet[str]) -> None

filter

def filter(record: logging.LogRecord) -> bool

mask

def mask(value: object) -> object

Return value with credential query values masked, or value unchanged.

Types and values

QUERY_CREDENTIALS

QUERY_CREDENTIALS = frozenset({'access_token', 'api_key', 'api_secret', 'api_token', 'apikey', 'client_secret', 'key', 'password', 'private_key', 'refresh_token', 'secret', 'signature', 'token', 'totp_secret'})