@ohos-ports/datadog-pprof 5.17.0-1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +202 -0
- package/README.md +112 -0
- package/out/src/heap-profiler-bindings.d.ts +22 -0
- package/out/src/heap-profiler-bindings.js +75 -0
- package/out/src/heap-profiler-bindings.js.map +1 -0
- package/out/src/heap-profiler.d.ts +98 -0
- package/out/src/heap-profiler.js +219 -0
- package/out/src/heap-profiler.js.map +1 -0
- package/out/src/index.d.ts +46 -0
- package/out/src/index.js +111 -0
- package/out/src/index.js.map +1 -0
- package/out/src/logger.d.ts +18 -0
- package/out/src/logger.js +36 -0
- package/out/src/logger.js.map +1 -0
- package/out/src/otel-thread-ctx.d.ts +85 -0
- package/out/src/otel-thread-ctx.js +176 -0
- package/out/src/otel-thread-ctx.js.map +1 -0
- package/out/src/profile-encoder.d.ts +18 -0
- package/out/src/profile-encoder.js +29 -0
- package/out/src/profile-encoder.js.map +1 -0
- package/out/src/profile-serializer.d.ts +56 -0
- package/out/src/profile-serializer.js +509 -0
- package/out/src/profile-serializer.js.map +1 -0
- package/out/src/sourcemapper/sourcemapper.d.ts +123 -0
- package/out/src/sourcemapper/sourcemapper.js +528 -0
- package/out/src/sourcemapper/sourcemapper.js.map +1 -0
- package/out/src/time-profiler-bindings.d.ts +3 -0
- package/out/src/time-profiler-bindings.js +25 -0
- package/out/src/time-profiler-bindings.js.map +1 -0
- package/out/src/time-profiler.d.ts +72 -0
- package/out/src/time-profiler.js +202 -0
- package/out/src/time-profiler.js.map +1 -0
- package/out/src/v8-types.d.ts +82 -0
- package/out/src/v8-types.js +18 -0
- package/out/src/v8-types.js.map +1 -0
- package/package.json +112 -0
- package/prebuilds/darwin-arm64/dd_pprof.node.abi108.node +0 -0
- package/prebuilds/darwin-arm64/dd_pprof.node.abi111.node +0 -0
- package/prebuilds/darwin-arm64/dd_pprof.node.abi115.node +0 -0
- package/prebuilds/darwin-arm64/dd_pprof.node.abi120.node +0 -0
- package/prebuilds/darwin-arm64/dd_pprof.node.abi127.node +0 -0
- package/prebuilds/darwin-arm64/dd_pprof.node.abi131.node +0 -0
- package/prebuilds/darwin-arm64/dd_pprof.node.abi137.node +0 -0
- package/prebuilds/darwin-arm64/dd_pprof.node.abi141.node +0 -0
- package/prebuilds/darwin-arm64/dd_pprof.node.abi147.node +0 -0
- package/prebuilds/darwin-x64/dd_pprof.node.abi108.node +0 -0
- package/prebuilds/darwin-x64/dd_pprof.node.abi111.node +0 -0
- package/prebuilds/darwin-x64/dd_pprof.node.abi115.node +0 -0
- package/prebuilds/darwin-x64/dd_pprof.node.abi120.node +0 -0
- package/prebuilds/darwin-x64/dd_pprof.node.abi127.node +0 -0
- package/prebuilds/darwin-x64/dd_pprof.node.abi131.node +0 -0
- package/prebuilds/darwin-x64/dd_pprof.node.abi137.node +0 -0
- package/prebuilds/darwin-x64/dd_pprof.node.abi141.node +0 -0
- package/prebuilds/darwin-x64/dd_pprof.node.abi147.node +0 -0
- package/prebuilds/linux-arm64/dd_pprof.musl.node.abi108.node +0 -0
- package/prebuilds/linux-arm64/dd_pprof.musl.node.abi111.node +0 -0
- package/prebuilds/linux-arm64/dd_pprof.musl.node.abi115.node +0 -0
- package/prebuilds/linux-arm64/dd_pprof.musl.node.abi120.node +0 -0
- package/prebuilds/linux-arm64/dd_pprof.musl.node.abi127.node +0 -0
- package/prebuilds/linux-arm64/dd_pprof.musl.node.abi131.node +0 -0
- package/prebuilds/linux-arm64/dd_pprof.musl.node.abi137.node +0 -0
- package/prebuilds/linux-arm64/dd_pprof.musl.node.abi141.node +0 -0
- package/prebuilds/linux-arm64/dd_pprof.musl.node.abi147.node +0 -0
- package/prebuilds/linux-arm64/dd_pprof.node.abi108.node +0 -0
- package/prebuilds/linux-arm64/dd_pprof.node.abi111.node +0 -0
- package/prebuilds/linux-arm64/dd_pprof.node.abi115.node +0 -0
- package/prebuilds/linux-arm64/dd_pprof.node.abi120.node +0 -0
- package/prebuilds/linux-arm64/dd_pprof.node.abi127.node +0 -0
- package/prebuilds/linux-arm64/dd_pprof.node.abi131.node +0 -0
- package/prebuilds/linux-arm64/dd_pprof.node.abi137.node +0 -0
- package/prebuilds/linux-arm64/dd_pprof.node.abi141.node +0 -0
- package/prebuilds/linux-arm64/dd_pprof.node.abi147.node +0 -0
- package/prebuilds/linux-x64/dd_pprof.musl.node.abi108.node +0 -0
- package/prebuilds/linux-x64/dd_pprof.musl.node.abi111.node +0 -0
- package/prebuilds/linux-x64/dd_pprof.musl.node.abi115.node +0 -0
- package/prebuilds/linux-x64/dd_pprof.musl.node.abi120.node +0 -0
- package/prebuilds/linux-x64/dd_pprof.musl.node.abi127.node +0 -0
- package/prebuilds/linux-x64/dd_pprof.musl.node.abi131.node +0 -0
- package/prebuilds/linux-x64/dd_pprof.musl.node.abi137.node +0 -0
- package/prebuilds/linux-x64/dd_pprof.musl.node.abi141.node +0 -0
- package/prebuilds/linux-x64/dd_pprof.musl.node.abi147.node +0 -0
- package/prebuilds/linux-x64/dd_pprof.node.abi108.node +0 -0
- package/prebuilds/linux-x64/dd_pprof.node.abi111.node +0 -0
- package/prebuilds/linux-x64/dd_pprof.node.abi115.node +0 -0
- package/prebuilds/linux-x64/dd_pprof.node.abi120.node +0 -0
- package/prebuilds/linux-x64/dd_pprof.node.abi127.node +0 -0
- package/prebuilds/linux-x64/dd_pprof.node.abi131.node +0 -0
- package/prebuilds/linux-x64/dd_pprof.node.abi137.node +0 -0
- package/prebuilds/linux-x64/dd_pprof.node.abi141.node +0 -0
- package/prebuilds/linux-x64/dd_pprof.node.abi147.node +0 -0
- package/prebuilds/openharmony-arm64/dd_pprof.node.abi147.node +0 -0
- package/prebuilds/win32-x64/dd_pprof.node.abi108.node +0 -0
- package/prebuilds/win32-x64/dd_pprof.node.abi111.node +0 -0
- package/prebuilds/win32-x64/dd_pprof.node.abi115.node +0 -0
- package/prebuilds/win32-x64/dd_pprof.node.abi120.node +0 -0
- package/prebuilds/win32-x64/dd_pprof.node.abi127.node +0 -0
- package/prebuilds/win32-x64/dd_pprof.node.abi131.node +0 -0
- package/prebuilds/win32-x64/dd_pprof.node.abi137.node +0 -0
- package/prebuilds/win32-x64/dd_pprof.node.abi141.node +0 -0
- package/prebuilds/win32-x64/dd_pprof.node.abi147.node +0 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
# pprof support for Node.js
|
|
2
|
+
|
|
3
|
+
[![NPM Version][npm-image]][npm-url]
|
|
4
|
+
[![Build Status][build-image]][build-url]
|
|
5
|
+
[![Known Vulnerabilities][snyk-image]][snyk-url]
|
|
6
|
+
|
|
7
|
+
[pprof][pprof-url] support for Node.js.
|
|
8
|
+
|
|
9
|
+
## Prerequisites
|
|
10
|
+
1. Your application will need to be using Node.js 18 or greater.
|
|
11
|
+
|
|
12
|
+
2. The `pprof` module has a native component that is used to collect profiles
|
|
13
|
+
with v8's CPU and Heap profilers. You may need to install additional
|
|
14
|
+
dependencies to build this module.
|
|
15
|
+
* `pprof` has prebuilt binaries available for Linux arm64/x64,
|
|
16
|
+
Alpine Linux x64, macOS arm64/x64, and Windows x64 for Node 18/20/22/24/25.
|
|
17
|
+
No additional dependencies are required.
|
|
18
|
+
* For other environments: on environments that `pprof` does not have
|
|
19
|
+
prebuilt binaries for, the module
|
|
20
|
+
[`node-gyp`](https://www.npmjs.com/package/node-gyp) will be used to
|
|
21
|
+
build binaries. See `node-gyp`'s
|
|
22
|
+
[documentation](https://github.com/nodejs/node-gyp#installation)
|
|
23
|
+
for information on dependencies required to build binaries with `node-gyp`.
|
|
24
|
+
|
|
25
|
+
3. The [`pprof`][pprof-url] CLI can be used to view profiles collected with
|
|
26
|
+
this module. Instructions for installing the `pprof` CLI can be found
|
|
27
|
+
[here][pprof-install-url].
|
|
28
|
+
|
|
29
|
+
## Basic Set-up
|
|
30
|
+
|
|
31
|
+
Install [`pprof`][npm-url] with `npm` or add to your `package.json`.
|
|
32
|
+
```sh
|
|
33
|
+
# Install through npm while saving to the local 'package.json'
|
|
34
|
+
npm install --save @datadog/pprof
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Using the Profiler
|
|
38
|
+
|
|
39
|
+
### Collect a Wall Time Profile
|
|
40
|
+
|
|
41
|
+
#### In code:
|
|
42
|
+
1. Update code to collect and save a profile:
|
|
43
|
+
```javascript
|
|
44
|
+
const profile = await pprof.time.profile({
|
|
45
|
+
durationMillis: 10000, // time in milliseconds for which to
|
|
46
|
+
// collect profile.
|
|
47
|
+
});
|
|
48
|
+
const buf = await pprof.encode(profile);
|
|
49
|
+
fs.writeFile('wall.pb.gz', buf, (err) => {
|
|
50
|
+
if (err) throw err;
|
|
51
|
+
});
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
2. View the profile with command line [`pprof`][pprof-url]:
|
|
55
|
+
```sh
|
|
56
|
+
pprof -http=: wall.pb.gz
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
#### Requiring from the command line
|
|
60
|
+
|
|
61
|
+
1. Start program from the command line:
|
|
62
|
+
```sh
|
|
63
|
+
node --require @datadog/pprof app.js
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
2. A wall time profile for the job will be saved in
|
|
67
|
+
`pprof-profile-${process.pid}.pb.gz`. View the profile with command line
|
|
68
|
+
[`pprof`][pprof-url]:
|
|
69
|
+
```sh
|
|
70
|
+
pprof -http=: pprof-profile-${process.pid}.pb.gz
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
### Collect a Heap Profile
|
|
74
|
+
1. Enable heap profiling at the start of the application:
|
|
75
|
+
```javascript
|
|
76
|
+
// The average number of bytes between samples.
|
|
77
|
+
const intervalBytes = 512 * 1024;
|
|
78
|
+
|
|
79
|
+
// The maximum stack depth for samples collected.
|
|
80
|
+
const stackDepth = 64;
|
|
81
|
+
|
|
82
|
+
heap.start(intervalBytes, stackDepth);
|
|
83
|
+
```
|
|
84
|
+
2. Collect heap profiles:
|
|
85
|
+
|
|
86
|
+
* Collecting and saving a profile in profile.proto format:
|
|
87
|
+
```javascript
|
|
88
|
+
const profile = await pprof.heap.profile();
|
|
89
|
+
const buf = await pprof.encode(profile);
|
|
90
|
+
fs.writeFile('heap.pb.gz', buf, (err) => {
|
|
91
|
+
if (err) throw err;
|
|
92
|
+
})
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
* View the profile with command line [`pprof`][pprof-url].
|
|
96
|
+
```sh
|
|
97
|
+
pprof -http=: heap.pb.gz
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
* Collecting a heap profile with V8 allocation profile format:
|
|
101
|
+
```javascript
|
|
102
|
+
const profile = await pprof.heap.v8Profile();
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
[build-image]: https://github.com/Datadog/pprof-nodejs/actions/workflows/build.yml/badge.svg?branch=main
|
|
106
|
+
[build-url]: https://github.com/Datadog/pprof-nodejs/actions/workflows/build.yml
|
|
107
|
+
[npm-image]: https://badge.fury.io/js/@datadog%2Fpprof.svg
|
|
108
|
+
[npm-url]: https://npmjs.org/package/@datadog/pprof
|
|
109
|
+
[pprof-url]: https://github.com/google/pprof
|
|
110
|
+
[pprof-install-url]: https://github.com/google/pprof#building-pprof
|
|
111
|
+
[snyk-image]: https://snyk.io/test/github/Datadog/pprof-nodejs/badge.svg
|
|
112
|
+
[snyk-url]: https://snyk.io/test/github/Datadog/pprof-nodejs
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright 2018 Google Inc. All Rights Reserved.
|
|
3
|
+
*
|
|
4
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
* you may not use this file except in compliance with the License.
|
|
6
|
+
* You may obtain a copy of the License at
|
|
7
|
+
*
|
|
8
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
*
|
|
10
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
* See the License for the specific language governing permissions and
|
|
14
|
+
* limitations under the License.
|
|
15
|
+
*/
|
|
16
|
+
import { AllocationProfileNode, AllocationProfileNodeWithStats } from './v8-types';
|
|
17
|
+
export declare function startSamplingHeapProfiler(heapIntervalBytes: number, heapStackDepth: number, allocations?: boolean): void;
|
|
18
|
+
export declare function stopSamplingHeapProfiler(): void;
|
|
19
|
+
export declare function getAllocationProfile(): AllocationProfileNode | AllocationProfileNodeWithStats;
|
|
20
|
+
export declare function mapAllocationProfile<T>(callback: (root: AllocationProfileNode) => T): T;
|
|
21
|
+
export type NearHeapLimitCallback = (profile: AllocationProfileNode) => void;
|
|
22
|
+
export declare function monitorOutOfMemory(heapLimitExtensionSize: number, maxHeapLimitExtensionCount: number, dumpHeapProfileOnSdterr: boolean, exportCommand: Array<string> | undefined, callback: NearHeapLimitCallback | undefined, callbackMode: number, isMainThread: boolean): void;
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* Copyright 2018 Google Inc. All Rights Reserved.
|
|
4
|
+
*
|
|
5
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
* you may not use this file except in compliance with the License.
|
|
7
|
+
* You may obtain a copy of the License at
|
|
8
|
+
*
|
|
9
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
*
|
|
11
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
* See the License for the specific language governing permissions and
|
|
15
|
+
* limitations under the License.
|
|
16
|
+
*/
|
|
17
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
18
|
+
if (k2 === undefined) k2 = k;
|
|
19
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
20
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
21
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
22
|
+
}
|
|
23
|
+
Object.defineProperty(o, k2, desc);
|
|
24
|
+
}) : (function(o, m, k, k2) {
|
|
25
|
+
if (k2 === undefined) k2 = k;
|
|
26
|
+
o[k2] = m[k];
|
|
27
|
+
}));
|
|
28
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
29
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
30
|
+
}) : function(o, v) {
|
|
31
|
+
o["default"] = v;
|
|
32
|
+
});
|
|
33
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
34
|
+
var ownKeys = function(o) {
|
|
35
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
36
|
+
var ar = [];
|
|
37
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
38
|
+
return ar;
|
|
39
|
+
};
|
|
40
|
+
return ownKeys(o);
|
|
41
|
+
};
|
|
42
|
+
return function (mod) {
|
|
43
|
+
if (mod && mod.__esModule) return mod;
|
|
44
|
+
var result = {};
|
|
45
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
46
|
+
__setModuleDefault(result, mod);
|
|
47
|
+
return result;
|
|
48
|
+
};
|
|
49
|
+
})();
|
|
50
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
51
|
+
exports.startSamplingHeapProfiler = startSamplingHeapProfiler;
|
|
52
|
+
exports.stopSamplingHeapProfiler = stopSamplingHeapProfiler;
|
|
53
|
+
exports.getAllocationProfile = getAllocationProfile;
|
|
54
|
+
exports.mapAllocationProfile = mapAllocationProfile;
|
|
55
|
+
exports.monitorOutOfMemory = monitorOutOfMemory;
|
|
56
|
+
const path = __importStar(require("path"));
|
|
57
|
+
const findBinding = require('node-gyp-build');
|
|
58
|
+
const profiler = findBinding(path.join(__dirname, '..', '..'));
|
|
59
|
+
// Wrappers around native heap profiler functions.
|
|
60
|
+
function startSamplingHeapProfiler(heapIntervalBytes, heapStackDepth, allocations = false) {
|
|
61
|
+
profiler.heapProfiler.startSamplingHeapProfiler(heapIntervalBytes, heapStackDepth, allocations);
|
|
62
|
+
}
|
|
63
|
+
function stopSamplingHeapProfiler() {
|
|
64
|
+
profiler.heapProfiler.stopSamplingHeapProfiler();
|
|
65
|
+
}
|
|
66
|
+
function getAllocationProfile() {
|
|
67
|
+
return profiler.heapProfiler.getAllocationProfile();
|
|
68
|
+
}
|
|
69
|
+
function mapAllocationProfile(callback) {
|
|
70
|
+
return profiler.heapProfiler.mapAllocationProfile(callback);
|
|
71
|
+
}
|
|
72
|
+
function monitorOutOfMemory(heapLimitExtensionSize, maxHeapLimitExtensionCount, dumpHeapProfileOnSdterr, exportCommand, callback, callbackMode, isMainThread) {
|
|
73
|
+
profiler.heapProfiler.monitorOutOfMemory(heapLimitExtensionSize, maxHeapLimitExtensionCount, dumpHeapProfileOnSdterr, exportCommand, callback, callbackMode, isMainThread);
|
|
74
|
+
}
|
|
75
|
+
//# sourceMappingURL=heap-profiler-bindings.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"heap-profiler-bindings.js","sourceRoot":"","sources":["../../ts/src/heap-profiler-bindings.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAcH,8DAUC;AAED,4DAEC;AAED,oDAIC;AAED,oDAIC;AAID,gDAkBC;AA5DD,2CAA6B;AAO7B,MAAM,WAAW,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;AAC9C,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;AAE/D,kDAAkD;AAElD,SAAgB,yBAAyB,CACvC,iBAAyB,EACzB,cAAsB,EACtB,WAAW,GAAG,KAAK;IAEnB,QAAQ,CAAC,YAAY,CAAC,yBAAyB,CAC7C,iBAAiB,EACjB,cAAc,EACd,WAAW,CACZ,CAAC;AACJ,CAAC;AAED,SAAgB,wBAAwB;IACtC,QAAQ,CAAC,YAAY,CAAC,wBAAwB,EAAE,CAAC;AACnD,CAAC;AAED,SAAgB,oBAAoB;IAGlC,OAAO,QAAQ,CAAC,YAAY,CAAC,oBAAoB,EAAE,CAAC;AACtD,CAAC;AAED,SAAgB,oBAAoB,CAClC,QAA4C;IAE5C,OAAO,QAAQ,CAAC,YAAY,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;AAC9D,CAAC;AAID,SAAgB,kBAAkB,CAChC,sBAA8B,EAC9B,0BAAkC,EAClC,uBAAgC,EAChC,aAAwC,EACxC,QAA2C,EAC3C,YAAoB,EACpB,YAAqB;IAErB,QAAQ,CAAC,YAAY,CAAC,kBAAkB,CACtC,sBAAsB,EACtB,0BAA0B,EAC1B,uBAAuB,EACvB,aAAa,EACb,QAAQ,EACR,YAAY,EACZ,YAAY,CACb,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright 2017 Google Inc. All Rights Reserved.
|
|
3
|
+
*
|
|
4
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
* you may not use this file except in compliance with the License.
|
|
6
|
+
* You may obtain a copy of the License at
|
|
7
|
+
*
|
|
8
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
*
|
|
10
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
* See the License for the specific language governing permissions and
|
|
14
|
+
* limitations under the License.
|
|
15
|
+
*/
|
|
16
|
+
import { Profile } from 'pprof-format';
|
|
17
|
+
import { ColumnNumbers } from './profile-serializer';
|
|
18
|
+
import { SourceMapper } from './sourcemapper/sourcemapper';
|
|
19
|
+
import { AllocationProfileNode, AllocationProfileNodeWithStats, GenerateAllocationLabelsFunction } from './v8-types';
|
|
20
|
+
export declare function v8Profile(): AllocationProfileNode | AllocationProfileNodeWithStats;
|
|
21
|
+
/**
|
|
22
|
+
* Map the heap profile to a converted profile using callback function when
|
|
23
|
+
* heapProfiler is enabled. Otherwise throws an error.
|
|
24
|
+
*
|
|
25
|
+
* WARNING: Nodes in the tree are only valid during the callback. Do not store
|
|
26
|
+
* references to them. The memory is freed when the callback returns.
|
|
27
|
+
*
|
|
28
|
+
* @param callback - function to convert the heap profile to a converted
|
|
29
|
+
|file
|
|
30
|
+
* @returns <T> converted profile
|
|
31
|
+
*/
|
|
32
|
+
export declare function v8ProfileV2<T>(callback: (root: AllocationProfileNode) => T): T;
|
|
33
|
+
/**
|
|
34
|
+
* Collects a profile and returns it serialized in pprof format.
|
|
35
|
+
* Throws if heap profiler is not enabled.
|
|
36
|
+
*
|
|
37
|
+
* @param ignoreSamplePath
|
|
38
|
+
* @param sourceMapper
|
|
39
|
+
*/
|
|
40
|
+
export declare function profile(ignoreSamplePath?: string, sourceMapper?: SourceMapper, generateLabels?: GenerateAllocationLabelsFunction, columnNumbers?: ColumnNumbers): Profile;
|
|
41
|
+
export declare function convertProfile(rootNode: AllocationProfileNode | AllocationProfileNodeWithStats, ignoreSamplePath?: string, sourceMapper?: SourceMapper, generateLabels?: GenerateAllocationLabelsFunction, columnNumbers?: ColumnNumbers): Profile;
|
|
42
|
+
/**
|
|
43
|
+
* Collects a profile and returns it serialized in pprof format using lazy V2 API.
|
|
44
|
+
* Throws if heap profiler is not enabled.
|
|
45
|
+
*
|
|
46
|
+
* @param ignoreSamplePath
|
|
47
|
+
* @param sourceMapper
|
|
48
|
+
* @param generateLabels
|
|
49
|
+
*/
|
|
50
|
+
export declare function profileV2(ignoreSamplePath?: string, sourceMapper?: SourceMapper, generateLabels?: GenerateAllocationLabelsFunction, columnNumbers?: ColumnNumbers): Profile;
|
|
51
|
+
/**
|
|
52
|
+
* Starts heap profiling. If heap profiling has already been started with
|
|
53
|
+
* the same parameters, this is a noop. If heap profiler has already been
|
|
54
|
+
* started with different parameters, this throws an error.
|
|
55
|
+
*
|
|
56
|
+
* @param intervalBytes - average number of bytes between samples.
|
|
57
|
+
* @param stackDepth - maximum stack depth for samples collected.
|
|
58
|
+
* @param allocations - include total allocation samples in the profile.
|
|
59
|
+
* When true, each call to `profile()` forces a full GC (via
|
|
60
|
+
* v8::HeapProfiler::kSamplingForceGC) to classify sampled objects as
|
|
61
|
+
* live/dead, which adds a measurable pause. Requires Node.js >= 26.
|
|
62
|
+
*/
|
|
63
|
+
export declare function start(intervalBytes: number, stackDepth: number, allocations?: boolean): void;
|
|
64
|
+
export declare function stop(): void;
|
|
65
|
+
export type NearHeapLimitCallback = (profile: Profile) => void;
|
|
66
|
+
export declare const CallbackMode: {
|
|
67
|
+
Async: number;
|
|
68
|
+
Interrupt: number;
|
|
69
|
+
Both: number;
|
|
70
|
+
};
|
|
71
|
+
/**
|
|
72
|
+
* Add monitoring for v8 heap, heap profiler must already be started.
|
|
73
|
+
* When an out of heap memory event occurs:
|
|
74
|
+
* - an extension of heap memory of |heapLimitExtensionSize| bytes is
|
|
75
|
+
* requested to v8. This extension can occur |maxHeapLimitExtensionCount|
|
|
76
|
+
* number of times. If the extension amount is not enough to satisfy
|
|
77
|
+
* memory allocation that triggers GC and OOM, process will abort.
|
|
78
|
+
* - heap profile is dumped as folded stacks on stderr if
|
|
79
|
+
* |dumpHeapProfileOnSdterr| is true
|
|
80
|
+
* - heap profile is dumped in temporary file and a new process is spawned
|
|
81
|
+
* with |exportCommand| arguments and profile path appended at the end.
|
|
82
|
+
* - |callback| is called. Callback can be invoked only if
|
|
83
|
+
* heapLimitExtensionSize is enough for the process to continue. Invocation
|
|
84
|
+
* will be done by a RequestInterrupt if |callbackMode| is Interrupt or Both,
|
|
85
|
+
* this might be unsafe since Isolate should not be reentered
|
|
86
|
+
* from RequestInterrupt, but this allows to interrupt synchronous code.
|
|
87
|
+
* Otherwise the callback is scheduled to be called asynchronously.
|
|
88
|
+
* @param heapLimitExtensionSize - amount of bytes heap should be expanded
|
|
89
|
+
* with upon OOM
|
|
90
|
+
* @param maxHeapLimitExtensionCount - maximum number of times heap size
|
|
91
|
+
* extension can occur
|
|
92
|
+
* @param dumpHeapProfileOnSdterr - dump heap profile on stderr upon OOM
|
|
93
|
+
* @param exportCommand - command to execute upon OOM, filepath of a
|
|
94
|
+
* temporary file containing heap profile will be appended
|
|
95
|
+
* @param callback - callback to call when OOM occurs
|
|
96
|
+
* @param callbackMode
|
|
97
|
+
*/
|
|
98
|
+
export declare function monitorOutOfMemory(heapLimitExtensionSize: number, maxHeapLimitExtensionCount: number, dumpHeapProfileOnSdterr: boolean, exportCommand?: Array<string>, callback?: NearHeapLimitCallback, callbackMode?: number): void;
|