Commit d64dfd5
doc: add link to diagnostic tools
PR-URL: #43736
Fixes: nodejs/diagnostics#567
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>1 parent f13e4c1 commit d64dfd5
1 file changed
Lines changed: 29 additions & 20 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -93,10 +93,10 @@ The tools are currently assigned to Tiers as follows: | |||
| 93 | 93 | ||
| 94 | 94 | ## Tier 1 | |
| 95 | 95 | ||
| 96 | - | Tool Type | Tool/API Name | Regular Testing in Node.js CI | Integrated with Node.js | Target Tier | | ||
| 97 | - | --------- | ----------------- | ----------------------------- | ----------------------- | ----------- | | ||
| 98 | - | FFDC | diagnostic report | Yes | Yes | 1 | | ||
| 99 | - | | | | | | | ||
| 96 | + | Tool Type | Tool/API Name | Regular Testing in Node.js CI | Integrated with Node.js | Target Tier | | ||
| 97 | + | --------- | --------------------- | ----------------------------- | ----------------------- | ----------- | | ||
| 98 | + | FFDC | [diagnostic report][] | Yes | Yes | 1 | | ||
| 99 | + | | | | | | | ||
| 100 | 100 | ||
| 101 | 101 | ## Tier 2 | |
| 102 | 102 | ||
@@ -112,25 +112,34 @@ The tools are currently assigned to Tiers as follows: | |||
| 112 | 112 | | Profiling | --prof/--prof-process flags | Yes | Yes | 1 | | |
| 113 | 113 | | Profiling | V8 CodeEventHandler API | Partial (V8 Tests) | Yes | 2 | | |
| 114 | 114 | | Profiling | V8 --interpreted-frames-native-stack | Yes | Yes | 2 | | |
| 115 | - | Profiling | Linux perf | Yes | Partial | 2 | | ||
| 116 | - | Profiling | node-clinic | No | No | 3 | | ||
| 117 | - | Debugger | Chrome Dev tools | No | No | 3 | | ||
| 115 | + | Profiling | [Linux perf][] | Yes | Partial | 2 | | ||
| 116 | + | Profiling | [node-clinic][] | No | No | 3 | | ||
| 117 | + | Debugger | [Chrome Dev tools][] | No | No | 3 | | ||
| 118 | 118 | ||
| 119 | 119 | ## Tier 4 | |
| 120 | 120 | ||
| 121 | - | Tool Type | Tool/API Name | Regular Testing in Node.js CI | Integrated with Node.js | Target Tier | | ||
| 122 | - | --------- | --------------------------------------------- | ----------------------------- | ----------------------- | ----------- | | ||
| 123 | - | Profiling | [0x](https://github.com/davidmarkclements/0x) | No | No | 3 | | ||
| 121 | + | Tool Type | Tool/API Name | Regular Testing in Node.js CI | Integrated with Node.js | Target Tier | | ||
| 122 | + | --------- | ------------- | ----------------------------- | ----------------------- | ----------- | | ||
| 123 | + | Profiling | [0x][] | No | No | 3 | | ||
| 124 | 124 | ||
| 125 | 125 | ## Not yet classified | |
| 126 | 126 | ||
| 127 | - | Tool Type | Tool/API Name | Regular Testing in Node.js CI | Integrated with Node.js | Target Tier | | ||
| 128 | - | --------- | ------------------------- | ----------------------------- | ----------------------- | ----------- | | ||
| 129 | - | Memory | V8 heap profiler | No | Yes | 1 | | ||
| 130 | - | Memory | V8 sampling heap profiler | No | Yes | 1 | | ||
| 131 | - | AsyncFlow | Async Hooks (API) | ? | Yes | 1 | | ||
| 132 | - | Debugger | V8 Debug protocol (API) | No | Yes | 1 | | ||
| 133 | - | Debugger | Command line Debug Client | ? | Yes | 1 | | ||
| 134 | - | Tracing | trace\_events (API) | No | Yes | 1 | | ||
| 135 | - | Tracing | trace\_gc | No | Yes | 1 | | ||
| 136 | - | M/T | eBPF tracing tool | No | No | ? | | ||
| 127 | + | Tool Type | Tool/API Name | Regular Testing in Node.js CI | Integrated with Node.js | Target Tier | | ||
| 128 | + | --------- | ----------------------------------------- | ----------------------------- | ----------------------- | ----------- | | ||
| 129 | + | Memory | V8 heap profiler | No | Yes | 1 | | ||
| 130 | + | Memory | V8 sampling heap profiler | No | Yes | 1 | | ||
| 131 | + | AsyncFlow | [Async Hooks (API)][] | ? | Yes | 1 | | ||
| 132 | + | Debugger | V8 Debug protocol (API) | No | Yes | 1 | | ||
| 133 | + | Debugger | [Command line Debug Client][] | ? | Yes | 1 | | ||
| 134 | + | Tracing | [trace\_events (API)][trace_events (API)] | No | Yes | 1 | | ||
| 135 | + | Tracing | trace\_gc | No | Yes | 1 | | ||
| 136 | + | M/T | eBPF tracing tool | No | No | ? | | ||
| 137 | + | ||
| 138 | + [0x]: https://github.com/davidmarkclements/0x | ||
| 139 | + [Async Hooks (API)]: https://nodejs.org/api/async_hooks.html | ||
| 140 | + [Chrome Dev Tools]: https://developer.chrome.com/docs/devtools/ | ||
| 141 | + [Command line Debug Client]: https://nodejs.org/api/inspector.html | ||
| 142 | + [Linux perf]: https://perf.wiki.kernel.org/index.php/Main_Page | ||
| 143 | + [diagnostic report]: https://nodejs.org/api/report.html | ||
| 144 | + [node-clinic]: https://github.com/clinicjs/node-clinic/ | ||
| 145 | + [trace_events (API)]: https://nodejs.org/api/tracing.html | ||
0 commit comments