ol-openedx-logging 0.0.1__tar.gz

ol-openedx-logging-0.0.1/MANIFEST.in

@@ -0,0 +1 @@
+include *.py

ol-openedx-logging-0.0.1/PKG-INFO

@@ -0,0 +1,6 @@
+Metadata-Version: 2.1
+Name: ol-openedx-logging
+Version: 0.0.1
+Summary: An Open edX plugin to customize the logging configuration used by the edx-platform application
+License: BSD-3-Clause
+Requires-Python: >=3.8

ol-openedx-logging-0.0.1/backend_shim.py

@@ -0,0 +1,24 @@
+
+# DO NOT EDIT THIS FILE -- AUTOGENERATED BY PANTS
+
+import os
+import setuptools.build_meta
+
+backend = setuptools.build_meta.__legacy__
+
+dist_dir = "dist"
+build_wheel = True
+build_sdist = True
+wheel_config_settings = {
+}
+sdist_config_settings = {
+}
+
+os.makedirs(dist_dir, exist_ok=True)
+wheel_path = backend.build_wheel(dist_dir, wheel_config_settings) if build_wheel else None
+sdist_path = backend.build_sdist(dist_dir, sdist_config_settings) if build_sdist else None
+
+if wheel_path:
+    print("wheel: {wheel_path}".format(wheel_path=wheel_path))
+if sdist_path:
+    print("sdist: {sdist_path}".format(sdist_path=sdist_path))

ol-openedx-logging-0.0.1/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"}}
+        }
+    }

ol-openedx-logging-0.0.1/ol_openedx_logging/settings/production.py

@@ -0,0 +1,88 @@
+from typing import Any, Dict
+import platform
+import sys
+
+
+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):
+    # Taken directly from Tutor from overhang.io
+
+    # This file and other files adapted from Tutor are covered by
+    # and subject to the AGPL-3 as a clause 5 'aggregate'.
+    hostname = platform.node().split(".")[0]
+    syslog_format = (
+        "[service_variant={service_variant}]"
+        "[%(name)s][env:{logging_env}] %(levelname)s "
+        "[{hostname}  %(process)d] [%(filename)s:%(lineno)d] "
+        "- %(message)s"
+    ).format(
+        service_variant=edx_settings.SERVICE_VARIANT,
+        logging_env=edx_settings.LOGGING_ENV,
+        hostname=hostname,
+    )
+
+    handlers = ["console"]
+
+    logger_config = {
+        "version": 1,
+        "disable_existing_loggers": False,
+        "formatters": {
+            "standard": {
+                "format": "%(asctime)s %(levelname)s %(process)d "
+                "[%(name)s] %(filename)s:%(lineno)d - %(message)s",
+            },
+            "syslog_format": {"format": syslog_format},
+            "raw": {"format": "%(message)s"},
+        },
+        "filters": {
+            "require_debug_false": {
+                "()": "django.utils.log.RequireDebugFalse",
+            },
+            "userid_context": {
+                "()": "edx_django_utils.logging.UserIdFilter",
+            },
+            "remoteip_context": {
+                "()": "edx_django_utils.logging.RemoteIpFilter",
+            },
+        },
+        "handlers": {
+            "console": {
+                "level": "INFO",
+                "class": "logging.StreamHandler",
+                "formatter": "standard",
+                "filters": ["userid_context", "remoteip_context"],
+                "stream": sys.stderr,
+            },
+            "tracking": {
+                "level": "DEBUG",
+                "class": "logging.handlers.RotatingFileHandler",
+                "filename": "/openedx/data/var/logs/tracking_logs.log",
+                "backupCount": 5,
+                "formatter": "raw",
+                "maxBytes": 10485760,
+            },
+        },
+        "loggers": {
+            "django": {"handlers": handlers, "propagate": True, "level": "INFO"},
+            "tracking": {
+                "handlers": ["tracking"],
+                "level": "DEBUG",
+                "propagate": False,
+            },
+            "requests": {"handlers": handlers, "propagate": True, "level": "WARNING"},
+            "factory": {"handlers": handlers, "propagate": True, "level": "WARNING"},
+            "django.request": {
+                "handlers": handlers,
+                "propagate": True,
+                "level": "ERROR",
+            },
+            "": {"handlers": handlers, "level": "INFO", "propagate": False},
+        },
+    }
+
+    edx_settings.LOGGING = logger_config

ol-openedx-logging-0.0.1/ol_openedx_logging.egg-info/PKG-INFO

@@ -0,0 +1,6 @@
+Metadata-Version: 2.1
+Name: ol-openedx-logging
+Version: 0.0.1
+Summary: An Open edX plugin to customize the logging configuration used by the edx-platform application
+License: BSD-3-Clause
+Requires-Python: >=3.8

ol-openedx-logging-0.0.1/ol_openedx_logging.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+MANIFEST.in
+__init__.py
+backend_shim.py
+setup.py
+ol_openedx_logging/__init__.py
+ol_openedx_logging/app.py
+ol_openedx_logging.egg-info/PKG-INFO
+ol_openedx_logging.egg-info/SOURCES.txt
+ol_openedx_logging.egg-info/dependency_links.txt
+ol_openedx_logging.egg-info/entry_points.txt
+ol_openedx_logging.egg-info/namespace_packages.txt
+ol_openedx_logging.egg-info/requires.txt
+ol_openedx_logging.egg-info/top_level.txt
+ol_openedx_logging/settings/__init__.py
+ol_openedx_logging/settings/production.py

ol-openedx-logging-0.0.1/ol_openedx_logging.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

ol-openedx-logging-0.0.1/ol_openedx_logging.egg-info/entry_points.txt

@@ -0,0 +1,5 @@
+[cms.djangoapp]
+ol_openedx_logging = ol_openedx_logging.app:EdxLoggingCMS
+
+[lms.djangoapp]
+ol_openedx_logging = ol_openedx_logging.app:EdxLoggingLMS

ol-openedx-logging-0.0.1/ol_openedx_logging.egg-info/namespace_packages.txt

@@ -0,0 +1 @@
+

ol-openedx-logging-0.0.1/ol_openedx_logging.egg-info/requires.txt

@@ -0,0 +1,2 @@
+Django>2.0
+python-json-logger<3.0.0,>=2.0.2

ol-openedx-logging-0.0.1/ol_openedx_logging.egg-info/top_level.txt

@@ -0,0 +1,2 @@
+
+ol_openedx_logging

ol-openedx-logging-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

ol-openedx-logging-0.0.1/setup.py

@@ -0,0 +1,34 @@
+
+# DO NOT EDIT THIS FILE -- AUTOGENERATED BY PANTS
+# Target: src/ol_openedx_logging:logging_package
+
+from setuptools import setup
+
+setup(**{
+    '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',
+        ],
+    },
+    'install_requires': (
+        'Django>2.0',
+        'python-json-logger<3.0.0,>=2.0.2',
+    ),
+    'license': 'BSD-3-Clause',
+    'name': 'ol-openedx-logging',
+    'namespace_packages': (
+    ),
+    'package_data': {
+    },
+    'packages': (
+        '',
+        'ol_openedx_logging',
+        'ol_openedx_logging.settings',
+    ),
+    'python_requires': '>=3.8',
+    'version': '0.0.1',
+})