@splunk/otel
v2.8.0
Published
The Splunk distribution of OpenTelemetry Node Instrumentation provides a Node agent that automatically instruments your Node application to capture and report distributed traces to Splunk APM.
Downloads
92,056
Readme
Splunk Distribution of OpenTelemetry for Node.js
The Splunk Distribution of OpenTelemetry JS integrates with Splunk APM and automatically instruments your Node application to capture traces, collect runtime metrics, and CPU and memory profiles.
This distribution comes with the following defaults:
- W3C tracecontext and baggage propagation
- OTLP exporter configured to send spans to a locally running OpenTelemetry Collector over gRPC
- Many bundled instrumentations
If you're using the SignalFx Tracing Library for Node and want to migrate to the Splunk Distribution of OpenTelemetry Node, see Migrate from the SignalFx Tracing Library for NodeJS in the official documentation.
Get started
For complete instructions on how to get started with the Splunk Distribution of OpenTelemetry JS, see Instrument a Node application for Splunk Observability Cloud in the official documentation.
Correlate traces and logs
The Splunk Distribution of OpenTelemetry JS automatically injects trace metadata into logs so that Node.js logging libraries can access it. You can use trace metadata to correlate traces with log events and explore logs in Observability Cloud.
For more information, see Connect Node.js trace data with logs for Splunk Observability Cloud in the official documentation.
Default instrumentation packages
By default, the following instrumentations are active:
@opentelemetry/instrumentation-amqplib@opentelemetry/instrumentation-aws-sdk@opentelemetry/instrumentation-bunyan@opentelemetry/instrumentation-cassandra-driver@opentelemetry/instrumentation-connect@opentelemetry/instrumentation-dataloader@opentelemetry/instrumentation-dns@opentelemetry/instrumentation-express@opentelemetry/instrumentation-fastify@opentelemetry/instrumentation-generic-pool@opentelemetry/instrumentation-graphql@opentelemetry/instrumentation-grpc@opentelemetry/instrumentation-hapi@opentelemetry/instrumentation-http@opentelemetry/instrumentation-ioredis@opentelemetry/instrumentation-knex@opentelemetry/instrumentation-koa@opentelemetry/instrumentation-memcached@opentelemetry/instrumentation-mongodb@opentelemetry/instrumentation-mongoose@opentelemetry/instrumentation-mysql@opentelemetry/instrumentation-mysql2@opentelemetry/instrumentation-nestjs-core@opentelemetry/instrumentation-net@opentelemetry/instrumentation-pg@opentelemetry/instrumentation-pino@opentelemetry/instrumentation-redis@opentelemetry/instrumentation-redis-4@opentelemetry/instrumentation-restify@opentelemetry/instrumentation-router@opentelemetry/instrumentation-tedious@opentelemetry/instrumentation-winstonopentelemetry-instrumentation-elasticsearchopentelemetry-instrumentation-kafkajsopentelemetry-instrumentation-sequelizeopentelemetry-instrumentation-typeorm
You can find more instrumentation packages in the OpenTelemetry Registry.
Troubleshooting
For troubleshooting issues with the Splunk Distribution of OpenTelemetry JS, see Troubleshoot Node.js instrumentation for Splunk Observability Cloud in the official documentation.
Examples and developer documentation for version 1.x is available at /tree/1.x.
License
The Splunk distribution of OpenTelemetry JS Instrumentation is a distribution of OpenTelemetry JS. It is licensed under the terms of the Apache Software License version 2.0. See the license file for more details.
ℹ️ SignalFx was acquired by Splunk in October 2019. See Splunk SignalFx for more information.