profiler-md 0.4.0 → 0.5.0
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/dist/cli/index.mjs +3327 -720
- package/dist/index.d.mts +596 -25
- package/dist/index.js +2 -2
- package/docs/formats/jfr.md +16 -0
- package/docs/formats/jsc-heap-snapshot.md +2 -2
- package/docs/languages/c.md +31 -7
- package/docs/languages/cpp.md +31 -7
- package/docs/languages/csharp.md +3 -0
- package/docs/languages/elixir.md +8 -4
- package/docs/languages/erlang.md +8 -4
- package/docs/languages/fsharp.md +3 -0
- package/docs/languages/go.md +11 -6
- package/docs/languages/java.md +109 -59
- package/docs/languages/javascript.md +34 -12
- package/docs/languages/julia.md +14 -2
- package/docs/languages/kotlin.md +109 -59
- package/docs/languages/php.md +64 -20
- package/docs/languages/python.md +11 -72
- package/docs/languages/ruby.md +17 -27
- package/docs/languages/typescript.md +34 -12
- package/examples/output/c.gperftools.cpu.base.pprof.md +324 -0
- package/examples/output/c.gperftools.cpu.current.pprof.md +271 -0
- package/examples/output/c.gperftools.cpu.diff.pprof.md +98 -0
- package/examples/output/c.gperftools.heap.base.pprof.md +362 -0
- package/examples/output/c.gperftools.heap.current.pprof.md +362 -0
- package/examples/output/c.gperftools.heap.diff.pprof.md +28 -0
- package/examples/output/cpp.gperftools.cpu.base.pprof.md +557 -0
- package/examples/output/cpp.gperftools.cpu.current.pprof.md +573 -0
- package/examples/output/cpp.gperftools.cpu.diff.pprof.md +122 -0
- package/examples/output/cpp.gperftools.heap.base.pprof.md +67 -0
- package/examples/output/cpp.gperftools.heap.current.pprof.md +67 -0
- package/examples/output/cpp.gperftools.heap.diff.pprof.md +19 -0
- package/examples/output/csharp.dotnet-trace.base.speedscope.json.md +411 -0
- package/examples/output/csharp.dotnet-trace.current.speedscope.json.md +412 -0
- package/examples/output/csharp.dotnet-trace.diff.speedscope.json.md +122 -0
- package/examples/output/elixir.eflambe.cpu.base.collapsed.md +399 -0
- package/examples/output/elixir.eflambe.cpu.current.collapsed.md +398 -0
- package/examples/output/elixir.eflambe.cpu.diff.collapsed.md +92 -0
- package/examples/output/erlang.eflambe.cpu.base.collapsed.md +147 -0
- package/examples/output/erlang.eflambe.cpu.current.collapsed.md +147 -0
- package/examples/output/erlang.eflambe.cpu.diff.collapsed.md +18 -0
- package/examples/output/fsharp.dotnet-trace.base.speedscope.json.md +324 -0
- package/examples/output/fsharp.dotnet-trace.current.speedscope.json.md +314 -0
- package/examples/output/fsharp.dotnet-trace.diff.speedscope.json.md +119 -0
- package/examples/output/go.pprof.block.base.pprof.md +86 -0
- package/examples/output/go.pprof.block.current.pprof.md +83 -0
- package/examples/output/go.pprof.block.diff.pprof.md +42 -0
- package/examples/output/go.pprof.cpu.base.pprof.md +81 -0
- package/examples/output/go.pprof.cpu.current.pprof.md +70 -0
- package/examples/output/go.pprof.cpu.diff.pprof.md +52 -0
- package/examples/output/go.pprof.goroutine.base.pprof.md +43 -0
- package/examples/output/go.pprof.goroutine.current.pprof.md +43 -0
- package/examples/output/go.pprof.goroutine.diff.pprof.md +13 -0
- package/examples/output/go.pprof.heap-alloc.base.pprof.md +154 -0
- package/examples/output/go.pprof.heap-alloc.current.pprof.md +146 -0
- package/examples/output/go.pprof.heap-alloc.diff.pprof.md +67 -0
- package/examples/output/go.pprof.heap.base.pprof.md +154 -0
- package/examples/output/go.pprof.heap.current.pprof.md +146 -0
- package/examples/output/go.pprof.heap.diff.pprof.md +67 -0
- package/examples/output/go.pprof.mutex.base.pprof.md +55 -0
- package/examples/output/go.pprof.mutex.current.pprof.md +41 -0
- package/examples/output/go.pprof.mutex.diff.pprof.md +31 -0
- package/examples/output/go.pprof.threadcreate.base.pprof.md +55 -0
- package/examples/output/go.pprof.threadcreate.current.pprof.md +55 -0
- package/examples/output/go.pprof.threadcreate.diff.pprof.md +19 -0
- package/examples/output/java.async-profiler.all.base.jfr.md +1071 -0
- package/examples/output/java.async-profiler.all.current.jfr.md +1007 -0
- package/examples/output/java.async-profiler.all.diff.jfr.md +268 -0
- package/examples/output/java.async-profiler.alloc.base.jfr.md +425 -0
- package/examples/output/java.async-profiler.alloc.current.jfr.md +413 -0
- package/examples/output/java.async-profiler.alloc.diff.jfr.md +99 -0
- package/examples/output/java.async-profiler.cpu.base.collapsed.md +367 -0
- package/examples/output/java.async-profiler.cpu.base.jfr.md +485 -0
- package/examples/output/java.async-profiler.cpu.current.collapsed.md +355 -0
- package/examples/output/java.async-profiler.cpu.current.jfr.md +488 -0
- package/examples/output/java.async-profiler.cpu.diff.collapsed.md +117 -0
- package/examples/output/java.async-profiler.cpu.diff.jfr.md +118 -0
- package/examples/output/java.async-profiler.live.base.jfr.md +697 -0
- package/examples/output/java.async-profiler.live.current.jfr.md +684 -0
- package/examples/output/java.async-profiler.live.diff.jfr.md +191 -0
- package/examples/output/java.async-profiler.lock.base.jfr.md +140 -0
- package/examples/output/java.async-profiler.lock.current.jfr.md +108 -0
- package/examples/output/java.async-profiler.lock.diff.jfr.md +44 -0
- package/examples/output/java.async-profiler.nativemem.base.jfr.md +222 -0
- package/examples/output/java.async-profiler.nativemem.current.jfr.md +222 -0
- package/examples/output/java.async-profiler.nativemem.diff.jfr.md +65 -0
- package/examples/output/java.async-profiler.wall.base.jfr.md +400 -0
- package/examples/output/java.async-profiler.wall.current.jfr.md +420 -0
- package/examples/output/java.async-profiler.wall.diff.jfr.md +94 -0
- package/examples/output/java.jdk.all.base.jfr.md +1024 -0
- package/examples/output/java.jdk.all.current.jfr.md +1010 -0
- package/examples/output/java.jdk.all.diff.jfr.md +311 -0
- package/examples/output/java.jdk.alloc.base.jfr.md +1024 -0
- package/examples/output/java.jdk.alloc.current.jfr.md +1046 -0
- package/examples/output/java.jdk.alloc.diff.jfr.md +312 -0
- package/examples/output/java.jdk.cpu.base.jfr.md +1023 -0
- package/examples/output/java.jdk.cpu.current.jfr.md +1039 -0
- package/examples/output/java.jdk.cpu.diff.jfr.md +285 -0
- package/examples/output/java.jdk.live.base.jfr.md +1029 -0
- package/examples/output/java.jdk.live.current.jfr.md +1035 -0
- package/examples/output/java.jdk.live.diff.jfr.md +289 -0
- package/examples/output/java.jdk.lock.base.jfr.md +1040 -0
- package/examples/output/java.jdk.lock.current.jfr.md +1051 -0
- package/examples/output/java.jdk.lock.diff.jfr.md +339 -0
- package/examples/output/javascript.bun.base.cpuprofile.md +73 -0
- package/examples/output/javascript.bun.base.heapsnapshot.md +608 -0
- package/examples/output/javascript.bun.base.jsc-heap-snapshot.json.md +480 -0
- package/examples/output/javascript.bun.current.cpuprofile.md +73 -0
- package/examples/output/javascript.bun.current.heapsnapshot.md +608 -0
- package/examples/output/javascript.bun.current.jsc-heap-snapshot.json.md +480 -0
- package/examples/output/javascript.bun.diff.cpuprofile.md +54 -0
- package/examples/output/javascript.bun.diff.heapsnapshot.md +48 -0
- package/examples/output/javascript.bun.diff.jsc-heap-snapshot.json.md +62 -0
- package/examples/output/javascript.chrome.base.cpuprofile.md +163 -0
- package/examples/output/javascript.chrome.base.heapprofile.md +32 -0
- package/examples/output/javascript.chrome.base.heapsnapshot.md +649 -0
- package/examples/output/javascript.chrome.current.cpuprofile.md +149 -0
- package/examples/output/javascript.chrome.current.heapprofile.md +32 -0
- package/examples/output/javascript.chrome.current.heapsnapshot.md +647 -0
- package/examples/output/javascript.chrome.diff.cpuprofile.md +65 -0
- package/examples/output/javascript.chrome.diff.heapprofile.md +50 -0
- package/examples/output/javascript.chrome.diff.heapsnapshot.md +73 -0
- package/examples/output/javascript.deno.base.cpuprofile.md +122 -0
- package/examples/output/javascript.deno.current.cpuprofile.md +114 -0
- package/examples/output/javascript.deno.diff.cpuprofile.md +66 -0
- package/examples/output/javascript.node.base.cpuprofile.md +136 -0
- package/examples/output/javascript.node.base.heapprofile.md +56 -0
- package/examples/output/javascript.node.base.heapsnapshot.md +660 -0
- package/examples/output/javascript.node.current.cpuprofile.md +119 -0
- package/examples/output/javascript.node.current.heapprofile.md +52 -0
- package/examples/output/javascript.node.current.heapsnapshot.md +660 -0
- package/examples/output/javascript.node.diff.cpuprofile.md +70 -0
- package/examples/output/javascript.node.diff.heapprofile.md +34 -0
- package/examples/output/javascript.node.diff.heapsnapshot.md +39 -0
- package/examples/output/javascript.pprof.cpu.base.pprof.md +104 -0
- package/examples/output/javascript.pprof.cpu.current.pprof.md +120 -0
- package/examples/output/javascript.pprof.cpu.diff.pprof.md +63 -0
- package/examples/output/javascript.pprof.heap.base.pprof.md +86 -0
- package/examples/output/javascript.pprof.heap.current.pprof.md +57 -0
- package/examples/output/javascript.pprof.heap.diff.pprof.md +42 -0
- package/examples/output/javascript.safari.base.webkit-timeline-recording.json.md +388 -0
- package/examples/output/javascript.safari.current.webkit-timeline-recording.json.md +378 -0
- package/examples/output/javascript.safari.diff.webkit-timeline-recording.json.md +122 -0
- package/examples/output/julia.pprof-jl.alloc.base.pprof.md +124 -0
- package/examples/output/julia.pprof-jl.alloc.current.pprof.md +126 -0
- package/examples/output/julia.pprof-jl.alloc.diff.pprof.md +30 -0
- package/examples/output/julia.pprof-jl.cpu.base.pprof.md +177 -0
- package/examples/output/julia.pprof-jl.cpu.current.pprof.md +179 -0
- package/examples/output/julia.pprof-jl.cpu.diff.pprof.md +64 -0
- package/examples/output/kotlin.async-profiler.all.base.jfr.md +920 -0
- package/examples/output/kotlin.async-profiler.all.current.jfr.md +925 -0
- package/examples/output/kotlin.async-profiler.all.diff.jfr.md +247 -0
- package/examples/output/kotlin.async-profiler.alloc.base.jfr.md +467 -0
- package/examples/output/kotlin.async-profiler.alloc.current.jfr.md +473 -0
- package/examples/output/kotlin.async-profiler.alloc.diff.jfr.md +122 -0
- package/examples/output/kotlin.async-profiler.cpu.base.collapsed.md +371 -0
- package/examples/output/kotlin.async-profiler.cpu.base.jfr.md +472 -0
- package/examples/output/kotlin.async-profiler.cpu.current.collapsed.md +370 -0
- package/examples/output/kotlin.async-profiler.cpu.current.jfr.md +445 -0
- package/examples/output/kotlin.async-profiler.cpu.diff.collapsed.md +124 -0
- package/examples/output/kotlin.async-profiler.cpu.diff.jfr.md +125 -0
- package/examples/output/kotlin.async-profiler.live.base.jfr.md +934 -0
- package/examples/output/kotlin.async-profiler.live.current.jfr.md +917 -0
- package/examples/output/kotlin.async-profiler.live.diff.jfr.md +245 -0
- package/examples/output/kotlin.async-profiler.lock.base.jfr.md +1 -0
- package/examples/output/kotlin.async-profiler.lock.current.jfr.md +1 -0
- package/examples/output/kotlin.async-profiler.lock.diff.jfr.md +1 -0
- package/examples/output/kotlin.async-profiler.nativemem.base.jfr.md +234 -0
- package/examples/output/kotlin.async-profiler.nativemem.current.jfr.md +234 -0
- package/examples/output/kotlin.async-profiler.nativemem.diff.jfr.md +65 -0
- package/examples/output/kotlin.async-profiler.wall.base.jfr.md +452 -0
- package/examples/output/kotlin.async-profiler.wall.current.jfr.md +457 -0
- package/examples/output/kotlin.async-profiler.wall.diff.jfr.md +125 -0
- package/examples/output/kotlin.jdk.all.base.jfr.md +1442 -0
- package/examples/output/kotlin.jdk.all.current.jfr.md +1343 -0
- package/examples/output/kotlin.jdk.all.diff.jfr.md +392 -0
- package/examples/output/kotlin.jdk.alloc.base.jfr.md +1418 -0
- package/examples/output/kotlin.jdk.alloc.current.jfr.md +1389 -0
- package/examples/output/kotlin.jdk.alloc.diff.jfr.md +383 -0
- package/examples/output/kotlin.jdk.cpu.base.jfr.md +1406 -0
- package/examples/output/kotlin.jdk.cpu.current.jfr.md +1374 -0
- package/examples/output/kotlin.jdk.cpu.diff.jfr.md +380 -0
- package/examples/output/kotlin.jdk.live.base.jfr.md +1378 -0
- package/examples/output/kotlin.jdk.live.current.jfr.md +1311 -0
- package/examples/output/kotlin.jdk.live.diff.jfr.md +381 -0
- package/examples/output/kotlin.jdk.lock.base.jfr.md +1427 -0
- package/examples/output/kotlin.jdk.lock.current.jfr.md +1374 -0
- package/examples/output/kotlin.jdk.lock.diff.jfr.md +386 -0
- package/examples/output/php.excimer.wall.base.speedscope.json.md +25 -0
- package/examples/output/php.excimer.wall.current.speedscope.json.md +25 -0
- package/examples/output/php.excimer.wall.diff.speedscope.json.md +29 -0
- package/examples/output/python.py-spy.cpu.base.collapsed.md +526 -0
- package/examples/output/python.py-spy.cpu.base.speedscope.json.md +37 -0
- package/examples/output/python.py-spy.cpu.current.collapsed.md +514 -0
- package/examples/output/python.py-spy.cpu.current.speedscope.json.md +37 -0
- package/examples/output/python.py-spy.cpu.diff.collapsed.md +122 -0
- package/examples/output/python.py-spy.cpu.diff.speedscope.json.md +31 -0
- package/examples/output/python.py-spy.wall.base.collapsed.md +527 -0
- package/examples/output/python.py-spy.wall.current.collapsed.md +518 -0
- package/examples/output/python.py-spy.wall.diff.collapsed.md +122 -0
- package/examples/output/ruby.rbspy.cpu.base.collapsed.md +90 -0
- package/examples/output/ruby.rbspy.cpu.base.pprof.md +105 -0
- package/examples/output/ruby.rbspy.cpu.base.speedscope.json.md +105 -0
- package/examples/output/ruby.rbspy.cpu.current.collapsed.md +90 -0
- package/examples/output/ruby.rbspy.cpu.current.pprof.md +115 -0
- package/examples/output/ruby.rbspy.cpu.current.speedscope.json.md +115 -0
- package/examples/output/ruby.rbspy.cpu.diff.collapsed.md +32 -0
- package/examples/output/ruby.rbspy.cpu.diff.pprof.md +44 -0
- package/examples/output/ruby.rbspy.cpu.diff.speedscope.json.md +44 -0
- package/examples/output/rust.pprof-rs.cpu.base.pprof.md +60 -0
- package/examples/output/rust.pprof-rs.cpu.current.pprof.md +60 -0
- package/examples/output/rust.pprof-rs.cpu.diff.pprof.md +24 -0
- package/package.json +7 -3
- package/readme.md +115 -27
- package/examples/bun.cpuprofile.md +0 -475
- package/examples/deno.cpuprofile.md +0 -481
- package/examples/jsc-heap-snapshot.base.json.md +0 -507
- package/examples/jsc-heap-snapshot.current.json.md +0 -504
- package/examples/jsc-heap-snapshot.diff.json.md +0 -119
- package/examples/node.base.cpuprofile.md +0 -451
- package/examples/node.current.cpuprofile.md +0 -449
- package/examples/node.diff.cpuprofile.md +0 -82
- package/examples/node.heapprofile.md +0 -281
- package/examples/node.heapsnapshot.md +0 -694
- package/examples/node.pprof.md +0 -441
- package/examples/python.base.collapsed.md +0 -116
- package/examples/python.current.collapsed.md +0 -125
- package/examples/python.diff.collapsed.md +0 -51
- package/examples/rust.base.pprof.md +0 -477
- package/examples/rust.current.pprof.md +0 -480
- package/examples/rust.diff.pprof.md +0 -117
- package/examples/webkit-timeline-recording.json.md +0 -434
package/dist/index.d.mts
CHANGED
|
@@ -22,6 +22,544 @@ type FileReference = {
|
|
|
22
22
|
type: `relative`;
|
|
23
23
|
path: string;
|
|
24
24
|
};
|
|
25
|
+
type SourceLocationInput = {
|
|
26
|
+
/** A string parseable into a {@link URL} or file path. */urlOrPath: string; /** The 1-based line number in the file at {@link urlOrPath}. */
|
|
27
|
+
line?: number; /** The 1-based column number in the file at {@link urlOrPath}. */
|
|
28
|
+
column?: number;
|
|
29
|
+
};
|
|
30
|
+
//#endregion
|
|
31
|
+
//#region src/profile/type.d.ts
|
|
32
|
+
/**
|
|
33
|
+
* A function occurrence at an executing position.
|
|
34
|
+
*
|
|
35
|
+
* Its {@link name} and {@link location} (the function's *definition* location)
|
|
36
|
+
* identify the function; frames sharing them are the same function.
|
|
37
|
+
*
|
|
38
|
+
* {@link line} is the *executing* line and feeds the per-line breakdown, not
|
|
39
|
+
* identity.
|
|
40
|
+
*
|
|
41
|
+
* A converter produces these raw (typically just a {@link name}); the resolved
|
|
42
|
+
* origin's `normalizeFrame` then splits out the location and line for variants
|
|
43
|
+
* that pack them into the frame string.
|
|
44
|
+
*/
|
|
45
|
+
type ProfileStackFrame = {
|
|
46
|
+
/** The function's name, if known. */name?: string; /** Where the function was defined, if known. */
|
|
47
|
+
location?: SourceLocationInput;
|
|
48
|
+
/**
|
|
49
|
+
* The 1-based line at which this frame was sampled, if known.
|
|
50
|
+
*
|
|
51
|
+
* Distinct from {@link location}'s line (the definition line): this is the
|
|
52
|
+
* executing line, which the aggregator forwards to the leaf function's
|
|
53
|
+
* per-line breakdown. Never a function-identity component.
|
|
54
|
+
*/
|
|
55
|
+
line?: number;
|
|
56
|
+
};
|
|
57
|
+
//#endregion
|
|
58
|
+
//#region src/origins/index.d.ts
|
|
59
|
+
/**
|
|
60
|
+
* A profile or snapshot origin: the thing that generated it, i.e. a profiler
|
|
61
|
+
* paired with a runtime (e.g. `node`, `deno`, `safari`).
|
|
62
|
+
*
|
|
63
|
+
* Auto-detected from a profile's entries via {@link determineOrigin}, or
|
|
64
|
+
* specified explicitly.
|
|
65
|
+
*/
|
|
66
|
+
type Origin = SpecificOriginSpec[`id`];
|
|
67
|
+
/**
|
|
68
|
+
* Returns the category of {@link entry} as the given {@link origin} categorizes
|
|
69
|
+
* it (see {@link OriginSpec.categorize}).
|
|
70
|
+
*
|
|
71
|
+
* The origin-aware categorization the library applies by default. Exposed so a
|
|
72
|
+
* custom `categorizeEntries` can reuse the library's categorization for an
|
|
73
|
+
* origin it didn't special-case, rather than reimplementing it.
|
|
74
|
+
*/
|
|
75
|
+
declare const categorizeEntryForOrigin: (entry: DeepReadonly<ProfileEntry>, origin: Origin) => EntryCategory;
|
|
76
|
+
/**
|
|
77
|
+
* All origin specs in global detection-priority order.
|
|
78
|
+
*
|
|
79
|
+
* Within a format, the detector tries candidates in the order they appear
|
|
80
|
+
* here, so origins that share a format and whose signals overlap must be
|
|
81
|
+
* ordered carefully (e.g. Deno before Node, since Deno supports `node:`
|
|
82
|
+
* specifiers).
|
|
83
|
+
*/
|
|
84
|
+
declare const originSpecs: ({
|
|
85
|
+
readonly id: "deno";
|
|
86
|
+
readonly language: "javascript";
|
|
87
|
+
readonly formats: ["v8-cpu-profile"];
|
|
88
|
+
readonly matchesEntry: ({
|
|
89
|
+
location
|
|
90
|
+
}: {
|
|
91
|
+
readonly id: number;
|
|
92
|
+
readonly name?: string | undefined;
|
|
93
|
+
readonly location?: {
|
|
94
|
+
readonly type: `absolute`;
|
|
95
|
+
readonly url: URL;
|
|
96
|
+
readonly line?: number | undefined;
|
|
97
|
+
readonly column?: number | undefined;
|
|
98
|
+
} | {
|
|
99
|
+
readonly type: `relative`;
|
|
100
|
+
readonly path: string;
|
|
101
|
+
readonly line?: number | undefined;
|
|
102
|
+
readonly column?: number | undefined;
|
|
103
|
+
} | undefined;
|
|
104
|
+
}) => boolean;
|
|
105
|
+
readonly categorize: (entry: {
|
|
106
|
+
readonly id: number;
|
|
107
|
+
readonly name?: string | undefined;
|
|
108
|
+
readonly location?: {
|
|
109
|
+
readonly type: `absolute`;
|
|
110
|
+
readonly url: URL;
|
|
111
|
+
readonly line?: number | undefined;
|
|
112
|
+
readonly column?: number | undefined;
|
|
113
|
+
} | {
|
|
114
|
+
readonly type: `relative`;
|
|
115
|
+
readonly path: string;
|
|
116
|
+
readonly line?: number | undefined;
|
|
117
|
+
readonly column?: number | undefined;
|
|
118
|
+
} | undefined;
|
|
119
|
+
}) => EntryCategory;
|
|
120
|
+
} | {
|
|
121
|
+
readonly id: "bun";
|
|
122
|
+
readonly language: "javascript";
|
|
123
|
+
readonly formats: ["v8-cpu-profile"];
|
|
124
|
+
readonly matchesEntry: ({
|
|
125
|
+
name,
|
|
126
|
+
location
|
|
127
|
+
}: {
|
|
128
|
+
readonly id: number;
|
|
129
|
+
readonly name?: string | undefined;
|
|
130
|
+
readonly location?: {
|
|
131
|
+
readonly type: `absolute`;
|
|
132
|
+
readonly url: URL;
|
|
133
|
+
readonly line?: number | undefined;
|
|
134
|
+
readonly column?: number | undefined;
|
|
135
|
+
} | {
|
|
136
|
+
readonly type: `relative`;
|
|
137
|
+
readonly path: string;
|
|
138
|
+
readonly line?: number | undefined;
|
|
139
|
+
readonly column?: number | undefined;
|
|
140
|
+
} | undefined;
|
|
141
|
+
}) => boolean;
|
|
142
|
+
readonly categorize: (entry: {
|
|
143
|
+
readonly id: number;
|
|
144
|
+
readonly name?: string | undefined;
|
|
145
|
+
readonly location?: {
|
|
146
|
+
readonly type: `absolute`;
|
|
147
|
+
readonly url: URL;
|
|
148
|
+
readonly line?: number | undefined;
|
|
149
|
+
readonly column?: number | undefined;
|
|
150
|
+
} | {
|
|
151
|
+
readonly type: `relative`;
|
|
152
|
+
readonly path: string;
|
|
153
|
+
readonly line?: number | undefined;
|
|
154
|
+
readonly column?: number | undefined;
|
|
155
|
+
} | undefined;
|
|
156
|
+
}) => EntryCategory;
|
|
157
|
+
} | {
|
|
158
|
+
readonly id: "node";
|
|
159
|
+
readonly language: "javascript";
|
|
160
|
+
readonly formats: ["v8-cpu-profile", "v8-heap-snapshot", "v8-heap-profile"];
|
|
161
|
+
readonly matchesEntry: ({
|
|
162
|
+
location
|
|
163
|
+
}: {
|
|
164
|
+
readonly id: number;
|
|
165
|
+
readonly name?: string | undefined;
|
|
166
|
+
readonly location?: {
|
|
167
|
+
readonly type: `absolute`;
|
|
168
|
+
readonly url: URL;
|
|
169
|
+
readonly line?: number | undefined;
|
|
170
|
+
readonly column?: number | undefined;
|
|
171
|
+
} | {
|
|
172
|
+
readonly type: `relative`;
|
|
173
|
+
readonly path: string;
|
|
174
|
+
readonly line?: number | undefined;
|
|
175
|
+
readonly column?: number | undefined;
|
|
176
|
+
} | undefined;
|
|
177
|
+
}) => boolean;
|
|
178
|
+
readonly categorize: (entry: {
|
|
179
|
+
readonly id: number;
|
|
180
|
+
readonly name?: string | undefined;
|
|
181
|
+
readonly location?: {
|
|
182
|
+
readonly type: `absolute`;
|
|
183
|
+
readonly url: URL;
|
|
184
|
+
readonly line?: number | undefined;
|
|
185
|
+
readonly column?: number | undefined;
|
|
186
|
+
} | {
|
|
187
|
+
readonly type: `relative`;
|
|
188
|
+
readonly path: string;
|
|
189
|
+
readonly line?: number | undefined;
|
|
190
|
+
readonly column?: number | undefined;
|
|
191
|
+
} | undefined;
|
|
192
|
+
}) => EntryCategory;
|
|
193
|
+
} | {
|
|
194
|
+
readonly id: "node-pprof";
|
|
195
|
+
readonly language: "javascript";
|
|
196
|
+
readonly formats: ["pprof"];
|
|
197
|
+
readonly matchesEntry: ({
|
|
198
|
+
name,
|
|
199
|
+
location
|
|
200
|
+
}: {
|
|
201
|
+
readonly id: number;
|
|
202
|
+
readonly name?: string | undefined;
|
|
203
|
+
readonly location?: {
|
|
204
|
+
readonly type: `absolute`;
|
|
205
|
+
readonly url: URL;
|
|
206
|
+
readonly line?: number | undefined;
|
|
207
|
+
readonly column?: number | undefined;
|
|
208
|
+
} | {
|
|
209
|
+
readonly type: `relative`;
|
|
210
|
+
readonly path: string;
|
|
211
|
+
readonly line?: number | undefined;
|
|
212
|
+
readonly column?: number | undefined;
|
|
213
|
+
} | undefined;
|
|
214
|
+
}) => boolean;
|
|
215
|
+
readonly categorize: (entry: {
|
|
216
|
+
readonly id: number;
|
|
217
|
+
readonly name?: string | undefined;
|
|
218
|
+
readonly location?: {
|
|
219
|
+
readonly type: `absolute`;
|
|
220
|
+
readonly url: URL;
|
|
221
|
+
readonly line?: number | undefined;
|
|
222
|
+
readonly column?: number | undefined;
|
|
223
|
+
} | {
|
|
224
|
+
readonly type: `relative`;
|
|
225
|
+
readonly path: string;
|
|
226
|
+
readonly line?: number | undefined;
|
|
227
|
+
readonly column?: number | undefined;
|
|
228
|
+
} | undefined;
|
|
229
|
+
}) => EntryCategory;
|
|
230
|
+
readonly normalizeFrame: (input: ProfileStackFrame) => ProfileStackFrame;
|
|
231
|
+
} | {
|
|
232
|
+
readonly id: "pprof-rs";
|
|
233
|
+
readonly language: "rust";
|
|
234
|
+
readonly formats: ["pprof"];
|
|
235
|
+
readonly matchesEntry: (entry: {
|
|
236
|
+
readonly id: number;
|
|
237
|
+
readonly name?: string | undefined;
|
|
238
|
+
readonly location?: {
|
|
239
|
+
readonly type: `absolute`;
|
|
240
|
+
readonly url: URL;
|
|
241
|
+
readonly line?: number | undefined;
|
|
242
|
+
readonly column?: number | undefined;
|
|
243
|
+
} | {
|
|
244
|
+
readonly type: `relative`;
|
|
245
|
+
readonly path: string;
|
|
246
|
+
readonly line?: number | undefined;
|
|
247
|
+
readonly column?: number | undefined;
|
|
248
|
+
} | undefined;
|
|
249
|
+
}) => boolean;
|
|
250
|
+
readonly categorize: (entry: {
|
|
251
|
+
readonly id: number;
|
|
252
|
+
readonly name?: string | undefined;
|
|
253
|
+
readonly location?: {
|
|
254
|
+
readonly type: `absolute`;
|
|
255
|
+
readonly url: URL;
|
|
256
|
+
readonly line?: number | undefined;
|
|
257
|
+
readonly column?: number | undefined;
|
|
258
|
+
} | {
|
|
259
|
+
readonly type: `relative`;
|
|
260
|
+
readonly path: string;
|
|
261
|
+
readonly line?: number | undefined;
|
|
262
|
+
readonly column?: number | undefined;
|
|
263
|
+
} | undefined;
|
|
264
|
+
}) => EntryCategory;
|
|
265
|
+
} | {
|
|
266
|
+
readonly id: "go";
|
|
267
|
+
readonly language: "go";
|
|
268
|
+
readonly formats: ["pprof"];
|
|
269
|
+
readonly matchesEntry: (entry: {
|
|
270
|
+
readonly id: number;
|
|
271
|
+
readonly name?: string | undefined;
|
|
272
|
+
readonly location?: {
|
|
273
|
+
readonly type: `absolute`;
|
|
274
|
+
readonly url: URL;
|
|
275
|
+
readonly line?: number | undefined;
|
|
276
|
+
readonly column?: number | undefined;
|
|
277
|
+
} | {
|
|
278
|
+
readonly type: `relative`;
|
|
279
|
+
readonly path: string;
|
|
280
|
+
readonly line?: number | undefined;
|
|
281
|
+
readonly column?: number | undefined;
|
|
282
|
+
} | undefined;
|
|
283
|
+
}) => boolean;
|
|
284
|
+
readonly categorize: (entry: {
|
|
285
|
+
readonly id: number;
|
|
286
|
+
readonly name?: string | undefined;
|
|
287
|
+
readonly location?: {
|
|
288
|
+
readonly type: `absolute`;
|
|
289
|
+
readonly url: URL;
|
|
290
|
+
readonly line?: number | undefined;
|
|
291
|
+
readonly column?: number | undefined;
|
|
292
|
+
} | {
|
|
293
|
+
readonly type: `relative`;
|
|
294
|
+
readonly path: string;
|
|
295
|
+
readonly line?: number | undefined;
|
|
296
|
+
readonly column?: number | undefined;
|
|
297
|
+
} | undefined;
|
|
298
|
+
}) => EntryCategory;
|
|
299
|
+
} | {
|
|
300
|
+
readonly id: "pprof-jl";
|
|
301
|
+
readonly language: "julia";
|
|
302
|
+
readonly formats: ["pprof"];
|
|
303
|
+
readonly matchesEntry: (entry: {
|
|
304
|
+
readonly id: number;
|
|
305
|
+
readonly name?: string | undefined;
|
|
306
|
+
readonly location?: {
|
|
307
|
+
readonly type: `absolute`;
|
|
308
|
+
readonly url: URL;
|
|
309
|
+
readonly line?: number | undefined;
|
|
310
|
+
readonly column?: number | undefined;
|
|
311
|
+
} | {
|
|
312
|
+
readonly type: `relative`;
|
|
313
|
+
readonly path: string;
|
|
314
|
+
readonly line?: number | undefined;
|
|
315
|
+
readonly column?: number | undefined;
|
|
316
|
+
} | undefined;
|
|
317
|
+
}) => boolean;
|
|
318
|
+
readonly categorize: (entry: {
|
|
319
|
+
readonly id: number;
|
|
320
|
+
readonly name?: string | undefined;
|
|
321
|
+
readonly location?: {
|
|
322
|
+
readonly type: `absolute`;
|
|
323
|
+
readonly url: URL;
|
|
324
|
+
readonly line?: number | undefined;
|
|
325
|
+
readonly column?: number | undefined;
|
|
326
|
+
} | {
|
|
327
|
+
readonly type: `relative`;
|
|
328
|
+
readonly path: string;
|
|
329
|
+
readonly line?: number | undefined;
|
|
330
|
+
readonly column?: number | undefined;
|
|
331
|
+
} | undefined;
|
|
332
|
+
}) => EntryCategory;
|
|
333
|
+
readonly normalizeFrame: (input: ProfileStackFrame) => ProfileStackFrame | null;
|
|
334
|
+
} | {
|
|
335
|
+
readonly id: "py-spy";
|
|
336
|
+
readonly language: "python";
|
|
337
|
+
readonly formats: ["collapsed", "speedscope"];
|
|
338
|
+
readonly matchesEntry: (entry: {
|
|
339
|
+
readonly id: number;
|
|
340
|
+
readonly name?: string | undefined;
|
|
341
|
+
readonly location?: {
|
|
342
|
+
readonly type: `absolute`;
|
|
343
|
+
readonly url: URL;
|
|
344
|
+
readonly line?: number | undefined;
|
|
345
|
+
readonly column?: number | undefined;
|
|
346
|
+
} | {
|
|
347
|
+
readonly type: `relative`;
|
|
348
|
+
readonly path: string;
|
|
349
|
+
readonly line?: number | undefined;
|
|
350
|
+
readonly column?: number | undefined;
|
|
351
|
+
} | undefined;
|
|
352
|
+
}) => boolean;
|
|
353
|
+
readonly categorize: (entry: DeepReadonly<ProfileEntry>) => EntryCategory;
|
|
354
|
+
readonly normalizeFrame: (input: ProfileStackFrame, format: "collapsed" | "jfr" | "jsc-heap-snapshot" | "pprof" | "speedscope" | "v8-cpu-profile" | "v8-heap-profile" | "v8-heap-snapshot" | "webkit-timeline-recording") => ProfileStackFrame;
|
|
355
|
+
} | {
|
|
356
|
+
readonly id: "tachyon";
|
|
357
|
+
readonly language: "python";
|
|
358
|
+
readonly formats: ["collapsed"];
|
|
359
|
+
readonly matchesEntry: (entry: {
|
|
360
|
+
readonly id: number;
|
|
361
|
+
readonly name?: string | undefined;
|
|
362
|
+
readonly location?: {
|
|
363
|
+
readonly type: `absolute`;
|
|
364
|
+
readonly url: URL;
|
|
365
|
+
readonly line?: number | undefined;
|
|
366
|
+
readonly column?: number | undefined;
|
|
367
|
+
} | {
|
|
368
|
+
readonly type: `relative`;
|
|
369
|
+
readonly path: string;
|
|
370
|
+
readonly line?: number | undefined;
|
|
371
|
+
readonly column?: number | undefined;
|
|
372
|
+
} | undefined;
|
|
373
|
+
}) => boolean;
|
|
374
|
+
readonly categorize: (entry: DeepReadonly<ProfileEntry>) => EntryCategory;
|
|
375
|
+
readonly normalizeFrame: (input: ProfileStackFrame) => ProfileStackFrame;
|
|
376
|
+
} | {
|
|
377
|
+
readonly id: "jvm";
|
|
378
|
+
readonly language: "java";
|
|
379
|
+
readonly formats: ["jfr", "collapsed"];
|
|
380
|
+
readonly matchesEntry: (entry: {
|
|
381
|
+
readonly id: number;
|
|
382
|
+
readonly name?: string | undefined;
|
|
383
|
+
readonly location?: {
|
|
384
|
+
readonly type: `absolute`;
|
|
385
|
+
readonly url: URL;
|
|
386
|
+
readonly line?: number | undefined;
|
|
387
|
+
readonly column?: number | undefined;
|
|
388
|
+
} | {
|
|
389
|
+
readonly type: `relative`;
|
|
390
|
+
readonly path: string;
|
|
391
|
+
readonly line?: number | undefined;
|
|
392
|
+
readonly column?: number | undefined;
|
|
393
|
+
} | undefined;
|
|
394
|
+
}) => boolean;
|
|
395
|
+
readonly categorize: (entry: {
|
|
396
|
+
readonly id: number;
|
|
397
|
+
readonly name?: string | undefined;
|
|
398
|
+
readonly location?: {
|
|
399
|
+
readonly type: `absolute`;
|
|
400
|
+
readonly url: URL;
|
|
401
|
+
readonly line?: number | undefined;
|
|
402
|
+
readonly column?: number | undefined;
|
|
403
|
+
} | {
|
|
404
|
+
readonly type: `relative`;
|
|
405
|
+
readonly path: string;
|
|
406
|
+
readonly line?: number | undefined;
|
|
407
|
+
readonly column?: number | undefined;
|
|
408
|
+
} | undefined;
|
|
409
|
+
}) => EntryCategory;
|
|
410
|
+
readonly normalizeFrame: (input: ProfileStackFrame) => ProfileStackFrame;
|
|
411
|
+
} | {
|
|
412
|
+
readonly id: "dotnet-trace";
|
|
413
|
+
readonly language: null;
|
|
414
|
+
readonly formats: ["speedscope"];
|
|
415
|
+
readonly matchesEntry: (entry: {
|
|
416
|
+
readonly id: number;
|
|
417
|
+
readonly name?: string | undefined;
|
|
418
|
+
readonly location?: {
|
|
419
|
+
readonly type: `absolute`;
|
|
420
|
+
readonly url: URL;
|
|
421
|
+
readonly line?: number | undefined;
|
|
422
|
+
readonly column?: number | undefined;
|
|
423
|
+
} | {
|
|
424
|
+
readonly type: `relative`;
|
|
425
|
+
readonly path: string;
|
|
426
|
+
readonly line?: number | undefined;
|
|
427
|
+
readonly column?: number | undefined;
|
|
428
|
+
} | undefined;
|
|
429
|
+
}) => boolean;
|
|
430
|
+
readonly categorize: (entry: {
|
|
431
|
+
readonly id: number;
|
|
432
|
+
readonly name?: string | undefined;
|
|
433
|
+
readonly location?: {
|
|
434
|
+
readonly type: `absolute`;
|
|
435
|
+
readonly url: URL;
|
|
436
|
+
readonly line?: number | undefined;
|
|
437
|
+
readonly column?: number | undefined;
|
|
438
|
+
} | {
|
|
439
|
+
readonly type: `relative`;
|
|
440
|
+
readonly path: string;
|
|
441
|
+
readonly line?: number | undefined;
|
|
442
|
+
readonly column?: number | undefined;
|
|
443
|
+
} | undefined;
|
|
444
|
+
}) => EntryCategory;
|
|
445
|
+
readonly normalizeFrame: (input: ProfileStackFrame) => ProfileStackFrame | null;
|
|
446
|
+
} | {
|
|
447
|
+
readonly id: "beam";
|
|
448
|
+
readonly language: null;
|
|
449
|
+
readonly formats: ["collapsed"];
|
|
450
|
+
readonly matchesEntry: (entry: {
|
|
451
|
+
readonly id: number;
|
|
452
|
+
readonly name?: string | undefined;
|
|
453
|
+
readonly location?: {
|
|
454
|
+
readonly type: `absolute`;
|
|
455
|
+
readonly url: URL;
|
|
456
|
+
readonly line?: number | undefined;
|
|
457
|
+
readonly column?: number | undefined;
|
|
458
|
+
} | {
|
|
459
|
+
readonly type: `relative`;
|
|
460
|
+
readonly path: string;
|
|
461
|
+
readonly line?: number | undefined;
|
|
462
|
+
readonly column?: number | undefined;
|
|
463
|
+
} | undefined;
|
|
464
|
+
}) => boolean;
|
|
465
|
+
readonly categorize: (entry: {
|
|
466
|
+
readonly id: number;
|
|
467
|
+
readonly name?: string | undefined;
|
|
468
|
+
readonly location?: {
|
|
469
|
+
readonly type: `absolute`;
|
|
470
|
+
readonly url: URL;
|
|
471
|
+
readonly line?: number | undefined;
|
|
472
|
+
readonly column?: number | undefined;
|
|
473
|
+
} | {
|
|
474
|
+
readonly type: `relative`;
|
|
475
|
+
readonly path: string;
|
|
476
|
+
readonly line?: number | undefined;
|
|
477
|
+
readonly column?: number | undefined;
|
|
478
|
+
} | undefined;
|
|
479
|
+
}) => EntryCategory;
|
|
480
|
+
readonly normalizeFrame: (input: ProfileStackFrame) => ProfileStackFrame;
|
|
481
|
+
} | {
|
|
482
|
+
readonly id: "rbspy";
|
|
483
|
+
readonly language: "ruby";
|
|
484
|
+
readonly formats: ["collapsed", "pprof", "speedscope"];
|
|
485
|
+
readonly matchesEntry: (entry: {
|
|
486
|
+
readonly id: number;
|
|
487
|
+
readonly name?: string | undefined;
|
|
488
|
+
readonly location?: {
|
|
489
|
+
readonly type: `absolute`;
|
|
490
|
+
readonly url: URL;
|
|
491
|
+
readonly line?: number | undefined;
|
|
492
|
+
readonly column?: number | undefined;
|
|
493
|
+
} | {
|
|
494
|
+
readonly type: `relative`;
|
|
495
|
+
readonly path: string;
|
|
496
|
+
readonly line?: number | undefined;
|
|
497
|
+
readonly column?: number | undefined;
|
|
498
|
+
} | undefined;
|
|
499
|
+
}) => boolean;
|
|
500
|
+
readonly categorize: (entry: {
|
|
501
|
+
readonly id: number;
|
|
502
|
+
readonly name?: string | undefined;
|
|
503
|
+
readonly location?: {
|
|
504
|
+
readonly type: `absolute`;
|
|
505
|
+
readonly url: URL;
|
|
506
|
+
readonly line?: number | undefined;
|
|
507
|
+
readonly column?: number | undefined;
|
|
508
|
+
} | {
|
|
509
|
+
readonly type: `relative`;
|
|
510
|
+
readonly path: string;
|
|
511
|
+
readonly line?: number | undefined;
|
|
512
|
+
readonly column?: number | undefined;
|
|
513
|
+
} | undefined;
|
|
514
|
+
}) => EntryCategory;
|
|
515
|
+
readonly normalizeFrame: (input: ProfileStackFrame, format: "collapsed" | "jfr" | "jsc-heap-snapshot" | "pprof" | "speedscope" | "v8-cpu-profile" | "v8-heap-profile" | "v8-heap-snapshot" | "webkit-timeline-recording") => ProfileStackFrame;
|
|
516
|
+
} | {
|
|
517
|
+
readonly id: "safari";
|
|
518
|
+
readonly language: "javascript";
|
|
519
|
+
readonly formats: ["jsc-heap-snapshot", "webkit-timeline-recording"];
|
|
520
|
+
readonly matchesEntry: ({
|
|
521
|
+
name,
|
|
522
|
+
location
|
|
523
|
+
}: DeepReadonly<ProfileEntry>) => boolean;
|
|
524
|
+
readonly categorize: (entry: {
|
|
525
|
+
readonly id: number;
|
|
526
|
+
readonly name?: string | undefined;
|
|
527
|
+
readonly location?: {
|
|
528
|
+
readonly type: `absolute`;
|
|
529
|
+
readonly url: URL;
|
|
530
|
+
readonly line?: number | undefined;
|
|
531
|
+
readonly column?: number | undefined;
|
|
532
|
+
} | {
|
|
533
|
+
readonly type: `relative`;
|
|
534
|
+
readonly path: string;
|
|
535
|
+
readonly line?: number | undefined;
|
|
536
|
+
readonly column?: number | undefined;
|
|
537
|
+
} | undefined;
|
|
538
|
+
}) => EntryCategory;
|
|
539
|
+
} | {
|
|
540
|
+
readonly id: "unknown";
|
|
541
|
+
readonly language: null;
|
|
542
|
+
readonly formats: [];
|
|
543
|
+
readonly matchesEntry: () => false;
|
|
544
|
+
readonly categorize: (entry: {
|
|
545
|
+
readonly id: number;
|
|
546
|
+
readonly name?: string | undefined;
|
|
547
|
+
readonly location?: {
|
|
548
|
+
readonly type: `absolute`;
|
|
549
|
+
readonly url: URL;
|
|
550
|
+
readonly line?: number | undefined;
|
|
551
|
+
readonly column?: number | undefined;
|
|
552
|
+
} | {
|
|
553
|
+
readonly type: `relative`;
|
|
554
|
+
readonly path: string;
|
|
555
|
+
readonly line?: number | undefined;
|
|
556
|
+
readonly column?: number | undefined;
|
|
557
|
+
} | undefined;
|
|
558
|
+
}) => EntryCategory;
|
|
559
|
+
})[];
|
|
560
|
+
/** One of the concrete origin specs, with its literal {@link Origin} ID. */
|
|
561
|
+
type SpecificOriginSpec = (typeof originSpecs)[number];
|
|
562
|
+
/** Every supported origin ID. */
|
|
25
563
|
//#endregion
|
|
26
564
|
//#region src/profile/aggregate.d.ts
|
|
27
565
|
/** An aggregation of samples taken at a given line within a function's body. */
|
|
@@ -59,18 +597,24 @@ type AggregatedProfileCallerMetrics = {
|
|
|
59
597
|
* callees, with a given direct callee.
|
|
60
598
|
*/
|
|
61
599
|
type AggregatedProfileCalleeMetrics = {
|
|
62
|
-
/** The callee corresponding to the
|
|
600
|
+
/** The callee corresponding to the ID. */callee: AggregatedProfileFunction;
|
|
63
601
|
/**
|
|
64
|
-
* The number of samples taken directly within the function's, _and_
|
|
65
|
-
* its callees, with this callee.
|
|
602
|
+
* The number of samples taken directly within the function's body, _and_
|
|
603
|
+
* all its callees, with this callee.
|
|
66
604
|
*/
|
|
67
605
|
totalSampleCount: number;
|
|
68
606
|
/**
|
|
69
607
|
* For each metric in {@link AggregatedProfile.metrics}, the sum of values from
|
|
70
608
|
* samples taken directly within the function's body, _and_ all its
|
|
71
|
-
* callees
|
|
609
|
+
* callees, with this callee.
|
|
72
610
|
*/
|
|
73
611
|
totalValues: Float64Array;
|
|
612
|
+
/**
|
|
613
|
+
* Internal aggregation bookkeeping: the epoch of the most recent call stack
|
|
614
|
+
* whose total this edge was counted into, so a frame pair that recurs within
|
|
615
|
+
* one call stack is counted just once.
|
|
616
|
+
*/
|
|
617
|
+
lastSeenEpoch: number;
|
|
74
618
|
};
|
|
75
619
|
/**
|
|
76
620
|
* An aggregation of data from every sample involving a given function within a
|
|
@@ -80,7 +624,7 @@ type AggregatedProfileFunction = {
|
|
|
80
624
|
type: `function`; /** An index that uniquely identifies this function. */
|
|
81
625
|
id: number; /** The name of the function in code. */
|
|
82
626
|
name: string; /** Where the function was defined, if known. */
|
|
83
|
-
location?: SourceLocation; /**
|
|
627
|
+
location?: SourceLocation; /** The category of functions this function belongs to. */
|
|
84
628
|
category: string;
|
|
85
629
|
/**
|
|
86
630
|
* The number of samples taken directly within the function's body, excluding
|
|
@@ -135,17 +679,18 @@ type ProfileData = string | Uint8Array | Iterable<Uint8Array>;
|
|
|
135
679
|
/** Profile data that can be asynchronously parsed and converted to Markdown. */
|
|
136
680
|
type AsyncProfileData = Blob | ReadableStream<Uint8Array>;
|
|
137
681
|
/**
|
|
138
|
-
* Profile data with
|
|
682
|
+
* Profile data with an optional explicit format and origin.
|
|
139
683
|
*
|
|
140
|
-
* The format
|
|
684
|
+
* The format and origin are auto-detected if not specified.
|
|
141
685
|
*/
|
|
142
686
|
type ProfileInput<Data> = Data | {
|
|
143
687
|
data: Data;
|
|
144
|
-
format
|
|
688
|
+
format?: Format;
|
|
689
|
+
origin?: Origin;
|
|
145
690
|
};
|
|
146
691
|
/** The category of code an entry originated from. */
|
|
147
|
-
type
|
|
148
|
-
/** A single entry in a
|
|
692
|
+
type EntryCategory = `ours` | `native` | `stdlib` | `third-party` | (string & {});
|
|
693
|
+
/** A single entry in a formatted profile. */
|
|
149
694
|
type ProfileEntry = {
|
|
150
695
|
/** An index that uniquely identifies this entry. */id: number;
|
|
151
696
|
/**
|
|
@@ -173,8 +718,16 @@ type NormalizedEntry = {
|
|
|
173
718
|
*/
|
|
174
719
|
location?: string;
|
|
175
720
|
};
|
|
176
|
-
/** A aggregated entry in a
|
|
721
|
+
/** A aggregated entry in a formatted profile. */
|
|
177
722
|
type AggregatedProfileEntry = AggregatedProfileFunction | AggregatedSnapshotNode;
|
|
723
|
+
/**
|
|
724
|
+
* The context in which a single profile or snapshot is being converted to
|
|
725
|
+
* Markdown.
|
|
726
|
+
*/
|
|
727
|
+
type ProfileToMdContext = {
|
|
728
|
+
/** The format of the profile or snapshot being converted. */format: Format; /** The origin, given explicitly or detected up front from the frames. */
|
|
729
|
+
origin: Origin;
|
|
730
|
+
};
|
|
178
731
|
/** Options for profile to Markdown converters. */
|
|
179
732
|
type ProfileToMdOptions = {
|
|
180
733
|
/**
|
|
@@ -199,7 +752,7 @@ type ProfileToMdOptions = {
|
|
|
199
752
|
*/
|
|
200
753
|
baseURL?: string | URL | null;
|
|
201
754
|
/**
|
|
202
|
-
* Source maps to apply when
|
|
755
|
+
* Source maps to apply when formatting profile locations.
|
|
203
756
|
*
|
|
204
757
|
* Accepts either a list of raw source map objects, or a record mapping
|
|
205
758
|
* generated file URLs or absolute/relative paths to raw source map objects.
|
|
@@ -225,11 +778,22 @@ type ProfileToMdOptions = {
|
|
|
225
778
|
*/
|
|
226
779
|
matchEntry?: (entry: DeepReadonly<ProfileEntry>) => NormalizedEntry | undefined;
|
|
227
780
|
/**
|
|
228
|
-
* Returns
|
|
781
|
+
* Returns a category string per entry of a single profile or snapshot, as an
|
|
782
|
+
* array aligned with {@link entries} (index `i` categorizes entry `i`).
|
|
229
783
|
*
|
|
230
784
|
* Used to compute a category breakdown in the Markdown output.
|
|
785
|
+
*
|
|
786
|
+
* Called once per profile or snapshot with all its {@link entries} and the
|
|
787
|
+
* conversion {@link ProfileToMdContext | context} (the {@link Format | format}
|
|
788
|
+
* and the resolved {@link Origin | origin}).
|
|
789
|
+
*
|
|
790
|
+
* Receiving every entry up front lets the categorizer decide from the full
|
|
791
|
+
* set rather than per entry in isolation.
|
|
792
|
+
*
|
|
793
|
+
* Defaults to {@link defaultCategorizeEntries}, which applies the library's
|
|
794
|
+
* origin-aware categorization ({@link categorizeEntryForOrigin}).
|
|
231
795
|
*/
|
|
232
|
-
|
|
796
|
+
categorizeEntries?: (entries: readonly DeepReadonly<ProfileEntry>[], context: ProfileToMdContext) => readonly EntryCategory[];
|
|
233
797
|
/**
|
|
234
798
|
* Whether to include the given entry in the Markdown output.
|
|
235
799
|
*
|
|
@@ -238,18 +802,25 @@ type ProfileToMdOptions = {
|
|
|
238
802
|
showEntry?: (entry: DeepReadonly<AggregatedProfileEntry>) => boolean;
|
|
239
803
|
};
|
|
240
804
|
/**
|
|
241
|
-
* Returns a location to match this entry by with known
|
|
242
|
-
*
|
|
243
|
-
*
|
|
805
|
+
* Returns a name and location to match this entry by with known
|
|
806
|
+
* run-varying identifiers stripped — build hashes (Cargo build-script and
|
|
807
|
+
* rustc commit-hash directories) and JVM runtime addresses (`$$Lambda.0x…`
|
|
808
|
+
* classes, `I2C/C2I adapters(0x…)` stubs) — or `undefined` if the entry
|
|
809
|
+
* contains none.
|
|
244
810
|
*/
|
|
245
811
|
declare const defaultMatchEntry: (entry: DeepReadonly<ProfileEntry>) => NormalizedEntry | undefined;
|
|
246
812
|
/**
|
|
247
|
-
*
|
|
813
|
+
* The default {@link ProfileToMdOptions.categorizeEntries}.
|
|
814
|
+
*
|
|
815
|
+
* Applies the library's origin-aware categorization to each entry (see
|
|
816
|
+
* {@link categorizeEntryForOrigin}).
|
|
248
817
|
*
|
|
249
|
-
*
|
|
250
|
-
*
|
|
818
|
+
* Exposed so a custom categorizer can reuse it as a base (e.g. override a few
|
|
819
|
+
* entries and delegate the rest).
|
|
251
820
|
*/
|
|
252
|
-
declare const
|
|
821
|
+
declare const defaultCategorizeEntries: (entries: readonly DeepReadonly<ProfileEntry>[], {
|
|
822
|
+
origin
|
|
823
|
+
}: ProfileToMdContext) => EntryCategory[];
|
|
253
824
|
/**
|
|
254
825
|
* Returns whether to include the given entry in the Markdown output.
|
|
255
826
|
*
|
|
@@ -267,8 +838,8 @@ declare const isSyntheticEntry: ({
|
|
|
267
838
|
name
|
|
268
839
|
}: DeepReadonly<AggregatedProfileEntry>) => boolean;
|
|
269
840
|
/**
|
|
270
|
-
* Returns true if the entry corresponds to an external function (`
|
|
271
|
-
* `third-party`) that's never directly called by `ours` code.
|
|
841
|
+
* Returns true if the entry corresponds to an external function (`native`,
|
|
842
|
+
* `stdlib`, or `third-party`) that's never directly called by `ours` code.
|
|
272
843
|
*
|
|
273
844
|
* These entries are typically implementation details of external code that your
|
|
274
845
|
* own code cannot directly call. Excluding these entries from the Markdown
|
|
@@ -312,8 +883,8 @@ declare const diffProfiles: (base: ProfileInput<ProfileData>, current: ProfileIn
|
|
|
312
883
|
* for supported formats and generation instructions.
|
|
313
884
|
*/
|
|
314
885
|
declare const diffProfilesAsync: (base: ProfileInput<AsyncProfileData>, current: ProfileInput<AsyncProfileData>, options?: ProfileToMdOptions) => Promise<string>;
|
|
315
|
-
declare const formats: readonly ["collapsed", "jsc-heap-snapshot", "pprof", "speedscope", "v8-cpu-profile", "v8-heap-profile", "v8-heap-snapshot", "webkit-timeline-recording"];
|
|
886
|
+
declare const formats: readonly ["collapsed", "jfr", "jsc-heap-snapshot", "pprof", "speedscope", "v8-cpu-profile", "v8-heap-profile", "v8-heap-snapshot", "webkit-timeline-recording"];
|
|
316
887
|
/** Supported profile format IDs. */
|
|
317
888
|
type Format = (typeof formats)[number];
|
|
318
889
|
//#endregion
|
|
319
|
-
export { type AggregatedProfileEntry, type AsyncProfileData, type
|
|
890
|
+
export { type AggregatedProfileEntry, type AsyncProfileData, type EntryCategory, type FileReference, type Format, type NormalizedEntry, type Origin, type ProfileData, type ProfileEntry, type ProfileInput, type ProfileToMdContext, type ProfileToMdOptions, type SourceLocation, type SourceMap, categorizeEntryForOrigin, defaultCategorizeEntries, defaultMatchEntry, defaultShowEntry, diffProfiles, diffProfilesAsync, fileReferenceId, isExternalImplementationDetailEntry, isSyntheticEntry, profileToMd, profileToMdAsync };
|