/
structured_log.py
55 lines (44 loc) · 2.18 KB
/
structured_log.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
# Copyright 2021 Google LLC All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Logging handler for printing formatted structured logs to standard output.
"""
import logging.handlers
from google.cloud.logging_v2.handlers.handlers import CloudLoggingFilter
GCP_FORMAT = '{"message": "%(message)s", "severity": "%(levelname)s", "logging.googleapis.com/trace": "%(trace)s", "logging.googleapis.com/sourceLocation": { "file": "%(file)s", "line": "%(line)d", "function": "%(function)s"}, "httpRequest": {"requestMethod": "%(request_method)s", "requestUrl": "%(request_url)s", "userAgent": "%(user_agent)s", "protocol": "%(protocol)s"} }'
class StructuredLogHandler(logging.StreamHandler):
"""Handler to format logs into the Cloud Logging structured log format,
and write them to standard output
"""
def __init__(self, *, name=None, stream=None, project=None):
"""
Args:
name (Optional[str]): The name of the custom log in Cloud Logging.
stream (Optional[IO]): Stream to be used by the handler.
"""
super(StructuredLogHandler, self).__init__(stream=stream)
self.name = name
self.project_id = project
# add extra keys to log record
self.addFilter(CloudLoggingFilter(project))
# make logs appear in GCP structured logging format
self.formatter = logging.Formatter(GCP_FORMAT)
def format(self, record):
"""Format the message into structured log JSON.
Args:
record (logging.LogRecord): The log record.
Returns:
str: A JSON string formatted for GKE fluentd.
"""
payload = self.formatter.format(record)
return payload