54 lines
21 KiB
HTML
54 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>@opentelemetry/exporter-logs-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-logs-otlp-http.html">@opentelemetry/exporter-logs-otlp-http</a></li></ul><h1>Module @opentelemetry/exporter-logs-otlp-http</h1></div><section class="tsd-panel tsd-typography"><a id="opentelemetry-collector-logs-exporter-for-web-and-node-with-http" class="tsd-anchor"></a><h1 class="tsd-anchor-link">OpenTelemetry Collector Logs Exporter for web and node with HTTP<a href="#opentelemetry-collector-logs-exporter-for-web-and-node-with-http" 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-logs-otlp-http"><img src="https://badge.fury.io/js/%40opentelemetry%2Fexporter-logs-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 logs-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-logs-otlp-http</span>
|
|
</code><button type="button">Copy</button></pre>
|
|
|
|
<a id="further-documentation" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Further Documentation<a href="#further-documentation" 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>To see documentation and sample code for the traces exporter, as well as instructions for using TLS, 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>.
|
|
To see documentation and sample code for the metric exporter, see the <a href="https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-exporter-metrics-otlp-http">exporter-metrics-otlp-grpc package</a></p>
|
|
<a id="logs-in-web" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Logs in Web<a href="#logs-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 OTLPLogExporter in Web expects the endpoint to end in <code>/v1/logs</code>.</p>
|
|
<pre><code class="js"><span class="hl-7">import</span><span class="hl-1"> { </span><span class="hl-6">SeverityNumber</span><span class="hl-1"> } </span><span class="hl-7">from</span><span class="hl-1"> </span><span class="hl-2">'@opentelemetry/api-logs'</span><span class="hl-1">;</span><br/><span class="hl-7">import</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">LoggerProvider</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-6">BatchLogRecordProcessor</span><span class="hl-1">,</span><br/><span class="hl-1">} </span><span class="hl-7">from</span><span class="hl-1"> </span><span class="hl-2">'@opentelemetry/sdk-logs'</span><span class="hl-1">;</span><br/><span class="hl-7">import</span><span class="hl-1"> { </span><span class="hl-6">OTLPLogExporter</span><span class="hl-1"> } </span><span class="hl-7">from</span><span class="hl-1"> </span><span class="hl-2">'@opentelemetry/exporter-logs-otlp-http'</span><span class="hl-1">;</span><br/><br/><span class="hl-5">// exporter options. see all options in OTLPExporterConfigBase</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">'<opentelemetry-collector-url>'</span><span class="hl-1">, </span><span class="hl-5">// url is optional and can be omitted - default is http://localhost:4318/v1/logs</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">logExporter</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">OTLPLogExporter</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">loggerProvider</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">LoggerProvider</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-6">processors:</span><span class="hl-1"> [</span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">BatchRecordProcessor</span><span class="hl-1">(</span><span class="hl-6">logExporter</span><span class="hl-1">)]</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">logger</span><span class="hl-1"> = </span><span class="hl-6">loggerProvider</span><span class="hl-1">.</span><span class="hl-0">getLogger</span><span class="hl-1">(</span><span class="hl-2">'default'</span><span class="hl-1">, </span><span class="hl-2">'1.0.0'</span><span class="hl-1">);</span><br/><span class="hl-5">// Emit a log</span><br/><span class="hl-6">logger</span><span class="hl-1">.</span><span class="hl-0">emit</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-6">severityNumber:</span><span class="hl-1"> </span><span class="hl-6">SeverityNumber</span><span class="hl-1">.</span><span class="hl-4">INFO</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-6">severityText:</span><span class="hl-1"> </span><span class="hl-2">'info'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-6">body:</span><span class="hl-1"> </span><span class="hl-2">'this is a log body'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-6">attributes:</span><span class="hl-1"> { </span><span class="hl-2">'log.type'</span><span class="hl-6">:</span><span class="hl-1"> </span><span class="hl-2">'custom'</span><span class="hl-1"> },</span><br/><span class="hl-1">});</span>
|
|
</code><button type="button">Copy</button></pre>
|
|
|
|
<a id="logs-in-node" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Logs in Node<a href="#logs-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-7">import</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">LoggerProvider</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-6">BatchLogRecordProcessor</span><span class="hl-1">,</span><br/><span class="hl-1">} </span><span class="hl-7">from</span><span class="hl-1"> </span><span class="hl-2">'@opentelemetry/sdk-logs'</span><span class="hl-1">;</span><br/><span class="hl-7">import</span><span class="hl-1"> { </span><span class="hl-6">OTLPLogExporter</span><span class="hl-1"> } </span><span class="hl-7">from</span><span class="hl-1"> </span><span class="hl-2">'@opentelemetry/exporter-logs-otlp-http'</span><span class="hl-1">;</span><br/><br/><span class="hl-5">// exporter options. see all options in OTLPExporterNodeConfigBase</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">'<opentelemetry-collector-url>'</span><span class="hl-1">, </span><span class="hl-5">// url is optional and can be omitted - default is http://localhost:4318/v1/logs</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">logExporter</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">OTLPLogExporter</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">loggerProvider</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">LoggerProvider</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-6">processors:</span><span class="hl-1"> [</span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">BatchRecordProcessor</span><span class="hl-1">(</span><span class="hl-6">logExporter</span><span class="hl-1">)]</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">logger</span><span class="hl-1"> = </span><span class="hl-6">loggerProvider</span><span class="hl-1">.</span><span class="hl-0">getLogger</span><span class="hl-1">(</span><span class="hl-2">'default'</span><span class="hl-1">, </span><span class="hl-2">'1.0.0'</span><span class="hl-1">);</span><br/><span class="hl-5">// Emit a log</span><br/><span class="hl-6">logger</span><span class="hl-1">.</span><span class="hl-0">emit</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-6">severityNumber:</span><span class="hl-1"> </span><span class="hl-6">SeverityNumber</span><span class="hl-1">.</span><span class="hl-4">INFO</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-6">severityText:</span><span class="hl-1"> </span><span class="hl-2">'info'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-6">body:</span><span class="hl-1"> </span><span class="hl-2">'this is a log body'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-6">attributes:</span><span class="hl-1"> { </span><span class="hl-2">'log.type'</span><span class="hl-6">:</span><span class="hl-1"> </span><span class="hl-2">'custom'</span><span class="hl-1"> },</span><br/><span class="hl-1">});</span>
|
|
</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 logs 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/logs</code> will be automatically appended to configured values.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>OTEL_EXPORTER_OTLP_LOGS_ENDPOINT</td>
|
|
<td>The endpoint to send logs to. By default <code>https://localhost:4318/v1/logs</code> will be used. <code>v1/logs</code> will not be appended automatically and has to be added explicitly.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>OTEL_EXPORTER_OTLP_LOGS_TIMEOUT</td>
|
|
<td>The maximum waiting time, in milliseconds, allowed to send each OTLP log batch. Default is 10000.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>OTEL_EXPORTER_OTLP_TIMEOUT</td>
|
|
<td>The maximum waiting time, in milliseconds, allowed to send each OTLP trace/metric/log batch. Default is 10000.</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="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>
|
|
</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-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="otlplogexporter" 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-logs-otlp-http.OTLPLogExporter.html">OTLPLogExporter</a><a href="#otlplogexporter" 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-logs-exporter-for-web-and-node-with-http"><span>Open<wbr/>Telemetry <wbr/>Collector <wbr/>Logs <wbr/>Exporter for web and node with HTTP</span></a><ul><li><a href="#installation"><span>Installation</span></a></li><li><a href="#further-documentation"><span>Further <wbr/>Documentation</span></a></li><li><a href="#logs-in-web"><span>Logs in <wbr/>Web</span></a></li><li><a href="#logs-in-node"><span>Logs in <wbr/>Node</span></a></li><li><a href="#environment-variable-configuration"><span>Environment <wbr/>Variable <wbr/>Configuration</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-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="#otlplogexporter" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="../assets/icons.svg#icon-128"></use></svg><span>OTLPLog<wbr/>Exporter</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>
|