stopwatch

Documentation

Overview

Package stopwatch is used to time things. Create a stopwatch with Start, then on success record the timing with Finish.

It's recommended you do not record errors, since they can have vastly different timings (maybe we add an Error method in the future and record a different event).

Index

• type FinishOpts
• type LapOpts
• type StartOpts
• type Stopwatch
  • func Start(ctx context.Context, logger *slog.Logger, operation string) *Stopwatch
  • func StartWith(ctx context.Context, logger *slog.Logger, operation string, opts StartOpts) *Stopwatch
  • func (sw *Stopwatch) Finish(ctx context.Context)
  • func (sw *Stopwatch) FinishWith(ctx context.Context, opts FinishOpts)
  • func (sw *Stopwatch) Lap(ctx context.Context)
  • func (sw *Stopwatch) LapWith(ctx context.Context, opts LapOpts)

Types

type FinishOpts

type FinishOpts struct {
	Logger       *slog.Logger
	Key          string
	ElapsedKey   string
	Milliseconds bool
	Level        slog.Level
}

type LapOpts

type LapOpts FinishOpts

type StartOpts

type StartOpts struct {
	Key   string
	Level slog.Level
}

type Stopwatch

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

func Start

func Start(ctx context.Context, logger *slog.Logger, operation string) *Stopwatch

func StartWith

func StartWith(ctx context.Context, logger *slog.Logger, operation string, opts StartOpts) *Stopwatch

func (*Stopwatch) Finish

func (sw *Stopwatch) Finish(ctx context.Context)

func (*Stopwatch) FinishWith

func (sw *Stopwatch) FinishWith(ctx context.Context, opts FinishOpts)

func (*Stopwatch) Lap

func (sw *Stopwatch) Lap(ctx context.Context)

func (*Stopwatch) LapWith

func (sw *Stopwatch) LapWith(ctx context.Context, opts LapOpts)