Express のデバッグ

Express で使用されるすべての内部ログを表示するには、アプリを起動するときに環境変数 DEBUG を express:* に設定します。

$ DEBUG=express:* node index.js

Windows では、対応するコマンドを使用します。

> set DEBUG=express:* & node index.js

express ジェネレータ で生成されたデフォルトのアプリでこのコマンドを実行すると、次の出力が表示されます。

$ 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 / +0ms

その後、アプリにリクエストが行われると、Express コードで指定されたログが表示されます。

  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" +1ms

ルーターの実装からのみログを表示するには、DEBUG の値を express:router に設定します。同様に、アプリケーションの実装からのみログを表示するには、DEBUG の値を express:application に設定します。

express で生成されたアプリケーション

express コマンドで生成されたアプリケーションは debug モジュールを使用しており、そのデバッグネームスペースはアプリケーションの名前にスコープ設定されています。

たとえば、$ express sample-app を使用してアプリを生成した場合、次のコマンドでデバッグステートメントを有効にすることができます。

$ DEBUG=sample-app:* node ./bin/www

名前をカンマ区切りのリストとして割り当てることで、複数のデバッグネームスペースを指定できます。

$ DEBUG=http,mail,express:* node index.js

高度なオプション

Node.js で実行する場合、デバッグログの動作を変更する環境変数をいくつか設定できます。

名称	目的
DEBUG	特定のデバッグネームスペースを有効または無効にします。
DEBUG_COLORS	デバッグ出力に色を使用するかどうか。
DEBUG_DEPTH	オブジェクトのインスペクションの深さ。
DEBUG_FD	デバッグ出力を書き込むファイル記述子。
DEBUG_SHOW_HIDDEN	非表示のプロパティをインスペクション対象のオブジェクトに表示します。

注意: DEBUG_ で始まる環境変数は、%o/%O フォーマッターで使用されるオプションオブジェクトに変換されます。完全なリストについては、util.inspect() の Node.js ドキュメントを参照してください。