@opentelemetry/exporter-jaeger

What is @opentelemetry/exporter-jaeger?

@opentelemetry/exporter-jaeger is an npm package that allows you to export OpenTelemetry traces to Jaeger, a popular open-source distributed tracing system. This package is part of the OpenTelemetry project, which provides a set of APIs, libraries, agents, and instrumentation to enable observability for cloud-native software.

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

Exporting Traces to Jaeger

This code sample demonstrates how to set up the Jaeger exporter with OpenTelemetry in a Node.js application. It configures the exporter to send traces to a Jaeger instance running locally and starts a simple trace.

const { NodeTracerProvider } = require('@opentelemetry/node');
const { SimpleSpanProcessor } = require('@opentelemetry/tracing');
const { JaegerExporter } = require('@opentelemetry/exporter-jaeger');

const provider = new NodeTracerProvider();
const exporter = new JaegerExporter({
  serviceName: 'my-service',
  endpoint: 'http://localhost:14268/api/traces',
});

provider.addSpanProcessor(new SimpleSpanProcessor(exporter));
provider.register();

// Now you can start tracing your application
const tracer = provider.getTracer('example-tracer');
const span = tracer.startSpan('example-span');
span.end();

Configuring Exporter Options

This code sample shows how to configure additional options for the Jaeger exporter, such as setting custom tags and specifying the maximum packet size.

const exporter = new JaegerExporter({
  serviceName: 'my-service',
  endpoint: 'http://localhost:14268/api/traces',
  tags: [], // Optional: Add custom tags
  maxPacketSize: 65000, // Optional: Set max packet size
});

Other packages similar to @opentelemetry/exporter-jaeger

@opentelemetry/exporter-zipkin

@opentelemetry/exporter-zipkin is another exporter for OpenTelemetry that sends traces to Zipkin, another popular distributed tracing system. It is similar to @opentelemetry/exporter-jaeger but targets Zipkin instead of Jaeger.

jaeger-client

jaeger-client is a Jaeger client library for Node.js that provides similar functionality to @opentelemetry/exporter-jaeger but is not part of the OpenTelemetry project. It offers more direct integration with Jaeger but lacks the broader ecosystem support of OpenTelemetry.

opentracing-javascript

opentracing-javascript is the official OpenTracing library for JavaScript. While it provides a more general API for distributed tracing, it requires additional setup to export traces to Jaeger, unlike @opentelemetry/exporter-jaeger, which is specifically designed for this purpose.

README

OpenTelemetry Jaeger Trace Exporter

OpenTelemetry Jaeger Trace Exporter allows the user to send collected traces to Jaeger.

Jaeger, inspired by Dapper and OpenZipkin, is a distributed tracing system released as open source by Uber Technologies. It is used for monitoring and troubleshooting microservices-based distributed systems, including:

• Distributed context propagation
• Distributed transaction monitoring
• Root cause analysis
• Service dependency analysis
• Performance / latency optimization

Prerequisites

Get up and running with Jaeger in your local environment.

Jaeger stores and queries traces exported by applications instrumented with OpenTelemetry. The easiest way to start a Jaeger server is to paste the below:

docker run -d --name jaeger \
  -e COLLECTOR_ZIPKIN_HTTP_PORT=9411 \
  -p 5775:5775/udp \
  -p 6831:6831/udp \
  -p 6832:6832/udp \
  -p 5778:5778 \
  -p 16686:16686 \
  -p 14268:14268 \
  -p 9411:9411 \
  jaegertracing/all-in-one:latest

Or run the jaeger-all-in-one(.exe) executable from the binary distribution archives:

jaeger-all-in-one --collector.zipkin.http-port=9411

You can then navigate to http://localhost:16686 to access the Jaeger UI.

Installation

npm install --save @opentelemetry/exporter-jaeger

Usage

Install the exporter on your application and pass the options, it must contain a service name.

import { JaegerExporter } from '@opentelemetry/exporter-jaeger';

const options = {
  serviceName: 'my-service',
  tags: [], // optional
  host: 'localhost', // optional
  port: 6832, // optional
  maxPacketSize: 65000 // optional
}
const exporter = new JaegerExporter(options);

Now, register the exporter.

tracer.addSpanProcessor(new BatchSpanProcessor(exporter));

You can use built-in SimpleSpanProcessor or BatchSpanProcessor or write your own.

• SimpleSpanProcessor: The implementation of SpanProcessor that passes ended span directly to the configured SpanExporter.
• BatchSpanProcessor: The implementation of the SpanProcessor that batches ended spans and pushes them to the configured SpanExporter. It is recommended to use this SpanProcessor for better performance and optimization.

Useful links

• To know more about Jaeger, visit: https://www.jaegertracing.io/docs/latest/getting-started/
• 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.2.0

Released 2019-11-04

:rocket: (Enhancement)

• opentelemetry-shim-opentracing, opentelemetry-tracing, opentelemetry-types
  • #449 fix: allow recording links only at Span creation time
• opentelemetry-core, opentelemetry-node, opentelemetry-tracing, opentelemetry-types
  • #454 fix(span): rename span recording flag
• opentelemetry-metrics
  • #475 add shutdown method on MetricExporter interface
• opentelemetry-plugin-document-load
  • #469 chore: fixing problem with load event and performance for loadend
• opentelemetry-core, opentelemetry-plugin-document-load, opentelemetry-tracing, opentelemetry-web
  • #466 chore: fixing coverage for karma using istanbul

:bug: (Bug Fix)

• opentelemetry-tracing
  • #444 fix: batchSpanProcessor test failing intermittently
• opentelemetry-core
  • #472 fix(core): add missing semver dependency

:books: (Refine Doc)

• #462 chore: update README
• #460 chore: move members list out of community repo
• #445 chore: update CONTRIBUTING.md
• #459 chore: update API docs

:sparkles: (Feature)

• opentelemetry-metrics, opentelemetry-types
  • #437 feat(metrics): add registerMetric and getMetrics
• opentelemetry-metrics
  • #468 feat: validate metric names
• opentelemetry-plugin-postgres
  • #417 feature(plugin): implement postgres plugin
• opentelemetry-core, opentelemetry-types
  • #451 feat: add IsRemote field to SpanContext, set by propagators
• opentelemetry-core, opentelemetry-plugin-document-load, opentelemetry-tracing, opentelemetry-types, opentelemetry-web
  • #433 feat(plugin-document-load): new plugin for document load for web tracer