spy

Documentation

Overview

Package spy contains an interface (Spy) and functionality to register new spies

Index

• Constants
• Variables
• func RegisterSpy(name string, cb SpyIntitializer)
• func ResolveAutoName(s string) string
• func SupportedExecSpies() []string
• type InitParams
• type Labels
  • func NewLabels() *Labels
  • func (l *Labels) ID() string
  • func (l *Labels) Set(key, val string)
  • func (l *Labels) Tags() map[string]string
• type ProfileType
  • func (t ProfileType) AggregationType() metadata.AggregationType
  • func (t ProfileType) IsCumulative() bool
  • func (t ProfileType) Units() metadata.Units
• type Resettable
• type Spy
• type SpyIntitializer
  • func StartFunc(name string) (SpyIntitializer, error)

Constants

const (
	ProfileCPU          ProfileType = "cpu"
	ProfileInuseObjects ProfileType = "inuse_objects"
	ProfileAllocObjects ProfileType = "alloc_objects"
	ProfileInuseSpace   ProfileType = "inuse_space"
	ProfileAllocSpace   ProfileType = "alloc_space"

	Go     = "gospy"
	EBPF   = "ebpfspy"
	Python = "pyspy"
	Ruby   = "rbspy"
)

Variables

var (
	SupportedSpies []string
)

Functions

func RegisterSpy

func RegisterSpy(name string, cb SpyIntitializer)

func ResolveAutoName

func ResolveAutoName(s string) string

func SupportedExecSpies

func SupportedExecSpies() []string

Types

type InitParams

type InitParams struct {
	Pid           int
	ProfileType   ProfileType
	SampleRate    uint32
	DisableGCRuns bool
	Logger        log.Logger
}

TODO: this interface is not the best as different spies have different arguments

type Labels

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

func NewLabels

func NewLabels() *Labels

func (*Labels) ID

func (l *Labels) ID() string

func (*Labels) Set

func (l *Labels) Set(key, val string)

func (*Labels) Tags

func (l *Labels) Tags() map[string]string

type ProfileType

type ProfileType string

func (ProfileType) AggregationType

func (t ProfileType) AggregationType() metadata.AggregationType

func (ProfileType) IsCumulative

func (t ProfileType) IsCumulative() bool

func (ProfileType) Units

func (t ProfileType) Units() metadata.Units

type Resettable

type Resettable interface {
	Reset()
}

type Spy

type Spy interface {
	Stop() error
	Snapshot(cb func(*Labels, []byte, uint64) error) error
}

type SpyIntitializer

type SpyIntitializer func(InitParams) (Spy, error)

func StartFunc

func StartFunc(name string) (SpyIntitializer, error)