@coog/otel-node-tracer

Coog OpenTelemetry Node Tracer Helper

This project is a library which provides a configuration layer that chooses default values for configuration options that many OpenTelemetry users want. The goal is to help users that aren't familiar with OpenTelemetry quickly ramp up on what they need to get going and instrument.

One of the key principles behind this library is to make lives of OpenTelemetry users easier, this means that there is no special configuration that requires users to install Launcher in order to use OpenTelemetry. It also means that any users of Launcher can leverage the flexibility of configuring OpenTelemetry as they need.

Getting started

yarn add @coog/otel-node-tracer

Configure

Minimal setup

const {
  otelnodetracer,
  opentelemetry,
} = require('@coog/otel-node-tracer');

const sdk = otelnodetracer.configureOpenTelemetry({
  zipkinUrl: 'YOUR Zipkin URL',
  serviceName: 'otel-example',
});

sdk.start().then(() => {
  // Make sure to load any modules you use after otel is started so that it
  // has its module loading hooks in place. In general, this is the right place
  // to require your code.
  require('./server-main.js').startServer();
});

We recommend turning on the debug logs, to get a sense of what OpenTelemetry is doing.

export OTEL_LOG_LEVEL=debug

Useful links

• For more information on OpenTelemetry, visit: opentelemetry.io
• For more about OpenTelemetry JavaScript: github.com/open-telemetry/opentelemetry-js
• For more information on Zipkin, visit: github.com/openzipkin/zipkin-js