metrics

Documentation

Index

• Constants
• Variables
• type InfluxConfig
  • func DefaultInfluxConfig() *InfluxConfig
  • func (cfg *InfluxConfig) Export() *influxdb.Config
• type MetricSink
  • func NewMetricSink() *MetricSink
  • func (ms *MetricSink) Close() error
  • func (ms *MetricSink) EnableInflux(cfg *InfluxConfig) error
  • func (ms *MetricSink) FlushInflux(cfg *InfluxConfig) error
  • func (ms *MetricSink) Receive(m *cypress.Message) error
  • func (ms *MetricSink) RunHTTP(addr string) error
• type Metrics
  • func (m *Metrics) Execute(args []string) error
• type MetricsConfig
• type Plugin
  • func (p *Plugin) Description() string
  • func (p *Plugin) Receiver() (cypress.Receiver, error)

Constants

const (
	DefaultFlushDuration  = "10s"
	DefaultUserAgent      = "cypress/1"
	DefaultInfluxUsername = "cypress"
)

Variables

var ErrInvalidMetric = errors.New("invalid metric")

Types

type InfluxConfig

type InfluxConfig struct {
	Flush     cypress.Duration
	URL       string
	Username  string
	Password  string
	Database  string
	UserAgent string
}

func DefaultInfluxConfig

func DefaultInfluxConfig() *InfluxConfig

func (*InfluxConfig) Export

func (cfg *InfluxConfig) Export() *influxdb.Config

type MetricSink

type MetricSink struct {
	Registry metrics.Registry
}

func NewMetricSink

func NewMetricSink() *MetricSink

func (*MetricSink) Close

func (ms *MetricSink) Close() error

func (*MetricSink) EnableInflux

func (ms *MetricSink) EnableInflux(cfg *InfluxConfig) error

func (*MetricSink) FlushInflux

func (ms *MetricSink) FlushInflux(cfg *InfluxConfig) error

func (*MetricSink) Receive

func (ms *MetricSink) Receive(m *cypress.Message) error

func (*MetricSink) RunHTTP

func (ms *MetricSink) RunHTTP(addr string) error

type Metrics

type Metrics struct {
	HTTP   string `short:"l" long:"listen" description:"Port to run metrics HTTP service on"`
	Config string `short:"c" long:"config" description:"Configuration file of metrics"`
}

func (*Metrics) Execute

func (m *Metrics) Execute(args []string) error

type MetricsConfig

type MetricsConfig struct {
	HTTP   string
	Influx *InfluxConfig
}

type Plugin

type Plugin struct {
	Listen string `description:"host:port to run an internal HTTP server on"`
	Config string `description:"path to the metrics config file"`
}

func (*Plugin) Description

func (p *Plugin) Description() string

func (*Plugin) Receiver

func (p *Plugin) Receiver() (cypress.Receiver, error)