prefect.events.clients
Functions
http_to_ws
events_in_socket_from_api_url
events_out_socket_from_api_url
get_events_client
get_events_subscriber
Classes
EventsClient
The abstract interface for all Prefect Events clients
Methods:
client_name
emit
NullEventsClient
A Prefect Events client implementation that does nothing
Methods:
client_name
emit
AssertingEventsClient
A Prefect Events client that records all events sent to it for inspection during
tests.
Methods:
client_name
emit
pop_events
reset
PrefectEventsClient
A Prefect Events client that streams events to a Prefect server
Methods:
client_name
emit
AssertingPassthroughEventsClient
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
reset
PrefectCloudEventsClient
A Prefect Events client that streams events to a Prefect Cloud Workspace
PrefectEventSubscriber
Subscribes to a Prefect event stream, yielding events as they occur.
Abnormal disconnects are retried. Clean disconnects end iteration unless
reconnect_on_clean_close is enabled. Event backfill and ID-based
deduplication cover the reconnect window.
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: