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

Jump to bottom

cmd/trace: execution tracer is essentially not documented #16526

Open
AlekSi opened this issue Jul 28, 2016 · 7 comments
Open

cmd/trace: execution tracer is essentially not documented #16526

AlekSi opened this issue Jul 28, 2016 · 7 comments
Labels
compiler/runtime Issues related to the Go compiler and/or runtime. Documentation
Milestone
Backlog

Comments

@AlekSi
Copy link
Contributor

AlekSi commented Jul 28, 2016

I was able to find only 3 short mentions:

They are not very helpful. Compare this to how race detector (article, blog post) or pprof (blog post) is documented. People on Reddit even think that trace tool flopped.
#11605 mentions future blog post, but it never materialised.
@rakyll rakyll changed the title Execution tracer is essentially not documented docs: execution tracer is essentially not documented Jul 28, 2016
@rakyll
Copy link
Contributor

rakyll commented Jul 28, 2016

/cc @broady @campoy

@rakyll rakyll added this to the Unreleased milestone Jul 28, 2016
@holys
Copy link

holys commented Nov 11, 2016

ping

@AlekSi
Copy link
Contributor Author

AlekSi commented Jan 17, 2017

Execution tracer just got some documentation… in the form of this talk.

@AlekSi
Copy link
Contributor Author

AlekSi commented Jan 23, 2017

There is an external package with some documentation for events format: go-trace.

@sebastienfr sebastienfr mentioned this issue Nov 8, 2017
Merged
@Deleplace
Copy link
Contributor

Deleplace commented Aug 10, 2018 •
edited

This article by Pusher.com (2017) is nice.

@campoy
Copy link
Contributor

campoy commented Aug 13, 2018

If it helps, I did write this long time ago: https://github.com/campoy/go-tooling-workshop/blob/master/3-dynamic-analysis/4-tracing/1-tracing.md

@bcmills bcmills changed the title docs: execution tracer is essentially not documented cmd/trace: execution tracer is essentially not documented Apr 9, 2019
@guevara guevara mentioned this issue Jun 21, 2019
Open
@rsc rsc unassigned dvyukov Jun 23, 2022
@gopherbot gopherbot added the compiler/runtime Issues related to the Go compiler and/or runtime. label Jul 7, 2022
@prattmic
Copy link
Member

We could definitely still use more documentation, but I'll note that Go 1.19 adds more documentation directly in the trace web UI via https://go.dev/cl/412876.

@mknyszek mknyszek modified the milestones: Unreleased, Backlog Oct 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
compiler/runtime Issues related to the Go compiler and/or runtime. Documentation
Projects
Go Compiler / Runtime
Status: Todo
Milestone
Backlog
Development

No branches or pull requests
9 participants
@AlekSi @rakyll @dvyukov @holys @mknyszek @prattmic @campoy @gopherbot @Deleplace