Add v8 heap snapshot guide

This commit is contained in:
Jarred Sumner
2025-02-12 17:22:30 -08:00
parent 506ea28b36
commit a127f1ab59

View File

@@ -0,0 +1,26 @@
---
name: Track memory usage using V8 heap snapshots
---
Bun implements V8's heap snapshot API, which allows you to create snapshots of the heap at runtime. This helps debug memory leaks in your JavaScript/TypeScript application.
```ts#snapshot.ts
import v8 from "node:v8";
// Creates a heap snapshot file with an auto-generated name
const snapshotPath = v8.writeHeapSnapshot();
console.log(`Heap snapshot written to: ${snapshotPath}`);
```
---
## Inspect memory in Chrome DevTools
To view V8 heap snapshots in Chrome DevTools:
1. Open Chrome DevTools (F12 or right-click and select "Inspect")
2. Go to the "Memory" tab
3. Click the "Load" button (folder icon)
4. Select your `.heapsnapshot` file
{% image src="/images/chrome-devtools-memory.png" alt="Chrome DevTools Memory Tab" width="100%" /%}