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.

Sign up for GitHub

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

Jump to bottom

Improve trace_event documentation #16315

Closed
AndreasMadsen opened this issue Oct 19, 2017 · 0 comments
Closed

Improve trace_event documentation #16315

AndreasMadsen opened this issue Oct 19, 2017 · 0 comments
Labels
doc Issues and PRs related to the documentations. good first issue Issues that are suitable for first-time contributors. help wanted Issues that need assistance from volunteers or PRs that need help to proceed.

Comments

@AndreasMadsen
Copy link
Member

AndreasMadsen commented Oct 19, 2017 •
edited
Loading

  • Version: master
  • Platform: all
  • Subsystem: trace_events, docs

The trace_events documentation is rather short and titled wrong.

We should:

  • change title from tracing to trace_event
  • describe what each category contains:
    • v8 events are GC, compiling, and execution related
    • node is a placeholder. Doesn't actually contain anything
    • node.async_hooks events have an id and a special triggerId property.
  • link to the output format specifications

ref: #15538 (comment)
@AndreasMadsen AndreasMadsen mentioned this issue Oct 19, 2017
Closed
3 tasks
@mscdex mscdex added the doc Issues and PRs related to the documentations. label Oct 19, 2017
@apapirovski apapirovski added help wanted Issues that need assistance from volunteers or PRs that need help to proceed. good first issue Issues that are suitable for first-time contributors. labels Apr 13, 2018
@BeniCheni BeniCheni mentioned this issue Apr 17, 2018
Closed
3 tasks
jasnell pushed a commit that referenced this issue Apr 23, 2018
@BeniCheni @jasnell
doc: update trace events categories description
b7d1e19 
PR-URL: #20092
Fixes: #16315
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. good first issue Issues that are suitable for first-time contributors. help wanted Issues that need assistance from volunteers or PRs that need help to proceed.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@apapirovski @mscdex @AndreasMadsen