Skip to content

Add article "Customize your performance data with extensibility API" #3406

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

Draft
wants to merge 21 commits into
base: main
Choose a base branch
from

Conversation

mikehoffms
Copy link
Collaborator

@mikehoffms mikehoffms commented Mar 13, 2025

status: todo: create 3 remaining pngs

Rendered article for review:

AB#55538778

@mikehoffms mikehoffms added in-progress cat: devtools DevTools-related content. labels Mar 13, 2025
Copy link

Learn Build status updates of commit 8c9380a:

✅ Validation status: passed

File Status Preview URL Details
microsoft-edge/devtools-guide-chromium/performance/extension.md ✅Succeeded View
microsoft-edge/devtools-guide-chromium/performance/index.md ✅Succeeded View
microsoft-edge/toc.yml ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

Copy link

Learn Build status updates of commit af24e29:

✅ Validation status: passed

File Status Preview URL Details
microsoft-edge/devtools-guide-chromium/performance/extension.md ✅Succeeded View
microsoft-edge/devtools-guide-chromium/performance/index.md ✅Succeeded View
microsoft-edge/toc.yml ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

Copy link

Learn Build status updates of commit 12672ca:

⚠️ Validation status: warnings

File Status Preview URL Details
microsoft-edge/devtools-guide-chromium/performance/extension.md ⚠️Warning View Details
microsoft-edge/devtools-guide-chromium/performance/extension-images/capture-settings-icon.png ✅Succeeded View
microsoft-edge/devtools-guide-chromium/performance/extension-images/custom-tracks-setting.png ✅Succeeded View
microsoft-edge/devtools-guide-chromium/performance/extension-images/example.png ✅Succeeded View
microsoft-edge/devtools-guide-chromium/performance/extension-images/expanded-custom-tracks.png ✅Succeeded View
microsoft-edge/devtools-guide-chromium/performance/extension-images/performance-icon.png ✅Succeeded View
microsoft-edge/devtools-guide-chromium/performance/extension-images/record-icon.png ✅Succeeded View
microsoft-edge/devtools-guide-chromium/performance/index.md ✅Succeeded View
microsoft-edge/toc.yml ✅Succeeded View

microsoft-edge/devtools-guide-chromium/performance/extension.md

  • Line 39, Column 3: [Warning: bookmark-not-found - See documentation] Cannot find bookmark '#see-also' in 'devtools-guide-chromium/performance/extension.md'.
  • Line 256, Column 1: [Warning: file-not-found - See documentation] Invalid file link: './extension-images/custom-track-console-timestamp.png'.
  • Line 306, Column 1: [Warning: file-not-found - See documentation] Invalid file link: './extension-images/custom-track.png'.
  • Line 334, Column 1: [Warning: file-not-found - See documentation] Invalid file link: './extension-images/marker-in-timings.png'.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@mikehoffms mikehoffms requested a review from captainbrosset May 28, 2025 01:13
@mikehoffms mikehoffms marked this pull request as ready for review May 28, 2025 01:13
@mikehoffms mikehoffms marked this pull request as draft May 28, 2025 01:15
Copy link

Copy link


This results in the following custom track entry in the performance timeline:

![A custom track with custom entries added with the console.timeStamp API](./extension-images/custom-track-console-timestamp.png)<!-- todo: png -->
Copy link
Collaborator Author

@mikehoffms mikehoffms May 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How to create png from the above code? like at
https://developer.chrome.com/docs/devtools/performance/extension#consoletimestamp_api_examples
@captainbrosset
Paste the above code into \Demos\photo-gallery\gallery.js ?
Will we be able to use the above code as-is, or need to present different code that can be in gallery.js?
upstream png shows "about:blank"

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For maintainers, and also users, can we give steps to produce the screenshot on your own machine? This upstream section lacks any hints about how they got from the code to the screenshot - mysterious gap for maintainers (& users).
@captainbrosset


To see the custom perf measures in the demo:

1. Open the [Photo Gallery demo page](https://microsoftedge.github.io/Demos/photo-gallery/) in a new window or tab.
Copy link
Collaborator Author

@mikehoffms mikehoffms May 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

show code that was added to Gallery?
\Demos\photo-gallery\gallery.js
The Commit in Demos repo
@captainbrosset
eg note that:

  • .mark is not used.
  • State which approach is used in Gallery: console.timeStamp (not used), or performance.mark (not used) & performance.measure (used).
  • List which API items are added to Gallery demo.


This API leverages the existing [User Timings API](https://developer.mozilla.org/docs/Web/API/Performance_API/User_timing). It also adds entries to the browser's internal performance timeline, allowing for further analysis and integration with other performance tools; see [Performance APIs](https://developer.mozilla.org/docs/Web/API/Performance_API) at MDN.

![An example of how custom tracks look in the Performance tool](./extension-images/example.png)
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

show localhost instead of github.io, in Address Bar?


1. Expand each of these three tracks to see the custom performance measures:

![Expanded custom tracks](./extension-images/expanded-custom-tracks.png)
Copy link
Collaborator Author

@mikehoffms mikehoffms May 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cat: devtools DevTools-related content. in-progress
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants