prefect.events.clients

Functions

http_to_ws ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/clients.py#L89" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

http_to_ws(url: str) -> str

events_in_socket_from_api_url ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/clients.py#L93" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

events_in_socket_from_api_url(url: str) -> str

events_out_socket_from_api_url ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/clients.py#L97" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

events_out_socket_from_api_url(url: str) -> str

get_events_client ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/clients.py#L101" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

get_events_client(reconnection_attempts: int = 10, checkpoint_every: int = 700, checkpoint_interval: float = 30.0) -> 'EventsClient'

get_events_subscriber ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/clients.py#L136" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

get_events_subscriber(filter: Optional['EventFilter'] = None, reconnection_attempts: int = 10) -> 'PrefectEventSubscriber'

Classes

EventsClient ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/clients.py#L166" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

The abstract interface for all Prefect Events clients

Methods:

client_name ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/clients.py#L170" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

client_name(self) -> str

emit ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/clients.py#L173" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

emit(self, event: Event) -> None

Emit a single event

NullEventsClient ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/clients.py#L204" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

A Prefect Events client implementation that does nothing

Methods:

client_name ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/clients.py#L170" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

client_name(self) -> str

emit ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/clients.py#L173" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

emit(self, event: Event) -> None

Emit a single event

AssertingEventsClient ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/clients.py#L211" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

A Prefect Events client that records all events sent to it for inspection during tests.

Methods:

client_name ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/clients.py#L170" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

client_name(self) -> str

emit ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/clients.py#L173" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

emit(self, event: Event) -> None

Emit a single event

pop_events ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/clients.py#L235" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

pop_events(self) -> List[Event]

reset ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/clients.py#L229" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

reset(cls) -> None

Reset all captured instances and their events. For use between tests

PrefectEventsClient ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/clients.py#L263" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

A Prefect Events client that streams events to a Prefect server

Methods:

client_name ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/clients.py#L170" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

client_name(self) -> str

emit ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/clients.py#L173" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

emit(self, event: Event) -> None

Emit a single event

AssertingPassthroughEventsClient ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/clients.py#L553" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

A Prefect Events client that BOTH records all events sent to it for inspection during tests AND sends them to a Prefect server.

Methods:

pop_events ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/clients.py#L576" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

pop_events(self) -> list[Event]

reset ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/clients.py#L572" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

reset(cls) -> None

PrefectCloudEventsClient ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/clients.py#L594" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

A Prefect Events client that streams events to a Prefect Cloud Workspace

PrefectEventSubscriber ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/clients.py#L640" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Subscribes to a Prefect event stream, yielding events as they occur.

Example:

from prefect.events.clients import PrefectEventSubscriber
from prefect.events.filters import EventFilter, EventNameFilter

filter = EventFilter(event=EventNameFilter(prefix=["prefect.flow-run."]))

async with PrefectEventSubscriber(filter=filter) as subscriber:
    async for event in subscriber:
        print(event.occurred, event.resource.id, event.event)

Methods:

client_name ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/clients.py#L707" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

client_name(self) -> str

PrefectCloudEventSubscriber ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/clients.py#L858" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Methods:

client_name ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/clients.py#L707" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

client_name(self) -> str

PrefectCloudAccountEventSubscriber ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/clients.py#L884" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}