Skip to content

Commit

Permalink
docs: updated the comments
Browse files Browse the repository at this point in the history
  • Loading branch information
aryamohanan committed Apr 4, 2024
1 parent 32b8402 commit f84b8d4
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 21 deletions.
12 changes: 6 additions & 6 deletions packages/aws-fargate/esm-loader.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,20 @@

/**
* IMPORTANT NOTE: From Node.js version 18.19 and above, the ESM loaders operate off-thread.
* Consequently, ESM instrumentation using '--experimental-loader' becomes obsolete.
* Instead, we recommend using '--import' for loading instrumentation and relocating the
* Instana collector loading to './register' file.
* Consequently, ESM instrumentation using '--experimental-loader' becomes deprecated.
* Instead, we are using '--import' for loading instrumentation and relocated the Instana collector
* loading to './register' file.
* Please note that '--import' flag is unavailable in earlier versions, hence we maintain both setups.
* We will incorporate the native ESM support by using 'import-in-the-middle'.
* We will incorporate the native ESM support by using 'import-in-the-middle' ith register method.
*
* Usage:
* ENV NODE_OPTIONS='--experimental-loader=/instana/node_modules/
* @instana/aws-fargate/esm-loader.mjs'
*
* NOTE: When using ESM, the customers have the option to set up the aws-fargate
* by configuring ENV variable within the docker file. Given that aws-fargate
* by configuring ENV variable within the docker file. Given that aws-fargate
* self-initializes, its current utilization remains unchanged.
* However, there's potential for future integration where the init() method
* However, there's potential for future integration where the init() method
* can be invoked from this context.
*/

Expand Down
9 changes: 4 additions & 5 deletions packages/azure-container-services/esm-loader.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@

/**
* IMPORTANT NOTE: From Node.js version 18.19 and above, the ESM loaders operate off-thread.
* Consequently, ESM instrumentation using '--experimental-loader' becomes obsolete.
* Instead, we recommend using '--import' for loading instrumentation and relocating the
* Instana collector loading to './register' file.
* Consequently, ESM instrumentation using '--experimental-loader' becomes deprecated.
* Instead, we are using '--import' for loading instrumentation and relocated the Instana collector
* loading to './register' file.
* Please note that '--import' flag is unavailable in earlier versions, hence we maintain both setups.
* We will incorporate the native ESM support by using 'import-in-the-middle'.
* We will incorporate the native ESM support by using 'import-in-the-middle' ith register method.
*
* Usage:
* ENV NODE_OPTIONS='--experimental-loader=/instana/node_modules/
Expand All @@ -24,4 +24,3 @@
*/

import './src/index.js';

9 changes: 4 additions & 5 deletions packages/collector/esm-loader.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,11 @@

/**
* IMPORTANT NOTE: From Node.js version 18.19 and above, the ESM loaders operate off-thread.
* Consequently, ESM instrumentation using '--experimental-loader' becomes obsolete.
* Instead, we recommend using '--import' for loading instrumentation and relocating the
* Instana collector loading to './register' file.
* Consequently, ESM instrumentation using '--experimental-loader' becomes deprecated.
* Instead, we are using '--import' for loading instrumentation and relocated the Instana collector
* loading to './register' file.
* Please note that '--import' flag is unavailable in earlier versions, hence we maintain both setups.
* We will incorporate the native ESM support by using 'import-in-the-middle'.
*
* We will incorporate the native ESM support by using 'import-in-the-middle' ith register method.
* Usage:
* node --experimental-loader=@instana/collector/esm-loader.mjs server.js
*
Expand Down
10 changes: 5 additions & 5 deletions packages/google-cloud-run/esm-loader.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@

/**
* IMPORTANT NOTE: From Node.js version 18.19 and above, the ESM loaders operate off-thread.
* Consequently, ESM instrumentation using '--experimental-loader' becomes obsolete.
* Instead, we recommend using '--import' for loading instrumentation and relocating the
* Instana collector loading to './register' file.
* Consequently, ESM instrumentation using '--experimental-loader' becomes deprecated.
* Instead, we are using '--import' for loading instrumentation and relocated the Instana collector
* loading to './register' file.
* Please note that '--import' flag is unavailable in earlier versions, hence we maintain both setups.
* We will incorporate the native ESM support by using 'import-in-the-middle'.
* We will incorporate the native ESM support by using 'import-in-the-middle' ith register method.
*
* Usage:
* ENV NODE_OPTIONS='--experimental-loader=/instana/node_modules/
Expand All @@ -23,4 +23,4 @@
* can be invoked from this context.
*/

import './src/index.js';
import './src/index.js';

0 comments on commit f84b8d4

Please sign in to comment.