adds gunicorn-logging extension
Dieser Commit ist enthalten in:
Sebastian Tobie 2024-03-05 00:08:18 +01:00
Commit 4932dc0cc5
4 geänderte Dateien mit 228 neuen und 0 gelöschten Zeilen

Datei anzeigen

@ -0,0 +1,9 @@
MIT License
Copyright (c) 2024-present Sebastian Tobie <sebastian@sebastian-tobie.de>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Datei anzeigen

@ -0,0 +1,18 @@
# Gunicorn Logging extension
-----
**Table of Contents**
- [Installation](#installation)
- [License](#license)
## Installation
```console
pip install gunicorn-logging-extension
```
## License
`gunicorn-logging-extension` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

Datei anzeigen

@ -0,0 +1,135 @@
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"
[project]
name = "gunicorn-logging-extension"
dynamic = ["version"]
description = ''
readme = "README.md"
requires-python = ">=3.7"
license = "MIT"
keywords = []
authors = [{ name = "Sebastian Tobie", email = "sebastian@sebastian-tobie.de" }]
classifiers = [
"Development Status :: 4 - Beta",
"Programming Language :: Python",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: Implementation :: CPython",
"Programming Language :: Python :: Implementation :: PyPy",
]
dependencies = ["gunicorn", "systemd_python"]
[project.urls]
Documentation = "https://github.com/unknown/gunicorn-logging-extension#readme"
Issues = "https://github.com/unknown/gunicorn-logging-extension/issues"
Source = "https://github.com/unknown/gunicorn-logging-extension"
[tool.hatch.version]
path = "src/gunicorn_logging_extension/__init__.py"
[tool.hatch.envs.default]
dependencies = ["coverage[toml]>=6.5", "pytest"]
[tool.hatch.envs.default.scripts]
test = "pytest {args:tests}"
test-cov = "coverage run -m pytest {args:tests}"
cov-report = ["- coverage combine", "coverage report"]
cov = ["test-cov", "cov-report"]
[[tool.hatch.envs.all.matrix]]
python = ["3.7", "3.8", "3.9", "3.10", "3.11"]
[tool.hatch.envs.lint]
detached = true
dependencies = ["black>=23.1.0", "mypy>=1.0.0", "ruff>=0.0.243"]
[tool.hatch.envs.lint.scripts]
typing = "mypy --install-types --non-interactive {args:src/gunicorn_logging_extension tests}"
style = ["ruff {args:.}", "black --check --diff {args:.}"]
fmt = ["black {args:.}", "ruff --fix {args:.}", "style"]
all = ["style", "typing"]
[tool.black]
target-version = ["py37"]
line-length = 120
skip-string-normalization = true
[tool.ruff]
target-version = "py37"
line-length = 120
select = [
"A",
"ARG",
"B",
"C",
"DTZ",
"E",
"EM",
"F",
"FBT",
"I",
"ICN",
"ISC",
"N",
"PLC",
"PLE",
"PLR",
"PLW",
"Q",
"RUF",
"S",
"T",
"TID",
"UP",
"W",
"YTT",
]
ignore = [
# Allow non-abstract empty methods in abstract base classes
"B027",
# Allow boolean positional values in function calls, like `dict.get(... True)`
"FBT003",
# Ignore checks for possible passwords
"S105",
"S106",
"S107",
# Ignore complexity
"C901",
"PLR0911",
"PLR0912",
"PLR0913",
"PLR0915",
]
unfixable = [
# Don't touch unused imports
"F401",
]
[tool.ruff.isort]
known-first-party = ["gunicorn_logging_extension"]
[tool.ruff.flake8-tidy-imports]
ban-relative-imports = "all"
[tool.ruff.per-file-ignores]
# Tests can use magic values, assertions, and relative imports
"tests/**/*" = ["PLR2004", "S101", "TID252"]
[tool.coverage.run]
source_pkgs = ["gunicorn_logging_extension", "tests"]
branch = true
parallel = true
omit = ["src/gunicorn_logging_extension/__about__.py"]
[tool.coverage.paths]
gunicorn_logging_extension = [
"src/gunicorn_logging_extension",
"*/gunicorn-logging-extension/src/gunicorn_logging_extension",
]
tests = ["tests", "*/gunicorn-logging-extension/tests"]
[tool.coverage.report]
exclude_lines = ["no cov", "if __name__ == .__main__.:", "if TYPE_CHECKING:"]

Datei anzeigen

@ -0,0 +1,66 @@
# SPDX-FileCopyrightText: 2024-present Sebastian Tobie <sebastian@sebastian-tobie.de>
#
# SPDX-License-Identifier: MIT
from gunicorn.glogging import Logger as gLogger
from logging import Formatter
from logging.config import dictConfig
from logging.config import fileConfig
import os.path
__version__ = "0.0.1"
class Logger(gLogger):
def __init__(self, cfg):
self.error_log = logging.getLogger("gunicorn.error")
self.access_log = logging.getLogger("gunicorn.access")
self.logfile = None
self.lock = threading.Lock()
self.cfg = cfg
self.setup(cfg)
def setup(self, cfg):
if cfg.logconfig_dict:
config = CONFIG_DEFAULTS.copy()
config.update(cfg.logconfig_dict)
try:
dictConfig(config)
except (AttributeError, ImportError, ValueError, TypeError) as exc:
raise RuntimeError(str(exc))
elif cfg.logconfig_json:
config = CONFIG_DEFAULTS.copy()
if os.path.exists(cfg.logconfig_json):
try:
config_json = json.load(open(cfg.logconfig_json))
config.update(config_json)
dictConfig(config)
except (json.JSONDecodeError, AttributeError, ImportError, ValueError, TypeError) as exc:
raise RuntimeError(str(exc))
elif cfg.logconfig:
if os.path.exists(cfg.logconfig):
defaults = CONFIG_DEFAULTS.copy()
defaults['__file__'] = cfg.logconfig
defaults['here'] = os.path.dirname(cfg.logconfig)
fileConfig(cfg.logconfig, defaults=defaults, disable_existing_loggers=False)
else:
msg = "Error: log config '%s' not found"
raise RuntimeError(msg % cfg.logconfig)
def atoms(self, resp, req, environ, request_time):
atoms = super().atoms(resp, req, environ, request_time)
atoms["extra"] = dict(
method=environ.get('REQUEST_METHOD'),
path=environ.get('PATH_INFO'),
query=environ.get('QUERY_STRING'),
proto=environ.get('SERVER_PROTOCOL'),
time="%d.%06d" % (request_time.seconds, request_time.microseconds),
)
if environ.get('REMOTE_ADDR', False):
atoms["extra"]["remote"] = environ.get('REMOTE_ADDR')
if getattr(resp, 'sent', False):
atoms["extra"]["length"] = getattr(resp, 'sent')
if environ.get('HTTP_REFERER', False):
atoms["extra"]["referer"] = environ.get('HTTP_REFERER')
if environ.get('HTTP_USER_AGENT', False):
atoms["extra"]["user_agent"] = environ.get('HTTP_USER_AGENT')
return atoms