opentelemetry-js/modules/_opentelemetry_instrumentat...

3 lines
18 KiB
HTML

<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>&lt;internal&gt; | OpenTelemetry SDK</title><meta name="description" content="Documentation for OpenTelemetry SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">OpenTelemetry SDK</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../index.html">OpenTelemetry SDK</a></li><li><a href="_opentelemetry_instrumentation_xml_http_request.html">@opentelemetry/instrumentation-xml-http-request</a></li><li><a href="_opentelemetry_instrumentation_xml_http_request._internal_.html">&lt;internal&gt;</a></li></ul><h1>Module &lt;internal&gt; </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/_opentelemetry_instrumentation_xml_http_request._internal_.XhrMem.html" class="tsd-kind-icon">Xhr<wbr/>Mem</a></li></ul></section><section class="tsd-index-section "><h3>Type Aliases</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_opentelemetry_instrumentation_xml_http_request._internal_.html#OpenFunction" class="tsd-kind-icon">Open<wbr/>Function</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_opentelemetry_instrumentation_xml_http_request._internal_.html#PropagateTraceHeaderCorsUrl" class="tsd-kind-icon">Propagate<wbr/>Trace<wbr/>Header<wbr/>Cors<wbr/>Url</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_opentelemetry_instrumentation_xml_http_request._internal_.html#PropagateTraceHeaderCorsUrls" class="tsd-kind-icon">Propagate<wbr/>Trace<wbr/>Header<wbr/>Cors<wbr/>Urls</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Type Aliases</h2><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="OpenFunction" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Open<wbr/>Function<a href="#OpenFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Open<wbr/>Function<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>method<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, async<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, user<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span>, pass<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/3920b15/experimental/packages/opentelemetry-instrumentation-xml-http-request/src/types.ts#L22">experimental/packages/opentelemetry-instrumentation-xml-http-request/src/types.ts:22</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>method<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, async<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, user<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span>, pass<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
<p>method &quot;open&quot; from XMLHttpRequest</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>method: <span class="tsd-signature-type">string</span></h5></li><li><h5>url: <span class="tsd-signature-type">string</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> async: <span class="tsd-signature-type">boolean</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> user: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> pass: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="PropagateTraceHeaderCorsUrl" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Propagate<wbr/>Trace<wbr/>Header<wbr/>Cors<wbr/>Url<a href="#PropagateTraceHeaderCorsUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Propagate<wbr/>Trace<wbr/>Header<wbr/>Cors<wbr/>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">RegExp</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/3920b15/experimental/packages/opentelemetry-instrumentation-xml-http-request/src/types.ts#L69">experimental/packages/opentelemetry-instrumentation-xml-http-request/src/types.ts:69</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="PropagateTraceHeaderCorsUrls" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Propagate<wbr/>Trace<wbr/>Header<wbr/>Cors<wbr/>Urls<a href="#PropagateTraceHeaderCorsUrls" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Propagate<wbr/>Trace<wbr/>Header<wbr/>Cors<wbr/>Urls<span class="tsd-signature-symbol">:</span> <a href="_opentelemetry_instrumentation_xml_http_request._internal_.html#PropagateTraceHeaderCorsUrl" class="tsd-signature-type" data-tsd-kind="Type alias">PropagateTraceHeaderCorsUrl</a><span class="tsd-signature-symbol"> | </span><a href="_opentelemetry_instrumentation_xml_http_request._internal_.html#PropagateTraceHeaderCorsUrl" class="tsd-signature-type" data-tsd-kind="Type alias">PropagateTraceHeaderCorsUrl</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/3920b15/experimental/packages/opentelemetry-instrumentation-xml-http-request/src/types.ts#L71">experimental/packages/opentelemetry-instrumentation-xml-http-request/src/types.ts:71</a></li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../index.html">Modules</a></li><li class=" tsd-kind-module"><a href="_opentelemetry_api.html">@opentelemetry/api</a></li><li class=" tsd-kind-module"><a href="_opentelemetry_api_events.html">@opentelemetry/api-<wbr/>events</a></li><li class=" tsd-kind-module"><a href="_opentelemetry_api_logs.html">@opentelemetry/api-<wbr/>logs</a></li><li class=" tsd-kind-module"><a href="_opentelemetry_context_async_hooks.html">@opentelemetry/context-<wbr/>async-<wbr/>hooks</a></li><li class=" tsd-kind-module"><a href="_opentelemetry_context_zone_peer_dep.html">@opentelemetry/context-<wbr/>zone-<wbr/>peer-<wbr/>dep</a></li><li class=" tsd-kind-module"><a href="_opentelemetry_core.html">@opentelemetry/core</a></li><li class=" tsd-kind-module"><a href="_opentelemetry_exporter_jaeger.html">@opentelemetry/exporter-<wbr/>jaeger</a></li><li class=" tsd-kind-module"><a href="_opentelemetry_exporter_logs_otlp_grpc.html">@opentelemetry/exporter-<wbr/>logs-<wbr/>otlp-<wbr/>grpc</a></li><li class=" tsd-kind-module"><a href="_opentelemetry_exporter_logs_otlp_http.html">@opentelemetry/exporter-<wbr/>logs-<wbr/>otlp-<wbr/>http</a></li><li class=" tsd-kind-module"><a href="_opentelemetry_exporter_logs_otlp_proto.html">@opentelemetry/exporter-<wbr/>logs-<wbr/>otlp-<wbr/>proto</a></li><li class=" tsd-kind-module"><a href="_opentelemetry_exporter_metrics_otlp_grpc.html">@opentelemetry/exporter-<wbr/>metrics-<wbr/>otlp-<wbr/>grpc</a></li><li class=" tsd-kind-module"><a href="_opentelemetry_exporter_metrics_otlp_http.html">@opentelemetry/exporter-<wbr/>metrics-<wbr/>otlp-<wbr/>http</a></li><li class=" tsd-kind-module"><a href="_opentelemetry_exporter_metrics_otlp_proto.html">@opentelemetry/exporter-<wbr/>metrics-<wbr/>otlp-<wbr/>proto</a></li><li class=" tsd-kind-module"><a href="_opentelemetry_exporter_prometheus.html">@opentelemetry/exporter-<wbr/>prometheus</a></li><li class=" tsd-kind-module"><a href="_opentelemetry_exporter_trace_otlp_grpc.html">@opentelemetry/exporter-<wbr/>trace-<wbr/>otlp-<wbr/>grpc</a></li><li class=" tsd-kind-module"><a href="_opentelemetry_exporter_trace_otlp_http.html">@opentelemetry/exporter-<wbr/>trace-<wbr/>otlp-<wbr/>http</a></li><li class=" tsd-kind-module"><a href="_opentelemetry_exporter_trace_otlp_proto.html">@opentelemetry/exporter-<wbr/>trace-<wbr/>otlp-<wbr/>proto</a></li><li class=" tsd-kind-module"><a href="_opentelemetry_exporter_zipkin.html">@opentelemetry/exporter-<wbr/>zipkin</a></li><li class=" tsd-kind-module"><a href="_opentelemetry_instrumentation.html">@opentelemetry/instrumentation</a></li><li class=" tsd-kind-module"><a href="_opentelemetry_instrumentation_fetch.html">@opentelemetry/instrumentation-<wbr/>fetch</a></li><li class=" tsd-kind-module"><a href="_opentelemetry_instrumentation_grpc.html">@opentelemetry/instrumentation-<wbr/>grpc</a></li><li class=" tsd-kind-module"><a href="_opentelemetry_instrumentation_http.html">@opentelemetry/instrumentation-<wbr/>http</a></li><li class="current tsd-kind-module"><a href="_opentelemetry_instrumentation_xml_http_request.html">@opentelemetry/instrumentation-<wbr/>xml-<wbr/>http-<wbr/>request</a><ul><li class="current tsd-kind-module tsd-parent-kind-module"><a href="_opentelemetry_instrumentation_xml_http_request._internal_.html">&lt;internal&gt;</a></li></ul></li><li class=" tsd-kind-module"><a href="_opentelemetry_opentelemetry_browser_detector.html">@opentelemetry/opentelemetry-<wbr/>browser-<wbr/>detector</a></li><li class=" tsd-kind-module"><a href="_opentelemetry_otlp_exporter_base.html">@opentelemetry/otlp-<wbr/>exporter-<wbr/>base</a></li><li class=" tsd-kind-module"><a href="_opentelemetry_otlp_grpc_exporter_base.html">@opentelemetry/otlp-<wbr/>grpc-<wbr/>exporter-<wbr/>base</a></li><li class=" tsd-kind-module"><a href="_opentelemetry_otlp_proto_exporter_base.html">@opentelemetry/otlp-<wbr/>proto-<wbr/>exporter-<wbr/>base</a></li><li class=" tsd-kind-module"><a href="_opentelemetry_otlp_transformer.html">@opentelemetry/otlp-<wbr/>transformer</a></li><li class=" tsd-kind-module"><a href="_opentelemetry_propagator_b3.html">@opentelemetry/propagator-<wbr/>b3</a></li><li class=" tsd-kind-module"><a href="_opentelemetry_propagator_jaeger.html">@opentelemetry/propagator-<wbr/>jaeger</a></li><li class=" tsd-kind-module"><a href="_opentelemetry_resources.html">@opentelemetry/resources</a></li><li class=" tsd-kind-module"><a href="_opentelemetry_sdk_logs.html">@opentelemetry/sdk-<wbr/>logs</a></li><li class=" tsd-kind-module"><a href="_opentelemetry_sdk_metrics.html">@opentelemetry/sdk-<wbr/>metrics</a></li><li class=" tsd-kind-module"><a href="_opentelemetry_sdk_node.html">@opentelemetry/sdk-<wbr/>node</a></li><li class=" tsd-kind-module"><a href="_opentelemetry_sdk_trace_base.html">@opentelemetry/sdk-<wbr/>trace-<wbr/>base</a></li><li class=" tsd-kind-module"><a href="_opentelemetry_sdk_trace_node.html">@opentelemetry/sdk-<wbr/>trace-<wbr/>node</a></li><li class=" tsd-kind-module"><a href="_opentelemetry_sdk_trace_web.html">@opentelemetry/sdk-<wbr/>trace-<wbr/>web</a></li><li class=" tsd-kind-module"><a href="_opentelemetry_semantic_conventions.html">@opentelemetry/semantic-<wbr/>conventions</a></li><li class=" tsd-kind-module"><a href="_opentelemetry_shim_opencensus.html">@opentelemetry/shim-<wbr/>opencensus</a></li><li class=" tsd-kind-module"><a href="_opentelemetry_shim_opentracing.html">@opentelemetry/shim-<wbr/>opentracing</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/_opentelemetry_instrumentation_xml_http_request._internal_.XhrMem.html" class="tsd-kind-icon">Xhr<wbr/>Mem</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_opentelemetry_instrumentation_xml_http_request._internal_.html#OpenFunction" class="tsd-kind-icon">Open<wbr/>Function</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_opentelemetry_instrumentation_xml_http_request._internal_.html#PropagateTraceHeaderCorsUrl" class="tsd-kind-icon">Propagate<wbr/>Trace<wbr/>Header<wbr/>Cors<wbr/>Url</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_opentelemetry_instrumentation_xml_http_request._internal_.html#PropagateTraceHeaderCorsUrls" class="tsd-kind-icon">Propagate<wbr/>Trace<wbr/>Header<wbr/>Cors<wbr/>Urls</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li><li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li><li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>