Merge pull request #2 from mitodl/edx-logging

Adding initial pass of extending logging configuration for edx-platform

pyproject.toml

@@ -7,9 +7,11 @@ license = "BSD-3-Clause"
 
 [tool.poetry.dependencies]
 python = "^3.8"
-sentry-sdk = "^1.3.1"
 Django = ">2.0"
 edx-django-utils = "^4.0.0"
+python-json-logger = "^2.0.2"
+sentry-sdk = "^1.3.1"
+systemd-python = ">=234"
 
 [tool.poetry.dev-dependencies]
 wemake-python-styleguide = "^0.15.3"

src/ol_openedx_logging/BUILD

@@ -0,0 +1,22 @@
+python_library(
+    name="edx_logging",
+    dependencies=[
+        "src/ol_openedx_logging/settings",
+        "//:python-json-logger",
+    ]
+)
+
+python_distribution(
+    name="logging_package",
+    dependencies=[":edx_logging"],
+    provides=setup_py(
+        name="ol-openedx-logging",
+        version="0.1.0",
+        description="An Open edX plugin to customize the logging configuration used by the edx-platform application",
+        entry_points={
+            "lms.djangoapp": ["ol_openedx_logging = ol_openedx_logging.app:EdxLoggingLMS"],
+            "cms.djangoapp": ["ol_openedx_logging = ol_openedx_logging.app:EdxLoggingCMS"]
+        }
+    ),
+    setup_py_commands=["sdist", "bdist_wheel"]
+)

src/ol_openedx_logging/app.py

@@ -0,0 +1,21 @@
+from django.apps import AppConfig
+
+
+class EdxLoggingLMS(AppConfig):
+    name = "ol_openedx_logging"
+    verbose_name = "Log customization support for Open edX platform"
+    plugin_app = {
+        "settings_config": {
+            "lms.djangoapp": {"production": {"relative_path": "settings.production"}}
+        }
+    }
+
+
+class EdxLoggingCMS(AppConfig):
+    name = "ol_openedx_logging"
+    verbose_name = "Log customization support for Open edX platform"
+    plugin_app = {
+        "settings_config": {
+            "cms.djangoapp": {"production": {"relative_path": "settings.production"}}
+        }
+    }

src/ol_openedx_logging/settings/BUILD

@@ -0,0 +1 @@
+python_library()

src/ol_openedx_logging/settings/production.py

@@ -0,0 +1,46 @@
+from typing import Any, Dict
+
+MEGABYTE = 1024 * 1024
+
+
+def _load_env_tokens(edx_settings, default_settings: Dict[str, Any]) -> Dict[str, Any]:
+    configured_tokens = getattr(edx_settings, "ENV_TOKENS", {})
+    default_settings.update(configured_tokens)
+    return default_settings
+
+
+def plugin_settings(edx_settings):
+    env_tokens = _load_env_tokens(
+        edx_settings,
+        {
+            "EDXAPP_LOG_LEVEL": "INFO",
+            "EDXAPP_LOG_FILE_PATH": "/var/log/edxapp/app.log",
+            "EDXAPP_LOG_FILE_MAX_MEGABYTES": 10,
+        },
+    )
+    edx_logging = getattr(edx_settings, "LOGGING", {})
+    edx_log_level = env_tokens["EDXAPP_LOG_LEVEL"]
+
+    edx_logging["formatters"]["json_format"] = {
+        "()": "pythonjsonlogger.jsonlogger.JsonFormatter",
+        "timestamp": True,
+        "reserved_attrs": [],  # Add all log attributes to JSON object
+    }
+
+    edx_logging["handlers"]["file"] = {
+        "level": edx_log_level,
+        "class": "logging.handlers.RotatingFileHandler",
+        "filename": env_tokens["EDXAPP_LOG_FILE_PATH"],
+        "formatter": "json_format",
+        "backupCount": 3,
+        "mode": "a",
+        "maxBytes": MEGABYTE * env_tokens["EDXAPP_LOG_FILE_MAX_MEGABYTES"],
+    }
+
+    edx_logging["loggers"][""] = {
+        "handlers": ["console", "local", "file"],
+        "level": edx_log_level,
+        "propagate": False,
+    }
+
+    edx_settings.LOGGING = edx_logging

src/ol_openedx_sentry/BUILD

@@ -5,7 +5,7 @@ python_library(
 
 python_distribution(
     name="sentry_package",
-    dependencies=[":sentry_app", "src/ol_openedx_sentry/settings:sentry_settings"],
+    dependencies=[":sentry_app"],
     provides=setup_py(
         name="ol-openedx-sentry",
         version="0.1.0",