prefect.logging.handlers

Functions

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

set_api_log_sink(sink: Callable[[Dict[str, Any]], None] | None) -> None

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

emit_api_log(log: Dict[str, Any]) -> None

Classes

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

Methods:

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

instance(cls: Type[Self], *args: Any) -> Self

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

max_batch_size(self) -> int

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

min_interval(self) -> float | None

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

A logging handler that sends logs to the Prefect API.

Sends log records to the APILogWorker which manages sending batches of logs in the background.

Methods:

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

aflush(cls) -> None

Tell the APILogWorker to send any currently enqueued logs and block until completion.

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

emit(self, record: logging.LogRecord) -> None

Send a log to the APILogWorker

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

flush(self) -> None

Tell the APILogWorker to send any currently enqueued logs and block until completion.

Use aflush from async contexts instead.

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

handleError(self, record: logging.LogRecord) -> None

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

prepare(self, record: logging.LogRecord) -> Dict[str, Any]

Convert a logging.LogRecord to the API LogCreate schema and serialize.

This infers the linked flow or task run from the log record or the current run context.

If a flow run id cannot be found, the log will be dropped.

Logs exceeding the maximum size will be dropped.

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

Methods:

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

aflush(cls) -> None

Tell the APILogWorker to send any currently enqueued logs and block until completion.

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

emit(self, record: logging.LogRecord) -> None

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

emit(self, record: logging.LogRecord) -> None

Send a log to the APILogWorker

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

flush(self) -> None

Tell the APILogWorker to send any currently enqueued logs and block until completion.

Use aflush from async contexts instead.

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

handleError(self, record: logging.LogRecord) -> None

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

prepare(self, record: logging.LogRecord) -> Dict[str, Any]

Convert a logging.LogRecord to the API LogCreate schema and serialize.

This will add in the worker id to the log.

Logs exceeding the maximum size will be dropped.

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

prepare(self, record: logging.LogRecord) -> Dict[str, Any]

Convert a logging.LogRecord to the API LogCreate schema and serialize.

This infers the linked flow or task run from the log record or the current run context.

If a flow run id cannot be found, the log will be dropped.

Logs exceeding the maximum size will be dropped.

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

Methods:

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

emit(self, record: logging.LogRecord) -> None