Skip to content

Files

Latest commit

648bcf3 · Dec 10, 2024

History

History
93 lines (73 loc) · 9.64 KB
·

README.md

File metadata and controls

93 lines (73 loc) · 9.64 KB
·
owaisseemkrauno56theletterfpellaredjtmalinowskit2t2flands
Jul 22, 2021
Jul 22, 2021
1
<p align="center">
Jun 6, 2022
Jun 6, 2022
2
<img alt="Stable" src="https://img.shields.io/badge/status-stable-informational?style=for-the-badge">
Mar 11, 2022
Mar 11, 2022
3
<a href="https://github.com/signalfx/splunk-otel-js/releases">
Jul 22, 2021
Jul 22, 2021
4
5
<img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/signalfx/splunk-otel-js?include_prereleases&style=for-the-badge">
</a>
Nov 12, 2024
Nov 12, 2024
6
7
<a href="https://github.com/signalfx/gdi-specification/releases/tag/v1.6.0">
<img alt="Splunk GDI specification" src="https://img.shields.io/badge/GDI-1.6.0-blueviolet?style=for-the-badge">
Mar 11, 2022
Mar 11, 2022
8
</a>
Jul 22, 2021
Jul 22, 2021
9
10
11
<img alt="npm" src="https://img.shields.io/npm/v/@splunk/otel?style=for-the-badge">
<img alt="node-current" src="https://img.shields.io/node/v/@splunk/otel?style=for-the-badge">
<img alt="Codecov" src="https://img.shields.io/codecov/c/github/signalfx/splunk-otel-js?style=for-the-badge&token=XKXjEQKGaK">
Dec 29, 2022
Dec 29, 2022
12
<img alt="GitHub branch checks state" src="https://img.shields.io/github/actions/workflow/status/signalfx/splunk-otel-js/.github/workflows/ci.yml?branch=main&style=for-the-badge">
Jul 22, 2021
Jul 22, 2021
13
14
</p>
Sep 20, 2021
Sep 20, 2021
15
# Splunk Distribution of OpenTelemetry for Node.js
Jan 26, 2021
Jan 26, 2021
16
Mar 8, 2023
Mar 8, 2023
17
The Splunk Distribution of [OpenTelemetry JS](https://github.com/open-telemetry/opentelemetry-js) integrates with Splunk APM and automatically instruments your Node application to capture traces, collect runtime metrics, and CPU and memory profiles.
Sep 27, 2022
Sep 27, 2022
18
Mar 8, 2023
Mar 8, 2023
19
This distribution comes with the following defaults:
Jan 26, 2021
Jan 26, 2021
20
Mar 8, 2023
Mar 8, 2023
21
- [W3C tracecontext and baggage propagation](https://www.w3.org/TR/trace-context)
Dec 10, 2024
Dec 10, 2024
22
- [OTLP exporter](https://www.npmjs.com/package/@opentelemetry/exporter-trace-otlp-proto) configured to send spans to a locally running OpenTelemetry Collector over HTTP.
Mar 8, 2023
Mar 8, 2023
23
- Many bundled [instrumentations](#default-instrumentation-packages)
Jan 26, 2021
Jan 26, 2021
24
Mar 8, 2023
Mar 8, 2023
25
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](https://quickdraw.splunk.com/redirect/?product=Observability&version=current&location=nodejs.application.migrate) in the official documentation.
Jan 26, 2021
Jan 26, 2021
26
Sep 20, 2021
Sep 20, 2021
27
## Get started
Jan 26, 2021
Jan 26, 2021
28
Mar 8, 2023
Mar 8, 2023
29
For complete instructions on how to get started with the Splunk Distribution of OpenTelemetry JS, see [Instrument a Node application for Splunk Observability Cloud](https://quickdraw.splunk.com/redirect/?product=Observability&version=current&location=nodejs.application.gdi) in the official documentation.
Mar 10, 2021
Mar 10, 2021
30
Oct 28, 2022
Oct 28, 2022
31
32
33
34
## 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.
Mar 8, 2023
Mar 8, 2023
35
For more information, see [Connect Node.js trace data with logs for Splunk Observability Cloud](https://quickdraw.splunk.com/redirect/?product=Observability&version=current&location=nodejs.application.tracelogs) in the official documentation.
Oct 28, 2022
Oct 28, 2022
36
Mar 8, 2023
Mar 8, 2023
37
## Default instrumentation packages<a name="default-instrumentation-packages"></a>
Mar 3, 2021
Mar 3, 2021
38
Mar 8, 2023
Mar 8, 2023
39
By default, the following instrumentations are active:
Oct 28, 2022
Oct 28, 2022
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
* [`@opentelemetry/instrumentation-amqplib`](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/instrumentation-amqplib)
* [`@opentelemetry/instrumentation-aws-sdk`](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-aws-sdk)
* [`@opentelemetry/instrumentation-bunyan`](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-bunyan)
* [`@opentelemetry/instrumentation-cassandra-driver`](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-cassandra)
* [`@opentelemetry/instrumentation-connect`](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-connect)
* [`@opentelemetry/instrumentation-dataloader`](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/instrumentation-dataloader)
* [`@opentelemetry/instrumentation-dns`](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-dns)
* [`@opentelemetry/instrumentation-express`](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-express)
* [`@opentelemetry/instrumentation-fastify`](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-fastify)
* [`@opentelemetry/instrumentation-generic-pool`](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-generic-pool)
* [`@opentelemetry/instrumentation-graphql`](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-graphql)
* [`@opentelemetry/instrumentation-grpc`](https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-instrumentation-grpc)
* [`@opentelemetry/instrumentation-hapi`](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-hapi)
* [`@opentelemetry/instrumentation-http`](https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-instrumentation-http)
* [`@opentelemetry/instrumentation-ioredis`](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-ioredis)
Jul 4, 2024
Jul 4, 2024
56
* [`@opentelemetry/instrumentation-kafkajs`](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/instrumentation-kafkajs)
Oct 28, 2022
Oct 28, 2022
57
58
59
60
* [`@opentelemetry/instrumentation-knex`](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-knex)
* [`@opentelemetry/instrumentation-koa`](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-koa)
* [`@opentelemetry/instrumentation-memcached`](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-memcached)
* [`@opentelemetry/instrumentation-mongodb`](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-mongodb)
Mar 22, 2023
Mar 22, 2023
61
* [`@opentelemetry/instrumentation-mongoose`](https://www.npmjs.com/package/@opentelemetry/instrumentation-mongoose)
Oct 28, 2022
Oct 28, 2022
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
* [`@opentelemetry/instrumentation-mysql`](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-mysql)
* [`@opentelemetry/instrumentation-mysql2`](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-mysql2)
* [`@opentelemetry/instrumentation-nestjs-core`](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-nestjs-core)
* [`@opentelemetry/instrumentation-net`](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-net)
* [`@opentelemetry/instrumentation-pg`](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-pg)
* [`@opentelemetry/instrumentation-pino`](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-pino)
* [`@opentelemetry/instrumentation-redis`](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-redis)
* [`@opentelemetry/instrumentation-redis-4`](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-redis-4)
* [`@opentelemetry/instrumentation-restify`](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-restify)
* [`@opentelemetry/instrumentation-router`](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-router)
* [`@opentelemetry/instrumentation-tedious`](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/instrumentation-tedious)
* [`@opentelemetry/instrumentation-winston`](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-winston)
* [`opentelemetry-instrumentation-elasticsearch`](https://github.com/aspecto-io/opentelemetry-ext-js/tree/master/packages/instrumentation-elasticsearch)
* [`opentelemetry-instrumentation-sequelize`](https://github.com/aspecto-io/opentelemetry-ext-js/tree/master/packages/instrumentation-sequelize)
* [`opentelemetry-instrumentation-typeorm`](https://github.com/aspecto-io/opentelemetry-ext-js/tree/master/packages/instrumentation-typeorm)
Mar 3, 2021
Mar 3, 2021
77
Mar 8, 2023
Mar 8, 2023
78
You can find more instrumentation packages in the [OpenTelemetry Registry](https://opentelemetry.io/registry/?language=js).
Oct 25, 2021
Oct 25, 2021
79
Jan 26, 2021
Jan 26, 2021
80
81
## Troubleshooting
Aug 24, 2023
Aug 24, 2023
82
For troubleshooting issues with the Splunk Distribution of OpenTelemetry JS, see [Troubleshoot Node.js instrumentation for Splunk Observability Cloud](https://quickdraw.splunk.com/redirect/?product=Observability&version=current&location=nodejs.application.tshoot) in the official documentation.
Mar 8, 2023
Mar 8, 2023
83
Dec 10, 2024
Dec 10, 2024
84
> Examples and developer documentation for version 2.x is available at [/tree/2.x](https://github.com/signalfx/splunk-otel-js/tree/2.x).
Jan 26, 2021
Jan 26, 2021
85
Sep 5, 2022
Sep 5, 2022
86
# License
Jan 26, 2021
Jan 26, 2021
87
88
The Splunk distribution of OpenTelemetry JS Instrumentation is a
Oct 19, 2022
Oct 19, 2022
89
90
distribution of [OpenTelemetry JS](https://github.com/open-telemetry/opentelemetry-js).
It is licensed under the terms of the Apache Software License version 2.0. See [the
Jan 26, 2021
Jan 26, 2021
91
license file](./LICENSE) for more details.
Dec 20, 2021
Dec 20, 2021
92
Aug 16, 2023
Aug 16, 2023
93
>ℹ️&nbsp;&nbsp;SignalFx was acquired by Splunk in October 2019. See [Splunk SignalFx](https://www.splunk.com/en_us/about-splunk/acquisitions/signalfx.html) for more information.