Skip to content
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

Add docs for JS self-profiling API #37796

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

wbamberg
Copy link
Collaborator

@wbamberg wbamberg commented Jan 24, 2025

Docs for the JS Self-Profiling API.

  • I've included a page for samplebufferfull which is mentioned in the spec but not defined, and which doesn't have a BCD entry yet.
  • in my experiments I often see samples which only have a timestamp and no stack ID. I believe that these are when the browser is doing some other work that isn't directly executing the program, like GC. Is that right? I should probably say something about this.
  • this API is protected using Document Policy which AFAIK is not documented on MDN. I haven't done that as part of this PR but we should. I think there is an issue somewhere to document it but I can't find it in mdn/content.

@wbamberg wbamberg requested review from a team as code owners January 24, 2025 19:10
@wbamberg wbamberg requested review from sideshowbarker and bsmth and removed request for a team January 24, 2025 19:10
@github-actions github-actions bot added the Content:WebAPI Web API docs label Jan 24, 2025
@github-actions github-actions bot added the size/m [PR only] 51-500 LoC changed label Jan 24, 2025
Copy link
Contributor

github-actions bot commented Jan 24, 2025

Preview URLs (6 pages)
External URLs (2)

URL: /en-US/docs/Web/API/Profiler/Profiler
Title: Profiler: Profiler() constructor


URL: /en-US/docs/Web/API/JS_Self-Profiling_API
Title: JS Self-Profiling API

(comment last updated: 2025-01-27 15:34:09)

@sideshowbarker sideshowbarker removed their request for review January 25, 2025 12:14
Copy link
Contributor

@captainbrosset captainbrosset left a comment

Choose a reason for hiding this comment

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

Looks great to me from a tech writing perspective. Thanks Will.
I'll ping someone from my side to take a look at the technical details too.

files/en-us/web/api/js_self-profiling_api/index.md Outdated Show resolved Hide resolved
@@ -0,0 +1,49 @@
---
title: "Profiler: samplebufferfull event"
Copy link
Contributor

Choose a reason for hiding this comment

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

It is indeed mentioned briefly in the spec, and is implemented in chromium (it seems).
I think this should be spec'd properly, and then added to BCD.

Co-authored-by: Patrick Brosset <patrickbrosset@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:WebAPI Web API docs size/m [PR only] 51-500 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants