12 lines
21 KiB
HTML
12 lines
21 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>BatchLogRecordProcessor | 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.logs.html">logs</a></li><li><a href="_opentelemetry_sdk-node.logs.BatchLogRecordProcessor.html">BatchLogRecordProcessor</a></li></ul><h1>Class BatchLogRecordProcessor</h1></div><section class="tsd-panel tsd-hierarchy" data-refl="9522"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-signature-type">BatchLogRecordProcessorBase</span><span class="tsd-signature-symbol"><</span><a href="../modules/_opentelemetry_sdk-node.logs.html" class="tsd-signature-type tsd-kind-namespace">logs</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node.logs.BufferConfig.html" class="tsd-signature-type tsd-kind-interface">BufferConfig</a><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">BatchLogRecordProcessor</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in experimental/packages/sdk-logs/build/src/platform/node/export/BatchLogRecordProcessor.d.ts:3</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.logs.BatchLogRecordProcessor.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.logs.BatchLogRecordProcessor.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.logs.BatchLogRecordProcessor.html#onemit" 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>on<wbr/>Emit</span></a>
|
||
<a href="_opentelemetry_sdk-node.logs.BatchLogRecordProcessor.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.logs.BatchLogRecordProcessor.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="constructorbatchlogrecordprocessor" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">BatchLogRecordProcessor</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">_exporter</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node.logs.html" class="tsd-signature-type tsd-kind-namespace">logs</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node.logs.LogRecordExporter.html" class="tsd-signature-type tsd-kind-interface">LogRecordExporter</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">?:</span> <a href="../modules/_opentelemetry_sdk-node.logs.html" class="tsd-signature-type tsd-kind-namespace">logs</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node.logs.BufferConfig.html" class="tsd-signature-type tsd-kind-interface">BufferConfig</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.logs.html" class="tsd-signature-type tsd-kind-namespace">logs</a><span class="tsd-signature-symbol">.</span><a href="_opentelemetry_sdk-node.logs.BatchLogRecordProcessor.html" class="tsd-signature-type tsd-kind-class">BatchLogRecordProcessor</a><a href="#constructorbatchlogrecordprocessor" 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">_exporter</span>: <a href="../modules/_opentelemetry_sdk-node.logs.html" class="tsd-signature-type tsd-kind-namespace">logs</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node.logs.LogRecordExporter.html" class="tsd-signature-type tsd-kind-interface">LogRecordExporter</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">config</span>: <a href="../modules/_opentelemetry_sdk-node.logs.html" class="tsd-signature-type tsd-kind-namespace">logs</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node.logs.BufferConfig.html" class="tsd-signature-type tsd-kind-interface">BufferConfig</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../modules/_opentelemetry_sdk-node.logs.html" class="tsd-signature-type tsd-kind-namespace">logs</a><span class="tsd-signature-symbol">.</span><a href="_opentelemetry_sdk-node.logs.BatchLogRecordProcessor.html" class="tsd-signature-type tsd-kind-class">BatchLogRecordProcessor</a></h4><aside class="tsd-sources"><p>Inherited from BatchLogRecordProcessorBase<BufferConfig>.constructor</p><ul><li>Defined in experimental/packages/sdk-logs/build/src/export/BatchLogRecordProcessorBase.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-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="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-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>Forces to export all finished log records</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>Inherited from BatchLogRecordProcessorBase.forceFlush</p><ul><li>Defined in experimental/packages/sdk-logs/build/src/export/BatchLogRecordProcessorBase.d.ts:16</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="onemit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>on<wbr/>Emit</span><a href="#onemit" 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="onemit-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">onEmit</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">logRecord</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node.logs.html" class="tsd-signature-type tsd-kind-namespace">logs</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node.logs.SdkLogRecord.html" class="tsd-signature-type tsd-kind-interface">SdkLogRecord</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#onemit-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>Called when a LogRecord is emit</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">logRecord</span>: <a href="../modules/_opentelemetry_sdk-node.logs.html" class="tsd-signature-type tsd-kind-namespace">logs</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node.logs.SdkLogRecord.html" class="tsd-signature-type tsd-kind-interface">SdkLogRecord</a></span><div class="tsd-comment tsd-typography"><p>the ReadWriteLogRecord that just emitted.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></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 BatchLogRecordProcessorBase.onEmit</p><ul><li>Defined in experimental/packages/sdk-logs/build/src/export/BatchLogRecordProcessorBase.d.ts:15</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=""><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">void</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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Overrides BatchLogRecordProcessorBase.onShutdown</p><ul><li>Defined in experimental/packages/sdk-logs/build/src/platform/node/export/BatchLogRecordProcessor.d.ts:4</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-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 processor. Called when SDK is shut down. This is an
|
||
opportunity for processor to do any cleanup required.</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>Inherited from BatchLogRecordProcessorBase.shutdown</p><ul><li>Defined in experimental/packages/sdk-logs/build/src/export/BatchLogRecordProcessorBase.d.ts:17</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="#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="#onemit" 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>on<wbr/>Emit</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="#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>
|