timing

Documentation

Overview

Package timing provides functions to record timing information.

Index

• type Stage
  • func Start(ctx context.Context, name string) (context.Context, *Stage)
  • func (st *Stage) End()

Types

type Stage

type Stage struct {
	// contains filtered or unexported fields
}

Stage represents a discrete unit of work that is being timed.

func Start

func Start(ctx context.Context, name string) (context.Context, *Stage)

Start starts and returns a new Stage named name.

Example usage to report the time used until the end of the current function:

ctx, st := timing.Start(ctx, "my_stage")
defer st.End()

func (*Stage) End

func (st *Stage) End()

End ends the stage. Child stages are recursively examined and also ended (although we expect them to have already been ended).