warpzone-sdk 14.3.0__tar.gz → 15.0.0__tar.gz

{warpzone_sdk-14.3.0 → warpzone_sdk-15.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: warpzone-sdk
-Version: 14.3.0
+Version: 15.0.0
 Summary: The main objective of this package is to centralize logic used to interact with Azure Functions, Azure Service Bus and Azure Table Storage
 Author: Team Enigma
 Author-email: enigma@energinet.dk
@@ -13,12 +13,11 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Requires-Dist: aiohttp (>=3.8.3)
 Requires-Dist: azure-core (>=1.26.3)
-Requires-Dist: azure-core-tracing-opentelemetry (>=1.0.0b12)
 Requires-Dist: azure-data-tables (>=12.4.0)
 Requires-Dist: azure-functions (>=1.12.0)
 Requires-Dist: azure-identity (>=1.15.0)
 Requires-Dist: azure-monitor-opentelemetry-exporter (>=1.0.0b36)
-Requires-Dist: azure-servicebus (>=7.8.0,<7.9.0)
+Requires-Dist: azure-servicebus (>=7.8.0)
 Requires-Dist: azure-storage-blob (>=12.14.1)
 Requires-Dist: cryptography (==43.0.3)
 Requires-Dist: datamazing (>=5.1.6)

{warpzone_sdk-14.3.0 → warpzone_sdk-15.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "warpzone-sdk"
-version = "14.3.0"
+version = "15.0.0"
 description = "The main objective of this package is to centralize logic used to interact with Azure Functions, Azure Service Bus and Azure Table Storage"
 authors = [{ name = "Team Enigma", email = "enigma@energinet.dk" }]
 requires-python = ">=3.10"
@@ -20,10 +20,9 @@ datamazing = ">=5.1.6"
 azure-core = ">=1.26.3"
 azure-data-tables = ">=12.4.0"
 azure-identity = ">=1.15.0"
-azure-servicebus = "~7.8.0" # pin to avoid breaking changes with tracing in 7.9.0
+azure-servicebus = ">=7.8.0"
 azure-storage-blob = ">=12.14.1"
 aiohttp = ">=3.8.3"
-azure-core-tracing-opentelemetry = ">=1.0.0b12"
 azure-monitor-opentelemetry-exporter = ">=1.0.0b36"
 opentelemetry-sdk = ">=1.32.0"
 azure-functions = ">=1.12.0"

{warpzone_sdk-14.3.0 → warpzone_sdk-15.0.0}/warpzone/function/monitor.py

@@ -1,5 +1,4 @@
 import asyncio
-import logging
 from contextlib import contextmanager
 from typing import Callable
 
@@ -18,16 +17,7 @@ def configure_monitoring():
     """
     Configure logging and tracing on Azure Function to
     - export telemetry to App Insights
-    - suppress spamming logs
     """
-    # disable logging for HTTP calls to avoid log spamming
-    logging.getLogger("azure.core.pipeline.policies.http_logging_policy").setLevel(
-        logging.WARNING
-    )
-
-    # disable logging for Service Bus underlying uAMQP library to avoid log spamming
-    logging.getLogger("uamqp").setLevel(logging.WARNING)
-
     # configure tracer provider
     traces.configure_tracing()
 

warpzone_sdk-15.0.0/warpzone/monitor/__init__.py

@@ -0,0 +1,2 @@
+from .logs import get_logger
+from .traces import get_current_diagnostic_id, get_tracer, servicebus_send_span

warpzone_sdk-15.0.0/warpzone/monitor/logs.py

@@ -0,0 +1,87 @@
+# NOTE: OpenTelemetry logging to Azure is still in EXPERIMENTAL mode!
+import logging
+import os
+import threading
+from logging import StreamHandler
+
+from azure.monitor.opentelemetry.exporter import AzureMonitorLogExporter
+from opentelemetry import _logs as logs
+from opentelemetry.sdk._logs import LoggerProvider, LoggingHandler
+from opentelemetry.sdk._logs.export import BatchLogRecordProcessor
+from opentelemetry.sdk.resources import SERVICE_NAME, Resource
+
+logger = logging.getLogger(__name__)
+logger.addHandler(StreamHandler())
+
+# Suppress verbose logging from Azure SDK and infrastructure
+_NOISY_LOGGERS = [
+    "azure.core.pipeline.policies.http_logging_policy",
+    "azure.data.tables",
+    "azure.storage.blob",
+    "azure.servicebus",
+    "azure.identity",
+    "azure.monitor.opentelemetry.exporter",
+    "azure_functions_worker",
+    "azure.functions",
+    "uamqp",
+]
+for _logger_name in _NOISY_LOGGERS:
+    logging.getLogger(_logger_name).setLevel(logging.WARNING)
+
+_LOGGING_LOCK = threading.Lock()
+LOGGING_IS_CONFIGURED = False
+
+
+def configure_logging():
+    global LOGGING_IS_CONFIGURED
+    # Add thread locking to avoid race conditions during setup
+    with _LOGGING_LOCK:
+        if LOGGING_IS_CONFIGURED:
+            # logging should only be set up once
+            # to avoid duplicated log handling.
+            # Global variables is the pattern used
+            # by opentelemetry, so we use the same
+            return
+
+        # set up logger provider based on the Azure Function resource
+        # (this is make sure App Insights can track the log source correctly)
+        # (https://learn.microsoft.com/en-us/azure/azure-monitor/app/opentelemetry-enable?tabs=net#set-the-cloud-role-name-and-the-cloud-role-instance)
+        service_name = os.getenv("WEBSITE_SITE_NAME") or "unknown-service"
+        resource = Resource.create({SERVICE_NAME: service_name})
+        logs.set_logger_provider(
+            LoggerProvider(
+                resource=resource,
+            )
+        )
+
+        # setup azure monitor log exporter to send telemetry to App Insights
+        try:
+            log_exporter = AzureMonitorLogExporter()
+        except ValueError:
+            logger.warning(
+                "Cant set up logging to App Insights,"
+                " as no connection string is set."
+            )
+        else:
+            log_record_processor = BatchLogRecordProcessor(log_exporter)
+            logs.get_logger_provider().add_log_record_processor(log_record_processor)
+
+        LOGGING_IS_CONFIGURED = True
+
+
+def get_logger(name: str):
+    # set up standard logger
+    logger = logging.getLogger(name)
+    logger.setLevel(logging.INFO)
+
+    # Check if OTEL handler is already added to this specific logger
+    # (not using hasHandlers() as it also checks parent/root handlers)
+    has_otel_handler = any(isinstance(h, LoggingHandler) for h in logger.handlers)
+    if not has_otel_handler:
+        # add OTEL handler for trace correlation
+        handler = LoggingHandler()
+        logger.addHandler(handler)
+        # Don't propagate to root logger to avoid duplicate logs
+        logger.propagate = False
+
+    return logger

warpzone_sdk-15.0.0/warpzone/monitor/traces.py

@@ -0,0 +1,128 @@
+import logging
+import os
+import threading
+from contextlib import contextmanager
+from logging import StreamHandler
+
+from azure.monitor.opentelemetry.exporter import AzureMonitorTraceExporter
+from opentelemetry import context, trace
+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 ALWAYS_ON
+from opentelemetry.trace.propagation.tracecontext import TraceContextTextMapPropagator
+
+logger = logging.getLogger(__name__)
+logger.addHandler(StreamHandler())
+
+tracer = trace.get_tracer(__name__)
+
+_TRACING_LOCK = threading.Lock()
+TRACING_IS_CONFIGURED = False
+
+
+def configure_tracing():
+    global TRACING_IS_CONFIGURED
+    # Add thread locking to avoid race conditions during setup
+    with _TRACING_LOCK:
+        if TRACING_IS_CONFIGURED:
+            # tracing should only be set up once
+            # to avoid duplicated trace handling.
+            # Global variables is the pattern used
+            # by opentelemetry, so we use the same
+            return
+
+        # set up tracer provider based on the Azure Function resource
+        # (this is make sure App Insights can track the trace source correctly)
+        # (https://learn.microsoft.com/en-us/azure/azure-monitor/app/opentelemetry-enable?tabs=net#set-the-cloud-role-name-and-the-cloud-role-instance).
+        # We use the ALWAYS ON sampler since otherwise spans will not be
+        # recording upon creation
+        # (https://anecdotes.dev/opentelemetry-on-google-cloud-unraveling-the-mystery-f61f044c18be)
+        service_name = os.getenv("WEBSITE_SITE_NAME") or "unknown-service"
+        resource = Resource.create({SERVICE_NAME: service_name})
+        trace.set_tracer_provider(
+            TracerProvider(
+                sampler=ALWAYS_ON,
+                resource=resource,
+            )
+        )
+
+        # setup azure monitor trace exporter to send telemetry to App Insights
+        try:
+            trace_exporter = AzureMonitorTraceExporter()
+        except ValueError:
+            logger.warning(
+                "Cant set up tracing to App Insights,"
+                " as no connection string is set."
+            )
+        else:
+            span_processor = BatchSpanProcessor(trace_exporter)
+            trace.get_tracer_provider().add_span_processor(span_processor)
+
+        TRACING_IS_CONFIGURED = True
+
+
+@contextmanager
+def set_trace_context(trace_parent: str, trace_state: str = ""):
+    """Context manager for setting the trace context
+
+    Args:
+        trace_parent (str): Trace parent ID
+        trace_state (str, optional): Trace state. Defaults to "".
+    """
+    carrier = {"traceparent": trace_parent, "tracestate": trace_state}
+    ctx = TraceContextTextMapPropagator().extract(carrier=carrier)
+
+    token = context.attach(ctx)  # attach context before run
+    try:
+        yield
+    finally:
+        context.detach(token)  # detach context after run
+
+
+def get_tracer(name: str):
+    tracer = trace.get_tracer(name)
+    return tracer
+
+
+def get_current_diagnostic_id() -> str:
+    """Gets diagnostic id from current span
+
+    The diagnostic id is a concatenation of operation-id and parent-id
+
+    Returns:
+        str: diagnostic id
+    """
+    span = trace.get_current_span()
+
+    if not span.is_recording():
+        return ""
+
+    operation_id = "{:016x}".format(span.context.trace_id)
+    parent_id = "{:016x}".format(span.context.span_id)
+
+    diagnostic_id = f"00-{operation_id}-{parent_id}-01"
+
+    return diagnostic_id
+
+
+# Service Bus trace constants (these were removed from azure-servicebus SDK)
+_SB_TRACE_NAMESPACE = "Microsoft.ServiceBus"
+
+
+@contextmanager
+def servicebus_send_span(subject: str) -> trace.Span:
+    """Start span for Service Bus message tracing.
+
+    Args:
+        subject: The message subject (used as span name for easy identification)
+
+    Yields:
+        trace.Span: the span
+    """
+    with tracer.start_as_current_span(
+        subject, kind=trace.SpanKind.PRODUCER
+    ) as msg_span:
+        msg_span.set_attributes({"az.namespace": _SB_TRACE_NAMESPACE})
+
+        yield msg_span

{warpzone_sdk-14.3.0 → warpzone_sdk-15.0.0}/warpzone/servicebus/events/client.py

@@ -56,9 +56,9 @@ class WarpzoneEventClient:
     def from_resource_name(
         cls,
         service_bus_namespace: str,
-        credential: AzureNamedKeyCredential
-        | AzureSasCredential
-        | TokenCredential = DefaultAzureCredential(),
+        credential: (
+            AzureNamedKeyCredential | AzureSasCredential | TokenCredential
+        ) = DefaultAzureCredential(),
     ):
         service_bus_client = ServiceBusClient(
             fully_qualified_namespace=f"{service_bus_namespace}.servicebus.windows.net",
@@ -125,9 +125,7 @@ class WarpzoneEventClient:
     ):
         typeguard.check_type(value=topic, expected_type=Topic)
         topic_name = topic.value
-        with traces.servicebus_send_span(
-            self._service_bus_client.fully_qualified_namespace, topic_name
-        ):
+        with traces.servicebus_send_span(event_msg.subject):
             diagnostic_id = traces.get_current_diagnostic_id()
 
             az_sdk_msg = ServiceBusMessage(

warpzone_sdk-14.3.0/warpzone/monitor/__init__.py

@@ -1,2 +0,0 @@
-from .logs import get_logger
-from .traces import get_current_diagnostic_id, get_tracer

warpzone_sdk-14.3.0/warpzone/monitor/logs.py

@@ -1,63 +0,0 @@
-# NOTE: OpenTelemetry logging to Azure is still in EXPERIMENTAL mode!
-import logging
-import os
-from logging import StreamHandler
-
-from azure.monitor.opentelemetry.exporter import AzureMonitorLogExporter
-from opentelemetry import _logs as logs
-from opentelemetry.sdk._logs import LoggerProvider, LoggingHandler
-from opentelemetry.sdk._logs.export import BatchLogRecordProcessor
-from opentelemetry.sdk.resources import SERVICE_NAME, Resource
-
-logger = logging.getLogger(__name__)
-logger.addHandler(StreamHandler())
-
-LOGGING_IS_CONFIGURED = False
-
-
-def configure_logging():
-    global LOGGING_IS_CONFIGURED
-    if LOGGING_IS_CONFIGURED:
-        # logging should only be set up once
-        # to avoid duplicated log handling.
-        # Global variables is the pattern used
-        # by opentelemetry, so we use the same
-        return
-
-    # set up logger provider based on the Azure Function resource
-    # (this is make sure App Insights can track the log source correctly)
-    # (https://learn.microsoft.com/en-us/azure/azure-monitor/app/opentelemetry-enable?tabs=net#set-the-cloud-role-name-and-the-cloud-role-instance)
-    resource = Resource.create({SERVICE_NAME: os.getenv("WEBSITE_SITE_NAME")})
-    logs.set_logger_provider(
-        LoggerProvider(
-            resource=resource,
-        )
-    )
-
-    # setup azure monitor log exporter to send telemetry to App Insights
-    try:
-        log_exporter = AzureMonitorLogExporter()
-    except ValueError:
-        # if no App Insights instrumentation key is set (e.g. when running unit tests),
-        # the exporter creation will fail. In this case we skip it
-        logger.warning(
-            "Cant set up logging to App Insights, as no instrumentation key is set."
-        )
-    else:
-        log_record_processor = BatchLogRecordProcessor(log_exporter)
-        logs.get_logger_provider().add_log_record_processor(log_record_processor)
-
-    LOGGING_IS_CONFIGURED = True
-
-
-def get_logger(name: str):
-    # set up standard logger
-    logger = logging.getLogger(name)
-    logger.setLevel(logging.INFO)
-
-    if not logger.hasHandlers():
-        # add OTEL handler
-        handler = LoggingHandler()
-        logger.addHandler(handler)
-
-    return logger

warpzone_sdk-14.3.0/warpzone/monitor/traces.py

@@ -1,136 +0,0 @@
-import logging
-import os
-from contextlib import contextmanager
-from logging import StreamHandler
-
-from azure.monitor.opentelemetry.exporter import AzureMonitorTraceExporter
-from azure.servicebus._common import constants
-from opentelemetry import context, trace
-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 ALWAYS_ON
-from opentelemetry.trace.propagation.tracecontext import TraceContextTextMapPropagator
-
-logger = logging.getLogger(__name__)
-logger.addHandler(StreamHandler())
-
-tracer = trace.get_tracer(__name__)
-
-TRACING_IS_CONFIGURED = False
-
-
-def configure_tracing():
-    global TRACING_IS_CONFIGURED
-    if TRACING_IS_CONFIGURED:
-        # tracing should only be set up once
-        # to avoid duplicated trace handling.
-        # Global variables is the pattern used
-        # by opentelemetry, so we use the same
-        return
-
-    # set up tracer provider based on the Azure Function resource
-    # (this is make sure App Insights can track the trace source correctly)
-    # (https://learn.microsoft.com/en-us/azure/azure-monitor/app/opentelemetry-enable?tabs=net#set-the-cloud-role-name-and-the-cloud-role-instance).
-    # We use the ALWAYS ON sampler since otherwise spans will not be
-    # recording upon creation
-    # (https://anecdotes.dev/opentelemetry-on-google-cloud-unraveling-the-mystery-f61f044c18be)
-    resource = Resource.create({SERVICE_NAME: os.getenv("WEBSITE_SITE_NAME")})
-    trace.set_tracer_provider(
-        TracerProvider(
-            sampler=ALWAYS_ON,
-            resource=resource,
-        )
-    )
-
-    # setup azure monitor trace exporter to send telemetry to App Insights
-    try:
-        trace_exporter = AzureMonitorTraceExporter()
-    except ValueError:
-        # if no App Insights instrumentation key is set (e.g. when running unit tests),
-        # the exporter creation will fail. In this case we skip it
-        logger.warning(
-            "Cant set up tracing to App Insights, as no instrumentation key is set."
-        )
-    else:
-        span_processor = BatchSpanProcessor(trace_exporter)
-        trace.get_tracer_provider().add_span_processor(span_processor)
-
-    TRACING_IS_CONFIGURED = True
-
-
-@contextmanager
-def set_trace_context(trace_parent: str, trace_state: str = ""):
-    """Context manager for setting the trace context
-
-    Args:
-        trace_parent (str): Trace parent ID
-        trace_state (str, optional): Trace state. Defaults to "".
-    """
-    carrier = {"traceparent": trace_parent, "tracestate": trace_state}
-    ctx = TraceContextTextMapPropagator().extract(carrier=carrier)
-
-    token = context.attach(ctx)  # attach context before run
-    try:
-        yield
-    finally:
-        context.detach(token)  # detach context after run
-
-
-def get_tracer(name: str):
-    tracer = trace.get_tracer(name)
-    return tracer
-
-
-def get_current_diagnostic_id() -> str:
-    """Gets diagnostic id from current span
-
-    The diagnostic id is a concatenation of operation-id and parent-id
-
-    Returns:
-        str: diagnostic id
-    """
-    span = trace.get_current_span()
-
-    if not span.is_recording():
-        return ""
-
-    operation_id = "{:016x}".format(span.context.trace_id)
-    parent_id = "{:016x}".format(span.context.span_id)
-
-    diagnostic_id = f"00-{operation_id}-{parent_id}-01"
-
-    return diagnostic_id
-
-
-@contextmanager
-def servicebus_send_span(servicebus_url: str, topic_name: str) -> trace.Span:
-    """Start spans necessary for correct tracing
-
-    Args:
-        servicebus_url (str): The full servicebus url
-        topic_name (str): Name of topic
-
-    Yields:
-        trace.Span: the inner span
-    """
-    with tracer.start_as_current_span(
-        constants.SPAN_NAME_SEND, kind=trace.SpanKind.CLIENT
-    ) as send_span:
-        send_span.set_attributes(
-            {
-                constants.TRACE_COMPONENT_PROPERTY: constants.TRACE_NAMESPACE,
-                constants.TRACE_NAMESPACE_PROPERTY: constants.TRACE_NAMESPACE_PROPERTY,
-                constants.TRACE_BUS_DESTINATION_PROPERTY: topic_name,
-                constants.TRACE_PEER_ADDRESS_PROPERTY: servicebus_url,
-            }
-        )
-
-        with tracer.start_as_current_span(
-            constants.SPAN_NAME_MESSAGE, kind=trace.SpanKind.PRODUCER
-        ) as msg_span:
-            msg_span.set_attributes(
-                {constants.TRACE_NAMESPACE_PROPERTY: constants.TRACE_NAMESPACE}
-            )
-
-            yield msg_span