mirror of
https://mau.dev/maunium/synapse.git
synced 2024-06-02 02:38:59 +02:00
330 lines
11 KiB
Python
330 lines
11 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright 2019 The Matrix.org Foundation C.I.C.
|
|
#
|
|
# 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.
|
|
|
|
"""
|
|
Log formatters that output terse JSON.
|
|
"""
|
|
|
|
import json
|
|
import sys
|
|
import traceback
|
|
from collections import deque
|
|
from ipaddress import IPv4Address, IPv6Address, ip_address
|
|
from math import floor
|
|
from typing import IO, Optional
|
|
|
|
import attr
|
|
from zope.interface import implementer
|
|
|
|
from twisted.application.internet import ClientService
|
|
from twisted.internet.defer import Deferred
|
|
from twisted.internet.endpoints import (
|
|
HostnameEndpoint,
|
|
TCP4ClientEndpoint,
|
|
TCP6ClientEndpoint,
|
|
)
|
|
from twisted.internet.interfaces import IPushProducer, ITransport
|
|
from twisted.internet.protocol import Factory, Protocol
|
|
from twisted.logger import FileLogObserver, ILogObserver, Logger
|
|
|
|
_encoder = json.JSONEncoder(ensure_ascii=False, separators=(",", ":"))
|
|
|
|
|
|
def flatten_event(event: dict, metadata: dict, include_time: bool = False):
|
|
"""
|
|
Flatten a Twisted logging event to an dictionary capable of being sent
|
|
as a log event to a logging aggregation system.
|
|
|
|
The format is vastly simplified and is not designed to be a "human readable
|
|
string" in the sense that traditional logs are. Instead, the structure is
|
|
optimised for searchability and filtering, with human-understandable log
|
|
keys.
|
|
|
|
Args:
|
|
event (dict): The Twisted logging event we are flattening.
|
|
metadata (dict): Additional data to include with each log message. This
|
|
can be information like the server name. Since the target log
|
|
consumer does not know who we are other than by host IP, this
|
|
allows us to forward through static information.
|
|
include_time (bool): Should we include the `time` key? If False, the
|
|
event time is stripped from the event.
|
|
"""
|
|
new_event = {}
|
|
|
|
# If it's a failure, make the new event's log_failure be the traceback text.
|
|
if "log_failure" in event:
|
|
new_event["log_failure"] = event["log_failure"].getTraceback()
|
|
|
|
# If it's a warning, copy over a string representation of the warning.
|
|
if "warning" in event:
|
|
new_event["warning"] = str(event["warning"])
|
|
|
|
# Stdlib logging events have "log_text" as their human-readable portion,
|
|
# Twisted ones have "log_format". For now, include the log_format, so that
|
|
# context only given in the log format (e.g. what is being logged) is
|
|
# available.
|
|
if "log_text" in event:
|
|
new_event["log"] = event["log_text"]
|
|
else:
|
|
new_event["log"] = event["log_format"]
|
|
|
|
# We want to include the timestamp when forwarding over the network, but
|
|
# exclude it when we are writing to stdout. This is because the log ingester
|
|
# (e.g. logstash, fluentd) can add its own timestamp.
|
|
if include_time:
|
|
new_event["time"] = round(event["log_time"], 2)
|
|
|
|
# Convert the log level to a textual representation.
|
|
new_event["level"] = event["log_level"].name.upper()
|
|
|
|
# Ignore these keys, and do not transfer them over to the new log object.
|
|
# They are either useless (isError), transferred manually above (log_time,
|
|
# log_level, etc), or contain Python objects which are not useful for output
|
|
# (log_logger, log_source).
|
|
keys_to_delete = [
|
|
"isError",
|
|
"log_failure",
|
|
"log_format",
|
|
"log_level",
|
|
"log_logger",
|
|
"log_source",
|
|
"log_system",
|
|
"log_time",
|
|
"log_text",
|
|
"observer",
|
|
"warning",
|
|
]
|
|
|
|
# If it's from the Twisted legacy logger (twisted.python.log), it adds some
|
|
# more keys we want to purge.
|
|
if event.get("log_namespace") == "log_legacy":
|
|
keys_to_delete.extend(["message", "system", "time"])
|
|
|
|
# Rather than modify the dictionary in place, construct a new one with only
|
|
# the content we want. The original event should be considered 'frozen'.
|
|
for key in event.keys():
|
|
|
|
if key in keys_to_delete:
|
|
continue
|
|
|
|
if isinstance(event[key], (str, int, bool, float)) or event[key] is None:
|
|
# If it's a plain type, include it as is.
|
|
new_event[key] = event[key]
|
|
else:
|
|
# If it's not one of those basic types, write out a string
|
|
# representation. This should probably be a warning in development,
|
|
# so that we are sure we are only outputting useful data.
|
|
new_event[key] = str(event[key])
|
|
|
|
# Add the metadata information to the event (e.g. the server_name).
|
|
new_event.update(metadata)
|
|
|
|
return new_event
|
|
|
|
|
|
def TerseJSONToConsoleLogObserver(outFile: IO[str], metadata: dict) -> FileLogObserver:
|
|
"""
|
|
A log observer that formats events to a flattened JSON representation.
|
|
|
|
Args:
|
|
outFile: The file object to write to.
|
|
metadata: Metadata to be added to each log object.
|
|
"""
|
|
|
|
def formatEvent(_event: dict) -> str:
|
|
flattened = flatten_event(_event, metadata)
|
|
return _encoder.encode(flattened) + "\n"
|
|
|
|
return FileLogObserver(outFile, formatEvent)
|
|
|
|
|
|
@attr.s
|
|
@implementer(IPushProducer)
|
|
class LogProducer(object):
|
|
"""
|
|
An IPushProducer that writes logs from its buffer to its transport when it
|
|
is resumed.
|
|
|
|
Args:
|
|
buffer: Log buffer to read logs from.
|
|
transport: Transport to write to.
|
|
"""
|
|
|
|
transport = attr.ib(type=ITransport)
|
|
_buffer = attr.ib(type=deque)
|
|
_paused = attr.ib(default=False, type=bool, init=False)
|
|
|
|
def pauseProducing(self):
|
|
self._paused = True
|
|
|
|
def stopProducing(self):
|
|
self._paused = True
|
|
self._buffer = None
|
|
|
|
def resumeProducing(self):
|
|
self._paused = False
|
|
|
|
while self._paused is False and (self._buffer and self.transport.connected):
|
|
try:
|
|
event = self._buffer.popleft()
|
|
self.transport.write(_encoder.encode(event).encode("utf8"))
|
|
self.transport.write(b"\n")
|
|
except Exception:
|
|
# Something has gone wrong writing to the transport -- log it
|
|
# and break out of the while.
|
|
traceback.print_exc(file=sys.__stderr__)
|
|
break
|
|
|
|
|
|
@attr.s
|
|
@implementer(ILogObserver)
|
|
class TerseJSONToTCPLogObserver(object):
|
|
"""
|
|
An IObserver that writes JSON logs to a TCP target.
|
|
|
|
Args:
|
|
hs (HomeServer): The homeserver that is being logged for.
|
|
host: The host of the logging target.
|
|
port: The logging target's port.
|
|
metadata: Metadata to be added to each log entry.
|
|
"""
|
|
|
|
hs = attr.ib()
|
|
host = attr.ib(type=str)
|
|
port = attr.ib(type=int)
|
|
metadata = attr.ib(type=dict)
|
|
maximum_buffer = attr.ib(type=int)
|
|
_buffer = attr.ib(default=attr.Factory(deque), type=deque)
|
|
_connection_waiter = attr.ib(default=None, type=Optional[Deferred])
|
|
_logger = attr.ib(default=attr.Factory(Logger))
|
|
_producer = attr.ib(default=None, type=Optional[LogProducer])
|
|
|
|
def start(self) -> None:
|
|
|
|
# Connect without DNS lookups if it's a direct IP.
|
|
try:
|
|
ip = ip_address(self.host)
|
|
if isinstance(ip, IPv4Address):
|
|
endpoint = TCP4ClientEndpoint(
|
|
self.hs.get_reactor(), self.host, self.port
|
|
)
|
|
elif isinstance(ip, IPv6Address):
|
|
endpoint = TCP6ClientEndpoint(
|
|
self.hs.get_reactor(), self.host, self.port
|
|
)
|
|
except ValueError:
|
|
endpoint = HostnameEndpoint(self.hs.get_reactor(), self.host, self.port)
|
|
|
|
factory = Factory.forProtocol(Protocol)
|
|
self._service = ClientService(endpoint, factory, clock=self.hs.get_reactor())
|
|
self._service.startService()
|
|
self._connect()
|
|
|
|
def stop(self):
|
|
self._service.stopService()
|
|
|
|
def _connect(self) -> None:
|
|
"""
|
|
Triggers an attempt to connect then write to the remote if not already writing.
|
|
"""
|
|
if self._connection_waiter:
|
|
return
|
|
|
|
self._connection_waiter = self._service.whenConnected(failAfterFailures=1)
|
|
|
|
@self._connection_waiter.addErrback
|
|
def fail(r):
|
|
r.printTraceback(file=sys.__stderr__)
|
|
self._connection_waiter = None
|
|
self._connect()
|
|
|
|
@self._connection_waiter.addCallback
|
|
def writer(r):
|
|
# We have a connection. If we already have a producer, and its
|
|
# transport is the same, just trigger a resumeProducing.
|
|
if self._producer and r.transport is self._producer.transport:
|
|
self._producer.resumeProducing()
|
|
self._connection_waiter = None
|
|
return
|
|
|
|
# If the producer is still producing, stop it.
|
|
if self._producer:
|
|
self._producer.stopProducing()
|
|
|
|
# Make a new producer and start it.
|
|
self._producer = LogProducer(buffer=self._buffer, transport=r.transport)
|
|
r.transport.registerProducer(self._producer, True)
|
|
self._producer.resumeProducing()
|
|
self._connection_waiter = None
|
|
|
|
def _handle_pressure(self) -> None:
|
|
"""
|
|
Handle backpressure by shedding events.
|
|
|
|
The buffer will, in this order, until the buffer is below the maximum:
|
|
- Shed DEBUG events
|
|
- Shed INFO events
|
|
- Shed the middle 50% of the events.
|
|
"""
|
|
if len(self._buffer) <= self.maximum_buffer:
|
|
return
|
|
|
|
# Strip out DEBUGs
|
|
self._buffer = deque(
|
|
filter(lambda event: event["level"] != "DEBUG", self._buffer)
|
|
)
|
|
|
|
if len(self._buffer) <= self.maximum_buffer:
|
|
return
|
|
|
|
# Strip out INFOs
|
|
self._buffer = deque(
|
|
filter(lambda event: event["level"] != "INFO", self._buffer)
|
|
)
|
|
|
|
if len(self._buffer) <= self.maximum_buffer:
|
|
return
|
|
|
|
# Cut the middle entries out
|
|
buffer_split = floor(self.maximum_buffer / 2)
|
|
|
|
old_buffer = self._buffer
|
|
self._buffer = deque()
|
|
|
|
for i in range(buffer_split):
|
|
self._buffer.append(old_buffer.popleft())
|
|
|
|
end_buffer = []
|
|
for i in range(buffer_split):
|
|
end_buffer.append(old_buffer.pop())
|
|
|
|
self._buffer.extend(reversed(end_buffer))
|
|
|
|
def __call__(self, event: dict) -> None:
|
|
flattened = flatten_event(event, self.metadata, include_time=True)
|
|
self._buffer.append(flattened)
|
|
|
|
# Handle backpressure, if it exists.
|
|
try:
|
|
self._handle_pressure()
|
|
except Exception:
|
|
# If handling backpressure fails,clear the buffer and log the
|
|
# exception.
|
|
self._buffer.clear()
|
|
self._logger.failure("Failed clearing backpressure")
|
|
|
|
# Try and write immediately.
|
|
self._connect()
|