Skip to content

Write structured logs; send uncaught logs to portal log #740

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
matthew-li merged 2 commits into from
Feb 9, 2026
Merged

Write structured logs; send uncaught logs to portal log #740

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
618acb2
* Install + configure structlog, django-structlog
matthew-li Feb 8, 2026
82e75bd
Add wrap_for_formatter processor to fix structlog double encoding and…
matthew-li Feb 8, 2026
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
55 changes: 51 additions & 4 deletions coldfront/config/local_settings.py.sample
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,34 @@ DISPLAY_TIME_ZONE = 'America/Los_Angeles'
# Logging
#------------------------------------------------------------------------------
import os
import structlog
LOG_PATH = os.path.join('/var/log/user_portals/cf_mybrc', 'cf_mybrc_portal.log')
API_LOG_PATH = os.path.join('/var/log/user_portals/cf_mybrc', 'cf_mybrc_api.log')
_log_formatter = 'console_dev' if DEBUG else 'json'
LOGGING = {
'version': 1,
'disable_existing_loggers': False,
'formatters': {
'console_dev': {
'()': structlog.stdlib.ProcessorFormatter,
'processor': structlog.dev.ConsoleRenderer(colors=True),
'foreign_pre_chain': [
structlog.contextvars.merge_contextvars,
structlog.processors.TimeStamper(fmt="iso"),
structlog.stdlib.add_logger_name,
structlog.stdlib.add_log_level,
],
},
'json': {
'()': structlog.stdlib.ProcessorFormatter,
'processor': structlog.processors.JSONRenderer(),
'foreign_pre_chain': [
structlog.contextvars.merge_contextvars,
structlog.processors.TimeStamper(fmt="iso"),
structlog.stdlib.add_logger_name,
structlog.stdlib.add_log_level,
],
},
'verbose': {
'format': '[{asctime}] {levelname} {module}.{funcName}: {message}',
'style': '{',
Expand All @@ -82,18 +104,19 @@ LOGGING = {
'handlers': {
'console': {
'class': 'logging.StreamHandler',
'formatter': _log_formatter,
},
'file': {
'level': 'INFO',
'class': 'logging.FileHandler',
'filename': LOG_PATH,
'formatter': 'verbose',
'formatter': 'json',
},
'api_file': {
'level': 'INFO',
'class': 'logging.FileHandler',
'filename': API_LOG_PATH,
'formatter': 'verbose',
'formatter': 'json',
},
},
'loggers': {
Expand All @@ -116,8 +139,32 @@ LOGGING = {
'level': 'INFO',
}
},
'root': {
'handlers': ['file'],
'level': 'INFO',
},
}

# structlog configuration
structlog.configure(
processors=[
structlog.contextvars.merge_contextvars,
structlog.stdlib.filter_by_level,
structlog.processors.TimeStamper(fmt="iso"),
structlog.stdlib.add_logger_name,
structlog.stdlib.add_log_level,
structlog.stdlib.PositionalArgumentsFormatter(),
structlog.processors.StackInfoRenderer(),
structlog.processors.format_exc_info,
structlog.processors.UnicodeDecoder(),
structlog.stdlib.ProcessorFormatter.wrap_for_formatter,
],
wrapper_class=structlog.stdlib.BoundLogger,
context_class=dict,
logger_factory=structlog.stdlib.LoggerFactory(),
cache_logger_on_first_use=True,
)

#------------------------------------------------------------------------------
# Advanced ColdFront configurations
#------------------------------------------------------------------------------
Expand Down Expand Up @@ -471,11 +518,11 @@ LOGGING['handlers']['api_file']['filename'] = API_LOG_PATH
if STREAM_LOGS_TO_STDOUT:
LOGGING['handlers']['file'] = {
'class': 'logging.StreamHandler',
'formatter': 'verbose',
'formatter': _log_formatter,
}
LOGGING['handlers']['api_file'] = {
'class': 'logging.StreamHandler',
'formatter': 'verbose',
'formatter': _log_formatter,
}

# Update allauth settings based on potentially-updated variables.
Expand Down
2 changes: 2 additions & 0 deletions coldfront/config/settings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
'simple_history',
'durationwidget',
'maintenance_mode',
'django_structlog',
]

# Fork-specific Additional Apps
Expand Down Expand Up @@ -82,6 +83,7 @@
# ------------------------------------------------------------------------------
MIDDLEWARE = [
'django.middleware.security.SecurityMiddleware',
'django_structlog.middlewares.RequestMiddleware',
'django.contrib.sessions.middleware.SessionMiddleware',
'django.middleware.common.CommonMiddleware',
'django.middleware.csrf.CsrfViewMiddleware',
Expand Down
2 changes: 2 additions & 0 deletions requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ django-sesame==3.2.3
django-settings-export==1.2.1
django-simple-history==3.10.1
django-sslserver==0.22
django-structlog==10.0.0
django-su==1.0.0
djangorestframework==3.16.0
doi2bib==0.4.0
Expand Down Expand Up @@ -56,6 +57,7 @@ requests==2.32.4
sentry-sdk==2.34.1
six==1.17.0
sqlparse==0.5.3
structlog==25.5.0
text-unidecode==1.3
tqdm==4.67.1
urllib3==2.5.0
Expand Down