const (
// NoTask indicates the lack of a task.
NoTask = TaskID(^uint64(0))
// BackgroundTask is the global task that events are attached to if there was
// no other task in the context at the point the event was emitted.
BackgroundTask = TaskID(0)
)
const (
// Special P identifiers:
FakeP = 1000000 + iota
TimerP // depicts timer unblocks
NetpollP // depicts network unblocks
SyscallP // depicts returns from syscalls
GCP // depicts GC state
ProfileP // depicts recording of CPU profile samples
)
Event types in the trace. Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.
const (
EvNone = 0 // unused
EvBatch = 1 // start of per-P batch of events [pid, timestamp]
EvFrequency = 2 // contains tracer timer frequency [frequency (ticks per second)]
EvStack = 3 // stack [stack id, number of PCs, array of {PC, func string ID, file string ID, line}]
EvGomaxprocs = 4 // current value of GOMAXPROCS [timestamp, GOMAXPROCS, stack id]
EvProcStart = 5 // start of P [timestamp, thread id]
EvProcStop = 6 // stop of P [timestamp]
EvGCStart = 7 // GC start [timestamp, seq, stack id]
EvGCDone = 8 // GC done [timestamp]
EvSTWStart = 9 // GC mark termination start [timestamp, kind]
EvSTWDone = 10 // GC mark termination done [timestamp]
EvGCSweepStart = 11 // GC sweep start [timestamp, stack id]
EvGCSweepDone = 12 // GC sweep done [timestamp, swept, reclaimed]
EvGoCreate = 13 // goroutine creation [timestamp, new goroutine id, new stack id, stack id]
EvGoStart = 14 // goroutine starts running [timestamp, goroutine id, seq]
EvGoEnd = 15 // goroutine ends [timestamp]
EvGoStop = 16 // goroutine stops (like in select{}) [timestamp, stack]
EvGoSched = 17 // goroutine calls Gosched [timestamp, stack]
EvGoPreempt = 18 // goroutine is preempted [timestamp, stack]
EvGoSleep = 19 // goroutine calls Sleep [timestamp, stack]
EvGoBlock = 20 // goroutine blocks [timestamp, stack]
EvGoUnblock = 21 // goroutine is unblocked [timestamp, goroutine id, seq, stack]
EvGoBlockSend = 22 // goroutine blocks on chan send [timestamp, stack]
EvGoBlockRecv = 23 // goroutine blocks on chan recv [timestamp, stack]
EvGoBlockSelect = 24 // goroutine blocks on select [timestamp, stack]
EvGoBlockSync = 25 // goroutine blocks on Mutex/RWMutex [timestamp, stack]
EvGoBlockCond = 26 // goroutine blocks on Cond [timestamp, stack]
EvGoBlockNet = 27 // goroutine blocks on network [timestamp, stack]
EvGoSysCall = 28 // syscall enter [timestamp, stack]
EvGoSysExit = 29 // syscall exit [timestamp, goroutine id, seq, real timestamp]
EvGoSysBlock = 30 // syscall blocks [timestamp]
EvGoWaiting = 31 // denotes that goroutine is blocked when tracing starts [timestamp, goroutine id]
EvGoInSyscall = 32 // denotes that goroutine is in syscall when tracing starts [timestamp, goroutine id]
EvHeapAlloc = 33 // gcController.heapLive change [timestamp, heap live bytes]
EvHeapGoal = 34 // gcController.heapGoal change [timestamp, heap goal bytes]
EvTimerGoroutine = 35 // denotes timer goroutine [timer goroutine id]
EvFutileWakeup = 36 // denotes that the previous wakeup of this goroutine was futile [timestamp]
EvString = 37 // string dictionary entry [ID, length, string]
EvGoStartLocal = 38 // goroutine starts running on the same P as the last event [timestamp, goroutine id]
EvGoUnblockLocal = 39 // goroutine is unblocked on the same P as the last event [timestamp, goroutine id, stack]
EvGoSysExitLocal = 40 // syscall exit on the same P as the last event [timestamp, goroutine id, real timestamp]
EvGoStartLabel = 41 // goroutine starts running with label [timestamp, goroutine id, seq, label string id]
EvGoBlockGC = 42 // goroutine blocks on GC assist [timestamp, stack]
EvGCMarkAssistStart = 43 // GC mark assist start [timestamp, stack]
EvGCMarkAssistDone = 44 // GC mark assist done [timestamp]
EvUserTaskCreate = 45 // trace.NewTask [timestamp, internal task id, internal parent id, name string, stack]
EvUserTaskEnd = 46 // end of task [timestamp, internal task id, stack]
EvUserRegion = 47 // trace.WithRegion [timestamp, internal task id, mode(0:start, 1:end), name string, stack]
EvUserLog = 48 // trace.Log [timestamp, internal id, key string id, stack, value string]
EvCPUSample = 49 // CPU profiling sample [timestamp, real timestamp, real P id (-1 when absent), goroutine id, stack]
EvCount = 50
)
NoGoroutine indicates that the relevant events don't correspond to any goroutine in particular.
const NoGoroutine = GoID(-1)
NoProc indicates that the relevant events don't correspond to any P in particular.
const NoProc = ProcID(-1)
NoThread indicates that the relevant events don't correspond to any thread in particular.
const NoThread = ThreadID(-1)
NoStack is a sentinel value that can be compared against any Stack value, indicating a lack of a stack trace.
var NoStack = Stack{}
func IsSystemGoroutine(entryFn string) bool
func MutatorUtilizationV2(events []Event, flags UtilFlags) [][]MutatorUtil
MutatorUtilizationV2 returns a set of mutator utilization functions for the given v2 trace, passed as an io.Reader. Each function will always end with 0 utilization. The bounds of each function are implicit in the first and last event; outside of these bounds each function is undefined.
If the UtilPerProc flag is not given, this always returns a single utilization function. Otherwise, it returns one function per P.
func RelatedGoroutinesV2(events []Event, goid GoID) map[GoID]struct{}
RelatedGoroutinesV2 finds a set of goroutines related to goroutine goid for v2 traces. The association is based on whether they have synchronized with each other in the Go scheduler (one has unblocked another).
Event represents a single event in the trace.
type Event struct {
// contains filtered or unexported fields
}
func (e Event) Experimental() ExperimentalEvent
Experimental returns a view of the raw event for an experimental event.
Panics if Kind != EventExperimental.
func (e Event) Goroutine() GoID
Goroutine returns the ID of the goroutine that was executing when this event happened. It describes part of the execution context for this event.
Note that for goroutine state transitions this always refers to the state before the transition. For example, if a goroutine is just starting to run on this thread and/or proc, then this will return NoGoroutine. In this case, the goroutine starting to run will be can be found at Event.StateTransition().Resource.
func (e Event) Kind() EventKind
Kind returns the kind of event that this is.
func (e Event) Label() Label
Label returns details about a Label event.
Panics if Kind != EventLabel.
func (e Event) Log() Log
Log returns details about a Log event.
Panics if Kind != EventLog.
func (e Event) Metric() Metric
Metric returns details about a Metric event.
Panics if Kind != EventMetric.
func (e Event) Proc() ProcID
Proc returns the ID of the proc this event event pertains to.
Note that for proc state transitions this always refers to the state before the transition. For example, if a proc is just starting to run on this thread, then this will return NoProc.
func (e Event) Range() Range
Range returns details about an EventRangeBegin, EventRangeActive, or EventRangeEnd event.
Panics if Kind != EventRangeBegin, Kind != EventRangeActive, and Kind != EventRangeEnd.
func (e Event) RangeAttributes() []RangeAttribute
RangeAttributes returns attributes for a completed range.
Panics if Kind != EventRangeEnd.
func (e Event) Region() Region
Region returns details about a RegionBegin or RegionEnd event.
Panics if Kind != EventRegionBegin and Kind != EventRegionEnd.
func (e Event) Stack() Stack
Stack returns a handle to a stack associated with the event.
This represents a stack trace at the current moment in time for the current execution context.
func (e Event) StateTransition() StateTransition
StateTransition returns details about a StateTransition event.
Panics if Kind != EventStateTransition.
func (e Event) String() string
String returns the event as a human-readable string.
The format of the string is intended for debugging and is subject to change.
func (e Event) Task() Task
Task returns details about a TaskBegin or TaskEnd event.
Panics if Kind != EventTaskBegin and Kind != EventTaskEnd.
func (e Event) Thread() ThreadID
Thread returns the ID of the thread this event pertains to.
Note that for thread state transitions this always refers to the state before the transition. For example, if a thread is just starting to run, then this will return NoThread.
Note: tracking thread state is not currently supported, so this will always return a valid thread ID. However thread state transitions may be tracked in the future, and callers must be robust to this possibility.
func (e Event) Time() Time
Time returns the timestamp of the event.
EventKind indicates the kind of event this is.
Use this information to obtain a more specific event that allows access to more detailed information.
type EventKind uint16
const (
EventBad EventKind = iota
// EventKindSync is an event that indicates a global synchronization
// point in the trace. At the point of a sync event, the
// trace reader can be certain that all resources (e.g. threads,
// goroutines) that have existed until that point have been enumerated.
EventSync
// EventMetric is an event that represents the value of a metric at
// a particular point in time.
EventMetric
// EventLabel attaches a label to a resource.
EventLabel
// EventStackSample represents an execution sample, indicating what a
// thread/proc/goroutine was doing at a particular point in time via
// its backtrace.
//
// Note: Samples should be considered a close approximation of
// what a thread/proc/goroutine was executing at a given point in time.
// These events may slightly contradict the situation StateTransitions
// describe, so they should only be treated as a best-effort annotation.
EventStackSample
// EventRangeBegin and EventRangeEnd are a pair of generic events representing
// a special range of time. Ranges are named and scoped to some resource
// (identified via ResourceKind). A range that has begun but has not ended
// is considered active.
//
// EvRangeBegin and EvRangeEnd will share the same name, and an End will always
// follow a Begin on the same instance of the resource. The associated
// resource ID can be obtained from the Event. ResourceNone indicates the
// range is globally scoped. That is, any goroutine/proc/thread can start or
// stop, but only one such range may be active at any given time.
//
// EventRangeActive is like EventRangeBegin, but indicates that the range was
// already active. In this case, the resource referenced may not be in the current
// context.
EventRangeBegin
EventRangeActive
EventRangeEnd
// EvTaskBegin and EvTaskEnd are a pair of events representing a runtime/trace.Task.
EventTaskBegin
EventTaskEnd
// EventRegionBegin and EventRegionEnd are a pair of events represent a runtime/trace.Region.
EventRegionBegin
EventRegionEnd
// EventLog represents a runtime/trace.Log call.
EventLog
// EventStateTransition represents a state change for some resource.
EventStateTransition
// EventExperimental is an experimental event that is unvalidated and exposed in a raw form.
// Users are expected to understand the format and perform their own validation. These events
// may always be safely ignored.
EventExperimental
)
func (e EventKind) String() string
String returns a string form of the EventKind.
ExperimentalBatch represents a packet of unparsed data along with metadata about that packet.
type ExperimentalBatch struct {
// Thread is the ID of the thread that produced a packet of data.
Thread ThreadID
// Data is a packet of unparsed data all produced by one thread.
Data []byte
}
ExperimentalData represents some raw and unparsed sidecar data present in the trace that is associated with certain kinds of experimental events. For example, this data may contain tables needed to interpret ExperimentalEvent arguments, or the ExperimentEvent could just be a placeholder for a differently encoded event that's actually present in the experimental data.
type ExperimentalData struct {
// Batches contain the actual experimental data, along with metadata about each batch.
Batches []ExperimentalBatch
}
ExperimentalEvent presents a raw view of an experimental event's arguments and thier names.
type ExperimentalEvent struct {
// Name is the name of the event.
Name string
// ArgNames is the names of the event's arguments in order.
// This may refer to a globally shared slice. Copy before mutating.
ArgNames []string
// Args contains the event's arguments.
Args []uint64
// Data is additional unparsed data that is associated with the experimental event.
// Data is likely to be shared across many ExperimentalEvents, so callers that parse
// Data are encouraged to cache the parse result and look it up by the value of Data.
Data *ExperimentalData
}
Frame is a frame in stack traces.
type Frame struct {
PC uint64
Fn string
File string
Line int
}
GoID is the runtime-internal G structure's goid field. This is unique for each goroutine.
type GoID int64
GoState represents the state of a goroutine.
New GoStates may be added in the future. Users of this type must be robust to that possibility.
type GoState uint8
const (
GoUndetermined GoState = iota // No information is known about the goroutine.
GoNotExist // Goroutine does not exist.
GoRunnable // Goroutine is runnable but not running.
GoRunning // Goroutine is running.
GoWaiting // Goroutine is waiting on something to happen.
GoSyscall // Goroutine is in a system call.
)
func (s GoState) Executing() bool
Executing returns true if the state indicates that the goroutine is executing and bound to its thread.
func (s GoState) String() string
String returns a human-readable representation of a GoState.
The format of the returned string is for debugging purposes and is subject to change.
GoroutineExecStats contains statistics about a goroutine's execution during a period of time.
type GoroutineExecStats struct {
// These stats are all non-overlapping.
ExecTime time.Duration
SchedWaitTime time.Duration
BlockTimeByReason map[string]time.Duration
SyscallTime time.Duration
SyscallBlockTime time.Duration
// TotalTime is the duration of the goroutine's presence in the trace.
// Necessarily overlaps with other stats.
TotalTime time.Duration
// Total time the goroutine spent in certain ranges; may overlap
// with other stats.
RangeTime map[string]time.Duration
}
func (s GoroutineExecStats) NonOverlappingStats() map[string]time.Duration
func (s GoroutineExecStats) UnknownTime() time.Duration
UnknownTime returns whatever isn't accounted for in TotalTime.
GoroutineSummary contains statistics and execution details of a single goroutine. (For v2 traces.)
type GoroutineSummary struct {
ID GoID
Name string // A non-unique human-friendly identifier for the goroutine.
PC uint64 // The first PC we saw for the entry function of the goroutine
CreationTime Time // Timestamp of the first appearance in the trace.
StartTime Time // Timestamp of the first time it started running. 0 if the goroutine never ran.
EndTime Time // Timestamp of when the goroutine exited. 0 if the goroutine never exited.
// List of regions in the goroutine, sorted based on the start time.
Regions []*UserRegionSummary
// Statistics of execution time during the goroutine execution.
GoroutineExecStats
// contains filtered or unexported fields
}
Label provides details about a Label event.
type Label struct {
// Label is the label applied to some resource.
Label string
// Resource is the resource to which this label should be applied.
Resource ResourceID
}
Log provides details about a Log event.
type Log struct {
// Task is the ID of the task this region is associated with.
Task TaskID
// Category is the category that was passed to runtime/trace.Log or runtime/trace.Logf.
Category string
// Message is the message that was passed to runtime/trace.Log or runtime/trace.Logf.
Message string
}
An MMUCurve is the minimum mutator utilization curve across multiple window sizes.
type MMUCurve struct {
// contains filtered or unexported fields
}
func NewMMUCurve(utils [][]MutatorUtil) *MMUCurve
NewMMUCurve returns an MMU curve for the given mutator utilization function.
func (c *MMUCurve) Examples(window time.Duration, n int) (worst []UtilWindow)
Examples returns n specific examples of the lowest mutator utilization for the given window size. The returned windows will be disjoint (otherwise there would be a huge number of mostly-overlapping windows at the single lowest point). There are no guarantees on which set of disjoint windows this returns.
func (c *MMUCurve) MMU(window time.Duration) (mmu float64)
MMU returns the minimum mutator utilization for the given time window. This is the minimum utilization for all windows of this duration across the execution. The returned value is in the range [0, 1].
func (c *MMUCurve) MUD(window time.Duration, quantiles []float64) []float64
MUD returns mutator utilization distribution quantiles for the given window size.
The mutator utilization distribution is the distribution of mean mutator utilization across all windows of the given window size in the trace.
The minimum mutator utilization is the minimum (0th percentile) of this distribution. (However, if only the minimum is desired, it's more efficient to use the MMU method.)
Metric provides details about a Metric event.
type Metric struct {
// Name is the name of the sampled metric.
//
// Names follow the same convention as metric names in the
// runtime/metrics package, meaning they include the unit.
// Names that match with the runtime/metrics package represent
// the same quantity. Note that this corresponds to the
// runtime/metrics package for the Go version this trace was
// collected for.
Name string
// Value is the sampled value of the metric.
//
// The Value's Kind is tied to the name of the metric, and so is
// guaranteed to be the same for metric samples for the same metric.
Value Value
}
MutatorUtil is a change in mutator utilization at a particular time. Mutator utilization functions are represented as a time-ordered []MutatorUtil.
type MutatorUtil struct {
Time int64
// Util is the mean mutator utilization starting at Time. This
// is in the range [0, 1].
Util float64
}
ProcID is the runtime-internal G structure's id field. This is unique for each P.
type ProcID int64
ProcState represents the state of a proc.
New ProcStates may be added in the future. Users of this type must be robust to that possibility.
type ProcState uint8
const (
ProcUndetermined ProcState = iota // No information is known about the proc.
ProcNotExist // Proc does not exist.
ProcRunning // Proc is running.
ProcIdle // Proc is idle.
)
func (s ProcState) Executing() bool
Executing returns true if the state indicates that the proc is executing and bound to its thread.
func (s ProcState) String() string
String returns a human-readable representation of a ProcState.
The format of the returned string is for debugging purposes and is subject to change.
Range provides details about a Range event.
type Range struct {
// Name is a human-readable name for the range.
//
// This name can be used to identify the end of the range for the resource
// its scoped to, because only one of each type of range may be active on
// a particular resource. The relevant resource should be obtained from the
// Event that produced these details. The corresponding RangeEnd will have
// an identical name.
Name string
// Scope is the resource that the range is scoped to.
//
// For example, a ResourceGoroutine scope means that the same goroutine
// must have a start and end for the range, and that goroutine can only
// have one range of a particular name active at any given time. The
// ID that this range is scoped to may be obtained via Event.Goroutine.
//
// The ResourceNone scope means that the range is globally scoped. As a
// result, any goroutine/proc/thread may start or end the range, and only
// one such named range may be active globally at any given time.
//
// For RangeBegin and RangeEnd events, this will always reference some
// resource ID in the current execution context. For RangeActive events,
// this may reference a resource not in the current context. Prefer Scope
// over the current execution context.
Scope ResourceID
}
RangeAttributes provides attributes about a completed Range.
type RangeAttribute struct {
// Name is the human-readable name for the range.
Name string
// Value is the value of the attribute.
Value Value
}
Reader reads a byte stream, validates it, and produces trace events.
type Reader struct {
// contains filtered or unexported fields
}
func NewReader(r io.Reader) (*Reader, error)
NewReader creates a new trace reader.
func (r *Reader) ReadEvent() (e Event, err error)
ReadEvent reads a single event from the stream.
If the stream has been exhausted, it returns an invalid event and io.EOF.
Region provides details about a Region event.
type Region struct {
// Task is the ID of the task this region is associated with.
Task TaskID
// Type is the regionType that was passed to runtime/trace.StartRegion or runtime/trace.WithRegion.
Type string
}
ResourceID represents a generic resource ID.
type ResourceID struct {
// Kind is the kind of resource this ID is for.
Kind ResourceKind
// contains filtered or unexported fields
}
func MakeResourceID[T interface{ GoID | ProcID | ThreadID }](id T) ResourceID
MakeResourceID creates a general resource ID from a specific resource's ID.
func (r ResourceID) Goroutine() GoID
Goroutine obtains a GoID from the resource ID.
r.Kind must be ResourceGoroutine or this function will panic.
func (r ResourceID) Proc() ProcID
Proc obtains a ProcID from the resource ID.
r.Kind must be ResourceProc or this function will panic.
func (r ResourceID) String() string
String returns a human-readable string representation of the ResourceID.
This representation is subject to change and is intended primarily for debugging.
func (r ResourceID) Thread() ThreadID
Thread obtains a ThreadID from the resource ID.
r.Kind must be ResourceThread or this function will panic.
ResourceKind indicates a kind of resource that has a state machine.
New ResourceKinds may be added in the future. Users of this type must be robust to that possibility.
type ResourceKind uint8
const (
ResourceNone ResourceKind = iota // No resource.
ResourceGoroutine // Goroutine.
ResourceProc // Proc.
ResourceThread // Thread.
)
func (r ResourceKind) String() string
String returns a human-readable representation of a ResourceKind.
The format of the returned string is for debugging purposes and is subject to change.
Stack represents a stack. It's really a handle to a stack and it's trivially comparable.
If two Stacks are equal then their Frames are guaranteed to be identical. If they are not equal, however, their Frames may still be equal.
type Stack struct {
// contains filtered or unexported fields
}
func (s Stack) Frames(yield func(f StackFrame) bool) bool
Frames is an iterator over the frames in a Stack.
StackFrame represents a single frame of a stack.
type StackFrame struct {
// PC is the program counter of the function call if this
// is not a leaf frame. If it's a leaf frame, it's the point
// at which the stack trace was taken.
PC uint64
// Func is the name of the function this frame maps to.
Func string
// File is the file which contains the source code of Func.
File string
// Line is the line number within File which maps to PC.
Line uint64
}
StateTransition provides details about a StateTransition event.
type StateTransition struct {
// Resource is the resource this state transition is for.
Resource ResourceID
// Reason is a human-readable reason for the state transition.
Reason string
// Stack is the stack trace of the resource making the state transition.
//
// This is distinct from the result (Event).Stack because it pertains to
// the transitioning resource, not any of the ones executing the event
// this StateTransition came from.
//
// An example of this difference is the NotExist -> Runnable transition for
// goroutines, which indicates goroutine creation. In this particular case,
// a Stack here would refer to the starting stack of the new goroutine, and
// an (Event).Stack would refer to the stack trace of whoever created the
// goroutine.
Stack Stack
// contains filtered or unexported fields
}
func (d StateTransition) Goroutine() (from, to GoState)
Goroutine returns the state transition for a goroutine.
Transitions to and from states that are Executing are special in that they change the future execution context. In other words, future events on the same thread will feature the same goroutine until it stops running.
Panics if d.Resource.Kind is not ResourceGoroutine.
func (d StateTransition) Proc() (from, to ProcState)
Proc returns the state transition for a proc.
Transitions to and from states that are Executing are special in that they change the future execution context. In other words, future events on the same thread will feature the same goroutine until it stops running.
Panics if d.Resource.Kind is not ResourceProc.
Summarizer constructs per-goroutine time statistics for v2 traces.
type Summarizer struct {
// contains filtered or unexported fields
}
func NewSummarizer() *Summarizer
NewSummarizer creates a new struct to build goroutine stats from a trace.
func (s *Summarizer) Event(ev *Event)
Event feeds a single event into the stats summarizer.
func (s *Summarizer) Finalize() *Summary
Finalize indicates to the summarizer that we're done processing the trace. It cleans up any remaining state and returns the full summary.
Summary is the analysis result produced by the summarizer.
type Summary struct {
Goroutines map[GoID]*GoroutineSummary
Tasks map[TaskID]*UserTaskSummary
}
Task provides details about a Task event.
type Task struct {
// ID is a unique identifier for the task.
//
// This can be used to associate the beginning of a task with its end.
ID TaskID
// ParentID is the ID of the parent task.
Parent TaskID
// Type is the taskType that was passed to runtime/trace.NewTask.
//
// May be "" if a task's TaskBegin event isn't present in the trace.
Type string
}
TaskID is the internal ID of a task used to disambiguate tasks (even if they are of the same type).
type TaskID uint64
ThreadID is the runtime-internal M structure's ID. This is unique for each OS thread.
type ThreadID int64
Time is a timestamp in nanoseconds.
It corresponds to the monotonic clock on the platform that the trace was taken, and so is possible to correlate with timestamps for other traces taken on the same machine using the same clock (i.e. no reboots in between).
The actual absolute value of the timestamp is only meaningful in relation to other timestamps from the same clock.
BUG: Timestamps coming from traces on Windows platforms are only comparable with timestamps from the same trace. Timestamps across traces cannot be compared, because the system clock is not used as of Go 1.22.
BUG: Traces produced by Go versions 1.21 and earlier cannot be compared with timestamps from other traces taken on the same machine. This is because the system clock was not used at all to collect those timestamps.
type Time int64
func (t Time) Sub(t0 Time) time.Duration
Sub subtracts t0 from t, returning the duration in nanoseconds.
UserRegionSummary represents a region and goroutine execution stats while the region was active. (For v2 traces.)
type UserRegionSummary struct {
TaskID TaskID
Name string
// Region start event. Normally EventRegionBegin event or nil,
// but can be a state transition event from NotExist or Undetermined
// if the region is a synthetic region representing task inheritance
// from the parent goroutine.
Start *Event
// Region end event. Normally EventRegionEnd event or nil,
// but can be a state transition event to NotExist if the goroutine
// terminated without explicitly ending the region.
End *Event
GoroutineExecStats
}
UserTaskSummary represents a task in the trace.
type UserTaskSummary struct {
ID TaskID
Name string
Parent *UserTaskSummary // nil if the parent is unknown.
Children []*UserTaskSummary
// Task begin event. An EventTaskBegin event or nil.
Start *Event
// End end event. Normally EventTaskEnd event or nil.
End *Event
// Logs is a list of EventLog events associated with the task.
Logs []*Event
// List of regions in the task, sorted based on the start time.
Regions []*UserRegionSummary
// Goroutines is the set of goroutines associated with this task.
Goroutines map[GoID]*GoroutineSummary
}
func (s *UserTaskSummary) Complete() bool
Complete returns true if we have complete information about the task from the trace: both a start and an end.
func (s *UserTaskSummary) Descendents() []*UserTaskSummary
Descendents returns a slice consisting of itself (always the first task returned), and the transitive closure of all of its children.
UtilFlags controls the behavior of MutatorUtilization.
type UtilFlags int
const (
// UtilSTW means utilization should account for STW events.
// This includes non-GC STW events, which are typically user-requested.
UtilSTW UtilFlags = 1 << iota
// UtilBackground means utilization should account for
// background mark workers.
UtilBackground
// UtilAssist means utilization should account for mark
// assists.
UtilAssist
// UtilSweep means utilization should account for sweeping.
UtilSweep
// UtilPerProc means each P should be given a separate
// utilization function. Otherwise, there is a single function
// and each P is given a fraction of the utilization.
UtilPerProc
)
UtilWindow is a specific window at Time.
type UtilWindow struct {
Time int64
// MutatorUtil is the mean mutator utilization in this window.
MutatorUtil float64
}
Value is a dynamically-typed value obtained from a trace.
type Value struct {
// contains filtered or unexported fields
}
func (v Value) Kind() ValueKind
Kind returns the ValueKind of the value.
It represents the underlying structure of the value.
New ValueKinds may be added in the future. Users of this type must be robust to that possibility.
func (v Value) Uint64() uint64
Uint64 returns the uint64 value for a MetricSampleUint64.
Panics if this metric sample's Kind is not MetricSampleUint64.
ValueKind is the type of a dynamically-typed value from a trace.
type ValueKind uint8
const (
ValueBad ValueKind = iota
ValueUint64
)
| Name | Synopsis |
|---|---|
| .. | |