Splunk OTel JS compatibility and requirements 🔗
Meet these requirements to instrument Node.js applications for Splunk Observability Cloud using the Splunk Distribution of OpenTelemetry JS.
Note
For front-end applications built using JavaScript libraries like React, use Splunk Real User Monitoring (RUM) for Browser. See Instrument browser-based web applications for Splunk RUM.
Ensure you have supported Node.js and library versions 🔗
The Splunk Distribution of OpenTelemetry JS requires Node.js 14 and higher. To activate AlwaysOn Profiling, you need Node.js 16 or higher.
The Splunk Distribution of OpenTelemetry JS instruments the following libraries and packages:
Instrumentation |
Environment variable name |
|---|---|
amqplib |
|
aws_sdk |
|
bunyan |
|
cassandra_driver |
|
connect |
|
dataloader |
|
dns |
|
express |
|
fastify |
|
generic_pool |
|
graphql |
|
grpc |
|
hapi |
|
http |
|
ioredis |
|
knex |
|
koa |
|
memcached |
|
mongodb |
|
mongoose |
|
mysql |
|
mysql2 |
|
nestjs_core |
|
net |
|
pg |
|
pino |
|
redis |
|
redis_4 |
|
restify |
|
router |
|
tedious |
|
winston |
|
elasticsearch |
|
kafkajs |
|
sequelize |
|
typeorm |
For a complete list, see the plugins folder in the OpenTelemetry upstream repository on GitHub. To use any additional instrumentation, install it using npm before running your application.
Note
If you’re using a Node.js version lower than 14, use the SignalFx Tracing Library for Node.js .
Install and configure the Splunk Distribution of OpenTelemetry Collector 🔗
The Splunk Distribution of OpenTelemetry JS exports application traces and spans to the Splunk Distribution of OpenTelemetry Collector, which also collects system metric data and logs, including profiling data.
To send application traces and spans to Splunk Observability Cloud, install the Splunk Distribution of OpenTelemetry Collector for your platform. The following distributions are available:
Splunk Distribution of the OpenTelemetry Collector for Linux. See Install the Collector for Linux with the installer script.
Splunk Distribution of the OpenTelemetry Collector for Windows. See Install the Collector for Windows with the installer script.
Splunk Distribution of the OpenTelemetry Collector for Kubernetes. See Install the Collector for Kubernetes.