Back to Prefect

configuration

docs/v3/api-ref/python/prefect-logging-configuration.mdx

3.6.30.dev31.3 KB
Original Source

prefect.logging.configuration

Functions

load_logging_config <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/logging/configuration.py#L32" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
load_logging_config(path: Path) -> dict[str, Any]

Loads logging configuration from a path allowing override from the environment

ensure_logging_setup <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/logging/configuration.py#L68" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
ensure_logging_setup() -> None

Ensure Prefect logging is configured in this process, calling setup_logging only if it has not already been called.

Use this in remote execution environments (e.g. Dask/Ray workers) where the normal SDK entry point (import prefect) may not have triggered logging configuration.

setup_logging <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/logging/configuration.py#L81" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
setup_logging(incremental: bool | None = None) -> dict[str, Any]

Sets up logging.

Returns the config used.