From abb4e9111073f8334a52afcec1fe17ffa45354bf Mon Sep 17 00:00:00 2001 From: Tim McCormack Date: Wed, 11 Dec 2024 19:15:27 +0000 Subject: [PATCH] docs: Update comment for suppressing Datadog middleware spans in edxapp It's now documented on the wiki as an option IDA owners may want. --- playbooks/roles/edxapp/templates/edx/app/edxapp/cms.sh.j2 | 7 ++----- playbooks/roles/edxapp/templates/edx/app/edxapp/lms.sh.j2 | 7 ++----- .../roles/edxapp/templates/edx/app/edxapp/worker.sh.j2 | 7 ++----- 3 files changed, 6 insertions(+), 15 deletions(-) diff --git a/playbooks/roles/edxapp/templates/edx/app/edxapp/cms.sh.j2 b/playbooks/roles/edxapp/templates/edx/app/edxapp/cms.sh.j2 index 4ff06765530..edc856f54b1 100644 --- a/playbooks/roles/edxapp/templates/edx/app/edxapp/cms.sh.j2 +++ b/playbooks/roles/edxapp/templates/edx/app/edxapp/cms.sh.j2 @@ -18,11 +18,8 @@ export DD_LOGS_INJECTION=true # reason. export DD_TRACE_LOG_STREAM_HANDLER=false -# Temporary: We currently have a span (or several) for each Django middleware, -# and Datadog Support has implied that it will be easier to debug our tracing -# issues if we don't record those middleware. (They make up the bulk of traces, -# at least visually.) -# See https://github.com/edx/edx-arch-experiments/issues/692 +# Suppress middleware spans because there are about 100 for each request. +# Remove (or set to true) for debugging. export DD_DJANGO_INSTRUMENT_MIDDLEWARE=false {% endif -%} diff --git a/playbooks/roles/edxapp/templates/edx/app/edxapp/lms.sh.j2 b/playbooks/roles/edxapp/templates/edx/app/edxapp/lms.sh.j2 index efc3fcdf629..a449edd7ad9 100644 --- a/playbooks/roles/edxapp/templates/edx/app/edxapp/lms.sh.j2 +++ b/playbooks/roles/edxapp/templates/edx/app/edxapp/lms.sh.j2 @@ -18,11 +18,8 @@ export DD_LOGS_INJECTION=true # reason. export DD_TRACE_LOG_STREAM_HANDLER=false -# Temporary: We currently have a span (or several) for each Django middleware, -# and Datadog Support has implied that it will be easier to debug our tracing -# issues if we don't record those middleware. (They make up the bulk of traces, -# at least visually.) -# See https://github.com/edx/edx-arch-experiments/issues/692 +# Suppress middleware spans because there are about 100 for each request. +# Remove (or set to true) for debugging. export DD_DJANGO_INSTRUMENT_MIDDLEWARE=false {% endif -%} diff --git a/playbooks/roles/edxapp/templates/edx/app/edxapp/worker.sh.j2 b/playbooks/roles/edxapp/templates/edx/app/edxapp/worker.sh.j2 index 20d235ddbdd..7d45f37a1f9 100644 --- a/playbooks/roles/edxapp/templates/edx/app/edxapp/worker.sh.j2 +++ b/playbooks/roles/edxapp/templates/edx/app/edxapp/worker.sh.j2 @@ -18,11 +18,8 @@ export DD_LOGS_INJECTION=true # reason. export DD_TRACE_LOG_STREAM_HANDLER=false -# Temporary: We currently have a span (or several) for each Django middleware, -# and Datadog Support has implied that it will be easier to debug our tracing -# issues if we don't record those middleware. (They make up the bulk of traces, -# at least visually.) -# See https://github.com/edx/edx-arch-experiments/issues/692 +# Suppress middleware spans because there are about 100 for each request. +# Remove (or set to true) for debugging. export DD_DJANGO_INSTRUMENT_MIDDLEWARE=false {% endif -%}