@opentelemetry/exporter-logs-otlp-http

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

@opentelemetry/exporter-logs-otlp-http is an OpenTelemetry component that allows you to export logs to an OpenTelemetry Collector or other backend that supports the OTLP (OpenTelemetry Protocol) over HTTP. This package is useful for sending log data from your application to a centralized logging system for analysis and monitoring.

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

Exporting Logs

This code demonstrates how to set up the @opentelemetry/exporter-logs-otlp-http package to export logs to an OTLP endpoint. It configures a logger provider, sets up an OTLP log exporter, and emits a log message.

const { diag, DiagConsoleLogger, DiagLogLevel } = require('@opentelemetry/api');
const { Resource } = require('@opentelemetry/resources');
const { SimpleLogRecordProcessor, LoggerProvider } = require('@opentelemetry/sdk-logs');
const { OTLPLogExporter } = require('@opentelemetry/exporter-logs-otlp-http');

// Set up diagnostic logger
diag.setLogger(new DiagConsoleLogger(), DiagLogLevel.DEBUG);

// Create a resource
const resource = new Resource({
  'service.name': 'my-service',
});

// Create a logger provider
const loggerProvider = new LoggerProvider({
  resource: resource,
});

// Create an OTLP log exporter
const exporter = new OTLPLogExporter({
  url: 'http://localhost:4318/v1/logs',
});

// Add a log record processor
loggerProvider.addLogRecordProcessor(new SimpleLogRecordProcessor(exporter));

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

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

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

@opentelemetry/exporter-logs-otlp-grpc

@opentelemetry/exporter-logs-otlp-grpc is similar to @opentelemetry/exporter-logs-otlp-http but uses gRPC instead of HTTP for communication. This can be beneficial in environments where gRPC is preferred for its performance benefits and bi-directional streaming capabilities.

winston

Winston is a popular logging library for Node.js that supports multiple transports (e.g., console, file, HTTP). While it does not natively support OTLP, it can be extended with custom transports to send logs to an OpenTelemetry Collector or other backend.

bunyan

Bunyan is another logging library for Node.js that focuses on JSON log output. Like Winston, it does not natively support OTLP but can be extended with custom streams to send logs to an OpenTelemetry Collector or other backend.

README

OpenTelemetry Collector Logs Exporter for web and node with HTTP

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

This module provides an exporter for OTLP (http/json) logs using protocol version v0.18.

Installation

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

Further Documentation

To see documentation and sample code for the traces exporter, as well as instructions for using TLS, visit the Collector Trace Exporter for web and node. To see documentation and sample code for the metric exporter, see the exporter-metrics-otlp-grpc package

Logs in Web

The OTLPLogExporter in Web expects the endpoint to end in /v1/logs.

import { SeverityNumber } from '@opentelemetry/api-logs';
import {
  LoggerProvider,
  BatchLogRecordProcessor,
} from '@opentelemetry/sdk-logs';
import { OTLPLogExporter } from '@opentelemetry/exporter-logs-otlp-http';

// exporter options. see all options in OTLPExporterConfigBase
const collectorOptions = {
  url: '<opentelemetry-collector-url>', // url is optional and can be omitted - default is http://localhost:4318/v1/logs
  headers: {}, // an optional object containing custom headers to be sent with each request
  concurrencyLimit: 1, // an optional limit on pending requests
};
const logExporter = new OTLPLogExporter(collectorOptions);
const loggerProvider = new LoggerProvider();

loggerProvider.addLogRecordProcessor(new BatchLogRecordProcessor(logExporter));

const logger = loggerProvider.getLogger('default', '1.0.0');
// Emit a log
logger.emit({
  severityNumber: SeverityNumber.INFO,
  severityText: 'info',
  body: 'this is a log body',
  attributes: { 'log.type': 'custom' },
});

Logs in Node

import {
  LoggerProvider,
  BatchLogRecordProcessor,
} from '@opentelemetry/sdk-logs';
import { OTLPLogsExporter } from '@opentelemetry/exporter-logs-otlp-http';

// exporter options. see all options in OTLPExporterNodeConfigBase
const collectorOptions = {
  url: '<opentelemetry-collector-url>', // url is optional and can be omitted - default is http://localhost:4318/v1/logs
  concurrencyLimit: 1, // an optional limit on pending requests
};
const logExporter = new OTLPLogExporter(collectorOptions);
const loggerProvider = new LoggerProvider();

loggerProvider.addLogRecordProcessor(new BatchLogRecordProcessor(logExporter));

const logger = loggerProvider.getLogger('default', '1.0.0');
// Emit a log
logger.emit({
  severityNumber: SeverityNumber.INFO,
  severityText: 'info',
  body: 'this is a log body',
  attributes: { 'log.type': 'custom' },
});

Environment Variable Configuration

In addition to settings passed to the constructor, the exporter also supports configuration via environment variables:

Environment variable	Description
OTEL_EXPORTER_OTLP_ENDPOINT	The endpoint to send logs to. This will also be used for the traces exporter if OTEL_EXPORTER_OTLP_TRACES_ENDPOINT is not configured. By default http://localhost:4318 will be used. /v1/logs will be automatically appended to configured values.
OTEL_EXPORTER_OTLP_LOGS_ENDPOINT	The endpoint to send logs to. By default https://localhost:4318/v1/logs will be used. v1/logs will not be appended automatically and has to be added explicitly.
OTEL_EXPORTER_OTLP_LOGS_TIMEOUT	The maximum waiting time, in milliseconds, allowed to send each OTLP log batch. Default is 10000.
OTEL_EXPORTER_OTLP_TIMEOUT	The maximum waiting time, in milliseconds, allowed to send each OTLP trace/metric/log batch. Default is 10000.

Settings configured programmatically take precedence over environment variables. Per-signal environment variables take precedence over non-per-signal environment variables.

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.