microbootstrap 1.5.3__tar.gz → 1.5.5__tar.gz

{microbootstrap-1.5.3 → microbootstrap-1.5.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: microbootstrap
-Version: 1.5.3
+Version: 1.5.5
 Summary: Package for bootstrapping new micro-services
 Keywords: python,microservice,bootstrap,opentelemetry,logging,error-tracing,litestar,fastapi,fastmcp,mcp
 Author: community-of-python
@@ -528,6 +528,22 @@ Parameters description:
 
 These settings are subsequently passed to [opentelemetry](https://opentelemetry.io/), finalizing your Opentelemetry integration.
 
+If an authoritative baggage value becomes available only after the current span has started, pass the same mapping to
+`opentelemetry_baggage_scope` to also materialize that value on the already-started span:
+
+```python
+from microbootstrap import opentelemetry_baggage_scope
+
+
+with opentelemetry_baggage_scope(
+    {"conversation_id": conversation_id},
+    current_span_attributes=settings.opentelemetry_baggage_span_attributes,
+):
+    ...
+```
+
+Only non-`None` baggage values supplied to the scope and present in the mapping are added to a recording current span.
+
 #### FastStream
 
 For FastStream you also should pass `opentelemetry_middleware_cls` - OpenTelemetry middleware for your broker

{microbootstrap-1.5.3 → microbootstrap-1.5.5}/README.md

@@ -463,6 +463,22 @@ Parameters description:
 
 These settings are subsequently passed to [opentelemetry](https://opentelemetry.io/), finalizing your Opentelemetry integration.
 
+If an authoritative baggage value becomes available only after the current span has started, pass the same mapping to
+`opentelemetry_baggage_scope` to also materialize that value on the already-started span:
+
+```python
+from microbootstrap import opentelemetry_baggage_scope
+
+
+with opentelemetry_baggage_scope(
+    {"conversation_id": conversation_id},
+    current_span_attributes=settings.opentelemetry_baggage_span_attributes,
+):
+    ...
+```
+
+Only non-`None` baggage values supplied to the scope and present in the mapping are added to a recording current span.
+
 #### FastStream
 
 For FastStream you also should pass `opentelemetry_middleware_cls` - OpenTelemetry middleware for your broker

{microbootstrap-1.5.3 → microbootstrap-1.5.5}/microbootstrap/bootstrappers/faststream.py

@@ -24,6 +24,7 @@ from microbootstrap.instruments.opentelemetry_instrument import (
 from microbootstrap.instruments.prometheus_instrument import FastStreamPrometheusConfig, PrometheusInstrument
 from microbootstrap.instruments.pyroscope_instrument import PyroscopeInstrument
 from microbootstrap.instruments.sentry_instrument import SentryInstrument
+from microbootstrap.middlewares.faststream import FastStreamOpenTelemetryBaggageMiddleware
 from microbootstrap.settings import FastStreamSettings
 
 
@@ -101,6 +102,11 @@ class FastStreamOpentelemetryInstrument(BaseOpentelemetryInstrument[FastStreamOp
             application.broker.add_middleware(
                 self.instrument_config.opentelemetry_middleware_cls(tracer_provider=self.tracer_provider),
             )
+            application.broker.add_middleware(
+                FastStreamOpenTelemetryBaggageMiddleware(
+                    baggage_span_attributes=self.instrument_config.opentelemetry_baggage_span_attributes,
+                ),
+            )
         return application
 
     @classmethod

{microbootstrap-1.5.3 → microbootstrap-1.5.5}/microbootstrap/instruments/opentelemetry_instrument.py

@@ -17,7 +17,7 @@ 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 SpanKind, format_span_id, set_tracer_provider
+from opentelemetry.trace import SpanKind, format_span_id, get_current_span, set_tracer_provider
 from opentelemetry.util._importlib_metadata import entry_points
 
 from microbootstrap.instruments.base import BaseInstrumentConfig, Instrument
@@ -44,6 +44,8 @@ OpentelemetryConfigT = typing.TypeVar("OpentelemetryConfigT", bound="Opentelemet
 @contextlib.contextmanager
 def opentelemetry_baggage_scope(
     baggage_values: typing.Mapping[str, object | None],
+    *,
+    current_span_attributes: typing.Mapping[str, str] | None = None,
 ) -> typing.Iterator[None]:
     baggage_context = context.get_current()
     for key, value in baggage_values.items():
@@ -55,6 +57,10 @@ def opentelemetry_baggage_scope(
 
     token: typing.Final = context.attach(baggage_context)
     try:
+        if current_span_attributes and (current_span := get_current_span()).is_recording():
+            for baggage_key, span_attribute in current_span_attributes.items():
+                if baggage_key in baggage_values and (value := baggage_values[baggage_key]) is not None:
+                    current_span.set_attribute(span_attribute, str(value))
         yield
     except Exception as exc:
         with contextlib.suppress(Exception):

microbootstrap-1.5.5/microbootstrap/middlewares/faststream.py

@@ -0,0 +1,66 @@
+from __future__ import annotations
+import typing
+
+from faststream._internal.middlewares import BaseMiddleware
+from opentelemetry import baggage, propagate
+
+from microbootstrap.instruments.opentelemetry_instrument import opentelemetry_baggage_scope
+
+
+if typing.TYPE_CHECKING:
+    from faststream._internal.basic_types import AsyncFuncAny
+    from faststream._internal.context import ContextRepo
+    from faststream.message import StreamMessage
+
+
+class FastStreamOpenTelemetryBaggageMiddleware:
+    def __init__(self, *, baggage_span_attributes: typing.Mapping[str, str]) -> None:
+        self.baggage_span_attributes = baggage_span_attributes
+
+    def __call__(
+        self,
+        msg: typing.Any,  # noqa: ANN401
+        /,
+        *,
+        context: ContextRepo,
+    ) -> _FastStreamOpenTelemetryBaggageMiddleware:
+        return _FastStreamOpenTelemetryBaggageMiddleware(
+            msg,
+            context=context,
+            baggage_span_attributes=self.baggage_span_attributes,
+        )
+
+
+class _FastStreamOpenTelemetryBaggageMiddleware(BaseMiddleware[typing.Any, typing.Any]):
+    def __init__(
+        self,
+        msg: typing.Any,  # noqa: ANN401
+        /,
+        *,
+        context: ContextRepo,
+        baggage_span_attributes: typing.Mapping[str, str],
+    ) -> None:
+        super().__init__(msg, context=context)
+        self.baggage_span_attributes = baggage_span_attributes
+
+    async def consume_scope(
+        self,
+        call_next: AsyncFuncAny,
+        msg: StreamMessage[typing.Any],
+    ) -> typing.Any:  # noqa: ANN401
+        extracted_baggage: typing.Final = baggage.get_all(propagate.extract(msg.headers))
+        with opentelemetry_baggage_scope(
+            extracted_baggage,
+            current_span_attributes=self.baggage_span_attributes,
+        ):
+            return await call_next(msg)
+
+    async def publish_scope(
+        self,
+        call_next: typing.Callable[[typing.Any], typing.Awaitable[typing.Any]],
+        cmd: typing.Any,  # noqa: ANN401
+    ) -> typing.Any:  # noqa: ANN401
+        for field in propagate.get_global_textmap().fields:
+            cmd.headers.pop(field, None)
+        propagate.inject(cmd.headers)
+        return await call_next(cmd)

{microbootstrap-1.5.3 → microbootstrap-1.5.5}/pyproject.toml

@@ -58,7 +58,7 @@ dependencies = [
     "opentelemetry-instrumentation-asgi>=0.46b0",
     "orjson>=3.10.18",
 ]
-version = "1.5.3"
+version = "1.5.5"
 
 [[project.authors]]
 name = "community-of-python"

{microbootstrap-1.5.3 → microbootstrap-1.5.5}/pyproject.toml.orig

@@ -58,7 +58,7 @@ dependencies = [
     "opentelemetry-instrumentation-asgi>=0.46b0",
     "orjson>=3.10.18",
 ]
-version = "1.5.3"
+version = "1.5.5"
 authors = [{ name = "community-of-python" }]
 
 [project.optional-dependencies]