16 lines
15 KiB
HTML
16 lines
15 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>DataPoint | 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.DataPoint.html">DataPoint</a></li></ul><h1>Interface DataPoint<T></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents an aggregated point data with start time, end time and their
|
||
associated attributes and points.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">DataPoint</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_opentelemetry_sdk-node.metrics.DataPoint.html#t">T</a><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="_opentelemetry_sdk-node.metrics.DataPoint.html#attributes">attributes</a><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="_opentelemetry_sdk-node._opentelemetry_api.Attributes.html" class="tsd-signature-type tsd-kind-interface">Attributes</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="_opentelemetry_sdk-node.metrics.DataPoint.html#endtime">endTime</a><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../types/_opentelemetry_sdk-node._opentelemetry_api.HrTime.html" class="tsd-signature-type tsd-kind-type-alias">HrTime</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="_opentelemetry_sdk-node.metrics.DataPoint.html#starttime">startTime</a><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../types/_opentelemetry_sdk-node._opentelemetry_api.HrTime.html" class="tsd-signature-type tsd-kind-type-alias">HrTime</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="_opentelemetry_sdk-node.metrics.DataPoint.html#value">value</a><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_opentelemetry_sdk-node.metrics.DataPoint.html#t">T</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="t" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section> <aside class="tsd-sources"><ul><li>Defined in packages/sdk-metrics/build/src/export/MetricData.d.ts:121</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="_opentelemetry_sdk-node.metrics.DataPoint.html#attributes" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>attributes</span></a>
|
||
<a href="_opentelemetry_sdk-node.metrics.DataPoint.html#endtime" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>end<wbr/>Time</span></a>
|
||
<a href="_opentelemetry_sdk-node.metrics.DataPoint.html#starttime" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>start<wbr/>Time</span></a>
|
||
<a href="_opentelemetry_sdk-node.metrics.DataPoint.html#value" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value</span></a>
|
||
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="attributes" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>attributes</span><a href="#attributes" 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">attributes</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="_opentelemetry_sdk-node._opentelemetry_api.Attributes.html" class="tsd-signature-type tsd-kind-interface">Attributes</a></div><div class="tsd-comment tsd-typography"><p>The attributes associated with this DataPoint.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/sdk-metrics/build/src/export/MetricData.d.ts:136</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="endtime" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>end<wbr/>Time</span><a href="#endtime" 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">endTime</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../types/_opentelemetry_sdk-node._opentelemetry_api.HrTime.html" class="tsd-signature-type tsd-kind-type-alias">HrTime</a></div><div class="tsd-comment tsd-typography"><p>The end epoch timestamp when data were collected, usually it represents
|
||
the moment when <code>MetricReader.collect</code> was called.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/sdk-metrics/build/src/export/MetricData.d.ts:132</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="starttime" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>start<wbr/>Time</span><a href="#starttime" 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">startTime</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../types/_opentelemetry_sdk-node._opentelemetry_api.HrTime.html" class="tsd-signature-type tsd-kind-type-alias">HrTime</a></div><div class="tsd-comment tsd-typography"><p>The start epoch timestamp of the DataPoint, usually the time when
|
||
the metric was created when the preferred AggregationTemporality is
|
||
CUMULATIVE, or last collection time otherwise.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/sdk-metrics/build/src/export/MetricData.d.ts:127</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="value" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>value</span><a href="#value" 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">value</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_opentelemetry_sdk-node.metrics.DataPoint.html#t">T</a></div><div class="tsd-comment tsd-typography"><p>The value for this DataPoint. The type of the value is indicated by the
|
||
<a href="../enums/_opentelemetry_sdk-node.metrics.DataPointType.html" class="tsd-kind-enum">DataPointType</a>.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/sdk-metrics/build/src/export/MetricData.d.ts:141</li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#attributes" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>attributes</span></a><a href="#endtime" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>end<wbr/>Time</span></a><a href="#starttime" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>start<wbr/>Time</span></a><a href="#value" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value</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>
|