[exporters] feat: add telementry support

Author: AndreyMarkinPPC

libs/exporters/docker-compose.yaml

@@ -0,0 +1,35 @@
+networks:
+  default:
+    name: garf-exporter
+    driver: bridge
+services:
+  exporter:
+    image: ghcr.io/google/garf-exporter:latest
+    command:
+      - "--source=$GARF_EXPORTER_SOURCE"
+      - "--config=/app/config.yaml"
+      - "--logger=local"
+    environment:
+      - GARF_EXPORTER_SOURCE=${GARF_EXPORTER_SOURCE}
+      - OTEL_SERVICE_NAME=garf-exporter
+      - OTEL_EXPORTER_OTLP_ENDPOINT=http://garf-exporter-otel-collector:4317
+    ports:
+      - "8001:8000"
+    volumes:
+      - "${GARF_EXPORTER_CONFIG}:/app/config.yaml"
+  jaeger:
+    image: jaegertracing/all-in-one:latest
+    ports:
+      - "16686:16686"
+    environment:
+      - COLLECTOR_OTLP_ENABLED=true
+  otel-collector:
+    image: otel/opentelemetry-collector:latest
+    container_name: garf-exporter-otel-collector
+    command: ["--config=/etc/otel-collector-config.yml"]
+    user: 0:0
+    ports:
+      - "4317:4317"
+      - "4318:4318"
+    volumes:
+      - "${OTEL_COLLECTOR_CONFIG}:/etc/otel-collector-config.yml"

libs/exporters/garf_exporter/__init__.py

@@ -19,4 +19,4 @@
   'GarfExporter',
 ]
 
-__version__ = '0.0.6'
+__version__ = '0.1.0'

libs/exporters/garf_exporter/entrypoints/cli.py

@@ -23,17 +23,20 @@
 import asyncio
 import contextlib
 import datetime
+import logging
 
 import fastapi
 import prometheus_client
 import requests
 import typer
 import uvicorn
 from garf_executors.entrypoints import utils as garf_utils
+from opentelemetry.instrumentation.fastapi import FastAPIInstrumentor
 from typing_extensions import Annotated
 
 import garf_exporter
 from garf_exporter import exporter_service
+from garf_exporter.entrypoints.tracer import initialize_tracer
 
 typer_app = typer.Typer()
 
@@ -49,8 +52,8 @@ def healthcheck(host: str, port: int) -> bool:
   the delay between exports. If this delta if greater than 1.5 check is failed.
 
   Args:
-    host: Hostname gaarf-exporter http server (i.e. localhost).
-    port: Port gaarf-exporter http server is running (i.e. 8000).
+    host: Hostname garf-exporter http server (i.e. localhost).
+    port: Port garf-exporter http server is running (i.e. 8000).
 
 
   Returns:
@@ -79,10 +82,12 @@ def healthcheck(host: str, port: int) -> bool:
   return not is_lagged_export
 
 
+initialize_tracer()
 app = fastapi.FastAPI(debug=False)
 exporter = garf_exporter.GarfExporter()
 metrics_app = prometheus_client.make_asgi_app(registry=exporter.registry)
 app.mount('/metrics', metrics_app)
+FastAPIInstrumentor.instrument_app(app)
 
 
 async def start_metric_generation(
@@ -158,7 +163,7 @@ def main(
   logger: Annotated[
     str,
     typer.Option(help='Type of logging'),
-  ] = 'rich',
+  ] = 'local',
   namespace: Annotated[
     str,
     typer.Option(help='Namespace prefix for Prometheus'),
@@ -223,6 +228,7 @@ async def start_uvicorn():
     await server.serve()
 
   asyncio.run(start_uvicorn())
+  logging.shutdown()
 
 
 if __name__ == '__main__':

libs/exporters/garf_exporter/entrypoints/tracer.py

@@ -0,0 +1,42 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import os
+
+from opentelemetry import trace
+from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import (
+  OTLPSpanExporter,
+)
+from opentelemetry.sdk.resources import Resource
+from opentelemetry.sdk.trace import TracerProvider
+from opentelemetry.sdk.trace.export import (
+  BatchSpanProcessor,
+)
+
+DEFAULT_SERVICE_NAME = 'garf-exporter'
+
+
+def initialize_tracer():
+  resource = Resource.create(
+    {'service.name': os.getenv('OTLP_SERVICE_NAME', DEFAULT_SERVICE_NAME)}
+  )
+
+  tracer_provider = TracerProvider(resource=resource)
+
+  if otel_endpoint := os.getenv('OTEL_EXPORTER_OTLP_ENDPOINT'):
+    otlp_processor = BatchSpanProcessor(
+      OTLPSpanExporter(endpoint=otel_endpoint, insecure=True)
+    )
+    tracer_provider.add_span_processor(otlp_processor)
+  trace.set_tracer_provider(tracer_provider)

libs/exporters/garf_exporter/exporter.py

@@ -26,6 +26,8 @@
 import garf_core
 import prometheus_client
 
+from garf_exporter.telemetry import tracer
+
 logger = logging.getLogger(__name__)
 
 
@@ -92,6 +94,7 @@ def reset_registry(self) -> None:
     self.registry._collector_to_names.clear()
     self.registry._names_to_collectors.clear()
 
+  @tracer.start_as_current_span('export')
   def export(
     self,
     report: garf_core.GarfReport,

libs/exporters/garf_exporter/exporter_service.py

@@ -29,6 +29,7 @@
 
 import garf_exporter
 from garf_exporter import collector
+from garf_exporter.telemetry import tracer
 
 logger = logging.getLogger(__name__)
 
@@ -112,6 +113,7 @@ def fetcher(self) -> garf_core.ApiReportFetcher:
     self._report_fetcher = fetcher(**self.source_parameters)
     return self._report_fetcher
 
+  @tracer.start_as_current_span('generate_metrics')
   def generate_metrics(
     self,
     request: GarfExporterRequest,

libs/exporters/garf_exporter/telemetry.py

@@ -0,0 +1,19 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from opentelemetry import trace
+
+tracer = trace.get_tracer(
+  instrumenting_module_name='garf_exporter',
+)

libs/exporters/pyproject.toml

@@ -12,6 +12,10 @@ dependencies = [
   "fastapi",
   "uvicorn",
   "typer",
+  "opentelemetry-api",
+  "opentelemetry-sdk",
+  "opentelemetry-instrumentation-fastapi",
+  "opentelemetry-exporter-otlp",
 ]
 authors = [
   {name = "Andrei Markin", email = "andrey.markin.ppc@gmail.com"},