Shortcuts on this page
r m x toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
1# --------------------------------------------------------------------------
2#
3# Copyright (c) Microsoft Corporation. All rights reserved.
4#
5# The MIT License (MIT)
6#
7# Permission is hereby granted, free of charge, to any person obtaining a copy
8# of this software and associated documentation files (the ""Software""), to deal
9# in the Software without restriction, including without limitation the rights
10# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11# copies of the Software, and to permit persons to whom the Software is
12# furnished to do so, subject to the following conditions:
13#
14# The above copyright notice and this permission notice shall be included in
15# all copies or substantial portions of the Software.
16#
17# THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23# THE SOFTWARE.
24#
25# --------------------------------------------------------------------------
26"""Traces network calls using the implementation library from the settings."""
27import logging
28import sys
29import urllib.parse
30from typing import TYPE_CHECKING, Optional, Tuple, TypeVar, Union, Any, Type
31from types import TracebackType
33from azure.core.pipeline import PipelineRequest, PipelineResponse
34from azure.core.pipeline.policies import SansIOHTTPPolicy
35from azure.core.pipeline.transport import HttpResponse as LegacyHttpResponse, HttpRequest as LegacyHttpRequest
36from azure.core.rest import HttpResponse, HttpRequest
37from azure.core.settings import settings
38from azure.core.tracing import SpanKind
40if TYPE_CHECKING:
41 from azure.core.tracing._abstract_span import (
42 AbstractSpan,
43 )
45HTTPResponseType = TypeVar("HTTPResponseType", HttpResponse, LegacyHttpResponse)
46HTTPRequestType = TypeVar("HTTPRequestType", HttpRequest, LegacyHttpRequest)
47ExcInfo = Tuple[Type[BaseException], BaseException, TracebackType]
48OptExcInfo = Union[ExcInfo, Tuple[None, None, None]]
50_LOGGER = logging.getLogger(__name__)
53def _default_network_span_namer(http_request: HTTPRequestType) -> str:
54 """Extract the path to be used as network span name.
56 :param http_request: The HTTP request
57 :type http_request: ~azure.core.pipeline.transport.HttpRequest
58 :returns: The string to use as network span name
59 :rtype: str
60 """
61 path = urllib.parse.urlparse(http_request.url).path
62 if not path:
63 path = "/"
64 return path
67class DistributedTracingPolicy(SansIOHTTPPolicy[HTTPRequestType, HTTPResponseType]):
68 """The policy to create spans for Azure calls.
70 :keyword network_span_namer: A callable to customize the span name
71 :type network_span_namer: callable[[~azure.core.pipeline.transport.HttpRequest], str]
72 :keyword tracing_attributes: Attributes to set on all created spans
73 :type tracing_attributes: dict[str, str]
74 """
76 TRACING_CONTEXT = "TRACING_CONTEXT"
77 _REQUEST_ID = "x-ms-client-request-id"
78 _RESPONSE_ID = "x-ms-request-id"
79 _HTTP_RESEND_COUNT = "http.request.resend_count"
81 def __init__(self, **kwargs: Any):
82 self._network_span_namer = kwargs.get("network_span_namer", _default_network_span_namer)
83 self._tracing_attributes = kwargs.get("tracing_attributes", {})
85 def on_request(self, request: PipelineRequest[HTTPRequestType]) -> None:
86 ctxt = request.context.options
87 try:
88 span_impl_type = settings.tracing_implementation()
89 if span_impl_type is None:
90 return
92 namer = ctxt.pop("network_span_namer", self._network_span_namer)
93 span_name = namer(request.http_request)
95 span = span_impl_type(name=span_name, kind=SpanKind.CLIENT)
96 for attr, value in self._tracing_attributes.items():
97 span.add_attribute(attr, value)
98 span.start()
100 headers = span.to_header()
101 request.http_request.headers.update(headers)
103 request.context[self.TRACING_CONTEXT] = span
104 except Exception as err: # pylint: disable=broad-except
105 _LOGGER.warning("Unable to start network span: %s", err)
107 def end_span(
108 self,
109 request: PipelineRequest[HTTPRequestType],
110 response: Optional[HTTPResponseType] = None,
111 exc_info: Optional[OptExcInfo] = None,
112 ) -> None:
113 """Ends the span that is tracing the network and updates its status.
115 :param request: The PipelineRequest object
116 :type request: ~azure.core.pipeline.PipelineRequest
117 :param response: The HttpResponse object
118 :type response: ~azure.core.rest.HTTPResponse or ~azure.core.pipeline.transport.HttpResponse
119 :param exc_info: The exception information
120 :type exc_info: tuple
121 """
122 if self.TRACING_CONTEXT not in request.context:
123 return
125 span: "AbstractSpan" = request.context[self.TRACING_CONTEXT]
126 http_request: Union[HttpRequest, LegacyHttpRequest] = request.http_request
127 if span is not None:
128 span.set_http_attributes(http_request, response=response)
129 if request.context.get("retry_count"):
130 span.add_attribute(self._HTTP_RESEND_COUNT, request.context["retry_count"])
131 request_id = http_request.headers.get(self._REQUEST_ID)
132 if request_id is not None:
133 span.add_attribute(self._REQUEST_ID, request_id)
134 if response and self._RESPONSE_ID in response.headers:
135 span.add_attribute(self._RESPONSE_ID, response.headers[self._RESPONSE_ID])
136 if exc_info:
137 span.__exit__(*exc_info)
138 else:
139 span.finish()
141 def on_response(
142 self, request: PipelineRequest[HTTPRequestType], response: PipelineResponse[HTTPRequestType, HTTPResponseType]
143 ) -> None:
144 self.end_span(request, response=response.http_response)
146 def on_exception(self, request: PipelineRequest[HTTPRequestType]) -> None:
147 self.end_span(request, exc_info=sys.exc_info())