@clickhouse/clickstack-node 0.0.0-stage → 1.0.0-rc.1

package/LICENSE

@@ -0,0 +1,203 @@
+Copyright 2016-2026 ClickHouse, Inc.
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 ClickHouse, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,283 @@
-# Temporary Holding Version
+# @clickhouse/clickstack-node
 
-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.
+Traces, metrics and logs from Node.js apps to ClickStack, built on the upstream OpenTelemetry
+Node.js SDK. One flag or one `init` call starts the SDK with the upstream auto-instrumentations,
+records `console` output and crashes, and flushes telemetry on exit, termination signals and AWS
+Lambda invocations. Exporters, batching, sampling and every `OTEL_*` variable stay upstream. Apps
+that set up the SDK themselves do not need this package
+([Using the upstream SDK directly](#using-the-upstream-sdk-directly)).
+
+If you're migrating from `@hyperdx/node-opentelemetry` please follow the
+[migration guide](docs/migration.md).
+
+## Install
+
+```sh
+npm install @clickhouse/clickstack-node
+```
+
+The package needs Node.js 22.15 or later and ships ES module and CommonJS builds.
+`@opentelemetry/api` is a peer dependency, which npm installs automatically, so the app and the
+SDK share one copy.
+
+## Quick start
+
+```sh
+export OTEL_EXPORTER_OTLP_ENDPOINT=https://example-collector.clickhouse.com:4318
+export OTEL_EXPORTER_OTLP_HEADERS="authorization=<YOUR_INGESTION_API_KEY>"
+export OTEL_SERVICE_NAME=example-app
+node --import @clickhouse/clickstack-node/register server.js
+```
+
+The endpoint is the OTLP HTTP address of your OpenTelemetry collector (port 4318), without
+`/v1/traces`. With ClickStack, it is your service's collector URL.
+
+The flag works for CommonJS and ES module apps, and `--require` works too. In `NODE_OPTIONS`, set
+it only on the command that runs the app, because build tools and every other Node.js process
+inherit it.
+
+Or call `init` in code, at the top of a CommonJS entry file before anything else is required:
+
+```js
+const { init } = require("@clickhouse/clickstack-node");
+
+init({
+  endpoint: "https://example-collector.clickhouse.com:4318",
+  apiKey: "<YOUR_INGESTION_API_KEY>",
+  serviceName: "example-app",
+});
+```
+
+Static imports run before any code in an ES module, so an ES module app calls `init` in a file of
+its own and preloads it: `node --import ./instrumentation.mjs server.mjs`.
+
+| Option                       | Environment variable (wins)                                          | Default                                    | Meaning                                                                                                                                                       |
+| ---------------------------- | -------------------------------------------------------------------- | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `endpoint`                   | `OTEL_EXPORTER_OTLP_ENDPOINT`                                        | `http://localhost:4318`                    | OTLP/HTTP base URL of the collector. `/v1/traces`, `/v1/metrics` and `/v1/logs` are appended.                                                                 |
+| `serviceName`                | `OTEL_SERVICE_NAME`, or `service.name` in `OTEL_RESOURCE_ATTRIBUTES` | `unknown_service:` and the executable name | `service.name` of all telemetry.                                                                                                                              |
+| `environment`                | `OTEL_RESOURCE_ATTRIBUTES` (`deployment.environment.name=<env>`)     | None                                       | `deployment.environment.name`, such as `production` or `staging`.                                                                                             |
+| `apiKey`                     | `OTEL_EXPORTER_OTLP_HEADERS` (`authorization=<key>`)                 | None                                       | Ingestion key, sent as the `authorization` header. Send the bare key; `Bearer <key>` works only on ClickStack 2.38.0 or later.                                |
+| `httpBodyCapture`            | `CLICKSTACK_CAPTURE_HTTP_BODY`                                       | `false`                                    | Records request and response bodies ([Privacy](#privacy)).                                                                                                    |
+| `instrumentations`           | None                                                                 | Upstream defaults                          | The `getNodeAutoInstrumentations()` config map. An `enabled` value here beats `OTEL_NODE_ENABLED_INSTRUMENTATIONS` and `OTEL_NODE_DISABLED_INSTRUMENTATIONS`. |
+| `additionalInstrumentations` | None                                                                 | `[]`                                       | Instrumentation instances to add to the bundle's, for libraries the bundle does not cover.                                                                    |
+
+`init` writes `serviceName`, `endpoint`, `apiKey` and `httpBodyCapture` to their variables only
+when those are unset or blank, so an operator's value wins and child processes inherit it;
+`environment` goes on the resource only. When `OTEL_EXPORTER_OTLP_HEADERS` already holds other
+headers, `apiKey` is ignored with a warning. Use either the flag or `init`: a second
+start logs a warning and does nothing. The rest is fixed:
+
+- Instrumentations: the upstream auto-instrumentations bundle with its defaults, plus `console`
+  capture (`@opentelemetry/instrumentation-console`) and crash capture. To turn `console` capture
+  off, add `console` to `OTEL_NODE_DISABLED_INSTRUMENTATIONS`. It is also off while
+  `OTEL_TRACES_EXPORTER`, `OTEL_METRICS_EXPORTER` or `OTEL_LOGS_EXPORTER` includes `console`,
+  because those exporters print with `console`.
+- The router instrumentation is off. Express 5 is built on the `router` package, so with it every
+  Express middleware gets a second span and every route error three exception events. To turn it
+  on, list `router` in `OTEL_NODE_ENABLED_INSTRUMENTATIONS`, or set `enabled: true` for
+  `@opentelemetry/instrumentation-router` in `instrumentations`.
+- Resource detectors: `container,host,os,process,serviceinstance,env`, so nothing probes cloud
+  metadata endpoints at startup. To add a cloud detector, set `OTEL_NODE_RESOURCE_DETECTORS` to the
+  whole list, without spaces and with `env` last, for example
+  `container,host,os,process,serviceinstance,aws,env`.
+- Diagnostics go to stderr at WARN level (`OTEL_LOG_LEVEL`), unless the app registered its own
+  `diag` logger first. They include unknown names in `OTEL_NODE_ENABLED_INSTRUMENTATIONS`,
+  `OTEL_NODE_DISABLED_INSTRUMENTATIONS` and `OTEL_NODE_RESOURCE_DETECTORS`. Messages from this
+  package start with `clickstack-node:`.
+- Every other OpenTelemetry variable keeps its upstream meaning, for example
+  `OTEL_EXPORTER_OTLP_PROTOCOL` (`http/protobuf`; `grpc` goes to port 4317),
+  `OTEL_TRACES_SAMPLER`, `OTEL_PROPAGATORS` and `OTEL_METRIC_EXPORT_INTERVAL`. Boolean variables
+  are true only for `true`. `OTEL_SDK_DISABLED=true` makes the flag and `init` do nothing.
+
+Other functions:
+
+- `flush(timeoutMillis)` exports what is buffered. It waits at most 5000 ms by default and never
+  rejects.
+- `shutdown(timeoutMillis)` flushes and stops the SDK, with the same bound. Await it before your
+  own code exits the process ([Lifecycle](#lifecycle)).
+- `withFlush(handler)` wraps an async AWS Lambda handler, so telemetry is exported before each
+  invocation returns.
+
+## Privacy
+
+`console` output and crash stack traces are exported by default. Headers and bodies are recorded
+only when you turn them on; they can hold personal data and credentials.
+
+- Headers: `OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_{SERVER,CLIENT}_{REQUEST,RESPONSE}` each list
+  exact header names, comma-separated, such as `user-agent,x-request-id`. They are recorded as
+  `http.request.header.<name>` and `http.response.header.<name>`. Names on
+  `OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SANITIZE_FIELDS` (by default
+  `authorization,cookie,set-cookie,proxy-authorization,x-api-key`) are never recorded.
+- Bodies: `httpBodyCapture` records `node:http` server and client bodies and `fetch` bodies (on
+  Node.js 24.4 or later). Only textual UTF-8 bodies without a `Content-Encoding` are recorded, from
+  the first 8192 bytes of each body; others get a size only. Values of keys that contain
+  `password`, `passwd`, `secret`, `token`, `api_key`, `apikey`, `api-key`, `authorization`,
+  `cookie` or `session` become `[REDACTED]` in JSON-looking text (also one level of JSON escaped
+  inside a string) and in form fields. This is a best effort, so keep a redaction step in your
+  collector.
+- The app's streams are never read, paused or resumed, and the bytes it sends and receives are
+  unchanged.
+
+## Using the upstream SDK directly
+
+This file sets up the upstream SDK with the same instrumentations and defaults. Start the app with
+`node --require ./telemetry.cjs app.js` and the variables from the quick start, plus
+`OTEL_NODE_RESOURCE_DETECTORS=container,host,os,process,serviceinstance,env`.
+
+```js
+// telemetry.cjs
+const {
+  getNodeAutoInstrumentations,
+  getResourceDetectors,
+} = require("@opentelemetry/auto-instrumentations-node");
+const {
+  ConsoleInstrumentation,
+} = require("@opentelemetry/instrumentation-console");
+const { NodeSDK } = require("@opentelemetry/sdk-node");
+
+// Without a log level, NodeSDK prints nothing, not even export errors.
+process.env.OTEL_LOG_LEVEL ??= "warn";
+
+const sdk = new NodeSDK({
+  // Reads OTEL_NODE_RESOURCE_DETECTORS; the default list includes the cloud detectors.
+  resourceDetectors: getResourceDetectors(),
+  instrumentations: [
+    getNodeAutoInstrumentations({
+      "@opentelemetry/instrumentation-runtime-node": {
+        captureUncaughtException: true,
+      },
+      // Express 5 is already covered by the express instrumentation.
+      "@opentelemetry/instrumentation-router": { enabled: false },
+    }),
+    new ConsoleInstrumentation(),
+  ],
+});
+sdk.start();
+
+process.once("SIGTERM", () => {
+  sdk.shutdown().finally(() => process.kill(process.pid, "SIGTERM"));
+});
+```
+
+What the package adds to this:
+
+- ES modules: upstream registers no ES module loader hook on the 2.x line. Add
+  `--experimental-loader=@opentelemetry/instrumentation/hook.mjs`, which prints an
+  `ExperimentalWarning` on every start.
+- Crashes: the record of an uncaught exception is exported before Node.js exits, and the process
+  still exits with code 1. Upstream drops it.
+- Signals: SIGINT as well as SIGTERM, a bounded shutdown, and the exit status when the app runs as
+  PID 1, where a re-raised signal is ignored.
+- AWS Lambda: `withFlush`, and the flush after each invocation by
+  `@opentelemetry/instrumentation-aws-lambda`, which `NodeSDK` leaves bound to a no-op provider. It
+  now also flushes logs, and ends before the invocation's deadline.
+- Header capture from the variables above, and body capture. Upstream reads no header variables
+  and has no body option.
+
+## What is emitted
+
+- Resource: `service.name`, `deployment.environment.name` when set, `telemetry.sdk.*`,
+  `telemetry.distro.name` (`clickstack-node`), `telemetry.distro.version`, and the detector
+  attributes (`host.*`, `os.*`, `process.*`, `container.id`, `service.instance.id`).
+- Spans, metrics and log records from the upstream instrumentations, unchanged.
+- `console` log records: the formatted message as the body, a severity number per method (`debug`
+  5, `log` and `info` 9, `warn` 13, `error` 17) and the active trace context.
+- A FATAL log record (severity number 21, body `exception`) with `exception.type`,
+  `exception.message` and `exception.stacktrace` for an uncaught exception
+  ([Errors](#errors)).
+- With capture on: `http.request.header.<name>` and `http.response.header.<name>` (string arrays),
+  `http.request.body.content` and `http.response.body.content`, and `http.request.body.size` and
+  `http.response.body.size` (bytes). The body keys are in development in the semantic conventions.
+
+## Errors
+
+- Uncaught exceptions, and unhandled rejections under Node's default
+  `--unhandled-rejections=throw`, become the FATAL log record, exported before the process exits
+  ([Lifecycle](#lifecycle)). It carries the active trace when the error comes from an asynchronous
+  callback, such as a timer or a rejected promise. A request still open at the crash exports no
+  span.
+- `exception.stacktrace` is the raw stack, with the error's `cause` chain, up to five deep,
+  appended as `Caused by: Name: message` sections. A thrown value that is not an error, such as
+  `throw { code: 1 }`, is recorded as JSON text in `exception.message`; Node.js itself wraps a
+  rejection reason that is not an error in an `ERR_UNHANDLED_REJECTION` error.
+- Start TypeScript and bundled apps with `--enable-source-maps`, for example in `NODE_OPTIONS`, so
+  that stack traces point to your sources when the error happens. ClickStack maps only browser
+  stack traces.
+- An app `uncaughtException` listener takes over the exit: the FATAL record is still recorded, but
+  the package neither prints the error nor exits, so await `flush()` before your listener ends the
+  process. An app `unhandledRejection` listener turns crash capture off for rejections, because
+  Node.js then no longer treats them as crashes.
+- Errors thrown in route handlers of instrumented frameworks, such as Express, Koa, Hapi and
+  NestJS, are recorded as `exception` events on the handler's span.
+- Errors that your code catches are not recorded. Record them on the active span:
+
+  ```js
+  import { SpanStatusCode, trace } from "@opentelemetry/api";
+
+  const span = trace.getActiveSpan();
+  span?.recordException(err);
+  span?.setStatus({ code: SpanStatusCode.ERROR });
+  ```
+
+- `console.error(err)` sends a log record whose body is the formatted error with its stack trace.
+  It has no `exception.*` attributes, so it does not count as an exception.
+- Telemetry still buffered when the app calls `process.exit()` is lost unless the app awaits
+  `shutdown()` first.
+
+## Lifecycle
+
+- SIGTERM and SIGINT: the SDK shuts down (at most 5 seconds) and the signal is raised again, so the
+  process exits with 143 or 130. If the app has its own listener for the signal, the SDK only
+  flushes and the app owns the exit; await `shutdown()` in that listener before it exits.
+- Uncaught exceptions, and unhandled rejections under the default `--unhandled-rejections=throw`:
+  the error goes to stderr as Node.js prints it, the SDK shuts down, and the process exits with
+  code 1, after 2 seconds when `@sentry/node` is installed so that Sentry can send its event. An app
+  `uncaughtException` listener takes over the exit ([Errors](#errors)).
+- When the event loop empties, the SDK shuts down. `process.exit()` skips this, so scripts call
+  `await shutdown()` first.
+- When the collector cannot be reached, these shutdowns wait the full 5 seconds. A second Ctrl-C,
+  more than a second after the first, exits at once. Set `OTEL_SDK_DISABLED=true` where no
+  collector runs.
+- In Docker, use the exec form of `CMD` (a JSON array), or `docker run --init`. In the shell form,
+  `/bin/sh` is PID 1 and does not forward signals, so `docker stop` kills the app after 10 seconds
+  without a flush.
+- On AWS Lambda, set `NODE_OPTIONS=--import @clickhouse/clickstack-node/register` and wrap the
+  handler. Only async handlers are supported. Flushes end 500 ms before the invocation's deadline,
+  so an unreachable collector does not make invocations time out.
+
+  ```js
+  import { withFlush } from "@clickhouse/clickstack-node";
+
+  export const handler = withFlush(async (event) => {
+    console.log("order received", event.id);
+    return { statusCode: 200 };
+  });
+  ```
+
+- The flag does nothing in worker threads. `init` in a worker starts an SDK for that worker only.
+
+## Compatibility
+
+- Node.js 22.15 or later. CI runs the latest 22, 24 and 26. Windows is not tested.
+- OpenTelemetry JS 2.x: `@opentelemetry/sdk-node` `^0.223.0`, `@opentelemetry/core` `^2.12.0` and
+  `@opentelemetry/auto-instrumentations-node` `^0.81.0`, with `@opentelemetry/api`
+  `>=1.9.1 <1.10.0`.
+- ES modules: the flag uses synchronous loader hooks on Node.js 22.22.3 or later, 24.11.1 or later
+  and 26, and `module.register()` on earlier versions and where `require()` of ES modules is off,
+  such as AWS Lambda. With `module.register()`, a named import from `node:http` after the import of
+  a package that loads `node:http` itself stays uninstrumented (import `node:http` first), and an ES
+  module entry file needs a file extension.
+- Default imports of CommonJS packages: the default export does not see functions that an
+  instrumentation replaces on the package's exports. With `import grpc from "@grpc/grpc-js"`, gRPC
+  client calls get no spans; use `import * as grpc from "@grpc/grpc-js"` or named imports.
+- TypeScript: CommonJS TypeScript fails under any ES module loader hook on Node.js 22 and on 24.0
+  to 24.11, so use `--require` there.
+- Bundlers: code that a bundler inlined cannot be instrumented, and nothing warns. Keep this
+  package and the instrumented libraries external (esbuild `--packages=external`, webpack
+  `externals`, Next.js `serverExternalPackages`). In Next.js, call `init` from `register()` in
+  `instrumentation.ts` when `process.env.NEXT_RUNTIME === "nodejs"`.
+- ClickStack: any version that accepts the ingestion key as a bare `authorization` header.
+
+## License
+
+[Apache-2.0](LICENSE)

package/dist/_virtual/_rolldown/runtime.cjs

@@ -0,0 +1,22 @@
+// \0rolldown/runtime.js
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+		key = keys[i];
+		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+			get: ((k) => from[k]).bind(null, key),
+			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+		});
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule || !__hasOwnProp.call(mod, "default") ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+exports.__toESM = __toESM;

package/dist/body/http.cjs

@@ -0,0 +1,115 @@
+const require_rules = require("./rules.cjs");
+let node_events = require("node:events");
+// src/body/http.ts
+function isIncoming(message) {
+	return !("getHeader" in message);
+}
+function observe(message) {
+	const capture = new require_rules.BodyCapture();
+	const copy = (chunk, encoding) => {
+		try {
+			capture.add(chunk, encoding);
+		} catch (err) {
+			require_rules.reportFailure(err);
+		}
+	};
+	if (isIncoming(message)) {
+		const { headers } = message;
+		const meta = {
+			contentType: headers["content-type"],
+			contentEncoding: headers["content-encoding"],
+			contentLength: headers["content-length"]
+		};
+		const emit = message.emit.bind(message);
+		message.emit = (event, ...args) => {
+			if (event === "data") copy(args[0], message.readableEncoding);
+			return emit(event, ...args);
+		};
+		return {
+			capture,
+			meta: () => ({
+				...meta,
+				complete: message.complete
+			})
+		};
+	}
+	const wrap = (original) => (...args) => {
+		const ended = message.writableEnded;
+		const result = Reflect.apply(original, message, args);
+		if (!ended && typeof args[0] !== "function") copy(args[0], args[1]);
+		return result;
+	};
+	message.write = wrap(message.write.bind(message));
+	message.end = wrap(message.end.bind(message));
+	let written = /* @__PURE__ */ new Map();
+	if ("writeHead" in message) {
+		const response = message;
+		const writeHead = response.writeHead.bind(response);
+		response.writeHead = ((...args) => {
+			const result = writeHead(...args);
+			try {
+				const raw = args.slice(1).find((a) => typeof a === "object" && a !== null);
+				const list = Array.isArray(raw) ? raw.flat() : Object.entries(raw ?? {}).flat();
+				if (list.length > 0) written = require_rules.headerMap(list);
+			} catch (err) {
+				require_rules.reportFailure(err);
+			}
+			return result;
+		});
+	}
+	const header = (name) => message.getHeader(name) ?? written.get(name);
+	return {
+		capture,
+		meta: () => ({
+			contentType: header("content-type"),
+			contentEncoding: header("content-encoding"),
+			contentLength: header("content-length"),
+			complete: message.writableEnded
+		})
+	};
+}
+/**
+* Creates the `node:http` body hooks.
+*
+* @returns Hooks for `instrumentation-http`.
+*/
+function createHttpBodyHooks() {
+	const exchanges = /* @__PURE__ */ new WeakMap();
+	const finalize = (span) => {
+		try {
+			const ex = exchanges.get(span);
+			exchanges.delete(span);
+			if (ex === void 0 || !span.isRecording()) return;
+			span.setAttributes(ex.request.capture.attributes("request", ex.request.meta()));
+			if (ex.response !== void 0 && !require_rules.responseHasNoBody(ex.method, ex.status?.())) span.setAttributes(ex.response.capture.attributes("response", ex.response.meta()));
+		} catch (err) {
+			require_rules.reportFailure(err);
+		}
+	};
+	return {
+		requestHook(span, request) {
+			if (!span.isRecording()) return;
+			exchanges.set(span, {
+				method: request.method,
+				request: observe(request)
+			});
+			if (!isIncoming(request)) {
+				const done = () => {
+					finalize(span);
+				};
+				request.on(node_events.errorMonitor, done).on("close", done);
+			}
+		},
+		responseHook(span, response) {
+			const ex = exchanges.get(span);
+			if (ex === void 0) return;
+			ex.response = observe(response);
+			ex.status = () => response.statusCode;
+			if (!isIncoming(response)) response.on(node_events.errorMonitor, () => {
+				finalize(span);
+			});
+		},
+		finalize
+	};
+}
+exports.createHttpBodyHooks = createHttpBodyHooks;