decoder

Documentation

Index

• Variables
• func UnmarshalYAML(input io.Reader) (builder.Builder, error)
• type AlertCondition
• type AlertThreshold
• type AlertValue
• type DashboardGraph
• type DashboardHeatmap
• type DashboardModel
• type DashboardPanel
• type DashboardRow
• type DashboardSingleStat
• type DashboardTable
• type DashboardText
• type DashboardVariable
• type GraphAlert
• type GraphAxes
• type GraphAxis
• type GraphSeriesOverride
• type GraphVisualization
• type GraphiteTarget
• type HeatmapTooltip
• type HeatmapYAxis
• type InfluxDBTarget
• type PrometheusTarget
• type StackdriverAlignment
• type StackdriverFilters
• type StackdriverTarget
• type Target
• type VariableConst
• type VariableCustom
• type VariableDatasource
• type VariableInterval
• type VariableQuery

Variables

var ErrInvalidAlertValueFunc = fmt.Errorf("invalid alert value function")

var ErrInvalidColoringTarget = fmt.Errorf("invalid coloring target")

var ErrInvalidDataFormat = fmt.Errorf("invalid data format")

var ErrInvalidHideValue = fmt.Errorf("invalid hide value. Valid values are: 'label', 'variable', empty")

var ErrInvalidLegendAttribute = fmt.Errorf("invalid legend attribute")

var ErrInvalidSingleStatValueType = fmt.Errorf("invalid single stat value type")

var ErrInvalidSparkLineMode = fmt.Errorf("invalid sparkline mode")

var ErrInvalidStackdriverAggregation = fmt.Errorf("invalid stackdriver aggregation type")

var ErrInvalidStackdriverAlignment = fmt.Errorf("invalid stackdriver alignment method")

var ErrInvalidStackdriverType = fmt.Errorf("invalid stackdriver target type")

var ErrInvalidTimezone = fmt.Errorf("invalid timezone")

var ErrNoAlertThresholdDefined = fmt.Errorf("no threshold defined")

var ErrPanelNotConfigured = fmt.Errorf("panel not configured")

var ErrTargetNotConfigured = fmt.Errorf("target not configured")

var ErrVariableNotConfigured = fmt.Errorf("variable not configured")

Functions

func UnmarshalYAML

func UnmarshalYAML(input io.Reader) (builder.Builder, error)

Types

type AlertCondition

type AlertCondition struct {
	Operand   string
	Value     AlertValue `yaml:",flow"`
	Threshold AlertThreshold
}

type AlertThreshold

type AlertThreshold struct {
	HasNoValue   bool       `yaml:"has_no_value,omitempty"`
	Above        *float64   `yaml:",omitempty"`
	Below        *float64   `yaml:",omitempty"`
	OutsideRange [2]float64 `yaml:"outside_range,omitempty,flow"`
	WithinRange  [2]float64 `yaml:"within_range,omitempty,flow"`
}

type AlertValue

type AlertValue struct {
	Func     string
	QueryRef string `yaml:"ref"`
	From     string
	To       string
}

type DashboardGraph

type DashboardGraph struct {
	Title         string
	Description   string  `yaml:",omitempty"`
	Span          float32 `yaml:",omitempty"`
	Height        string  `yaml:",omitempty"`
	Transparent   bool    `yaml:",omitempty"`
	Datasource    string  `yaml:",omitempty"`
	Repeat        string  `yaml:",omitempty"`
	Targets       []Target
	Axes          *GraphAxes          `yaml:",omitempty"`
	Legend        []string            `yaml:",omitempty,flow"`
	Alert         *GraphAlert         `yaml:",omitempty"`
	Visualization *GraphVisualization `yaml:",omitempty"`
}

type DashboardHeatmap

type DashboardHeatmap struct {
	Title           string
	Description     string  `yaml:",omitempty"`
	Span            float32 `yaml:",omitempty"`
	Height          string  `yaml:",omitempty"`
	Transparent     bool    `yaml:",omitempty"`
	Datasource      string  `yaml:",omitempty"`
	Repeat          string  `yaml:",omitempty"`
	DataFormat      string  `yaml:"data_format,omitempty"`
	HideZeroBuckets bool    `yaml:"hide_zero_buckets"`
	HighlightCards  bool    `yaml:"highlight_cards"`
	Targets         []Target
	ReverseYBuckets bool            `yaml:"reverse_y_buckets,omitempty"`
	Tooltip         *HeatmapTooltip `yaml:",omitempty"`
	YAxis           *HeatmapYAxis   `yaml:",omitempty"`
}

type DashboardModel

type DashboardModel struct {
	Title           string
	Editable        bool
	SharedCrosshair bool `yaml:"shared_crosshair"`
	Tags            []string
	AutoRefresh     string `yaml:"auto_refresh"`

	Time     [2]string
	Timezone string

	TagsAnnotation []dashboard.TagAnnotation `yaml:"tags_annotations"`
	Variables      []DashboardVariable

	Rows []DashboardRow
}

type DashboardPanel

type DashboardPanel struct {
	Graph      *DashboardGraph      `yaml:",omitempty"`
	Table      *DashboardTable      `yaml:",omitempty"`
	SingleStat *DashboardSingleStat `yaml:"single_stat,omitempty"`
	Text       *DashboardText       `yaml:",omitempty"`
	Heatmap    *DashboardHeatmap    `yaml:",omitempty"`
}

type DashboardRow

type DashboardRow struct {
	Name     string
	Repeat   string `yaml:"repeat_for,omitempty"`
	Collapse bool   `yaml:",omitempty"`
	Panels   []DashboardPanel
}

type DashboardSingleStat

type DashboardSingleStat struct {
	Title           string
	Description     string  `yaml:",omitempty"`
	Span            float32 `yaml:",omitempty"`
	Height          string  `yaml:",omitempty"`
	Transparent     bool    `yaml:",omitempty"`
	Datasource      string  `yaml:",omitempty"`
	Repeat          string  `yaml:",omitempty"`
	Unit            string
	Decimals        *int   `yaml:",omitempty"`
	ValueType       string `yaml:"value_type"`
	ValueFontSize   string `yaml:"value_font_size,omitempty"`
	PrefixFontSize  string `yaml:"prefix_font_size,omitempty"`
	PostfixFontSize string `yaml:"postfix_font_size,omitempty"`
	SparkLine       string `yaml:"sparkline"`
	Targets         []Target
	Thresholds      [2]string
	Colors          [3]string
	Color           []string              `yaml:",omitempty"`
	RangesToText    []singlestat.RangeMap `yaml:"ranges_to_text,omitempty"`
}

type DashboardTable

type DashboardTable struct {
	Title                  string
	Description            string  `yaml:",omitempty"`
	Span                   float32 `yaml:",omitempty"`
	Height                 string  `yaml:",omitempty"`
	Transparent            bool    `yaml:",omitempty"`
	Datasource             string  `yaml:",omitempty"`
	Targets                []Target
	HiddenColumns          []string            `yaml:"hidden_columns,flow"`
	TimeSeriesAggregations []table.Aggregation `yaml:"time_series_aggregations"`
}

type DashboardText

type DashboardText struct {
	Title       string
	Description string  `yaml:",omitempty"`
	Span        float32 `yaml:",omitempty"`
	Height      string  `yaml:",omitempty"`
	Transparent bool    `yaml:",omitempty"`
	HTML        string  `yaml:",omitempty"`
	Markdown    string  `yaml:",omitempty"`
}

type DashboardVariable

type DashboardVariable struct {
	Interval   *VariableInterval   `yaml:",omitempty"`
	Custom     *VariableCustom     `yaml:",omitempty"`
	Query      *VariableQuery      `yaml:",omitempty"`
	Const      *VariableConst      `yaml:",omitempty"`
	Datasource *VariableDatasource `yaml:",omitempty"`
}

type GraphAlert

type GraphAlert struct {
	Title            string
	EvaluateEvery    string `yaml:"evaluate_every"`
	For              string
	If               []AlertCondition
	Notify           string            `yaml:",omitempty"`
	Notifications    []string          `yaml:",omitempty,flow"`
	Message          string            `yaml:",omitempty"`
	OnNoData         string            `yaml:"on_no_data"`
	OnExecutionError string            `yaml:"on_execution_error"`
	Tags             map[string]string `yaml:",omitempty"`
}

type GraphAxes

type GraphAxes struct {
	Left   *GraphAxis `yaml:",omitempty"`
	Right  *GraphAxis `yaml:",omitempty"`
	Bottom *GraphAxis `yaml:",omitempty"`
}

type GraphAxis

type GraphAxis struct {
	Hidden  *bool    `yaml:",omitempty"`
	Label   string   `yaml:",omitempty"`
	Unit    *string  `yaml:",omitempty"`
	Min     *float64 `yaml:",omitempty"`
	Max     *float64 `yaml:",omitempty"`
	LogBase int      `yaml:"log_base"`
}

type GraphSeriesOverride

type GraphSeriesOverride struct {
	Alias     string
	Color     string `yaml:",omitempty"`
	Dashes    *bool  `yaml:",omitempty"`
	Lines     *bool  `yaml:",omitempty"`
	Fill      *int   `yaml:",omitempty"`
	LineWidth *int   `yaml:"line_width,omitempty"`
}

type GraphVisualization

type GraphVisualization struct {
	NullValue string                `yaml:",omitempty"`
	Staircase bool                  `yaml:",omitempty"`
	Overrides []GraphSeriesOverride `yaml:"overrides,omitempty"`
}

type GraphiteTarget

type GraphiteTarget struct {
	Query  string
	Ref    string `yaml:",omitempty"`
	Hidden bool   `yaml:",omitempty"`
}

type HeatmapTooltip

type HeatmapTooltip struct {
	Show          bool
	ShowHistogram bool
	Decimals      *int `yaml:",omitempty"`
}

type HeatmapYAxis

type HeatmapYAxis struct {
	Decimals *int     `yaml:"decimals,omitempty"`
	Unit     string   `yaml:"unit,omitempty"`
	Max      *float64 `yaml:"max,omitempty"`
	Min      *float64 `yaml:"min,omitempty"`
}

type InfluxDBTarget

type InfluxDBTarget struct {
	Query  string
	Ref    string `yaml:",omitempty"`
	Hidden bool   `yaml:",omitempty"`
}

type PrometheusTarget

type PrometheusTarget struct {
	Query          string
	Legend         string `yaml:",omitempty"`
	Ref            string `yaml:",omitempty"`
	Hidden         bool   `yaml:",omitempty"`
	Format         string `yaml:",omitempty"`
	Instant        bool   `yaml:",omitempty"`
	IntervalFactor *int   `yaml:"interval_factor,omitempty"`
}

type StackdriverAlignment

type StackdriverAlignment struct {
	Method string
	Period string
}

type StackdriverFilters

type StackdriverFilters struct {
	Eq         map[string]string `yaml:",omitempty"`
	Neq        map[string]string `yaml:",omitempty"`
	Matches    map[string]string `yaml:",omitempty"`
	NotMatches map[string]string `yaml:"not_matches,omitempty"`
}

type StackdriverTarget

type StackdriverTarget struct {
	Project     string
	Type        string
	Metric      string
	Filters     StackdriverFilters    `yaml:",omitempty"`
	Aggregation string                `yaml:",omitempty"`
	Alignment   *StackdriverAlignment `yaml:",omitempty"`
	Legend      string                `yaml:",omitempty"`
	Ref         string                `yaml:",omitempty"`
	Hidden      bool                  `yaml:",omitempty"`
	GroupBy     []string              `yaml:",omitempty"`
}

type Target

type Target struct {
	Prometheus  *PrometheusTarget  `yaml:",omitempty"`
	Graphite    *GraphiteTarget    `yaml:",omitempty"`
	InfluxDB    *InfluxDBTarget    `yaml:"influxdb,omitempty"`
	Stackdriver *StackdriverTarget `yaml:",omitempty"`
}

type VariableConst

type VariableConst struct {
	Name      string
	Label     string
	Default   string
	ValuesMap map[string]string `yaml:"values_map"`
	Hide      string            `yaml:",omitempty"`
}

type VariableCustom

type VariableCustom struct {
	Name       string
	Label      string
	Default    string
	ValuesMap  map[string]string `yaml:"values_map"`
	IncludeAll bool              `yaml:"include_all"`
	AllValue   string            `yaml:"all_value,omitempty"`
	Hide       string            `yaml:",omitempty"`
}

type VariableDatasource

type VariableDatasource struct {
	Name  string
	Label string

	Type string

	Regex      string
	IncludeAll bool   `yaml:"include_all"`
	Hide       string `yaml:",omitempty"`
}

type VariableInterval

type VariableInterval struct {
	Name    string
	Label   string
	Default string
	Values  []string `yaml:",flow"`
	Hide    string   `yaml:",omitempty"`
}

type VariableQuery

type VariableQuery struct {
	Name  string
	Label string

	Datasource string
	Request    string

	Regex      string
	IncludeAll bool   `yaml:"include_all"`
	DefaultAll bool   `yaml:"default_all"`
	AllValue   string `yaml:"all_value,omitempty"`
	Hide       string `yaml:",omitempty"`
}