audit - Chirp

security.audit

module

Security audit events.

Small opt-in event channel for authentication and authorization telemetry. Applications can register a sink to forward events to logs, metrics, or SIEM.

Security audit events.

Small opt-in event channel for authentication and authorization telemetry. Applications can register a sink to forward events to logs, metrics, or SIEM.

security.audit

Name	Type	Default	Description
`type`		—
`qualified_name`		—
`element_type`		—
`description`		—
`source_file`		—
`line_number`		—
`is_autodoc`		—
`autodoc_element`		—
`_autodoc_template`		—
`_autodoc_url_path`		—
`_autodoc_page_type`		—
`title`		—
`doc_content_hash`		—

Symbols on this page

class SecurityEvent

A structured security event.

function set_security_event_sink

Set a process-wide sink for security events.

PassNoneto disable event delivery.

function emit_security_event

Emit a best-effort security event to the configured sink.

SecurityEvent

class

A structured security event.

set_security_event_sink

function

def set_security_event_sink(sink: SecurityEventSink | None) -> None

Set a process-wide sink for security events.

PassNoneto disable event delivery.

Parameters

Name	Type	Default	Description
`sink`	`SecurityEventSink \| None`	—

emit_security_event

function

def emit_security_event(name: str, *, request: Any | None = None, user_id: str | None = None, details: dict[str, Any] | None = None) -> None

Emit a best-effort security event to the configured sink.

Parameters

Name	Type	Default
`name`	`str`	—
`request`	`Any \| None`	`None`
`user_id`	`str \| None`	`None`
`details`	`dict[str, Any] \| None`	`None`

View source · /home/runner/work/chirp/chirp/site/../src/chirp/security/audit.py:1