process

Documentation

Index

• Variables
• type Cache
• type DebuginfoManager
• type Info
  • func (i Info) Labels(ctx context.Context) (model.LabelSet, error)
• type InfoManager
  • func NewInfoManager(logger log.Logger, tracer trace.Tracer, reg prometheus.Registerer, ...) *InfoManager
  • func (im *InfoManager) Close() error
  • func (im *InfoManager) Fetch(ctx context.Context, pid int) (Info, error)
  • func (im *InfoManager) FetchWithFreshMappings(ctx context.Context, pid int) (Info, error)
  • func (im *InfoManager) Info(ctx context.Context, pid int) (Info, error)
  • func (im *InfoManager) Run(ctx context.Context) error
• type LabelManager
• type MapManager
  • func NewMapManager(reg prometheus.Registerer, fs procfs.FS, objFilePool *objectfile.Pool) *MapManager
  • func (mm *MapManager) MappingsForPID(pid int) (Mappings, error)
  • func (mm *MapManager) NewUserMapping(pm *procfs.ProcMap, pid int) (*Mapping, error)
• type Mapping
  • func (m *Mapping) AbsolutePath() string
  • func (m *Mapping) ExecutableInfo(addr uint64) (*profilestorepb.ExecutableInfo, error)
  • func (m *Mapping) Normalize(addr uint64) (uint64, error)
  • func (m *Mapping) Root() string
• type Mappings
  • func (ms Mappings) ConvertToPprof() []*profile.Mapping
  • func (ms Mappings) Executables() []*Mapping
  • func (ms Mappings) Hash() (uint64, error)
• type Tree
  • func NewTree(logger log.Logger, procfs procfs.FS, maxUpdateInterval time.Duration) *Tree
  • func (t *Tree) FindAllAncestorProcessIDsInSameCgroup(pid int) ([]int, error)
  • func (t *Tree) Run(ctx context.Context) error

Variables

var (
	ErrProcessMapNotFound = errors.New("perf-map not found")
	ErrProcNotFound       = errors.New("process not found")
)

Types

type Cache

type Cache[K comparable, V any] interface {
	Add(key K, value V)
	Get(key K) (V, bool)
	Peek(key K) (V, bool)
	Remove(key K)
}

type DebuginfoManager

type DebuginfoManager interface {
	ShouldInitiateUpload(ctx context.Context, buildID string) (bool, error)
	UploadMapping(ctx context.Context, m *Mapping) error
	Close() error
}

type Info

type Info struct {

	// - Unwind Information
	Interpreter *runtime.Interpreter
	Mappings    Mappings
	// contains filtered or unexported fields
}

func (Info) Labels

func (i Info) Labels(ctx context.Context) (model.LabelSet, error)

type InfoManager

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

func NewInfoManager

func NewInfoManager(
	logger log.Logger,
	tracer trace.Tracer,
	reg prometheus.Registerer,
	proceFS procfs.FS,
	objFilePool *objectfile.Pool,
	mm *MapManager,
	dim DebuginfoManager,
	lm LabelManager,
	profilingDuration time.Duration,
	cacheTTL time.Duration,
) *InfoManager

func (*InfoManager) Close

func (im *InfoManager) Close() error

func (*InfoManager) Fetch

func (im *InfoManager) Fetch(ctx context.Context, pid int) (Info, error)

func (*InfoManager) FetchWithFreshMappings

func (im *InfoManager) FetchWithFreshMappings(ctx context.Context, pid int) (Info, error)

func (*InfoManager) Info

func (im *InfoManager) Info(ctx context.Context, pid int) (Info, error)

Info returns the cached information for the given process.

func (*InfoManager) Run

func (im *InfoManager) Run(ctx context.Context) error

type LabelManager

type LabelManager interface {
	Fetch(ctx context.Context, pid int) error
	LabelSet(ctx context.Context, pid int) (model.LabelSet, error)
}

TODO: Unify PID types.

type MapManager

type MapManager struct {
	procfs.FS
	// contains filtered or unexported fields
}

func NewMapManager

func NewMapManager(
	reg prometheus.Registerer,
	fs procfs.FS,
	objFilePool *objectfile.Pool,
) *MapManager

func (*MapManager) MappingsForPID

func (mm *MapManager) MappingsForPID(pid int) (Mappings, error)

MappingsForPID returns all the mappings for the given PID.

func (*MapManager) NewUserMapping

func (mm *MapManager) NewUserMapping(pm *procfs.ProcMap, pid int) (*Mapping, error)

newUserMapping makes sure the mapped file is open and computes the kernel offset.

type Mapping

type Mapping struct {
	*procfs.ProcMap

	// Process related fields.
	PID int

	// This will be populated if mappping has executable and symbolizable.
	// We intentionally do NOT use an ObjectFile here.
	// So that it could be GCed and closed.
	// This is needed for pprof conversion.
	BuildID string

	IsJITDump bool

	// This mapping had no path associated with it. Usually this means the
	// mapping is a JIT compiled section.
	NoFileMapping bool
	// contains filtered or unexported fields
}

func (*Mapping) AbsolutePath

func (m *Mapping) AbsolutePath() string

AbsolutePath returns path relative to the root namespace of the system.

func (*Mapping) ExecutableInfo

func (m *Mapping) ExecutableInfo(addr uint64) (*profilestorepb.ExecutableInfo, error)

Normalize converts the given address to the address relative to the start of the object file.

func (*Mapping) Normalize

func (m *Mapping) Normalize(addr uint64) (uint64, error)

func (*Mapping) Root

func (m *Mapping) Root() string

Root returns the root filesystem of the process that owns the mapping.

type Mappings

type Mappings []*Mapping

func (Mappings) ConvertToPprof

func (ms Mappings) ConvertToPprof() []*profile.Mapping

func (Mappings) Executables

func (ms Mappings) Executables() []*Mapping

func (Mappings) Hash

func (ms Mappings) Hash() (uint64, error)

Hash produces a summary of the raw mappings. It only hashes the raw mappings, not the bookkeeping information.

type Tree

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

func NewTree

func NewTree(
	logger log.Logger,
	procfs procfs.FS,
	maxUpdateInterval time.Duration,
) *Tree

NewTree returns a new process tree with current state of all the processes on the system.

func (*Tree) FindAllAncestorProcessIDsInSameCgroup

func (t *Tree) FindAllAncestorProcessIDsInSameCgroup(pid int) ([]int, error)

FindAllAncestorProcessIDsInSameCgroup returns all ancestor process IDs for a given PID in the same cgroup.

func (*Tree) Run

func (t *Tree) Run(ctx context.Context) error

Run starts the process tree and update it periodically.