temporalio.workflow.LoggerAdapter

class documentation

class LoggerAdapter(logging.LoggerAdapter): (source)

Constructor: LoggerAdapter(logger, extra)

Adapter that adds details to the log about the running workflow.

Values added to extra are merged with the extra dictionary from a logging call, with values from the logging call taking precedence. I.e. the behavior is that of merge_extra=True in Python >= 3.13.

Method	`__init__`	Create the logger adapter.
Method	`isEnabledFor`	Override to ignore replay logs.
Method	`process`	Override to add workflow details.
Instance Variable	`full_workflow_info_on_extra`	Boolean for whether a `workflow_info` value will be added to the `extra` dictionary with the entire workflow info, making it present on the `LogRecord.__dict__` for use by others. Default is False.
Instance Variable	`log_during_replay`	Boolean for whether logs should occur during replay. Default is False.
Instance Variable	`workflow_info_on_extra`	Boolean for whether a `temporal_workflow` dictionary value will be added to the `extra` dictionary with some workflow info, making it present on the `LogRecord.__dict__` for use by others. Default is True.
Instance Variable	`workflow_info_on_message`	Boolean for whether a string representation of a dict of some workflow info will be appended to each message. Default is True.
Property	`base_logger`	Underlying logger usable for actions such as adding handlers/formatters.

def __init__(self, logger: logging.Logger, extra: Optional[Mapping[str, Any]]): (source) ¶

Create the logger adapter.

def isEnabledFor(self, level: int) -> bool: (source) ¶

Override to ignore replay logs.

def process(self, msg: Any, kwargs: MutableMapping[str, Any]) -> Tuple[Any, MutableMapping[str, Any]]: (source) ¶

Override to add workflow details.

full_workflow_info_on_extra: bool = (source) ¶

Boolean for whether a workflow_info value will be added to the extra dictionary with the entire workflow info, making it present on the LogRecord.__dict__ for use by others. Default is False.

log_during_replay: bool = (source) ¶

Boolean for whether logs should occur during replay. Default is False.

workflow_info_on_extra: bool = (source) ¶

Boolean for whether a temporal_workflow dictionary value will be added to the extra dictionary with some workflow info, making it present on the LogRecord.__dict__ for use by others. Default is True.

workflow_info_on_message: bool = (source) ¶

Boolean for whether a string representation of a dict of some workflow info will be appended to each message. Default is True.

@property
base_logger: logging.Logger = (source) ¶

Underlying logger usable for actions such as adding handlers/formatters.