profiler

Documentation

Overview

Package profiler is a public API golang apps should use to send data to pyroscope server. It is intentionally separate from the rest of the code.

The idea is that this API won't change much over time, while all the other code will.

Index

• Variables
• func TagWrapper(ctx context.Context, labels LabelSet, cb func(context.Context))
• type Config
• type LabelSet
• type ProfileType
• type Profiler
  • func Start(cfg Config) (*Profiler, error)
  • func (p *Profiler) Stop() error

Variables

var (
	ProfileCPU          = spy.ProfileCPU
	ProfileAllocObjects = spy.ProfileAllocObjects
	ProfileAllocSpace   = spy.ProfileAllocSpace
	ProfileInuseObjects = spy.ProfileInuseObjects
	ProfileInuseSpace   = spy.ProfileInuseSpace
)

var Labels = pprof.Labels

Functions

func TagWrapper

func TagWrapper(ctx context.Context, labels LabelSet, cb func(context.Context))

Types

type Config

type Config struct {
	ApplicationName string // e.g backend.purchases
	Tags            map[string]string
	ServerAddress   string // e.g http://pyroscope.services.internal:4040
	AuthToken       string // specify this token when using pyroscope cloud
	SampleRate      uint32
	Logger          log.Logger
	ProfileTypes    []ProfileType
	DisableGCRuns   bool // this will disable automatic runtime.GC runs
}

type LabelSet

type LabelSet = pprof.LabelSet

type ProfileType

type ProfileType = spy.ProfileType

type Profiler

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

func Start

func Start(cfg Config) (*Profiler, error)

Start starts continuously profiling go code

func (*Profiler) Stop

func (p *Profiler) Stop() error

Stop stops continuous profiling session