Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 0 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ EdX utilities for Django Application development.

monitoring/how_tos/add_code_owner_custom_attribute_to_an_ida
monitoring/how_tos/using_custom_attributes
monitoring/how_tos/search_new_relic_nrql
monitoring/how_tos/update_monitoring_for_squad_or_theme_changes

.. toctree::
Expand Down
1 change: 0 additions & 1 deletion docs/monitoring/how_tos/search_new_relic.rst

This file was deleted.

6 changes: 0 additions & 6 deletions edx_django_utils/monitoring/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,6 @@ Here is how you add the middleware:
'edx_django_utils.monitoring.MonitoringSupportMiddleware',
'edx_django_utils.monitoring.DeploymentMonitoringMiddleware',
'edx_django_utils.monitoring.CookieMonitoringMiddleware',
'edx_django_utils.monitoring.CodeOwnerMonitoringMiddleware',
'edx_django_utils.monitoring.FrontendMonitoringMiddleware',
'edx_django_utils.monitoring.MonitoringMemoryMiddleware',
)
Expand All @@ -99,11 +98,6 @@ In order to use the monitoring signals, import them as follows::

from edx_django_utils.monitoring.signals import monitoring_support_process_response

Code Owner Custom Attribute
---------------------------

See docstring for ``CodeOwnerMonitoringMiddleware`` for configuring the ``code_owner`` custom attribute for your IDA.

Cookie Monitoring Middleware
----------------------------

Expand Down
1 change: 0 additions & 1 deletion edx_django_utils/monitoring/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
See README.rst for additional details.
"""
from .internal.backends import DatadogBackend, NewRelicBackend, OpenTelemetryBackend, TelemetryBackend
from .internal.code_owner.middleware import CodeOwnerMonitoringMiddleware
from .internal.code_owner.utils import (
get_code_owner_from_module,
set_code_owner_attribute,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,6 @@ If you want to know about custom attributes in general, see :doc:`using_custom_a

.. _ADR on monitoring by code owner: https://github.com/openedx/edx-platform/blob/master/lms/djangoapps/monitoring/docs/decisions/0001-monitoring-by-code-owner.rst

Setting up the Middleware
-------------------------

You simply need to add ``edx_django_utils.monitoring.CodeOwnerMonitoringMiddleware`` as described in the README to make this functionality available. Then it is ready to be configured.

Handling celery tasks
---------------------

Expand All @@ -52,7 +47,7 @@ An untested potential alternative to the decorator is documented in the `Code Ow
Configuring your app settings
-----------------------------

Once the Middleware is made available, simply set the Django Settings ``CODE_OWNER_MAPPINGS`` and ``CODE_OWNER_THEMES`` appropriately.
Set the Django Settings ``CODE_OWNER_MAPPINGS`` and ``CODE_OWNER_THEMES`` appropriately.

The following example shows how you can include an optional config for a catch-all using ``'*'``. Although you might expect this example to use Python, it is intentionally illustrated in YAML because the catch-all requires special care in YAML.

Expand Down
6 changes: 0 additions & 6 deletions edx_django_utils/monitoring/docs/how_tos/search_new_relic.rst

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,3 @@ Example contract phase NRQL::

code_owner_squad = 'new-squad-name'
code_owner_theme = 'new-theme-name'

To find the relevant NRQL to update, see `Searching New Relic NRQL`_.

Searching New Relic NRQL
------------------------

See :doc:`search_new_relic` for general information about the ``new_relic_search.py`` script.

This script can be especially useful for helping with the expand/contract phase when changing squad or theme names. For example, you could use the following::

new_relic_search.py --regex old-squad-name
new_relic_search.py --regex new-squad-name
175 changes: 0 additions & 175 deletions edx_django_utils/monitoring/internal/code_owner/middleware.py

This file was deleted.

3 changes: 0 additions & 3 deletions edx_django_utils/monitoring/internal/code_owner/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -136,9 +136,6 @@ def set_code_owner_attribute_from_module(module):
Celery tasks or other non-web functions do not use middleware, so we need
an alternative way to set the code_owner custom attribute.

Note: These settings will be overridden by the CodeOwnerMonitoringMiddleware.
This method can't be used to override web functions at this time.

Usage::

set_code_owner_attribute_from_module(__name__)
Expand Down
Loading