hexkit 8.5.0__tar.gz → 8.6.0__tar.gz

{hexkit-8.5.0/src/hexkit.egg-info → hexkit-8.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hexkit
-Version: 8.5.0
+Version: 8.6.0
 Summary: A Toolkit for Building Microservices using the Hexagonal Architecture
 Author-email: "German Human Genome Phenome Archive (GHGA)" <contact@ghga.de>
 License: Apache 2.0
@@ -21,7 +21,7 @@ Classifier: Intended Audience :: Developers
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: opentelemetry-api<2,>=1.39
+Requires-Dist: opentelemetry-api<2,>=1.44
 Requires-Dist: pydantic<3,>=2.12
 Requires-Dist: pydantic_settings<3,>=2.12
 Requires-Dist: PyYAML<7,>=6
@@ -38,30 +38,30 @@ Requires-Dist: redis<8,>=7.1; extra == "redis"
 Provides-Extra: vault
 Requires-Dist: hvac<3,>=2.4; extra == "vault"
 Provides-Extra: opentelemetry-base
-Requires-Dist: opentelemetry-sdk<2,>=1.39.1; extra == "opentelemetry-base"
-Requires-Dist: opentelemetry-exporter-otlp<2,>=1.39.1; extra == "opentelemetry-base"
-Requires-Dist: opentelemetry-instrumentation>=0.60b1; extra == "opentelemetry-base"
-Requires-Dist: opentelemetry-instrumentation-httpx>=0.60b1; extra == "opentelemetry-base"
-Requires-Dist: opentelemetry-distro>=0.60b1; extra == "opentelemetry-base"
+Requires-Dist: opentelemetry-sdk<2,>=1.44; extra == "opentelemetry-base"
+Requires-Dist: opentelemetry-exporter-otlp<2,>=1.44; extra == "opentelemetry-base"
+Requires-Dist: opentelemetry-instrumentation>=0.65b0; extra == "opentelemetry-base"
+Requires-Dist: opentelemetry-instrumentation-httpx>=0.65b0; extra == "opentelemetry-base"
+Requires-Dist: opentelemetry-distro>=0.65b0; extra == "opentelemetry-base"
 Provides-Extra: opentelemetry-akafka
 Requires-Dist: hexkit[opentelemetry-base]; extra == "opentelemetry-akafka"
 Requires-Dist: hexkit[akafka]; extra == "opentelemetry-akafka"
-Requires-Dist: opentelemetry-instrumentation-aiokafka>=0.60b1; extra == "opentelemetry-akafka"
+Requires-Dist: opentelemetry-instrumentation-aiokafka>=0.65b0; extra == "opentelemetry-akafka"
 Provides-Extra: opentelemetry-mongodb
 Requires-Dist: hexkit[opentelemetry-base]; extra == "opentelemetry-mongodb"
 Requires-Dist: hexkit[mongodb]; extra == "opentelemetry-mongodb"
-Requires-Dist: opentelemetry-instrumentation-pymongo>=0.60b1; extra == "opentelemetry-mongodb"
+Requires-Dist: opentelemetry-instrumentation-pymongo>=0.65b0; extra == "opentelemetry-mongodb"
 Provides-Extra: opentelemetry-fastapi
 Requires-Dist: hexkit[opentelemetry-base]; extra == "opentelemetry-fastapi"
-Requires-Dist: opentelemetry-instrumentation-fastapi>=0.60b1; extra == "opentelemetry-fastapi"
+Requires-Dist: opentelemetry-instrumentation-fastapi>=0.65b0; extra == "opentelemetry-fastapi"
 Provides-Extra: opentelemetry-s3
 Requires-Dist: hexkit[opentelemetry-base]; extra == "opentelemetry-s3"
 Requires-Dist: hexkit[s3]; extra == "opentelemetry-s3"
-Requires-Dist: opentelemetry-instrumentation-botocore>=0.60b1; extra == "opentelemetry-s3"
+Requires-Dist: opentelemetry-instrumentation-botocore>=0.65b0; extra == "opentelemetry-s3"
 Provides-Extra: opentelemetry-redis
 Requires-Dist: hexkit[opentelemetry-base]; extra == "opentelemetry-redis"
 Requires-Dist: hexkit[redis]; extra == "opentelemetry-redis"
-Requires-Dist: opentelemetry-instrumentation-redis>=0.60b1; extra == "opentelemetry-redis"
+Requires-Dist: opentelemetry-instrumentation-redis>=0.65b0; extra == "opentelemetry-redis"
 Provides-Extra: opentelemetry
 Requires-Dist: hexkit[opentelemetry-akafka]; extra == "opentelemetry"
 Requires-Dist: hexkit[opentelemetry-mongodb]; extra == "opentelemetry"

{hexkit-8.5.0 → hexkit-8.6.0}/pyproject.toml

@@ -23,10 +23,10 @@ classifiers = [
     "Intended Audience :: Developers",
 ]
 name = "hexkit"
-version = "8.5.0"
+version = "8.6.0"
 description = "A Toolkit for Building Microservices using the Hexagonal Architecture"
 dependencies = [
-    "opentelemetry-api >=1.39, <2",
+    "opentelemetry-api >=1.44, <2",
     "pydantic >=2.12, <3",
     "pydantic_settings >=2.12, <3",
     "PyYAML >=6, <7",
@@ -54,35 +54,35 @@ vault = [
     "hvac >=2.4, <3",
 ]
 opentelemetry-base = [
-    "opentelemetry-sdk >=1.39.1, <2",
-    "opentelemetry-exporter-otlp >=1.39.1, <2",
-    "opentelemetry-instrumentation >=0.60b1",
-    "opentelemetry-instrumentation-httpx >=0.60b1",
-    "opentelemetry-distro >=0.60b1",
+    "opentelemetry-sdk >=1.44, <2",
+    "opentelemetry-exporter-otlp >=1.44, <2",
+    "opentelemetry-instrumentation >=0.65b0",
+    "opentelemetry-instrumentation-httpx >=0.65b0",
+    "opentelemetry-distro >=0.65b0",
 ]
 opentelemetry-akafka = [
     "hexkit[opentelemetry-base]",
     "hexkit[akafka]",
-    "opentelemetry-instrumentation-aiokafka >=0.60b1",
+    "opentelemetry-instrumentation-aiokafka >=0.65b0",
 ]
 opentelemetry-mongodb = [
     "hexkit[opentelemetry-base]",
     "hexkit[mongodb]",
-    "opentelemetry-instrumentation-pymongo >=0.60b1",
+    "opentelemetry-instrumentation-pymongo >=0.65b0",
 ]
 opentelemetry-fastapi = [
     "hexkit[opentelemetry-base]",
-    "opentelemetry-instrumentation-fastapi >=0.60b1",
+    "opentelemetry-instrumentation-fastapi >=0.65b0",
 ]
 opentelemetry-s3 = [
     "hexkit[opentelemetry-base]",
     "hexkit[s3]",
-    "opentelemetry-instrumentation-botocore >=0.60b1",
+    "opentelemetry-instrumentation-botocore >=0.65b0",
 ]
 opentelemetry-redis = [
     "hexkit[opentelemetry-base]",
     "hexkit[redis]",
-    "opentelemetry-instrumentation-redis >=0.60b1",
+    "opentelemetry-instrumentation-redis >=0.65b0",
 ]
 opentelemetry = [
     "hexkit[opentelemetry-akafka]",

hexkit-8.6.0/src/hexkit/opentelemetry/__init__.py

@@ -0,0 +1,29 @@
+# Copyright 2021 - 2026 Universität Tübingen, DKFZ, EMBL, and Universität zu Köln
+# for the German Human Genome-Phenome Archive (GHGA)
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+"""Subpackage containing OpenTelemetry instrumentation and related utilities."""
+
+from .instrumentation import (
+    OpenTelemetryConfig,
+    configure_opentelemetry,
+    instrument_installed_libraries,
+)
+
+__all__ = [
+    "OpenTelemetryConfig",
+    "configure_opentelemetry",
+    "instrument_installed_libraries",
+]

hexkit-8.6.0/src/hexkit/opentelemetry/instrumentation.py

@@ -0,0 +1,122 @@
+# Copyright 2021 - 2026 Universität Tübingen, DKFZ, EMBL, and Universität zu Köln
+# for the German Human Genome-Phenome Archive (GHGA)
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""OpenTelemetry specific configuration code. This is gated behind the opentelemetry extra."""
+
+import importlib
+import logging
+from typing import Annotated
+
+from opentelemetry import trace
+from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
+from opentelemetry.sdk.resources import SERVICE_NAME, Resource
+from opentelemetry.sdk.trace import SpanProcessor, TracerProvider
+from opentelemetry.sdk.trace.export import BatchSpanProcessor
+from opentelemetry.sdk.trace.sampling import ParentBasedTraceIdRatio
+from pydantic import Field
+from pydantic_settings import BaseSettings
+
+__all__ = [
+    "OpenTelemetryConfig",
+    "configure_opentelemetry",
+    "instrument_installed_libraries",
+]
+
+logger = logging.getLogger(__name__)
+
+# Instrumentation modules corresponding to the `opentelemetry-*` optional extras.
+# Each entry is only instrumented if its module is installed.
+_INSTRUMENTOR_MODULES: tuple[tuple[str, str], ...] = (
+    ("opentelemetry.instrumentation.httpx", "HTTPXClientInstrumentor"),
+    ("opentelemetry.instrumentation.aiokafka", "AIOKafkaInstrumentor"),
+    ("opentelemetry.instrumentation.pymongo", "PymongoInstrumentor"),
+    ("opentelemetry.instrumentation.fastapi", "FastAPIInstrumentor"),
+    ("opentelemetry.instrumentation.botocore", "BotocoreInstrumentor"),
+    ("opentelemetry.instrumentation.redis", "RedisInstrumentor"),
+)
+
+
+def instrument_installed_libraries() -> None:
+    """Run `.instrument()` for every instrumentation library that is installed."""
+    for module_name, class_name in _INSTRUMENTOR_MODULES:
+        try:
+            module = importlib.import_module(module_name)
+        except ImportError:
+            logger.debug("'%s' not installed, skipping instrumentation.", module_name)
+            continue
+        try:
+            instrumentor_class = getattr(module, class_name)
+        except AttributeError:
+            logger.warning(
+                "Could not instrument '%s' for '%s'.", class_name, module_name
+            )
+        instrumentor_class().instrument()
+        logger.info("Instrumented '%s' for '%s'.", class_name, module_name)
+
+
+class OpenTelemetryConfig(BaseSettings):
+    """OpenTelemetry specific configuration options"""
+
+    enable_opentelemetry: bool = Field(
+        default=False,
+        description="If set to true, this will run necessary setup code."
+        "If set to false, no setup code is run, which leaves tracing disabled.",
+    )
+    otel_trace_sampling_rate: Annotated[float, Field(strict=True, ge=0, le=1)] = Field(
+        default=1.0,
+        description="Determines which proportion of spans should be sampled. "
+        "A value of 1.0 means all and is equivalent to the previous behaviour. "
+        "Setting this to 0 will result in no spans being sampled, but this does not "
+        "automatically set `enable_opentelemetry` to False.",
+    )
+
+
+def configure_opentelemetry(
+    *,
+    service_name: str,
+    config: OpenTelemetryConfig,
+    span_processor: SpanProcessor | None = None,
+):
+    """Configure all needed parts of OpenTelemetry.
+
+    This needs to be called before constructing any objects that are instrumented, e.g.
+    construction a FastAPI app before running this, will result in missing instrumentation.
+
+    Setup of the TracerProvider is done programmatically. If disabled, this is a no-op,
+    leaving the default no-op TracerProvider from the OpenTelemetry API in place.
+
+    By default, spans are exported via OTLP over HTTP using a `BatchSpanProcessor`.
+    """
+    if not config.enable_opentelemetry:
+        logger.info("OpenTelemetry disabled via config.")
+        return
+
+    resource = Resource(attributes={SERVICE_NAME: service_name})
+    # Replace the default static sampler with a probabilistic one that honors parent
+    # span sampling decisions
+    # This should consistently yield full traces within a service but not necessarily
+    # across service boundaries
+    # With the default sampling rate, behaviour does not change, but this allows to
+    # introduce head sampling by adjusting a config option on the service side later on
+    sampler = ParentBasedTraceIdRatio(rate=config.otel_trace_sampling_rate)
+
+    # Initialize service specific TracerProvider
+    trace_provider = TracerProvider(resource=resource, sampler=sampler)
+    trace_provider.add_span_processor(
+        span_processor or BatchSpanProcessor(OTLPSpanExporter())
+    )
+    trace.set_tracer_provider(trace_provider)
+
+    instrument_installed_libraries()

hexkit-8.6.0/src/hexkit/opentelemetry/testutils.py

@@ -0,0 +1,141 @@
+# Copyright 2021 - 2026 Universität Tübingen, DKFZ, EMBL, and Universität zu Köln
+# for the German Human Genome-Phenome Archive (GHGA)
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+"""Utilities for testing code that relies on OpenTelemetry instrumentation.
+
+Please note, only use for testing purposes.
+"""
+
+from collections.abc import Generator
+from dataclasses import dataclass
+
+import pytest
+from opentelemetry import trace
+from opentelemetry.sdk.trace import ReadableSpan, TracerProvider
+from opentelemetry.sdk.trace.export import SimpleSpanProcessor
+from opentelemetry.sdk.trace.export.in_memory_span_exporter import (
+    InMemorySpanExporter,
+)
+
+from hexkit.custom_types import PytestScope
+from hexkit.opentelemetry import OpenTelemetryConfig, configure_opentelemetry
+
+__all__ = [
+    "OpenTelemetryFixture",
+    "get_otel_fixture",
+    "get_otel_provider_fixture",
+    "otel_fixture",
+    "otel_provider_fixture",
+]
+
+
+@dataclass(frozen=True)
+class OpenTelemetryFixture:
+    """A fixture with utility methods for tests that verify emitted spans."""
+
+    exporter: InMemorySpanExporter
+
+    def reset(self) -> None:
+        """Clear all previously captured spans."""
+        self.exporter.clear()
+
+    def get_finished_spans(self) -> tuple[ReadableSpan, ...]:
+        """Return all spans finished so far, in the order they completed."""
+        return tuple(self.exporter.get_finished_spans())
+
+    def get_span_names(self) -> list[str]:
+        """Return the names of all finished spans, in the order they completed."""
+        return [span.name for span in self.get_finished_spans()]
+
+    def assert_has_span(self, name: str) -> ReadableSpan:
+        """Assert that a finished span with the given name exists and return it."""
+        for span in self.get_finished_spans():
+            if span.name == name:
+                return span
+        raise AssertionError(
+            f"No span named {name!r} found. Captured spans: {self.get_span_names()}"
+        )
+
+
+def _otel_provider_fixture(
+    service_name: str = "test",
+) -> Generator[OpenTelemetryFixture, None, None]:
+    """Fixture function attaching an in-memory span exporter for the test session.
+
+    If OpenTelemetry has already been configured (e.g. because the app under test
+    calls `configure_opentelemetry()` on startup), this attaches to the resulting
+    TracerProvider so the exact same setup (sampler, resource, instrumented
+    libraries) is exercised. Otherwise, it configures one itself via
+    `configure_opentelemetry()` so the fixture also works standalone.
+
+    A `SimpleSpanProcessor` is used instead of the `BatchSpanProcessor` used for real
+    exports, so spans show up as soon as they end instead of on a batching interval.
+    """
+    provider = trace.get_tracer_provider()
+    exporter = InMemorySpanExporter()
+
+    if not isinstance(provider, TracerProvider):
+        # No app under test has configured OpenTelemetry yet, so do it here, wiring
+        # up the in-memory exporter directly instead of the default OTLP exporter -
+        # this avoids pointless connection attempts against a collector in tests.
+        configure_opentelemetry(
+            service_name=service_name,
+            config=OpenTelemetryConfig(enable_opentelemetry=True),
+            span_processor=SimpleSpanProcessor(exporter),
+        )
+    else:
+        # OpenTelemetry has already been configured (e.g. by the app under test),
+        # so attach to its existing TracerProvider instead of replacing it -
+        # OpenTelemetry only allows the global TracerProvider to be set once.
+        # Detaching after the test is not possible, as there's no stable public API for that
+        provider.add_span_processor(SimpleSpanProcessor(exporter))
+
+    yield OpenTelemetryFixture(exporter=exporter)
+
+
+def get_otel_provider_fixture(
+    scope: PytestScope = "session", name: str = "otel_provider"
+):
+    """Get a fixture with desired scope and name that sets up span capturing.
+
+    By default, the session scope is used since only one `TracerProvider` can be
+    configured per process.
+    """
+    return pytest.fixture(_otel_provider_fixture, scope=scope, name=name)
+
+
+otel_provider_fixture = get_otel_provider_fixture()
+
+
+def _otel_fixture(
+    otel_provider: OpenTelemetryFixture,
+) -> Generator[OpenTelemetryFixture, None, None]:
+    """Fixture function that gets a clean slate of captured spans for a single test."""
+    otel_provider.reset()
+    yield otel_provider
+    otel_provider.reset()
+
+
+def get_otel_fixture(scope: PytestScope = "function", name: str = "otel"):
+    """Get a fixture with desired scope and name for asserting on emitted spans.
+
+    By default, the function scope is used so captured spans don't leak between
+    tests, while the session scope is used for the underlying span capturing setup.
+    """
+    return pytest.fixture(_otel_fixture, scope=scope, name=name)
+
+
+otel_fixture = get_otel_fixture()

{hexkit-8.5.0 → hexkit-8.6.0/src/hexkit.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hexkit
-Version: 8.5.0
+Version: 8.6.0
 Summary: A Toolkit for Building Microservices using the Hexagonal Architecture
 Author-email: "German Human Genome Phenome Archive (GHGA)" <contact@ghga.de>
 License: Apache 2.0
@@ -21,7 +21,7 @@ Classifier: Intended Audience :: Developers
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: opentelemetry-api<2,>=1.39
+Requires-Dist: opentelemetry-api<2,>=1.44
 Requires-Dist: pydantic<3,>=2.12
 Requires-Dist: pydantic_settings<3,>=2.12
 Requires-Dist: PyYAML<7,>=6
@@ -38,30 +38,30 @@ Requires-Dist: redis<8,>=7.1; extra == "redis"
 Provides-Extra: vault
 Requires-Dist: hvac<3,>=2.4; extra == "vault"
 Provides-Extra: opentelemetry-base
-Requires-Dist: opentelemetry-sdk<2,>=1.39.1; extra == "opentelemetry-base"
-Requires-Dist: opentelemetry-exporter-otlp<2,>=1.39.1; extra == "opentelemetry-base"
-Requires-Dist: opentelemetry-instrumentation>=0.60b1; extra == "opentelemetry-base"
-Requires-Dist: opentelemetry-instrumentation-httpx>=0.60b1; extra == "opentelemetry-base"
-Requires-Dist: opentelemetry-distro>=0.60b1; extra == "opentelemetry-base"
+Requires-Dist: opentelemetry-sdk<2,>=1.44; extra == "opentelemetry-base"
+Requires-Dist: opentelemetry-exporter-otlp<2,>=1.44; extra == "opentelemetry-base"
+Requires-Dist: opentelemetry-instrumentation>=0.65b0; extra == "opentelemetry-base"
+Requires-Dist: opentelemetry-instrumentation-httpx>=0.65b0; extra == "opentelemetry-base"
+Requires-Dist: opentelemetry-distro>=0.65b0; extra == "opentelemetry-base"
 Provides-Extra: opentelemetry-akafka
 Requires-Dist: hexkit[opentelemetry-base]; extra == "opentelemetry-akafka"
 Requires-Dist: hexkit[akafka]; extra == "opentelemetry-akafka"
-Requires-Dist: opentelemetry-instrumentation-aiokafka>=0.60b1; extra == "opentelemetry-akafka"
+Requires-Dist: opentelemetry-instrumentation-aiokafka>=0.65b0; extra == "opentelemetry-akafka"
 Provides-Extra: opentelemetry-mongodb
 Requires-Dist: hexkit[opentelemetry-base]; extra == "opentelemetry-mongodb"
 Requires-Dist: hexkit[mongodb]; extra == "opentelemetry-mongodb"
-Requires-Dist: opentelemetry-instrumentation-pymongo>=0.60b1; extra == "opentelemetry-mongodb"
+Requires-Dist: opentelemetry-instrumentation-pymongo>=0.65b0; extra == "opentelemetry-mongodb"
 Provides-Extra: opentelemetry-fastapi
 Requires-Dist: hexkit[opentelemetry-base]; extra == "opentelemetry-fastapi"
-Requires-Dist: opentelemetry-instrumentation-fastapi>=0.60b1; extra == "opentelemetry-fastapi"
+Requires-Dist: opentelemetry-instrumentation-fastapi>=0.65b0; extra == "opentelemetry-fastapi"
 Provides-Extra: opentelemetry-s3
 Requires-Dist: hexkit[opentelemetry-base]; extra == "opentelemetry-s3"
 Requires-Dist: hexkit[s3]; extra == "opentelemetry-s3"
-Requires-Dist: opentelemetry-instrumentation-botocore>=0.60b1; extra == "opentelemetry-s3"
+Requires-Dist: opentelemetry-instrumentation-botocore>=0.65b0; extra == "opentelemetry-s3"
 Provides-Extra: opentelemetry-redis
 Requires-Dist: hexkit[opentelemetry-base]; extra == "opentelemetry-redis"
 Requires-Dist: hexkit[redis]; extra == "opentelemetry-redis"
-Requires-Dist: opentelemetry-instrumentation-redis>=0.60b1; extra == "opentelemetry-redis"
+Requires-Dist: opentelemetry-instrumentation-redis>=0.65b0; extra == "opentelemetry-redis"
 Provides-Extra: opentelemetry
 Requires-Dist: hexkit[opentelemetry-akafka]; extra == "opentelemetry"
 Requires-Dist: hexkit[opentelemetry-mongodb]; extra == "opentelemetry"

{hexkit-8.5.0 → hexkit-8.6.0}/src/hexkit.egg-info/SOURCES.txt

@@ -9,7 +9,6 @@ src/hexkit/config.py
 src/hexkit/correlation.py
 src/hexkit/custom_types.py
 src/hexkit/log.py
-src/hexkit/opentelemetry.py
 src/hexkit/py.typed
 src/hexkit/utils.py
 src/hexkit.egg-info/PKG-INFO
@@ -17,6 +16,9 @@ src/hexkit.egg-info/SOURCES.txt
 src/hexkit.egg-info/dependency_links.txt
 src/hexkit.egg-info/requires.txt
 src/hexkit.egg-info/top_level.txt
+src/hexkit/opentelemetry/__init__.py
+src/hexkit/opentelemetry/instrumentation.py
+src/hexkit/opentelemetry/testutils.py
 src/hexkit/protocols/__init__.py
 src/hexkit/protocols/dao.py
 src/hexkit/protocols/daopub.py

{hexkit-8.5.0 → hexkit-8.6.0}/src/hexkit.egg-info/requires.txt

@@ -1,4 +1,4 @@
-opentelemetry-api<2,>=1.39
+opentelemetry-api<2,>=1.44
 pydantic<3,>=2.12
 pydantic_settings<3,>=2.12
 PyYAML<7,>=6
@@ -23,33 +23,33 @@ hexkit[opentelemetry-s3]
 [opentelemetry-akafka]
 hexkit[opentelemetry-base]
 hexkit[akafka]
-opentelemetry-instrumentation-aiokafka>=0.60b1
+opentelemetry-instrumentation-aiokafka>=0.65b0
 
 [opentelemetry-base]
-opentelemetry-sdk<2,>=1.39.1
-opentelemetry-exporter-otlp<2,>=1.39.1
-opentelemetry-instrumentation>=0.60b1
-opentelemetry-instrumentation-httpx>=0.60b1
-opentelemetry-distro>=0.60b1
+opentelemetry-sdk<2,>=1.44
+opentelemetry-exporter-otlp<2,>=1.44
+opentelemetry-instrumentation>=0.65b0
+opentelemetry-instrumentation-httpx>=0.65b0
+opentelemetry-distro>=0.65b0
 
 [opentelemetry-fastapi]
 hexkit[opentelemetry-base]
-opentelemetry-instrumentation-fastapi>=0.60b1
+opentelemetry-instrumentation-fastapi>=0.65b0
 
 [opentelemetry-mongodb]
 hexkit[opentelemetry-base]
 hexkit[mongodb]
-opentelemetry-instrumentation-pymongo>=0.60b1
+opentelemetry-instrumentation-pymongo>=0.65b0
 
 [opentelemetry-redis]
 hexkit[opentelemetry-base]
 hexkit[redis]
-opentelemetry-instrumentation-redis>=0.60b1
+opentelemetry-instrumentation-redis>=0.65b0
 
 [opentelemetry-s3]
 hexkit[opentelemetry-base]
 hexkit[s3]
-opentelemetry-instrumentation-botocore>=0.60b1
+opentelemetry-instrumentation-botocore>=0.65b0
 
 [redis]
 redis<8,>=7.1

hexkit-8.5.0/src/hexkit/opentelemetry.py

@@ -1,76 +0,0 @@
-# Copyright 2021 - 2026 Universität Tübingen, DKFZ, EMBL, and Universität zu Köln
-# for the German Human Genome-Phenome Archive (GHGA)
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-"""OpenTelemetry specific configuration code. This is gated behind the opentelemetry extra."""
-
-import logging
-import os
-from typing import Annotated
-
-from opentelemetry import trace
-from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
-from opentelemetry.sdk.environment_variables import OTEL_SDK_DISABLED
-from opentelemetry.sdk.resources import SERVICE_NAME, Resource
-from opentelemetry.sdk.trace import TracerProvider
-from opentelemetry.sdk.trace.export import BatchSpanProcessor
-from opentelemetry.sdk.trace.sampling import ParentBasedTraceIdRatio
-from pydantic import Field
-from pydantic_settings import BaseSettings
-
-logger = logging.getLogger(__name__)
-
-
-class OpenTelemetryConfig(BaseSettings):
-    """OpenTelemetry specific configuration options"""
-
-    enable_opentelemetry: bool = Field(
-        default=False,
-        description="If set to true, this will run necessary setup code."
-        "If set to false, environment variables are set that should also effectively "
-        "disable autoinstrumentation.",
-    )
-    otel_trace_sampling_rate: Annotated[float, Field(strict=True, ge=0, le=1)] = Field(
-        default=1.0,
-        description="Determines which proportion of spans should be sampled. "
-        "A value of 1.0 means all and is equivalent to the previous behaviour. "
-        "Setting this to 0 will result in no spans being sampled, but this does not "
-        "automatically set `enable_opentelemetry` to False.",
-    )
-
-
-def configure_opentelemetry(*, service_name: str, config: OpenTelemetryConfig):
-    """Configure all needed parts of OpenTelemetry.
-
-    Setup of the TracerProvider is done programmatically, while disabling OpenTelemetry
-    sets the corresponding environment variable.
-    """
-    if config.enable_opentelemetry:
-        resource = Resource(attributes={SERVICE_NAME: service_name})
-        # Replace the default static sampler with a probabilistic one that honors parent
-        # span sampling decisions
-        # This should consistently yield full traces within a service but not necessarily
-        # across service boundaries
-        # With the default sampling rate, behaviour does not change, but this allows to
-        # introduce head sampling by adjusting a config option on the service side later on
-        sampler = ParentBasedTraceIdRatio(rate=config.otel_trace_sampling_rate)
-
-        # Initialize service specific TracerProvider
-        trace_provider = TracerProvider(resource=resource, sampler=sampler)
-        processor = BatchSpanProcessor(OTLPSpanExporter())
-        trace_provider.add_span_processor(processor)
-        trace.set_tracer_provider(trace_provider)
-    else:
-        # Currently OTEL_SDK_DISABLED doesn't seem to be honored by all implementations yet
-        # It seems to be working well enough for the Python implementation.
-        os.environ[OTEL_SDK_DISABLED] = "true"