yera.security.redaction

Structured redaction for diagnostic values.

Symbols

def install_sensitive_data_filter — Attach structured redaction to every configured root handler.
def redact_sensitive_fields — Return diagnostic data with structured secret fields redacted.
class SensitiveDataFilter — Redact structured secret fields from log records.

install_sensitive_data_filter

install_sensitive_data_filter() → None

Attach structured redaction to every configured root handler.

redact_sensitive_fields

redact_sensitive_fields(
    value: object,
) → object

Return diagnostic data with structured secret fields redacted.

Parameters

value
type: object

Nested dictionaries, lists, tuples, or scalar diagnostic data.

Returns

type: object

A copied structure in which recognized sensitive fields contain redaction markers.

SensitiveDataFilter

Inherits: logging.Filter

Redact structured secret fields from log records.

Methods

filter — Redact structured values before a record is formatted.

SensitiveDataFilter.filter

filter(
    record: logging.LogRecord,
) → bool

Redact structured values before a record is formatted.

Parameters

record
type: logging.LogRecord

Mutable logging record entering a handler.

Returns

type: bool

Always True so the redacted record remains loggable.