@splunk/otel
Advanced tools
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.
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:
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.
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.
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.
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-kafkajs@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-sequelizeopentelemetry-instrumentation-typeormYou can find more instrumentation packages in the OpenTelemetry Registry.
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 2.x is available at /tree/2.x.
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.
3.0.0
[!WARNING]
Breaking changes
- Raise the minimum required Node.js version to 18. If Node <18 is a requirement, 2.x is still maintained and package versions 2.x can be used.
- Change the default OTLP protocol from
grpctohttp/protobuf. The default exporting endpoint has been changed fromhttp://localhost:4317tohttp://localhost:4318. Signal specific URL paths are automatically added when choosing the endpoint, e.g. whenendpointis set tohttp://collector:4318,/v1/tracesis added for traces.- Change the default sampler from
parentbased_always_ontoalways_on.- Profiling configuration:
resource: Resourcefield has been changed toresourceFactory: (resource: Resource) => Resourceto bring it in line with tracing and metrics configuration.
Improve the start API to avoid duplicating parameters in the signal specific configuration.
Add resource field - a function which can be used to overwrite or add additional parameters to the resource detected from the environment.
import { start } from '@splunk/otel';
import { Resource } from '@opentelemetry/resources';
start({
serviceName: 'example',
resource: (detectedResource) => {
return detectedResource.merge(new Resource({ 'service.version': '0.2.0' }));
},
});
Add realm field. When set passes the access token and realm to signals.
import { start } from '@splunk/otel';
start({
serviceName: 'example',
realm: 'us0',
accessToken: '<token>'
});
// Traces and metrics are now sent to the us0 backend.
Signal specific options can still be used and take preference over the shared configuration options.
splunk.distro.version (automatically added resource attribute) has been removed and is replaced with telemetry.distro.version and telemetry.distro.name.
SPLUNK_METRICS_ENDPOINT environment variable has been removed. Use the OpenTelemetry specific OTEL_EXPORTER_OTLP_METRICS_ENDPOINT instead.
Fix logging of service.name attribute not set from each signal, when the service name is not set.
Add prebuilt binaries for Node.js 22 and 23.
Upgrade to OpenTelemetry 1.30.0 / 0.57.0.
FAQs
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.
The npm package @splunk/otel receives a total of 29,513 weekly downloads. As such, @splunk/otel popularity was classified as popular.
We found that @splunk/otel demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 14 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
/Security News
Socket researchers uncover how threat actors weaponize Discord across the npm, PyPI, and RubyGems ecosystems to exfiltrate sensitive data.
Security News
Socket now integrates with Bun 1.3’s Security Scanner API to block risky packages at install time and enforce your organization’s policies in local dev and CI.
Research
The Socket Threat Research Team is tracking weekly intrusions into the npm registry that follow a repeatable adversarial playbook used by North Korean state-sponsored actors.