microbootstrap 1.4.2__tar.gz → 1.5.0__tar.gz

{microbootstrap-1.4.2 → microbootstrap-1.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: microbootstrap
-Version: 1.4.2
+Version: 1.5.0
 Summary: Package for bootstrapping new micro-services
 Keywords: python,microservice,bootstrap,opentelemetry,logging,error-tracing,litestar,fastapi,fastmcp,mcp
 Author: community-of-python
@@ -378,6 +378,8 @@ class YourSettings(BaseServiceSettings):
     sentry_additional_params: dict[str, typing.Any] = {}
     sentry_tags: dict[str, str] | None = None
     sentry_opentelemetry_trace_url_template: str | None = None
+    sentry_opentelemetry_baggage_keys: set[str] = set()
+    sentry_opentelemetry_baggage_url_templates: dict[str, str] = {}
 
     ... # Other settings here
 ```
@@ -397,6 +399,8 @@ Parameter descriptions:
 - `sentry_additional_params` - Additional parameters to pass to Sentry SDK.
 - `sentry_tags` - Tags to apply to all Sentry events.
 - `sentry_opentelemetry_trace_url_template` - Template for OpenTelemetry trace URLs to add to Sentry events (example: `"https://example.com/traces/{trace_id}"`).
+- `sentry_opentelemetry_baggage_keys` - Baggage keys to copy into searchable Sentry tags.
+- `sentry_opentelemetry_baggage_url_templates` - Maps baggage keys to URL templates added to Sentry event extra data as `<key>_url`. The placeholder must match the baggage key and its value is URL-encoded (example: `{"conversation_id": "https://example.com/logs/{conversation_id}"}`).
 
 ### [Prometheus](https://prometheus.io/)
 
@@ -502,6 +506,7 @@ class YourSettings(BaseServiceSettings):
     opentelemetry_insecure: bool = True
     opentelemetry_instrumentors: list[OpenTelemetryInstrumentor] = []
     opentelemetry_exclude_urls: list[str] = []
+    opentelemetry_baggage_span_attributes: dict[str, str] = {}
 
     ... # Other settings here
 ```
@@ -519,6 +524,7 @@ Parameters description:
 - `opentelemetry_exclude_urls` - list of ignored urls.
 - `opentelemetry_log_traces` - traces will be logged to stdout.
 - `opentelemetry_generate_health_check_spans` - generate spans for health check handlers if `True`
+- `opentelemetry_baggage_span_attributes` - maps allowed baggage keys to attributes added to local server and consumer spans.
 
 These settings are subsequently passed to [opentelemetry](https://opentelemetry.io/), finalizing your Opentelemetry integration.
 

{microbootstrap-1.4.2 → microbootstrap-1.5.0}/README.md

@@ -313,6 +313,8 @@ class YourSettings(BaseServiceSettings):
     sentry_additional_params: dict[str, typing.Any] = {}
     sentry_tags: dict[str, str] | None = None
     sentry_opentelemetry_trace_url_template: str | None = None
+    sentry_opentelemetry_baggage_keys: set[str] = set()
+    sentry_opentelemetry_baggage_url_templates: dict[str, str] = {}
 
     ... # Other settings here
 ```
@@ -332,6 +334,8 @@ Parameter descriptions:
 - `sentry_additional_params` - Additional parameters to pass to Sentry SDK.
 - `sentry_tags` - Tags to apply to all Sentry events.
 - `sentry_opentelemetry_trace_url_template` - Template for OpenTelemetry trace URLs to add to Sentry events (example: `"https://example.com/traces/{trace_id}"`).
+- `sentry_opentelemetry_baggage_keys` - Baggage keys to copy into searchable Sentry tags.
+- `sentry_opentelemetry_baggage_url_templates` - Maps baggage keys to URL templates added to Sentry event extra data as `<key>_url`. The placeholder must match the baggage key and its value is URL-encoded (example: `{"conversation_id": "https://example.com/logs/{conversation_id}"}`).
 
 ### [Prometheus](https://prometheus.io/)
 
@@ -437,6 +441,7 @@ class YourSettings(BaseServiceSettings):
     opentelemetry_insecure: bool = True
     opentelemetry_instrumentors: list[OpenTelemetryInstrumentor] = []
     opentelemetry_exclude_urls: list[str] = []
+    opentelemetry_baggage_span_attributes: dict[str, str] = {}
 
     ... # Other settings here
 ```
@@ -454,6 +459,7 @@ Parameters description:
 - `opentelemetry_exclude_urls` - list of ignored urls.
 - `opentelemetry_log_traces` - traces will be logged to stdout.
 - `opentelemetry_generate_health_check_spans` - generate spans for health check handlers if `True`
+- `opentelemetry_baggage_span_attributes` - maps allowed baggage keys to attributes added to local server and consumer spans.
 
 These settings are subsequently passed to [opentelemetry](https://opentelemetry.io/), finalizing your Opentelemetry integration.
 

{microbootstrap-1.4.2 → microbootstrap-1.5.0}/microbootstrap/granian_server.py

@@ -27,13 +27,15 @@ GRANIAN_LOG_LEVELS_MAP = {
 def create_granian_server(
     target: str,
     settings: ServerConfig,
+    *,
+    interface: Interfaces = Interfaces.ASGI,
     **granian_options: typing.Any,  # noqa: ANN401
 ) -> GranianServer[typing.Any]:
     return granian.Granian(
         target=target,
         address=settings.server_host,
         port=settings.server_port,
-        interface=Interfaces.ASGI,
+        interface=interface,
         workers=settings.server_workers_count,
         log_level=GRANIAN_LOG_LEVELS_MAP[getattr(settings, "logging_log_level", logging.INFO)],
         reload=settings.server_reload,

{microbootstrap-1.4.2 → microbootstrap-1.5.0}/microbootstrap/instruments/opentelemetry_instrument.py

@@ -6,6 +6,7 @@ import typing
 
 import pydantic
 import structlog
+from opentelemetry import baggage
 from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExporter
 from opentelemetry.instrumentation.dependencies import DependencyConflictError
 from opentelemetry.instrumentation.environment_variables import OTEL_PYTHON_DISABLED_INSTRUMENTATIONS
@@ -15,7 +16,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 format_span_id, set_tracer_provider
+from opentelemetry.trace import SpanKind, format_span_id, set_tracer_provider
 from opentelemetry.util._importlib_metadata import entry_points
 
 from microbootstrap.instruments.base import BaseInstrumentConfig, Instrument
@@ -66,6 +67,7 @@ class OpentelemetryConfig(BaseInstrumentConfig):
     )
     opentelemetry_log_traces: bool = False
     opentelemetry_generate_health_check_spans: bool = True
+    opentelemetry_baggage_span_attributes: dict[str, str] = pydantic.Field(default_factory=dict)
 
 
 @typing.runtime_checkable
@@ -95,6 +97,22 @@ def _format_span(readable_span: ReadableSpan) -> str:
     return typing.cast("str", readable_span.to_json(indent=None)) + os.linesep
 
 
+class BaggageSpanProcessor(SpanProcessor):
+    def __init__(self, baggage_span_attributes: dict[str, str]) -> None:
+        self.baggage_span_attributes = baggage_span_attributes
+
+    def on_start(self, span: Span, parent_context: Context | None = None) -> None:
+        if span.kind not in {SpanKind.SERVER, SpanKind.CONSUMER}:
+            return
+
+        for baggage_key, span_attribute in self.baggage_span_attributes.items():
+            if (value := baggage.get_baggage(baggage_key, context=parent_context)) is not None:
+                span.set_attribute(span_attribute, str(value))
+
+    def on_end(self, span: ReadableSpan) -> None:
+        pass
+
+
 class BaseOpentelemetryInstrument(Instrument[OpentelemetryConfigT]):
     instrument_name = "Opentelemetry"
     ready_condition = "Provide all necessary config parameters"
@@ -145,6 +163,10 @@ class BaseOpentelemetryInstrument(Instrument[OpentelemetryConfigT]):
         resource: typing.Final = resources.Resource.create(attributes=attributes)
 
         self.tracer_provider = SdkTracerProvider(resource=resource)
+        if self.instrument_config.opentelemetry_baggage_span_attributes:
+            self.tracer_provider.add_span_processor(
+                BaggageSpanProcessor(self.instrument_config.opentelemetry_baggage_span_attributes),
+            )
         if self.instrument_config.pyroscope_endpoint and pyroscope:
             self.tracer_provider.add_span_processor(PyroscopeSpanProcessor())
 

{microbootstrap-1.4.2 → microbootstrap-1.5.0}/microbootstrap/instruments/sentry_instrument.py

@@ -2,10 +2,12 @@ from __future__ import annotations
 import contextlib
 import functools
 import typing
+import urllib.parse
 
 import orjson
 import pydantic
 import sentry_sdk
+from opentelemetry import baggage
 from sentry_sdk import _types as sentry_types
 from sentry_sdk.integrations import Integration  # noqa: TC002
 
@@ -26,6 +28,8 @@ class SentryConfig(BaseInstrumentConfig):
     sentry_tags: dict[str, str] | None = None
     sentry_before_send: typing.Callable[[typing.Any, typing.Any], typing.Any | None] | None = None
     sentry_opentelemetry_trace_url_template: str | None = None
+    sentry_opentelemetry_baggage_keys: set[str] = pydantic.Field(default_factory=set)
+    sentry_opentelemetry_baggage_url_templates: dict[str, str] = pydantic.Field(default_factory=dict)
 
 
 IGNORED_STRUCTLOG_ATTRIBUTES: typing.Final = frozenset({"event", "level", "logger", "tracing", "timestamp"})
@@ -72,6 +76,34 @@ def add_trace_url_to_event(
     return event
 
 
+def enrich_sentry_event_from_opentelemetry_baggage(
+    baggage_keys: set[str],
+    baggage_url_templates: dict[str, str],
+    event: sentry_types.Event,
+    _hint: sentry_types.Hint,
+) -> sentry_types.Event:
+    baggage_values = {
+        key: value
+        for key in baggage_keys.union(baggage_url_templates)
+        if (value := baggage.get_baggage(key)) is not None
+    }
+    if not baggage_values:
+        return event
+
+    if tag_values := {key: str(baggage_values[key]) for key in baggage_keys if key in baggage_values}:
+        event.setdefault("tags", {}).update(tag_values)
+
+    for key, url_template in baggage_url_templates.items():
+        placeholder = f"{{{key}}}"
+        if key not in baggage_values or placeholder not in url_template:
+            continue
+        event.setdefault("extra", {})[f"{key}_url"] = url_template.replace(
+            placeholder,
+            urllib.parse.quote(str(baggage_values[key]), safe=""),
+        )
+    return event
+
+
 def wrap_before_send_callbacks(*callbacks: sentry_types.EventProcessor | None) -> sentry_types.EventProcessor:
     def run_before_send(event: sentry_types.Event, hint: sentry_types.Hint) -> sentry_types.Event | None:
         for callback in callbacks:
@@ -109,6 +141,16 @@ class SentryInstrument(Instrument[SentryConfig]):
                 )
                 if self.instrument_config.sentry_opentelemetry_trace_url_template
                 else None,
+                functools.partial(
+                    enrich_sentry_event_from_opentelemetry_baggage,
+                    self.instrument_config.sentry_opentelemetry_baggage_keys,
+                    self.instrument_config.sentry_opentelemetry_baggage_url_templates,
+                )
+                if (
+                    self.instrument_config.sentry_opentelemetry_baggage_keys
+                    or self.instrument_config.sentry_opentelemetry_baggage_url_templates
+                )
+                else None,
                 self.instrument_config.sentry_before_send,
             ),
             integrations=self.instrument_config.sentry_integrations,

microbootstrap-1.5.0/pyproject.toml

@@ -0,0 +1,173 @@
+[project]
+name = "microbootstrap"
+description = "Package for bootstrapping new micro-services"
+readme = "README.md"
+requires-python = ">=3.10,<4"
+keywords = [
+    "python",
+    "microservice",
+    "bootstrap",
+    "opentelemetry",
+    "logging",
+    "error-tracing",
+    "litestar",
+    "fastapi",
+    "fastmcp",
+    "mcp",
+]
+classifiers = [
+    "Typing :: Typed",
+    "Topic :: Software Development :: Build Tools",
+    "Operating System :: MacOS",
+    "Operating System :: Microsoft",
+    "Operating System :: POSIX :: Linux",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+dependencies = [
+    "eval-type-backport>=0.2",
+    "opentelemetry-api>=1.30.0",
+    "opentelemetry-exporter-otlp>=1.15.0",
+    "opentelemetry-exporter-prometheus-remote-write>=0.46b0",
+    "opentelemetry-instrumentation>=0.46b0",
+    "opentelemetry-instrumentation-system-metrics>=0.46b0",
+    "opentelemetry-sdk>=1.30.0",
+    "pydantic-settings>=2",
+    "rich>=13",
+    "sentry-sdk>=2.7",
+    "structlog>=24",
+    "pyroscope-io>=1.0.0; platform_system != 'Windows'",
+    "opentelemetry-distro[otlp]>=0.54b1",
+    "opentelemetry-instrumentation-aio-pika>=0.54b1",
+    "opentelemetry-instrumentation-aiohttp-client>=0.54b1",
+    "opentelemetry-instrumentation-aiokafka>=0.54b1",
+    "opentelemetry-instrumentation-asyncpg>=0.54b1",
+    "opentelemetry-instrumentation-httpx>=0.54b1",
+    "opentelemetry-instrumentation-logging>=0.54b1",
+    "opentelemetry-instrumentation-redis>=0.54b1",
+    "opentelemetry-instrumentation-psycopg>=0.54b1",
+    "opentelemetry-instrumentation-sqlalchemy>=0.54b1",
+    "opentelemetry-instrumentation-asyncio>=0.54b1",
+    "opentelemetry-instrumentation-asgi>=0.46b0",
+    "orjson>=3.10.18",
+]
+version = "1.5.0"
+
+[[project.authors]]
+name = "community-of-python"
+
+[project.optional-dependencies]
+fastapi = [
+    "fastapi>=0.100",
+    "fastapi-offline-docs>=1",
+    "opentelemetry-instrumentation-fastapi>=0.46b0",
+    "prometheus-fastapi-instrumentator>=6.1",
+]
+litestar = [
+    "litestar>=2.9",
+    "litestar-offline-docs>=1",
+    "prometheus-client>=0.20",
+]
+granian = ["granian[reload]>=1"]
+faststream = [
+    "faststream~=0.6.2",
+    "prometheus-client>=0.20",
+]
+fastmcp = [
+    "fastmcp>=2,<4",
+    "prometheus-client>=0.20",
+]
+
+[dependency-groups]
+dev = [
+    "anyio>=4.8.0",
+    "httpx>=0.28.1",
+    "mypy>=1.14.1",
+    "pre-commit>=4.0.1",
+    "pytest>=8.3.4",
+    "pytest-cov>=6.0.0",
+    "pytest-mock>=3.14.0",
+    "pytest-xdist>=3.6.1",
+    "redis>=5.2.1",
+    "ruff>=0.9.1",
+    "trio>=0.28.0",
+    "typing-extensions>=4.12.2",
+]
+
+[build-system]
+requires = ["uv_build"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "microbootstrap"
+module-root = ""
+
+[tool.mypy]
+plugins = ["pydantic.mypy"]
+files = [
+    "microbootstrap",
+    "tests",
+]
+python_version = "3.10"
+strict = true
+pretty = true
+show_error_codes = true
+
+[tool.ruff]
+target-version = "py310"
+line-length = 120
+
+[tool.ruff.format]
+exclude = ["README.md"]
+docstring-code-format = true
+
+[tool.ruff.lint]
+select = ["ALL"]
+ignore = [
+    "CPY001",
+    "EM",
+    "FBT",
+    "TRY003",
+    "FIX002",
+    "TD003",
+    "D1",
+    "D106",
+    "D203",
+    "D213",
+    "G004",
+    "FA",
+    "COM812",
+    "ISC001",
+    "PLR0917",
+]
+
+[tool.ruff.lint.isort]
+no-lines-before = [
+    "standard-library",
+    "local-folder",
+]
+lines-after-imports = 2
+
+[tool.ruff.lint.extend-per-file-ignores]
+"tests/*.py" = [
+    "S101",
+    "S311",
+]
+"examples/*.py" = ["INP001"]
+
+[tool.coverage.report]
+exclude_also = [
+    "if typing.TYPE_CHECKING:",
+    'class \w+\(typing.Protocol\):',
+]
+omit = ["tests/*"]
+
+[tool.pytest.ini_options]
+addopts = "--cov=. -p no:warnings --cov-report term-missing"

microbootstrap-1.4.2/pyproject.toml → microbootstrap-1.5.0/pyproject.toml.orig

@@ -58,7 +58,7 @@ dependencies = [
     "opentelemetry-instrumentation-asgi>=0.46b0",
     "orjson>=3.10.18",
 ]
-version = "1.4.2"
+version = "1.5.0"
 authors = [{ name = "community-of-python" }]
 
 [project.optional-dependencies]
@@ -114,11 +114,13 @@ target-version = "py310"
 line-length = 120
 
 [tool.ruff.format]
+exclude = ["README.md"]
 docstring-code-format = true
 
 [tool.ruff.lint]
 select = ["ALL"]
 ignore = [
+    "CPY001",
     "EM",
     "FBT",
     "TRY003",
@@ -132,6 +134,7 @@ ignore = [
     "FA",
     "COM812",
     "ISC001",
+    "PLR0917",
 ]
 
 [tool.ruff.lint.isort]