metrics

Documentation

Index

• func GenerateMetrics(metricsCollections Collections) []*proto.StatsEntity
• func GenerateMetricsReportBundle(entities []*StatsEntityWrapper) core.Payload
• func GetCalculationMap() map[string]string
• func GetTimeMetrics(times []float64, metricType string) float64
• func NewStatsEntity(dims []*proto.Dimension, samples []*proto.SimpleMetric) *proto.StatsEntity
• type Collections
  • func SaveCollections(metricsCollections Collections, reports ...*proto.MetricsReport) Collections
• type Collector
• type CommonDim
  • func NewCommonDim(hostInfo *proto.HostInfo, conf *config.Config, nginxId string) *CommonDim
  • func (c *CommonDim) ToDimensions() []*proto.Dimension
• type MetricsHandler
• type MetricsReportBundle
• type NginxCollectorConfig
• type NginxSource
• type PerDimension
• type Source
• type StatsEntityWrapper
  • func NewStatsEntityWrapper(dims []*proto.Dimension, samples []*proto.SimpleMetric, ...) *StatsEntityWrapper

Functions

func GenerateMetrics

func GenerateMetrics(metricsCollections Collections) []*proto.StatsEntity

func GenerateMetricsReportBundle

func GenerateMetricsReportBundle(entities []*StatsEntityWrapper) core.Payload

func GetCalculationMap

func GetCalculationMap() map[string]string

func GetTimeMetrics

func GetTimeMetrics(times []float64, metricType string) float64

func NewStatsEntity

func NewStatsEntity(dims []*proto.Dimension, samples []*proto.SimpleMetric) *proto.StatsEntity

Types

type Collections

type Collections struct {
	Count int // this is the number of collections run.  Will use this to calculate the average.
	Data  map[string]PerDimension
}

func SaveCollections

func SaveCollections(metricsCollections Collections, reports ...*proto.MetricsReport) Collections

SaveCollections loops through one or more reports and get all the raw metrics for the Collections Note this function operate on the Collections struct data directly.

type Collector

type Collector interface {
	Collect(ctx context.Context, wg *sync.WaitGroup, m chan<- *StatsEntityWrapper)
	UpdateConfig(config *config.Config)
}

type CommonDim

type CommonDim struct {
	SystemId, Hostname, InstanceTags, InstanceGroup,
	DisplayName, NginxId string

	PublishedAPI, NginxType, NginxBuild, NginxVersion,
	NginxBinPath, NginxConfPath string

	NginxAccessLogPaths []string
}

CommonDim is the set of dimensions that apply to all metrics

func NewCommonDim

func NewCommonDim(hostInfo *proto.HostInfo, conf *config.Config, nginxId string) *CommonDim

func (*CommonDim) ToDimensions

func (c *CommonDim) ToDimensions() []*proto.Dimension

ToDimensions returns the set of common agent dimensions Ensures dimensions are generated in the same order every time, as required by control plane

type MetricsHandler

type MetricsHandler func(float64, int) float64

type MetricsReportBundle

type MetricsReportBundle struct {
	Data []*proto.MetricsReport
}

type NginxCollectorConfig

type NginxCollectorConfig struct {
	NginxId            string
	StubStatus         string
	PlusAPI            string
	BinPath            string
	ConfPath           string
	CollectionInterval time.Duration
	AccessLogs         []string
	ErrorLogs          []string
	ClientVersion      int
}

type NginxSource

type NginxSource interface {
	Collect(ctx context.Context, wg *sync.WaitGroup, m chan<- *StatsEntityWrapper)
	Update(dimensions *CommonDim, collectorConf *NginxCollectorConfig)
	Stop()
}

type PerDimension

type PerDimension struct {
	Dimensions    []*proto.Dimension
	RunningSumMap map[string]float64
}

type Source

type Source interface {
	Collect(ctx context.Context, wg *sync.WaitGroup, m chan<- *StatsEntityWrapper)
}

type StatsEntityWrapper

type StatsEntityWrapper struct {
	Type proto.MetricsReport_Type
	Data *proto.StatsEntity
}

func NewStatsEntityWrapper

func NewStatsEntityWrapper(dims []*proto.Dimension, samples []*proto.SimpleMetric, seType proto.MetricsReport_Type) *StatsEntityWrapper