Updated: https://wiki.mozilla.org/DevTools/OperationInstrument#1._Adding_the_Instrumentation_to_Gecko

Nick, since you're the original author for these docs, could you take a quick look on that page and let me know if there's something particularly confusing?

Keep in mind that dxr seems to not be up-to date yet with the most recent m-c changes.

TimelineConsumers::AddMarkerToDocShellsList is only for a single start or end, right? If so, you probably want to be explicit about that because the other two automatically add start and end. Aside 1: We can probably update the screecap on the page. Aside 2: Do we still require the devtools js metadata config step? Would be nice if that was optional...

(In reply to Nick Fitzgerald [:fitzgen][:nf] from comment #4) > TimelineConsumers::AddMarkerToDocShellsList is only for a single start or > end, right? If so, you probably want to be explicit about that because the > other two automatically add start and end. > Indeed, but this will change. The plan is to have a marker constructor that gives you an instance on which you call End() or something directly, instead of rebuilding the marker pairs in a O(n^2) like a madman. > Aside 1: We can probably update the screecap on the page. > Meh. Sure. > Aside 2: Do we still require the devtools js metadata config step? Would be > nice if that was optional... You can get away without it now, but markers will be shown as "Other" or "Unknown" or something similar if I'm not mistaken. We could take care of this ourselves, I guess, but it's still relevant to have that info on the page.

(In reply to Victor Porof [:vporof][:vp] from comment #5) > (In reply to Nick Fitzgerald [:fitzgen][:nf] from comment #4) > > TimelineConsumers::AddMarkerToDocShellsList is only for a single start or > > end, right? If so, you probably want to be explicit about that because the > > other two automatically add start and end. > > > > Indeed, but this will change. The plan is to have a marker constructor that > gives you an instance on which you call End() or something directly, instead > of rebuilding the marker pairs in a O(n^2) like a madman. Whoa whoa whoa what is O(n^2) and why?!? > > Aside 2: Do we still require the devtools js metadata config step? Would be > > nice if that was optional... > > You can get away without it now, but markers will be shown as "Other" or > "Unknown" or something similar if I'm not mistaken. We could take care of > this ourselves, I guess, but it's still relevant to have that info on the > page. We're starting to digress, but it would be nice if they just used the marker name instead of unknown/other but were only shown if show-platform-data was enabled. That way it is easy to get new markers that are useful to the people adding it, but normal webdevs still have a more curated experience.

(In reply to Nick Fitzgerald [:fitzgen][:nf] from comment #6) > (In reply to Victor Porof [:vporof][:vp] from comment #5) > > (In reply to Nick Fitzgerald [:fitzgen][:nf] from comment #4) > > > TimelineConsumers::AddMarkerToDocShellsList is only for a single start or > > > end, right? If so, you probably want to be explicit about that because the > > > other two automatically add start and end. > > > > > > > Indeed, but this will change. The plan is to have a marker constructor that > > gives you an instance on which you call End() or something directly, instead > > of rebuilding the marker pairs in a O(n^2) like a madman. > > Whoa whoa whoa what is O(n^2) and why?!? > See ObservedDocShell::PopMarkers. This code existed under the docshell before in this exact same form, and it's horrendous. I'll remove all of that. > > > Aside 2: Do we still require the devtools js metadata config step? Would be > > > nice if that was optional... > > > > You can get away without it now, but markers will be shown as "Other" or > > "Unknown" or something similar if I'm not mistaken. We could take care of > > this ourselves, I guess, but it's still relevant to have that info on the > > page. > > We're starting to digress, but it would be nice if they just used the marker > name instead of unknown/other but were only shown if show-platform-data was > enabled. That way it is easy to get new markers that are useful to the > people adding it, but normal webdevs still have a more curated experience. File a bug. We still have l10n issues to consider.