Class StructuredLogHandler (3.0.0)

StructuredLogHandler(*, labels=None, stream=None, project_id=None)

Handler to format logs into the Cloud Logging structured log format, and write them to standard output

Methods

StructuredLogHandler

StructuredLogHandler(*, labels=None, stream=None, project_id=None)
Parameters
Name Description
labels Optional[dict]

Additional labels to attach to logs.

stream Optional[IO]

Stream to be used by the handler.

project Optional[str]

Project Id associated with the logs.

format

format(record)

Format the message into structured log JSON.

Parameter
Name Description
record logging.LogRecord

The log record.

Returns
Type Description
str A JSON string formatted for GCP structured logging.