api

Documentation

Index

• Constants
• Variables
• func AvailableProfilingToolsString() string
• func GetDataStructByType(t EventType) interface{}
• func IsSupportedCompressor(compressor string) bool
• func IsSupportedContainerRuntime(runtime string) bool
• func IsSupportedEvent(event string) bool
• func IsSupportedLanguage(lang string) bool
• func IsSupportedLogLevel(event string) bool
• func IsSupportedOutputType(outputType string) bool
• func IsSupportedProfilingTool(profilingTool string) bool
• func IsValidOutputType(eventType EventType, profilingTool ProfilingTool) bool
• func IsValidProfilingTool(tool ProfilingTool, language ProgrammingLanguage) bool
• func ParseEvent(eventString string) (interface{}, error)
• func PublishError(err error)
• func PublishEvent(eventType EventType, data interface{}) error
• func PublishLogEvent(level LogLevel, msg string)
• type Compressor
  • func AvailableCompressors() []Compressor
• type ContainerRuntime
  • func AvailableContainerRuntimes() []ContainerRuntime
• type ErrorData
• type Event
• type EventType
  • func AvailableOutputTypes() []EventType
• type LogData
• type LogLevel
  • func AvailableLogLevels() []LogLevel
• type OutputData
• type ProfilingEvent
  • func AvailableEvents() []ProfilingEvent
• type ProfilingTool
  • func AvailableProfilingTools() []ProfilingTool
• type ProgrammingLanguage
  • func AvailableLanguages() []ProgrammingLanguage
• type ProgressData
• type ProgressStage

Constants

const (
	Error       EventType = "error"
	FlameGraph  EventType = "flamegraph"
	Jfr         EventType = "jfr"
	Raw         EventType = "raw"
	StackThread EventType = "stackthread"
	Progress    EventType = "progress"
	Log         EventType = "log"

	Started ProgressStage = "started"
	Ended   ProgressStage = "ended"
)

Variables

var GetContainerRuntimeRootPath = map[ContainerRuntime]string{
	Docker:     "/var/lib/docker/",
	Crio:       "/var/lib/containers/storage/",
	Containerd: "/run/containerd/",
}

var GetOutputTypesByProfilingTool = map[ProfilingTool][]EventType{
	AsyncProfiler: {FlameGraph, Jfr},
	Jcmd:          {Jfr},
	Pyspy:         {FlameGraph, Raw},
	Bpf:           {FlameGraph},
	Perf:          {FlameGraph},
	Rbspy:         {FlameGraph},
}

GetOutputTypesByProfilingTool Gets the list of EventType related to the ProfilingTool that they will be considered as output types. The first one is considered the default

var GetProfilingToolsByProgrammingLanguage = map[ProgrammingLanguage][]ProfilingTool{
	Java:   {AsyncProfiler, Jcmd},
	Python: {Pyspy},
	Go:     {Bpf},
	Node:   {Bpf, Perf},
	Ruby:   {Rbspy},
}

GetProfilingToolsByProgrammingLanguage Gets profiling tool related to the programming language. The first one is considered the default

var (
	ProfilingTools = []ProfilingTool{AsyncProfiler, Jcmd, Pyspy, Bpf, Perf, Rbspy}
)

Functions

func AvailableProfilingToolsString

func AvailableProfilingToolsString() string

func GetDataStructByType

func GetDataStructByType(t EventType) interface{}

func IsSupportedCompressor

func IsSupportedCompressor(compressor string) bool

func IsSupportedContainerRuntime

func IsSupportedContainerRuntime(runtime string) bool

func IsSupportedEvent

func IsSupportedEvent(event string) bool

func IsSupportedLanguage

func IsSupportedLanguage(lang string) bool

func IsSupportedLogLevel

func IsSupportedLogLevel(event string) bool

func IsSupportedOutputType

func IsSupportedOutputType(outputType string) bool

func IsSupportedProfilingTool

func IsSupportedProfilingTool(profilingTool string) bool

func IsValidOutputType

func IsValidOutputType(eventType EventType, profilingTool ProfilingTool) bool

IsValidOutputType Identifies if given EventType is valid for the also given ProfilingTool

func IsValidProfilingTool

func IsValidProfilingTool(tool ProfilingTool, language ProgrammingLanguage) bool

IsValidProfilingTool Identifies if given ProfilingTool is valid for the also given ProgrammingLanguage

func ParseEvent

func ParseEvent(eventString string) (interface{}, error)

func PublishError

func PublishError(err error)

func PublishEvent

func PublishEvent(eventType EventType, data interface{}) error

func PublishLogEvent

func PublishLogEvent(level LogLevel, msg string)

Types

type Compressor

type Compressor string

const (
	None   Compressor = "none"
	Snappy Compressor = "snappy"
	Gzip   Compressor = "gzip"
	Lzo    Compressor = "lzo"
	Zstd   Compressor = "zstd"
)

func AvailableCompressors

func AvailableCompressors() []Compressor

type ContainerRuntime

type ContainerRuntime string

const (
	Docker     ContainerRuntime = "docker"
	Crio       ContainerRuntime = "crio"
	Containerd ContainerRuntime = "containerd"
)

func AvailableContainerRuntimes

func AvailableContainerRuntimes() []ContainerRuntime

type ErrorData

type ErrorData struct {
	Reason string `json:"reason"`
}

type Event

type Event struct {
	Type EventType            `json:"type"`
	Data *jsoniter.RawMessage `json:"data"`
}

type EventType

type EventType string

func AvailableOutputTypes

func AvailableOutputTypes() []EventType

type LogData

type LogData struct {
	Time  time.Time `json:"time"`
	Level string    `json:"level"`
	Msg   string    `json:"msg"`
}

type LogLevel

type LogLevel string

const (
	InfoLevel  LogLevel = "info"
	WarnLevel  LogLevel = "warn"
	DebugLevel LogLevel = "debug"
	ErrorLevel LogLevel = "error"
)

func AvailableLogLevels

func AvailableLogLevels() []LogLevel

type OutputData

type OutputData struct {
	EncodedData string `json:"encoded_data"`
}

type ProfilingEvent

type ProfilingEvent string

const (
	Cpu         ProfilingEvent = "cpu"
	Alloc       ProfilingEvent = "alloc"
	Lock        ProfilingEvent = "lock"
	CacheMisses ProfilingEvent = "cache-misses"
	Wall        ProfilingEvent = "wall"
	Itimer      ProfilingEvent = "itimer"
)

func AvailableEvents

func AvailableEvents() []ProfilingEvent

type ProfilingTool

type ProfilingTool string

const (
	AsyncProfiler ProfilingTool = "async-profiler"
	Jcmd          ProfilingTool = "jcmd"
	Pyspy         ProfilingTool = "pyspy"
	Bpf           ProfilingTool = "bpf"
	Perf          ProfilingTool = "perf"
	Rbspy         ProfilingTool = "rbspy"
)

func AvailableProfilingTools

func AvailableProfilingTools() []ProfilingTool

type ProgrammingLanguage

type ProgrammingLanguage string

const (
	Java   ProgrammingLanguage = "java"
	Go     ProgrammingLanguage = "go"
	Python ProgrammingLanguage = "python"
	Ruby   ProgrammingLanguage = "ruby"
	Node   ProgrammingLanguage = "node"
	//Deprecated: NodeWithPerf is deprecated. This option will be removed. Use instead Node, that use BPF for running profiling
	NodeWithPerf ProgrammingLanguage = "node-perf"
)

func AvailableLanguages

func AvailableLanguages() []ProgrammingLanguage

type ProgressData

type ProgressData struct {
	Time  time.Time     `json:"time"`
	Stage ProgressStage `json:"stage"`
}

type ProgressStage

type ProgressStage string