open-telemetry
/
opentelemetry-js
mirror of https://github.com/open-telemetry/opentelemetry-js.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
opentelemetry-js/interfaces/_opentelemetry_instrumentat...

43 lines
43 KiB
HTML
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>HttpInstrumentationConfig | 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 defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></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"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">OpenTelemetry SDK</a></li><li><a href="../modules/_opentelemetry_instrumentation-http.html">@opentelemetry/instrumentation-http</a></li><li><a href="_opentelemetry_instrumentation-http.HttpInstrumentationConfig.html">HttpInstrumentationConfig</a></li></ul><h1>Interface HttpInstrumentationConfig</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Options available for the HTTP instrumentation (see <a href="https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-instrumentation-http#http-instrumentation-options">documentation</a>)</p>
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">HttpInstrumentationConfig</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="_opentelemetry_instrumentation-http.HttpInstrumentationConfig.html#applycustomattributesonspan">applyCustomAttributesOnSpan</a><span class="tsd-signature-symbol">?:</span> <a href="_opentelemetry_instrumentation-http.HttpCustomAttributeFunction.html" class="tsd-signature-type tsd-kind-interface">HttpCustomAttributeFunction</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="_opentelemetry_instrumentation-http.HttpInstrumentationConfig.html#disableincomingrequestinstrumentation">disableIncomingRequestInstrumentation</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="_opentelemetry_instrumentation-http.HttpInstrumentationConfig.html#disableoutgoingrequestinstrumentation">disableOutgoingRequestInstrumentation</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="_opentelemetry_instrumentation-http.HttpInstrumentationConfig.html#enabled">enabled</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="_opentelemetry_instrumentation-http.HttpInstrumentationConfig.html#enablesyntheticsourcedetection">enableSyntheticSourceDetection</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="_opentelemetry_instrumentation-http.HttpInstrumentationConfig.html#headerstospanattributes">headersToSpanAttributes</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/>        <span class="tsd-kind-property">client</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">requestHeaders</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">responseHeaders</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">server</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">requestHeaders</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">responseHeaders</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="_opentelemetry_instrumentation-http.HttpInstrumentationConfig.html#ignoreincomingrequesthook">ignoreIncomingRequestHook</a><span class="tsd-signature-symbol">?:</span> <a href="_opentelemetry_instrumentation-http.IgnoreIncomingRequestFunction.html" class="tsd-signature-type tsd-kind-interface">IgnoreIncomingRequestFunction</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="_opentelemetry_instrumentation-http.HttpInstrumentationConfig.html#ignoreoutgoingrequesthook">ignoreOutgoingRequestHook</a><span class="tsd-signature-symbol">?:</span> <a href="_opentelemetry_instrumentation-http.IgnoreOutgoingRequestFunction.html" class="tsd-signature-type tsd-kind-interface">IgnoreOutgoingRequestFunction</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="_opentelemetry_instrumentation-http.HttpInstrumentationConfig.html#redactedqueryparams">redactedQueryParams</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="_opentelemetry_instrumentation-http.HttpInstrumentationConfig.html#requesthook">requestHook</a><span class="tsd-signature-symbol">?:</span> <a href="_opentelemetry_instrumentation-http.HttpRequestCustomAttributeFunction.html" class="tsd-signature-type tsd-kind-interface">HttpRequestCustomAttributeFunction</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="_opentelemetry_instrumentation-http.HttpInstrumentationConfig.html#requireparentforincomingspans">requireParentforIncomingSpans</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="_opentelemetry_instrumentation-http.HttpInstrumentationConfig.html#requireparentforoutgoingspans">requireParentforOutgoingSpans</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="_opentelemetry_instrumentation-http.HttpInstrumentationConfig.html#responsehook">responseHook</a><span class="tsd-signature-symbol">?:</span> <a href="_opentelemetry_instrumentation-http.HttpResponseCustomAttributeFunction.html" class="tsd-signature-type tsd-kind-interface">HttpResponseCustomAttributeFunction</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="_opentelemetry_instrumentation-http.HttpInstrumentationConfig.html#servername">serverName</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="_opentelemetry_instrumentation-http.HttpInstrumentationConfig.html#startincomingspanhook">startIncomingSpanHook</a><span class="tsd-signature-symbol">?:</span> <a href="_opentelemetry_instrumentation-http.StartIncomingSpanCustomAttributeFunction.html" class="tsd-signature-type tsd-kind-interface">StartIncomingSpanCustomAttributeFunction</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="_opentelemetry_instrumentation-http.HttpInstrumentationConfig.html#startoutgoingspanhook">startOutgoingSpanHook</a><span class="tsd-signature-symbol">?:</span> <a href="_opentelemetry_instrumentation-http.StartOutgoingSpanCustomAttributeFunction.html" class="tsd-signature-type tsd-kind-interface">StartOutgoingSpanCustomAttributeFunction</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="8466"><h4>Hierarchy (<a href="../hierarchy.html#@opentelemetry/instrumentation-http.HttpInstrumentationConfig">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="_opentelemetry_instrumentation.InstrumentationConfig.html" class="tsd-signature-type tsd-kind-interface">InstrumentationConfig</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">HttpInstrumentationConfig</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/2d3760898cdc4f0e68f9f956603cc5df279eb3a8/experimental/packages/opentelemetry-instrumentation-http/src/types.ts#L60">opentelemetry-instrumentation-http/src/types.ts:60</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="_opentelemetry_instrumentation-http.HttpInstrumentationConfig.html#applycustomattributesonspan" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>apply<wbr/>Custom<wbr/>Attributes<wbr/>On<wbr/>Span?</span></a>
<a href="_opentelemetry_instrumentation-http.HttpInstrumentationConfig.html#disableincomingrequestinstrumentation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disable<wbr/>Incoming<wbr/>Request<wbr/>Instrumentation?</span></a>
<a href="_opentelemetry_instrumentation-http.HttpInstrumentationConfig.html#disableoutgoingrequestinstrumentation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disable<wbr/>Outgoing<wbr/>Request<wbr/>Instrumentation?</span></a>
<a href="_opentelemetry_instrumentation-http.HttpInstrumentationConfig.html#enabled" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>enabled?</span></a>
<a href="_opentelemetry_instrumentation-http.HttpInstrumentationConfig.html#enablesyntheticsourcedetection" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>enable<wbr/>Synthetic<wbr/>Source<wbr/>Detection?</span></a>
<a href="_opentelemetry_instrumentation-http.HttpInstrumentationConfig.html#headerstospanattributes" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>headers<wbr/>To<wbr/>Span<wbr/>Attributes?</span></a>
<a href="_opentelemetry_instrumentation-http.HttpInstrumentationConfig.html#ignoreincomingrequesthook" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ignore<wbr/>Incoming<wbr/>Request<wbr/>Hook?</span></a>
<a href="_opentelemetry_instrumentation-http.HttpInstrumentationConfig.html#ignoreoutgoingrequesthook" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ignore<wbr/>Outgoing<wbr/>Request<wbr/>Hook?</span></a>
<a href="_opentelemetry_instrumentation-http.HttpInstrumentationConfig.html#redactedqueryparams" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>redacted<wbr/>Query<wbr/>Params?</span></a>
<a href="_opentelemetry_instrumentation-http.HttpInstrumentationConfig.html#requesthook" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request<wbr/>Hook?</span></a>
<a href="_opentelemetry_instrumentation-http.HttpInstrumentationConfig.html#requireparentforincomingspans" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>require<wbr/>Parentfor<wbr/>Incoming<wbr/>Spans?</span></a>
<a href="_opentelemetry_instrumentation-http.HttpInstrumentationConfig.html#requireparentforoutgoingspans" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>require<wbr/>Parentfor<wbr/>Outgoing<wbr/>Spans?</span></a>
<a href="_opentelemetry_instrumentation-http.HttpInstrumentationConfig.html#responsehook" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response<wbr/>Hook?</span></a>
<a href="_opentelemetry_instrumentation-http.HttpInstrumentationConfig.html#servername" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>server<wbr/>Name?</span></a>
<a href="_opentelemetry_instrumentation-http.HttpInstrumentationConfig.html#startincomingspanhook" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>start<wbr/>Incoming<wbr/>Span<wbr/>Hook?</span></a>
<a href="_opentelemetry_instrumentation-http.HttpInstrumentationConfig.html#startoutgoingspanhook" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>start<wbr/>Outgoing<wbr/>Span<wbr/>Hook?</span></a>
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="applycustomattributesonspan" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>apply<wbr/>Custom<wbr/>Attributes<wbr/>On<wbr/>Span</span><a href="#applycustomattributesonspan" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">applyCustomAttributesOnSpan</span><span class="tsd-signature-symbol">?:</span> <a href="_opentelemetry_instrumentation-http.HttpCustomAttributeFunction.html" class="tsd-signature-type tsd-kind-interface">HttpCustomAttributeFunction</a></div><div class="tsd-comment tsd-typography"><p>Function for adding custom attributes after response is handled</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/2d3760898cdc4f0e68f9f956603cc5df279eb3a8/experimental/packages/opentelemetry-instrumentation-http/src/types.ts#L70">opentelemetry-instrumentation-http/src/types.ts:70</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="disableincomingrequestinstrumentation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>disable<wbr/>Incoming<wbr/>Request<wbr/>Instrumentation</span><a href="#disableincomingrequestinstrumentation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">disableIncomingRequestInstrumentation</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>If set to true, incoming requests will not be instrumented at all.</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/2d3760898cdc4f0e68f9f956603cc5df279eb3a8/experimental/packages/opentelemetry-instrumentation-http/src/types.ts#L66">opentelemetry-instrumentation-http/src/types.ts:66</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="disableoutgoingrequestinstrumentation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>disable<wbr/>Outgoing<wbr/>Request<wbr/>Instrumentation</span><a href="#disableoutgoingrequestinstrumentation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">disableOutgoingRequestInstrumentation</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>If set to true, outgoing requests will not be instrumented at all.</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/2d3760898cdc4f0e68f9f956603cc5df279eb3a8/experimental/packages/opentelemetry-instrumentation-http/src/types.ts#L68">opentelemetry-instrumentation-http/src/types.ts:68</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="enabled" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>enabled</span><a href="#enabled" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">enabled</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether to enable the plugin.</p>
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link"><a id="default" class="tsd-anchor"></a>Default<a href="#default" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">true</span>
</code><button type="button">Copy</button></pre>
</div></div><aside class="tsd-sources"><p>Inherited from <a href="_opentelemetry_instrumentation.InstrumentationConfig.html">InstrumentationConfig</a>.<a href="_opentelemetry_instrumentation.InstrumentationConfig.html#enabled">enabled</a></p><ul><li>Defined in opentelemetry-instrumentation/build/src/types.d.ts:35</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="enablesyntheticsourcedetection" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Experimental</code><span>enable<wbr/>Synthetic<wbr/>Source<wbr/>Detection</span><a href="#enablesyntheticsourcedetection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">enableSyntheticSourceDetection</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Enable automatic population of synthetic source type based on the user-agent header</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/2d3760898cdc4f0e68f9f956603cc5df279eb3a8/experimental/packages/opentelemetry-instrumentation-http/src/types.ts#L94">opentelemetry-instrumentation-http/src/types.ts:94</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="headerstospanattributes" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>headers<wbr/>To<wbr/>Span<wbr/>Attributes</span><a href="#headerstospanattributes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">headersToSpanAttributes</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/>    <span class="tsd-kind-property">client</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">requestHeaders</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">responseHeaders</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">server</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">requestHeaders</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">responseHeaders</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Map the following HTTP headers to span attributes.</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/2d3760898cdc4f0e68f9f956603cc5df279eb3a8/experimental/packages/opentelemetry-instrumentation-http/src/types.ts#L86">opentelemetry-instrumentation-http/src/types.ts:86</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="ignoreincomingrequesthook" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>ignore<wbr/>Incoming<wbr/>Request<wbr/>Hook</span><a href="#ignoreincomingrequesthook" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ignoreIncomingRequestHook</span><span class="tsd-signature-symbol">?:</span> <a href="_opentelemetry_instrumentation-http.IgnoreIncomingRequestFunction.html" class="tsd-signature-type tsd-kind-interface">IgnoreIncomingRequestFunction</a></div><div class="tsd-comment tsd-typography"><p>Not trace all incoming requests that matched with custom function</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/2d3760898cdc4f0e68f9f956603cc5df279eb3a8/experimental/packages/opentelemetry-instrumentation-http/src/types.ts#L62">opentelemetry-instrumentation-http/src/types.ts:62</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="ignoreoutgoingrequesthook" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>ignore<wbr/>Outgoing<wbr/>Request<wbr/>Hook</span><a href="#ignoreoutgoingrequesthook" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ignoreOutgoingRequestHook</span><span class="tsd-signature-symbol">?:</span> <a href="_opentelemetry_instrumentation-http.IgnoreOutgoingRequestFunction.html" class="tsd-signature-type tsd-kind-interface">IgnoreOutgoingRequestFunction</a></div><div class="tsd-comment tsd-typography"><p>Not trace all outgoing requests that matched with custom function</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/2d3760898cdc4f0e68f9f956603cc5df279eb3a8/experimental/packages/opentelemetry-instrumentation-http/src/types.ts#L64">opentelemetry-instrumentation-http/src/types.ts:64</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="redactedqueryparams" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Experimental</code><span>redacted<wbr/>Query<wbr/>Params</span><a href="#redactedqueryparams" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">redactedQueryParams</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>[Optional] Additional query parameters to redact.
Use this to specify custom query strings that contain sensitive information.
These will replace/overwrite the default query strings that are to be redacted.</p>
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example" class="tsd-anchor"></a>Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-7">default</span><span class="hl-1"> </span><span class="hl-6">strings</span><span class="hl-1"> [</span><span class="hl-2">&#39;sig&#39;</span><span class="hl-1">,</span><span class="hl-2">&#39;Signature&#39;</span><span class="hl-1">,</span><span class="hl-2">&#39;AWSAccessKeyId&#39;</span><span class="hl-1">,</span><span class="hl-2">&#39;X-Goog-Signature&#39;</span><span class="hl-1">]</span><br/><span class="hl-1">@</span><span class="hl-6">experimental</span>
</code><button type="button">Copy</button></pre>
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/2d3760898cdc4f0e68f9f956603cc5df279eb3a8/experimental/packages/opentelemetry-instrumentation-http/src/types.ts#L102">opentelemetry-instrumentation-http/src/types.ts:102</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="requesthook" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>request<wbr/>Hook</span><a href="#requesthook" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">requestHook</span><span class="tsd-signature-symbol">?:</span> <a href="_opentelemetry_instrumentation-http.HttpRequestCustomAttributeFunction.html" class="tsd-signature-type tsd-kind-interface">HttpRequestCustomAttributeFunction</a></div><div class="tsd-comment tsd-typography"><p>Function for adding custom attributes before request is handled</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/2d3760898cdc4f0e68f9f956603cc5df279eb3a8/experimental/packages/opentelemetry-instrumentation-http/src/types.ts#L72">opentelemetry-instrumentation-http/src/types.ts:72</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="requireparentforincomingspans" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>require<wbr/>Parentfor<wbr/>Incoming<wbr/>Spans</span><a href="#requireparentforincomingspans" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">requireParentforIncomingSpans</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Require parent to create span for incoming requests</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/2d3760898cdc4f0e68f9f956603cc5df279eb3a8/experimental/packages/opentelemetry-instrumentation-http/src/types.ts#L84">opentelemetry-instrumentation-http/src/types.ts:84</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="requireparentforoutgoingspans" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>require<wbr/>Parentfor<wbr/>Outgoing<wbr/>Spans</span><a href="#requireparentforoutgoingspans" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">requireParentforOutgoingSpans</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Require parent to create span for outgoing requests</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/2d3760898cdc4f0e68f9f956603cc5df279eb3a8/experimental/packages/opentelemetry-instrumentation-http/src/types.ts#L82">opentelemetry-instrumentation-http/src/types.ts:82</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="responsehook" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>response<wbr/>Hook</span><a href="#responsehook" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">responseHook</span><span class="tsd-signature-symbol">?:</span> <a href="_opentelemetry_instrumentation-http.HttpResponseCustomAttributeFunction.html" class="tsd-signature-type tsd-kind-interface">HttpResponseCustomAttributeFunction</a></div><div class="tsd-comment tsd-typography"><p>Function for adding custom attributes before response is handled</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/2d3760898cdc4f0e68f9f956603cc5df279eb3a8/experimental/packages/opentelemetry-instrumentation-http/src/types.ts#L74">opentelemetry-instrumentation-http/src/types.ts:74</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="servername" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>server<wbr/>Name</span><a href="#servername" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">serverName</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The primary server name of the matched virtual host.</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/2d3760898cdc4f0e68f9f956603cc5df279eb3a8/experimental/packages/opentelemetry-instrumentation-http/src/types.ts#L80">opentelemetry-instrumentation-http/src/types.ts:80</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="startincomingspanhook" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>start<wbr/>Incoming<wbr/>Span<wbr/>Hook</span><a href="#startincomingspanhook" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">startIncomingSpanHook</span><span class="tsd-signature-symbol">?:</span> <a href="_opentelemetry_instrumentation-http.StartIncomingSpanCustomAttributeFunction.html" class="tsd-signature-type tsd-kind-interface">StartIncomingSpanCustomAttributeFunction</a></div><div class="tsd-comment tsd-typography"><p>Function for adding custom attributes before a span is started in incomingRequest</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/2d3760898cdc4f0e68f9f956603cc5df279eb3a8/experimental/packages/opentelemetry-instrumentation-http/src/types.ts#L76">opentelemetry-instrumentation-http/src/types.ts:76</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="startoutgoingspanhook" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>start<wbr/>Outgoing<wbr/>Span<wbr/>Hook</span><a href="#startoutgoingspanhook" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">startOutgoingSpanHook</span><span class="tsd-signature-symbol">?:</span> <a href="_opentelemetry_instrumentation-http.StartOutgoingSpanCustomAttributeFunction.html" class="tsd-signature-type tsd-kind-interface">StartOutgoingSpanCustomAttributeFunction</a></div><div class="tsd-comment tsd-typography"><p>Function for adding custom attributes before a span is started in outgoingRequest</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/2d3760898cdc4f0e68f9f956603cc5df279eb3a8/experimental/packages/opentelemetry-instrumentation-http/src/types.ts#L78">opentelemetry-instrumentation-http/src/types.ts:78</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#applycustomattributesonspan" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>apply<wbr/>Custom<wbr/>Attributes<wbr/>On<wbr/>Span</span></a><a href="#disableincomingrequestinstrumentation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disable<wbr/>Incoming<wbr/>Request<wbr/>Instrumentation</span></a><a href="#disableoutgoingrequestinstrumentation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disable<wbr/>Outgoing<wbr/>Request<wbr/>Instrumentation</span></a><a href="#enabled" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>enabled</span></a><a href="#enablesyntheticsourcedetection" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>enable<wbr/>Synthetic<wbr/>Source<wbr/>Detection</span></a><a href="#headerstospanattributes" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>headers<wbr/>To<wbr/>Span<wbr/>Attributes</span></a><a href="#ignoreincomingrequesthook" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ignore<wbr/>Incoming<wbr/>Request<wbr/>Hook</span></a><a href="#ignoreoutgoingrequesthook" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ignore<wbr/>Outgoing<wbr/>Request<wbr/>Hook</span></a><a href="#redactedqueryparams" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>redacted<wbr/>Query<wbr/>Params</span></a><a href="#requesthook" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request<wbr/>Hook</span></a><a href="#requireparentforincomingspans" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>require<wbr/>Parentfor<wbr/>Incoming<wbr/>Spans</span></a><a href="#requireparentforoutgoingspans" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>require<wbr/>Parentfor<wbr/>Outgoing<wbr/>Spans</span></a><a href="#responsehook" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response<wbr/>Hook</span></a><a href="#servername" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>server<wbr/>Name</span></a><a href="#startincomingspanhook" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>start<wbr/>Incoming<wbr/>Span<wbr/>Hook</span></a><a href="#startoutgoingspanhook" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>start<wbr/>Outgoing<wbr/>Span<wbr/>Hook</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html">OpenTelemetry SDK</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
Reference in New Issue View Git Blame Copy Permalink