@opentelemetry/exporter-collector

OpenTelemetry Collector Exporter for web and node

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

Installation

npm install --save @opentelemetry/exporter-collector

Usage in Web

The CollectorExporter in Web expects the endpoint to end in /v1/trace.

import { SimpleSpanProcessor } from '@opentelemetry/tracing';
import { WebTracerProvider } from '@opentelemetry/web';
import { CollectorExporter } from '@opentelemetry/exporter-collector';

const collectorOptions = {
  url: '<opentelemetry-collector-url>', // url is optional and can be omitted - default is http://localhost:55678/v1/trace
  headers: {}, //an optional object containing custom headers to be sent with each request
};

const provider = new WebTracerProvider();
const exporter = new CollectorExporter(collectorOptions);
provider.addSpanProcessor(new SimpleSpanProcessor(exporter));

provider.register();

Usage in Node

The CollectorExporter in Node expects the URL to only be the hostname. It will not work with /v1/trace.

const { BasicTracerProvider, SimpleSpanProcessor } = require('@opentelemetry/tracing');
const { CollectorExporter } =  require('@opentelemetry/exporter-collector');

const collectorOptions = {
  serviceName: 'basic-service',
  url: '<opentelemetry-collector-url>' // url is optional and can be omitted - default is localhost:55678
};

const provider = new BasicTracerProvider();
const exporter = new CollectorExporter(collectorOptions);
provider.addSpanProcessor(new SimpleSpanProcessor(exporter));

provider.register();

By default, plaintext connection is used. In order to use TLS in Node.js, provide credentials option like so:

const fs = require('fs');
const grpc = require('grpc');
const { BasicTracerProvider, SimpleSpanProcessor } = require('@opentelemetry/tracing');
const { CollectorExporter } =  require('@opentelemetry/exporter-collector');

const collectorOptions = {
  serviceName: 'basic-service',
  url: '<opentelemetry-collector-url>', // url is optional and can be omitted - default is localhost:55678
  credentials: grpc.credentials.createSsl(
    fs.readFileSync('./ca.crt'),
    fs.readFileSync('./client.key'),
    fs.readFileSync('./client.crt')
  )
};

const provider = new BasicTracerProvider();
const exporter = new CollectorExporter(collectorOptions);
provider.addSpanProcessor(new SimpleSpanProcessor(exporter));

provider.register();

To see how to generate credentials, you can refer to the script used to generate certificates for tests here

The exporter can be configured to send custom metadata with each request as in the example below:

const grpc = require('grpc');
const { BasicTracerProvider, SimpleSpanProcessor } = require('@opentelemetry/tracing');
const { CollectorExporter } =  require('@opentelemetry/exporter-collector');

const metadata = new grpc.Metadata();
metadata.set('k', 'v');

const collectorOptions = {
  serviceName: 'basic-service',
  url: '<opentelemetry-collector-url>', // url is optional and can be omitted - default is localhost:55678
  metadata, // // an optional grpc.Metadata object to be sent with each request
};

const provider = new BasicTracerProvider();
const exporter = new CollectorExporter(collectorOptions);
provider.addSpanProcessor(new SimpleSpanProcessor(exporter));

provider.register();

Note, that this will only work if TLS is also configured on the server.

Running opentelemetry-collector locally to see the traces

1. Go to examples/basic-tracer-node
2. run npm run collector:docker:ot
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 on gitter

License

Apache 2.0 - See LICENSE for more information.

Changelog

0.9.0

:boom: Breaking Change

• opentelemetry-api, opentelemetry-exporter-prometheus, opentelemetry-metrics
  • #1120 feat: add the UpDownCounter instrument (@mayurkale22)
  • #1126 feat!: remove label keys as they are no longer part of the spec (@naseemkullah)
• opentelemetry-api, opentelemetry-metrics
  • #1117 chore: rename meaure to value recorder (@dyladan)
• opentelemetry-api, opentelemetry-core, opentelemetry-tracing
  • #1058 feat: spec compliant sampling result support (@legendecas)

:rocket: (Enhancement)

• Other
  • #1181 feat: add node-plugins-all package (@dyladan)
• opentelemetry-plugin-fetch, opentelemetry-plugin-xml-http-request, opentelemetry-web
  • #1121 chore: adding plugin-fetch and example (@obecny)
• opentelemetry-node
  • #1153 feat: add OPENTELEMETRY_NO_PATCH_MODULES (@markwolff)
  • #1151 chore(todo): add missing span sampling test (@markwolff)
• opentelemetry-exporter-jaeger
  • #965 feat(opentelemetry-exporter-jaeger): http sender (@leonardodalcin)
• opentelemetry-exporter-zipkin
  • #1138 feat(opentelemetry-js): infer zipkin service name from resource (@rezakrimi)
• opentelemetry-plugin-xml-http-request
  • #1133 fix(plugin-xml-http-request): support sync requests (@johnbley)
• opentelemetry-metrics
  • #1145 chore: creating new metric kind (@obecny)
• opentelemetry-exporter-collector
  • #1204 feat: collector exporter custom headers and metadata (@mwear)
• opentelemetry-exporter-zipkin
  • #1202 Adds possibility to set headers to zipkin exporter (@obecny)

:bug: (Bug Fix)

• opentelemetry-exporter-collector
  • #1197 fix(exporter-collector): default endpoint for node and browser (@davidwitten)
• opentelemetry-context-zone-peer-dep
  • #1209 chore: fixing zone from which to fork a new zone (@obecny)

:sparkles: (Feature)

• opentelemetry-semantic-conventions
  • #1160 refactor(attributes): move enums to @opentelemetry/semantic-conventions (@markwolff)

:books: (Refine Doc)

• Other
  • #1192 Fix_typo (@shivkanya9146)
  • #1147 ci: lint markdown files (@naseemkullah)
  • #1142 chore: template prometheus endpoint in examples rather than hardcode (@naseemkullah)
  • #1217 chore: fix markdown linting and add npm script (@dyladan)

Committers: 13

• David W. (@davidwitten)
• Bartlomiej Obecny (@obecny)
• Daniel Dyla (@dyladan)
• Mark Wolff (@markwolff)
• Mayur Kale (@mayurkale22)
• Naseem (@naseemkullah)
• Valentin Marchaud (@vmarchaud)
• legendecas (@legendecas)
• Shivkanya Andhare (@shivkanya9146)
• Leonardo Dalcin (@leonardodalcin)
• @rezakrimi
• John Bley (@johnbley)
• Matthew Wear (@mwear)