23 lines
31 KiB
HTML
23 lines
31 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>InMemoryMetricExporter | 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.InMemoryMetricExporter.html">InMemoryMetricExporter</a></li></ul><h1>Class InMemoryMetricExporter</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>In-memory Metrics Exporter is a Push Metric Exporter
|
||
which accumulates metrics data in the local memory and
|
||
allows to inspect it (useful for e.g. unit tests).</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><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.PushMetricExporter.html" class="tsd-signature-type tsd-kind-interface">PushMetricExporter</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in packages/sdk-metrics/build/src/export/InMemoryMetricExporter.d.ts:10</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.InMemoryMetricExporter.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">Properties</h3><div class="tsd-index-list"><a href="_opentelemetry_sdk-node.metrics.InMemoryMetricExporter.html#_aggregationtemporality" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_aggregation<wbr/>Temporality</span></a>
|
||
<a href="_opentelemetry_sdk-node.metrics.InMemoryMetricExporter.html#_shutdown" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_shutdown</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.InMemoryMetricExporter.html#export" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>export</span></a>
|
||
<a href="_opentelemetry_sdk-node.metrics.InMemoryMetricExporter.html#forceflush" class="tsd-index-link"><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.InMemoryMetricExporter.html#getmetrics" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Metrics</span></a>
|
||
<a href="_opentelemetry_sdk-node.metrics.InMemoryMetricExporter.html#reset" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reset</span></a>
|
||
<a href="_opentelemetry_sdk-node.metrics.InMemoryMetricExporter.html#selectaggregationtemporality" class="tsd-index-link"><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.InMemoryMetricExporter.html#shutdown" class="tsd-index-link"><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="constructorinmemorymetricexporter" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">InMemoryMetricExporter</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">aggregationTemporality</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><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.InMemoryMetricExporter.html" class="tsd-signature-type tsd-kind-class">InMemoryMetricExporter</a><a href="#constructorinmemorymetricexporter" 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">aggregationTemporality</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></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.InMemoryMetricExporter.html" class="tsd-signature-type tsd-kind-class">InMemoryMetricExporter</a></h4><aside class="tsd-sources"><ul><li>Defined in packages/sdk-metrics/build/src/export/InMemoryMetricExporter.d.ts:14</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-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 tsd-is-protected"><a id="_aggregationtemporality" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>_aggregation<wbr/>Temporality</span><a href="#_aggregationtemporality" 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">_aggregationTemporality</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></div><aside class="tsd-sources"><ul><li>Defined in packages/sdk-metrics/build/src/export/InMemoryMetricExporter.d.ts:12</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="_shutdown" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><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><div class="tsd-signature"><span class="tsd-kind-property">_shutdown</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in packages/sdk-metrics/build/src/export/InMemoryMetricExporter.d.ts:11</li></ul></aside></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"><a id="export" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>export</span><a href="#export" 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="export-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">export</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">metrics</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.ResourceMetrics.html" class="tsd-signature-type tsd-kind-interface">ResourceMetrics</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">resultCallback</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">result</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node.core.html" class="tsd-signature-type tsd-kind-namespace">core</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node.core.ExportResult.html" class="tsd-signature-type tsd-kind-interface">ExportResult</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#export-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-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">metrics</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.ResourceMetrics.html" class="tsd-signature-type tsd-kind-interface">ResourceMetrics</a></span></li><li><span><span class="tsd-kind-parameter">resultCallback</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">result</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node.core.html" class="tsd-signature-type tsd-kind-namespace">core</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node.core.ExportResult.html" class="tsd-signature-type tsd-kind-interface">ExportResult</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span></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 class="tsd-tag-inheritedDoc"><h4 class="tsd-anchor-link"><a id="inherited-doc" class="tsd-anchor"></a>Inherited Doc<a href="#inherited-doc" 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></div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_opentelemetry_sdk-node.metrics.PushMetricExporter.html">PushMetricExporter</a>.<a href="../interfaces/_opentelemetry_sdk-node.metrics.PushMetricExporter.html#export">export</a></p><ul><li>Defined in packages/sdk-metrics/build/src/export/InMemoryMetricExporter.d.ts:18</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><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"><li class=""><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-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>Ensure that the export of any metrics the exporter has received is
|
||
completed before the returned promise is settled.</p>
|
||
</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>Implementation of <a href="../interfaces/_opentelemetry_sdk-node.metrics.PushMetricExporter.html">PushMetricExporter</a>.<a href="../interfaces/_opentelemetry_sdk-node.metrics.PushMetricExporter.html#forceflush">forceFlush</a></p><ul><li>Defined in packages/sdk-metrics/build/src/export/InMemoryMetricExporter.d.ts:24</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="getmetrics" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Metrics</span><a href="#getmetrics" 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="getmetrics-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getMetrics</span><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="../interfaces/_opentelemetry_sdk-node.metrics.ResourceMetrics.html" class="tsd-signature-type tsd-kind-interface">ResourceMetrics</a><span class="tsd-signature-symbol">[]</span><a href="#getmetrics-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>Returns all the collected resource metrics</p>
|
||
</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="../interfaces/_opentelemetry_sdk-node.metrics.ResourceMetrics.html" class="tsd-signature-type tsd-kind-interface">ResourceMetrics</a><span class="tsd-signature-symbol">[]</span></h4><p>ResourceMetrics[]</p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/sdk-metrics/build/src/export/InMemoryMetricExporter.d.ts:23</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="reset" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>reset</span><a href="#reset" 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="reset-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">reset</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#reset-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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in packages/sdk-metrics/build/src/export/InMemoryMetricExporter.d.ts:25</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><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"><li class=""><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 exporter.</p>
|
||
</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>Implementation of <a href="../interfaces/_opentelemetry_sdk-node.metrics.PushMetricExporter.html">PushMetricExporter</a>.<a href="../interfaces/_opentelemetry_sdk-node.metrics.PushMetricExporter.html#selectaggregationtemporality">selectAggregationTemporality</a></p><ul><li>Defined in packages/sdk-metrics/build/src/export/InMemoryMetricExporter.d.ts:26</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><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"><li class=""><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-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>Returns a promise which resolves when the last exportation is completed.
|
||
Further calls to <a href="../interfaces/_opentelemetry_sdk-node.metrics.PushMetricExporter.html#export" class="tsd-kind-method">PushMetricExporter.export</a> may not export the
|
||
data.</p>
|
||
</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>Implementation of <a href="../interfaces/_opentelemetry_sdk-node.metrics.PushMetricExporter.html">PushMetricExporter</a>.<a href="../interfaces/_opentelemetry_sdk-node.metrics.PushMetricExporter.html#shutdown">shutdown</a></p><ul><li>Defined in packages/sdk-metrics/build/src/export/InMemoryMetricExporter.d.ts:27</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-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="#_aggregationtemporality" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_aggregation<wbr/>Temporality</span></a><a href="#_shutdown" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_shutdown</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="#export" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>export</span></a><a href="#forceflush" class=""><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="#getmetrics" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Metrics</span></a><a href="#reset" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reset</span></a><a href="#selectaggregationtemporality" class=""><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="#shutdown" class=""><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>
|