# @opentelemetry/exporter-otlp-http > OpenTelemetry Collector Exporter allows user to send collected traces to the OpenTelemetry Collector Latest version **0.26.0** (published 2021-10-05) · Apache-2.0 license · 0 weekly downloads > **Deprecated.** This package is deprecated. ## Install ```sh npm install @opentelemetry/exporter-otlp-http pnpm add @opentelemetry/exporter-otlp-http yarn add @opentelemetry/exporter-otlp-http bun add @opentelemetry/exporter-otlp-http ``` ## Health **Score 10/100 (F)** — status: deprecated. Negative: deprecated. ## Facts | | | |---|---| | Version | 0.26.0 | | Published | 2021-10-05 | | First published | 2021-10-05 | | Weekly downloads | 0 | | License | Apache-2.0 | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Node | >=8.0.0 | | Dependencies | 5 | | Unpacked size | 370 KB | | Known vulnerabilities | 0 (+1 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 3482 | | Author | OpenTelemetry Authors | | Maintainers | mayurkale22, bogdandrutu, dyladan, obecny | | Keywords | opentelemetry, nodejs, browser, tracing, profiling, metrics, stats | ## Links - npm: https://www.npmjs.com/package/@opentelemetry/exporter-otlp-http - Repository: https://github.com/open-telemetry/opentelemetry-js - Homepage: https://github.com/open-telemetry/opentelemetry-js#readme - Issues: https://github.com/open-telemetry/opentelemetry-js/issues - npm.io page: https://npm.io/package/@opentelemetry/exporter-otlp-http ## Dependencies (5) - [@opentelemetry/core](https://npm.io/package/@opentelemetry/core.md) 1.0.0 - [@opentelemetry/resources](https://npm.io/package/@opentelemetry/resources.md) 1.0.0 - [@opentelemetry/api-metrics](https://npm.io/package/@opentelemetry/api-metrics.md) 0.26.0 - [@opentelemetry/sdk-trace-base](https://npm.io/package/@opentelemetry/sdk-trace-base.md) 1.0.0 - [@opentelemetry/sdk-metrics-base](https://npm.io/package/@opentelemetry/sdk-metrics-base.md) 0.26.0 ## Alternatives - [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads - [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads - [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads - [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads - [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads ## Recent versions - 0.26.0 (latest) — 2021-10-05 ## README # OpenTelemetry Collector Exporter for web and node [![NPM Published Version][npm-img]][npm-url] [![dependencies][dependencies-image]][dependencies-url] [![devDependencies][devDependencies-image]][devDependencies-url] [![Apache License][license-image]][license-image] This module provides exporter for web and node to be used with [opentelemetry-collector][opentelemetry-collector-url] - last tested with version **0.25.0**. ## Installation ```bash 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][semconv-resource-service-name]. ## Traces in Web The OTLPTraceExporter in Web expects the endpoint to end in `/v1/traces`. ```js import { BatchSpanProcessor } from '@opentelemetry/sdk-trace-base'; import { WebTracerProvider } from '@opentelemetry/sdk-trace-web'; import { OTLPTraceExporter } from '@opentelemetry/exporter-otlp-http'; const collectorOptions = { 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`. ```js import { MeterProvider } from '@opentelemetry/sdk-metrics-base'; import { OTLPMetricExporter } from '@opentelemetry/exporter-otlp-http'; const collectorOptions = { 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 ```js const { BasicTracerProvider, BatchSpanProcessor } = require('@opentelemetry/sdk-trace-base'); const { OTLPTraceExporter } = require('@opentelemetry/exporter-otlp-http'); const collectorOptions = { 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 ```js const { MeterProvider } = require('@opentelemetry/sdk-metrics-base'); const { OTLPMetricExporter } = require('@opentelemetry/exporter-otlp-http'); const collectorOptions = { 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. ```sh 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 ```sh 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][opentelemetry-spec-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: - For more about OpenTelemetry JavaScript: - For help or feedback on this project, join us in [GitHub Discussions][discussions-url] ## License Apache 2.0 - See [LICENSE][license-url] for more information. [discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions [license-url]: https://github.com/open-telemetry/opentelemetry-js/blob/main/LICENSE [license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat [dependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js.svg?path=packages%2Fopentelemetry-exporter-otlp-http [dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-exporter-otlp-http [devDependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js.svg?path=packages%2Fopentelemetry-exporter-otlp-http&type=dev [devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-exporter-otlp-http&type=dev [npm-url]: https://www.npmjs.com/package/@opentelemetry/exporter-otlp-http [npm-url-grpc]: https://www.npmjs.com/package/@opentelemetry/exporter-otlp-grpc [npm-url-proto]: https://www.npmjs.com/package/@opentelemetry/exporter-otlp-proto [npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fexporter-collector.svg [opentelemetry-collector-url]: https://github.com/open-telemetry/opentelemetry-collector [opentelemetry-spec-protocol-exporter]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#configuration-options [semconv-resource-service-name]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/semantic_conventions/README.md#service --- _Source: https://npm.io/package/@opentelemetry/exporter-otlp-http · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._