Enable OpenTelemetry in debug mode (#91)

* Remove health-checks dependency

* Add pyroscope

* Add Pyroscope instrumentation configuration and implementation

* Adding Pyroscope integration to OpenTelemetry instrument for span processing and configuration adjustments

* Add service_debug option to enable console span export in OpentelemetryConfig

* Add PyroscopeInstrument and simplify OpentelemetryInstrument checks

* Adjust is_ready check and conditionally add OTLPSpanProcessor based on endpoint

* Add span formatting function for console exporter in opentelemetry_instrument.py

* Optimize Litestar bootstrapper by removing Pyroscope integration

* Adjust minimal opentelemetry config and test checks

* Adjust minimal_opentelemetry_config for bootstrap readiness test in test_opentelemetry.py

* Simplify minimal_opentelemetry_config fixture return statement

* Adjusts minimal_opentelemetry_config to include namespace and container name

Author: vrslev

microbootstrap/instruments/opentelemetry_instrument.py

@@ -1,13 +1,15 @@
 from __future__ import annotations
 import dataclasses
+import os
 import typing
 
 import pydantic
 from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExporter
 from opentelemetry.instrumentation.instrumentor import BaseInstrumentor  # type: ignore[attr-defined] # noqa: TC002
 from opentelemetry.sdk import resources
+from opentelemetry.sdk.trace import ReadableSpan
 from opentelemetry.sdk.trace import TracerProvider as SdkTracerProvider
-from opentelemetry.sdk.trace.export import BatchSpanProcessor
+from opentelemetry.sdk.trace.export import BatchSpanProcessor, ConsoleSpanExporter, SimpleSpanProcessor
 from opentelemetry.trace import set_tracer_provider
 
 
@@ -29,6 +31,7 @@ class OpenTelemetryInstrumentor:
 
 
 class OpentelemetryConfig(BaseInstrumentConfig):
+    service_debug: bool = True
     service_name: str = "micro-service"
     service_version: str = "1.0.0"
     health_checks_path: str = "/health/"
@@ -58,46 +61,46 @@ class FastStreamOpentelemetryConfig(OpentelemetryConfig):
     opentelemetry_middleware_cls: type[FastStreamTelemetryMiddlewareProtocol] | None = None
 
 
+def _format_span(readable_span: ReadableSpan) -> str:
+    return typing.cast("str", readable_span.to_json(indent=None)) + os.linesep
+
+
 class BaseOpentelemetryInstrument(Instrument[OpentelemetryConfigT]):
     instrument_name = "Opentelemetry"
     ready_condition = "Provide all necessary config parameters"
 
     def is_ready(self) -> bool:
-        return all(
-            [
-                self.instrument_config.opentelemetry_endpoint,
-                self.instrument_config.opentelemetry_namespace,
-                self.instrument_config.service_name,
-                self.instrument_config.service_version,
-                self.instrument_config.opentelemetry_container_name,
-            ],
-        )
+        return bool(self.instrument_config.opentelemetry_endpoint) or self.instrument_config.service_debug
 
     def teardown(self) -> None:
         for instrumentor_with_params in self.instrument_config.opentelemetry_instrumentors:
             instrumentor_with_params.instrumentor.uninstrument(**instrumentor_with_params.additional_params)
 
     def bootstrap(self) -> None:
-        resource: typing.Final = resources.Resource.create(
-            attributes={
-                resources.SERVICE_NAME: self.instrument_config.opentelemetry_service_name
-                or self.instrument_config.service_name,
-                resources.TELEMETRY_SDK_LANGUAGE: "python",
-                resources.SERVICE_NAMESPACE: self.instrument_config.opentelemetry_namespace,  # type: ignore[dict-item]
-                resources.SERVICE_VERSION: self.instrument_config.service_version,
-                resources.CONTAINER_NAME: self.instrument_config.opentelemetry_container_name,  # type: ignore[dict-item]
-            },
-        )
+        attributes = {
+            resources.SERVICE_NAME: self.instrument_config.opentelemetry_service_name
+            or self.instrument_config.service_name,
+            resources.TELEMETRY_SDK_LANGUAGE: "python",
+            resources.SERVICE_VERSION: self.instrument_config.service_version,
+        }
+        if self.instrument_config.opentelemetry_namespace:
+            attributes[resources.SERVICE_NAMESPACE] = self.instrument_config.opentelemetry_namespace
+        if self.instrument_config.opentelemetry_container_name:
+            attributes[resources.CONTAINER_NAME] = self.instrument_config.opentelemetry_container_name
+        resource: typing.Final = resources.Resource.create(attributes=attributes)
 
         self.tracer_provider = SdkTracerProvider(resource=resource)
-        self.tracer_provider.add_span_processor(
-            BatchSpanProcessor(
-                OTLPSpanExporter(
-                    endpoint=self.instrument_config.opentelemetry_endpoint,
-                    insecure=self.instrument_config.opentelemetry_insecure,
+        if self.instrument_config.service_debug:
+            self.tracer_provider.add_span_processor(SimpleSpanProcessor(ConsoleSpanExporter(formatter=_format_span)))
+        if self.instrument_config.opentelemetry_endpoint:
+            self.tracer_provider.add_span_processor(
+                BatchSpanProcessor(
+                    OTLPSpanExporter(
+                        endpoint=self.instrument_config.opentelemetry_endpoint,
+                        insecure=self.instrument_config.opentelemetry_insecure,
+                    ),
                 ),
-            ),
-        )
+            )
         for opentelemetry_instrumentor in self.instrument_config.opentelemetry_instrumentors:
             opentelemetry_instrumentor.instrumentor.instrument(
                 tracer_provider=self.tracer_provider,

pyproject.toml

@@ -60,7 +60,7 @@ litestar = [
     "prometheus-client>=0.20",
 ]
 granian = ["granian[reload]>=1"]
-faststream = ["faststream~=0.5", "health-checks>=1", "prometheus-client>=0.20"]
+faststream = ["faststream~=0.5", "prometheus-client>=0.20"]
 
 [dependency-groups]
 dev = [

tests/conftest.py

@@ -78,8 +78,6 @@ def minimal_health_checks_config() -> HealthChecksConfig:
 @pytest.fixture
 def minimal_opentelemetry_config() -> OpentelemetryConfig:
     return OpentelemetryConfig(
-        service_name="test-micro-service",
-        service_version="1.0.0",
         opentelemetry_endpoint="/my-engdpoint",
         opentelemetry_namespace="namespace",
         opentelemetry_container_name="container-name",

tests/instruments/test_opentelemetry.py

@@ -23,7 +23,8 @@ def test_opentelemetry_is_ready(
 
 
 def test_opentelemetry_bootstrap_is_not_ready(minimal_opentelemetry_config: OpentelemetryConfig) -> None:
-    minimal_opentelemetry_config.service_name = ""
+    minimal_opentelemetry_config.service_debug = False
+    minimal_opentelemetry_config.opentelemetry_endpoint = None
     opentelemetry_instrument: typing.Final = OpentelemetryInstrument(minimal_opentelemetry_config)
     assert not opentelemetry_instrument.is_ready()