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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
from __future__ import annotations
import json
import logging
import os
import sys
import time
from http import HTTPStatus
from logging.config import dictConfig, fileConfig
from typing import Any, IO, Mapping, Optional, TYPE_CHECKING, Union
if sys.version_info >= (3, 11):
import tomllib
else:
import tomli as tomllib
if TYPE_CHECKING:
from .config import Config
from .typing import ResponseSummary, WWWScope
def _create_logger(
name: str,
target: Union[logging.Logger, str, None],
level: Optional[str],
sys_default: IO,
*,
propagate: bool = True,
) -> Optional[logging.Logger]:
if isinstance(target, logging.Logger):
return target
if target:
logger = logging.getLogger(name)
logger.handlers = [
logging.StreamHandler(sys_default) if target == "-" else logging.FileHandler(target) # type: ignore # noqa: E501
]
logger.propagate = propagate
formatter = logging.Formatter(
"%(asctime)s [%(process)d] [%(levelname)s] %(message)s",
"[%Y-%m-%d %H:%M:%S %z]",
)
logger.handlers[0].setFormatter(formatter)
if level is not None:
logger.setLevel(logging.getLevelName(level.upper()))
return logger
else:
return None
class Logger:
def __init__(self, config: "Config") -> None:
self.access_log_format = config.access_log_format
self.access_logger = _create_logger(
"hypercorn.access",
config.accesslog,
config.loglevel,
sys.stdout,
propagate=False,
)
self.error_logger = _create_logger(
"hypercorn.error", config.errorlog, config.loglevel, sys.stderr
)
if config.logconfig is not None:
if config.logconfig.startswith("json:"):
with open(config.logconfig[5:]) as file_:
dictConfig(json.load(file_))
elif config.logconfig.startswith("toml:"):
with open(config.logconfig[5:], "rb") as file_:
dictConfig(tomllib.load(file_))
else:
log_config = {
"__file__": config.logconfig,
"here": os.path.dirname(config.logconfig),
}
fileConfig(config.logconfig, defaults=log_config, disable_existing_loggers=False)
else:
if config.logconfig_dict is not None:
dictConfig(config.logconfig_dict)
async def access(
self, request: "WWWScope", response: "ResponseSummary", request_time: float
) -> None:
if self.access_logger is not None:
self.access_logger.info(
self.access_log_format, self.atoms(request, response, request_time)
)
async def critical(self, message: str, *args: Any, **kwargs: Any) -> None:
if self.error_logger is not None:
self.error_logger.critical(message, *args, **kwargs)
async def error(self, message: str, *args: Any, **kwargs: Any) -> None:
if self.error_logger is not None:
self.error_logger.error(message, *args, **kwargs)
async def warning(self, message: str, *args: Any, **kwargs: Any) -> None:
if self.error_logger is not None:
self.error_logger.warning(message, *args, **kwargs)
async def info(self, message: str, *args: Any, **kwargs: Any) -> None:
if self.error_logger is not None:
self.error_logger.info(message, *args, **kwargs)
async def debug(self, message: str, *args: Any, **kwargs: Any) -> None:
if self.error_logger is not None:
self.error_logger.debug(message, *args, **kwargs)
async def exception(self, message: str, *args: Any, **kwargs: Any) -> None:
if self.error_logger is not None:
self.error_logger.exception(message, *args, **kwargs)
async def log(self, level: int, message: str, *args: Any, **kwargs: Any) -> None:
if self.error_logger is not None:
self.error_logger.log(level, message, *args, **kwargs)
def atoms(
self, request: "WWWScope", response: Optional["ResponseSummary"], request_time: float
) -> Mapping[str, str]:
"""Create and return an access log atoms dictionary.
This can be overidden and customised if desired. It should
return a mapping between an access log format key and a value.
"""
return AccessLogAtoms(request, response, request_time)
def __getattr__(self, name: str) -> Any:
return getattr(self.error_logger, name)
class AccessLogAtoms(dict):
def __init__(
self, request: "WWWScope", response: Optional["ResponseSummary"], request_time: float
) -> None:
for name, value in request["headers"]:
self[f"{{{name.decode('latin1').lower()}}}i"] = value.decode("latin1")
for name, value in os.environ.items():
self[f"{{{name.lower()}}}e"] = value
protocol = request.get("http_version", "ws")
client = request.get("client")
if client is None:
remote_addr = None
elif len(client) == 2:
remote_addr = f"{client[0]}:{client[1]}"
elif len(client) == 1:
remote_addr = client[0]
else: # make sure not to throw UnboundLocalError
remote_addr = f"<???{client}???>"
if request["type"] == "http":
method = request["method"]
else:
method = "GET"
query_string = request["query_string"].decode()
path_with_qs = request["path"] + ("?" + query_string if query_string else "")
status_code = "-"
status_phrase = "-"
if response is not None:
for name, value in response.get("headers", []): # type: ignore
self[f"{{{name.decode('latin1').lower()}}}o"] = value.decode("latin1") # type: ignore # noqa: E501
status_code = str(response["status"])
try:
status_phrase = HTTPStatus(response["status"]).phrase
except ValueError:
status_phrase = f"<???{status_code}???>"
self.update(
{
"h": remote_addr,
"l": "-",
"t": time.strftime("[%d/%b/%Y:%H:%M:%S %z]"),
"r": f"{method} {request['path']} {protocol}",
"R": f"{method} {path_with_qs} {protocol}",
"s": status_code,
"st": status_phrase,
"S": request["scheme"],
"m": method,
"U": request["path"],
"Uq": path_with_qs,
"q": query_string,
"H": protocol,
"b": self["{Content-Length}o"],
"B": self["{Content-Length}o"],
"f": self["{Referer}i"],
"a": self["{User-Agent}i"],
"T": int(request_time),
"D": int(request_time * 1_000_000),
"L": f"{request_time:.6f}",
"p": f"<{os.getpid()}>",
}
)
def __getitem__(self, key: str) -> str:
try:
if key.startswith("{"):
return super().__getitem__(key.lower())
else:
return super().__getitem__(key)
except KeyError:
return "-"
|
