api

Documentation

Index

• type DetectedProcess
• type ProcessDetectType
  • func (d ProcessDetectType) Name() string
• type ProcessEntity
  • func (e *ProcessEntity) SameWith(other *ProcessEntity) bool
  • func (e *ProcessEntity) String() string
• type ProcessInterface
• type ProcessListener

Types

type DetectedProcess

type DetectedProcess interface {
	// Pid of process in host
	Pid() int32
	// OriginalProcess is works for query the process data
	OriginalProcess() *process.Process
	// Entity of process, is related with backend entity
	Entity() *ProcessEntity
	// DetectType define the process find type
	DetectType() ProcessDetectType
	// ProfilingStat of process
	ProfilingStat() *profiling.Info
	// ExposePorts define which ports are exposed
	ExposePorts() []int
	// ExposeHosts define which hosts are exposed
	ExposeHosts() []string
}

DetectedProcess from the finder

type ProcessDetectType

type ProcessDetectType int8

const (
	Kubernetes ProcessDetectType
)

func (ProcessDetectType) Name

func (d ProcessDetectType) Name() string

type ProcessEntity

type ProcessEntity struct {
	Layer        string
	ServiceName  string
	InstanceName string
	ProcessName  string
	Labels       []string
}

ProcessEntity is related to backend entity concept

func (*ProcessEntity) SameWith

func (e *ProcessEntity) SameWith(other *ProcessEntity) bool

func (*ProcessEntity) String

func (e *ProcessEntity) String() string

type ProcessInterface

type ProcessInterface interface {
	// ID of process, it's provide by backend
	ID() string
	// Pid of process
	Pid() int32
	// DetectType of process, it decide how to find this process
	DetectType() ProcessDetectType
	// Entity of process in backend
	Entity() *ProcessEntity
	// ProfilingStat of process
	ProfilingStat() *profiling.Info
	// ExeName get execute file name
	ExeName() (string, error)
	// OriginalProcess from process library
	OriginalProcess() *process.Process
	// DetectProcess from finder
	DetectProcess() DetectedProcess

	// PortIsExpose check the port is exposed
	PortIsExpose(port int) bool
	// DetectNewExposePort add a new detected expose port
	DetectNewExposePort(port int)
	// ExposeHosts get all exposed hosts
	ExposeHosts() []string
}

type ProcessListener

type ProcessListener interface {
	// AddNewProcess detect new process
	AddNewProcess(pid int32, entities []ProcessInterface)
	// RemoveProcess process been dead
	RemoveProcess(pid int32, entities []ProcessInterface)
	// RecheckAllProcesses recheck all process with interval, make sure all processes synchronize success
	RecheckAllProcesses(processes map[int32][]ProcessInterface)
}