@opentelemetry/exporter-logs-otlp-proto

What is @opentelemetry/exporter-logs-otlp-proto?

@opentelemetry/exporter-logs-otlp-proto is an npm package that allows you to export logs using the OpenTelemetry Protocol (OTLP) in protobuf format. This package is part of the OpenTelemetry project, which provides a set of APIs, libraries, agents, and instrumentation to enable observability in your applications.

What are @opentelemetry/exporter-logs-otlp-proto's main functionalities?

Exporting Logs

This feature allows you to export logs to an OTLP endpoint using the protobuf format. The code sample demonstrates how to set up the OTLPProtoLogExporter, create a LoggerProvider, and emit a log message.

const { OTLPProtoLogExporter } = require('@opentelemetry/exporter-logs-otlp-proto');
const { LoggerProvider } = require('@opentelemetry/sdk-logs');
const { SimpleLogRecordProcessor } = require('@opentelemetry/sdk-logs');

const exporter = new OTLPProtoLogExporter({
  url: 'http://localhost:4317',
});

const loggerProvider = new LoggerProvider();
loggerProvider.addLogRecordProcessor(new SimpleLogRecordProcessor(exporter));

const logger = loggerProvider.getLogger('example-logger');

logger.emit({
  severityText: 'INFO',
  body: 'This is an example log message',
});

Other packages similar to @opentelemetry/exporter-logs-otlp-proto

@opentelemetry/exporter-logs-otlp-http

@opentelemetry/exporter-logs-otlp-http is another exporter for OpenTelemetry logs, but it uses HTTP instead of protobuf for communication. This package is useful if you prefer or require HTTP for log export.

@opentelemetry/exporter-logs-otlp-grpc

@opentelemetry/exporter-logs-otlp-grpc is similar to @opentelemetry/exporter-logs-otlp-proto but uses gRPC for communication instead of protobuf. This can be useful if your infrastructure is set up to use gRPC.

README

An OTLP exporter to send logs using protobuf over HTTP

Note: This is an experimental package under active development. New releases may include breaking changes.

This module provides a logs-exporter for OTLP (http/protobuf) using protocol version v0.20.0.

Installation

npm install --save @opentelemetry/exporter-logs-otlp-proto

Further Documentation

To see documentation and sample code for the traces exporter, as well as instructions for using TLS, see the exporter-trace-otlp-proto package. To see documentation and sample code for the metric exporter, see the exporter-trace-otlp-proto package.

Example Setup

const { LoggerProvider, SimpleLogRecordProcessor } = require('@opentelemetry/sdk-logs');
const { OTLPLogExporter } =  require('@opentelemetry/exporter-logs-otlp-proto');

const collectorOptions = {
  url: '<opentelemetry-collector-url>', // url is optional and can be omitted - default is http://localhost:4318/v1/logs
  headers: {
    foo: 'bar'
  }, //an optional object containing custom headers to be sent with each request will only work with http
};

const logProvider = new LoggerProvider({resource: new Resource({'service.name': 'testApp'})});
const logExporter = new OTLPLogExporter(collectorOptions);
logProvider.addLogRecordProcessor(new SimpleLogRecordProcessor(exporter));

const logger = logProvider.getLogger('test_log_instrumentation');

logger.emit({
  //log data to emit
})

Exporter Timeout Configuration

The OTLPLogExporter has a timeout configuration option which is the maximum time, in milliseconds, the OTLP exporter will wait for each batch export. The default value is 10000ms.

To override the default timeout duration, use the following options:

• Set with environment variables:

  | Environment variable | Description | ------------------------------|----------------------|-------------| | OTEL_EXPORTER_OTLP_LOGS_TIMEOUT | The maximum waiting time, in milliseconds, allowed to send each OTLP trace batch. Default is 10000. | | OTEL_EXPORTER_OTLP_TIMEOUT | The maximum waiting time, in milliseconds, allowed to send each OTLP trace and metric batch. Default is 10000. |

  OTEL_EXPORTER_OTLP_LOGS_TIMEOUT takes precedence and overrides OTEL_EXPORTER_OTLP_TIMEOUT.

• Provide timeoutMillis to OTLPLogExporter with collectorOptions:

  const collectorOptions = {
    timeoutMillis: 15000,
    url: '<opentelemetry-collector-url>', // url is optional and can be omitted - default is http://localhost:4318/v1/logs
    headers: {
      foo: 'bar'
    }, //an optional object containing custom headers to be sent with each request will only work with http
  };
  
  const exporter = new OTLPLogExporter(collectorOptions);
  

  Providing timeoutMillis with collectorOptions takes precedence and overrides timeout set with environment variables.

OTLP Exporter Retry

OTLP requires that transient errors be handled with a retry strategy.

This retry policy has the following configuration, which there is currently no way to customize.

• DEFAULT_EXPORT_MAX_ATTEMPTS: The maximum number of attempts, including the original request. Defaults to 5.
• DEFAULT_EXPORT_INITIAL_BACKOFF: The initial backoff duration. Defaults to 1 second.
• DEFAULT_EXPORT_MAX_BACKOFF: The maximum backoff duration. Defaults to 5 seconds.
• DEFAULT_EXPORT_BACKOFF_MULTIPLIER: The backoff multiplier. Defaults to 1.5.

This retry policy first checks if the response has a 'Retry-After' header. If there is a 'Retry-After' header, the exporter will wait the amount specified in the 'Retry-After' header before retrying. If there is no 'Retry-After' header, the exporter will use an exponential backoff with jitter retry strategy.

The exporter will retry exporting within the exporter timeout configuration time.

Useful links

• For more information on OpenTelemetry, visit: https://opentelemetry.io/
• For more about OpenTelemetry JavaScript: https://github.com/open-telemetry/opentelemetry-js
• For help or feedback on this project, join us in GitHub Discussions

License

Apache 2.0 - See LICENSE for more information.