OpenTelemetry Collector Exporter for web and node
This module provides exporter for web and node to be used with opentelemetry-collector - last tested with version 0.12.0.
Installation
npm install --save @opentelemetry/exporter-collector
Traces in Web
The CollectorTraceExporter in Web expects the endpoint to end in /v1/trace
.
;;; const collectorOptions = url: '<opentelemetry-collector-url>' // url is optional and can be omitted - default is http://localhost:55681/v1/trace headers: {} //an optional object containing custom headers to be sent with each request; const provider = ;const exporter = collectorOptions;provider; provider;
Metrics in Web
The CollectorMetricExporter in Web expects the endpoint to end in /v1/metrics
.
;;const collectorOptions = url: '<opentelemetry-collector-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;const exporter = collectorOptions; // Register the exporterconst meter = exporter interval: 60000; // Now, start recording dataconst counter = meter;counter;
Traces in Node - JSON over http
const BasicTracerProvider SimpleSpanProcessor = ;const CollectorTraceExporter = ; const collectorOptions = serviceName: 'basic-service' url: '<opentelemetry-collector-url>' // url is optional and can be omitted - default is http://localhost:55681/v1/trace headers: foo: 'bar' //an optional object containing custom headers to be sent with each request will only work with http; const provider = ;const exporter = collectorOptions;provider; provider;
Metrics in Node
const MeterProvider = ;const CollectorMetricExporter = ;const collectorOptions = serviceName: 'basic-service' url: '<opentelemetry-collector-url>' // url is optional and can be omitted - default is http://localhost:55681/v1/metrics;const exporter = collectorOptions; // Register the exporterconst meter = exporter interval: 60000; // Now, start recording dataconst counter = meter;counter;
GRPC
For GRPC please check npm-url-grpc
PROTOBUF
For PROTOBUF please check npm-url-proto
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 on gitter
License
Apache 2.0 - See LICENSE for more information.