edx_django_utils.monitoring package

Subpackages

• edx_django_utils.monitoring.internal package
  • Subpackages
    • edx_django_utils.monitoring.internal.code_owner package
      • Submodules
      • edx_django_utils.monitoring.internal.code_owner.middleware module
      • edx_django_utils.monitoring.internal.code_owner.utils module
      • Module contents
  • Submodules
  • edx_django_utils.monitoring.internal.backends module
    • DatadogBackend
      • DatadogBackend.create_span()
      • DatadogBackend.record_exception()
      • DatadogBackend.set_attribute()
      • DatadogBackend.set_local_root_span_name()
      • DatadogBackend.tag_root_span_with_error()
    • NewRelicBackend
      • NewRelicBackend.create_span()
      • NewRelicBackend.record_exception()
      • NewRelicBackend.set_attribute()
      • NewRelicBackend.set_local_root_span_name()
      • NewRelicBackend.tag_root_span_with_error()
    • OpenTelemetryBackend
      • OpenTelemetryBackend.create_span()
      • OpenTelemetryBackend.record_exception()
      • OpenTelemetryBackend.set_attribute()
      • OpenTelemetryBackend.set_local_root_span_name()
      • OpenTelemetryBackend.tag_root_span_with_error()
    • TelemetryBackend
      • TelemetryBackend.create_span()
      • TelemetryBackend.record_exception()
      • TelemetryBackend.set_attribute()
      • TelemetryBackend.set_local_root_span_name()
      • TelemetryBackend.tag_root_span_with_error()
    • configured_backends()
  • edx_django_utils.monitoring.internal.middleware module
    • CachedCustomMonitoringMiddleware
    • CookieMonitoringMiddleware
      • CookieMonitoringMiddleware.get_log_message_and_monitor_cookies()
      • CookieMonitoringMiddleware.log_corrupt_cookie_headers()
    • DeploymentMonitoringMiddleware
      • DeploymentMonitoringMiddleware.record_django_version()
      • DeploymentMonitoringMiddleware.record_python_version()
    • FrontendMonitoringMiddleware
      • FrontendMonitoringMiddleware.inject_script()
    • MonitoringMemoryMiddleware
      • MonitoringMemoryMiddleware.guid_key
      • MonitoringMemoryMiddleware.memory_data_key
      • MonitoringMemoryMiddleware.process_request()
      • MonitoringMemoryMiddleware.process_response()
    • MonitoringSupportMiddleware
      • MonitoringSupportMiddleware.accumulate_attribute()
      • MonitoringSupportMiddleware.accumulate_metric()
      • MonitoringSupportMiddleware.process_exception()
      • MonitoringSupportMiddleware.process_request()
      • MonitoringSupportMiddleware.process_response()
    • split_ascii_log_message()
  • edx_django_utils.monitoring.internal.transactions module
    • ignore_transaction()
  • edx_django_utils.monitoring.internal.utils module
    • accumulate()
    • background_task()
    • function_trace()
    • increment()
    • record_exception()
    • set_custom_attribute()
    • set_custom_attributes_for_course_key()
    • set_monitoring_transaction_name()
  • Module contents
• edx_django_utils.monitoring.tests package
  • Subpackages
    • edx_django_utils.monitoring.tests.code_owner package
      • Submodules
      • edx_django_utils.monitoring.tests.code_owner.mock_views module
      • edx_django_utils.monitoring.tests.code_owner.test_middleware module
      • edx_django_utils.monitoring.tests.code_owner.test_utils module
      • Module contents
  • Submodules
  • edx_django_utils.monitoring.tests.test_backends module
    • TestBackendsConfig
      • TestBackendsConfig.test_configured_backends_1__None____NewRelicBackend___()
      • TestBackendsConfig.test_configured_backends_2_________()
      • TestBackendsConfig.test_configured_backends_3____edx_django_utils_monitoring_OpenTelemetryBackend______OpenTelemetryBackend___()
      • TestBackendsConfig.test_configured_backends_4____edx_django_utils_monitoring_NewRelicBackend____edx_django_utils_monitoring_OpenTelemetryBackend____edx_django_utils_monitoring_DatadogBackend______NewRelicBackend____OpenTelemetryBackend____DatadogBackend___()
      • TestBackendsConfig.test_default_config()
      • TestBackendsConfig.test_import_failure()
      • TestBackendsConfig.test_newrelic_package()
      • TestBackendsConfig.test_type()
      • TestBackendsConfig.test_wrong_class()
    • TestBackendsFanOut
      • TestBackendsFanOut.test_record_exception()
      • TestBackendsFanOut.test_set_custom_attribute()
  • edx_django_utils.monitoring.tests.test_middleware module
  • edx_django_utils.monitoring.tests.test_monitoring_support module
    • TestMonitoringSupportMiddleware
      • TestMonitoringSupportMiddleware.catch_signal()
      • TestMonitoringSupportMiddleware.setUp()
      • TestMonitoringSupportMiddleware.test_accumulate_and_increment_1()
      • TestMonitoringSupportMiddleware.test_accumulate_and_increment_2()
      • TestMonitoringSupportMiddleware.test_accumulate_and_increment_3()
      • TestMonitoringSupportMiddleware.test_accumulate_with_illegal_value_1()
      • TestMonitoringSupportMiddleware.test_accumulate_with_illegal_value_2()
      • TestMonitoringSupportMiddleware.test_deprecated_accumulate()
      • TestMonitoringSupportMiddleware.test_deprecated_increment()
      • TestMonitoringSupportMiddleware.test_deprecated_set_custom_attribute()
      • TestMonitoringSupportMiddleware.test_deprecated_set_custom_attributes_for_course_key()
      • TestMonitoringSupportMiddleware.test_error_tagging()
      • TestMonitoringSupportMiddleware.test_process_exception_signal()
      • TestMonitoringSupportMiddleware.test_process_request_signal()
      • TestMonitoringSupportMiddleware.test_process_response_signal()
  • Module contents

Submodules

edx_django_utils.monitoring.signals module

Signals defined to support monitoring plugins.

Placing signals in this file (vs alternatives like /internal, or signals/signals.py) provides a good public api for these signals.

edx_django_utils.monitoring.utils module

Deprecated monitoring helpers for backward-compatibility.

IMPORTANT: No new code should be added to this file. TODO: Remove this file once this code are no longer used.

edx_django_utils.monitoring.utils.accumulate(name, value)

Deprecated method. Use public API instead.

edx_django_utils.monitoring.utils.increment(name)

Deprecated method. Use public API instead.

edx_django_utils.monitoring.utils.set_custom_attribute(key, value)

Deprecated method. Use public API instead.

edx_django_utils.monitoring.utils.set_custom_attributes_for_course_key(course_key)

Deprecated method. Use public API instead.

edx_django_utils.monitoring.utils.set_custom_metric(key, value)

Deprecated method to set monitoring custom attribute.

edx_django_utils.monitoring.utils.set_custom_metrics_for_course_key(course_key)

Deprecated method to set monitoring custom attributes for course key.

Module contents

Monitoring utilities public api

Does not include signals.py, which is also part of the public api. See README.rst for additional details.