Skip to content

Add Sentry usage to ESM docs #872

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hansott merged 2 commits into from
Jan 13, 2026
Merged

Add Sentry usage to ESM docs #872

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b0b631e
Add Sentry usage to ESM docs
timokoessler Jan 8, 2026
4c33774
Update ESM Sentry guide
timokoessler Jan 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/esm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,15 @@ node --env-file=.env -r @aikidosec/firewall/instrument your-app.js
> [!NOTE]
> The `--env-file` flag cannot be used in `NODE_OPTIONS`.

## Use Zen together with Sentry (ESM)

You need to use Node.js v24.11.1 / v25.1.0 or later to use Zen together with Sentry in an ESM application.
Follow the [Sentry instructions for ESM](https://docs.sentry.io/platforms/javascript/guides/node/install/esm/) to set up Sentry. After that, make sure to preload Zen using `--require`/`-r` before loading Sentry:

```sh
node -r @aikidosec/firewall/instrument --import ./instrument.mjs your-app.js
```

## Known issues

- Zen can not protect ESM sub-dependencies of an ESM package. For example if an ESM package `foo` imports a sub-dependency `bar` that is also an ESM package, Zen will not be able to protect the code in `bar`. This is because the V8 engine does not allow Node.js to observe the evaluation of inner ESM packages (yet). Open issue: [Adding an evaluation hook for v8::Module](https://issues.chromium.org/u/1/issues/384413088). See a full example below.
Expand Down