Class StructuredLogHandler (3.2.3)

Version 3.2.3

• 3.11.3 (latest)
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.1
• 3.2.5
• 3.1.2
• 3.0.0
• 2.7.2
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.1
• 2.2.0
• 2.1.1
• 2.0.2
• 1.15.3
• 1.14.0
• 1.13.0
• 1.12.1

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

Inheritance

builtins.object > logging.Filterer > logging.Handler > logging.StreamHandler > StructuredLogHandler

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.

emit

emit(record)

Emit a record.

If a formatter is specified, it is used to format the record. The record is then written to the stream with a trailing newline. If exception information is present, it is formatted using traceback.print_exception and appended to the stream. If the stream has an 'encoding' attribute, it is used to determine how to do the output to the stream.

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.