From dbf6ef22df2f89f6d1b04269aaf9d3446c0dfc40 Mon Sep 17 00:00:00 2001 From: Mike OConnell <51322993+moconnell1453@users.noreply.github.com> Date: Mon, 2 Nov 2020 21:40:59 -0500 Subject: [PATCH] Using logging filters from edx-django-utils (#25492) The UserIdFilter and RemoteIpFilter logging filter classes were moved from edx-platform to edx-django-utils for more distributed use. This updated removes those classes from edx-platform, and references their counterparts in edx-django-utils. ENT-3494 --- openedx/core/djangoapps/util/log_utils.py | 34 ----------------------- openedx/core/lib/logsettings.py | 4 +-- package-lock.json | 2 +- 3 files changed, 3 insertions(+), 37 deletions(-) delete mode 100644 openedx/core/djangoapps/util/log_utils.py diff --git a/openedx/core/djangoapps/util/log_utils.py b/openedx/core/djangoapps/util/log_utils.py deleted file mode 100644 index 9406eb6db9..0000000000 --- a/openedx/core/djangoapps/util/log_utils.py +++ /dev/null @@ -1,34 +0,0 @@ -""" -Django-based logging utilities - -UserIdFilter: A logging.Filter that adds userid to the logging context - -RemoteIpFilter: A logging filter that adds the remote IP to the logging context -""" - - -from logging import Filter - -from crum import get_current_request -from crum import get_current_user - - -class UserIdFilter(Filter): - def filter(self, record): - user = get_current_user() - if user and user.pk: - record.userid = user.pk - else: - record.userid = None - return True - - -class RemoteIpFilter(Filter): - def filter(self, record): - # get IP from context - request = get_current_request() - if request and 'REMOTE_ADDR' in request.META: - record.remoteip = request.META['REMOTE_ADDR'] - else: - record.remoteip = None - return True diff --git a/openedx/core/lib/logsettings.py b/openedx/core/lib/logsettings.py index bb29924ab4..9b2a17931c 100644 --- a/openedx/core/lib/logsettings.py +++ b/openedx/core/lib/logsettings.py @@ -51,10 +51,10 @@ def get_logger_config(log_dir, '()': 'django.utils.log.RequireDebugFalse', }, 'userid_context': { - '()': 'openedx.core.djangoapps.util.log_utils.UserIdFilter', + '()': 'edx_django_utils.logging.UserIdFilter', }, 'remoteip_context': { - '()': 'openedx.core.djangoapps.util.log_utils.RemoteIpFilter', + '()': 'edx_django_utils.logging.RemoteIpFilter', } }, 'handlers': { diff --git a/package-lock.json b/package-lock.json index ea3dd15690..62396a9da5 100644 --- a/package-lock.json +++ b/package-lock.json @@ -574,7 +574,7 @@ "aproba": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/aproba/-/aproba-1.2.0.tgz", - "integrity": "sha1-aALmJk79GMeQobDVF/DyYnvyyUo=" + "integrity": "sha512-Y9J6ZjXtoYh8RnXVCMOU/ttDmk1aBjunq9vO0ta5x85WDQiQfUF9sIPBITdbiiIVcBo03Hi3jMxigBtsddlXRw==" }, "are-we-there-yet": { "version": "1.1.5",