feat: init OpenTelemetry metrics in server mode

The env var OTEL_EXPORTER_OTLP_ENDPOINT must be set to init the metrics

Author: dalpasso

eodag/rest/server.py

@@ -60,6 +60,7 @@
     get_stac_extension_oseo,
     get_stac_item_by_id,
     search_stac_items,
+    telemetry_init,
 )
 from eodag.utils import DEFAULT_ITEMS_PER_PAGE, parse_header, update_nested_dict
 from eodag.utils.exceptions import (
@@ -725,3 +726,4 @@ def stac_search(
 
 
 app.include_router(router)
+telemetry_init(app)

eodag/rest/utils.py

@@ -23,6 +23,7 @@
 import logging
 import os
 import re
+import sys
 from shutil import make_archive, rmtree
 from typing import (
     TYPE_CHECKING,
@@ -40,7 +41,17 @@
 
 import dateutil.parser
 from dateutil import tz
+from fastapi import FastAPI
 from fastapi.responses import StreamingResponse
+from opentelemetry import metrics, trace
+from opentelemetry.exporter.otlp.proto.http.metric_exporter import OTLPMetricExporter
+from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
+from opentelemetry.instrumentation.fastapi import FastAPIInstrumentor
+from opentelemetry.sdk.metrics import MeterProvider
+from opentelemetry.sdk.metrics._internal.export import PeriodicExportingMetricReader
+from opentelemetry.sdk.resources import SERVICE_NAME, Resource
+from opentelemetry.sdk.trace import TracerProvider
+from opentelemetry.sdk.trace.export import BatchSpanProcessor
 from shapely.geometry import Polygon, shape
 
 import eodag
@@ -69,6 +80,7 @@
     UnsupportedProductType,
     ValidationError,
 )
+from eodag.utils.instrumentation.eodag import EODAGInstrumentor
 
 if TYPE_CHECKING:
     from io import BufferedReader
@@ -1088,3 +1100,41 @@ def eodag_api_init() -> None:
     # pre-build search plugins
     for provider in eodag_api.available_providers():
         next(eodag_api._plugins_manager.get_search_plugins(provider=provider))
+
+
+def telemetry_init(fastapi_app: FastAPI = None):
+    """Init telemetry
+
+    :param fastapi_app: FastAPI to automatically instrument.
+    :type fastapi_app: FastAPI"""
+
+    if not os.getenv("OTEL_EXPORTER_OTLP_ENDPOINT"):
+        return None
+    if "opentelemetry" not in sys.modules:
+        return None
+
+    # Start OTLP exporter
+    resource = Resource(attributes={SERVICE_NAME: "eodag-serve-rest"})
+    # trace
+    tracer_provider = TracerProvider(resource=resource)
+    processor = BatchSpanProcessor(OTLPSpanExporter())
+    tracer_provider.add_span_processor(processor)
+    trace.set_tracer_provider(tracer_provider)
+    # metrics
+    reader = PeriodicExportingMetricReader(OTLPMetricExporter())
+    meter_provider = MeterProvider(resource=resource, metric_readers=[reader])
+    metrics.set_meter_provider(meter_provider)
+
+    # Auto instrumentation
+    if fastapi_app:
+        logger.debug("Instrument FastAPI app")
+        FastAPIInstrumentor.instrument_app(
+            app=fastapi_app,
+            tracer_provider=tracer_provider,
+            meter_provider=meter_provider,
+        )
+    logger.debug("Instrument EODAG app")
+    EODAGInstrumentor(eodag_api).instrument(
+        tracer_provider=tracer_provider,
+        meter_provider=meter_provider,
+    )