Skip to content

feat: Change the logging config for edx-platform. #206

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
dianakhuang merged 1 commit into from
Jul 22, 2026
Merged

feat: Change the logging config for edx-platform. #206

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 21 additions & 0 deletions dockerfiles/edx-platform.Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,7 @@ RUN <<EOCMD
set -eu

cat > lms/envs/docker-production.py <<'EOF'
import platform
from .production import * # pylint: disable=wildcard-import, unused-wildcard-import
from openedx.core.lib.logsettings import get_docker_logger_config
LOGGING = get_docker_logger_config()
Expand All @@ -274,13 +275,33 @@ _tracking_log_dir = os.path.join(
os.environ.get('NODE_NAME', 'unknown-node'),
os.environ.get('POD_NAME', 'unknown-pod'),
)

os.makedirs(_tracking_log_dir, exist_ok=True)
LOGGING["handlers"]["tracking"] = {
'level': 'DEBUG',
'class': 'logging.handlers.WatchedFileHandler',
'filename': os.path.join(_tracking_log_dir, 'tracking.log'),
'formatter': 'raw',
}

# This overrides the existing syslog format for Docker with an extended one and adds it to the console handler.
try:
# This should check to see if ddtrace is available in the context for setting up the loggers.
# If it is available, include Datadog information in the log string. If it is not, exclude it.
import ddtrace
syslog_format = ("[%(name)s] %(levelname)s "
"[dd.trace_id=%(dd.trace_id)s dd.span_id=%(dd.span_id)s] "
"[{hostname}] [process %(process)d] [user %(userid)s] [ip %(remoteip)s] [%(filename)s:%(lineno)d] "
"- %(message)s").format(hostname=platform.node().split(".")[0])
except ImportError:
syslog_format = ("[%(name)s] %(levelname)s "
"[{hostname}] [process %(process)d] [user %(userid)s] [ip %(remoteip)s] [%(filename)s:%(lineno)d] "
"- %(message)s").format(hostname=platform.node().split(".")[0])


LOGGING["formatters"]["syslog_format"] = {"format": syslog_format}
LOGGING["handlers"]["console"]["formatter"] = "syslog_format"

EOF

cp lms/envs/docker-production.py cms/envs/docker-production.py
Expand Down
Loading