診断レポート#

安定性: 2 - 安定

JSON形式の診断サマリーを提供し、ファイルに書き込みます。

このレポートは、問題の特定のために情報をキャプチャおよび保存するための、開発、テスト、および実稼働での使用を目的としています。JavaScriptおよびネイティブスタックトレース、ヒープ統計、プラットフォーム情報、リソース使用状況などが含まれます。レポートオプションを有効にすると、API呼び出しを通じてプログラムでトリガーすることに加えて、未処理の例外、致命的なエラー、およびユーザーシグナルで診断レポートをトリガーできます。

キャッチされない例外で生成された完全なレポートの例を以下に参照用として示します。

{
  "header": {
    "reportVersion": 3,
    "event": "exception",
    "trigger": "Exception",
    "filename": "report.20181221.005011.8974.0.001.json",
    "dumpEventTime": "2018-12-21T00:50:11Z",
    "dumpEventTimeStamp": "1545371411331",
    "processId": 8974,
    "cwd": "/home/nodeuser/project/node",
    "commandLine": [
      "/home/nodeuser/project/node/out/Release/node",
      "--report-uncaught-exception",
      "/home/nodeuser/project/node/test/report/test-exception.js",
      "child"
    ],
    "nodejsVersion": "v12.0.0-pre",
    "glibcVersionRuntime": "2.17",
    "glibcVersionCompiler": "2.17",
    "wordSize": "64 bit",
    "arch": "x64",
    "platform": "linux",
    "componentVersions": {
      "node": "12.0.0-pre",
      "v8": "7.1.302.28-node.5",
      "uv": "1.24.1",
      "zlib": "1.2.11",
      "ares": "1.15.0",
      "modules": "68",
      "nghttp2": "1.34.0",
      "napi": "3",
      "llhttp": "1.0.1",
      "openssl": "1.1.0j"
    },
    "release": {
      "name": "node"
    },
    "osName": "Linux",
    "osRelease": "3.10.0-862.el7.x86_64",
    "osVersion": "#1 SMP Wed Mar 21 18:14:51 EDT 2018",
    "osMachine": "x86_64",
    "cpus": [
      {
        "model": "Intel(R) Core(TM) i7-6820HQ CPU @ 2.70GHz",
        "speed": 2700,
        "user": 88902660,
        "nice": 0,
        "sys": 50902570,
        "idle": 241732220,
        "irq": 0
      },
      {
        "model": "Intel(R) Core(TM) i7-6820HQ CPU @ 2.70GHz",
        "speed": 2700,
        "user": 88902660,
        "nice": 0,
        "sys": 50902570,
        "idle": 241732220,
        "irq": 0
      }
    ],
    "networkInterfaces": [
      {
        "name": "en0",
        "internal": false,
        "mac": "13:10:de:ad:be:ef",
        "address": "10.0.0.37",
        "netmask": "255.255.255.0",
        "family": "IPv4"
      }
    ],
    "host": "test_machine"
  },
  "javascriptStack": {
    "message": "Error: *** test-exception.js: throwing uncaught Error",
    "stack": [
      "at myException (/home/nodeuser/project/node/test/report/test-exception.js:9:11)",
      "at Object.<anonymous> (/home/nodeuser/project/node/test/report/test-exception.js:12:3)",
      "at Module._compile (internal/modules/cjs/loader.js:718:30)",
      "at Object.Module._extensions..js (internal/modules/cjs/loader.js:729:10)",
      "at Module.load (internal/modules/cjs/loader.js:617:32)",
      "at tryModuleLoad (internal/modules/cjs/loader.js:560:12)",
      "at Function.Module._load (internal/modules/cjs/loader.js:552:3)",
      "at Function.Module.runMain (internal/modules/cjs/loader.js:771:12)",
      "at executeUserCode (internal/bootstrap/node.js:332:15)"
    ]
  },
  "nativeStack": [
    {
      "pc": "0x000055b57f07a9ef",
      "symbol": "report::GetNodeReport(v8::Isolate*, node::Environment*, char const*, char const*, v8::Local<v8::String>, std::ostream&) [./node]"
    },
    {
      "pc": "0x000055b57f07cf03",
      "symbol": "report::GetReport(v8::FunctionCallbackInfo<v8::Value> const&) [./node]"
    },
    {
      "pc": "0x000055b57f1bccfd",
      "symbol": " [./node]"
    },
    {
      "pc": "0x000055b57f1be048",
      "symbol": "v8::internal::Builtin_HandleApiCall(int, v8::internal::Object**, v8::internal::Isolate*) [./node]"
    },
    {
      "pc": "0x000055b57feeda0e",
      "symbol": " [./node]"
    }
  ],
  "javascriptHeap": {
    "totalMemory": 5660672,
    "executableMemory": 524288,
    "totalCommittedMemory": 5488640,
    "availableMemory": 4341379928,
    "totalGlobalHandlesMemory": 8192,
    "usedGlobalHandlesMemory": 3136,
    "usedMemory": 4816432,
    "memoryLimit": 4345298944,
    "mallocedMemory": 254128,
    "externalMemory": 315644,
    "peakMallocedMemory": 98752,
    "nativeContextCount": 1,
    "detachedContextCount": 0,
    "doesZapGarbage": 0,
    "heapSpaces": {
      "read_only_space": {
        "memorySize": 524288,
        "committedMemory": 39208,
        "capacity": 515584,
        "used": 30504,
        "available": 485080
      },
      "new_space": {
        "memorySize": 2097152,
        "committedMemory": 2019312,
        "capacity": 1031168,
        "used": 985496,
        "available": 45672
      },
      "old_space": {
        "memorySize": 2273280,
        "committedMemory": 1769008,
        "capacity": 1974640,
        "used": 1725488,
        "available": 249152
      },
      "code_space": {
        "memorySize": 696320,
        "committedMemory": 184896,
        "capacity": 152128,
        "used": 152128,
        "available": 0
      },
      "map_space": {
        "memorySize": 536576,
        "committedMemory": 344928,
        "capacity": 327520,
        "used": 327520,
        "available": 0
      },
      "large_object_space": {
        "memorySize": 0,
        "committedMemory": 0,
        "capacity": 1520590336,
        "used": 0,
        "available": 1520590336
      },
      "new_large_object_space": {
        "memorySize": 0,
        "committedMemory": 0,
        "capacity": 0,
        "used": 0,
        "available": 0
      }
    }
  },
  "resourceUsage": {
    "rss": "35766272",
    "free_memory": "1598337024",
    "total_memory": "17179869184",
    "available_memory": "1598337024",
    "maxRss": "36624662528",
    "constrained_memory": "36624662528",
    "userCpuSeconds": 0.040072,
    "kernelCpuSeconds": 0.016029,
    "cpuConsumptionPercent": 5.6101,
    "userCpuConsumptionPercent": 4.0072,
    "kernelCpuConsumptionPercent": 1.6029,
    "pageFaults": {
      "IORequired": 0,
      "IONotRequired": 4610
    },
    "fsActivity": {
      "reads": 0,
      "writes": 0
    }
  },
  "uvthreadResourceUsage": {
    "userCpuSeconds": 0.039843,
    "kernelCpuSeconds": 0.015937,
    "cpuConsumptionPercent": 5.578,
    "userCpuConsumptionPercent": 3.9843,
    "kernelCpuConsumptionPercent": 1.5937,
    "fsActivity": {
      "reads": 0,
      "writes": 0
    }
  },
  "libuv": [
    {
      "type": "async",
      "is_active": true,
      "is_referenced": false,
      "address": "0x0000000102910900",
      "details": ""
    },
    {
      "type": "timer",
      "is_active": false,
      "is_referenced": false,
      "address": "0x00007fff5fbfeab0",
      "repeat": 0,
      "firesInMsFromNow": 94403548320796,
      "expired": true
    },
    {
      "type": "check",
      "is_active": true,
      "is_referenced": false,
      "address": "0x00007fff5fbfeb48"
    },
    {
      "type": "idle",
      "is_active": false,
      "is_referenced": true,
      "address": "0x00007fff5fbfebc0"
    },
    {
      "type": "prepare",
      "is_active": false,
      "is_referenced": false,
      "address": "0x00007fff5fbfec38"
    },
    {
      "type": "check",
      "is_active": false,
      "is_referenced": false,
      "address": "0x00007fff5fbfecb0"
    },
    {
      "type": "async",
      "is_active": true,
      "is_referenced": false,
      "address": "0x000000010188f2e0"
    },
    {
      "type": "tty",
      "is_active": false,
      "is_referenced": true,
      "address": "0x000055b581db0e18",
      "width": 204,
      "height": 55,
      "fd": 17,
      "writeQueueSize": 0,
      "readable": true,
      "writable": true
    },
    {
      "type": "signal",
      "is_active": true,
      "is_referenced": false,
      "address": "0x000055b581d80010",
      "signum": 28,
      "signal": "SIGWINCH"
    },
    {
      "type": "tty",
      "is_active": true,
      "is_referenced": true,
      "address": "0x000055b581df59f8",
      "width": 204,
      "height": 55,
      "fd": 19,
      "writeQueueSize": 0,
      "readable": true,
      "writable": true
    },
    {
      "type": "loop",
      "is_active": true,
      "address": "0x000055fc7b2cb180",
      "loopIdleTimeSeconds": 22644.8
    }
  ],
  "workers": [],
  "environmentVariables": {
    "REMOTEHOST": "REMOVED",
    "MANPATH": "/opt/rh/devtoolset-3/root/usr/share/man:",
    "XDG_SESSION_ID": "66126",
    "HOSTNAME": "test_machine",
    "HOST": "test_machine",
    "TERM": "xterm-256color",
    "SHELL": "/bin/csh",
    "SSH_CLIENT": "REMOVED",
    "PERL5LIB": "/opt/rh/devtoolset-3/root//usr/lib64/perl5/vendor_perl:/opt/rh/devtoolset-3/root/usr/lib/perl5:/opt/rh/devtoolset-3/root//usr/share/perl5/vendor_perl",
    "OLDPWD": "/home/nodeuser/project/node/src",
    "JAVACONFDIRS": "/opt/rh/devtoolset-3/root/etc/java:/etc/java",
    "SSH_TTY": "/dev/pts/0",
    "PCP_DIR": "/opt/rh/devtoolset-3/root",
    "GROUP": "normaluser",
    "USER": "nodeuser",
    "LD_LIBRARY_PATH": "/opt/rh/devtoolset-3/root/usr/lib64:/opt/rh/devtoolset-3/root/usr/lib",
    "HOSTTYPE": "x86_64-linux",
    "XDG_CONFIG_DIRS": "/opt/rh/devtoolset-3/root/etc/xdg:/etc/xdg",
    "MAIL": "/var/spool/mail/nodeuser",
    "PATH": "/home/nodeuser/project/node:/opt/rh/devtoolset-3/root/usr/bin:/usr/local/bin:/usr/bin:/usr/local/sbin:/usr/sbin",
    "PWD": "/home/nodeuser/project/node",
    "LANG": "en_US.UTF-8",
    "PS1": "\\u@\\h : \\[\\e[31m\\]\\w\\[\\e[m\\] >  ",
    "SHLVL": "2",
    "HOME": "/home/nodeuser",
    "OSTYPE": "linux",
    "VENDOR": "unknown",
    "PYTHONPATH": "/opt/rh/devtoolset-3/root/usr/lib64/python2.7/site-packages:/opt/rh/devtoolset-3/root/usr/lib/python2.7/site-packages",
    "MACHTYPE": "x86_64",
    "LOGNAME": "nodeuser",
    "XDG_DATA_DIRS": "/opt/rh/devtoolset-3/root/usr/share:/usr/local/share:/usr/share",
    "LESSOPEN": "||/usr/bin/lesspipe.sh %s",
    "INFOPATH": "/opt/rh/devtoolset-3/root/usr/share/info",
    "XDG_RUNTIME_DIR": "/run/user/50141",
    "_": "./node"
  },
  "userLimits": {
    "core_file_size_blocks": {
      "soft": "",
      "hard": "unlimited"
    },
    "data_seg_size_kbytes": {
      "soft": "unlimited",
      "hard": "unlimited"
    },
    "file_size_blocks": {
      "soft": "unlimited",
      "hard": "unlimited"
    },
    "max_locked_memory_bytes": {
      "soft": "unlimited",
      "hard": 65536
    },
    "max_memory_size_kbytes": {
      "soft": "unlimited",
      "hard": "unlimited"
    },
    "open_files": {
      "soft": "unlimited",
      "hard": 4096
    },
    "stack_size_bytes": {
      "soft": "unlimited",
      "hard": "unlimited"
    },
    "cpu_time_seconds": {
      "soft": "unlimited",
      "hard": "unlimited"
    },
    "max_user_processes": {
      "soft": "unlimited",
      "hard": 4127290
    },
    "virtual_memory_kbytes": {
      "soft": "unlimited",
      "hard": "unlimited"
    }
  },
  "sharedObjects": [
    "/lib64/libdl.so.2",
    "/lib64/librt.so.1",
    "/lib64/libstdc++.so.6",
    "/lib64/libm.so.6",
    "/lib64/libgcc_s.so.1",
    "/lib64/libpthread.so.0",
    "/lib64/libc.so.6",
    "/lib64/ld-linux-x86-64.so.2"
  ]
}

使い方#

node --report-uncaught-exception --report-on-signal \
--report-on-fatalerror app.js

  • --report-uncaught-exception キャッチされない例外が発生した場合にレポートを生成できるようにします。ネイティブスタックやその他のランタイム環境データと組み合わせてJavaScriptスタックを調べるときに役立ちます。

  • --report-on-signal 実行中のNode.jsプロセスに指定された（または事前定義された）シグナルを受信したときにレポートが生成されるようにします。（レポートをトリガーするシグナルを変更する方法については、以下を参照してください。）デフォルトのシグナルはSIGUSR2です。別のプログラムからレポートをトリガーする必要がある場合に役立ちます。アプリケーションモニターは、この機能を利用して、定期的にレポートを収集し、豊富な内部ランタイムデータのセットをビューにプロットできます。

シグナルベースのレポート生成は、Windowsではサポートされていません。

通常、レポートをトリガーするシグナルを変更する必要はありません。ただし、SIGUSR2が他の目的ですでに使用されている場合は、このフラグを使用すると、レポート生成のシグナルを変更し、SIGUSR2の元の意味を当該目的のために保持できます。

  • --report-on-fatalerror アプリケーションの終了につながる致命的なエラー（メモリ不足などのNode.jsランタイム内の内部エラー）が発生した場合にレポートをトリガーできるようにします。ヒープ、スタック、イベントループの状態、リソース消費量などのさまざまな診断データ要素を調べて、致命的なエラーの原因を推論するのに役立ちます。

  • --report-compact レポートをコンパクトな形式（単一行JSON）で書き込みます。これは、人間が消費するように設計されたデフォルトの複数行形式よりも、ログ処理システムでより簡単に消費できます。

  • --report-directory レポートが生成される場所。

  • --report-filename レポートが書き込まれるファイルの名前。

  • --report-signal レポート生成のシグナルを設定またはリセットします（Windowsではサポートされていません）。デフォルトのシグナルはSIGUSR2です。

レポートは、JavaScriptアプリケーションからのAPI呼び出しによってもトリガーできます。

process.report.writeReport();

この関数は、レポートが書き込まれるファイルの名前であるオプションの追加引数filenameを受け取ります。

process.report.writeReport('./foo.json');

この関数は、レポートに出力されるJavaScriptスタックのコンテキストとして使用されるErrorオブジェクトであるオプションの追加引数errを受け取ります。レポートを使用して、コールバックまたは例外ハンドラーのエラーを処理する場合、これにより、レポートに元のエラーの場所と、それが処理された場所を含めることができます。

try {
  process.chdir('/non-existent-path');
} catch (err) {
  process.report.writeReport(err);
}
// Any other code

ファイル名とエラーオブジェクトの両方がwriteReport()に渡される場合、エラーオブジェクトは2番目のパラメーターである必要があります。

try {
  process.chdir('/non-existent-path');
} catch (err) {
  process.report.writeReport(filename, err);
}
// Any other code

診断レポートの内容は、JavaScriptアプリケーションからのAPI呼び出しを介してJavaScriptオブジェクトとして返すことができます。

const report = process.report.getReport();
console.log(typeof report === 'object'); // true

// Similar to process.report.writeReport() output
console.log(JSON.stringify(report, null, 2));

この関数は、レポートに出力されるJavaScriptスタックのコンテキストとして使用されるErrorオブジェクトであるオプションの追加引数errを受け取ります。

const report = process.report.getReport(new Error('custom error'));
console.log(typeof report === 'object'); // true

APIバージョンは、リソース消費量の自己調整、負荷分散、監視などを期待して、アプリケーション内からランタイム状態を検査する場合に役立ちます。

レポートの内容は、イベントタイプ、日付、時刻、PID、およびNode.jsバージョンを含むヘッダーセクション、JavaScriptおよびネイティブスタックトレースを含むセクション、V8ヒープ情報を含むセクション、libuvハンドル情報を含むセクション、およびCPUとメモリの使用量とシステム制限を示すOSプラットフォーム情報セクションで構成されます。レポートの例は、Node.js REPLを使用してトリガーできます。

$ node
> process.report.writeReport();
Writing Node.js report to file: report.20181126.091102.8480.0.001.json
Node.js report completed
>

レポートが書き込まれると、開始メッセージと終了メッセージがstderrに発行され、レポートのファイル名が呼び出し元に返されます。デフォルトのファイル名には、日付、時刻、PID、およびシーケンス番号が含まれています。シーケンス番号は、同じNode.jsプロセスに対して複数回生成された場合に、レポートダンプをランタイム状態に関連付けるのに役立ちます。

診断レポートには、レポート形式を一意に表す関連する1桁のバージョン番号（report.header.reportVersion）があります。バージョン番号は、新しいキーが追加または削除された場合、または値のデータ型が変更された場合にインクリメントされます。レポートのバージョン定義は、LTSリリース全体で一貫しています。

設定#

レポート生成の追加のランタイム構成は、process.reportの次のプロパティを介して利用できます。

reportOnFatalError は、trueの場合に致命的なエラーで診断レポートをトリガーします。デフォルトはfalseです。

reportOnSignal は、trueの場合にシグナルで診断レポートをトリガーします。これはWindowsではサポートされていません。デフォルトはfalseです。

reportOnUncaughtException は、trueの場合にキャッチされない例外で診断レポートをトリガーします。デフォルトはfalseです。

signal は、レポート生成の外部トリガーをインターセプトするために使用されるPOSIXシグナル識別子を指定します。デフォルトは'SIGUSR2'です。

filename は、ファイルシステム内の出力ファイルの名前を指定します。stdoutとstderrには特別な意味があります。これらを使用すると、レポートが関連付けられた標準ストリームに書き込まれます。標準ストリームが使用されている場合、directoryの値は無視されます。URLはサポートされていません。デフォルトは、タイムスタンプ、PID、およびシーケンス番号を含む複合ファイル名です。

directory は、レポートが書き込まれるファイルシステムディレクトリを指定します。URLはサポートされていません。デフォルトは、Node.jsプロセスの現在の作業ディレクトリです。

// Trigger report only on uncaught exceptions.
process.report.reportOnFatalError = false;
process.report.reportOnSignal = false;
process.report.reportOnUncaughtException = true;

// Trigger report for both internal errors as well as external signal.
process.report.reportOnFatalError = true;
process.report.reportOnSignal = true;
process.report.reportOnUncaughtException = false;

// Change the default signal to 'SIGQUIT' and enable it.
process.report.reportOnFatalError = false;
process.report.reportOnUncaughtException = false;
process.report.reportOnSignal = true;
process.report.signal = 'SIGQUIT';

モジュール初期化時の構成は、環境変数でも利用できます。

NODE_OPTIONS="--report-uncaught-exception \
  --report-on-fatalerror --report-on-signal \
  --report-signal=SIGUSR2  --report-filename=./report.json \
  --report-directory=/home/nodeuser"

特定のAPIドキュメントは、process API documentationセクションにあります。

ワーカーとの相互作用#

履歴
バージョン変更点
v13.9.0, v12.16.2

ワーカーがレポートに含まれるようになりました。

Workerスレッドは、メインスレッドと同じ方法でレポートを作成できます。

レポートには、現在のスレッドの子であるすべてのワーカーに関する情報がworkersセクションの一部として含まれ、各ワーカーは標準レポート形式でレポートを生成します。

レポートを生成しているスレッドは、ワーカー スレッドからのレポートが完了するのを待ちます。ただし、JavaScriptとイベントループの両方がレポートを生成するために中断されるため、これによる遅延は通常は低くなります。