OpenTelemetry Collector Exporter for node with grpc
This module provides exporter for web and node to be used with opentelemetry-collector - last tested with version 0.25.0.
Installation
npm install --save @opentelemetry/exporter-trace-otlp-grpc
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.
To see documentation and sample code for the metric exporter, see the exporter-metrics-otlp-grpc package
Traces in Node - GRPC
The OTLPTraceExporter in Node expects the URL to only be the hostname. It will not work with /v1/traces
.
const { BasicTracerProvider, SimpleSpanProcessor } = require('@opentelemetry/sdk-trace-base');
const { OTLPTraceExporter } = require('@opentelemetry/exporter-trace-otlp-grpc');
const collectorOptions = {
url: '<collector-hostname>:<port>',
};
const provider = new BasicTracerProvider();
const exporter = new OTLPTraceExporter(collectorOptions);
provider.addSpanProcessor(new SimpleSpanProcessor(exporter));
provider.register();
['SIGINT', 'SIGTERM'].forEach(signal => {
process.on(signal, () => provider.shutdown().catch(console.error));
});
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/grpc-js');
const { BasicTracerProvider, SimpleSpanProcessor } = require('@opentelemetry/sdk-trace-base');
const { OTLPTraceExporter } = require('@opentelemetry/exporter-trace-otlp-grpc');
const collectorOptions = {
url: '<collector-hostname>:<port>',
credentials: grpc.credentials.createSsl(),
};
const provider = new BasicTracerProvider();
const exporter = new OTLPTraceExporter(collectorOptions);
provider.addSpanProcessor(new SimpleSpanProcessor(exporter));
provider.register();
['SIGINT', 'SIGTERM'].forEach(signal => {
process.on(signal, () => provider.shutdown().catch(console.error));
});
To use mutual authentication, pass to the createSsl()
constructor:
credentials: grpc.credentials.createSsl(
fs.readFileSync('./ca.crt'),
fs.readFileSync('./client.key'),
fs.readFileSync('./client.crt')
),
To generate credentials for mutual authentication, 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/grpc-js');
const { BasicTracerProvider, SimpleSpanProcessor } = require('@opentelemetry/sdk-trace-base');
const { OTLPTraceExporter } = require('@opentelemetry/exporter-trace-otlp-grpc');
const metadata = new grpc.Metadata();
metadata.set('k', 'v');
const collectorOptions = {
url: '<collector-hostname>:<port>',
metadata,
};
const provider = new BasicTracerProvider();
const exporter = new OTLPTraceExporter(collectorOptions);
provider.addSpanProcessor(new SimpleSpanProcessor(exporter));
provider.register();
['SIGINT', 'SIGTERM'].forEach(signal => {
process.on(signal, () => provider.shutdown().catch(console.error));
});
Note, that this will only work if TLS is also configured on the server.
By default no compression will be used. To use compression, set it programmatically in collectorOptions
or with environment variables. Supported compression options: gzip
and none
.
const { CompressionAlgorithm } = require('@opentelemetry/exporter-trace-otlp-grpc');
const collectorOptions = {
url: '<collector-hostname>:<port>',
metadata,
compression: CompressionAlgorithm.GZIP,
};
const exporter = new OTLPTraceExporter(collectorOptions);
Providing compression
with collectorOptions
takes precedence and overrides compression set with environment variables.
Environment Variable Configuration
Set compression with environment variables.
OTEL_EXPORTER_OTLP_TRACES_COMPRESSION=gzip
Compression set programatically in collectorOptions
takes precedence over compression set with environment variables. OTEL_EXPORTER_OTLP_TRACES_COMPRESSION
takes precedence and overrides OTEL_EXPORTER_OTLP_COMPRESSION
.
Running opentelemetry-collector locally to see the traces
- Go to examples/otlp-exporter-node
- run
npm run docker:start
- Open page at
http://localhost:9411/zipkin/
to observe the traces
Useful links
License
Apache 2.0 - See LICENSE for more information.