Merge pull request #455 from ansforge/hotfix-instrumentation-filter-health

chore(converter): filter calls to metrics & health

Author: Clemsazert

converter/converter/converter.py

@@ -14,7 +14,7 @@
 )
 from converter.logging_config import configure_logging, LoggingKeys
 from converter.database import init_db, get_db
-from converter.tracing import configure_tracing, tag_current_span
+from converter.tracing import configure_tracing, tag_current_span, untraced
 
 configure_logging()
 
@@ -106,7 +106,7 @@ def convert():
 @app.route("/health", methods=["GET"])
 def health_check():
     try:
-        with timeout(5):
+        with untraced(), timeout(5):
             get_db().command("ping")
             db_status = "UP"
     except Exception:

converter/converter/tracing.py

@@ -4,6 +4,7 @@
 from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
 from opentelemetry.instrumentation.flask import FlaskInstrumentor
 from opentelemetry.instrumentation.pymongo import PymongoInstrumentor
+from opentelemetry.instrumentation.utils import suppress_instrumentation
 from opentelemetry.sdk.resources import SERVICE_NAME, SERVICE_VERSION, Resource
 from opentelemetry.sdk.trace import TracerProvider
 from opentelemetry.sdk.trace.export import BatchSpanProcessor
@@ -23,6 +24,11 @@
 RECIPIENT_ATTRIBUTE = "hubsante.recipient"
 USE_CASE_ATTRIBUTE = "hubsante.use_case"
 
+# Regexes matched against the request URL: probe/scrape endpoints get no Flask span.
+EXCLUDED_URLS = "/health,/metrics"
+
+untraced = suppress_instrumentation
+
 
 def is_tracing_enabled() -> bool:
     return os.getenv("OTEL_SDK_DISABLED", "false").strip().lower() != "true"
@@ -66,7 +72,7 @@ def configure_tracing(app) -> None:
     provider.add_span_processor(BatchSpanProcessor(OTLPSpanExporter()))
     trace.set_tracer_provider(provider)
 
-    FlaskInstrumentor().instrument_app(app)
+    FlaskInstrumentor().instrument_app(app, excluded_urls=EXCLUDED_URLS)
     PymongoInstrumentor().instrument()
     logger.info(
         f"OpenTelemetry tracing configured for service '{resource.attributes.get(SERVICE_NAME)}'"