profiler

Documentation

Index

• type EfficientBuffer
  • func (eb *EfficientBuffer) PutInt16(v int16)
  • func (eb *EfficientBuffer) PutUint16(v uint16)
  • func (eb *EfficientBuffer) PutUint32(v uint32)
  • func (eb *EfficientBuffer) PutUint64(v uint64)
  • func (eb *EfficientBuffer) PutUint8(v uint8)
  • func (eb *EfficientBuffer) Slice(size int) EfficientBuffer
• type FileStore
  • func NewFileStore(dirPath string) *FileStore
  • func (fw *FileStore) Store(_ context.Context, labels model.LabelSet, prof profile.Writer, ...) error
• type NoopProfiler
  • func (p *NoopProfiler) FailedReasons() map[int]UnwindFailedReasons
  • func (p *NoopProfiler) LastError() error
  • func (p *NoopProfiler) LastProfileStartedAt() time.Time
  • func (p *NoopProfiler) Name() string
  • func (p *NoopProfiler) ProcessLastErrors() map[int]error
  • func (p *NoopProfiler) Run(_ context.Context) error
  • func (p *NoopProfiler) Stop()
• type PID
• type ProcessInfoManager
• type ProfileStore
• type RemoteStore
  • func NewRemoteStore(logger log.Logger, profileStoreClient profilestorepb.ProfileStoreServiceClient) *RemoteStore
  • func (rw *RemoteStore) Store(ctx context.Context, labels model.LabelSet, prof profile.Writer, ...) error
• type StackID
• type UnwindFailedReasons

Types

type EfficientBuffer

type EfficientBuffer []byte

func (*EfficientBuffer) PutInt16

func (eb *EfficientBuffer) PutInt16(v int16)

PutInt16 writes the passed int16 in little endian and advances the current slice.

func (*EfficientBuffer) PutUint16

func (eb *EfficientBuffer) PutUint16(v uint16)

PutUint16 writes the passed uint16 in little endian and advances the current slice.

func (*EfficientBuffer) PutUint32

func (eb *EfficientBuffer) PutUint32(v uint32)

PutUint32 writes the passed uint32 in little endian and advances the current slice.

func (*EfficientBuffer) PutUint64

func (eb *EfficientBuffer) PutUint64(v uint64)

PutUint64 writes the passed uint64 in little endian and advances the current slice.

func (*EfficientBuffer) PutUint8

func (eb *EfficientBuffer) PutUint8(v uint8)

PutUint8 writes the passed uint8 in little endian and advances the current slice.

func (*EfficientBuffer) Slice

func (eb *EfficientBuffer) Slice(size int) EfficientBuffer

Slice returns a slice re-sliced from the original EfficientBuffer. This is useful to efficiently write byte by byte, for example, when setting BPF maps without incurring in extra allocations in the writing methods, or changing the capacity of the underlying memory buffer.

Callers are responsible to ensure that there is enough capacity left for the passed size.

type FileStore

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

FileStore writes profiles to a local file.

func NewFileStore

func NewFileStore(dirPath string) *FileStore

NewFileStore creates a new FileProfileWriter.

func (*FileStore) Store

func (fw *FileStore) Store(_ context.Context, labels model.LabelSet, prof profile.Writer, _ []*profilestorepb.ExecutableInfo) error

type NoopProfiler

type NoopProfiler struct{}

NoopProfiler does nothing. It serves as a skeleton of what other will have to be implemented when adding a new profiler.

func (*NoopProfiler) FailedReasons

func (p *NoopProfiler) FailedReasons() map[int]UnwindFailedReasons

func (*NoopProfiler) LastError

func (p *NoopProfiler) LastError() error

func (*NoopProfiler) LastProfileStartedAt

func (p *NoopProfiler) LastProfileStartedAt() time.Time

func (*NoopProfiler) Name

func (p *NoopProfiler) Name() string

func (*NoopProfiler) ProcessLastErrors

func (p *NoopProfiler) ProcessLastErrors() map[int]error

func (*NoopProfiler) Run

func (p *NoopProfiler) Run(_ context.Context) error

func (*NoopProfiler) Stop

func (p *NoopProfiler) Stop()

type PID

type PID int32

PID is the process ID of the profiling target. See https://ftp.gnu.org/old-gnu/Manuals/glibc-2.2.3/html_node/libc_554.html

type ProcessInfoManager

type ProcessInfoManager interface {
	Fetch(ctx context.Context, pid int) (process.Info, error)
	FetchWithFreshMappings(ctx context.Context, pid int) (process.Info, error)
	Info(ctx context.Context, pid int) (process.Info, error)
}

TODO: Unify PID types.

type ProfileStore

type ProfileStore interface {
	Store(ctx context.Context, labels model.LabelSet, wrt profile.Writer, executableInfo []*profilestorepb.ExecutableInfo) error
}

type RemoteStore

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

RemoteStore is a profile writer that writes profiles to a remote profile store.

func NewRemoteStore

func NewRemoteStore(logger log.Logger, profileStoreClient profilestorepb.ProfileStoreServiceClient) *RemoteStore

NewRemoteStore creates a new RemoteProfileWriter.

func (*RemoteStore) Store

func (rw *RemoteStore) Store(ctx context.Context, labels model.LabelSet, prof profile.Writer, ei []*profilestorepb.ExecutableInfo) error

Store sends the profile using the designated write client.

type StackID

type StackID struct {
	PID PID
	TID PID
}

StackID consists of two parts: the first part is the process ID of the profiling target, the second part is the thread ID of the stack trace has been collected from.

type UnwindFailedReasons

type UnwindFailedReasons struct {
	PcNotCovered        uint32
	NoUnwindInfo        uint32
	MissedFilter        uint32
	MappingNotFound     uint32
	ChunkNotFound       uint32
	NullUnwindTable     uint32
	TableNotFound       uint32
	RbpFailed           uint32
	RaFailed            uint32
	UnsupportedFpAction uint32
	UnsupportedCfa      uint32
	PreviousRspZero     uint32
	PreviousRipZero     uint32
	PreviousRbpZero     uint32
	InternalError       uint32
}