batchinsights

Documentation

Index

• Constants
• func GetMetricID(metric *appinsights.MetricTelemetry) string
• func ListenForStats(config Config)
• func PrintSystemInfo()
• type AppInsightsService
  • func NewAppInsightsService(instrumentationKey string, poolID string, nodeID string, ...) AppInsightsService
  • func (service *AppInsightsService) UploadStats(stats NodeStats)
• type Config
  • func ValidateAndBuildConfig(userConfig UserConfig) (Config, error)
  • func (config Config) Print()
• type DisableConfig
  • func (d DisableConfig) String() string
• type GPUStatsCollector
  • func NewGPUStatsCollector() GPUStatsCollector
  • func (gpu GPUStatsCollector) GetStats() []GPUUsage
  • func (gpu GPUStatsCollector) Shutdown()
• type GPUUsage
• type NodeStats
• type ProcessPerfInfo
  • func ListProcesses(processNames []string) ([]*ProcessPerfInfo, error)
• type UserConfig
  • func (config UserConfig) Merge(other UserConfig) UserConfig
  • func (config UserConfig) Print()

Constants

const DefaultAggregationTime = time.Duration(1) * time.Minute

DefaultAggregationTime default time range where metrics are preaggregated locally

const DefaultSamplingRate = time.Duration(5) * time.Second

DefaultSamplingRate default time between metrics sampling

const Version = "1.3.0"

Version Batch insights version

Functions

func GetMetricID

func GetMetricID(metric *appinsights.MetricTelemetry) string

GetMetricID compute an group id for this metric so it can be aggregated

func ListenForStats

func ListenForStats(config Config)

ListenForStats Start the sanpling of node metrics

func PrintSystemInfo

func PrintSystemInfo()

PrintSystemInfo print system info needed

Types

type AppInsightsService

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

AppInsightsService service handling the aggregation and upload of metrics

func NewAppInsightsService

func NewAppInsightsService(instrumentationKey string, poolID string, nodeID string, aggregation time.Duration) AppInsightsService

NewAppInsightsService create a new instance of the AppInsightsService

func (*AppInsightsService) UploadStats

func (service *AppInsightsService) UploadStats(stats NodeStats)

UploadStats will register the given stats for upload. They will be first aggregated during the given aggregation interval

type Config

type Config struct {
	PoolID             string
	NodeID             string
	InstrumentationKey string
	Processes          []string
	Aggregation        time.Duration
	SamplingRate       time.Duration
	Disable            DisableConfig
}

Config General config batch insights takes as input

func ValidateAndBuildConfig

func ValidateAndBuildConfig(userConfig UserConfig) (Config, error)

ValidateAndBuildConfig Convert Batch insights user config into config taken by the library

func (Config) Print

func (config Config) Print()

Print print the config to console

type DisableConfig

type DisableConfig struct {
	DiskIO    bool `json:"diskIO"`
	DiskUsage bool `json:"diskUsage"`
	NetworkIO bool `json:"networkIO"`
	GPU       bool `json:"gpu"`
	CPU       bool `json:"cpu"`
	Memory    bool `json:"memory"`
}

DisableConfig config showing which feature are disabled

func (DisableConfig) String

func (d DisableConfig) String() string

type GPUStatsCollector

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

GPUStatsCollector collector that retrieve gpu usage from nvml

func NewGPUStatsCollector

func NewGPUStatsCollector() GPUStatsCollector

NewGPUStatsCollector Create a new instance of the GPU stats collector

func (GPUStatsCollector) GetStats

func (gpu GPUStatsCollector) GetStats() []GPUUsage

GetStats Get GPU stats

func (GPUStatsCollector) Shutdown

func (gpu GPUStatsCollector) Shutdown()

Shutdown Dispose of the Nvidia driver connection

type GPUUsage

type GPUUsage struct {
	GPU    float64
	Memory float64
}

GPUUsage contains gpu stats

type NodeStats

type NodeStats struct {
	Memory      *mem.VirtualMemoryStat
	CPUPercents []float64
	DiskUsage   []*disk.UsageStat
	DiskIO      *utils.IOStats
	NetIO       *utils.IOStats
	Gpus        []GPUUsage
	Processes   []*ProcessPerfInfo
}

NodeStats Combined model for all metrics being collected at the given interal

type ProcessPerfInfo

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

ProcessPerfInfo Process specific information

func ListProcesses

func ListProcesses(processNames []string) ([]*ProcessPerfInfo, error)

ListProcesses Retrieve process cpu, memory, etc usage for the given list of process names

type UserConfig

type UserConfig struct {
	PoolID             *string
	NodeID             *string
	InstrumentationKey *string  // Application insights instrumentation key
	Processes          []string // List of process names to watch
	Aggregation        *int     // Local aggregation of data in minutes (default: 1)
	Disable            []string // List of metrics to disable
}

UserConfig config provided by the user either via command line, file or environemnt variable.

func (UserConfig) Merge

func (config UserConfig) Merge(other UserConfig) UserConfig

Merge with another config

func (UserConfig) Print

func (config UserConfig) Print()

Print print the config to console