Skip to content

Commit 3976922

Browse files
jmsundarclaude
andcommitted
docs(nodejs): drop stale OPENTELEMETRY_JS_PATH and IITM_PATH refs
Build scripts only consume OPENTELEMETRY_JS_CONTRIB_PATH now; the upstream opentelemetry-js and import-in-the-middle forks were dropped when we moved those deps to npm. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
1 parent e7af743 commit 3976922

1 file changed

Lines changed: 5 additions & 19 deletions

File tree

nodejs/README.md

Lines changed: 5 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -12,27 +12,17 @@ included and loaded automatically if you use the AWS SDK v2.
1212

1313
### Requirements
1414

15-
You will need to provide the path to 3 forked dependencies through environment
16-
variables for the libraries below:
15+
The build only needs one forked dependency:
1716

18-
- opentelemetry-js: `OPENTELEMETRY_JS_PATH`.
19-
- opentelemetry-js-contrib: `OPENTELEMETRY_JS_CONTRIB_PATH`.
20-
- import-in-the-middle: `IITM_PATH`.
17+
- `coralogix/opentelemetry-js-contrib` (branch `coralogix-autoinstrumentation`), pointed at by `OPENTELEMETRY_JS_CONTRIB_PATH`.
2118

22-
Note that these paths are very important, because they are will impact the
23-
relative paths in some `package.json` files in ways that could potentially
24-
break CI scripts.
25-
26-
To avoid this issue we recommend setting them like so:
19+
If you already have a local checkout, set:
2720

2821
```sh
2922
export OPENTELEMETRY_JS_CONTRIB_PATH=./opentelemetry-js-contrib-cx
30-
export OPENTELEMETRY_JS_PATH=./opentelemetry-js
31-
export IITM_PATH=./import-in-the-middle
3223
```
3324

34-
This project's `.gitignore` is already configured with these folders
35-
to ensure your git index stays clean.
25+
Otherwise leave it unset and `./scripts/build-nodejs.sh` will clone the pinned SHA to `.build-cache/opentelemetry-js-contrib/`. Both paths are gitignored. `upstream/opentelemetry-js` and `import-in-the-middle` are now resolved from npm, no local checkout needed.
3626

3727
### The layer
3828

@@ -43,8 +33,4 @@ the root of the application:
4333
./scripts/build-nodejs.sh
4434
```
4535

46-
This is a thin wrapper over `./scripts/build_nodejs_layer.sh` that
47-
will clone the forked dependencies if the paths indicated by the
48-
previously mentioned environment variables are empty, then use
49-
that script to download all dependencies and compile all code.
50-
The layer zip file will be present at `./packages/layer/build/layer.zip`.
36+
This is a thin wrapper over `./scripts/build_nodejs_layer.sh` that handles the cx-contrib fork clone/checkout when `OPENTELEMETRY_JS_CONTRIB_PATH` is unset, then calls `build_nodejs_layer.sh` to install deps and compile. The layer zip file will be present at `./packages/layer/build/layer.zip`.

0 commit comments

Comments
 (0)