-
Notifications
You must be signed in to change notification settings - Fork 542
Update to DevTools enhanced traces documentation #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
Open
leahmsft
wants to merge
28
commits into
main
Choose a base branch
from
user/leahtu/enhanced-traces-update
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+365
−190
Open
Changes from 5 commits
Commits
Show all changes
28 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 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
File renamed without changes
File renamed without changes
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.
90 changes: 90 additions & 0 deletions
90
microsoft-edge/devtools/experimental-features/share-memory-traces.md
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,90 @@ | ||
| --- | ||
| title: Share memory traces 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: conceptual | ||
| ms.service: microsoft-edge | ||
| ms.subservice: devtools | ||
| ms.date: 01/06/2023 | ||
| --- | ||
| # Share memory traces 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. An exported trace is a `.heapsnapshot`, `.heapprofile`, or `.heaptimeline` file which can be imported in DevTools at any time. By default, these traces contain minimal information about the runtime data from the traced webpage. | ||
|
|
||
| Memory traces can also be saved as a `.devtools` file which contains much more runtime data from the traced webpage. This makes it easier to resolve memory issues, by recreating the environment in which the trace was recorded, and by providing original source files. Also, this makes it possible to reliably resolve source code references found in imported traces to the actual runtime code in the **Sources** tool. Additionally, 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 will also be possible to resolve code references to their original source code. | ||
|
|
||
| `.devtools` traces can only be imported in Microsoft Edge, while other traces are compatible with other browsers based on the Chromium engine. | ||
|
|
||
|
|
||
| <!-- ====================================================================== --> | ||
| ## 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 what is included in these 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. In the **Persistence** section of the **Preferences** page, use these checkboxes to control what to include: | ||
|
|
||
| * **Include console message in .devtools traces**. | ||
| * **Include script sources in .devtools traces**. | ||
| * **Include DOM snapshots in .devtools traces (experimental)**. | ||
|
|
||
| <!-- TODO: replace once new UI is in canary  --> | ||
|
|
||
|
|
||
| <!-- ====================================================================== --> | ||
| ## Export a trace from the Memory tool | ||
|
|
||
| To export memory information from the **Memory** tool: | ||
|
|
||
| 1. Open the **Memory** tool. | ||
|
|
||
| 1. Choose the type of memory recording you're interested in, such as **Heap Snapshot**. The following instructions are similar if you choose a different memory recording type. To learn more about the different memory recording types, see [Fix memory problems](../memory-problems/index.md). | ||
|
|
||
| 1. Click **Take Snapshot**. | ||
|
|
||
| 1. When the snapshot is recorded, click the **Save** button in the **Memory** tool sidebar: | ||
|
|
||
| <!-- TODO: replace with updated UI  --> | ||
|
|
||
| 1. Choose the trace type and a location to save the trace file on your disk. Select `.devtools` if you want to include console messages, script sources, and DOM elements. Otherwise, select `.heapsnapshot`, `.heapprofile`, or `.heaptimeline`. | ||
|
|
||
| <!-- TOOD: replace once new UI is in canary  --> | ||
|
|
||
|
|
||
| <!-- ====================================================================== --> | ||
| ## 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: | ||
|
|
||
|  | ||
|
|
||
| 1. Locate the trace file on your disk. It's either a `.devtools` file, or a `.heapsnapshot`, `.heaptimeline`, or `.heapprofile` file. | ||
|
|
||
|  | ||
|
|
||
| 1. Open the file. | ||
|
|
||
| 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) | ||
| * [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
-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
-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.