Debugging Express
Express Docs · نسخهٔ 14b435df23ad · طبق مجوز مستندات مخزن رسمی
To see all the internal logs used in Express, set the DEBUG environment variable to express:* when launching your app.
$ DEBUG=express:* node index.jsOn Windows, use the corresponding command.
> $env:DEBUG = "express:*"; node index.jsRunning this command on the default app generated by the express generator prints the following output:
$ DEBUG=express:* node ./bin/www
express:router:route new / +0ms
express:router:layer new / +1ms
express:router:route get / +1ms
express:router:layer new / +0ms
express:router:route new / +1ms
express:router:layer new / +0ms
express:router:route get / +0ms
express:router:layer new / +0ms
express:application compile etag weak +1ms
express:application compile query parser extended +0ms
express:application compile trust proxy false +0ms
express:application booting in development mode +1ms
express:router use / query +0ms
express:router:layer new / +0ms
express:router use / expressInit +0ms
express:router:layer new / +0ms
express:router use / favicon +1ms
express:router:layer new / +0ms
express:router use / logger +0ms
express:router:layer new / +0ms
express:router use / jsonParser +0ms
express:router:layer new / +1ms
express:router use / urlencodedParser +0ms
express:router:layer new / +0ms
express:router use / cookieParser +0ms
express:router:layer new / +0ms
express:router use / stylus +90ms
express:router:layer new / +0ms
express:router use / serveStatic +0ms
express:router:layer new / +0ms
express:router use / router +0ms
express:router:layer new / +1ms
express:router use /users router +0ms
express:router:layer new /users +0ms
express:router use / <anonymous> +0ms
express:router:layer new / +0ms
express:router use / <anonymous> +0ms
express:router:layer new / +0ms
express:router use / <anonymous> +0ms
express:router:layer new / +0msWhen a request is then made to the app, you will see the logs specified in the Express code:
express:router dispatching GET / +4h
express:router query : / +2ms
express:router expressInit : / +0ms
express:router favicon : / +0ms
express:router logger : / +1ms
express:router jsonParser : / +0ms
express:router urlencodedParser : / +1ms
express:router cookieParser : / +0ms
express:router stylus : / +0ms
express:router serveStatic : / +2ms
express:router router : / +2ms
express:router dispatching GET / +1ms
express:view lookup "index.pug" +338ms
express:view stat "/projects/example/views/index.pug" +0ms
express:view render "/projects/example/views/index.pug" +1msTo see the logs only from the router implementation, set the value of DEBUG to express:router. Likewise, to see logs only from the application implementation, set the value of DEBUG to express:application, and so on.
Using debug in your own code
The same debug module that Express uses internally is available for your application code. Install it, create one or more loggers scoped to a namespace of your choosing, and call them wherever you would otherwise use console.log:
<PackageManagerCommand command="npm install debug" />
const express = require('express');
const debug = require('debug')('myapp:server');
const app = express();
app.get('/', (req, res) => {
debug('handling request from %s', req.ip);
res.send('Hello World!');
});
app.listen(3000, () => {
debug('listening on port 3000');
});
const debug = debugModule('myapp:server');
const app = express();
app.get('/', (req, res) => {
debug('handling request from %s', req.ip);
res.send('Hello World!');
});
app.listen(3000, () => {
debug('listening on port 3000');
});These statements print nothing by default. Enable them through the same DEBUG environment variable, using your own namespace:
$ DEBUG=myapp:* node index.jsYou can specify more than one debug namespace by assigning a comma-separated list of names:
$ DEBUG=myapp:*,express:router node index.jsSetting DEBUG in your IDE
The DEBUG environment variable can be set by any process launcher that supports environment variables, including the run and debug configurations of your IDE. For example, in VS Code you can set it in the env property of a launch configuration:
{
"type": "node",
"request": "launch",
"name": "Launch Express app",
"program": "${workspaceFolder}/index.js",
"env": { "DEBUG": "express:*" }
}See Node.js debugging in VS Code for the full list of launch options.
Using the Node.js inspector
Debug logs show what the app did; for stepping through your code with breakpoints, use the built-in Node.js inspector. Start your app with the --inspect flag:
$ node --inspect index.jsThen attach a debugging client, such as Chrome DevTools (open chrome://inspect), VS Code, or any other inspector-capable tool, to set breakpoints in your route handlers and middleware, step through code, and inspect variables.
If you need to debug something that happens during startup, use --inspect-brk instead, which pauses execution on the first line until a debugger attaches. See the Node.js debugging guide for details.
Debugging the HTTP layer
Express runs on top of the Node.js http module, which has its own debugging facilities that work with any Express app.
Setting the NODE_DEBUG environment variable to http makes Node.js print internal logs from the HTTP layer, such as connection handling and socket events:
$ NODE_DEBUG=http node index.jsYou can combine it with other subsystems, such as net or stream, in a comma-separated list. Be aware that this output can expose sensitive data such as authentication headers, so use it only in development.
Diagnostics channels
Node.js publishes an event for every HTTP request through the diagnostics_channel module, which you can subscribe to without patching Express or adding middleware:
const { subscribe } = require('node:diagnostics_channel');
subscribe('http.server.request.start', ({ request }) => {
console.log(`${request.method} ${request.url}`);
});
subscribe('http.server.request.start', ({ request }) => {
console.log(`${request.method} ${request.url}`);
});Other built-in channels cover the rest of the request lifecycle, such as http.server.response.finish, and the client side of http.request calls. See the diagnostics_channel documentation for the full list.
Advanced options
When running through Node.js, you can set a few environment variables that will change the behavior of the debug logging:
| Name | Purpose |
|---|---|
DEBUG | Enables/disables specific debugging namespaces. |
DEBUG_COLORS | Whether or not to use colors in the debug output. |
DEBUG_DEPTH | Object inspection depth. |
DEBUG_FD | File descriptor to write debug output to. |
DEBUG_SHOW_HIDDEN | Shows hidden properties on inspected objects. |
<Alert type="info">
The environment variables beginning with DEBUG_ end up being converted into an Options object that gets used with %o/%O formatters. See the Node.js documentation for [util.inspect()](https://nodejs.org/api/util.html#utilinspectobject-options) for the complete list.
</Alert>