event

Documentation

Index

• func ListPublishers() []string
• type ConfigTemplate
• type MetricReading
• type MetricTemplate
• type Publisher
• type ValueTemplate

Functions

func ListPublishers

func ListPublishers() []string

ListPublishers list supported publishers

Types

type ConfigTemplate

type ConfigTemplate struct {
	Metrics []MetricTemplate `yaml:"metrics" json:"metrics"`
}

ConfigTemplate is the content of user config

type MetricReading

type MetricReading struct {
	ID    string      `json:"id"`
	SrcID string      `json:"src_id"`
	Time  int64       `json:"time"`
	Label string      `json:"label"`
	Data  interface{} `json:"data"`
	Unit  string      `json:"unit"`
}

MetricReading represents generic event

type MetricTemplate

type MetricTemplate struct {
	Label     string        `yaml:"label" json:"label"`
	Unit      string        `yaml:"unit" json:"unit"`
	Frequency time.Duration `yaml:"frequency" json:"frequency"`
	Template  ValueTemplate `yaml:"template" json:"template"`
}

MetricTemplate is readings parameter

type Publisher

type Publisher interface {
	Publish(ctx context.Context, e *MetricReading) error
	Close() error
}

Publisher defines the interface for event publisher

type ValueTemplate

type ValueTemplate struct {
	Type string      `yaml:"type" json:"type"`
	Min  interface{} `yaml:"min" json:"min"`
	Max  interface{} `yaml:"max" json:"max"`
}

ValueTemplate defines the generation arguments