StreamedLogAsync

Async variant of StreamedLog that is logging in tasks.

Hierarchy

• StreamedLog
  • StreamedLogAsync

Index

Methods

• __aenter__
• __aexit__
• __init__
• start
• stop

Methods

__aenter__

• async __aenter__(): Self

• Start the streaming task within the context. Exiting the context will cancel the streaming task.

  ---

  Returns Self

__aexit__

• async __aexit__(exc_type, exc_val, exc_tb): None

• Cancel the streaming task.

  ---

  Parameters

  • exc_type: type[BaseException] | None

  • exc_val: BaseException | None

  • exc_tb: TracebackType | None

  Returns None

__init__

• __init__(to_logger, *, from_start): None

• Overrides StreamedLog.__init__

  Initialize StreamedLog.

  ---

  Parameters

  • to_logger: logging.Logger

    The logger to which the logs will be redirected.

  • optionalkeyword-onlyfrom_start: bool = True

    If True, all logs from the start of the actor run will be redirected. If False, only newly arrived logs will be redirected. This can be useful for redirecting only a small portion of relevant logs for long-running actors in stand-by.

  Returns None

start

• start(): Task

• Start the streaming task. The caller has to handle any cleanup by manually calling the stop method.

  ---

  Returns Task

stop

• async stop(): None

• Stop the streaming task.

  ---

  Returns None