@opentelemetry/exporter-collector-proto

OpenTelemetry Collector Exporter for node with protobuf

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

Installation

npm install --save @opentelemetry/exporter-collector-proto

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 Node - PROTO over http

const { BasicTracerProvider, SimpleSpanProcessor } = require('@opentelemetry/sdk-trace-base');
const { CollectorTraceExporter } =  require('@opentelemetry/exporter-collector-proto');

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
};

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

provider.register();

Metrics in Node - PROTO over http

const { MeterProvider } = require('@opentelemetry/sdk-metrics-base');
const { CollectorMetricExporter } =  require('@opentelemetry/exporter-collector-proto');
const collectorOptions = {
  url: '<opentelemetry-collector-url>', // url is optional and can be omitted - default is http://localhost:55681/v1/metrics
};
const exporter = new CollectorMetricExporter(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' });

Running opentelemetry-collector locally to see the traces

• Go to examples/collector-exporter-node
• run npm run docker:start
• 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.25.0

:boom: Breaking Change

• opentelemetry-api-metrics, opentelemetry-context-zone-peer-dep, opentelemetry-context-zone, opentelemetry-core, opentelemetry-exporter-collector-grpc, opentelemetry-exporter-collector-proto, opentelemetry-exporter-collector, opentelemetry-exporter-jaeger, opentelemetry-exporter-prometheus, opentelemetry-exporter-zipkin, opentelemetry-instrumentation-fetch, opentelemetry-instrumentation-grpc, opentelemetry-instrumentation-http, opentelemetry-instrumentation-xml-http-request, opentelemetry-instrumentation, opentelemetry-propagator-jaeger, opentelemetry-sdk-metrics-base, opentelemetry-sdk-node, opentelemetry-sdk-trace-base, opentelemetry-sdk-trace-node, opentelemetry-sdk-trace-web, opentelemetry-shim-opentracing
  • #2340 chore: rename sdks to better represent what they are [#2146] (@vmarchaud)

:rocket: (Enhancement)

• opentelemetry-exporter-collector-grpc, opentelemetry-exporter-collector-proto, opentelemetry-exporter-collector, opentelemetry-exporter-zipkin
  • #1775 fix(@opentelemetry/exporter-collector): remove fulfilled promises cor… (@aabmass)
• opentelemetry-exporter-collector
  • #2336 feat: use Blob in sendBeacon to add application/json type (@jufab)

:bug: (Bug Fix)

• opentelemetry-instrumentation-grpc, opentelemetry-instrumentation-http, opentelemetry-instrumentation-jaeger, opentelemetry-exporter-zipkin, opentelemetry-sdk-trace-base
  • #2499 fix: 2389- replaced logger unformatted strings with template literals (@PaurushGarg)
• opentelemetry-instrumentation-fetch
  • #2411 fix(instrumentation-fetch): fetch(string, Request) silently drops request body (@t2t2)
• opentelemetry-sdk-trace-base
  • #2396 fix: respect sampled flag in Span Processors, fix associated tests (@quickgiant)

:books: (Refine Doc)

• Other
  • #2412 docs: fix examples in website_docs/instrumentation.md (@svrnm)
  • #2400 Website docs update 0821 (@svrnm)
• opentelemetry-resources, opentelemetry-semantic-conventions
  • #2399 chore: update doc identifier names in readme (@lonewolf3739)

:house: (Internal)

• opentelemetry-core, opentelemetry-exporter-collector-grpc, opentelemetry-exporter-collector-proto, opentelemetry-instrumentation-http, opentelemetry-sdk-trace-node
  • #2416 chore: hoist dependencies to speed up ci (@dyladan)
• opentelemetry-propagator-b3, opentelemetry-propagator-jaeger, opentelemetry-resources, opentelemetry-sdk-metrics-base
  • #2406 chore: Fix lint warnings in propagator-jaeger, propagator-b3, resources, and sdk-metrics-base packages (@alisabzevari)
• opentelemetry-core
  • #2405 chore: Fix lint warnings in core package (@alisabzevari)
• opentelemetry-resource-detector-aws, opentelemetry-resource-detector-gcp, opentelemetry-sdk-node
  • #2392 refactor: move detectors to opentelemetry-js-contrib repo (@legendecas)
• opentelemetry-exporter-collector-grpc, opentelemetry-exporter-collector-proto, opentelemetry-exporter-collector, opentelemetry-exporter-jaeger, opentelemetry-exporter-zipkin, opentelemetry-instrumentation-fetch, opentelemetry-instrumentation-grpc, opentelemetry-instrumentation-http, opentelemetry-instrumentation-xml-http-request, opentelemetry-sdk-node, opentelemetry-sdk-trace-node, opentelemetry-sdk-trace-web, opentelemetry-shim-opentracing
  • #2402 chore: sort entries in tsconfig (@Flarna)
• opentelemetry-api-metrics, opentelemetry-context-zone-peer-dep
  • #2390 chore: fix Lint warnings in api-metrics and context-zone-peer-dep (@alisabzevari)
• Other
  • #2397 chore: change codeowners to point to team (@dyladan)
  • #2385 chore: move api into dependencies in integration tests (@Flarna)

Committers: 11

• Aaron Abbott (@aabmass)
• Ali Sabzevari (@alisabzevari)
• Clark Jacobsohn (@quickgiant)
• Daniel Dyla (@dyladan)
• Gerhard Stöbich (@Flarna)
• Julien Fabre (@jufab)
• Severin Neumann (@svrnm)
• Srikanth Chekuri (@lonewolf3739)
• Valentin Marchaud (@vmarchaud)
• legendecas (@legendecas)
• t2t2 (@t2t2)