corehttp 1.0.0b6__py3-none-any.whl → 1.0.0b7__py3-none-any.whl

corehttp/_version.py

@@ -9,4 +9,4 @@
 # regenerated.
 # --------------------------------------------------------------------------
 
-VERSION = "1.0.0b6"
+VERSION = "1.0.0b7"

corehttp/credentials.py

@@ -68,7 +68,11 @@ class TokenCredential(Protocol, ContextManager["TokenCredential"]):
         ...
 
     def close(self) -> None:
-        pass
+        """Close the credential, releasing any resources it holds.
+
+        :return: None
+        :rtype: None
+        """
 
 
 class ServiceNamedKey(NamedTuple):
@@ -93,7 +97,7 @@ class ServiceKeyCredential:
     It provides the ability to update the key without creating a new client.
 
     :param str key: The key used to authenticate to a service
-    :raises: TypeError
+    :raises TypeError: If the key is not a string.
     """
 
     def __init__(self, key: str) -> None:
@@ -117,7 +121,8 @@ class ServiceKeyCredential:
         to update long-lived clients.
 
         :param str key: The key used to authenticate to a service
-        :raises: ValueError or TypeError
+        :raises ValueError: If the key is None or empty.
+        :raises TypeError: If the key is not a string.
         """
         if not key:
             raise ValueError("The key used for updating can not be None or empty")
@@ -132,7 +137,7 @@ class ServiceNamedKeyCredential:
 
     :param str name: The name of the credential used to authenticate to a service.
     :param str key: The key used to authenticate to a service.
-    :raises: TypeError
+    :raises TypeError: If the name or key is not a string.
     """
 
     def __init__(self, name: str, key: str) -> None:
@@ -180,7 +185,11 @@ class AsyncTokenCredential(Protocol, AsyncContextManager["AsyncTokenCredential"]
         ...
 
     async def close(self) -> None:
-        pass
+        """Close the credential, releasing any resources.
+
+        :return: None
+        :rtype: None
+        """
 
     async def __aexit__(
         self,

corehttp/instrumentation/__init__.py

@@ -0,0 +1,9 @@
+# ------------------------------------
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+# ------------------------------------
+from .tracing._tracer import get_tracer
+
+__all__ = [
+    "get_tracer",
+]

corehttp/instrumentation/tracing/__init__.py

@@ -0,0 +1,14 @@
+# ------------------------------------
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+# ------------------------------------
+from ._models import SpanKind, Link, TracingOptions
+from ._decorator import distributed_trace, distributed_trace_async
+
+__all__ = [
+    "Link",
+    "SpanKind",
+    "TracingOptions",
+    "distributed_trace",
+    "distributed_trace_async",
+]

corehttp/instrumentation/tracing/_decorator.py

@@ -0,0 +1,189 @@
+# ------------------------------------
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+# ------------------------------------
+"""The decorator to apply if you want the given method traced."""
+from contextvars import ContextVar
+import functools
+from typing import Awaitable, Any, TypeVar, overload, Optional, Callable, TYPE_CHECKING
+from typing_extensions import ParamSpec
+
+from ._models import SpanKind
+from ._tracer import get_tracer
+from ...settings import settings
+
+if TYPE_CHECKING:
+    from ._models import TracingOptions
+
+
+P = ParamSpec("P")
+T = TypeVar("T")
+
+
+# This context variable is used to determine if we are already in the span context of a decorated function.
+_in_span_context = ContextVar("in_span_context", default=False)
+
+
+@overload
+def distributed_trace(__func: Callable[P, T]) -> Callable[P, T]:
+    pass
+
+
+@overload
+def distributed_trace(**kwargs: Any) -> Callable[[Callable[P, T]], Callable[P, T]]:
+    pass
+
+
+def distributed_trace(__func: Optional[Callable[P, T]] = None, **kwargs: Any) -> Any:  # pylint: disable=unused-argument
+    """Decorator to apply to an SDK method to have it traced automatically.
+
+    Span will use the method's qualified name.
+
+    Note: This decorator SHOULD NOT be used by application developers. It's intended to be called by client
+    libraries only. Application developers should use OpenTelemetry directly to instrument their applications.
+
+    :param callable __func: A function to decorate
+
+    :return: The decorated function
+    :rtype: Any
+    """
+
+    def decorator(func: Callable[P, T]) -> Callable[P, T]:
+
+        @functools.wraps(func)
+        def wrapper_use_tracer(*args: Any, **kwargs: Any) -> T:
+            # If we are already in the span context of a decorated function, don't trace.
+            if _in_span_context.get():
+                return func(*args, **kwargs)
+
+            # This will be popped in the pipeline or transport runner.
+            tracing_options: TracingOptions = kwargs.get("tracing_options", {})
+
+            # User can explicitly disable tracing for this call
+            user_enabled = tracing_options.get("enabled")
+            if user_enabled is False:
+                return func(*args, **kwargs)
+
+            # If tracing is disabled globally and user didn't explicitly enable it, don't trace.
+            if not settings.tracing_enabled and user_enabled is None:
+                return func(*args, **kwargs)
+
+            config = {}
+            if args and hasattr(args[0], "_instrumentation_config"):
+                config = args[0]._instrumentation_config  # pylint: disable=protected-access
+
+            method_tracer = get_tracer(
+                library_name=config.get("library_name"),
+                library_version=config.get("library_version"),
+                schema_url=config.get("schema_url"),
+                attributes=config.get("attributes"),
+            )
+            if not method_tracer:
+                return func(*args, **kwargs)
+
+            name = func.__qualname__
+            span_suppression_token = _in_span_context.set(True)
+            try:
+                with method_tracer.start_as_current_span(
+                    name=name,
+                    kind=SpanKind.INTERNAL,
+                    attributes=tracing_options.get("attributes"),
+                ) as span:
+                    try:
+                        return func(*args, **kwargs)
+                    except Exception as err:  # pylint: disable=broad-except
+                        ex_type = type(err)
+                        module = ex_type.__module__ if ex_type.__module__ != "builtins" else ""
+                        error_type = f"{module}.{ex_type.__qualname__}" if module else ex_type.__qualname__
+                        span.set_attribute("error.type", error_type)
+                        raise
+            finally:
+                _in_span_context.reset(span_suppression_token)
+
+        return wrapper_use_tracer
+
+    return decorator if __func is None else decorator(__func)
+
+
+@overload
+def distributed_trace_async(__func: Callable[P, Awaitable[T]]) -> Callable[P, Awaitable[T]]:
+    pass
+
+
+@overload
+def distributed_trace_async(**kwargs: Any) -> Callable[[Callable[P, Awaitable[T]]], Callable[P, Awaitable[T]]]:
+    pass
+
+
+def distributed_trace_async(  # pylint: disable=unused-argument
+    __func: Optional[Callable[P, Awaitable[T]]] = None,
+    **kwargs: Any,
+) -> Any:
+    """Decorator to apply to an SDK method to have it traced automatically.
+
+    Span will use the method's qualified name.
+
+    Note: This decorator SHOULD NOT be used by application developers. It's intended to be called by client
+    libraries only. Application developers should use OpenTelemetry directly to instrument their applications.
+
+    :param callable __func: A function to decorate
+
+    :return: The decorated function
+    :rtype: Any
+    """
+
+    def decorator(func: Callable[P, Awaitable[T]]) -> Callable[P, Awaitable[T]]:
+
+        @functools.wraps(func)
+        async def wrapper_use_tracer(*args: Any, **kwargs: Any) -> T:
+            # If we are already in the span context of a decorated function, don't trace.
+            if _in_span_context.get():
+                return await func(*args, **kwargs)
+
+            # This will be popped in the pipeline or transport runner.
+            tracing_options: TracingOptions = kwargs.get("tracing_options", {})
+
+            # User can explicitly disable tracing for this call
+            user_enabled = tracing_options.get("enabled")
+            if user_enabled is False:
+                return await func(*args, **kwargs)
+
+            # If tracing is disabled globally and user didn't explicitly enable it, don't trace.
+            if not settings.tracing_enabled and user_enabled is None:
+                return await func(*args, **kwargs)
+
+            config = {}
+            if args and hasattr(args[0], "_instrumentation_config"):
+                config = args[0]._instrumentation_config  # pylint: disable=protected-access
+
+            method_tracer = get_tracer(
+                library_name=config.get("library_name"),
+                library_version=config.get("library_version"),
+                schema_url=config.get("schema_url"),
+                attributes=config.get("attributes"),
+            )
+            if not method_tracer:
+                return await func(*args, **kwargs)
+
+            name = func.__qualname__
+            span_suppression_token = _in_span_context.set(True)
+            try:
+                with method_tracer.start_as_current_span(
+                    name=name,
+                    kind=SpanKind.INTERNAL,
+                    attributes=tracing_options.get("attributes"),
+                ) as span:
+                    try:
+                        return await func(*args, **kwargs)
+                    except Exception as err:  # pylint: disable=broad-except
+                        ex_type = type(err)
+                        module = ex_type.__module__ if ex_type.__module__ != "builtins" else ""
+                        error_type = f"{module}.{ex_type.__qualname__}" if module else ex_type.__qualname__
+                        span.set_attribute("error.type", error_type)
+                        raise
+            finally:
+                _in_span_context.reset(span_suppression_token)
+
+        return wrapper_use_tracer
+
+    return decorator if __func is None else decorator(__func)

corehttp/instrumentation/tracing/_models.py

@@ -0,0 +1,72 @@
+# ------------------------------------
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+# ------------------------------------
+from __future__ import annotations
+from enum import Enum
+from typing import Dict, Mapping, Optional, Union, Sequence, TypedDict
+
+from ...utils import CaseInsensitiveEnumMeta
+
+
+AttributeValue = Union[
+    str,
+    bool,
+    int,
+    float,
+    Sequence[str],
+    Sequence[bool],
+    Sequence[int],
+    Sequence[float],
+]
+Attributes = Mapping[str, AttributeValue]
+
+
+class SpanKind(Enum, metaclass=CaseInsensitiveEnumMeta):
+    """Describes the role or kind of a span within a distributed trace.
+
+    This helps to categorize spans based on their relationship to other spans and the type
+    of operation they represent.
+    """
+
+    UNSPECIFIED = 1
+    """Unspecified span kind."""
+
+    SERVER = 2
+    """Indicates that the span describes an operation that handles a remote request."""
+
+    CLIENT = 3
+    """Indicates that the span describes a request to some remote service."""
+
+    PRODUCER = 4
+    """Indicates that the span describes the initiation or scheduling of a local or remote operation."""
+
+    CONSUMER = 5
+    """Indicates that the span represents the processing of an operation initiated by a producer."""
+
+    INTERNAL = 6
+    """Indicates that the span is used internally in the application."""
+
+
+class Link:
+    """Represents a reference from one span to another span.
+
+    :param headers: A dictionary of the request header as key value pairs.
+    :type headers: dict
+    :param attributes: Any additional attributes that should be added to link
+    :type attributes: dict
+    """
+
+    def __init__(self, headers: Dict[str, str], attributes: Optional[Attributes] = None) -> None:
+        self.headers = headers
+        self.attributes = attributes
+
+
+class TracingOptions(TypedDict, total=False):
+    """Options to configure tracing behavior for operations."""
+
+    enabled: bool
+    """Whether tracing is enabled for the operation. By default, if the global setting is enabled, tracing is
+    enabled for all operations. This option can be used to override the global setting for a specific operation."""
+    attributes: Attributes
+    """Attributes to include in the spans emitted for the operation."""

corehttp/instrumentation/tracing/_tracer.py

@@ -0,0 +1,69 @@
+# ------------------------------------
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+# ------------------------------------
+from typing import Optional, Union, Mapping, TYPE_CHECKING
+from functools import lru_cache
+
+if TYPE_CHECKING:
+    try:
+        from .opentelemetry import OpenTelemetryTracer
+    except ImportError:
+        pass
+
+
+def _get_tracer_impl():
+    # Check if OpenTelemetry is available/installed.
+    try:
+        from .opentelemetry import OpenTelemetryTracer
+
+        return OpenTelemetryTracer
+    except ImportError:
+        return None
+
+
+@lru_cache
+def _get_tracer_cached(
+    library_name: Optional[str],
+    library_version: Optional[str],
+    schema_url: Optional[str],
+    attributes_key: Optional[frozenset],
+) -> Optional["OpenTelemetryTracer"]:
+    tracer_impl = _get_tracer_impl()
+    if tracer_impl:
+        # Convert attributes_key back to dict if needed
+        attributes = dict(attributes_key) if attributes_key else None
+        return tracer_impl(
+            library_name=library_name,
+            library_version=library_version,
+            schema_url=schema_url,
+            attributes=attributes,
+        )
+    return None
+
+
+def get_tracer(
+    *,
+    library_name: Optional[str] = None,
+    library_version: Optional[str] = None,
+    schema_url: Optional[str] = None,
+    attributes: Optional[Mapping[str, Union[str, bool, int, float]]] = None,
+) -> Optional["OpenTelemetryTracer"]:
+    """Get the OpenTelemetry tracer instance if available.
+
+    If OpenTelemetry is not available, this method will return None. This method caches
+    the tracer instance for each unique set of parameters.
+
+    :keyword library_name: The name of the library to use in the tracer.
+    :paramtype library_name: str
+    :keyword library_version: The version of the library to use in the tracer.
+    :paramtype library_version: str
+    :keyword schema_url: Specifies the Schema URL of the emitted spans.
+    :paramtype schema_url: str
+    :keyword attributes: Attributes to add to the emitted spans.
+    :paramtype attributes: Mapping[str, Union[str, bool, int, float]]
+    :return: The OpenTelemetry tracer instance if available.
+    :rtype: Optional[~corehttp.instrumentation.tracing.opentelemetry.OpenTelemetryTracer]
+    """
+    attributes_key = frozenset(attributes.items()) if attributes else None
+    return _get_tracer_cached(library_name, library_version, schema_url, attributes_key)

corehttp/instrumentation/tracing/opentelemetry.py

@@ -0,0 +1,277 @@
+# ------------------------------------
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+# ------------------------------------
+from __future__ import annotations
+from contextlib import contextmanager
+from contextvars import Token
+from typing import Any, Optional, Dict, Sequence, cast, Callable, Iterator, TYPE_CHECKING
+
+from opentelemetry import context as otel_context_module, trace
+from opentelemetry.trace import (
+    Span,
+    SpanKind as OpenTelemetrySpanKind,
+    Link as OpenTelemetryLink,
+    StatusCode,
+)
+from opentelemetry.trace.propagation import get_current_span as get_current_span_otel
+from opentelemetry.propagate import extract, inject
+
+try:
+    from opentelemetry.context import _SUPPRESS_HTTP_INSTRUMENTATION_KEY  # type: ignore[attr-defined]
+except ImportError:
+    _SUPPRESS_HTTP_INSTRUMENTATION_KEY = "suppress_http_instrumentation"
+
+from ..._version import VERSION
+from ._models import (
+    Attributes,
+    SpanKind as _SpanKind,
+    Link as _Link,
+)
+
+if TYPE_CHECKING:
+    from corehttp.instrumentation.tracing import Link, SpanKind
+
+
+_DEFAULT_SCHEMA_URL = "https://opentelemetry.io/schemas/1.23.1"
+_DEFAULT_MODULE_NAME = "corehttp"
+
+_KIND_MAPPINGS = {
+    _SpanKind.CLIENT: OpenTelemetrySpanKind.CLIENT,
+    _SpanKind.CONSUMER: OpenTelemetrySpanKind.CONSUMER,
+    _SpanKind.PRODUCER: OpenTelemetrySpanKind.PRODUCER,
+    _SpanKind.SERVER: OpenTelemetrySpanKind.SERVER,
+    _SpanKind.INTERNAL: OpenTelemetrySpanKind.INTERNAL,
+    _SpanKind.UNSPECIFIED: OpenTelemetrySpanKind.INTERNAL,
+}
+
+
+class OpenTelemetryTracer:
+    """A tracer that uses OpenTelemetry to trace operations.
+
+    :keyword library_name: The name of the library to use in the tracer.
+    :paramtype library_name: str
+    :keyword library_version: The version of the library to use in the tracer.
+    :paramtype library_version: str
+    :keyword schema_url: Specifies the Schema URL of the emitted spans. Defaults to
+        "https://opentelemetry.io/schemas/1.23.1".
+    :paramtype schema_url: str
+    :keyword attributes: Attributes to add to the emitted spans.
+    """
+
+    def __init__(
+        self,
+        *,
+        library_name: Optional[str] = None,
+        library_version: Optional[str] = None,
+        schema_url: Optional[str] = None,
+        attributes: Optional[Attributes] = None,
+    ) -> None:
+        self._tracer = trace.get_tracer(
+            instrumenting_module_name=library_name or _DEFAULT_MODULE_NAME,
+            instrumenting_library_version=library_version or VERSION,
+            schema_url=schema_url or _DEFAULT_SCHEMA_URL,
+            attributes=attributes,
+        )
+
+    def start_span(
+        self,
+        name: str,
+        *,
+        kind: SpanKind = _SpanKind.INTERNAL,
+        attributes: Optional[Attributes] = None,
+        links: Optional[Sequence[Link]] = None,
+        start_time: Optional[int] = None,
+        context: Optional[Dict[str, Any]] = None,
+    ) -> Span:
+        """Starts a span without setting it as the current span in the context.
+
+        :param name: The name of the span
+        :type name: str
+        :keyword kind: The kind of the span. INTERNAL by default.
+        :paramtype kind: ~corehttp.instrumentation.tracing.SpanKind
+        :keyword attributes: Attributes to add to the span.
+        :paramtype attributes: Mapping[str, AttributeValue]
+        :keyword links: Links to add to the span.
+        :paramtype links: list[~corehttp.instrumentation.tracing.Link]
+        :keyword start_time: The start time of the span in nanoseconds since the epoch.
+        :paramtype start_time: Optional[int]
+        :keyword context: A dictionary of context values corresponding to the parent span. If not provided,
+          the current global context will be used.
+        :paramtype context: Optional[Dict[str, any]]
+        :return: The span that was started
+        :rtype: ~opentelemetry.trace.Span
+        """
+        otel_kind = _KIND_MAPPINGS.get(kind, OpenTelemetrySpanKind.INTERNAL)
+        otel_links = self._parse_links(links)
+
+        otel_context = None
+        if context:
+            otel_context = extract(context)
+
+        otel_span = self._tracer.start_span(
+            name,
+            context=otel_context,
+            kind=otel_kind,
+            attributes=attributes,
+            links=otel_links,
+            start_time=start_time,
+            record_exception=False,
+        )
+
+        return otel_span
+
+    @contextmanager
+    def start_as_current_span(
+        self,
+        name: str,
+        *,
+        kind: SpanKind = _SpanKind.INTERNAL,
+        attributes: Optional[Attributes] = None,
+        links: Optional[Sequence[Link]] = None,
+        start_time: Optional[int] = None,
+        context: Optional[Dict[str, Any]] = None,
+        end_on_exit: bool = True,
+    ) -> Iterator[Span]:
+        """Context manager that starts a span and sets it as the current span in the context.
+
+        .. code:: python
+
+            with tracer.start_as_current_span("span_name") as span:
+                # Do something with the span
+                span.set_attribute("key", "value")
+
+        :param name: The name of the span
+        :type name: str
+        :keyword kind: The kind of the span. INTERNAL by default.
+        :paramtype kind: ~corehttp.instrumentation.tracing.SpanKind
+        :keyword attributes: Attributes to add to the span.
+        :paramtype attributes: Optional[Attributes]
+        :keyword links: Links to add to the span.
+        :paramtype links: Optional[Sequence[Link]]
+        :keyword start_time: The start time of the span in nanoseconds since the epoch.
+        :paramtype start_time: Optional[int]
+        :keyword context: A dictionary of context values corresponding to the parent span. If not provided,
+          the current global context will be used.
+        :paramtype context: Optional[Dict[str, any]]
+        :keyword end_on_exit: Whether to end the span when exiting the context manager. Defaults to True.
+        :paramtype end_on_exit: bool
+        :return: The span that was started
+        :rtype: Iterator[~opentelemetry.trace.Span]
+        """
+        span = self.start_span(
+            name, kind=kind, attributes=attributes, links=links, start_time=start_time, context=context
+        )
+        with trace.use_span(  # pylint: disable=not-context-manager
+            span, record_exception=False, end_on_exit=end_on_exit
+        ) as span:
+            yield span
+
+    @classmethod
+    @contextmanager
+    def use_span(cls, span: Span, *, end_on_exit: bool = True) -> Iterator[Span]:
+        """Context manager that takes a non-active span and activates it in the current context.
+
+        :param span: The span to set as the current span
+        :type span: ~opentelemetry.trace.Span
+        :keyword end_on_exit: Whether to end the span when exiting the context manager. Defaults to True.
+        :paramtype end_on_exit: bool
+        :return: The span that was activated.
+        :rtype: Iterator[~opentelemetry.trace.Span]
+        """
+        with trace.use_span(  # pylint: disable=not-context-manager
+            span, record_exception=False, end_on_exit=end_on_exit
+        ) as active_span:
+            yield active_span
+
+    @staticmethod
+    def set_span_error_status(span: Span, description: Optional[str] = None) -> None:
+        """Set the status of a span to ERROR with the provided description, if any.
+
+        :param span: The span to set the ERROR status on.
+        :type span: ~opentelemetry.trace.Span
+        :param description: An optional description of the error.
+        :type description: str
+        """
+        span.set_status(StatusCode.ERROR, description=description)
+
+    def _parse_links(self, links: Optional[Sequence[Link]]) -> Optional[Sequence[OpenTelemetryLink]]:
+        if not links:
+            return None
+
+        try:
+            otel_links = []
+            for link in links:
+                ctx = extract(link.headers)
+                span_ctx = get_current_span_otel(ctx).get_span_context()
+                otel_links.append(OpenTelemetryLink(span_ctx, link.attributes))
+            return otel_links
+        except AttributeError:
+            # We will just send the links as is if it's not ~corehttp.instrumentation.tracing.Link without
+            # any validation assuming the user knows what they are doing.
+            return cast(Sequence[OpenTelemetryLink], links)
+
+    @classmethod
+    def get_current_span(cls) -> Span:
+        """Returns the current span in the context.
+
+        :return: The current span
+        :rtype: ~opentelemetry.trace.Span
+        """
+        return get_current_span_otel()
+
+    @classmethod
+    def with_current_context(cls, func: Callable) -> Callable:
+        """Passes the current spans to the new context the function will be run in.
+
+        :param func: The function that will be run in the new context
+        :type func: callable
+        :return: The wrapped function
+        :rtype: callable
+        """
+        current_context = otel_context_module.get_current()
+
+        def call_with_current_context(*args, **kwargs):
+            token = None
+            try:
+                token = otel_context_module.attach(current_context)
+                return func(*args, **kwargs)
+            finally:
+                if token is not None:
+                    otel_context_module.detach(token)
+
+        return call_with_current_context
+
+    @classmethod
+    def get_trace_context(cls) -> Dict[str, str]:
+        """Returns the Trace Context header values associated with the current span.
+
+        These are generally the W3C Trace Context headers (i.e. "traceparent" and "tracestate").
+        :return: A key value pair dictionary
+        :rtype: dict[str, str]
+        """
+        trace_context: Dict[str, str] = {}
+        inject(trace_context)
+        return trace_context
+
+    @classmethod
+    def _suppress_auto_http_instrumentation(cls) -> Token:
+        """Enabled automatic HTTP instrumentation suppression.
+
+        Since corehttp already instruments HTTP calls, we need to suppress any automatic HTTP
+        instrumentation provided by other libraries to prevent duplicate spans. This has no effect if no
+        automatic HTTP instrumentation libraries are being used.
+
+        :return: A token that can be used to detach the suppression key from the context
+        :rtype: ~contextvars.Token
+        """
+        return otel_context_module.attach(otel_context_module.set_value(_SUPPRESS_HTTP_INSTRUMENTATION_KEY, True))
+
+    @classmethod
+    def _detach_from_context(cls, token: Token) -> None:
+        """Detach a token from the context.
+
+        :param token: The token to detach
+        :type token: ~contextvars.Token
+        """
+        otel_context_module.detach(token)