import datetime import functools import logging import os import re from collections import namedtuple from typing import Any, Callable, Dict, Iterable, List, Tuple # noqa from .abc import AbstractAccessLogger from .web_request import BaseRequest from .web_response import StreamResponse KeyMethod = namedtuple("KeyMethod", "key method") class AccessLogger(AbstractAccessLogger): """Helper object to log access. Usage: log = logging.getLogger("spam") log_format = "%a %{User-Agent}i" access_logger = AccessLogger(log, log_format) access_logger.log(request, response, time) Format: %% The percent sign %a Remote IP-address (IP-address of proxy if using reverse proxy) %t Time when the request was started to process %P The process ID of the child that serviced the request %r First line of request %s Response status code %b Size of response in bytes, including HTTP headers %T Time taken to serve the request, in seconds %Tf Time taken to serve the request, in seconds with floating fraction in .06f format %D Time taken to serve the request, in microseconds %{FOO}i request.headers['FOO'] %{FOO}o response.headers['FOO'] %{FOO}e os.environ['FOO'] """ LOG_FORMAT_MAP = { "a": "remote_address", "t": "request_start_time", "P": "process_id", "r": "first_request_line", "s": "response_status", "b": "response_size", "T": "request_time", "Tf": "request_time_frac", "D": "request_time_micro", "i": "request_header", "o": "response_header", } LOG_FORMAT = '%a %t "%r" %s %b "%{Referer}i" "%{User-Agent}i"' FORMAT_RE = re.compile(r"%(\{([A-Za-z0-9\-_]+)\}([ioe])|[atPrsbOD]|Tf?)") CLEANUP_RE = re.compile(r"(%[^s])") _FORMAT_CACHE = {} # type: Dict[str, Tuple[str, List[KeyMethod]]] def __init__(self, logger: logging.Logger, log_format: str = LOG_FORMAT) -> None: """Initialise the logger. logger is a logger object to be used for logging. log_format is a string with apache compatible log format description. """ super().__init__(logger, log_format=log_format) _compiled_format = AccessLogger._FORMAT_CACHE.get(log_format) if not _compiled_format: _compiled_format = self.compile_format(log_format) AccessLogger._FORMAT_CACHE[log_format] = _compiled_format self._log_format, self._methods = _compiled_format def compile_format(self, log_format: str) -> Tuple[str, List[KeyMethod]]: """Translate log_format into form usable by modulo formatting All known atoms will be replaced with %s Also methods for formatting of those atoms will be added to _methods in appropriate order For example we have log_format = "%a %t" This format will be translated to "%s %s" Also contents of _methods will be [self._format_a, self._format_t] These method will be called and results will be passed to translated string format. Each _format_* method receive 'args' which is list of arguments given to self.log Exceptions are _format_e, _format_i and _format_o methods which also receive key name (by functools.partial) """ # list of (key, method) tuples, we don't use an OrderedDict as users # can repeat the same key more than once methods = list() for atom in self.FORMAT_RE.findall(log_format): if atom[1] == "": format_key1 = self.LOG_FORMAT_MAP[atom[0]] m = getattr(AccessLogger, "_format_%s" % atom[0]) key_method = KeyMethod(format_key1, m) else: format_key2 = (self.LOG_FORMAT_MAP[atom[2]], atom[1]) m = getattr(AccessLogger, "_format_%s" % atom[2]) key_method = KeyMethod(format_key2, functools.partial(m, atom[1])) methods.append(key_method) log_format = self.FORMAT_RE.sub(r"%s", log_format) log_format = self.CLEANUP_RE.sub(r"%\1", log_format) return log_format, methods @staticmethod def _format_i( key: str, request: BaseRequest, response: StreamResponse, time: float ) -> str: if request is None: return "(no headers)" # suboptimal, make istr(key) once return request.headers.get(key, "-") @staticmethod def _format_o( key: str, request: BaseRequest, response: StreamResponse, time: float ) -> str: # suboptimal, make istr(key) once return response.headers.get(key, "-") @staticmethod def _format_a(request: BaseRequest, response: StreamResponse, time: float) -> str: if request is None: return "-" ip = request.remote return ip if ip is not None else "-" @staticmethod def _format_t(request: BaseRequest, response: StreamResponse, time: float) -> str: now = datetime.datetime.utcnow() start_time = now - datetime.timedelta(seconds=time) return start_time.strftime("[%d/%b/%Y:%H:%M:%S +0000]") @staticmethod def _format_P(request: BaseRequest, response: StreamResponse, time: float) -> str: return "<%s>" % os.getpid() @staticmethod def _format_r(request: BaseRequest, response: StreamResponse, time: float) -> str: if request is None: return "-" return "{} {} HTTP/{}.{}".format( request.method, request.path_qs, request.version.major, request.version.minor, ) @staticmethod def _format_s(request: BaseRequest, response: StreamResponse, time: float) -> int: return response.status @staticmethod def _format_b(request: BaseRequest, response: StreamResponse, time: float) -> int: return response.body_length @staticmethod def _format_T(request: BaseRequest, response: StreamResponse, time: float) -> str: return str(round(time)) @staticmethod def _format_Tf(request: BaseRequest, response: StreamResponse, time: float) -> str: return "%06f" % time @staticmethod def _format_D(request: BaseRequest, response: StreamResponse, time: float) -> str: return str(round(time * 1000000)) def _format_line( self, request: BaseRequest, response: StreamResponse, time: float ) -> Iterable[Tuple[str, Callable[[BaseRequest, StreamResponse, float], str]]]: return [(key, method(request, response, time)) for key, method in self._methods] def log(self, request: BaseRequest, response: StreamResponse, time: float) -> None: try: fmt_info = self._format_line(request, response, time) values = list() extra = dict() for key, value in fmt_info: values.append(value) if key.__class__ is str: extra[key] = value else: k1, k2 = key # type: ignore dct = extra.get(k1, {}) # type: ignore dct[k2] = value # type: ignore extra[k1] = dct # type: ignore self.logger.info(self._log_format % tuple(values), extra=extra) except Exception: self.logger.exception("Error in logging")
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
.hash | Folder | 0755 |
|
|
__pycache__ | Folder | 0755 |
|
|
__init__.py | File | 6.77 KB | 0644 |
|
_cparser.pxd | File | 3.87 KB | 0644 |
|
_find_header.c | File | 183.17 KB | 0644 |
|
_find_header.h | File | 170 B | 0644 |
|
_find_header.pxd | File | 68 B | 0644 |
|
_frozenlist.c | File | 287.3 KB | 0644 |
|
_frozenlist.cpython-38-x86_64-linux-gnu.so | File | 337.8 KB | 0755 |
|
_frozenlist.pyx | File | 2.54 KB | 0644 |
|
_headers.pxi | File | 1.96 KB | 0644 |
|
_helpers.c | File | 207.02 KB | 0644 |
|
_helpers.cpython-38-x86_64-linux-gnu.so | File | 223.16 KB | 0755 |
|
_helpers.pyi | File | 202 B | 0644 |
|
_helpers.pyx | File | 1.02 KB | 0644 |
|
_http_parser.c | File | 987.82 KB | 0644 |
|
_http_parser.cpython-38-x86_64-linux-gnu.so | File | 2.17 MB | 0755 |
|
_http_parser.pyx | File | 28.34 KB | 0644 |
|
_http_writer.c | File | 208.03 KB | 0644 |
|
_http_writer.cpython-38-x86_64-linux-gnu.so | File | 199.89 KB | 0755 |
|
_http_writer.pyx | File | 4.1 KB | 0644 |
|
_websocket.c | File | 134.21 KB | 0644 |
|
_websocket.cpython-38-x86_64-linux-gnu.so | File | 98.52 KB | 0755 |
|
_websocket.pyx | File | 1.52 KB | 0644 |
|
abc.py | File | 5.12 KB | 0644 |
|
base_protocol.py | File | 2.64 KB | 0644 |
|
client.py | File | 42.89 KB | 0644 |
|
client_exceptions.py | File | 8.33 KB | 0644 |
|
client_proto.py | File | 7.97 KB | 0644 |
|
client_reqrep.py | File | 35.58 KB | 0644 |
|
client_ws.py | File | 10.05 KB | 0644 |
|
connector.py | File | 41.96 KB | 0644 |
|
cookiejar.py | File | 11.88 KB | 0644 |
|
formdata.py | File | 5.94 KB | 0644 |
|
frozenlist.py | File | 1.68 KB | 0644 |
|
frozenlist.pyi | File | 1.4 KB | 0644 |
|
hdrs.py | File | 3.37 KB | 0644 |
|
helpers.py | File | 22.38 KB | 0644 |
|
http.py | File | 1.78 KB | 0644 |
|
http_exceptions.py | File | 2.53 KB | 0644 |
|
http_parser.py | File | 30.06 KB | 0644 |
|
http_websocket.py | File | 24.51 KB | 0644 |
|
http_writer.py | File | 5.22 KB | 0644 |
|
locks.py | File | 1.19 KB | 0644 |
|
log.py | File | 325 B | 0644 |
|
multipart.py | File | 31.5 KB | 0644 |
|
payload.py | File | 13.02 KB | 0644 |
|
payload_streamer.py | File | 2.05 KB | 0644 |
|
py.typed | File | 7 B | 0644 |
|
pytest_plugin.py | File | 10.75 KB | 0644 |
|
resolver.py | File | 4.5 KB | 0644 |
|
signals.py | File | 852 B | 0644 |
|
signals.pyi | File | 319 B | 0644 |
|
streams.py | File | 20.05 KB | 0644 |
|
tcp_helpers.py | File | 962 B | 0644 |
|
test_utils.py | File | 19.78 KB | 0644 |
|
tracing.py | File | 14.03 KB | 0644 |
|
typedefs.py | File | 1.34 KB | 0644 |
|
web.py | File | 17.46 KB | 0644 |
|
web_app.py | File | 16.65 KB | 0644 |
|
web_exceptions.py | File | 9.87 KB | 0644 |
|
web_fileresponse.py | File | 8.81 KB | 0644 |
|
web_log.py | File | 7.32 KB | 0644 |
|
web_middlewares.py | File | 4.09 KB | 0644 |
|
web_protocol.py | File | 22.71 KB | 0644 |
|
web_request.py | File | 25.83 KB | 0644 |
|
web_response.py | File | 25.59 KB | 0644 |
|
web_routedef.py | File | 5.97 KB | 0644 |
|
web_runner.py | File | 10.93 KB | 0644 |
|
web_server.py | File | 2.01 KB | 0644 |
|
web_urldispatcher.py | File | 38.61 KB | 0644 |
|
web_ws.py | File | 16.39 KB | 0644 |
|
worker.py | File | 7.83 KB | 0644 |
|