@ohos-ports/opentelemetry-auto-instrumentations-node 0.0.0-stage → 0.83.0-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/README.md CHANGED
@@ -1,3 +1,216 @@
1
- # Temporary Holding Version
1
+ # OpenTelemetry Meta Packages for Node
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ [![NPM Published Version][npm-img]][npm-url]
4
+ [![Apache License][license-image]][license-url]
5
+
6
+ ## About
7
+
8
+ This module provides a way to auto instrument any Node application to capture telemetry from a number of popular libraries and frameworks.
9
+ You can export the telemetry data in a variety of formats. Exporters, samplers, and more can be configured via [environment variables][env-var-url].
10
+ The net result is the ability to gather telemetry data from a Node application without any code changes.
11
+
12
+ This module also provides a simple way to manually initialize multiple Node instrumentations for use with the OpenTelemetry SDK.
13
+
14
+ Compatible with OpenTelemetry JS API and SDK `2.0+`.
15
+
16
+ ## Installation
17
+
18
+ ```bash
19
+ npm install --save @opentelemetry/api
20
+ npm install --save @opentelemetry/auto-instrumentations-node
21
+ ```
22
+
23
+ ## Usage: Auto Instrumentation
24
+
25
+ This module includes auto instrumentation for all supported instrumentations and [all available data exporters][exporter-url].
26
+ It provides a completely automatic, out-of-the-box experience.
27
+ Please see the [Supported Instrumentations](#supported-instrumentations) section for more information.
28
+
29
+ Enable auto instrumentation by requiring this module using the [--require flag][require-url]:
30
+
31
+ ```shell
32
+ node --require '@opentelemetry/auto-instrumentations-node/register' app.js
33
+ ```
34
+
35
+ If your Node application is encapsulated in a complex run script, you can also set it via an environment variable before running Node.
36
+
37
+ ```shell
38
+ env NODE_OPTIONS="--require @opentelemetry/auto-instrumentations-node/register"
39
+ ```
40
+
41
+ The module is highly configurable using environment variables.
42
+ Many aspects of the auto instrumentation's behavior can be configured for your needs, such as resource detectors, exporter choice, exporter configuration, trace context propagation headers, and much more.
43
+ Instrumentation configuration is not yet supported through environment variables. Users that require instrumentation configuration must initialize OpenTelemetry programmatically.
44
+
45
+ ```shell
46
+ export OTEL_TRACES_EXPORTER="otlp"
47
+ export OTEL_EXPORTER_OTLP_PROTOCOL="http/protobuf"
48
+ export OTEL_EXPORTER_OTLP_COMPRESSION="gzip"
49
+ export OTEL_EXPORTER_OTLP_TRACES_ENDPOINT="https://your-endpoint"
50
+ export OTEL_EXPORTER_OTLP_HEADERS="x-api-key=your-api-key"
51
+ export OTEL_EXPORTER_OTLP_TRACES_HEADERS="x-api-key=your-api-key"
52
+ export OTEL_RESOURCE_ATTRIBUTES="service.namespace=my-namespace"
53
+ export OTEL_NODE_RESOURCE_DETECTORS="host,os,serviceinstance,env"
54
+ export OTEL_SERVICE_NAME="client"
55
+ export NODE_OPTIONS="--require @opentelemetry/auto-instrumentations-node/register"
56
+ node app.js
57
+ ```
58
+
59
+ By default, all SDK resource detectors are used, but you can use the environment variable OTEL_NODE_RESOURCE_DETECTORS to enable only certain detectors, or completely disable them:
60
+
61
+ - `env`
62
+ - `host`
63
+ - `os`
64
+ - `process`
65
+ - `serviceinstance`
66
+ - `container`
67
+ - `alibaba`
68
+ - `aws`
69
+ - `azure`
70
+ - `gcp`
71
+ - `all` - enable all resource detectors
72
+ - `none` - disable resource detection
73
+
74
+ For example, to enable only the `env`, `host` detectors:
75
+
76
+ ```shell
77
+ export OTEL_NODE_RESOURCE_DETECTORS="host,env"
78
+ ```
79
+
80
+ NOTE: The order set on `OTEL_NODE_RESOURCE_DETECTORS` will be respected and the detectors will be executed in order.
81
+ For example, if you have `OTEL_RESOURCE_ATTRIBUTES="service.instance.id=custom-name"`, but also `serviceinstance` and `env` on `OTEL_NODE_RESOURCE_DETECTORS`, it can have 2 scenarios:
82
+
83
+ - `OTEL_NODE_RESOURCE_DETECTORS="serviceinstance,env"` will have the `service.instance.id` as `custom-name`
84
+ - `OTEL_NODE_RESOURCE_DETECTORS="env,serviceinstance"` will have the `service.instance.id` as a random UUID
85
+
86
+ By default, all [Supported Instrumentations](#supported-instrumentations) are enabled, unless they are annotated with "default disabled".
87
+ You can use the environment variable `OTEL_NODE_ENABLED_INSTRUMENTATIONS` to enable only certain instrumentations, including "default disabled" ones
88
+ OR the environment variable `OTEL_NODE_DISABLED_INSTRUMENTATIONS` to disable only certain instrumentations,
89
+ by providing a comma-separated list of the instrumentation package names without the `@opentelemetry/instrumentation-` prefix.
90
+
91
+ For example, to enable only
92
+ [@opentelemetry/instrumentation-http](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-instrumentation-http)
93
+ and [@opentelemetry/instrumentation-nestjs-core](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-nestjs-core)
94
+ instrumentations:
95
+
96
+ ```shell
97
+ export OTEL_NODE_ENABLED_INSTRUMENTATIONS="http,nestjs-core"
98
+ ```
99
+
100
+ To disable only [@opentelemetry/instrumentation-net](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-net):
101
+
102
+ ```shell
103
+ export OTEL_NODE_DISABLED_INSTRUMENTATIONS="net"
104
+ ```
105
+
106
+ If both environment variables are set, `OTEL_NODE_ENABLED_INSTRUMENTATIONS` is applied first, and then `OTEL_NODE_DISABLED_INSTRUMENTATIONS` is applied to that list.
107
+ Therefore, if the same instrumentation is included in both lists, that instrumentation will be disabled.
108
+
109
+ To enable logging for troubleshooting, set the log level by setting the `OTEL_LOG_LEVEL` environment variable to one of the following:
110
+
111
+ - `none`
112
+ - `error`
113
+ - `warn`
114
+ - `info`
115
+ - `debug`
116
+ - `verbose`
117
+ - `all`
118
+
119
+ The default level is `info`.
120
+
121
+ Notes:
122
+
123
+ - In a production environment, it is recommended to set `OTEL_LOG_LEVEL`to `info`.
124
+ - Logs are always sent to console, no matter the environment, or debug level.
125
+ - Debug logs are extremely verbose. Enable debug logging only when needed. Debug logging negatively impacts the performance of your application.
126
+
127
+ ## Usage: Instrumentation Initialization
128
+
129
+ OpenTelemetry Meta Packages for Node automatically loads instrumentations for Node builtin modules and common packages.
130
+
131
+ Custom configuration for each of the instrumentations can be passed to the function, by providing an object with the name of the instrumentation as a key, and its configuration as the value.
132
+
133
+ ```javascript
134
+ const { NodeSDK } = require('@opentelemetry/sdk-node');
135
+ const { getNodeAutoInstrumentations } = require('@opentelemetry/auto-instrumentations-node');
136
+
137
+ const sdk = new NodeSDK({
138
+ serviceName: 'my-service',
139
+ instrumentations: [
140
+ getNodeAutoInstrumentations({
141
+ // Optionally customize some instrumentations, e.g.:
142
+ '@opentelemetry/instrumentation-http': {
143
+ applyCustomAttributesOnSpan: (span) => {
144
+ span.setAttribute('foo2', 'bar2');
145
+ },
146
+ },
147
+ }),
148
+ ],
149
+ });
150
+ sdk.start();
151
+ process.once('beforeExit', async () => { await sdk.shutdown(); });
152
+ ```
153
+
154
+ ## Supported instrumentations
155
+
156
+ - [@opentelemetry/instrumentation-amqplib](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-amqplib)
157
+ - [@opentelemetry/instrumentation-aws-lambda](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-aws-lambda)
158
+ - [@opentelemetry/instrumentation-aws-sdk](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-aws-sdk)
159
+ - [@opentelemetry/instrumentation-bunyan](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-bunyan)
160
+ - [@opentelemetry/instrumentation-cassandra-driver](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-cassandra-driver)
161
+ - [@opentelemetry/instrumentation-connect](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-connect)
162
+ - [@opentelemetry/instrumentation-cucumber](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-cucumber)
163
+ - [@opentelemetry/instrumentation-dataloader](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-dataloader)
164
+ - [@opentelemetry/instrumentation-dns](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-dns)
165
+ - [@opentelemetry/instrumentation-express](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-express)
166
+ - [@opentelemetry/instrumentation-fs](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-fs) (default disabled)
167
+ - [@opentelemetry/instrumentation-generic-pool](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-generic-pool)
168
+ - [@opentelemetry/instrumentation-graphql](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-graphql)
169
+ - [@opentelemetry/instrumentation-grpc](https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-instrumentation-grpc)
170
+ - [@opentelemetry/instrumentation-hapi](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-hapi)
171
+ - [@opentelemetry/instrumentation-host-metrics](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-host-metrics) (default disabled)
172
+ - [@opentelemetry/instrumentation-http](https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-instrumentation-http)
173
+ - [@opentelemetry/instrumentation-ioredis](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-ioredis)
174
+ - [@opentelemetry/instrumentation-kafkajs](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-kafkajs)
175
+ - [@opentelemetry/instrumentation-knex](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-knex)
176
+ - [@opentelemetry/instrumentation-koa](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-koa)
177
+ - [@opentelemetry/instrumentation-lru-memoizer](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-lru-memoizer)
178
+ - [@opentelemetry/instrumentation-memcached](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-memcached)
179
+ - [@opentelemetry/instrumentation-mongodb](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-mongodb)
180
+ - [@opentelemetry/instrumentation-mongoose](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-mongoose)
181
+ - [@opentelemetry/instrumentation-mysql](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-mysql)
182
+ - [@opentelemetry/instrumentation-mysql2](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-mysql2)
183
+ - [@opentelemetry/instrumentation-nestjs-core](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-nestjs-core)
184
+ - [@opentelemetry/instrumentation-net](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-net)
185
+ - [@opentelemetry/instrumentation-openai](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-openai)
186
+ - [@opentelemetry/instrumentation-oracledb](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-oracledb)
187
+ - [@opentelemetry/instrumentation-pg](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-pg)
188
+ - [@opentelemetry/instrumentation-pino](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-pino)
189
+ - [@opentelemetry/instrumentation-redis](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-redis)
190
+ - [@opentelemetry/instrumentation-restify](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-restify)
191
+ - [@opentelemetry/instrumentation-runtime-node](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-runtime-node)
192
+ - [@opentelemetry/instrumentation-socket.io](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-socket.io)
193
+ - [@opentelemetry/instrumentation-undici](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-undici)
194
+ - [@opentelemetry/instrumentation-winston](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-winston)
195
+
196
+ ### Removed instrumentations
197
+
198
+ - [`@opentelemetry/instrumentation-fastify`](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/archive/instrumentation-fastify) was removed Mar 2026. It had been deprecated (and default disabled) Jan 2025, in favor of the [`@fastify/otel`](https://www.npmjs.com/package/@fastify/otel) instrumentation package, maintained by the Fastify authors.
199
+ - Please see [the offical plugin's README.md](https://github.com/fastify/otel?tab=readme-ov-file#usage) for instructions on how to use `@fastify/otel`.
200
+
201
+ ## Useful links
202
+
203
+ - For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
204
+ - For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js>
205
+
206
+ ## License
207
+
208
+ APACHE 2.0 - See [LICENSE][license-url] for more information.
209
+
210
+ [license-url]: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/LICENSE
211
+ [license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat
212
+ [npm-url]: https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node
213
+ [npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fauto-instrumentations-node.svg
214
+ [env-var-url]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/sdk-environment-variables.md#general-sdk-configuration
215
+ [exporter-url]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/sdk-environment-variables.md#otlp-exporter
216
+ [require-url]: https://nodejs.org/api/cli.html#-r---require-module
@@ -0,0 +1,23 @@
1
+ //#region \0rolldown/runtime.js
2
+ var __create = Object.create;
3
+ var __defProp = Object.defineProperty;
4
+ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
5
+ var __getOwnPropNames = Object.getOwnPropertyNames;
6
+ var __getProtoOf = Object.getPrototypeOf;
7
+ var __hasOwnProp = Object.prototype.hasOwnProperty;
8
+ var __copyProps = (to, from, except, desc) => {
9
+ if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
10
+ key = keys[i];
11
+ if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
12
+ get: ((k) => from[k]).bind(null, key),
13
+ enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
14
+ });
15
+ }
16
+ return to;
17
+ };
18
+ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule || !__hasOwnProp.call(mod, "default") ? __defProp(target, "default", {
19
+ value: mod,
20
+ enumerable: true
21
+ }) : target, mod));
22
+ //#endregion
23
+ exports.__toESM = __toESM;
package/dist/index.cjs ADDED
@@ -0,0 +1,4 @@
1
+ Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
2
+ const require_utils = require("./utils.cjs");
3
+ exports.getNodeAutoInstrumentations = require_utils.getNodeAutoInstrumentations;
4
+ exports.getResourceDetectors = require_utils.getResourceDetectorsFromEnv;
@@ -0,0 +1,2 @@
1
+ import { InstrumentationConfigMap, getNodeAutoInstrumentations, getResourceDetectorsFromEnv } from "./utils.cjs";
2
+ export { type InstrumentationConfigMap, getNodeAutoInstrumentations, getResourceDetectorsFromEnv as getResourceDetectors };
@@ -0,0 +1,2 @@
1
+ import { InstrumentationConfigMap, getNodeAutoInstrumentations, getResourceDetectorsFromEnv } from "./utils.mjs";
2
+ export { type InstrumentationConfigMap, getNodeAutoInstrumentations, getResourceDetectorsFromEnv as getResourceDetectors };
package/dist/index.mjs ADDED
@@ -0,0 +1,2 @@
1
+ import { getNodeAutoInstrumentations, getResourceDetectorsFromEnv } from "./utils.mjs";
2
+ export { getNodeAutoInstrumentations, getResourceDetectorsFromEnv as getResourceDetectors };
@@ -0,0 +1,35 @@
1
+ const require_runtime = require("./_virtual/_rolldown/runtime.cjs");
2
+ const require_utils = require("./utils.cjs");
3
+ let _opentelemetry_api = require("@opentelemetry/api");
4
+ let _opentelemetry_sdk_node = require("@opentelemetry/sdk-node");
5
+ _opentelemetry_sdk_node = require_runtime.__toESM(_opentelemetry_sdk_node);
6
+ let _opentelemetry_core = require("@opentelemetry/core");
7
+ //#region src/register.ts
8
+ const logLevel = (0, _opentelemetry_core.getStringFromEnv)("OTEL_LOG_LEVEL");
9
+ if (logLevel != null) _opentelemetry_api.diag.setLogger(new _opentelemetry_api.DiagConsoleLogger(), { logLevel: (0, _opentelemetry_core.diagLogLevelFromString)(logLevel) });
10
+ const instrumentations = require_utils.getNodeAutoInstrumentations();
11
+ const resourceDetectors = require_utils.getResourceDetectorsFromEnv();
12
+ if (logLevel != null) _opentelemetry_api.diag.disable();
13
+ const sdk = new _opentelemetry_sdk_node.NodeSDK({
14
+ instrumentations,
15
+ resourceDetectors
16
+ });
17
+ try {
18
+ sdk.start();
19
+ _opentelemetry_api.diag.info("OpenTelemetry automatic instrumentation started successfully");
20
+ } catch (error) {
21
+ _opentelemetry_api.diag.error("Error initializing OpenTelemetry SDK. Your application is not instrumented and will not produce telemetry", error);
22
+ }
23
+ async function shutdown() {
24
+ try {
25
+ await sdk.shutdown();
26
+ _opentelemetry_api.diag.debug("OpenTelemetry SDK terminated");
27
+ } catch (error) {
28
+ _opentelemetry_api.diag.error("Error terminating OpenTelemetry SDK", error);
29
+ }
30
+ }
31
+ process.on("SIGTERM", shutdown);
32
+ process.once("beforeExit", shutdown);
33
+ //#endregion
34
+
35
+ //# sourceMappingURL=register.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"register.cjs","names":["getStringFromEnv","DiagConsoleLogger","diagLogLevelFromString","getNodeAutoInstrumentations","getResourceDetectorsFromEnv","opentelemetry"],"sources":["../src/register.ts"],"sourcesContent":["/*\n * Copyright The OpenTelemetry Authors\n * SPDX-License-Identifier: Apache-2.0\n */\nimport * as opentelemetry from '@opentelemetry/sdk-node';\nimport { diag, DiagConsoleLogger } from '@opentelemetry/api';\nimport { getStringFromEnv, diagLogLevelFromString } from '@opentelemetry/core';\nimport {\n getNodeAutoInstrumentations,\n getResourceDetectorsFromEnv,\n} from './utils';\n\nconst logLevel = getStringFromEnv('OTEL_LOG_LEVEL');\nif (logLevel != null) {\n diag.setLogger(new DiagConsoleLogger(), {\n logLevel: diagLogLevelFromString(logLevel),\n });\n}\n\nconst instrumentations = getNodeAutoInstrumentations();\nconst resourceDetectors = getResourceDetectorsFromEnv();\n\n// `NodeSDK` registers its own `DiagConsoleLogger` based on `OTEL_LOG_LEVEL`\n// internally, so disable the logger set up above to avoid the \"Current\n// logger will be overwritten\" warning being logged on every start.\nif (logLevel != null) {\n diag.disable();\n}\n\nconst sdk = new opentelemetry.NodeSDK({\n instrumentations,\n resourceDetectors,\n});\n\ntry {\n sdk.start();\n diag.info('OpenTelemetry automatic instrumentation started successfully');\n} catch (error) {\n diag.error(\n 'Error initializing OpenTelemetry SDK. Your application is not instrumented and will not produce telemetry',\n error\n );\n}\n\nasync function shutdown(): Promise<void> {\n try {\n await sdk.shutdown();\n diag.debug('OpenTelemetry SDK terminated');\n } catch (error) {\n diag.error('Error terminating OpenTelemetry SDK', error);\n }\n}\n\n// Gracefully shutdown SDK if a SIGTERM is received\nprocess.on('SIGTERM', shutdown);\n// Gracefully shutdown SDK if Node.js is exiting normally\nprocess.once('beforeExit', shutdown);\n"],"mappings":";;;;;;;AAYA,MAAM,YAAA,GAAWA,oBAAAA,iBAAAA,CAAiB,gBAAgB;AAClD,IAAI,YAAY,MACd,mBAAA,KAAK,UAAU,IAAIC,mBAAAA,kBAAkB,GAAG,EACtC,WAAA,GAAUC,oBAAAA,uBAAAA,CAAuB,QAAQ,EAC3C,CAAC;AAGH,MAAM,mBAAmBC,cAAAA,4BAA4B;AACrD,MAAM,oBAAoBC,cAAAA,4BAA4B;AAKtD,IAAI,YAAY,MACd,mBAAA,KAAK,QAAQ;AAGf,MAAM,MAAM,IAAIC,wBAAc,QAAQ;CACpC;CACA;AACF,CAAC;AAED,IAAI;CACF,IAAI,MAAM;CACV,mBAAA,KAAK,KAAK,8DAA8D;AAC1E,SAAS,OAAO;CACd,mBAAA,KAAK,MACH,6GACA,KACF;AACF;AAEA,eAAe,WAA0B;CACvC,IAAI;EACF,MAAM,IAAI,SAAS;EACnB,mBAAA,KAAK,MAAM,8BAA8B;CAC3C,SAAS,OAAO;EACd,mBAAA,KAAK,MAAM,uCAAuC,KAAK;CACzD;AACF;AAGA,QAAQ,GAAG,WAAW,QAAQ;AAE9B,QAAQ,KAAK,cAAc,QAAQ"}
@@ -0,0 +1 @@
1
+ export {}
@@ -0,0 +1 @@
1
+ export {}
@@ -0,0 +1,34 @@
1
+ import { getNodeAutoInstrumentations, getResourceDetectorsFromEnv } from "./utils.mjs";
2
+ import { DiagConsoleLogger, diag } from "@opentelemetry/api";
3
+ import * as opentelemetry from "@opentelemetry/sdk-node";
4
+ import { diagLogLevelFromString, getStringFromEnv } from "@opentelemetry/core";
5
+ //#region src/register.ts
6
+ const logLevel = getStringFromEnv("OTEL_LOG_LEVEL");
7
+ if (logLevel != null) diag.setLogger(new DiagConsoleLogger(), { logLevel: diagLogLevelFromString(logLevel) });
8
+ const instrumentations = getNodeAutoInstrumentations();
9
+ const resourceDetectors = getResourceDetectorsFromEnv();
10
+ if (logLevel != null) diag.disable();
11
+ const sdk = new opentelemetry.NodeSDK({
12
+ instrumentations,
13
+ resourceDetectors
14
+ });
15
+ try {
16
+ sdk.start();
17
+ diag.info("OpenTelemetry automatic instrumentation started successfully");
18
+ } catch (error) {
19
+ diag.error("Error initializing OpenTelemetry SDK. Your application is not instrumented and will not produce telemetry", error);
20
+ }
21
+ async function shutdown() {
22
+ try {
23
+ await sdk.shutdown();
24
+ diag.debug("OpenTelemetry SDK terminated");
25
+ } catch (error) {
26
+ diag.error("Error terminating OpenTelemetry SDK", error);
27
+ }
28
+ }
29
+ process.on("SIGTERM", shutdown);
30
+ process.once("beforeExit", shutdown);
31
+ //#endregion
32
+ export {};
33
+
34
+ //# sourceMappingURL=register.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"register.mjs","names":[],"sources":["../src/register.ts"],"sourcesContent":["/*\n * Copyright The OpenTelemetry Authors\n * SPDX-License-Identifier: Apache-2.0\n */\nimport * as opentelemetry from '@opentelemetry/sdk-node';\nimport { diag, DiagConsoleLogger } from '@opentelemetry/api';\nimport { getStringFromEnv, diagLogLevelFromString } from '@opentelemetry/core';\nimport {\n getNodeAutoInstrumentations,\n getResourceDetectorsFromEnv,\n} from './utils';\n\nconst logLevel = getStringFromEnv('OTEL_LOG_LEVEL');\nif (logLevel != null) {\n diag.setLogger(new DiagConsoleLogger(), {\n logLevel: diagLogLevelFromString(logLevel),\n });\n}\n\nconst instrumentations = getNodeAutoInstrumentations();\nconst resourceDetectors = getResourceDetectorsFromEnv();\n\n// `NodeSDK` registers its own `DiagConsoleLogger` based on `OTEL_LOG_LEVEL`\n// internally, so disable the logger set up above to avoid the \"Current\n// logger will be overwritten\" warning being logged on every start.\nif (logLevel != null) {\n diag.disable();\n}\n\nconst sdk = new opentelemetry.NodeSDK({\n instrumentations,\n resourceDetectors,\n});\n\ntry {\n sdk.start();\n diag.info('OpenTelemetry automatic instrumentation started successfully');\n} catch (error) {\n diag.error(\n 'Error initializing OpenTelemetry SDK. Your application is not instrumented and will not produce telemetry',\n error\n );\n}\n\nasync function shutdown(): Promise<void> {\n try {\n await sdk.shutdown();\n diag.debug('OpenTelemetry SDK terminated');\n } catch (error) {\n diag.error('Error terminating OpenTelemetry SDK', error);\n }\n}\n\n// Gracefully shutdown SDK if a SIGTERM is received\nprocess.on('SIGTERM', shutdown);\n// Gracefully shutdown SDK if Node.js is exiting normally\nprocess.once('beforeExit', shutdown);\n"],"mappings":";;;;;AAYA,MAAM,WAAW,iBAAiB,gBAAgB;AAClD,IAAI,YAAY,MACd,KAAK,UAAU,IAAI,kBAAkB,GAAG,EACtC,UAAU,uBAAuB,QAAQ,EAC3C,CAAC;AAGH,MAAM,mBAAmB,4BAA4B;AACrD,MAAM,oBAAoB,4BAA4B;AAKtD,IAAI,YAAY,MACd,KAAK,QAAQ;AAGf,MAAM,MAAM,IAAI,cAAc,QAAQ;CACpC;CACA;AACF,CAAC;AAED,IAAI;CACF,IAAI,MAAM;CACV,KAAK,KAAK,8DAA8D;AAC1E,SAAS,OAAO;CACd,KAAK,MACH,6GACA,KACF;AACF;AAEA,eAAe,WAA0B;CACvC,IAAI;EACF,MAAM,IAAI,SAAS;EACnB,KAAK,MAAM,8BAA8B;CAC3C,SAAS,OAAO;EACd,KAAK,MAAM,uCAAuC,KAAK;CACzD;AACF;AAGA,QAAQ,GAAG,WAAW,QAAQ;AAE9B,QAAQ,KAAK,cAAc,QAAQ"}