Files
edx-platform/lms/djangoapps/monitoring/middleware.py
Robert Raposa 7e56d89bcc remove temp_view_func_compare custom metric (#24211)
In an earlier PR, we moved logic from process_view to process
request, so mapping would happen earlier in the middleware
lifecycle, and the code_owner metric would be set for requests
that never made it to process_view.

The temp_view_func_compare custom metric was added temporarily to
ensure this earlier refactor did not introduce any unaccounted for
differences. It did not, so we are removing this temporary metric.

ARCHBOM-1263
2020-06-12 08:53:20 -04:00

50 lines
1.7 KiB
Python

"""
Middleware for monitoring the LMS
"""
import logging
from django.urls import Resolver404, resolve
from edx_django_utils.monitoring import set_custom_metric
from .utils import get_code_owner_from_module, is_code_owner_mappings_configured
log = logging.getLogger(__name__)
class CodeOwnerMetricMiddleware:
"""
Django middleware object to set custom metrics for the owner of each view.
Custom metrics set:
- code_owner: The owning team mapped to the current view.
- code_owner_mapping_error: If there are any errors when trying to perform the mapping.
- view_func_module: The __module__ of the view_func, which can be used to
find missing mappings.
"""
def __init__(self, get_response):
self.get_response = get_response
def __call__(self, request):
self._set_owner_metrics_for_request(request)
response = self.get_response(request)
return response
def _set_owner_metrics_for_request(self, request):
"""
Uses the request path to find the view_func and then sets code owner metrics based on the view.
"""
if not is_code_owner_mappings_configured():
return
try:
view_func, _, _ = resolve(request.path)
view_func_module = view_func.__module__
set_custom_metric('view_func_module', view_func_module)
code_owner = get_code_owner_from_module(view_func_module)
if code_owner:
set_custom_metric('code_owner', code_owner)
except Resolver404:
set_custom_metric('code_owner_mapping_error', "Couldn't resolve view for request path {}".format(request.path))
except Exception as e:
set_custom_metric('code_owner_mapping_error', e)