o g@sVdZddlmZddlZddlZddlmZddlmZddl m Z ddlm Z m Z m Z mZmZddlmZdd lmZmZdd lmZmZmZmZmZmZmZmZmZmZm Z m!Z!m"Z"m#Z#m$Z$m%Z%m&Z&m'Z'm(Z(m)Z)m*Z*m+Z+m,Z,dd l-m.Z.m/Z/m0Z0dd l1m2Z2dd l3m4Z4ddl5m6Z6ddl7m8Z8ddl9m:Z:m;Z;ddlZ>m?Z?ddl@mAZAddlBmCZCddlDmEZEddlFmGZGddlHmIZImJZJmKZKmLZLmMZMmNZNmOZOmPZPmQZQmRZRGddde:eSZTeTZUGddde;eSZVeVZWe,jXfddZYd>d'd(ZZd)d*Z[de,jXfd+d,Z\d?d0d1Z]d@d4d5Z^Gd6d7d7Z_e,jXfd8d9Z`e,jXfd:d;Zad`_. Request headers *************** To capture HTTP request headers as span attributes, set the environment variable ``OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST`` to a comma delimited list of HTTP header names. For example, :: export OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST="content-type,custom_request_header" will extract ``content-type`` and ``custom_request_header`` from the request headers and add them as span attributes. Request header names in ASGI are case-insensitive. So, giving the header name as ``CUStom-Header`` in the environment variable will capture the header named ``custom-header``. Regular expressions may also be used to match multiple headers that correspond to the given pattern. For example: :: export OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST="Accept.*,X-.*" Would match all request headers that start with ``Accept`` and ``X-``. To capture all request headers, set ``OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST`` to ``".*"``. :: export OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST=".*" The name of the added span attribute will follow the format ``http.request.header.`` where ```` is the normalized HTTP header name (lowercase, with ``-`` replaced by ``_``). The value of the attribute will be a list containing the header values. For example: ``http.request.header.custom_request_header = ["", ""]`` Response headers **************** To capture HTTP response headers as span attributes, set the environment variable ``OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_RESPONSE`` to a comma delimited list of HTTP header names. For example, :: export OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_RESPONSE="content-type,custom_response_header" will extract ``content-type`` and ``custom_response_header`` from the response headers and add them as span attributes. Response header names in ASGI are case-insensitive. So, giving the header name as ``CUStom-Header`` in the environment variable will capture the header named ``custom-header``. Regular expressions may also be used to match multiple headers that correspond to the given pattern. For example: :: export OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_RESPONSE="Content.*,X-.*" Would match all response headers that start with ``Content`` and ``X-``. To capture all response headers, set ``OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_RESPONSE`` to ``".*"``. :: export OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_RESPONSE=".*" The name of the added span attribute will follow the format ``http.response.header.`` where ```` is the normalized HTTP header name (lowercase, with ``-`` replaced by ``_``). The value of the attribute will be a list containing the header values. For example: ``http.response.header.custom_response_header = ["", ""]`` Sanitizing headers ****************** In order to prevent storing sensitive data such as personally identifiable information (PII), session keys, passwords, etc, set the environment variable ``OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SANITIZE_FIELDS`` to a comma delimited list of HTTP header names to be sanitized. Regexes may be used, and all header names will be matched in a case-insensitive manner. For example, :: export OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SANITIZE_FIELDS=".*session.*,set-cookie" will replace the value of headers such as ``session-id`` and ``set-cookie`` with ``[REDACTED]`` in the span. Note: The environment variable names used to capture HTTP headers are still experimental, and thus are subject to change. API --- ) annotationsN) defaultdictwraps) default_timer)Any AwaitableCallable DefaultDictTuple)guarantee_single_callable)contexttrace))_filter_semconv_active_request_count_attr_filter_semconv_duration_attrs_get_schema_url)_OpenTelemetrySemanticConventionStability!_OpenTelemetryStabilitySignalType _report_new _report_old'_server_active_requests_count_attrs_new'_server_active_requests_count_attrs_old_server_duration_attrs_new_server_duration_attrs_old_set_http_flavor_version_set_http_host_server_set_http_method_set_http_net_host_port_set_http_peer_ip_server_set_http_peer_port_server_set_http_scheme_set_http_target _set_http_url_set_http_user_agent _set_status_StabilityMode)ClientRequestHookClientResponseHookServerRequestHook) __version__)get_global_response_propagator)_start_internal_or_server_span) get_meter)GetterSetter)"create_http_server_active_requests$create_http_server_request_body_size%create_http_server_response_body_size)MetricInstruments)HTTP_SERVER_REQUEST_DURATION)SpanAttributes)set_span_in_context) 9OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SANITIZE_FIELDS8OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST9OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_RESPONSE SanitizeValue_parse_url_queryget_custom_headersnormalise_request_header_namenormalise_response_header_nameremove_url_credentialssanitize_methodc@s eZdZd ddZdd d Zd S) ASGIGettercarrierdictkeystrreturn!typing.Optional[typing.List[str]]cs8|d}|s dSfdd|D}|sdS|S)a/Getter implementation to retrieve a HTTP header value from the ASGI scope. Args: carrier: ASGI scope object key: header name in scope Returns: A list with a single string with the header value if it exists, else None. headersNcs(g|]\}}t|krt|qS)_decode_header_itemlower.0_key_valuerCrHb/var/www/visachat/venv/lib/python3.10/site-packages/opentelemetry/instrumentation/asgi/__init__.py s z"ASGIGetter.get..)getrJ)selfrArCrGdecodedrHrOrPrR s  zASGIGetter.gettyping.List[str]cCs|dpg}dd|DS)NrGcSsg|]\}}t|qSrH)rIrKrHrHrPrQ)sz#ASGIGetter.keys..)rR)rSrArGrHrHrPkeys'szASGIGetter.keysN)rArBrCrDrErF)rArBrErU)__name__ __module__ __qualname__rRrVrHrHrHrPr@ s r@c@seZdZd dd Zd S) ASGISetterrArBrCrDvaluerENonecCs8|d}|s g}||d<|||gdS)aNSets response header values on an ASGI scope according to `the spec `_. Args: carrier: ASGI scope object key: response header name to set value: response header value Returns: None rGN)rRappendrJencode)rSrArCr[rGrHrHrPset0s zASGISetter.setN)rArBrCrDr[rDrEr\)rWrXrYr_rHrHrHrPrZ/srZc Cst|\}}}|d}|r$|r$t|tr|d}|dtj|7}i}|d}|r3t||||r;t ||||rCt ||||d}|rPt ||||d} | r_t || | |||rnt |rnt|t|tj|dd} | rt|| t| |t|d } | rt |rd | |tj<t|d } | rt|| d |d |vr|d durt||d d |t||d d|dd|D}|S)zyCollects HTTP request attributes from the ASGI scope and returns a dictionary to be used as span creation attributes. query_stringutf8?scheme http_versionpathmethodhost,z user-agentrclientNcSsi|] \}}|dur||qSNrH)rLkvrHrHrP sz.collect_request_attributes..)get_host_port_url_tuplerR isinstancebytesdecodeurllibparseunquoter rrrr!rr"r>r%DEFAULTrr? asgi_getterjoinr4HTTP_SERVER_NAMEr#rritems) scopesem_conv_opt_in_mode server_hostporthttp_urlr`resultrcflavorre http_methodhttp_host_value_listhttp_user_agentrHrHrPcollect_request_attributesFsn              rscope_or_response_messagedict[str, Any]sanitizer9header_regexes list[str]normalize_namesCallable[[str], str]rEdict[str, list[str]]cCsHtt}|d}|r|D]\}}|t|t|q ||||S)a' Returns custom HTTP request or response headers to be added into SERVER span as span attributes. Refer specifications: - https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/http.md#http-request-and-response-headers rG)rlistrRrIr]sanitize_header_values)rrrrrG raw_headersrCr[rHrHrP!collect_custom_headers_attributess   rcCsl|dpddg}|d}|dt|dkrdt|nd}|d d}|d d d ||}|||fS) z%Returns (host, port, full_url) tuple.serverz0.0.0.0Prkr80:rgrerchttpz://)rRrD)r|rrr~ full_pathrrHrHrPrps $  rpcCsPt|}zt|}Wn tyd}Ynw|duri}t||||d|ddS)zEAdds HTTP response attributes to span using the status_code argument.NT) server_spanr})rDint ValueErrorr$)span status_codemetric_attributesr}status_code_strrHrHrPset_status_codes    rr|rBTuple[str, dict]cCs^|dd}t|dd}|dkrd}|r%|r%|d|ifS|r+|ifS|ifS)a Default span name is the HTTP method and URL path, or just the method. https://github.com/open-telemetry/opentelemetry-specification/pull/3165 https://opentelemetry.io/docs/reference/specification/trace/semantic_conventions/http/#name Args: scope: the ASGI scope dictionary Returns: a tuple of the span name, and any attributes to attach to the span. rergrf_OTHERHTTP )rRstripr?)r|rerfrHrHrPget_default_span_detailss rtyping.Dict[str, typing.Any]typing.Optional[str]cCs6|dd}|d}t|dd}|r||SdS)a  Returns the target path as defined by the Semantic Conventions. This value is suitable to use in metrics as it should replace concrete values with a parameterized name. Example: /api/users/{user_id} Refer to the specification https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/semantic_conventions/http-metrics.md#parameterized-attributes Note: this function requires specific code for each framework, as there's no standard attribute to use. root_pathrgroute path_formatN)rRgetattr)r|rrrrHrHrP_collect_target_attributes    rc@s`eZdZdZ             d#d$ddZd%ddZddZddZdd Zd!d"Z dS)&OpenTelemetryMiddlewareaThe ASGI application middleware. This class is an ASGI middleware that starts and annotates spans for any requests it is invoked with. Args: app: The ASGI application callable to forward requests to. default_span_details: Callback which should return a string and a tuple, representing the desired default span name and a dictionary with any additional span attributes to set. Optional: Defaults to get_default_span_details. server_request_hook: Optional callback which is called with the server span and ASGI scope object for every incoming request. client_request_hook: Optional callback which is called with the internal span, and ASGI scope and event which are sent as dictionaries for when the method receive is called. client_response_hook: Optional callback which is called with the internal span, and ASGI scope and event which are sent as dictionaries for when the method send is called. tracer_provider: The optional tracer provider to use. If omitted the current globally configured one is used. meter_provider: The optional meter provider to use. If omitted the current globally configured one is used. exclude_spans: Optionally exclude HTTP `send` and/or `receive` spans from the trace. Nserver_request_hookr(client_request_hookr&client_response_hookr'#http_capture_headers_server_requestlist[str] | None$http_capture_headers_server_response$http_capture_headers_sanitize_fields exclude_spans.list[typing.Literal['receive', 'send']] | NonecCstttj}t||_| durtjt t |t |dn| |_ | dur/t t t |t |dn| |_d|_t|rD|jjtjddd|_d|_t|rU|jjtddd|_d|_t|rg|jjtjdd d|_d|_t|rtt|j|_d|_t|r|jjtjdd d|_d|_t|rt|j|_t|j|_ ||_!|pt"|_#||_$||_%||_&d|_'||_(| pt)t*pd|_+| pt)t,pd|_-t.| pt)t/pg|_0|rd |vnd |_1|rd |v|_2dSd |_2dS)N) schema_urlmsz/Measures the duration of inbound HTTP requests.)nameunit descriptionz!Duration of HTTP server requests.s)rrrByz9measures the size of HTTP response messages (compressed).z8Measures the size of HTTP request messages (compressed).receiveFsend)3r _initialize(_get_opentelemetry_stability_opt_in_moderrr appr get_tracerrWr)rtracerr,meterduration_histogram_oldrcreate_histogramr2HTTP_SERVER_DURATIONduration_histogram_newrr3server_response_size_histogramHTTP_SERVER_RESPONSE_SIZE#server_response_body_size_histogramr1server_request_size_histogramHTTP_SERVER_REQUEST_SIZE"server_request_body_size_histogramr0r/active_requests_counter excluded_urlsrdefault_span_detailsrrrcontent_length_header_sem_conv_opt_in_moder;r7rr8rr9r6rexclude_receive_spanexclude_send_span)rSrrrrrrtracer_providermeter_providerrrrrrrr}rHrHrP__init__s      z OpenTelemetryMiddleware.__init__r|rr'Callable[[], Awaitable[dict[str, Any]]]r+Callable[[dict[str, Any]], Awaitable[None]]rEr\cst}|ddvr||||IdHSt|\}}}|jr.|j|r.||||IdHS||\}}t||j} | |t |j |d|t | d\} } t | |j} |ddkr`|j d| z/tj| dd`} | r| D] \}}| ||qr| jtjjkr|jrt||j|jtni}t|d kr| |t|jr|| |||||}| | |||| }||||IdHWdn1swYW|ddkr|t!|}|rt"|\}}t#| ||||jt|}t$| t%j&}|r||t'j(<t$| t%j)}|j*r|j*+t,t-|d d ||j.r'|j.+t,|d ||j d | |j/rJ|j0r>|j0+|j/||j1rJ|j1+|j/|t 2|d }|r|zt3|d }Wn t4yeYnw|j5rq|j5+|||j6r||j6+||| rt78| | r| 9dSdS|ddkr.otel_receive)rr)rSrr|rrrHrrPr's z)OpenTelemetryMiddleware._get_otel_receivecCs|jd||ddf?}t|jr|||||r3|ddkr+|dd}|d|d|rEt||d|j Wd|SWd|S1sPwY|S) z)Set send span attributes and status code.rrrhttp.response.starttrailersFrN) rrryrrrrRrrr)rSrr|rrrexpecting_trailers send_spanrHrHrP_set_send_spanBs0      z&OpenTelemetryMiddleware._set_send_spancCsl|r(|jtjjkr(d|vr(|jrt||j|jtni}t |dkr(| ||r4t ||||j dSdS)z+Set server span attributes and status code.rGrN) rrrrrrrrr=rrrr)rSrrrduration_attrscustom_response_attributesrHrHrP_set_server_span`s.  z(OpenTelemetryMiddleware._set_server_spanc s*dtdfdd }|S)NFrrcsd}|ddkr|d}n|ddkrd}js#||||t}|r>|j|ttjt dt |d}|rYz t |d_ Wn tyXYnw|IdHsn|dd krn| d d r|r|dd kr| d d sdSdSdSdS)Nrrstatuszwebsocket.sendr)r setterrrzhttp.response.body more_bodyFzhttp.response.trailers more_trailers)rrrr*injectr5r context_apiContext asgi_setterrxrRrrrr)rr propagatorcontent_lengthrrr|rSrrrrHrPrs`            z9OpenTelemetryMiddleware._get_otel_send..otel_send)rrr)rSrrr|rrrrHr(rPr~s6z&OpenTelemetryMiddleware._get_otel_send) NNNNNNNNNNNNN)rr(rr&rr'rrrrrrrr)r|rrrrrrEr\) rWrXrY__doc__rrrrrrrHrHrHrPrs.   rcCt|tt|Srl)rrr req_attrsr}rHrHrPr rcCr*rl)rrrr+rHrHrPrr-rcCs*z|dWSty|dYSw)Nzutf-8unicode_escape)rsr)r[rHrHrPrIs   rI) rrrr9rrrrrEr)r|rBrEr)r|rrEr)cr) __future__rtypingrt collectionsr functoolsrtimeitrrrr r r asgiref.compatibilityr opentelemetryr r&opentelemetry.instrumentation._semconvrrrrrrrrrrrrrrrrrr r!r"r#r$r%(opentelemetry.instrumentation.asgi.typesr&r'r(*opentelemetry.instrumentation.asgi.versionr))opentelemetry.instrumentation.propagatorsr*#opentelemetry.instrumentation.utilsr+opentelemetry.metricsr,!opentelemetry.propagators.textmapr-r.6opentelemetry.semconv._incubating.metrics.http_metricsr/r0r1opentelemetry.semconv.metricsr2*opentelemetry.semconv.metrics.http_metricsr3opentelemetry.semconv.tracer4opentelemetry.tracer5opentelemetry.util.httpr6r7r8r9r:r;r<r=r>r?rBr@rxrZr%rwrrrprrrrrrrIrHrHrHrPs\ 1    d        0" D  G