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

docs: add trace interpretation guide #2472

Merged
merged 2 commits into from
Jun 15, 2017
Merged

docs: add trace interpretation guide #2472

merged 2 commits into from
Jun 15, 2017

Conversation

patrickhulce
Copy link
Collaborator

followup to #2454

Copy link
Member

@brendankenny brendankenny left a comment

Choose a reason for hiding this comment

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

this is great


### Trace of Tab

Trace of tab identifies trace events for key moments (navigation start, first meaningful paint, DOM content loaded, trace end, etc) and provides filtered views of just the main process and the main thread events. Because the timestamps are not interesting in isolation, trace of tab also calculates the times in milliseconds of key moments relative to navigation start, thus providing the typical interpretation of first meaningful paint in ms.
Copy link
Member

Choose a reason for hiding this comment

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

  • link to trace-of-tab?
  • "Because the timestamps are not necessarily interesting in isolation..." :)
  • give the timestamps and timings names for each of the two groups of times?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

done


### Tracing Processor

Tracing processor takes the output of trace of tab and identifies the toplevel main thread tasks, their durations, and corresponding impact on page responsiveness. Tracing process also translates task timestamps to milliseconds since navigation start for easier interpretation in computed gatherers and audits.
Copy link
Member

Choose a reason for hiding this comment

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

  • top-level
  • "Tracing processor also translates..."

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

done


### Trace of Tab

Trace of tab identifies trace events for key moments (navigation start, first meaningful paint, DOM content loaded, trace end, etc) and provides filtered views of just the main process and the main thread events. Because the timestamps are not interesting in isolation, trace of tab also calculates the times in milliseconds of key moments relative to navigation start, thus providing the typical interpretation of first meaningful paint in ms.
Copy link
Member

Choose a reason for hiding this comment

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

hyphenate or camelCase trace-of-tab? It feels weird without articles, so clearly a proper name, but also lower case and without anything connecting the words :)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

done

Copy link
Member

@brendankenny brendankenny left a comment

Choose a reason for hiding this comment

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

sorry, meant to LGTM this.

@paulirish might want to take a look now that he's back, but could also just add in a followup if he wants more stuff

@patrickhulce patrickhulce merged commit f22279e into master Jun 15, 2017
@patrickhulce patrickhulce deleted the trace_docs branch June 15, 2017 06:30
@patrickhulce
Copy link
Collaborator Author

followup suggestions welcome @paulirish :)

@paulirish
Copy link
Member

All good! This looks A+

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants