@opentelemetry/exporter-otlp-http

OpenTelemetry Collector Exporter for web and node

This module provides exporter for web and node to be used with opentelemetry-collector - last tested with version 0.25.0.

Installation

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

Service Name

The OpenTelemetry Collector Exporter does not have a service name configuration. In order to set the service name, use the service.name resource attribute as prescribed in the OpenTelemetry Resource Semantic Conventions.

Traces in Web

The OTLPTraceExporter in Web expects the endpoint to end in /v1/traces.

import { BatchSpanProcessor } from '@opentelemetry/sdk-trace-base';
import { WebTracerProvider } from '@opentelemetry/sdk-trace-web';
import { OTLPTraceExporter } from '@opentelemetry/exporter-otlp-http';

const collectorOptions = {
  url: '<opentelemetry-collector-url>', // url is optional and can be omitted - default is http://localhost:55681/v1/traces
  headers: {}, // an optional object containing custom headers to be sent with each request
  concurrencyLimit: 10, // an optional limit on pending requests
};

const provider = new WebTracerProvider();
const exporter = new OTLPTraceExporter(collectorOptions);
provider.addSpanProcessor(new BatchSpanProcessor(exporter, {
  // The maximum queue size. After the size is reached spans are dropped.
  maxQueueSize: 100,
  // The maximum batch size of every export. It must be smaller or equal to maxQueueSize.
  maxExportBatchSize: 10,
  // The interval between two consecutive exports
  scheduledDelayMillis: 500,
  // How long the export can run before it is cancelled
  exportTimeoutMillis: 30000,
}));

provider.register();

Metrics in Web

The OTLPMetricExporter in Web expects the endpoint to end in /v1/metrics.

import { MeterProvider } from '@opentelemetry/sdk-metrics-base';
import { OTLPMetricExporter } from '@opentelemetry/exporter-otlp-http';
const collectorOptions = {
  url: '<opentelemetry-collector-url>', // url is optional and can be omitted - default is http://localhost:55681/v1/metrics
  headers: {}, // an optional object containing custom headers to be sent with each request
  concurrencyLimit: 1, // an optional limit on pending requests
};
const exporter = new OTLPMetricExporter(collectorOptions);

// Register the exporter
const meter = new MeterProvider({
  exporter,
  interval: 60000,
}).getMeter('example-meter');

// Now, start recording data
const counter = meter.createCounter('metric_name');
counter.add(10, { 'key': 'value' });

Traces in Node - JSON over http

const { BasicTracerProvider, BatchSpanProcessor } = require('@opentelemetry/sdk-trace-base');
const { OTLPTraceExporter } =  require('@opentelemetry/exporter-otlp-http');

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

const provider = new BasicTracerProvider();
const exporter = new OTLPTraceExporter(collectorOptions);
provider.addSpanProcessor(new BatchSpanProcessor(exporter, {
  // The maximum queue size. After the size is reached spans are dropped.
  maxQueueSize: 1000,
  // The interval between two consecutive exports
  scheduledDelayMillis: 30000,
}));

provider.register();

Metrics in Node

const { MeterProvider } = require('@opentelemetry/sdk-metrics-base');
const { OTLPMetricExporter } =  require('@opentelemetry/exporter-otlp-http');
const collectorOptions = {
  url: '<opentelemetry-collector-url>', // url is optional and can be omitted - default is http://localhost:55681/v1/metrics
  concurrencyLimit: 1, // an optional limit on pending requests
};
const exporter = new OTLPMetricExporter(collectorOptions);

// Register the exporter
const meter = new MeterProvider({
  exporter,
  interval: 60000,
}).getMeter('example-meter');

// Now, start recording data
const counter = meter.createCounter('metric_name');
counter.add(10, { 'key': 'value' });

GRPC

For GRPC please check npm-url-grpc

PROTOBUF

For PROTOBUF please check npm-url-proto

Configuration options as environment variables

Instead of providing options to OTLPMetricExporter and OTLPTraceExporter explicitly, environment variables may be provided instead.

OTEL_EXPORTER_OTLP_ENDPOINT=https://localhost:4317
# this will automatically append the version and signal path
# e.g. https://localhost:4317/v1/traces for `OTLPTraceExporter` and https://localhost:4317/v1/metrics for `OTLPMetricExporter`

If the trace and metric exporter endpoints have different providers, the env var for per-signal endpoints are available to use

OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=https://trace-service:4317/v1/traces
OTEL_EXPORTER_OTLP_METRICS_ENDPOINT=https://metric-service:4317/v1/metrics
# version and signal needs to be explicit

The per-signal endpoints take precedence and overrides OTEL_EXPORTER_OTLP_ENDPOINT

For more details, see OpenTelemetry Specification on Protocol Exporter.

Running opentelemetry-collector locally to see the traces

1. Go to examples/otlp-exporter-node
2. run npm run docker:start
3. Open page at http://localhost:9411/zipkin/ to observe the traces

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.

Changelog

0.26.0

:boom: Breaking Change

• opentelemetry-exporter-collector-grpc, opentelemetry-exporter-otlp-grpc, opentelemetry-exporter-otlp-http, opentelemetry-exporter-otlp-proto
  • #2476 chore!: rename collector exporters (@dyladan)
• opentelemetry-core, opentelemetry-instrumentation-grpc, opentelemetry-sdk-trace-base, opentelemetry-shim-opentracing
  • #2429 fix!: remove 'Http' from W3C propagator names (@aabmass)

:rocket: (Enhancement)

• opentelemetry-core, opentelemetry-sdk-trace-base
  • #2430 feat(opentelemetry-sdk-trace-base): implemented general limits of attributes (@banothurameshnaik)
  • #2418 feat(opentelemetry-sdk-trace-base): implemented option to limit length of values of attributes (@banothurameshnaik)
• opentelemetry-instrumentation
  • #2450 fix: handle missing package.json file when checking for version (@nozik)
• opentelemetry-semantic-conventions
  • #2456 feat: upgrade semantic conventions to the latest 1.6.1 version (@weyert)
• opentelemetry-exporter-collector-proto, opentelemetry-exporter-collector
  • #2438 feat: OTEL_EXPORTER_OTLP_ENDPOINT append version and signal (@longility)

:bug: (Bug Fix)

• Other
  • #2494 fix: remove setting http.route in http span attributes (@mustafain117)
• opentelemetry-instrumentation-fetch
  • #2426 fix(opentelemetry-instrumentation-fetch): fixed override of headers (@philipszalla)
• opentelemetry-sdk-trace-base
  • #2434 fix: ReferenceError when OTEL_TRACES_SAMPLER used without OTEL_TRACES_SAMPLER_ARG (@hermanbanken)

:books: (Refine Doc)

• #2478 Update links to packages moved to experimental (@jessitron)
• #2463 docs(README): Fix links in README.md (@JamesJHPark)
• #2437 docs(examples): updated examples readme links (@banothurameshnaik)
• #2421 docs(website): support GH page links to canonical src (@chalin)
• #2408 docs: make link to exporters filter only exporters (@Rauno56)
• #2297 eslint configuration for getting-started examples (@alisabzevari)

:house: (Internal)

• opentelemetry-exporter-otlp-http
  • #2490 chore: mark otlp exporters experimental (@dyladan)
  • #2491 fix: remove usage of serviceName property in tests for otel collector (@mustafain117)
• opentelemetry-sdk-node
  • #2473 chore: move sdk-node to experimental (@dyladan)
  • #2453 chore(sdk-node): fix lint warnings (@alisabzevari)
• Other
  • #2469 Drop website_docs folder (@chalin)
  • #2474 chore: move missed test file to its package (@dyladan)
  • #2435 chore: simplify unit test cache (@dyladan)
• opentelemetry-context-zone, opentelemetry-core, opentelemetry-exporter-collector-grpc, opentelemetry-exporter-collector-proto, opentelemetry-exporter-collector, opentelemetry-exporter-prometheus, opentelemetry-exporter-zipkin, opentelemetry-instrumentation-fetch, opentelemetry-instrumentation-grpc, opentelemetry-instrumentation-http, opentelemetry-instrumentation-xml-http-request, opentelemetry-propagator-b3, opentelemetry-propagator-jaeger, opentelemetry-resources, opentelemetry-sdk-metrics-base, opentelemetry-sdk-node, opentelemetry-sdk-trace-base, opentelemetry-sdk-trace-web
  • #2462 chore: split stable and experimental packages into groups using directories (@dyladan)
• opentelemetry-instrumentation-http
  • #2126 feat(instrumentation-http): add diag debug on http request events (@Asafb26)
  • #2455 chore(instrumentation-http): fix lint warnings (@alisabzevari)
• opentelemetry-instrumentation-fetch
  • #2454 chore(instrumentation-fetch): fix lint warnings (@alisabzevari)
• opentelemetry-exporter-collector
  • #2452 chore(exporter-collector): fix lint warnings (@alisabzevari)
• opentelemetry-sdk-trace-base, opentelemetry-sdk-trace-node
  • #2446 chore(sdk-trace): fix lint warnings (@alisabzevari)
• opentelemetry-exporter-prometheus, opentelemetry-exporter-zipkin, opentelemetry-shim-opentracing
  • #2447 chore(exporter): fix lint warnings (@alisabzevari)

Committers: 18

• Aaron Abbott (@aabmass)
• Ali Sabzevari (@alisabzevari)
• Asaf Ben Aharon (@Asafb26)
• Banothu Ramesh Naik (@banothurameshnaik)
• Daniel Dyla (@dyladan)
• Gerhard Stöbich (@Flarna)
• Herman (@hermanbanken)
• James (@JamesJHPark)
• Jessica Kerr (@jessitron)
• Long Mai (@longility)
• Mustafain Ali Khan (@mustafain117)
• Patrice Chalin (@chalin)
• Philip Szalla (@philipszalla)
• Ran Nozik (@nozik)
• Rauno Viskus (@Rauno56)
• Siim Kallas (@seemk)
• Weyert de Boer (@weyert)
• legendecas (@legendecas)