OpenTelemetry Protocol

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 package provides everything needed to serialize OpenTelemetry SDK traces, metrics and logs into the OpenTelemetry Protocol format.

Quick Start

To get started you will need to install a compatible OpenTelemetry API.

Install Peer Dependencies

npm install @opentelemetry/api

Serialize Traces/Metrics/Logs

This module exports functions to serialize traces, metrics and logs from the OpenTelemetry SDK into protocol buffers which can be sent over HTTP to the OpenTelemetry collector or a compatible receiver.

import {
  createExportTraceServiceRequest,
  createExportMetricsServiceRequest,
  createExportLogsServiceRequest,
} from '@opentelemetry/otlp-transformer';

const serializedSpans = createExportTraceServiceRequest(readableSpans);
const serializedMetrics = createExportMetricsServiceRequest(readableMetrics);
const serializedLogs = createExportLogsServiceRequest(readableLogRecords);

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.