|
7 | 7 | [pprof][pprof-url] support for Node.js.
|
8 | 8 |
|
9 | 9 | ## Prerequisites
|
10 |
| -1. Your application will need to be using Node.js 10.4.1 or greater, or any |
11 |
| -version of Node 12 or 14. |
12 |
| - |
13 |
| -The profiler should not be enabled when using earlier versions of Node 10, |
14 |
| -since versions of Node.js 10 prior to 10.4.1 are impacted by |
15 |
| -[this](https://bugs.chromium.org/p/chromium/issues/detail?id=847863) issue, |
16 |
| -which can cause garbage collection to take several minutes when heap profiling |
17 |
| -is enabled. |
| 10 | +1. Your application will need to be using Node.js 14 or greater. This package is tested against |
| 11 | +[current versions of Node.js][node-versions]: 14, 16, 18, and 19. |
18 | 12 |
|
19 | 13 | 2. The `pprof` module has a native component that is used to collect profiles
|
20 | 14 | with v8's CPU and Heap profilers. You may need to install additional
|
21 | 15 | dependencies to build this module.
|
22 | 16 | * For Linux: `pprof` has prebuilt binaries available for Linux and Alpine
|
23 |
| - Linux for Node 10, 12 and 14. No additional dependencies are required. |
| 17 | + Linux for Node 14 and 16. No additional dependencies are required. |
24 | 18 | * For other environments: when using `@google-cloud/profiler` on environments
|
25 | 19 | that `pprof` does not have prebuilt binaries for, the module
|
26 | 20 | [`node-gyp`](https://www.npmjs.com/package/node-gyp) will be used to
|
@@ -111,9 +105,10 @@ Install [`pprof`][npm-url] with `npm` or add to your `package.json`.
|
111 | 105 | [circle-image]: https://circleci.com/gh/google/pprof-nodejs.svg?style=svg
|
112 | 106 | [circle-url]: https://circleci.com/gh/google/pprof-nodejs
|
113 | 107 | [coveralls-image]: https://coveralls.io/repos/google/pprof-nodejs/badge.svg?branch=main&service=github
|
| 108 | +[node-versions]: https://github.com/nodejs/Release#release-schedule |
114 | 109 | [npm-image]: https://badge.fury.io/js/pprof.svg
|
115 | 110 | [npm-url]: https://npmjs.org/package/pprof
|
116 |
| -[pprof-url]: https://github.com/google/pprof |
117 | 111 | [pprof-install-url]: https://github.com/google/pprof#building-pprof
|
| 112 | +[pprof-url]: https://github.com/google/pprof |
118 | 113 | [snyk-image]: https://snyk.io/test/github/google/pprof-nodejs/badge.svg
|
119 | 114 | [snyk-url]: https://snyk.io/test/github/google/pprof-nodejs
|
0 commit comments