-
Notifications
You must be signed in to change notification settings - Fork 542
Update "Share memory|performance traces with more data" #3615
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 44 commits
Commits
Show all changes
48 commits
Select commit
Hold shift + click to select a range
c3a78c2
first drafts
leahmsft 5d656ab
removed stale photos
leahmsft 34a1d1f
image dir name
mikehoffms 2f4460d
build errs
mikehoffms 4056721
flag "enhanced"
mikehoffms 1e197c0
Load Profile buttons png
mikehoffms 6e616ae
alt text
mikehoffms 2dc9c82
break up para
mikehoffms 0568e2c
addressed PR comments
leahmsft 0627925
add png of the save performance trace dialog
leahmsft d46bafc
update script content to resource content to align with last minute c…
leahmsft e4ba3fb
writer/editor pass mon
mikehoffms fa9d3d3
Merge branch 'user/leahtu/enhanced-traces-update' of https://github.c…
mikehoffms 996f538
annot link
mikehoffms a058311
linkfix
mikehoffms 2a0f5e8
open a trace
mikehoffms 906c263
task-oriented titles
mikehoffms 8f5126b
linkfix
mikehoffms dad87c8
Open a performance trace file
mikehoffms 4f5d9ed
context of checkbox location
mikehoffms 2cedede
just enter 1 task
mikehoffms 95f259f
tabs>tools
mikehoffms 9de61c7
del todo
mikehoffms 2b77065
link to snippets & 2 tools
mikehoffms bc133b4
Merge branch 'main' into user/leahtu/enhanced-traces-update
mikehoffms cba66ef
update png and content for loading a trace
leahmsft 26575e6
update saving perf trace png
leahmsft 9baaaef
reflag png todos
mikehoffms 777ddf8
tooltips todo
mikehoffms 5e9b2f7
Merge branch 'main' into user/leahtu/enhanced-traces-update
mikehoffms add1b3e
Merge branch 'main' into user/leahtu/enhanced-traces-update
mikehoffms 13c948d
add a section for setting memory default export type and pngs
leahmsft 388ea41
pngs
mikehoffms 24caec3
Merge branch 'user/leahtu/enhanced-traces-update' of https://github.c…
mikehoffms b934d7a
straggler png
mikehoffms 01cd0b8
h4
mikehoffms 9bd4ecc
remove todos
mikehoffms d2e31b5
file types saving/opening
mikehoffms 1954c87
Merge branch 'main' into user/leahtu/enhanced-traces-update
mikehoffms eaa74cb
ms.topic: article
mikehoffms ca24ff5
ms.topic: article
mikehoffms 5afd689
update valid chrome link
leahmsft a42eb5d
Merge branch 'user/leahtu/enhanced-traces-update' of https://github.c…
leahmsft 0bf6dbe
link text
mikehoffms cbb28ce
incorporating sulekha's suggestions
leahmsft 2d32aed
Merge branch 'user/leahtu/enhanced-traces-update' of https://github.c…
leahmsft d39e922
del chkbx "collecting source text"
mikehoffms ef346f5
del Experi > enh traces
mikehoffms File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file added
BIN
+271 Bytes
...t-edge/devtools/experimental-features/share-memory-traces-images/close-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+57.6 KB
...ols/experimental-features/share-memory-traces-images/enhanced-trace-options.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+63.7 KB
...ols/experimental-features/share-memory-traces-images/exporting-memory-trace.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+93.9 KB
...ols/experimental-features/share-memory-traces-images/importing-memory-trace.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+259 Bytes
...devtools/experimental-features/share-memory-traces-images/load-profile-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
Binary file added
BIN
+297 Bytes
...devtools/experimental-features/share-memory-traces-images/save-profile-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+21.1 KB
...vtools/experimental-features/share-memory-traces-images/saving-memory-trace.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+110 KB
...erimental-features/share-memory-traces-images/set-default-memory-trace-type.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+1.06 KB
...tools/experimental-features/share-memory-traces-images/settings-button-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+1.06 KB
...ls/experimental-features/share-memory-traces-images/take-heap-snapshot-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
178 changes: 178 additions & 0 deletions
178
microsoft-edge/devtools/experimental-features/share-memory-traces.md
mikehoffms marked this conversation as resolved.
Show resolved
Hide resolved
mikehoffms marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,178 @@ | ||
| --- | ||
| title: Share a memory trace with more data | ||
| description: Learn to export and import memory traces with more data in DevTools to resolve low performance and high memory usage issues in your webpages | ||
| author: MSEdgeTeam | ||
| ms.author: msedgedevrel | ||
| ms.topic: article | ||
| ms.service: microsoft-edge | ||
| ms.subservice: devtools | ||
| ms.date: 11/17/2025 | ||
| --- | ||
| # Share a memory trace with more data | ||
|
|
||
| The **Memory** tool records runtime data about your webpage. Exploring the recorded data makes it possible to improve your webpage's memory usage. | ||
|
|
||
| Additionally, the recorded data can be exported to files on disk. The exported files are called _traces_. | ||
|
|
||
| Exporting memory traces is useful when you want to share these files with other people to get help with investigating issues. | ||
|
|
||
|
|
||
| <!-- ------------------------------ --> | ||
| #### File formats | ||
|
|
||
| A trace file can be imported in DevTools at any time. By default, these traces contain minimal information about the runtime data from the traced webpage. | ||
|
|
||
| An exported trace can be a basic `.heapsnapshot`, `.heapprofile`, or `.heaptimeline` file. | ||
|
|
||
| A memory trace can also be saved as a `.devtools` file, which contains much more runtime data from the traced webpage. Advantages of the `.devtools` file format: | ||
|
|
||
| * This makes it easier to resolve memory issues, by recreating the environment in which the trace was recorded, and by providing original source files. | ||
|
|
||
| * This makes it possible to reliably resolve source code references found in imported traces to the actual runtime code in the **Sources** tool. | ||
|
|
||
| * If source maps were present when a trace was recorded, or if they are stored on the [Azure Artifacts Symbol Server](../javascript/consume-source-maps-from-azure.md), it's also possible to resolve code references to their original source code. | ||
|
|
||
|
|
||
| <!-- ------------------------------ --> | ||
| #### Browser compatibility | ||
|
|
||
| * `.heapsnapshot`, `.heapprofile`, and `.heaptimeline` trace files are compatible with Microsoft Edge and other browsers that are based on the Chromium engine. | ||
|
|
||
| * `.devtools` traces can only be imported in Microsoft Edge. | ||
|
|
||
|
|
||
| <!-- ====================================================================== --> | ||
| ## Set the default memory trace type | ||
|
|
||
| By default, the **Memory** tool exports data as `.heapsnapshot`, `.heapprofile`, or `.heaptimeline` trace files. | ||
|
|
||
| To change the default trace type to `.devtools`: | ||
|
|
||
| 1. Open DevTools by pressing **Ctrl+Shift+I** (Windows, Linux) or **Command+Option+I** (macOS). | ||
|
|
||
| 1. In DevTools, in the upper right, select **Customize and control DevTools** > **Settings** (). **Settings** opens, with the **Preferences** page selected. | ||
|
|
||
| 1. In the **Persistence** section of the **Preferences** page, use the **Export .devtools memory traces** checkbox to control the default type. | ||
|
|
||
|  | ||
|
|
||
|
|
||
| <!-- ====================================================================== --> | ||
| ## Set the export options for memory traces | ||
|
|
||
| Memory traces that are `.devtools` files can optionally include console messages, script sources, and DOM elements. | ||
|
|
||
| To control whether console messages, script sources, or DOM elements are included in memory traces: | ||
|
|
||
| 1. Open DevTools by pressing **Ctrl+Shift+I** (Windows, Linux) or **Command+Option+I** (macOS). | ||
|
|
||
| 1. In DevTools, in the upper right, select **Customize and control DevTools** > **Settings** (). **Settings** opens, with the **Preferences** page selected. | ||
|
|
||
| 1. Scroll down to the **Persistence** section: | ||
|
|
||
|  | ||
|
|
||
| 1. Use these checkboxes to control what to include: | ||
|
|
||
| * **Include console messages in .devtools memory traces** | ||
|
|
||
| * **Include script sources in .devtools memory traces** | ||
|
|
||
| * **Include DOM snapshots in .devtools memory traces (experimental)** | ||
|
|
||
| 1. In the upper right of DevTools, click the **Close** () button. | ||
|
|
||
|
|
||
| <!-- ====================================================================== --> | ||
| ## Export a trace from the Memory tool | ||
|
|
||
| To export memory information from the **Memory** tool: | ||
|
|
||
| 1. Open the **Memory** tool. | ||
|
|
||
| 1. Select the option button for the type of memory recording you're interested in, such as the **Heap snapshot** option button. | ||
|
|
||
| The following instructions are similar if you choose a different memory recording type, per [Fix memory problems](../memory-problems/index.md). | ||
|
|
||
| **In the case of a heap snapshot:** | ||
|
|
||
| 1. Click the **Take heap snapshot** () button at top, or the **Take snapshot** button at bottom. | ||
|
|
||
| The snapshot is recorded and displayed. | ||
|
|
||
| 1. In the toolbar, select the **Save profile** () button: | ||
|
|
||
|  | ||
|
|
||
| Or, in the **Memory** tool sidebar, hover over the new snapshot's entry, and then select **Save profile**. | ||
|
|
||
| The **Save As** dialog opens: | ||
|
|
||
|  | ||
|
|
||
| 1. Navigate to a folder in which to save the trace file on your disk. | ||
|
|
||
| 1. In the **File name** text box, adjust the file name if desired. | ||
|
|
||
| 1. In the **File name** text box, keep or modify the extension that's specified after the file name. | ||
|
|
||
| <!-- todo: expect the File type dropdown to have not just 1 item, but 2 | ||
|
|
||
| when DevTools Settings > **Export .devtools memory traces** checkbox is cleared, **Save as type**'s lone item is | ||
| **Performance traces (*.devtools; *.json; *.heapsnapshot)** | ||
|
|
||
| when DevTools Settings > **Export .devtools memory traces** checkbox is selected, **Save as type**'s lone item is | ||
| **Performance traces (*.devtools; *.json; *.devtools)** | ||
| --> | ||
|
|
||
| * `.devtools` includes console messages, script sources, and DOM elements. | ||
|
|
||
| * `.heapsnapshot`, `.heapprofile`, or `.heaptimeline` omits console messages, script sources, and DOM elements. | ||
|
|
||
| Which extension is initially displayed is controlled by a DevTools setting; see [Set the default memory trace type](#set-the-default-memory-trace-type), above. | ||
|
|
||
| 1. Click the **Save** button. | ||
|
|
||
| The **Save As** dialog closes, and the file is saved to disk. | ||
|
|
||
|
|
||
| <!-- ====================================================================== --> | ||
| ## Import a trace in the Memory tool | ||
|
|
||
| To import a trace in the **Memory** tool: | ||
|
|
||
| 1. Open the **Memory** tool: | ||
|
|
||
|  | ||
|
|
||
| 1. Click the **Load profile** () button at the top. Or, click the **Load profile** button at the bottom. | ||
|
|
||
| The **Open** dialog is displayed. | ||
|
|
||
| 1. In the lower left dropdown list (a filter), select file types to display: | ||
|
|
||
| * **Performance traces (*.devtools; *.json)** - _Used with the **Performance** tool._ | ||
| * **Heap snapshots (*.devtools; *.heapsnapshot)** | ||
| * **Heap timelines (*.devtools; *.heaptimeline)** | ||
| * **Sampled heap profiles (*.devtools; *.heapprofile)** | ||
|
|
||
| 1. Locate the trace file on your disk, and then select it. | ||
|
|
||
| The trace file is either a `.devtools` file, or a `.heapsnapshot`, `.heaptimeline`, or `.heapprofile` file. | ||
|
|
||
|  | ||
|
|
||
| 1. Click the **Open** button. | ||
|
|
||
| If it's a `.devtools` file, a new DevTools window appears, showing the memory information and the extra runtime information that was recorded displayed in the **Sources**, **Console**, and **Elements** tools. | ||
|
|
||
| Otherwise, the memory information appears in the **Memory** tool, and the rest of the DevTools tabs continue to show information related to the current webpage. | ||
|
|
||
|
|
||
| <!-- ====================================================================== --> | ||
| ## See also | ||
| <!-- all links in article --> | ||
|
|
||
| * [Share performance traces with more data](../performance/share-performance-traces.md)<!-- link not in article --> | ||
| * [Fix memory problems](../memory-problems/index.md) | ||
| * [Azure Artifacts Symbol Server](../javascript/consume-source-maps-from-azure.md) |
Binary file removed
BIN
-260 KB
...tools/experimental-features/share-traces-images/choose-trace-type-on-export.png
Binary file not shown.
Binary file removed
BIN
-155 KB
...e/devtools/experimental-features/share-traces-images/enhanced-trace-options.png
Binary file not shown.
Binary file removed
BIN
-323 Bytes
microsoft-edge/devtools/experimental-features/share-traces-images/export-icon.png
Binary file not shown.
Binary file removed
BIN
-173 KB
...e/devtools/experimental-features/share-traces-images/exporting-memory-trace.png
Binary file not shown.
Binary file removed
BIN
-182 KB
...dge/devtools/experimental-features/share-traces-images/exporting-perf-trace.png
Binary file not shown.
Binary file removed
BIN
-328 Bytes
microsoft-edge/devtools/experimental-features/share-traces-images/import-icon.png
Binary file not shown.
Binary file removed
BIN
-97.7 KB
...e/devtools/experimental-features/share-traces-images/importing-memory-trace.png
Binary file not shown.
Binary file removed
BIN
-159 KB
...dge/devtools/experimental-features/share-traces-images/importing-perf-trace.png
Binary file not shown.
Binary file removed
BIN
-67.5 KB
...-edge/devtools/experimental-features/share-traces-images/opening-perf-trace.png
Binary file not shown.
Binary file removed
BIN
-86.2 KB
...edge/devtools/experimental-features/share-traces-images/saving-memory-trace.png
Binary file not shown.
Binary file removed
BIN
-107 KB
...t-edge/devtools/experimental-features/share-traces-images/saving-perf-trace.png
Binary file not shown.
Binary file removed
BIN
-648 Bytes
...dge/devtools/experimental-features/share-traces-images/settings-button-icon.png
Binary file not shown.
Binary file removed
BIN
-155 KB
...-edge/devtools/experimental-features/share-traces-images/trace-type-setting.png
Binary file not shown.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.