@opentelemetry/otlp-exporter-base

What is @opentelemetry/otlp-exporter-base?

@opentelemetry/otlp-exporter-base is a foundational package for OpenTelemetry that provides base classes and utilities for creating OTLP (OpenTelemetry Protocol) exporters. These exporters are used to send telemetry data such as traces and metrics to an OTLP endpoint.

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

BaseExporter

The BaseExporter class provides a foundation for creating custom OTLP exporters. You can extend this class to implement your own logic for sending telemetry data.

const { BaseExporter } = require('@opentelemetry/otlp-exporter-base');

class MyCustomExporter extends BaseExporter {
  constructor(config) {
    super(config);
  }

  onInit(config) {
    // Initialize exporter with config
  }

  onShutdown() {
    // Cleanup resources
  }

  send(objects, onSuccess, onError) {
    // Send telemetry data
    onSuccess();
  }
}

const exporter = new MyCustomExporter({});

OTLPExporterConfig

The OTLPExporterConfig class is used to configure the OTLP exporter. It allows you to set properties such as the endpoint URL and headers for authentication.

const { OTLPExporterConfig } = require('@opentelemetry/otlp-exporter-base');

const config = new OTLPExporterConfig({
  url: 'http://localhost:4317',
  headers: {
    'Authorization': 'Bearer token'
  }
});

console.log(config);

Exporting Traces

This example demonstrates how to create a custom trace exporter by extending the BaseExporter class. The send method is implemented to handle the export of trace data.

const { BaseExporter } = require('@opentelemetry/otlp-exporter-base');
const { ReadableSpan } = require('@opentelemetry/sdk-trace-base');

class TraceExporter extends BaseExporter {
  send(spans, onSuccess, onError) {
    // Convert spans to OTLP format and send
    onSuccess();
  }
}

const exporter = new TraceExporter({});
const span = new ReadableSpan({
  name: 'example-span',
  startTime: Date.now(),
  endTime: Date.now() + 1000
});

exporter.export([span], () => console.log('Export successful'), (err) => console.error('Export failed', err));

Other packages similar to @opentelemetry/otlp-exporter-base

@opentelemetry/exporter-collector

@opentelemetry/exporter-collector is another package in the OpenTelemetry ecosystem that provides exporters for sending telemetry data to the OpenTelemetry Collector. It offers similar functionalities to @opentelemetry/otlp-exporter-base but is more specialized for integration with the OpenTelemetry Collector.

@opentelemetry/exporter-zipkin

@opentelemetry/exporter-zipkin is an OpenTelemetry exporter for sending trace data to Zipkin. While it serves a similar purpose of exporting telemetry data, it is specifically designed for Zipkin, unlike @opentelemetry/otlp-exporter-base which is more generic and can be extended for various OTLP endpoints.

@opentelemetry/exporter-prometheus

@opentelemetry/exporter-prometheus is an exporter for sending metrics data to Prometheus. It is similar to @opentelemetry/otlp-exporter-base in that it exports telemetry data, but it is specifically tailored for Prometheus metrics.

README

OpenTelemetry Collector Exporter for web and node

Note: This package is intended for internal use only.

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

This module provides a base exporter for web and node to be used with opentelemetry-collector.

Installation

npm install --save @opentelemetry/otlp-exporter-base

GRPC

For GRPC please check npm-url-grpc

PROTOBUF

For PROTOBUF please check npm-url-proto

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.