search

edx / edx-arch-experiments

A plugin to include applications under development by the architecture team at edx
GNU Affero General Public License v3.0
0 stars 3 forks source link

feat: Add middleware `DatadogDiagnosticMiddleware` #735

Closed timmc-edx closed 2 months ago

timmc-edx commented 2 months ago

Adds logging diagnostics for traces in Datadog.

See https://github.com/edx/edx-arch-experiments/issues/692

Merge checklist: Check off if complete or not applicable:

timmc-edx commented 2 months ago

Hmm... it would require a significant amount of test harness to test the span and resolver logic, and there aren't easy ways to test both the datadog-installed and datadog-missing branches. Honestly, I'm pretty happy to fall back on the try/except here to protect against exceptions and just rely on manual testing for the rest.

In case you're curious about log size and what information is in the spans, here's a sample log line from devstack:

2024-07-24 19:14:21,990 INFO 159041 [edx_arch_experiments.datadog_diagnostics.middleware] [user 3] [ip 172.25.0.1] middleware.py:63 - Datadog span diagnostics: Route = api/user/v1/preferences/(?P<username>[\w .@_+-]+)$; local root span = name='django.request' id=16693121629397193611 trace_id=136418889693043940232725395409779696451 parent_id=None service='django' resource='__django_request' type='web' start=1721848461.88791 end=None duration=None error=0 tags={'DEFAULT_HASHING_ALGORITHM': 'sha256', 'component': 'django', 'django.request.class': 'django.core.handlers.wsgi.WSGIRequest', 'django_version': '4.2.14', 'http.method': 'GET', 'ip_chain.external.types': 'priv', 'ip_chain.raw': '172.25.0.1', 'ip_chain.safest_client_ip': '172.25.0.1', 'ip_chain.types': 'priv', 'is_enforce_session_email_match_enabled': 'False', 'python_version': '3.11.9', 'runtime-id': '64041d8c5a144b4bb2e4317837def5cf', 'session_email_mismatch': 'False', 'span.kind': 'server'} metrics={'_dd.measured': 1, 'cookies.header.size': 933, 'ip_chain.count': 1, 'ip_chain.external.count': 1, 'process_id': 159041, 'safe_sessions.session_cookie_count': 1}; current span = name='django.middleware' id=5174195364098946478 trace_id=136418889693043940232725395409779696451 parent_id=17630798428218980004 service='django' resource='edx_arch_experiments.datadog_diagnostics.middleware.DatadogDiagnosticMiddleware.process_view' type=None start=1721848461.9880073 end=None duration=None error=0 tags={'component': 'django'} metrics={}

timmc-edx commented 2 months ago

Yeah, I could add ddtrace to the test requirements and set up a bunch of mocks, but I'm feeling lucky. I think if we go to add additional functionality (or if this fails when deployed) that's when I'd like to invest in tests.