@jennifersoft/jennifer5-instrumentation 5.6.5-1

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 [yyyy] [name of copyright owner]
+
+   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/LICENSE-3rdparty.csv

@@ -0,0 +1,3 @@
+Component,Origin,License,Copyright
+dd-trace-js datadog-shimmer,https://github.com/DataDog/dd-trace-js,Apache-2.0,"Copyright 2018 Datadog, Inc."
+jshttp/cookie,https://github.com/jshttp/cookie,MIT,"Copyright (c) 2012-2014 Roman Shtylman; Copyright (c) 2015 Douglas Christopher Wilson"

package/MIT-jshttp-cookie.txt

@@ -0,0 +1,24 @@
+(The MIT License)
+
+Copyright (c) 2012-2014 Roman Shtylman <shtylman@gmail.com>
+Copyright (c) 2015 Douglas Christopher Wilson <doug@somethingdoug.com>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

package/NOTICE

@@ -0,0 +1,30 @@
+This project includes code from the following open source projects:
+
+dd-trace-js
+-----------
+Copyright 2018 Datadog, Inc.
+License: Apache-2.0 (chosen from Apache-2.0 OR BSD-3-Clause)
+Source: https://github.com/DataDog/dd-trace-js
+This product includes software developed at Datadog, Inc. (https://www.datadoghq.com/).
+
+Files:
+- packages/jennifer5-instrumentation/src/core/shimmer.ts
+  Based on dd-trace-js/packages/datadog-shimmer/src/shimmer.js
+  Modified for TypeScript and Jennifer instrumentation
+
+License text available at:
+- Apache-2.0: https://www.apache.org/licenses/LICENSE-2.0
+
+jshttp/cookie
+-------------
+Copyright (c) 2012-2014 Roman Shtylman <shtylman@gmail.com>
+Copyright (c) 2015 Douglas Christopher Wilson <doug@somethingdoug.com>
+License: MIT
+Source: https://github.com/jshttp/cookie
+
+Files:
+- packages/jennifer5-instrumentation/src/dep/cookie.ts
+  Copied from jshttp/cookie repository for internal use
+
+License text available at:
+- MIT: ./MIT-jshttp-cookie.txt

package/README.md

@@ -0,0 +1,113 @@
+# @jennifersoft/jennifer5-instrumentation
+
+Node.js APM instrumentation layer for Jennifer5 monitoring system.
+
+## Supported Environments
+
+- **Platform**: Linux x64 gnu (GLIBC 2.15+), Linux x64 musl
+- **Jennifer5 Server**: 5.6.5.7 or later
+- **Node.js**:
+  - CommonJS modules: 18.0+
+  - ESM modules: 18.19+ or 20.6+ 
+    - This package's ESM setup additionally needs `module.register()`, which is available from Node.js 20.6.0 and 18.19.0.
+    - https://nodejs.org/docs/latest/api/module.html#moduleregisterspecifier-parenturl-options
+
+## Installation
+
+### Install via NPM
+
+```bash
+$ # In your Node.js project directory
+$ npm install @jennifersoft/jennifer5-instrumentation
+```
+
+## Configuration
+
+Copy the `jennifer.toml` configuration file from the installed package to your Node.js project's working directory:
+
+```bash
+$ cp node_modules/@jennifersoft/jennifer5-agent/jennifer.toml .
+```
+
+Edit the configuration file with your Jennifer5 server settings:
+
+```toml
+# jennifer5 server address
+server_address = "127.0.0.1"
+
+# jennifer5 server port
+server_port = 5000
+
+# domain_id
+domain_id = 1000
+
+# instance id, if inst_id is '-1', inst_id will be set by server
+inst_id = -1
+```
+
+## Running Node.js with Jennifer5 Agent
+
+### Option 1: Command Line Arguments
+
+**CommonJS application**
+
+```bash
+$ node --require @jennifersoft/jennifer5-instrumentation/auto your_server.js
+```
+
+**ESM application**
+
+```bash
+$ node --import @jennifersoft/jennifer5-instrumentation/auto your_server.js
+```
+
+> Note (Permission model): If Node.js permission model (`--permission`) is enabled,
+> add `--allow-worker` because `module.register()` requires worker permission.
+>
+> ```bash
+> $ node --permission --allow-worker --import @jennifersoft/jennifer5-instrumentation/auto your_server.js
+> ```
+
+### Option 2: NODE_OPTIONS Environment Variable
+
+**CommonJS application**
+
+```bash
+$ export NODE_OPTIONS="--require @jennifersoft/jennifer5-instrumentation/auto"
+$ node your_server.js
+```
+
+**ESM application**
+
+```bash
+$ export NODE_OPTIONS="--import @jennifersoft/jennifer5-instrumentation/auto"
+$ node your_server.js
+```
+
+> Note (Permission model): If Node.js permission model (`--permission`) is enabled,
+> add `--allow-worker` because `module.register()` requires worker permission.
+
+```bash
+$ export NODE_OPTIONS="--permission --allow-worker --import @jennifersoft/jennifer5-instrumentation/auto"
+$ node your_server.js
+```
+
+### Option 3: Initialize in Entry File
+
+Load Jennifer at the very top of your entry file before other imports.
+
+**CommonJS application (`your_server.js`)**
+
+```javascript
+require("@jennifersoft/jennifer5-instrumentation/auto");
+```
+
+**ESM application (`your_server.js` or `your_server.mjs`)**
+
+```javascript
+import "@jennifersoft/jennifer5-instrumentation/auto";
+```
+
+> Note (ESM): For the most reliable instrumentation, use **Option 1** or **Option 2**.
+> In ESM, part of the module graph can be resolved or loaded before your entry file body runs.
+> If Jennifer initializes after that point, some modules may be loaded before hooks are registered.

package/dist/index.d.mts

@@ -0,0 +1,88 @@
+/**
+ * Register all RITM (require-in-the-middle) hooks for CommonJS modules
+ *
+ * This must be called before any instrumented modules are loaded.
+ * RITM intercepts require() calls and patches modules at load time.
+ */
+declare function registerRitmHooks(): void;
+
+/**
+ * Register all IITM (import-in-the-middle) hooks for ES Modules
+ *
+ * This must be called in the loader context via Node.js module.register() API.
+ * IITM intercepts import statements and patches modules at load time.
+ */
+declare function registerIitmHooks(): void;
+
+/**
+ * Callback function type for heap metrics collection
+ */
+type HeapMetricsCallback = (heapUsed: number, heapTotal: number, external: number, arrayBuffers: number) => void;
+/**
+ * Starts periodic collection of Node.js heap metrics
+ *
+ * Collects heap metrics from process.memoryUsage() and sends them to the agent
+ * for transmission to the Jennifer server.
+ *
+ * @param intervalMs - Collection interval in milliseconds (default: 1000ms = 1 second)
+ * @param callback - Optional callback function to send metrics (defaults to sendHeapMetrics)
+ * @returns Cleanup function to stop the collection
+ */
+declare function startHeapMetricsCollection(intervalMs?: number, callback?: HeapMetricsCallback): () => void;
+
+/**
+ * Callback function type for GC metrics transmission
+ */
+type GcMetricsCallback = (gcCount: number, gcTime: number, gcCountDelta: number) => void;
+/**
+ * Starts GC metrics collection using PerformanceObserver
+ *
+ * Collects GC events and sends accumulated metrics to the agent for transmission
+ * to the Jennifer server via RawData protocol (ARIES-3630).
+ *
+ * @param intervalMs - Transmission interval in milliseconds (default: 1000ms = 1 second)
+ * @param callback - Optional callback function to send metrics (defaults to sendGcMetrics)
+ * @returns Cleanup function to stop the collection, or null if PerformanceObserver is not supported
+ *
+ * @remarks
+ * - Requires Node.js 16.7+ for PerformanceObserver GC events
+ * - Accumulates GC count and time (not deltas)
+ * - Server calculates deltas using DiffCalculatorUsingAccumulation
+ * - Observer is created once and maintained throughout process lifetime
+ */
+declare function startGcMetricsCollection(intervalMs?: number, callback?: GcMetricsCallback): (() => void) | null;
+
+/**
+ * Transaction context that is maintained across async operations
+ */
+interface TransactionContext {
+    id: number;
+    enable: boolean;
+}
+/**
+ * Manages transaction contexts using AsyncLocalStorage
+ */
+declare class TransactionContextManager {
+    private _asyncLocalStorage;
+    constructor();
+    /**
+     * Create a new transaction context
+     */
+    start(): TransactionContext;
+    /**
+     * Run a callback within a transaction context scope
+     * All async operations within this scope will automatically have access to the context
+     */
+    run<T>(ctx: TransactionContext, callback: () => T): T;
+    /**
+     * Get the current transaction context (if any)
+     * This works automatically across async boundaries thanks to AsyncLocalStorage
+     */
+    getCurrentContext(): TransactionContext | undefined;
+}
+declare const contextManager: TransactionContextManager;
+
+type RouteHandler<TRequest extends Request = Request> = (request: TRequest) => Promise<Response> | Response;
+declare function withJenniferNextRouteTx<TRequest extends Request>(handler: RouteHandler<TRequest>): RouteHandler<TRequest>;
+
+export { type GcMetricsCallback, type HeapMetricsCallback, type TransactionContext, TransactionContextManager, contextManager, registerIitmHooks, registerRitmHooks, startGcMetricsCollection, startHeapMetricsCollection, withJenniferNextRouteTx };

package/dist/index.d.ts

@@ -0,0 +1,88 @@
+/**
+ * Register all RITM (require-in-the-middle) hooks for CommonJS modules
+ *
+ * This must be called before any instrumented modules are loaded.
+ * RITM intercepts require() calls and patches modules at load time.
+ */
+declare function registerRitmHooks(): void;
+
+/**
+ * Register all IITM (import-in-the-middle) hooks for ES Modules
+ *
+ * This must be called in the loader context via Node.js module.register() API.
+ * IITM intercepts import statements and patches modules at load time.
+ */
+declare function registerIitmHooks(): void;
+
+/**
+ * Callback function type for heap metrics collection
+ */
+type HeapMetricsCallback = (heapUsed: number, heapTotal: number, external: number, arrayBuffers: number) => void;
+/**
+ * Starts periodic collection of Node.js heap metrics
+ *
+ * Collects heap metrics from process.memoryUsage() and sends them to the agent
+ * for transmission to the Jennifer server.
+ *
+ * @param intervalMs - Collection interval in milliseconds (default: 1000ms = 1 second)
+ * @param callback - Optional callback function to send metrics (defaults to sendHeapMetrics)
+ * @returns Cleanup function to stop the collection
+ */
+declare function startHeapMetricsCollection(intervalMs?: number, callback?: HeapMetricsCallback): () => void;
+
+/**
+ * Callback function type for GC metrics transmission
+ */
+type GcMetricsCallback = (gcCount: number, gcTime: number, gcCountDelta: number) => void;
+/**
+ * Starts GC metrics collection using PerformanceObserver
+ *
+ * Collects GC events and sends accumulated metrics to the agent for transmission
+ * to the Jennifer server via RawData protocol (ARIES-3630).
+ *
+ * @param intervalMs - Transmission interval in milliseconds (default: 1000ms = 1 second)
+ * @param callback - Optional callback function to send metrics (defaults to sendGcMetrics)
+ * @returns Cleanup function to stop the collection, or null if PerformanceObserver is not supported
+ *
+ * @remarks
+ * - Requires Node.js 16.7+ for PerformanceObserver GC events
+ * - Accumulates GC count and time (not deltas)
+ * - Server calculates deltas using DiffCalculatorUsingAccumulation
+ * - Observer is created once and maintained throughout process lifetime
+ */
+declare function startGcMetricsCollection(intervalMs?: number, callback?: GcMetricsCallback): (() => void) | null;
+
+/**
+ * Transaction context that is maintained across async operations
+ */
+interface TransactionContext {
+    id: number;
+    enable: boolean;
+}
+/**
+ * Manages transaction contexts using AsyncLocalStorage
+ */
+declare class TransactionContextManager {
+    private _asyncLocalStorage;
+    constructor();
+    /**
+     * Create a new transaction context
+     */
+    start(): TransactionContext;
+    /**
+     * Run a callback within a transaction context scope
+     * All async operations within this scope will automatically have access to the context
+     */
+    run<T>(ctx: TransactionContext, callback: () => T): T;
+    /**
+     * Get the current transaction context (if any)
+     * This works automatically across async boundaries thanks to AsyncLocalStorage
+     */
+    getCurrentContext(): TransactionContext | undefined;
+}
+declare const contextManager: TransactionContextManager;
+
+type RouteHandler<TRequest extends Request = Request> = (request: TRequest) => Promise<Response> | Response;
+declare function withJenniferNextRouteTx<TRequest extends Request>(handler: RouteHandler<TRequest>): RouteHandler<TRequest>;
+
+export { type GcMetricsCallback, type HeapMetricsCallback, type TransactionContext, TransactionContextManager, contextManager, registerIitmHooks, registerRitmHooks, startGcMetricsCollection, startHeapMetricsCollection, withJenniferNextRouteTx };