next.js: [NEXT-1173] use node module inside instrumentation hook cause module not found error

Ran into this issue with 13.5.4, originally, I had

if (process.env.NEXT_RUNTIME !== "nodejs") return;
// imports and do something

but apparently this does not work, instead it must be

if (process.env.NEXT_RUNTIME === "nodejs") {
  // imports and do something
}

Hi, was trying this feature out and faced the same problem at first. Then read again the documentation and realized that I needed to use import inside the function. The other issue is that you need to check that your are running your code in the correct runtime. Seen your codesandbox and this should fix it:

instrumentation.ts:

export async function register() {
  if (process.env.NEXT_RUNTIME === "nodejs") {
    const { join } = await import("path");
    const { cwd, exit, platform } = await import("process");
    console.log(join("a", "b"));
    console.log(cwd());
  }
}

Hope this helps

for some reason…found out that you must put those imports in:

export async function register() {
    if (process.env.NEXT_RUNTIME === "nodejs") {
        console.log("instrumentation register");
        //await import packages...
    }
}

not only using await, the trick seems to be “if (process.env.NEXT_RUNTIME === “nodejs”) {…}”, you have to do things inside this “IF”, I don’t know why, but it worked well, otherwise didn’t.

I’m running into this in dependencies.

If I attempt to await import('winston'), it errors on os being required by the @colors/colors dependency in winston.

Forked from @justLuiz’s example:

Just importing winston

My problem with this feature is I wanted something to run on server start and not when the first browser window opens. It seems that its not the case even though they are marketing it as start with the server: If you export a function named register from this file, we will call that function whenever a new Next.js server instance is bootstrapped.

I have the same problem, This looks like a bug.

Hi, was trying this feature out and faced the same problem at first. Then read again the documentation and realized that I needed to use import inside the function. The other issue is that you need to check that your are running your code in the correct runtime. Seen your codesandbox and this should fix it:

instrumentation.ts:

export async function register() {
  if (process.env.NEXT_RUNTIME === "nodejs") {
    const { join } = await import("path");
    const { cwd, exit, platform } = await import("process");
    console.log(join("a", "b"));
    console.log(cwd());
  }
}

Hope this helps

it works，thanks！ maybe the document should describe it more clear

I’m also hitting a similar issue:

Error: Module not found: Can't resolve 'net'

https://nextjs.org/docs/messages/module-not-found

Import trace for requested module:
./node_modules/.pnpm/postgres@3.3.5/node_modules/postgres/src/index.js
./src/app/api/db/index.ts
./src/instrumentation.ts

For my case, I’m running my DB migrations on server start, and I import the migration function from my DB lib. From the above solution, it looks like I may need to pull in my DB connection and migration logic directly into register, but this is not ideal.

Also running into this issue when attempting to bootstrap the https://github.com/microsoft/ApplicationInsights-node.js package.

Inlining the logic into the register function doesn’t work as the Node runtime dependencies are only used by the applicationinsights package. Using the workaround with the browser config is a non-starter as that would require explicitly declaring [node package name]: false for over a dozen packages, when those packages should be resolvable in the nodejs runtime without issue.

My problem with this feature is I wanted something to run on server start and not when the first browser window opens. It seems that its not the case even though they are marketing it as start with the server: If you export a function named register from this file, we will call that function whenever a new Next.js server instance is bootstrapped.