changelog

Documentation

Index

• Constants
• func New(p *plugin.AbstractPlugin) plugin.Plugin
• type Change
• type ChangeLog
  • func (c *ChangeLog) CompareMetrics(curMat *matrix.Matrix) map[string]map[string]struct{}
  • func (c *ChangeLog) Init(remote conf.Remote) error
  • func (c *ChangeLog) Run(dataMap map[string]*matrix.Matrix) ([]*matrix.Matrix, *util.Metadata, error)
• type Config
• type Entry

Constants

const (
	ObjectChangeLog = "change"

	Track = "track"

	Metric   = "metric"
	Label    = "label"
	Category = "category"
)

Constants for ChangeLog metrics and labels

Functions

func New

func New(p *plugin.AbstractPlugin) plugin.Plugin

New initializes a new instance of the ChangeLog plugin

Types

type Change

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

Change represents a single change entry in the ChangeLog

type ChangeLog

type ChangeLog struct {
	*plugin.AbstractPlugin
	// contains filtered or unexported fields
}

ChangeLog represents the main structure of the ChangeLog plugin

func (*ChangeLog) CompareMetrics

func (c *ChangeLog) CompareMetrics(curMat *matrix.Matrix) map[string]map[string]struct{}

CompareMetrics compares the metrics of the current and previous instances

func (*ChangeLog) Init

func (c *ChangeLog) Init(remote conf.Remote) error

Init initializes the ChangeLog plugin

func (*ChangeLog) Run

func (c *ChangeLog) Run(dataMap map[string]*matrix.Matrix) ([]*matrix.Matrix, *util.Metadata, error)

Run processes the data and generates ChangeLog instances

type Config

type Config struct {
	ChangeLogs []Entry `yaml:"ChangeLog"`
}

Config represents the structure of the ChangeLog configuration

type Entry

type Entry struct {
	Object        string   `yaml:"object"`
	Track         []string `yaml:"track"`
	PublishLabels []string `yaml:"publish_labels"`
	// contains filtered or unexported fields
}

Entry represents a single ChangeLog entry