metrics

Documentation

Index

• Constants
• func AsBatch(msg *metrics_pb.MetricsMessage) (*influxdb.BatchPoints, error)
• func LoadInfluxConfig(src map[interface{}]interface{}) (*influxConfig, error)
• func LoadOutputFileConfig(src map[interface{}]interface{}) (*outputfileConfig, error)
• type Config
  • func LoadConfig(srcmap map[interface{}]interface{}) (*Config, error)
• type Formatter
• type Gauge
• type Handler
  • func NewInfluxDBMetricsHandler(cfg *influxConfig) (Handler, error)
  • func NewOutputFileMetricsHandler(cfg *outputfileConfig) (Handler, error)
• type HandlerType
• type Histogram
• type IntervalCounter
• type JsonFormatter
  • func (formatter *JsonFormatter) WriteTo(msg *metrics_pb.MetricsMessage, out io.Writer) error
• type Meter
• type Metric
• type PlainTextFormatter
  • func (PlainTextFormatter) WriteTo(msg *metrics_pb.MetricsMessage, out io.Writer) error
• type Registry
  • func NewRegistry(sourceId string, tags map[string]string) Registry
• type Timer
• type UsageRegistry
  • func NewUsageRegistry(sourceId string, tags map[string]string, closeNotify <-chan struct{}) UsageRegistry

Constants

const (
	DefaultMetricsReportInterval = 15 * time.Second
)

Functions

func AsBatch

func AsBatch(msg *metrics_pb.MetricsMessage) (*influxdb.BatchPoints, error)

func LoadInfluxConfig

func LoadInfluxConfig(src map[interface{}]interface{}) (*influxConfig, error)

func LoadOutputFileConfig

func LoadOutputFileConfig(src map[interface{}]interface{}) (*outputfileConfig, error)

Types

type Config

type Config struct {
	Handlers       []Handler
	Source         string
	Tags           map[string]string
	ReportInterval time.Duration
}

func LoadConfig

func LoadConfig(srcmap map[interface{}]interface{}) (*Config, error)

type Formatter

type Formatter interface {
	WriteTo(msg *metrics_pb.MetricsMessage, out io.Writer) error
}

type Gauge

type Gauge interface {
	metrics.Gauge
	Metric
}

Gauge represents a metric which is measuring a count and a rate

type Handler

type Handler interface {
	// AcceptMetrics is called when new metrics become available
	AcceptMetrics(message *metrics_pb.MetricsMessage)
}

Handler represents a sink for metric events

func NewInfluxDBMetricsHandler

func NewInfluxDBMetricsHandler(cfg *influxConfig) (Handler, error)

NewInfluxDBMetricsHandler creates a new HandlerTypeInfluxDB metrics ChannelReporter

func NewOutputFileMetricsHandler

func NewOutputFileMetricsHandler(cfg *outputfileConfig) (Handler, error)

Message handler that write node and link metrics to a file in json format

type HandlerType

type HandlerType string

HandlerType is used to define known handler types

const (
	HandlerTypeInfluxDB HandlerType = "influxdb"
	HandlerTypeJSONFile HandlerType = "jsonfile"
	HandlerTypeFile     HandlerType = "file"
)

type Histogram

type Histogram interface {
	Metric
	Clear()
	Update(int64)
}

Histogram represents a metric which is measuring the distribution of values for some measurement

type IntervalCounter

type IntervalCounter interface {
	Metric
	Update(intervalId string, time time.Time, value uint64)
}

IntervalCounter allows tracking counters which are bucketized by some interval

type JsonFormatter

type JsonFormatter struct{}

func (*JsonFormatter) WriteTo

func (formatter *JsonFormatter) WriteTo(msg *metrics_pb.MetricsMessage, out io.Writer) error

type Meter

type Meter interface {
	Metric
	Mark(int64)
}

Meter represents a metric which is measuring a count and a rate

type Metric

type Metric interface {
	Dispose()
}

Metric is the base functionality for all metrics types

type PlainTextFormatter

type PlainTextFormatter struct {
}

func (PlainTextFormatter) WriteTo

func (PlainTextFormatter) WriteTo(msg *metrics_pb.MetricsMessage, out io.Writer) error

type Registry

type Registry interface {
	SourceId() string
	Gauge(name string) Gauge
	FuncGauge(name string, f func() int64) Gauge
	Meter(name string) Meter
	Histogram(name string) Histogram
	Timer(name string) Timer
	EachMetric(visitor func(name string, metric Metric))

	IsValidMetric(name string) bool
	Poll() *metrics_pb.MetricsMessage
	DisposeAll()
}

Registry allows for configuring and accessing metrics for a fabric application

func NewRegistry

func NewRegistry(sourceId string, tags map[string]string) Registry

type Timer

type Timer interface {
	Metric
	Time(func())
	Update(time.Duration)
	UpdateSince(time.Time)
}

type UsageRegistry

type UsageRegistry interface {
	Registry
	PollWithoutUsageMetrics() *metrics_pb.MetricsMessage
	IntervalCounter(name string, intervalSize time.Duration) IntervalCounter
	FlushToHandler(handler Handler)
	Flush()
	StartReporting(eventSink Handler, reportInterval time.Duration, msgQueueSize int)
}

UsageRegistry extends registry to allow collecting usage metrics

func NewUsageRegistry

func NewUsageRegistry(sourceId string, tags map[string]string, closeNotify <-chan struct{}) UsageRegistry