Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 22 additions & 9 deletions coldfront/config/log_filters.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,17 +27,30 @@ def filter(self, record):
request = get_current_request()
if request is not None:
ip, _ = get_client_ip(request)
record.ip_addr = ip or ''
user = getattr(request, "user", None)
if user and user.is_authenticated:
record.user = getattr(user, "get_username", lambda: str(user))()
if not hasattr(record, 'ip_addr'):
record.ip_addr = ip or ''

request_user = getattr(request, "user", None)
if request_user and request_user.is_authenticated:
request_username = getattr(
request_user, "get_username", lambda: str(request_user)
)()
else:
record.user = 'anonymous'
record.auth_backend = request.session._session_cache.get('_auth_user_backend', 'unknown')
request_username = 'anonymous'
if not hasattr(record, 'requesting_user'):
record.requesting_user = request_username

if not hasattr(record, 'auth_backend'):
record.auth_backend = request.session._session_cache.get(
'_auth_user_backend', 'unknown'
)
else:
record.ip_addr = ''
record.user = ''
record.auth_backend = ''
if not hasattr(record, 'ip_addr'):
record.ip_addr = ''
if not hasattr(record, 'requesting_user'):
record.requesting_user = ''
if not hasattr(record, 'auth_backend'):
record.auth_backend = ''
if not hasattr(record, 'category'):
record.category = ''
return True
53 changes: 53 additions & 0 deletions coldfront/config/log_formatters.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
import json
import logging

from django.utils.log import ServerFormatter


RESERVED_RECORD_ATTRS = set(logging.makeLogRecord({}).__dict__.keys()) | {
"asctime",
"message",
"server_time",
}


class LogfmtServerFormatter(ServerFormatter):
"""ServerFormatter that appends non-reserved record attributes as logfmt."""

@staticmethod
def _to_logfmt_value(value):
if isinstance(value, (dict, list, tuple, set)):
value = json.dumps(value, sort_keys=True, default=str)
else:
value = str(value)

if value == "":
return '""'

needs_quotes = any(ch.isspace() for ch in value) or any(
ch in value for ch in ('"', "=", "\\")
)
if not needs_quotes:
return value

escaped = value.replace("\\", "\\\\").replace('"', '\\"')
return f'"{escaped}"'

def format(self, record):
base_message = super().format(record)

fields = []
for key in sorted(record.__dict__.keys()):
if key in RESERVED_RECORD_ATTRS or key.startswith("_"):
continue

value = record.__dict__[key]
if value is None:
continue

fields.append(f"{key}={self._to_logfmt_value(value)}")

if not fields:
return base_message

return f"{base_message} {' '.join(fields)}"
22 changes: 11 additions & 11 deletions coldfront/config/logging.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,12 @@
},
'formatters': {
'key-events': {
"()": "django.utils.log.ServerFormatter",
"()": "coldfront.config.log_formatters.LogfmtServerFormatter",
"format": "[{server_time}] {name} {levelname} {message}",
"style": "{",
},
'default': {
"()": "django.utils.log.ServerFormatter",
"()": "coldfront.config.log_formatters.LogfmtServerFormatter",
"format": "[{server_time}] {name} {levelname} {message}",
"style": "{",
},
Expand All @@ -56,18 +56,18 @@
'filters': ['require_debug_true'],
},
'django-q': {
'class': 'logging.handlers.TimedRotatingFileHandler',
'class': 'logging.handlers.RotatingFileHandler',
'filename': 'logs/django-q.log',
'when': 'midnight',
'backupCount': 10,
'backupCount': 7,
'maxBytes': 10 * 1024 * 1024, # 10 MB
'formatter': 'key-events',
'level': 'DEBUG',
},
'key-events': {
'class': 'logging.handlers.TimedRotatingFileHandler',
'class': 'logging.handlers.RotatingFileHandler',
'filename': 'logs/key-events.log',
'when': 'midnight',
'backupCount': 10,
'backupCount': 7,
'maxBytes': 10 * 1024 * 1024, # 10 MB
'formatter': 'key-events',
'level': 'INFO',
},
Expand All @@ -77,10 +77,10 @@
'class': 'django.utils.log.AdminEmailHandler',
},
'json': {
'class': 'logging.handlers.TimedRotatingFileHandler',
'class': 'logging.handlers.RotatingFileHandler',
'filename': 'logs/coldfront.json.log',
'when': 'midnight',
'backupCount': 10,
'backupCount': 7,
'maxBytes': 10 * 1024 * 1024, # 10 MB
'formatter': 'json',
'level': 'INFO',
'filters': ['request'],
Expand Down
Loading
Loading