Show More
@@ -3,21 +3,24 b' Gunicorn config extension and hooks. Thi' | |||
|
3 | 3 | Gunicorn configuration should be managed by .ini files entries of RhodeCode or VCSServer |
|
4 | 4 | """ |
|
5 | 5 | |
|
6 | import contextlib | |
|
7 | import dataclasses | |
|
6 | 8 | import gc |
|
7 | import os | |
|
8 | import sys | |
|
9 | 9 | import math |
|
10 |
import |
|
|
11 | import threading | |
|
12 | import traceback | |
|
10 | import os | |
|
13 | 11 | import random |
|
14 | 12 | import socket |
|
15 |
import |
|
|
13 | import sys | |
|
14 | import threading | |
|
15 | import time | |
|
16 | import traceback | |
|
17 | ||
|
16 | 18 | from gunicorn.glogging import Logger |
|
17 | 19 | |
|
18 | 20 | |
|
19 | 21 | def get_workers(): |
|
20 | 22 | import multiprocessing |
|
23 | ||
|
21 | 24 | return multiprocessing.cpu_count() * 2 + 1 |
|
22 | 25 | |
|
23 | 26 | |
@@ -25,10 +28,10 b' bind = "127.0.0.1:10010"' | |||
|
25 | 28 | |
|
26 | 29 | |
|
27 | 30 | # Error logging output for gunicorn (-) is stdout |
|
28 |
errorlog = |
|
|
31 | errorlog = "-" | |
|
29 | 32 | |
|
30 | 33 | # Access logging output for gunicorn (-) is stdout |
|
31 |
accesslog = |
|
|
34 | accesslog = "-" | |
|
32 | 35 | |
|
33 | 36 | |
|
34 | 37 | # SERVER MECHANICS |
@@ -45,8 +48,7 b' tmp_upload_dir = None' | |||
|
45 | 48 | # '%(t)s %(p)s INFO [GNCRN] %(h)-15s rqt:%(L)s %(s)s %(b)-6s "%(m)s:%(U)s %(q)s" usr:%(u)s "%(f)s" "%(a)s"') |
|
46 | 49 | |
|
47 | 50 | # loki format for easier parsing in grafana |
|
48 | access_log_format = ( | |
|
49 | 'time="%(t)s" pid=%(p)s level="INFO" type="[GNCRN]" ip="%(h)-15s" rqt="%(L)s" response_code="%(s)s" response_bytes="%(b)-6s" uri="%(m)s:%(U)s %(q)s" user=":%(u)s" user_agent="%(a)s"') | |
|
51 | access_log_format = 'time="%(t)s" pid=%(p)s level="INFO" type="[GNCRN]" ip="%(h)-15s" rqt="%(L)s" response_code="%(s)s" response_bytes="%(b)-6s" uri="%(m)s:%(U)s %(q)s" user=":%(u)s" user_agent="%(a)s"' | |
|
50 | 52 | |
|
51 | 53 | |
|
52 | 54 | # Sets the number of process workers. More workers means more concurrent connections |
@@ -62,14 +64,14 b' workers = 6' | |||
|
62 | 64 | # workers = get_workers() |
|
63 | 65 | |
|
64 | 66 | # Gunicorn access log level |
|
65 |
loglevel = |
|
|
67 | loglevel = "info" | |
|
66 | 68 | |
|
67 | 69 | # Process name visible in a process list |
|
68 |
proc_name = |
|
|
70 | proc_name = "rhodecode_vcsserver" | |
|
69 | 71 | |
|
70 | 72 | # Type of worker class, one of `sync`, `gevent` |
|
71 | 73 | # currently `sync` is the only option allowed. |
|
72 |
worker_class = |
|
|
74 | worker_class = "sync" | |
|
73 | 75 | |
|
74 | 76 | # The maximum number of simultaneous clients. Valid only for gevent |
|
75 | 77 | worker_connections = 10 |
@@ -136,25 +138,26 b' class MemoryCheckConfig:' | |||
|
136 | 138 | |
|
137 | 139 | |
|
138 | 140 | def _get_process_rss(pid=None): |
|
139 | try: | |
|
141 | with contextlib.suppress(Exception): | |
|
140 | 142 | import psutil |
|
143 | ||
|
141 | 144 | if pid: |
|
142 | 145 | proc = psutil.Process(pid) |
|
143 | 146 | else: |
|
144 | 147 | proc = psutil.Process() |
|
145 | 148 | return proc.memory_info().rss |
|
146 | except Exception: | |
|
149 | ||
|
147 | 150 |
|
|
148 | 151 | |
|
149 | 152 | |
|
150 | 153 | def _get_config(ini_path): |
|
151 | 154 | import configparser |
|
152 | 155 | |
|
153 | try: | |
|
156 | with contextlib.suppress(Exception): | |
|
154 | 157 | config = configparser.RawConfigParser() |
|
155 | 158 | config.read(ini_path) |
|
156 | 159 | return config |
|
157 | except Exception: | |
|
160 | ||
|
158 | 161 |
|
|
159 | 162 | |
|
160 | 163 | |
@@ -168,24 +171,24 b' def get_memory_usage_params(config=None)' | |||
|
168 | 171 | ini_path = os.path.abspath(config) |
|
169 | 172 | conf = _get_config(ini_path) |
|
170 | 173 | |
|
171 |
section = |
|
|
174 | section = "server:main" | |
|
172 | 175 | if conf and conf.has_section(section): |
|
176 | if conf.has_option(section, "memory_max_usage"): | |
|
177 | _memory_max_usage = conf.getint(section, "memory_max_usage") | |
|
173 | 178 | |
|
174 |
if conf.has_option(section, |
|
|
175 |
_memory_ |
|
|
176 | ||
|
177 | if conf.has_option(section, 'memory_usage_check_interval'): | |
|
178 | _memory_usage_check_interval = conf.getint(section, 'memory_usage_check_interval') | |
|
179 | if conf.has_option(section, "memory_usage_check_interval"): | |
|
180 | _memory_usage_check_interval = conf.getint(section, "memory_usage_check_interval") | |
|
179 | 181 | |
|
180 |
if conf.has_option(section, |
|
|
181 |
_memory_usage_recovery_threshold = conf.getfloat(section, |
|
|
182 | if conf.has_option(section, "memory_usage_recovery_threshold"): | |
|
183 | _memory_usage_recovery_threshold = conf.getfloat(section, "memory_usage_recovery_threshold") | |
|
182 | 184 | |
|
183 |
_memory_max_usage = int(os.environ.get( |
|
|
184 | or _memory_max_usage) | |
|
185 |
|
|
|
186 | or _memory_usage_check_interval) | |
|
187 | _memory_usage_recovery_threshold = float(os.environ.get('RC_GUNICORN_MEMORY_USAGE_RECOVERY_THRESHOLD', '') | |
|
188 | or _memory_usage_recovery_threshold) | |
|
185 | _memory_max_usage = int(os.environ.get("RC_GUNICORN_MEMORY_MAX_USAGE", "") or _memory_max_usage) | |
|
186 | _memory_usage_check_interval = int( | |
|
187 | os.environ.get("RC_GUNICORN_MEMORY_USAGE_CHECK_INTERVAL", "") or _memory_usage_check_interval | |
|
188 | ) | |
|
189 | _memory_usage_recovery_threshold = float( | |
|
190 | os.environ.get("RC_GUNICORN_MEMORY_USAGE_RECOVERY_THRESHOLD", "") or _memory_usage_recovery_threshold | |
|
191 | ) | |
|
189 | 192 | |
|
190 | 193 | return MemoryCheckConfig(_memory_max_usage, _memory_usage_check_interval, _memory_usage_recovery_threshold) |
|
191 | 194 | |
@@ -199,26 +202,27 b' def pre_fork(server, worker):' | |||
|
199 | 202 | |
|
200 | 203 | |
|
201 | 204 | def post_fork(server, worker): |
|
202 | ||
|
203 | 205 | memory_conf = get_memory_usage_params() |
|
204 | 206 | _memory_max_usage = memory_conf.max_usage |
|
205 | 207 | _memory_usage_check_interval = memory_conf.check_interval |
|
206 | 208 | _memory_usage_recovery_threshold = memory_conf.recovery_threshold |
|
207 | 209 | |
|
208 |
worker._memory_max_usage = int(os.environ.get( |
|
|
209 | or _memory_max_usage) | |
|
210 |
|
|
|
211 | or _memory_usage_check_interval) | |
|
212 |
worker._memory_usage_recovery_threshold = float( |
|
|
213 | or _memory_usage_recovery_threshold) | |
|
210 | worker._memory_max_usage = int(os.environ.get("RC_GUNICORN_MEMORY_MAX_USAGE", "") or _memory_max_usage) | |
|
211 | worker._memory_usage_check_interval = int( | |
|
212 | os.environ.get("RC_GUNICORN_MEMORY_USAGE_CHECK_INTERVAL", "") or _memory_usage_check_interval | |
|
213 | ) | |
|
214 | worker._memory_usage_recovery_threshold = float( | |
|
215 | os.environ.get("RC_GUNICORN_MEMORY_USAGE_RECOVERY_THRESHOLD", "") or _memory_usage_recovery_threshold | |
|
216 | ) | |
|
214 | 217 | |
|
215 | 218 | # register memory last check time, with some random offset so we don't recycle all |
|
216 | 219 | # at once |
|
217 | 220 | worker._last_memory_check_time = _time_with_offset(_memory_usage_check_interval) |
|
218 | 221 | |
|
219 | 222 | if _memory_max_usage: |
|
220 | server.log.info("pid=[%-10s] WORKER spawned with max memory set at %s", worker.pid, | |
|
221 |
|
|
|
223 | server.log.info( | |
|
224 | "pid=[%-10s] WORKER spawned with max memory set at %s", worker.pid, _format_data_size(_memory_max_usage) | |
|
225 | ) | |
|
222 | 226 | else: |
|
223 | 227 | server.log.info("pid=[%-10s] WORKER spawned", worker.pid) |
|
224 | 228 | |
@@ -228,9 +232,9 b' def pre_exec(server):' | |||
|
228 | 232 | |
|
229 | 233 | |
|
230 | 234 | def on_starting(server): |
|
231 |
server_lbl = |
|
|
235 | server_lbl = "{} {}".format(server.proc_name, server.address) | |
|
232 | 236 | server.log.info("Server %s is starting.", server_lbl) |
|
233 |
server.log.info( |
|
|
237 | server.log.info("Config:") | |
|
234 | 238 | server.log.info(f"\n{server.cfg}") |
|
235 | 239 | server.log.info(get_memory_usage_params()) |
|
236 | 240 | |
@@ -264,10 +268,10 b' def _format_data_size(size, unit="B", pr' | |||
|
264 | 268 | |
|
265 | 269 | if not binary: |
|
266 | 270 | base = 1000 |
|
267 |
multiples = ( |
|
|
271 | multiples = ("", "k", "M", "G", "T", "P", "E", "Z", "Y") | |
|
268 | 272 | else: |
|
269 | 273 | base = 1024 |
|
270 |
multiples = ( |
|
|
274 | multiples = ("", "Ki", "Mi", "Gi", "Ti", "Pi", "Ei", "Zi", "Yi") | |
|
271 | 275 | |
|
272 | 276 | sign = "" |
|
273 | 277 | if size > 0: |
@@ -282,13 +286,13 b' def _format_data_size(size, unit="B", pr' | |||
|
282 | 286 | m = 8 |
|
283 | 287 | |
|
284 | 288 | if m == 0: |
|
285 |
precision = |
|
|
289 | precision = "%.0f" | |
|
286 | 290 | else: |
|
287 |
precision = |
|
|
291 | precision = "%%.%df" % precision | |
|
288 | 292 | |
|
289 | 293 | size = precision % (size / math.pow(base, m)) |
|
290 | 294 | |
|
291 |
return |
|
|
295 | return "%s%s %s%s" % (sign, size.strip(), multiples[m], unit) | |
|
292 | 296 | |
|
293 | 297 | |
|
294 | 298 | def _check_memory_usage(worker): |
@@ -304,8 +308,8 b' def _check_memory_usage(worker):' | |||
|
304 | 308 | mem_usage = _get_process_rss() |
|
305 | 309 | if mem_usage and mem_usage > _memory_max_usage: |
|
306 | 310 | worker.log.info( |
|
307 | "memory usage %s > %s, forcing gc", | |
|
308 | _format_data_size(mem_usage), _format_data_size(_memory_max_usage)) | |
|
311 | "memory usage %s > %s, forcing gc", _format_data_size(mem_usage), _format_data_size(_memory_max_usage) | |
|
312 | ) | |
|
309 | 313 | # Try to clean it up by forcing a full collection. |
|
310 | 314 | gc.collect() |
|
311 | 315 | mem_usage = _get_process_rss() |
@@ -313,7 +317,9 b' def _check_memory_usage(worker):' | |||
|
313 | 317 | # Didn't clean up enough, we'll have to terminate. |
|
314 | 318 | worker.log.warning( |
|
315 | 319 | "memory usage %s > %s after gc, quitting", |
|
316 |
_format_data_size(mem_usage), |
|
|
320 | _format_data_size(mem_usage), | |
|
321 | _format_data_size(_memory_max_usage), | |
|
322 | ) | |
|
317 | 323 | # This will cause worker to auto-restart itself |
|
318 | 324 | worker.alive = False |
|
319 | 325 | worker._last_memory_check_time = time.time() |
@@ -329,8 +335,7 b' def worker_int(worker):' | |||
|
329 | 335 | |
|
330 | 336 | code = [] |
|
331 | 337 | for thread_id, stack in sys._current_frames().items(): # noqa |
|
332 | code.append( | |
|
333 | "\n# Thread: %s(%d)" % (get_thread_id(thread_id), thread_id)) | |
|
338 | code.append("\n# Thread: %s(%d)" % (get_thread_id(thread_id), thread_id)) | |
|
334 | 339 | for fname, lineno, name, line in traceback.extract_stack(stack): |
|
335 | 340 | code.append('File: "%s", line %d, in %s' % (fname, lineno, name)) |
|
336 | 341 | if line: |
@@ -352,17 +357,21 b' def child_exit(server, worker):' | |||
|
352 | 357 | |
|
353 | 358 | def pre_request(worker, req): |
|
354 | 359 | worker.start_time = time.time() |
|
355 | worker.log.debug( | |
|
356 | "GNCRN PRE WORKER [cnt:%s]: %s %s", worker.nr, req.method, req.path) | |
|
360 | worker.log.debug("GNCRN PRE WORKER [cnt:%s]: %s %s", worker.nr, req.method, req.path) | |
|
357 | 361 | |
|
358 | 362 | |
|
359 | 363 | def post_request(worker, req, environ, resp): |
|
360 | 364 | total_time = time.time() - worker.start_time |
|
361 | 365 | # Gunicorn sometimes has problems with reading the status_code |
|
362 |
status_code = getattr(resp, |
|
|
366 | status_code = getattr(resp, "status_code", "") | |
|
363 | 367 | worker.log.debug( |
|
364 | 368 | "GNCRN POST WORKER [cnt:%s]: %s %s resp: %s, Load Time: %.4fs", |
|
365 | worker.nr, req.method, req.path, status_code, total_time) | |
|
369 | worker.nr, | |
|
370 | req.method, | |
|
371 | req.path, | |
|
372 | status_code, | |
|
373 | total_time, | |
|
374 | ) | |
|
366 | 375 | _check_memory_usage(worker) |
|
367 | 376 | |
|
368 | 377 | |
@@ -375,8 +384,8 b' def _filter_proxy(ip):' | |||
|
375 | 384 | |
|
376 | 385 | :param ip: ip string from headers |
|
377 | 386 | """ |
|
378 |
if |
|
|
379 |
_ips = ip.split( |
|
|
387 | if "," in ip: | |
|
388 | _ips = ip.split(",") | |
|
380 | 389 | _first_ip = _ips[0].strip() |
|
381 | 390 | return _first_ip |
|
382 | 391 | return ip |
@@ -392,8 +401,9 b' def _filter_port(ip):' | |||
|
392 | 401 | |
|
393 | 402 | :param ip: |
|
394 | 403 | """ |
|
404 | ||
|
395 | 405 | def is_ipv6(ip_addr): |
|
396 |
if hasattr(socket, |
|
|
406 | if hasattr(socket, "inet_pton"): | |
|
397 | 407 | try: |
|
398 | 408 | socket.inet_pton(socket.AF_INET6, ip_addr) |
|
399 | 409 | except socket.error: |
@@ -402,24 +412,24 b' def _filter_port(ip):' | |||
|
402 | 412 | return False |
|
403 | 413 | return True |
|
404 | 414 | |
|
405 |
if |
|
|
415 | if ":" not in ip: # must be ipv4 pure ip | |
|
406 | 416 | return ip |
|
407 | 417 | |
|
408 |
if |
|
|
409 |
return ip.split( |
|
|
418 | if "[" in ip and "]" in ip: # ipv6 with port | |
|
419 | return ip.split("]")[0][1:].lower() | |
|
410 | 420 | |
|
411 | 421 | # must be ipv6 or ipv4 with port |
|
412 | 422 | if is_ipv6(ip): |
|
413 | 423 | return ip |
|
414 | 424 | else: |
|
415 |
ip, _port = ip.split( |
|
|
425 | ip, _port = ip.split(":")[:2] # means ipv4+port | |
|
416 | 426 | return ip |
|
417 | 427 | |
|
418 | 428 | |
|
419 | 429 | def get_ip_addr(environ): |
|
420 |
proxy_key = |
|
|
421 |
proxy_key2 = |
|
|
422 |
def_key = |
|
|
430 | proxy_key = "HTTP_X_REAL_IP" | |
|
431 | proxy_key2 = "HTTP_X_FORWARDED_FOR" | |
|
432 | def_key = "REMOTE_ADDR" | |
|
423 | 433 | |
|
424 | 434 | def _filters(x): |
|
425 | 435 | return _filter_port(_filter_proxy(x)) |
@@ -432,7 +442,7 b' def get_ip_addr(environ):' | |||
|
432 | 442 | if ip: |
|
433 | 443 | return _filters(ip) |
|
434 | 444 | |
|
435 |
ip = environ.get(def_key, |
|
|
445 | ip = environ.get(def_key, "0.0.0.0") | |
|
436 | 446 | return _filters(ip) |
|
437 | 447 | |
|
438 | 448 | |
@@ -450,40 +460,37 b' class RhodeCodeLogger(Logger):' | |||
|
450 | 460 |
""" |
|
451 | 461 | now = time.time() |
|
452 | 462 | msecs = int((now - int(now)) * 1000) |
|
453 |
return time.strftime(self.datefmt, time.localtime(now)) + |
|
|
463 | return time.strftime(self.datefmt, time.localtime(now)) + ".{0:03d}".format(msecs) | |
|
454 | 464 | |
|
455 | 465 | def atoms(self, resp, req, environ, request_time): |
|
456 |
""" |
|
|
457 | """ | |
|
466 | """Gets atoms for log formatting.""" | |
|
458 | 467 | status = resp.status |
|
459 | 468 | if isinstance(status, str): |
|
460 | 469 | status = status.split(None, 1)[0] |
|
461 | 470 | atoms = { |
|
462 |
|
|
|
463 |
|
|
|
464 |
|
|
|
465 |
|
|
|
466 |
|
|
|
467 | environ['RAW_URI'], | |
|
468 | environ["SERVER_PROTOCOL"]), | |
|
469 | 's': status, | |
|
470 |
|
|
|
471 |
|
|
|
472 | 'q': environ.get('QUERY_STRING'), | |
|
473 | 'H': environ.get('SERVER_PROTOCOL'), | |
|
474 | 'b': getattr(resp, 'sent', None) is not None and str(resp.sent) or '-', | |
|
475 | 'B': getattr(resp, 'sent', None), | |
|
476 | 'f': environ.get('HTTP_REFERER', '-'), | |
|
477 | 'a': environ.get('HTTP_USER_AGENT', '-'), | |
|
478 | 'T': request_time.seconds, | |
|
479 |
|
|
|
480 | 'M': (request_time.seconds * 1000) + int(request_time.microseconds/1000), | |
|
481 | 'L': "%d.%06d" % (request_time.seconds, request_time.microseconds), | |
|
482 | 'p': "<%s>" % os.getpid() | |
|
471 | "h": get_ip_addr(environ), | |
|
472 | "l": "-", | |
|
473 | "u": self._get_user(environ) or "-", | |
|
474 | "t": self.now(), | |
|
475 | "r": "%s %s %s" % (environ["REQUEST_METHOD"], environ["RAW_URI"], environ["SERVER_PROTOCOL"]), | |
|
476 | "s": status, | |
|
477 | "m": environ.get("REQUEST_METHOD"), | |
|
478 | "U": environ.get("PATH_INFO"), | |
|
479 | "q": environ.get("QUERY_STRING"), | |
|
480 | "H": environ.get("SERVER_PROTOCOL"), | |
|
481 | "b": getattr(resp, "sent", None) is not None and str(resp.sent) or "-", | |
|
482 | "B": getattr(resp, "sent", None), | |
|
483 | "f": environ.get("HTTP_REFERER", "-"), | |
|
484 | "a": environ.get("HTTP_USER_AGENT", "-"), | |
|
485 | "T": request_time.seconds, | |
|
486 | "D": (request_time.seconds * 1000000) + request_time.microseconds, | |
|
487 | "M": (request_time.seconds * 1000) + int(request_time.microseconds / 1000), | |
|
488 | "L": "%d.%06d" % (request_time.seconds, request_time.microseconds), | |
|
489 | "p": "<%s>" % os.getpid(), | |
|
483 | 490 | } |
|
484 | 491 | |
|
485 | 492 | # add request headers |
|
486 |
if hasattr(req, |
|
|
493 | if hasattr(req, "headers"): | |
|
487 | 494 | req_headers = req.headers |
|
488 | 495 | else: |
|
489 | 496 | req_headers = req |
@@ -35,6 +35,7 b' dependencies = {file = ["requirements.tx' | |||
|
35 | 35 | optional-dependencies.tests = {file = ["requirements_test.txt"]} |
|
36 | 36 | |
|
37 | 37 | [tool.ruff] |
|
38 | ||
|
38 | 39 | select = [ |
|
39 | 40 | # Pyflakes |
|
40 | 41 | "F", |
@@ -44,16 +45,29 b' select = [' | |||
|
44 | 45 | # isort |
|
45 | 46 | "I001" |
|
46 | 47 | ] |
|
48 | ||
|
47 | 49 | ignore = [ |
|
48 | 50 | "E501", # line too long, handled by black |
|
49 | 51 | ] |
|
52 | ||
|
50 | 53 | # Same as Black. |
|
51 | 54 | line-length = 120 |
|
52 | 55 | |
|
56 | [tool.ruff.isort] | |
|
53 | 57 | |
|
54 | [tool.ruff.isort] | |
|
55 | 58 | known-first-party = ["vcsserver"] |
|
56 | 59 | |
|
57 | [tool.black] | |
|
58 | line-length = 120 | |
|
59 | target-version = ['py310', 'py311'] | |
|
60 | [tool.ruff.format] | |
|
61 | ||
|
62 | # Like Black, use double quotes for strings. | |
|
63 | quote-style = "double" | |
|
64 | ||
|
65 | # Like Black, indent with spaces, rather than tabs. | |
|
66 | indent-style = "space" | |
|
67 | ||
|
68 | # Like Black, respect magic trailing commas. | |
|
69 | skip-magic-trailing-comma = false | |
|
70 | ||
|
71 | # Like Black, automatically detect the appropriate line ending. | |
|
72 | line-ending = "auto" | |
|
73 |
General Comments 0
You need to be logged in to leave comments.
Login now