warpzone-sdk 15.0.0.dev9__tar.gz → 15.0.0.dev11__tar.gz

{warpzone_sdk-15.0.0.dev9 → warpzone_sdk-15.0.0.dev11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: warpzone-sdk
-Version: 15.0.0.dev9
+Version: 15.0.0.dev11
 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

{warpzone_sdk-15.0.0.dev9 → warpzone_sdk-15.0.0.dev11}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "warpzone-sdk"
-version = "15.0.0.dev9"
+version = "15.0.0.dev11"
 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"

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

@@ -1,20 +1,44 @@
-import inspect
+import asyncio
+import logging
 from contextlib import contextmanager
 from typing import Callable
 
 import azure.functions as func
 
 from warpzone.function.types import SingleArgumentCallable
-from warpzone.monitor import traces
-
-# Configure tracing at import time (once per worker process)
-traces.configure_tracing()
+from warpzone.monitor import logs, traces
 
 SUBJECT_IDENTIFIER = "<Subject>"
 
+tracer = traces.get_tracer(__name__)
+logger = logs.get_logger(__name__)
+
+
+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()
+
+    # configure logger provider
+    logs.configure_logging()
+
 
 @contextmanager
 def run_in_trace_context(context: func.Context):
+    configure_monitoring()
+
     trace_context = context.trace_context
     with traces.set_trace_context(
         trace_context.trace_parent, trace_context.trace_state
@@ -51,7 +75,7 @@ def monitor(main: SingleArgumentCallable) -> Callable:
             result = main(arg)
             return result
 
-    if inspect.iscoroutinefunction(main):
+    if asyncio.iscoroutinefunction(main):
         return wrapper_async
     else:
         return wrapper

warpzone_sdk-15.0.0.dev11/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.dev11/warpzone/monitor/logs.py

@@ -0,0 +1,78 @@
+# 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())
+
+# 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_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-15.0.0.dev11/warpzone/monitor/traces.py

@@ -0,0 +1,124 @@
+import logging
+import os
+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_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
+
+
+# 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-15.0.0.dev9 → warpzone_sdk-15.0.0.dev11}/warpzone/servicebus/events/client.py

@@ -125,20 +125,20 @@ class WarpzoneEventClient:
     ):
         typeguard.check_type(value=topic, expected_type=Topic)
         topic_name = topic.value
+        with traces.servicebus_send_span(event_msg.subject):
+            diagnostic_id = traces.get_current_diagnostic_id()
+
+            az_sdk_msg = ServiceBusMessage(
+                body=json.dumps(event_msg.event),
+                subject=event_msg.subject,
+                content_type="application/json",
+                message_id=event_msg.message_id,
+                application_properties={"Diagnostic-Id": diagnostic_id},
+                time_to_live=event_msg.time_to_live,
+            )
 
-        diagnostic_id = traces.get_current_diagnostic_id()
-
-        az_sdk_msg = ServiceBusMessage(
-            body=json.dumps(event_msg.event),
-            subject=event_msg.subject,
-            content_type="application/json",
-            message_id=event_msg.message_id,
-            application_properties={"Diagnostic-Id": diagnostic_id},
-            time_to_live=event_msg.time_to_live,
-        )
-
-        with self._get_topic_sender(topic_name) as sender:
-            sender.send_messages(message=az_sdk_msg)
+            with self._get_topic_sender(topic_name) as sender:
+                sender.send_messages(message=az_sdk_msg)
 
     def list_subscriptions(
         self,

warpzone_sdk-15.0.0.dev9/warpzone/monitor/__init__.py

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

warpzone_sdk-15.0.0.dev9/warpzone/monitor/logs.py

@@ -1,34 +0,0 @@
-import logging
-
-# Suppress verbose logging from Azure SDK
-logging.getLogger("azure.core.pipeline.policies.http_logging_policy").setLevel(
-    logging.WARNING
-)
-logging.getLogger("azure.data.tables").setLevel(logging.WARNING)
-logging.getLogger("azure.storage.blob").setLevel(logging.WARNING)
-logging.getLogger("azure.servicebus").setLevel(logging.WARNING)
-logging.getLogger("uamqp").setLevel(logging.WARNING)
-logging.getLogger("azure.identity").setLevel(logging.WARNING)
-# Suppress Azure Functions host/worker logging (e.g., trigger details)
-logging.getLogger("azure_functions_worker").setLevel(logging.WARNING)
-logging.getLogger("azure.functions").setLevel(logging.WARNING)
-# Suppress Azure Monitor exporter logging (e.g., transmission success messages)
-logging.getLogger("azure.monitor.opentelemetry.exporter").setLevel(logging.WARNING)
-
-
-def get_logger(name: str):
-    """Get a logger instance.
-
-    The logger will automatically use the current OpenTelemetry trace context
-    for correlation in Application Insights. The trace context is set by the
-    monitor decorator's run_in_trace_context context manager.
-
-    Args:
-        name: Logger name, typically __name__
-
-    Returns:
-        A configured logger instance
-    """
-    logger = logging.getLogger(name)
-    logger.setLevel(logging.INFO)
-    return logger

warpzone_sdk-15.0.0.dev9/warpzone/monitor/traces.py

@@ -1,142 +0,0 @@
-import logging
-import os
-from contextlib import contextmanager
-
-from azure.core.settings import settings
-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 ReadableSpan, SpanProcessor, TracerProvider
-from opentelemetry.sdk.trace.export import BatchSpanProcessor
-from opentelemetry.sdk.trace.sampling import ALWAYS_ON
-from opentelemetry.trace.propagation.tracecontext import TraceContextTextMapPropagator
-
-# Enable OpenTelemetry tracing for Azure SDK (including Service Bus)
-# This must be set before any Azure SDK clients are created
-settings.tracing_implementation = "opentelemetry"
-
-logger = logging.getLogger(__name__)
-
-_TRACING_IS_CONFIGURED = False
-
-# Span name prefixes to allow from Azure SDK (Service Bus for function chaining)
-_ALLOWED_AZURE_SPAN_NAMES = frozenset({"ServiceBus.message"})
-
-
-class AzureSDKTraceFilter(SpanProcessor):
-    """SpanProcessor that filters out noisy Azure SDK traces.
-
-    Allows:
-    - All non-Azure SDK spans (custom/user traces)
-    - Service Bus spans (for tracing function chains)
-
-    Drops:
-    - Other Azure SDK spans (HTTP client, blob storage, etc.)
-    """
-
-    def __init__(self, wrapped_processor: SpanProcessor):
-        self.wrapped_processor = wrapped_processor
-
-    def on_start(
-        self, span: ReadableSpan, parent_context: context.Context = None
-    ) -> None:
-        self.wrapped_processor.on_start(span, parent_context)
-
-    def on_end(self, span: ReadableSpan) -> None:
-        scope = span.instrumentation_scope
-        if scope and scope.name:
-            # Check if it's an Azure SDK span (uses azure.core.tracing wrapper)
-            if scope.name.startswith("azure."):
-                # Allow only specific Service Bus span names
-                span_name = getattr(span, "name", "") or ""
-                if span_name in _ALLOWED_AZURE_SPAN_NAMES:
-                    self.wrapped_processor.on_end(span)
-                # Drop other Azure SDK spans
-                return
-
-        # Pass through: non-Azure SDK spans (custom traces)
-        self.wrapped_processor.on_end(span)
-
-    def shutdown(self) -> None:
-        self.wrapped_processor.shutdown()
-
-    def force_flush(self, timeout_millis: int = 30000) -> bool:
-        return self.wrapped_processor.force_flush(timeout_millis)
-
-
-def configure_tracing():
-    """Configure OpenTelemetry tracing with Azure Monitor exporter.
-
-    This sets up tracing for Service Bus and custom spans.
-    Other Azure SDK traces (HTTP, blob, etc.) are filtered out.
-
-    Should be called once before any tracing is performed.
-    """
-    global _TRACING_IS_CONFIGURED
-    if _TRACING_IS_CONFIGURED:
-        return
-
-    # Set up tracer provider with Azure Function resource info
-    resource = Resource.create({SERVICE_NAME: os.getenv("WEBSITE_SITE_NAME")})
-    provider = TracerProvider(
-        sampler=ALWAYS_ON,
-        resource=resource,
-    )
-    trace.set_tracer_provider(provider)
-
-    # Set up Azure Monitor trace exporter with filter
-    try:
-        trace_exporter = AzureMonitorTraceExporter()
-        span_processor = BatchSpanProcessor(trace_exporter)
-        filtered_processor = AzureSDKTraceFilter(span_processor)
-        provider.add_span_processor(filtered_processor)
-    except ValueError:
-        logger.warning(
-            "Cannot set up tracing to App Insights, as no instrumentation key is set."
-        )
-
-    _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)
-    try:
-        yield
-    finally:
-        context.detach(token)
-
-
-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