package traceviewer

Import Path
	internal/trace/traceviewer (on go.dev)

Dependency Relation
	imports 20 packages, and imported by 0 packages

Involved Source Files

	    emitter.go
	    histogram.go
	    http.go
	    mmu.go
	    pprof.go
Package-Level Type Names (total 16)

	/* sort by: alphabet | popularity */
	 type ArrowEvent (struct)

		Fields (total 6)
			End time.Duration
			FromResource uint64
			FromStack int
			Name string
			Start time.Duration
			ToResource uint64
		As Inputs Of (at least 2)
			func (*Emitter).Arrow(a ArrowEvent)
			func (*Emitter).TaskArrow(a ArrowEvent)

	 type AsyncSliceEvent (struct)

		Fields (total 11)
			Category string
			Scope string
			SliceEvent SliceEvent
			SliceEvent.Arg any
			SliceEvent.Dur time.Duration
			SliceEvent.EndStack int
			SliceEvent.Name string
			SliceEvent.Resource uint64
			SliceEvent.Stack int
			SliceEvent.Ts time.Duration
			TaskColorIndex uint64
				// Take on the same color as the task with this ID.

		As Inputs Of (at least one exported)
			func (*Emitter).AsyncSlice(s AsyncSliceEvent)

	 type Emitter (struct)

		Methods (total 21)
			(*Emitter) Arrow(a ArrowEvent)
			(*Emitter) AsyncSlice(s AsyncSliceEvent)
			(*Emitter) Err() error
				Err returns an error if the emitter is in an invalid state.

			(*Emitter) Event(ev *format.Event)
			(*Emitter) Flush()
			(*Emitter) Focus(id uint64)
			(*Emitter) Gomaxprocs(v uint64)
			(*Emitter) GoroutineTransition(ts time.Duration, from, to GState)
			(*Emitter) HeapAlloc(ts time.Duration, v uint64)
			(*Emitter) HeapGoal(ts time.Duration, v uint64)
			(*Emitter) IncThreadStateCount(ts time.Duration, state ThreadState, delta int64)
			(*Emitter) Instant(i InstantEvent)
			(*Emitter) OptionalEvent(ev *format.Event)
				OptionalEvent emits ev if it's within the time range of of the consumer, i.e.
				the selected trace split range.

			(*Emitter) Resource(id uint64, name string)
			(*Emitter) SetResourceFilter(filter func(uint64) bool)
			(*Emitter) SetResourceType(name string)
			(*Emitter) Slice(s SliceEvent)
			(*Emitter) Stack(stk []*trace.Frame) int
				Stack emits the given frames and returns a unique id for the stack. No
				pointers to the given data are being retained beyond the call to Stack.

			(*Emitter) Task(id uint64, name string, sortIndex int)
			(*Emitter) TaskArrow(a ArrowEvent)
			(*Emitter) TaskSlice(s SliceEvent)
		Implements (at least one exported)
			*Emitter : net/http.Flusher
		As Outputs Of (at least one exported)
			func NewEmitter(c TraceConsumer, rangeStart, rangeEnd time.Duration) *Emitter

	 type GState int (basic type)

		As Inputs Of (at least one exported)
			func (*Emitter).GoroutineTransition(ts time.Duration, from, to GState)
		As Types Of (total 5)
			const GDead
			const GRunnable
			const GRunning
			const GWaiting
			const GWaitingGC

	 type InstantEvent (struct)

		Fields (total 6)
			Arg any
			Category string
			Name string
			Resource uint64
			Stack int
			Ts time.Duration
		As Inputs Of (at least one exported)
			func (*Emitter).Instant(i InstantEvent)

	 type Mode int (basic type)

		As Types Of (total 3)
			const ModeGoroutineOriented
			const ModeTaskOriented
			const ModeThreadOriented

	 type MutatorUtilFunc (func)

		As Inputs Of (at least one exported)
			func MMUHandlerFunc(ranges []Range, f MutatorUtilFunc) http.HandlerFunc

	 type ProfileFunc (func)

		As Inputs Of (at least one exported)
			func SVGProfileHandlerFunc(f ProfileFunc) http.HandlerFunc

	 type ProfileRecord (struct)

		Fields (total 3)
			Count uint64
			Stack []*trace.Frame
			Time time.Duration
		As Inputs Of (at least one exported)
			func BuildProfile(prof []ProfileRecord) *profile.Profile

	 type Range (struct)

		Fields (total 5)
			End int
			EndTime int64
			Name string
			Start int
			StartTime int64
		Methods (only one)
			( Range) URL(viewType ViewType) string
		As Inputs Of (at least one exported)
			func MMUHandlerFunc(ranges []Range, f MutatorUtilFunc) http.HandlerFunc

	 type SliceEvent (struct)

		Fields (total 7)
			Arg any
			Dur time.Duration
			EndStack int
			Name string
			Resource uint64
			Stack int
			Ts time.Duration
		As Inputs Of (at least 2)
			func (*Emitter).Slice(s SliceEvent)
			func (*Emitter).TaskSlice(s SliceEvent)

	 type ThreadState int (basic type)

		As Inputs Of (at least one exported)
			func (*Emitter).IncThreadStateCount(ts time.Duration, state ThreadState, delta int64)
		As Types Of (total 3)
			const ThreadStateInSyscall
			const ThreadStateInSyscallRuntime
			const ThreadStateRunning

	 type TimeHistogram (struct)
		TimeHistogram is an high-dynamic-range histogram for durations.

		Fields (total 4)
			Buckets []int
			Count int
			MaxBucket int
			MinBucket int
		Methods (total 3)
			(*TimeHistogram) Add(d time.Duration)
				Add adds a single sample to the histogram.

			(*TimeHistogram) BucketMin(bucket int) time.Duration
				BucketMin returns the minimum duration value for a provided bucket.

			(*TimeHistogram) ToHTML(urlmaker func(min, max time.Duration) string) template.HTML
				ToHTML renders the histogram as HTML.


	 type TraceConsumer (struct)

		Fields (total 4)
			ConsumeTimeUnit func(unit string)
			ConsumeViewerEvent func(v *format.Event, required bool)
			ConsumeViewerFrame func(key string, f format.Frame)
			Flush func()
		As Outputs Of (at least 2)
			func SplittingTraceConsumer(max int) (*splitter, TraceConsumer)
			func ViewerDataTraceConsumer(w io.Writer, startIdx, endIdx int64) TraceConsumer
		As Inputs Of (at least one exported)
			func NewEmitter(c TraceConsumer, rangeStart, rangeEnd time.Duration) *Emitter

	 type View (struct)

		Fields (total 2)
			Ranges []Range
			Type ViewType
		Methods (only one)
			( View) URL(rangeIdx int) string
		As Inputs Of (at least one exported)
			func MainHandler(views []View) http.Handler

	 type ViewType string (basic type)

		As Inputs Of (at least one exported)
			func Range.URL(viewType ViewType) string
		As Types Of (total 2)
			const ViewProc
			const ViewThread


Package-Level Functions (total 10)

	 func BuildProfile(prof []ProfileRecord) *profile.Profile
	 func MainHandler(views []View) http.Handler
	 func MMUHandlerFunc(ranges []Range, f MutatorUtilFunc) http.HandlerFunc
	 func NewEmitter(c TraceConsumer, rangeStart, rangeEnd time.Duration) *Emitter
		NewEmitter returns a new Emitter that writes to c. The rangeStart and
		rangeEnd args are used for splitting large traces.

	 func SplittingTraceConsumer(max int) (*splitter, TraceConsumer)
	 func StaticHandler() http.Handler
	 func SVGProfileHandlerFunc(f ProfileFunc) http.HandlerFunc
		SVGProfileHandlerFunc serves pprof-like profile generated by prof as svg.

	 func TraceHandler() http.Handler
	 func ViewerDataTraceConsumer(w io.Writer, startIdx, endIdx int64) TraceConsumer
		ViewerDataTraceConsumer returns a TraceConsumer that writes to w. The
		startIdx and endIdx are used for splitting large traces. They refer to
		indexes in the traceEvents output array, not the events in the trace input.

	 func WalkStackFrames(allFrames map[string]format.Frame, id int, fn func(id int))
		WalkStackFrames calls fn for id and all of its parent frames from allFrames.


Package-Level Constants (total 14)

	const CommonStyle = "\n/* See https://github.com/golang/pkgsite/blob/master/static/shared...
	const GDead GState = 0
	const GRunnable GState = 1
	const GRunning GState = 2
	const GWaiting GState = 3
	const GWaitingGC GState = 4
	const ModeGoroutineOriented Mode = 1
	const ModeTaskOriented Mode = 2
	const ModeThreadOriented Mode = 4 // Mutually exclusive with ModeGoroutineOriented.
	const ThreadStateInSyscall ThreadState = 0
	const ThreadStateInSyscallRuntime ThreadState = 1
	const ThreadStateRunning ThreadState = 2
	const ViewProc ViewType = "proc"
	const ViewThread ViewType = "thread"

The pages are generated with Golds v0.6.9-preview. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.