opentelemetry-js/modules/_opentelemetry_exporter-met...

60 lines
29 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>@opentelemetry/exporter-metrics-otlp-http | 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="_opentelemetry_exporter-metrics-otlp-http.html">@opentelemetry/exporter-metrics-otlp-http</a></li></ul><h1>Module @opentelemetry/exporter-metrics-otlp-http</h1></div><section class="tsd-panel tsd-typography"><a id="opentelemetry-collector-metrics-exporter-for-web-and-node" class="tsd-anchor"></a><h1 class="tsd-anchor-link">OpenTelemetry Collector Metrics Exporter for web and node<a href="#opentelemetry-collector-metrics-exporter-for-web-and-node" 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></h1><p><a href="https://www.npmjs.com/package/@opentelemetry/exporter-metrics-otlp-http"><img src="https://badge.fury.io/js/%40opentelemetry%2Fexporter-metrics-otlp-http.svg" alt="NPM Published Version"></a>
<a href="https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat"><img src="https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat" alt="Apache License"></a></p>
<p><strong>Note: This is an experimental package under active development. New releases may include breaking changes.</strong></p>
<p>This module provides a metrics-exporter for OTLP (http/json) using protocol version <code>v1.7.0</code>.</p>
<a id="installation" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Installation<a href="#installation" 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></h2><pre><code class="bash"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">install</span><span class="hl-1"> </span><span class="hl-3">--save</span><span class="hl-1"> </span><span class="hl-2">@opentelemetry/exporter-metrics-otlp-http</span>
</code><button type="button">Copy</button></pre>
<a id="service-name" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Service Name<a href="#service-name" 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></h2><p>The OpenTelemetry Collector Metrics Exporter does not have a service name configuration.
In order to set the service name, use the <code>service.name</code> resource attribute as prescribed in
the <a href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/semantic_conventions/README.md#service">OpenTelemetry Resource Semantic Conventions</a>.
To see sample code and documentation for the traces exporter, visit
the <a href="https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/exporter-trace-otlp-http">Collector Trace Exporter for web and node</a>.</p>
<a id="metrics-in-web" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Metrics in Web<a href="#metrics-in-web" 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></h2><p>The OTLPMetricExporter in Web expects the endpoint to end in <code>/v1/metrics</code>.</p>
<pre><code class="js"><span class="hl-7">import</span><span class="hl-1"> { </span><span class="hl-6">MeterProvider</span><span class="hl-1">, </span><span class="hl-6">PeriodicExportingMetricReader</span><span class="hl-1"> } </span><span class="hl-7">from</span><span class="hl-1"> </span><span class="hl-2">&#39;@opentelemetry/sdk-metrics&#39;</span><span class="hl-1">;</span><br/><span class="hl-7">import</span><span class="hl-1"> { </span><span class="hl-6">OTLPMetricExporter</span><span class="hl-1"> } </span><span class="hl-7">from</span><span class="hl-1"> </span><span class="hl-2">&#39;@opentelemetry/exporter-metrics-otlp-http&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">collectorOptions</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-6">url:</span><span class="hl-1"> </span><span class="hl-2">&#39;&lt;opentelemetry-collector-url&gt;&#39;</span><span class="hl-1">, </span><span class="hl-5">// url is optional and can be omitted - default is http://localhost:4318/v1/metrics</span><br/><span class="hl-1"> </span><span class="hl-6">headers:</span><span class="hl-1"> {}, </span><span class="hl-5">// an optional object containing custom headers to be sent with each request</span><br/><span class="hl-1"> </span><span class="hl-6">concurrencyLimit:</span><span class="hl-1"> </span><span class="hl-9">1</span><span class="hl-1">, </span><span class="hl-5">// an optional limit on pending requests</span><br/><span class="hl-1">};</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">metricExporter</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">OTLPMetricExporter</span><span class="hl-1">(</span><span class="hl-6">collectorOptions</span><span class="hl-1">);</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">meterProvider</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">MeterProvider</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-6">readers:</span><span class="hl-1"> [</span><br/><span class="hl-1"> </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">PeriodicExportingMetricReader</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-6">exporter:</span><span class="hl-1"> </span><span class="hl-6">metricExporter</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-6">exportIntervalMillis:</span><span class="hl-1"> </span><span class="hl-9">1000</span><span class="hl-1">,</span><br/><span class="hl-1"> }),</span><br/><span class="hl-1"> ],</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-5">// Now, start recording data</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">meter</span><span class="hl-1"> = </span><span class="hl-6">meterProvider</span><span class="hl-1">.</span><span class="hl-0">getMeter</span><span class="hl-1">(</span><span class="hl-2">&#39;example-meter&#39;</span><span class="hl-1">);</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">counter</span><span class="hl-1"> = </span><span class="hl-6">meter</span><span class="hl-1">.</span><span class="hl-0">createCounter</span><span class="hl-1">(</span><span class="hl-2">&#39;metric_name&#39;</span><span class="hl-1">);</span><br/><span class="hl-6">counter</span><span class="hl-1">.</span><span class="hl-0">add</span><span class="hl-1">(</span><span class="hl-9">10</span><span class="hl-1">, { </span><span class="hl-2">&#39;key&#39;</span><span class="hl-6">:</span><span class="hl-1"> </span><span class="hl-2">&#39;value&#39;</span><span class="hl-1"> });</span>
</code><button type="button">Copy</button></pre>
<a id="metrics-in-node" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Metrics in Node<a href="#metrics-in-node" 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></h2><pre><code class="js"><span class="hl-3">const</span><span class="hl-1"> { </span><span class="hl-4">MeterProvider</span><span class="hl-1">, </span><span class="hl-4">PeriodicExportingMetricReader</span><span class="hl-1"> } = </span><span class="hl-0">require</span><span class="hl-1">(</span><span class="hl-2">&#39;@opentelemetry/sdk-metrics&#39;</span><span class="hl-1">);</span><br/><span class="hl-3">const</span><span class="hl-1"> { </span><span class="hl-4">OTLPMetricExporter</span><span class="hl-1"> } = </span><span class="hl-0">require</span><span class="hl-1">(</span><span class="hl-2">&#39;@opentelemetry/exporter-metrics-otlp-http&#39;</span><span class="hl-1">);</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">collectorOptions</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-6">url:</span><span class="hl-1"> </span><span class="hl-2">&#39;&lt;opentelemetry-collector-url&gt;&#39;</span><span class="hl-1">, </span><span class="hl-5">// url is optional and can be omitted - default is http://localhost:4318/v1/metrics</span><br/><span class="hl-1"> </span><span class="hl-6">concurrencyLimit:</span><span class="hl-1"> </span><span class="hl-9">1</span><span class="hl-1">, </span><span class="hl-5">// an optional limit on pending requests</span><br/><span class="hl-1">};</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">metricExporter</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">OTLPMetricExporter</span><span class="hl-1">(</span><span class="hl-6">collectorOptions</span><span class="hl-1">);</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">meterProvider</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">MeterProvider</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-6">readers:</span><span class="hl-1"> [</span><br/><span class="hl-1"> </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">PeriodicExportingMetricReader</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-6">exporter:</span><span class="hl-1"> </span><span class="hl-6">metricExporter</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-6">exportIntervalMillis:</span><span class="hl-1"> </span><span class="hl-9">1000</span><span class="hl-1">,</span><br/><span class="hl-1"> }),</span><br/><span class="hl-1"> ],</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-5">// Now, start recording data</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">meter</span><span class="hl-1"> = </span><span class="hl-6">meterProvider</span><span class="hl-1">.</span><span class="hl-0">getMeter</span><span class="hl-1">(</span><span class="hl-2">&#39;example-meter&#39;</span><span class="hl-1">);</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">counter</span><span class="hl-1"> = </span><span class="hl-6">meter</span><span class="hl-1">.</span><span class="hl-0">createCounter</span><span class="hl-1">(</span><span class="hl-2">&#39;metric_name&#39;</span><span class="hl-1">);</span><br/><span class="hl-6">counter</span><span class="hl-1">.</span><span class="hl-0">add</span><span class="hl-1">(</span><span class="hl-9">10</span><span class="hl-1">, { </span><span class="hl-2">&#39;key&#39;</span><span class="hl-6">:</span><span class="hl-1"> </span><span class="hl-2">&#39;value&#39;</span><span class="hl-1"> });</span><br/>
</code><button type="button">Copy</button></pre>
<a id="environment-variable-configuration" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Environment Variable Configuration<a href="#environment-variable-configuration" 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></h2><p>In addition to settings passed to the constructor, the exporter also supports configuration via environment variables:</p>
<table>
<thead>
<tr>
<th>Environment variable</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>OTEL_EXPORTER_OTLP_ENDPOINT</td>
<td>The endpoint to send metrics to. This will also be used for the traces exporter if <code>OTEL_EXPORTER_OTLP_TRACES_ENDPOINT</code> is not configured. By default <code>http://localhost:4318</code> will be used. <code>/v1/metrics</code> will be automatically appended to configured values.</td>
</tr>
<tr>
<td>OTEL_EXPORTER_OTLP_METRICS_ENDPOINT</td>
<td>The endpoint to send metrics to. By default <code>https://localhost:4318/v1/metrics</code> will be used. <code>v1/metrics</code> will not be appended automatically and has to be added explicitly.</td>
</tr>
<tr>
<td>OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE</td>
<td>The exporters aggregation temporality preference. Valid values are <code>cumulative</code>, <code>delta</code>, and <code>lowmemory</code>. <code>cumulative</code> selects cumulative temporality for all instrument kinds. <code>delta</code> selects delta aggregation temporality for Counter, Asynchronous Counter and Histogram instrument kinds, and selects cumulative aggregation for UpDownCounter and Asynchronous UpDownCounter instrument kinds. <code>lowmemory</code> selects delta aggregation temporality for Counter and Histogram instrument kinds, and selects cumulative aggregation for UpDownCounter, Asynchronous Counter and Asynchronous UpDownCounter instrument kinds. By default <code>cumulative</code> is used.</td>
</tr>
</tbody>
</table>
<blockquote>
<p>Settings configured programmatically take precedence over environment variables. Per-signal environment variables take
precedence over non-per-signal environment variables.</p>
</blockquote>
<a id="running-opentelemetry-collector-locally-to-see-the-metrics" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Running opentelemetry-collector locally to see the metrics<a href="#running-opentelemetry-collector-locally-to-see-the-metrics" 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></h2><ol>
<li>Go to <code>examples/otlp-exporter-node</code></li>
<li>Follow the instructions there to observe the metrics.</li>
</ol>
<a id="useful-links" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Useful links<a href="#useful-links" 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></h2><ul>
<li>For more information on OpenTelemetry, visit: <a href="https://opentelemetry.io/">https://opentelemetry.io/</a></li>
<li>For more about OpenTelemetry JavaScript: <a href="https://github.com/open-telemetry/opentelemetry-js">https://github.com/open-telemetry/opentelemetry-js</a></li>
<li>For help or feedback on this project, join us in <a href="https://github.com/open-telemetry/opentelemetry-js/discussions">GitHub Discussions</a></li>
<li>For exporting metrics via gRPC please check <a href="https://www.npmjs.com/package/@opentelemetry/exporter-metrics-otlp-grpc">exporter-metrics-otlp-grpc</a></li>
<li>For exporting metrics via protobuf please check <a href="https://www.npmjs.com/package/@opentelemetry/exporter-metrics-otlp-proto">exporter-metrics-otlp-proto</a></li>
</ul>
<a id="license" class="tsd-anchor"></a><h2 class="tsd-anchor-link">License<a href="#license" 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></h2><p>Apache 2.0 - See <a href="https://github.com/open-telemetry/opentelemetry-js/blob/main/LICENSE">LICENSE</a> for more information.</p>
</section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Enumerations"><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> Enumerations</h2></summary><dl class="tsd-member-summaries"><dt class="tsd-member-summary"><a id="aggregationtemporalitypreference" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration"><use href="../assets/icons.svg#icon-8"></use></svg><a href="../enums/_opentelemetry_exporter-metrics-otlp-http.AggregationTemporalityPreference.html">AggregationTemporalityPreference</a><a href="#aggregationtemporalitypreference" 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></span></dt><dd class="tsd-member-summary"></dd></dl></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Classes"><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> Classes</h2></summary><dl class="tsd-member-summaries"><dt class="tsd-member-summary"><a id="otlpmetricexporter" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="../assets/icons.svg#icon-128"></use></svg><a href="../classes/_opentelemetry_exporter-metrics-otlp-http.OTLPMetricExporter.html">OTLPMetricExporter</a><a href="#otlpmetricexporter" 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></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="otlpmetricexporterbase" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="../assets/icons.svg#icon-128"></use></svg><a href="../classes/_opentelemetry_exporter-metrics-otlp-http.OTLPMetricExporterBase.html">OTLPMetricExporterBase</a><a href="#otlpmetricexporterbase" 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></span></dt><dd class="tsd-member-summary"></dd></dl></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Interfaces"><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> Interfaces</h2></summary><dl class="tsd-member-summaries"><dt class="tsd-member-summary"><a id="otlpmetricexporteroptions" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="../assets/icons.svg#icon-256"></use></svg><a href="../interfaces/_opentelemetry_exporter-metrics-otlp-http.OTLPMetricExporterOptions.html">OTLPMetricExporterOptions</a><a href="#otlpmetricexporteroptions" 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></span></dt><dd class="tsd-member-summary"></dd></dl></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Functions"><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> Functions</h2></summary><dl class="tsd-member-summaries"><dt class="tsd-member-summary"><a id="cumulativetemporalityselector" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="../assets/icons.svg#icon-64"></use></svg><a href="../functions/_opentelemetry_exporter-metrics-otlp-http.CumulativeTemporalitySelector.html">CumulativeTemporalitySelector</a><a href="#cumulativetemporalityselector" 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></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="deltatemporalityselector" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="../assets/icons.svg#icon-64"></use></svg><a href="../functions/_opentelemetry_exporter-metrics-otlp-http.DeltaTemporalitySelector.html">DeltaTemporalitySelector</a><a href="#deltatemporalityselector" 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></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="lowmemorytemporalityselector" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="../assets/icons.svg#icon-64"></use></svg><a href="../functions/_opentelemetry_exporter-metrics-otlp-http.LowMemoryTemporalitySelector.html">LowMemoryTemporalitySelector</a><a href="#lowmemorytemporalityselector" 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></span></dt><dd class="tsd-member-summary"></dd></dl></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"><a href="#opentelemetry-collector-metrics-exporter-for-web-and-node"><span>Open<wbr/>Telemetry <wbr/>Collector <wbr/>Metrics <wbr/>Exporter for web and node</span></a><ul><li><a href="#installation"><span>Installation</span></a></li><li><a href="#service-name"><span>Service <wbr/>Name</span></a></li><li><a href="#metrics-in-web"><span>Metrics in <wbr/>Web</span></a></li><li><a href="#metrics-in-node"><span>Metrics in <wbr/>Node</span></a></li><li><a href="#environment-variable-configuration"><span>Environment <wbr/>Variable <wbr/>Configuration</span></a></li><li><a href="#running-opentelemetry-collector-locally-to-see-the-metrics"><span>Running opentelemetry-<wbr/>collector locally to see the metrics</span></a></li><li><a href="#useful-links"><span>Useful links</span></a></li><li><a href="#license"><span>License</span></a></li></ul><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Enumerations"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Enumerations</summary><div><a href="#aggregationtemporalitypreference" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration"><use href="../assets/icons.svg#icon-8"></use></svg><span>Aggregation<wbr/>Temporality<wbr/>Preference</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Classes"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Classes</summary><div><a href="#otlpmetricexporter" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="../assets/icons.svg#icon-128"></use></svg><span>OTLPMetric<wbr/>Exporter</span></a><a href="#otlpmetricexporterbase" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="../assets/icons.svg#icon-128"></use></svg><span>OTLPMetric<wbr/>Exporter<wbr/>Base</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Interfaces"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Interfaces</summary><div><a href="#otlpmetricexporteroptions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="../assets/icons.svg#icon-256"></use></svg><span>OTLPMetric<wbr/>Exporter<wbr/>Options</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Functions"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Functions</summary><div><a href="#cumulativetemporalityselector" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="../assets/icons.svg#icon-64"></use></svg><span>Cumulative<wbr/>Temporality<wbr/>Selector</span></a><a href="#deltatemporalityselector" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="../assets/icons.svg#icon-64"></use></svg><span>Delta<wbr/>Temporality<wbr/>Selector</span></a><a href="#lowmemorytemporalityselector" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="../assets/icons.svg#icon-64"></use></svg><span>Low<wbr/>Memory<wbr/>Temporality<wbr/>Selector</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>