33 lines
42 KiB
HTML
33 lines
42 KiB
HTML
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>PeriodicExportingMetricReader | 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_sdk-node.html">@opentelemetry/sdk-node</a></li><li><a href="../modules/_opentelemetry_sdk-node.metrics.html">metrics</a></li><li><a href="_opentelemetry_sdk-node.metrics.PeriodicExportingMetricReader.html">PeriodicExportingMetricReader</a></li></ul><h1>Class PeriodicExportingMetricReader</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p><a href="_opentelemetry_sdk-node.metrics.MetricReader.html" class="tsd-kind-class">MetricReader</a> which collects metrics based on a user-configurable time interval, and passes the metrics to
|
||
the configured <a href="../interfaces/_opentelemetry_sdk-node.metrics.PushMetricExporter.html" class="tsd-kind-interface">PushMetricExporter</a></p>
|
||
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy" data-refl="9795"><h4>Hierarchy (<a href="../hierarchy.html#@opentelemetry/sdk-node.metrics.PeriodicExportingMetricReader">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="../modules/_opentelemetry_sdk-node.metrics.html" class="tsd-signature-type tsd-kind-namespace">metrics</a><span class="tsd-signature-symbol">.</span><a href="_opentelemetry_sdk-node.metrics.MetricReader.html" class="tsd-signature-type tsd-kind-class">MetricReader</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">PeriodicExportingMetricReader</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in packages/sdk-metrics/build/src/export/PeriodicExportingMetricReader.d.ts:30</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">Constructors</h3><div class="tsd-index-list"><a href="_opentelemetry_sdk-node.metrics.PeriodicExportingMetricReader.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
||
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="_opentelemetry_sdk-node.metrics.PeriodicExportingMetricReader.html#collect" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>collect</span></a>
|
||
<a href="_opentelemetry_sdk-node.metrics.PeriodicExportingMetricReader.html#forceflush" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>force<wbr/>Flush</span></a>
|
||
<a href="_opentelemetry_sdk-node.metrics.PeriodicExportingMetricReader.html#onforceflush" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on<wbr/>Force<wbr/>Flush</span></a>
|
||
<a href="_opentelemetry_sdk-node.metrics.PeriodicExportingMetricReader.html#oninitialized" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on<wbr/>Initialized</span></a>
|
||
<a href="_opentelemetry_sdk-node.metrics.PeriodicExportingMetricReader.html#onshutdown" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on<wbr/>Shutdown</span></a>
|
||
<a href="_opentelemetry_sdk-node.metrics.PeriodicExportingMetricReader.html#selectaggregation" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>select<wbr/>Aggregation</span></a>
|
||
<a href="_opentelemetry_sdk-node.metrics.PeriodicExportingMetricReader.html#selectaggregationtemporality" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>select<wbr/>Aggregation<wbr/>Temporality</span></a>
|
||
<a href="_opentelemetry_sdk-node.metrics.PeriodicExportingMetricReader.html#selectcardinalitylimit" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>select<wbr/>Cardinality<wbr/>Limit</span></a>
|
||
<a href="_opentelemetry_sdk-node.metrics.PeriodicExportingMetricReader.html#setmetricproducer" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Metric<wbr/>Producer</span></a>
|
||
<a href="_opentelemetry_sdk-node.metrics.PeriodicExportingMetricReader.html#shutdown" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>shutdown</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-Constructors"><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> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="constructorperiodicexportingmetricreader" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">PeriodicExportingMetricReader</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node.metrics.html" class="tsd-signature-type tsd-kind-namespace">metrics</a><span class="tsd-signature-symbol">.</span><a href="../types/_opentelemetry_sdk-node.metrics.PeriodicExportingMetricReaderOptions.html" class="tsd-signature-type tsd-kind-type-alias">PeriodicExportingMetricReaderOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node.metrics.html" class="tsd-signature-type tsd-kind-namespace">metrics</a><span class="tsd-signature-symbol">.</span><a href="_opentelemetry_sdk-node.metrics.PeriodicExportingMetricReader.html" class="tsd-signature-type tsd-kind-class">PeriodicExportingMetricReader</a><a href="#constructorperiodicexportingmetricreader" 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></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <a href="../modules/_opentelemetry_sdk-node.metrics.html" class="tsd-signature-type tsd-kind-namespace">metrics</a><span class="tsd-signature-symbol">.</span><a href="../types/_opentelemetry_sdk-node.metrics.PeriodicExportingMetricReaderOptions.html" class="tsd-signature-type tsd-kind-type-alias">PeriodicExportingMetricReaderOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../modules/_opentelemetry_sdk-node.metrics.html" class="tsd-signature-type tsd-kind-namespace">metrics</a><span class="tsd-signature-symbol">.</span><a href="_opentelemetry_sdk-node.metrics.PeriodicExportingMetricReader.html" class="tsd-signature-type tsd-kind-class">PeriodicExportingMetricReader</a></h4><aside class="tsd-sources"><p>Overrides <a href="_opentelemetry_sdk-node.metrics.MetricReader.html">MetricReader</a>.<a href="_opentelemetry_sdk-node.metrics.MetricReader.html#constructor">constructor</a></p><ul><li>Defined in packages/sdk-metrics/build/src/export/PeriodicExportingMetricReader.d.ts:35</li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><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> Methods</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="collect" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>collect</span><a href="#collect" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="collect-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">collect</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">CommonReaderOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/_opentelemetry_sdk-node.metrics.html" class="tsd-signature-type tsd-kind-namespace">metrics</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node.metrics.CollectionResult.html" class="tsd-signature-type tsd-kind-interface">CollectionResult</a><span class="tsd-signature-symbol">></span><a href="#collect-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Collect all metrics from the associated <a href="../interfaces/_opentelemetry_sdk-node.metrics.MetricProducer.html" class="tsd-kind-interface">MetricProducer</a></p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">CommonReaderOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/_opentelemetry_sdk-node.metrics.html" class="tsd-signature-type tsd-kind-namespace">metrics</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node.metrics.CollectionResult.html" class="tsd-signature-type tsd-kind-interface">CollectionResult</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="_opentelemetry_sdk-node.metrics.MetricReader.html">MetricReader</a>.<a href="_opentelemetry_sdk-node.metrics.MetricReader.html#collect">collect</a></p><ul><li>Defined in packages/sdk-metrics/build/src/export/MetricReader.d.ts:130</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="forceflush" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>force<wbr/>Flush</span><a href="#forceflush" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="forceflush-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">forceFlush</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">CommonReaderOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#forceflush-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Flushes metrics read by this reader, the promise will reject after the optional timeout or resolve after completion.</p>
|
||
<p> NOTE: this operation MAY continue even after the promise rejects due to a timeout.</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">CommonReaderOptions</span></span><div class="tsd-comment tsd-typography"><p>options with timeout.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="_opentelemetry_sdk-node.metrics.MetricReader.html">MetricReader</a>.<a href="_opentelemetry_sdk-node.metrics.MetricReader.html#forceflush">forceFlush</a></p><ul><li>Defined in packages/sdk-metrics/build/src/export/MetricReader.d.ts:132</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="onforceflush" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>on<wbr/>Force<wbr/>Flush</span><a href="#onforceflush" 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><ul class="tsd-signatures tsd-is-protected"><li class="tsd-is-protected"><div class="tsd-signature tsd-anchor-link"><a id="onforceflush-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">onForceFlush</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#onforceflush-1" 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></div><div class="tsd-description"><code class="tsd-tag">Protected</code><div class="tsd-comment tsd-typography"><p>Handle a force flush signal by the SDK.</p>
|
||
<p> In all scenarios metrics should be collected via <a href="_opentelemetry_sdk-node.metrics.MetricReader.html#collect" class="tsd-kind-method">()</a>.
|
||
<p> For push exporters, this should collect and report metrics.</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="_opentelemetry_sdk-node.metrics.MetricReader.html">MetricReader</a>.<a href="_opentelemetry_sdk-node.metrics.MetricReader.html#onforceflush">onForceFlush</a></p><ul><li>Defined in packages/sdk-metrics/build/src/export/PeriodicExportingMetricReader.d.ts:39</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="oninitialized" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>on<wbr/>Initialized</span><a href="#oninitialized" 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><ul class="tsd-signatures tsd-is-protected"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="oninitialized-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">onInitialized</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#oninitialized-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Handle once the SDK has initialized this <a href="_opentelemetry_sdk-node.metrics.MetricReader.html" class="tsd-kind-class">MetricReader</a>
|
||
Overriding this method is optional.</p>
|
||
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="_opentelemetry_sdk-node.metrics.MetricReader.html">MetricReader</a>.<a href="_opentelemetry_sdk-node.metrics.MetricReader.html#oninitialized">onInitialized</a></p><ul><li>Defined in packages/sdk-metrics/build/src/export/PeriodicExportingMetricReader.d.ts:38</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="onshutdown" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>on<wbr/>Shutdown</span><a href="#onshutdown" 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><ul class="tsd-signatures tsd-is-protected"><li class="tsd-is-protected"><div class="tsd-signature tsd-anchor-link"><a id="onshutdown-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">onShutdown</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#onshutdown-1" 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></div><div class="tsd-description"><code class="tsd-tag">Protected</code><div class="tsd-comment tsd-typography"><p>Handle a shutdown signal by the SDK.</p>
|
||
<p> For push exporters, this should shut down any intervals and close any open connections.</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="_opentelemetry_sdk-node.metrics.MetricReader.html">MetricReader</a>.<a href="_opentelemetry_sdk-node.metrics.MetricReader.html#onshutdown">onShutdown</a></p><ul><li>Defined in packages/sdk-metrics/build/src/export/PeriodicExportingMetricReader.d.ts:40</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="selectaggregation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>select<wbr/>Aggregation</span><a href="#selectaggregation" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="selectaggregation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">selectAggregation</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">instrumentType</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node.metrics.html" class="tsd-signature-type tsd-kind-namespace">metrics</a><span class="tsd-signature-symbol">.</span><a href="../enums/_opentelemetry_sdk-node.metrics.InstrumentType.html" class="tsd-signature-type tsd-kind-enum">InstrumentType</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node.metrics.html" class="tsd-signature-type tsd-kind-namespace">metrics</a><span class="tsd-signature-symbol">.</span><a href="../types/_opentelemetry_sdk-node.metrics.AggregationOption.html" class="tsd-signature-type tsd-kind-type-alias">AggregationOption</a><a href="#selectaggregation-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Select the <a href="../types/_opentelemetry_sdk-node.metrics.AggregationOption.html" class="tsd-kind-type-alias">AggregationOption</a> for the given <a href="../enums/_opentelemetry_sdk-node.metrics.InstrumentType.html" class="tsd-kind-enum">InstrumentType</a> for this
|
||
reader.</p>
|
||
<p> NOTE: implementations MUST be pure</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">instrumentType</span>: <a href="../modules/_opentelemetry_sdk-node.metrics.html" class="tsd-signature-type tsd-kind-namespace">metrics</a><span class="tsd-signature-symbol">.</span><a href="../enums/_opentelemetry_sdk-node.metrics.InstrumentType.html" class="tsd-signature-type tsd-kind-enum">InstrumentType</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../modules/_opentelemetry_sdk-node.metrics.html" class="tsd-signature-type tsd-kind-namespace">metrics</a><span class="tsd-signature-symbol">.</span><a href="../types/_opentelemetry_sdk-node.metrics.AggregationOption.html" class="tsd-signature-type tsd-kind-type-alias">AggregationOption</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="_opentelemetry_sdk-node.metrics.MetricReader.html">MetricReader</a>.<a href="_opentelemetry_sdk-node.metrics.MetricReader.html#selectaggregation">selectAggregation</a></p><ul><li>Defined in packages/sdk-metrics/build/src/export/MetricReader.d.ts:107</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="selectaggregationtemporality" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>select<wbr/>Aggregation<wbr/>Temporality</span><a href="#selectaggregationtemporality" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="selectaggregationtemporality-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">selectAggregationTemporality</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">instrumentType</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node.metrics.html" class="tsd-signature-type tsd-kind-namespace">metrics</a><span class="tsd-signature-symbol">.</span><a href="../enums/_opentelemetry_sdk-node.metrics.InstrumentType.html" class="tsd-signature-type tsd-kind-enum">InstrumentType</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node.metrics.html" class="tsd-signature-type tsd-kind-namespace">metrics</a><span class="tsd-signature-symbol">.</span><a href="../enums/_opentelemetry_sdk-node.metrics.AggregationTemporality.html" class="tsd-signature-type tsd-kind-enum">AggregationTemporality</a><a href="#selectaggregationtemporality-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Select the <a href="../enums/_opentelemetry_sdk-node.metrics.AggregationTemporality.html" class="tsd-kind-enum">AggregationTemporality</a> for the given
|
||
<a href="../enums/_opentelemetry_sdk-node.metrics.InstrumentType.html" class="tsd-kind-enum">InstrumentType</a> for this reader.</p>
|
||
<p> NOTE: implementations MUST be pure</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">instrumentType</span>: <a href="../modules/_opentelemetry_sdk-node.metrics.html" class="tsd-signature-type tsd-kind-namespace">metrics</a><span class="tsd-signature-symbol">.</span><a href="../enums/_opentelemetry_sdk-node.metrics.InstrumentType.html" class="tsd-signature-type tsd-kind-enum">InstrumentType</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../modules/_opentelemetry_sdk-node.metrics.html" class="tsd-signature-type tsd-kind-namespace">metrics</a><span class="tsd-signature-symbol">.</span><a href="../enums/_opentelemetry_sdk-node.metrics.AggregationTemporality.html" class="tsd-signature-type tsd-kind-enum">AggregationTemporality</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="_opentelemetry_sdk-node.metrics.MetricReader.html">MetricReader</a>.<a href="_opentelemetry_sdk-node.metrics.MetricReader.html#selectaggregationtemporality">selectAggregationTemporality</a></p><ul><li>Defined in packages/sdk-metrics/build/src/export/MetricReader.d.ts:108</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="selectcardinalitylimit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>select<wbr/>Cardinality<wbr/>Limit</span><a href="#selectcardinalitylimit" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="selectcardinalitylimit-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">selectCardinalityLimit</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">instrumentType</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node.metrics.html" class="tsd-signature-type tsd-kind-namespace">metrics</a><span class="tsd-signature-symbol">.</span><a href="../enums/_opentelemetry_sdk-node.metrics.InstrumentType.html" class="tsd-signature-type tsd-kind-enum">InstrumentType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#selectcardinalitylimit-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Select the cardinality limit for the given <a href="../enums/_opentelemetry_sdk-node.metrics.InstrumentType.html" class="tsd-kind-enum">InstrumentType</a> for this
|
||
reader.</p>
|
||
<p> NOTE: implementations MUST be pure</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">instrumentType</span>: <a href="../modules/_opentelemetry_sdk-node.metrics.html" class="tsd-signature-type tsd-kind-namespace">metrics</a><span class="tsd-signature-symbol">.</span><a href="../enums/_opentelemetry_sdk-node.metrics.InstrumentType.html" class="tsd-signature-type tsd-kind-enum">InstrumentType</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="_opentelemetry_sdk-node.metrics.MetricReader.html">MetricReader</a>.<a href="_opentelemetry_sdk-node.metrics.MetricReader.html#selectcardinalitylimit">selectCardinalityLimit</a></p><ul><li>Defined in packages/sdk-metrics/build/src/export/MetricReader.d.ts:109</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="setmetricproducer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Metric<wbr/>Producer</span><a href="#setmetricproducer" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="setmetricproducer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setMetricProducer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">metricProducer</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node.metrics.html" class="tsd-signature-type tsd-kind-namespace">metrics</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node.metrics.MetricProducer.html" class="tsd-signature-type tsd-kind-interface">MetricProducer</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#setmetricproducer-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set the <a href="../interfaces/_opentelemetry_sdk-node.metrics.MetricProducer.html" class="tsd-kind-interface">MetricProducer</a> used by this instance. <strong>This should only be called once by the
|
||
SDK and should be considered internal.</strong></p>
|
||
<p> NOTE: implementations MUST throw when called more than once</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">metricProducer</span>: <a href="../modules/_opentelemetry_sdk-node.metrics.html" class="tsd-signature-type tsd-kind-namespace">metrics</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node.metrics.MetricProducer.html" class="tsd-signature-type tsd-kind-interface">MetricProducer</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="_opentelemetry_sdk-node.metrics.MetricReader.html">MetricReader</a>.<a href="_opentelemetry_sdk-node.metrics.MetricReader.html#setmetricproducer">setMetricProducer</a></p><ul><li>Defined in packages/sdk-metrics/build/src/export/MetricReader.d.ts:106</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="shutdown" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>shutdown</span><a href="#shutdown" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="shutdown-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">shutdown</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">CommonReaderOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#shutdown-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Shuts down the metric reader, the promise will reject after the optional timeout or resolve after completion.</p>
|
||
<p> NOTE: this operation MAY continue even after the promise rejects due to a timeout.</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">CommonReaderOptions</span></span><div class="tsd-comment tsd-typography"><p>options with timeout.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="_opentelemetry_sdk-node.metrics.MetricReader.html">MetricReader</a>.<a href="_opentelemetry_sdk-node.metrics.MetricReader.html#shutdown">shutdown</a></p><ul><li>Defined in packages/sdk-metrics/build/src/export/MetricReader.d.ts:131</li></ul></aside></div></li></ul></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-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#collect" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>collect</span></a><a href="#forceflush" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>force<wbr/>Flush</span></a><a href="#onforceflush" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on<wbr/>Force<wbr/>Flush</span></a><a href="#oninitialized" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on<wbr/>Initialized</span></a><a href="#onshutdown" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on<wbr/>Shutdown</span></a><a href="#selectaggregation" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>select<wbr/>Aggregation</span></a><a href="#selectaggregationtemporality" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>select<wbr/>Aggregation<wbr/>Temporality</span></a><a href="#selectcardinalitylimit" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>select<wbr/>Cardinality<wbr/>Limit</span></a><a href="#setmetricproducer" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Metric<wbr/>Producer</span></a><a href="#shutdown" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>shutdown</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>
|