Allow protocol selection

Author: diego-ferrand

build.py

@@ -106,6 +106,8 @@ def run_pyinstaller(name: str, icon: str):
         '--hidden-import=opentelemetry.sdk.metrics.export',
         '--hidden-import=opentelemetry.exporter.otlp.proto.grpc.trace_exporter',
         '--hidden-import=opentelemetry.exporter.otlp.proto.grpc.metric_exporter',
+        '--hidden-import=opentelemetry.exporter.otlp.proto.http.trace_exporter',
+        '--hidden-import=opentelemetry.exporter.otlp.proto.http.metric_exporter',
         '--hidden-import=opentelemetry.propagate',
         '--collect-submodules=opentelemetry',
         '--collect-all=grpc',

telemetry.py

@@ -34,6 +34,27 @@
 _duration_histogram = None
 
 DEFAULT_OTLP_ENDPOINT = "https://grpc.public.prd.shared.perforce.com"
+DEFAULT_OTLP_PROTOCOL = "grpc"
+
+
+def _get_otlp_protocol() -> str:
+    return os.getenv("OTEL_EXPORTER_OTLP_PROTOCOL", DEFAULT_OTLP_PROTOCOL)
+
+
+def _create_trace_exporter():
+    if _get_otlp_protocol() == "grpc":
+        from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExporter
+    else:
+        from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
+    return OTLPSpanExporter()
+
+
+def _create_metric_exporter():
+    if _get_otlp_protocol() == "grpc":
+        from opentelemetry.exporter.otlp.proto.grpc.metric_exporter import OTLPMetricExporter
+    else:
+        from opentelemetry.exporter.otlp.proto.http.metric_exporter import OTLPMetricExporter
+    return OTLPMetricExporter()
 
 
 def init_telemetry(service_name: str, service_version: str) -> None:
@@ -56,15 +77,14 @@ def init_telemetry(service_name: str, service_version: str) -> None:
         })
         provider = TracerProvider(resource=resource)
 
-        # Default the export destination to the Perforce gRPC collector. Users
-        # override only the endpoint via OTEL_EXPORTER_OTLP_ENDPOINT;
-        # OTEL_SDK_DISABLED=true turns tracing off entirely.
+        # Default export destination/protocol for shipped releases (gRPC + Perforce
+        # collector). PAG or local dev may override via OTEL_EXPORTER_OTLP_ENDPOINT
+        # and OTEL_EXPORTER_OTLP_PROTOCOL; OTEL_SDK_DISABLED=true disables telemetry.
         if not os.environ.get("OTEL_EXPORTER_OTLP_ENDPOINT"):
             os.environ["OTEL_EXPORTER_OTLP_ENDPOINT"] = DEFAULT_OTLP_ENDPOINT
 
         try:
-            from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExporter
-            provider.add_span_processor(BatchSpanProcessor(OTLPSpanExporter()))
+            provider.add_span_processor(BatchSpanProcessor(_create_trace_exporter()))
         except Exception:
             logger.debug("OTLP trace exporter setup failed", exc_info=True)
 
@@ -77,8 +97,7 @@ def init_telemetry(service_name: str, service_version: str) -> None:
 
             readers = []
             try:
-                from opentelemetry.exporter.otlp.proto.grpc.metric_exporter import OTLPMetricExporter
-                readers.append(PeriodicExportingMetricReader(OTLPMetricExporter()))
+                readers.append(PeriodicExportingMetricReader(_create_metric_exporter()))
             except Exception:
                 logger.debug("OTLP metric exporter setup failed", exc_info=True)
 

tests/test_telemetry.py

@@ -21,7 +21,16 @@
 import pytest
 
 from models.result import BaseResult
-from telemetry import DEFAULT_OTLP_ENDPOINT, _record_metrics, init_telemetry, run_tool
+from telemetry import (
+    DEFAULT_OTLP_ENDPOINT,
+    DEFAULT_OTLP_PROTOCOL,
+    _create_metric_exporter,
+    _create_trace_exporter,
+    _get_otlp_protocol,
+    _record_metrics,
+    init_telemetry,
+    run_tool,
+)
 
 
 def _make_ctx(meta=None):
@@ -232,3 +241,53 @@ def test_explicit_endpoint_not_overridden(self, monkeypatch):
         monkeypatch.delenv("OTEL_SDK_DISABLED", raising=False)
         init_telemetry("perfecto-mcp", "1.0.0")
         assert os.environ["OTEL_EXPORTER_OTLP_ENDPOINT"] == "http://localhost:4317"
+
+    def test_defaults_protocol_to_grpc(self, monkeypatch):
+        monkeypatch.delenv("OTEL_EXPORTER_OTLP_PROTOCOL", raising=False)
+        assert _get_otlp_protocol() == DEFAULT_OTLP_PROTOCOL
+        assert DEFAULT_OTLP_PROTOCOL == "grpc"
+
+    def test_http_protocol_env(self, monkeypatch):
+        monkeypatch.setenv("OTEL_EXPORTER_OTLP_PROTOCOL", "http/protobuf")
+        assert _get_otlp_protocol() == "http/protobuf"
+
+    def test_does_not_raise_with_http_protocol(self, monkeypatch):
+        monkeypatch.setenv("OTEL_EXPORTER_OTLP_PROTOCOL", "http/protobuf")
+        monkeypatch.setenv("OTEL_EXPORTER_OTLP_ENDPOINT", "http://localhost:4318")
+        init_telemetry("perfecto-mcp", "1.0.0")
+
+    def test_grpc_trace_exporter_selected(self, monkeypatch):
+        monkeypatch.setenv("OTEL_EXPORTER_OTLP_PROTOCOL", "grpc")
+        with patch(
+            "opentelemetry.exporter.otlp.proto.grpc.trace_exporter.OTLPSpanExporter",
+            return_value=MagicMock(),
+        ) as grpc_exporter:
+            _create_trace_exporter()
+        grpc_exporter.assert_called_once()
+
+    def test_http_trace_exporter_selected(self, monkeypatch):
+        monkeypatch.setenv("OTEL_EXPORTER_OTLP_PROTOCOL", "http/protobuf")
+        with patch(
+            "opentelemetry.exporter.otlp.proto.http.trace_exporter.OTLPSpanExporter",
+            return_value=MagicMock(),
+        ) as http_exporter:
+            _create_trace_exporter()
+        http_exporter.assert_called_once()
+
+    def test_grpc_metric_exporter_selected(self, monkeypatch):
+        monkeypatch.setenv("OTEL_EXPORTER_OTLP_PROTOCOL", "grpc")
+        with patch(
+            "opentelemetry.exporter.otlp.proto.grpc.metric_exporter.OTLPMetricExporter",
+            return_value=MagicMock(),
+        ) as grpc_exporter:
+            _create_metric_exporter()
+        grpc_exporter.assert_called_once()
+
+    def test_http_metric_exporter_selected(self, monkeypatch):
+        monkeypatch.setenv("OTEL_EXPORTER_OTLP_PROTOCOL", "http/json")
+        with patch(
+            "opentelemetry.exporter.otlp.proto.http.metric_exporter.OTLPMetricExporter",
+            return_value=MagicMock(),
+        ) as http_exporter:
+            _create_metric_exporter()
+        http_exporter.assert_called_once()