golang/go

runtime/trace: implement user events

Open

#16,619 opened on Aug 5, 2016

View on GitHub
 (15 comments) (0 reactions) (0 assignees)Go (19,008 forks)batch import
NeedsFixearly-in-cyclehelp wanted

Repository metrics

Stars
 (133,883 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

https://golang.org/s/go15trace specifies user events:

Runtime/pprof package also exposes a set of functions for emission of user events:

package pprof
func TraceEvent(id string)
func TraceScopeStart(id string)
func TraceScopeEnd(id string)

But there is no implementation at this time.

Those would be invaluable to properly debug latency problems.

(According to @dvyukov there is no one actively working on it, so I might give it a try.)

Contributor guide

Research direction
Examine the existing runtime/trace implementation to understand how trace events are generated. Then implement the user event functions (TraceEvent, TraceScopeStart, TraceScopeEnd) in the runtime/pprof package following the design document.
Tech stack
go
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GoUnderstanding of tracing concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50