ORIONIS API REFERENCE

THE ORIONIS API

Build with clarity.

Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.

class documentation

class FailureContext: (source)

View In Hierarchy

Immutable, bounded context delivered to the application failure hook.

Method __post_init__ Copy bounded metadata and redact values under credential-like keys.
Class Variable correlation_id Identifier shared by incidents within the same operation.
Class Variable event_id Identifier assigned to this incident when observation begins.
Class Variable expected Whether default policy should omit ordinary error logging.
Class Variable flow Execution flow owning the failure, such as HTTP, CLI, or worker.
Class Variable metadata Read-only, bounded scalar metadata with credential-like values redacted.
Class Variable operation Optional logical operation name supplied by the execution owner.
Class Variable parent_event_id Previously observed cause associated with this secondary incident.
Class Variable phase Stage within the owning flow at which the failure was observed.
Class Variable reporting_allowed Whether logging resources remain available for deferred reporting.
def __post_init__(self): (source)

Copy bounded metadata and redact values under credential-like keys.

Keep at most 32 entries with string keys and supported scalar values. Truncate keys to 128 characters and string values to 1024 characters. Replace metadata with a read-only mapping of the sanitized entries.

Returns
NoneNo return value.
correlation_id: str | None = (source)

Identifier shared by incidents within the same operation.

event_id: str | None = (source)

Identifier assigned to this incident when observation begins.

expected: bool = (source)

Whether default policy should omit ordinary error logging.

Execution flow owning the failure, such as HTTP, CLI, or worker.

metadata: Mapping[str, object] = (source)

Read-only, bounded scalar metadata with credential-like values redacted.

operation: str | None = (source)

Optional logical operation name supplied by the execution owner.

parent_event_id: str | None = (source)

Previously observed cause associated with this secondary incident.

Stage within the owning flow at which the failure was observed.

reporting_allowed: bool = (source)

Whether logging resources remain available for deferred reporting.