opentelemetry: fix import ordering (#99)

* opentelemetry: fix import ordering

* test: fix failing tests

- auto_instrumentation patched away

* test: add missing call to test

- Results checked in the test were missing one is_ready() call

* fastapi: remove unused type ignore directives

* openetelemetry_instrument: use ResourceAttributes instead of aliases

- resources module uses constants that are just aliases to ResourceAttributes module. The module has
a @deprecated message though. But it doesn't appear to matter at the moment.

* opentelemetry_instrument: mypy blooper

- resources certainly have Resource!

Author: danberdev

microbootstrap/bootstrappers/fastapi.py

@@ -104,8 +104,8 @@ def bootstrap_after(self, application: ApplicationT) -> ApplicationT:
 class FastApiLoggingInstrument(LoggingInstrument):
     def bootstrap_after(self, application: ApplicationT) -> ApplicationT:
         if not self.instrument_config.logging_turn_off_middleware:
-            application.add_middleware(  # type: ignore[call-arg]
-                build_fastapi_logging_middleware(self.instrument_config.logging_exclude_endpoints),  # type: ignore[arg-type]
+            application.add_middleware(
+                build_fastapi_logging_middleware(self.instrument_config.logging_exclude_endpoints),
             )
         return application
 

microbootstrap/instruments/opentelemetry_instrument.py

@@ -6,13 +6,14 @@
 
 import pydantic
 from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExporter
+from opentelemetry.instrumentation import auto_instrumentation
 from opentelemetry.instrumentation.instrumentor import BaseInstrumentor  # type: ignore[attr-defined] # noqa: TC002
 from opentelemetry.sdk import resources
 from opentelemetry.sdk.trace import ReadableSpan, Span, SpanProcessor
 from opentelemetry.sdk.trace import TracerProvider as SdkTracerProvider
 from opentelemetry.sdk.trace.export import BatchSpanProcessor, ConsoleSpanExporter, SimpleSpanProcessor
+from opentelemetry.semconv.resource import ResourceAttributes
 from opentelemetry.trace import format_span_id, set_tracer_provider
-from opentelemetry.instrumentation import auto_instrumentation
 
 from microbootstrap.instruments.base import BaseInstrumentConfig, Instrument
 
@@ -90,16 +91,16 @@ def bootstrap(self) -> None:
         auto_instrumentation.initialize()
 
         attributes = {
-            resources.SERVICE_NAME: self.instrument_config.opentelemetry_service_name
+            ResourceAttributes.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,
+            ResourceAttributes.TELEMETRY_SDK_LANGUAGE: "python",
+            ResourceAttributes.SERVICE_VERSION: self.instrument_config.service_version,
         }
         if self.instrument_config.opentelemetry_namespace:
-            attributes[resources.SERVICE_NAMESPACE] = self.instrument_config.opentelemetry_namespace
+            attributes[ResourceAttributes.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)
+            attributes[ResourceAttributes.CONTAINER_NAME] = self.instrument_config.opentelemetry_container_name
+        resource: typing.Final = resources.Resource.create(attributes=attributes)  # type: ignore[attr-defined]
 
         self.tracer_provider = SdkTracerProvider(resource=resource)
         if self.instrument_config.pyroscope_endpoint and pyroscope:

tests/conftest.py

@@ -16,6 +16,7 @@
     SentryConfig,
 )
 from microbootstrap.console_writer import ConsoleWriter
+from microbootstrap.instruments import opentelemetry_instrument
 from microbootstrap.instruments.cors_instrument import CorsConfig
 from microbootstrap.instruments.health_checks_instrument import HealthChecksConfig
 from microbootstrap.instruments.prometheus_instrument import BasePrometheusConfig
@@ -126,3 +127,8 @@ def console_writer() -> ConsoleWriter:
 def reset_reloaded_settings_module() -> typing.Iterator[None]:
     yield
     importlib.reload(microbootstrap.settings)
+
+
+@pytest.fixture(autouse=True)
+def disable_auto_instrumentation(monkeypatch: pytest.MonkeyPatch) -> None:
+    monkeypatch.setattr(opentelemetry_instrument, "auto_instrumentation", MagicMock())

tests/test_instruments_setupper.py

@@ -44,6 +44,7 @@ def test_instruments_setupper_causes_instruments_lifespan() -> None:
         mock.call.is_ready(),
         mock.call.bootstrap(),
         mock.call.write_status(current_setupper.console_writer),
+        mock.call.is_ready(),
         mock.call.teardown(),
     ]
     assert all_mock_calls == [expected_successful_instrument_calls] * instruments_count