As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Python Logging Handler Threaded Transport

Transport for Python logging handler

Uses a background worker to log to Cloud Logging asynchronously.

class google.cloud.logging_v2.handlers.transports.background_thread.BackgroundThreadTransport(client, name, *, grace_period=5.0, batch_size=10, max_latency=0)[source]

Bases: google.cloud.logging_v2.handlers.transports.base.Transport

Asynchronous transport that uses a background thread.

Parameters
  • client (Client) – The Logging client.

  • name (str) – The name of the lgoger.

  • grace_period (Optional[float]) – The amount of time to wait for pending logs to be submitted when the process is shutting down.

  • batch_size (Optional[int]) – The maximum number of items to send at a time in the background thread.

  • max_latency (Optional[float]) – The amount of time to wait for new logs before sending a new batch. It is strongly recommended to keep this smaller than the grace_period. This means this is effectively the longest amount of time the background thread will hold onto log entries before sending them to the server.

flush()[source]

Submit any pending log records.

send(record, message, **kwargs)[source]

Overrides Transport.send().

Parameters
  • record (logging.LogRecord) – Python log record that the handler was called with.

  • message (str) – The message from the LogRecord after being formatted by the associated log formatters.

  • kwargs – Additional optional arguments for the logger