Class StructuredLogHandler (3.1.2)

Version latest

• 3.1.2 (latest)
• 3.1.1
• 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.1
• 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.

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.