profiler

Documentation

Overview

Package profiler is for profilers

Index

• type Option
  • func Name(n string) Option
• type Options
• type Profiler
  • func NewProfiler(opts ...Option) Profiler

Types

type Option

type Option func(o *Options)

Option func signature

func Name

func Name(n string) Option

Name of the profile

type Options

type Options struct {
	// Name to use for the profile
	Name string
}

Options holds the options for profiler

type Profiler

type Profiler interface {
	// Start the profiler
	Start() error
	// Stop the profiler
	Stop() error
	// Name of the profiler
	String() string
}

Profiler interface

var (
	// DefaultProfiler holds the default profiler
	DefaultProfiler Profiler = NewProfiler()
)

func NewProfiler

func NewProfiler(opts ...Option) Profiler

NewProfiler returns new noop profiler