hexkit 6.0.0__tar.gz → 7.0.0__tar.gz

{hexkit-6.0.0/src/hexkit.egg-info → hexkit-7.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hexkit
-Version: 6.0.0
+Version: 7.0.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
@@ -32,25 +32,26 @@ Requires-Dist: botocore<2,>=1.37; extra == "s3"
 Provides-Extra: mongodb
 Requires-Dist: pymongo<5,>=4.13; extra == "mongodb"
 Provides-Extra: opentelemetry-base
-Requires-Dist: opentelemetry-sdk<2,>=1.31.1; extra == "opentelemetry-base"
-Requires-Dist: opentelemetry-exporter-otlp<2,>=1.31.1; extra == "opentelemetry-base"
-Requires-Dist: opentelemetry-instrumentation>=0.52b1; extra == "opentelemetry-base"
-Requires-Dist: opentelemetry-instrumentation-httpx>=0.52b1; extra == "opentelemetry-base"
+Requires-Dist: opentelemetry-sdk<2,>=1.35.0; extra == "opentelemetry-base"
+Requires-Dist: opentelemetry-exporter-otlp<2,>=1.35.0; extra == "opentelemetry-base"
+Requires-Dist: opentelemetry-instrumentation>=0.56b0; extra == "opentelemetry-base"
+Requires-Dist: opentelemetry-instrumentation-httpx>=0.56b0; extra == "opentelemetry-base"
+Requires-Dist: opentelemetry-distro>=0.56b0; 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.52b1; extra == "opentelemetry-akafka"
+Requires-Dist: opentelemetry-instrumentation-aiokafka>=0.56b0; 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.52b1; extra == "opentelemetry-mongodb"
+Requires-Dist: opentelemetry-instrumentation-pymongo>=0.56b0; extra == "opentelemetry-mongodb"
 Provides-Extra: opentelemetry-fastapi
 Requires-Dist: hexkit[opentelemetry-base]; extra == "opentelemetry-fastapi"
-Requires-Dist: opentelemetry-instrumentation-fastapi>=0.52b1; extra == "opentelemetry-fastapi"
+Requires-Dist: opentelemetry-instrumentation-fastapi>=0.56b0; 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.52b1; extra == "opentelemetry-s3"
+Requires-Dist: opentelemetry-instrumentation-botocore>=0.56b0; extra == "opentelemetry-s3"
 Provides-Extra: opentelemetry
 Requires-Dist: hexkit[opentelemetry-akafka]; extra == "opentelemetry"
 Requires-Dist: hexkit[opentelemetry-mongodb]; extra == "opentelemetry"

{hexkit-6.0.0 → hexkit-7.0.0}/pyproject.toml

@@ -24,7 +24,7 @@ classifiers = [
     "Intended Audience :: Developers",
 ]
 name = "hexkit"
-version = "6.0.0"
+version = "7.0.0"
 description = "A Toolkit for Building Microservices using the Hexagonal Architecture"
 dependencies = [
     "opentelemetry-api >=1.31.1, <2",
@@ -49,29 +49,30 @@ mongodb = [
     "pymongo >=4.13, <5",
 ]
 opentelemetry-base = [
-    "opentelemetry-sdk >=1.31.1, <2",
-    "opentelemetry-exporter-otlp >=1.31.1, <2",
-    "opentelemetry-instrumentation >=0.52b1",
-    "opentelemetry-instrumentation-httpx >=0.52b1",
+    "opentelemetry-sdk >=1.35.0, <2",
+    "opentelemetry-exporter-otlp >=1.35.0, <2",
+    "opentelemetry-instrumentation >=0.56b0",
+    "opentelemetry-instrumentation-httpx >=0.56b0",
+    "opentelemetry-distro >=0.56b0",
 ]
 opentelemetry-akafka = [
     "hexkit[opentelemetry-base]",
     "hexkit[akafka]",
-    "opentelemetry-instrumentation-aiokafka >=0.52b1",
+    "opentelemetry-instrumentation-aiokafka >=0.56b0",
 ]
 opentelemetry-mongodb = [
     "hexkit[opentelemetry-base]",
     "hexkit[mongodb]",
-    "opentelemetry-instrumentation-pymongo >=0.52b1",
+    "opentelemetry-instrumentation-pymongo >=0.56b0",
 ]
 opentelemetry-fastapi = [
     "hexkit[opentelemetry-base]",
-    "opentelemetry-instrumentation-fastapi >=0.52b1",
+    "opentelemetry-instrumentation-fastapi >=0.56b0",
 ]
 opentelemetry-s3 = [
     "hexkit[opentelemetry-base]",
     "hexkit[s3]",
-    "opentelemetry-instrumentation-botocore >=0.52b1",
+    "opentelemetry-instrumentation-botocore >=0.56b0",
 ]
 opentelemetry = [
     "hexkit[opentelemetry-akafka]",
@@ -102,9 +103,6 @@ all = [
 [project.urls]
 Repository = "https://github.com/ghga-de/hexkit"
 
-[project.entry-points.opentelemetry_distro]
-hexkit_distro = "hexkit.opentelemetry:HexkitDistro"
-
 [tool.setuptools.packages.find]
 where = [
     "src",
@@ -226,7 +224,7 @@ source = [
 [tool.tox]
 legacy_tox_ini = """
     [tox]
-    env_list = py3{9,12,13}
+    env_list = py3{9,10,11,12,13}
 
     [gh-actions]
     python =
@@ -242,5 +240,7 @@ legacy_tox_ini = """
         DOCKER_HOST
     deps =
         --no-deps -r ./lock/requirements-dev.txt
-    commands = pytest {posargs}
+    commands =
+        py3{9,10}: pip install --no-deps backports.asyncio.runner==1.2.0 exceptiongroup==1.3.0 tomli==2.2.1
+        pytest {posargs}
 """

hexkit-7.0.0/src/hexkit/opentelemetry.py

@@ -0,0 +1,76 @@
+# Copyright 2021 - 2025 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"

{hexkit-6.0.0 → hexkit-7.0.0/src/hexkit.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hexkit
-Version: 6.0.0
+Version: 7.0.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
@@ -32,25 +32,26 @@ Requires-Dist: botocore<2,>=1.37; extra == "s3"
 Provides-Extra: mongodb
 Requires-Dist: pymongo<5,>=4.13; extra == "mongodb"
 Provides-Extra: opentelemetry-base
-Requires-Dist: opentelemetry-sdk<2,>=1.31.1; extra == "opentelemetry-base"
-Requires-Dist: opentelemetry-exporter-otlp<2,>=1.31.1; extra == "opentelemetry-base"
-Requires-Dist: opentelemetry-instrumentation>=0.52b1; extra == "opentelemetry-base"
-Requires-Dist: opentelemetry-instrumentation-httpx>=0.52b1; extra == "opentelemetry-base"
+Requires-Dist: opentelemetry-sdk<2,>=1.35.0; extra == "opentelemetry-base"
+Requires-Dist: opentelemetry-exporter-otlp<2,>=1.35.0; extra == "opentelemetry-base"
+Requires-Dist: opentelemetry-instrumentation>=0.56b0; extra == "opentelemetry-base"
+Requires-Dist: opentelemetry-instrumentation-httpx>=0.56b0; extra == "opentelemetry-base"
+Requires-Dist: opentelemetry-distro>=0.56b0; 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.52b1; extra == "opentelemetry-akafka"
+Requires-Dist: opentelemetry-instrumentation-aiokafka>=0.56b0; 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.52b1; extra == "opentelemetry-mongodb"
+Requires-Dist: opentelemetry-instrumentation-pymongo>=0.56b0; extra == "opentelemetry-mongodb"
 Provides-Extra: opentelemetry-fastapi
 Requires-Dist: hexkit[opentelemetry-base]; extra == "opentelemetry-fastapi"
-Requires-Dist: opentelemetry-instrumentation-fastapi>=0.52b1; extra == "opentelemetry-fastapi"
+Requires-Dist: opentelemetry-instrumentation-fastapi>=0.56b0; 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.52b1; extra == "opentelemetry-s3"
+Requires-Dist: opentelemetry-instrumentation-botocore>=0.56b0; extra == "opentelemetry-s3"
 Provides-Extra: opentelemetry
 Requires-Dist: hexkit[opentelemetry-akafka]; extra == "opentelemetry"
 Requires-Dist: hexkit[opentelemetry-mongodb]; extra == "opentelemetry"

{hexkit-6.0.0 → hexkit-7.0.0}/src/hexkit.egg-info/SOURCES.txt

@@ -15,7 +15,6 @@ src/hexkit/utils.py
 src/hexkit.egg-info/PKG-INFO
 src/hexkit.egg-info/SOURCES.txt
 src/hexkit.egg-info/dependency_links.txt
-src/hexkit.egg-info/entry_points.txt
 src/hexkit.egg-info/requires.txt
 src/hexkit.egg-info/top_level.txt
 src/hexkit/protocols/__init__.py

{hexkit-6.0.0 → hexkit-7.0.0}/src/hexkit.egg-info/requires.txt

@@ -23,27 +23,28 @@ hexkit[opentelemetry-s3]
 [opentelemetry-akafka]
 hexkit[opentelemetry-base]
 hexkit[akafka]
-opentelemetry-instrumentation-aiokafka>=0.52b1
+opentelemetry-instrumentation-aiokafka>=0.56b0
 
 [opentelemetry-base]
-opentelemetry-sdk<2,>=1.31.1
-opentelemetry-exporter-otlp<2,>=1.31.1
-opentelemetry-instrumentation>=0.52b1
-opentelemetry-instrumentation-httpx>=0.52b1
+opentelemetry-sdk<2,>=1.35.0
+opentelemetry-exporter-otlp<2,>=1.35.0
+opentelemetry-instrumentation>=0.56b0
+opentelemetry-instrumentation-httpx>=0.56b0
+opentelemetry-distro>=0.56b0
 
 [opentelemetry-fastapi]
 hexkit[opentelemetry-base]
-opentelemetry-instrumentation-fastapi>=0.52b1
+opentelemetry-instrumentation-fastapi>=0.56b0
 
 [opentelemetry-mongodb]
 hexkit[opentelemetry-base]
 hexkit[mongodb]
-opentelemetry-instrumentation-pymongo>=0.52b1
+opentelemetry-instrumentation-pymongo>=0.56b0
 
 [opentelemetry-s3]
 hexkit[opentelemetry-base]
 hexkit[s3]
-opentelemetry-instrumentation-botocore>=0.52b1
+opentelemetry-instrumentation-botocore>=0.56b0
 
 [s3]
 boto3<2,>=1.37

hexkit-6.0.0/src/hexkit/opentelemetry.py

@@ -1,177 +0,0 @@
-# Copyright 2021 - 2025 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, Callable, Literal, Optional
-
-from opentelemetry import trace
-from opentelemetry.environment_variables import (
-    OTEL_LOGS_EXPORTER,
-    OTEL_METRICS_EXPORTER,
-    OTEL_TRACES_EXPORTER,
-)
-from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
-from opentelemetry.instrumentation.distro import (  # type: ignore[attr-defined]
-    BaseDistro,
-)
-from opentelemetry.sdk.environment_variables import (
-    OTEL_EXPORTER_OTLP_ENDPOINT,
-    OTEL_EXPORTER_OTLP_PROTOCOL,
-    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 AnyHttpUrl, Field
-from pydantic_settings import BaseSettings
-
-TRACER: Optional["SpanTracer"] = None
-
-logger = logging.getLogger(__name__)
-
-
-class SpanTracer:
-    """Custom tracer class providing a decorator to autpopulate span names."""
-
-    def __init__(self, name):
-        self.tracer = trace.get_tracer(name)
-
-    def start_span(
-        self, *, record_exception: bool = False, set_status_on_exception: bool = False
-    ):
-        """Decorator function starting a span populated with the __qualname__ of the wrapped function"""
-
-        def outer_wrapper(function: Callable):
-            def traced_function(*args, **kwargs):
-                name = function.__qualname__
-                with self.tracer.start_as_current_span(
-                    name,
-                    record_exception=record_exception,
-                    set_status_on_exception=set_status_on_exception,
-                ):
-                    return function(*args, **kwargs)
-
-            return traced_function
-
-        return outer_wrapper
-
-
-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.",
-    )
-    otel_exporter_protocol: Literal["grpc", "http/protobuf"] = Field(
-        default="http/protobuf",
-        description="Specifies which protocol should be used by exporters.",
-    )
-    otel_exporter_endpoint: AnyHttpUrl = Field(
-        default=...,
-        description="Base endpoint URL for the collector that receives content from the exporter.",
-        examples=["http://localhost:4318"],
-    )
-
-
-class HexkitDistro(BaseDistro):
-    """
-    Custom OpenTelemetry Distro configuring a default set of configuration
-    based on a config file.
-    """
-
-    def _configure(self, **kwargs):
-        """Custom DefaultDistro iplementation to provide autoinstrumentation entry points."""
-
-
-def configure_opentelemetry(*, service_name: str, config: OpenTelemetryConfig):
-    """Configure all needed parts of OpenTelemetry.
-
-    Setup of the TracerProvider is done programmatically, all other configuration exports
-    OpenTelemetry specific environment variables.
-    """
-    global TRACER
-    # opentelemetry distro sets this to grpc, but in the current context http/protobuf is preferred
-    os.environ[OTEL_EXPORTER_OTLP_PROTOCOL] = config.otel_exporter_protocol
-    os.environ[OTEL_EXPORTER_OTLP_ENDPOINT] = str(config.otel_exporter_endpoint)
-    # Disable OpenTelemetry metrics and logs explicitly as they are not processed in the backend currently
-    # This overwrites the defaults of `otlp` set in opentelemetry distro
-    os.environ[OTEL_METRICS_EXPORTER] = "none"
-    os.environ[OTEL_LOGS_EXPORTER] = "none"
-
-    if config.enable_opentelemetry:
-        if TRACER is not None:
-            logger.warning(
-                "OpenTelemetry configuration code should only be run once. "
-                "If it has been run with a different service name than %s before, "
-                "the tracer and resource name will likely be wrong in some cases.",
-                service_name,
-            )
-        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)
-        TRACER = SpanTracer(service_name)
-    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, but to be on
-        # the safe side, let's explicitly disable the trace exporter for now
-        os.environ[OTEL_TRACES_EXPORTER] = "none"
-        os.environ[OTEL_SDK_DISABLED] = "true"
-
-
-def start_span(
-    *,
-    record_exception: bool = True,
-    set_status_on_exception: bool = True,
-) -> Callable:
-    """Returns decorated or undecorated function depending on if TRACER is instantiated.
-
-    Should be used as a decorator.
-    """
-
-    def wrapper(function: Callable):
-        # Caller did not have any time to populate from config yet or otel is disabled
-        if TRACER is None:
-            return function
-        # Return decorated function
-        return TRACER.start_span(
-            record_exception=record_exception,
-            set_status_on_exception=set_status_on_exception,
-        )(function)
-
-    return wrapper

hexkit-6.0.0/src/hexkit.egg-info/entry_points.txt

@@ -1,2 +0,0 @@
-[opentelemetry_distro]
-hexkit_distro = hexkit.opentelemetry:HexkitDistro