profile

Documentation

Index

• type ProfilingService
  • func New(profileType string) (ProfilingService, error)
  • func NewWithOptions(profileType string, startProfilingFunc StartProfilingFunc) (ProfilingService, error)
• type StartProfilingFunc

Types

type ProfilingService

type ProfilingService interface {
	Start()
	Stop()
}

ProfilingService is the interface to this class' functionality.

func New

func New(profileType string) (ProfilingService, error)

New returns a new performance profile of the specified type.

func NewWithOptions

func NewWithOptions(
	profileType string,
	startProfilingFunc StartProfilingFunc,
) (ProfilingService, error)

NewWithOptions returns a new performance profile of the specified type with the ability to pass in the implementing profile interface..

type StartProfilingFunc

type StartProfilingFunc func(...func(*profile.Profile)) interface{ Stop() }

StartProfilingFunc is a function that will be invoked when profile start is requested. This method signature is just a type wrapper around the `Start()` signature from `github.com/pkg/profile`.