decoder

Documentation

Index

• Variables
• func UnmarshalYAML(input io.Reader) (builder.Builder, error)
• type AlertCondition
• type AlertThreshold
• type AlertValue
• type DashboardGraph
• type DashboardModel
• type DashboardPanel
• type DashboardRow
• type DashboardSingleStat
• type DashboardTable
• type DashboardText
• type DashboardVariable
• type GraphAlert
• type GraphAxes
• type GraphAxis
• type PrometheusTarget
• type Target
• type VariableConst
• type VariableCustom
• type VariableInterval
• type VariableQuery

Variables

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

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

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

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

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
	Threshold AlertThreshold
}

type AlertThreshold

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

type AlertValue

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

type DashboardGraph

type DashboardGraph struct {
	Title      string
	Span       float32 `yaml:",omitempty"`
	Height     string  `yaml:",omitempty"`
	Datasource string  `yaml:",omitempty"`
	Targets    []Target
	Axes       *GraphAxes  `yaml:",omitempty"`
	Alert      *GraphAlert `yaml:",omitempty"`
}

type DashboardModel

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

	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"`
}

type DashboardRow

type DashboardRow struct {
	Name   string
	Panels []DashboardPanel
}

type DashboardSingleStat

type DashboardSingleStat struct {
	Title      string
	Span       float32 `yaml:",omitempty"`
	Height     string  `yaml:",omitempty"`
	Datasource string  `yaml:",omitempty"`
	Unit       string
	ValueType  string `yaml:"value_type"`
	SparkLine  string `yaml:"sparkline"`
	Targets    []Target
	Thresholds [2]string
	Colors     [3]string
	Color      []string `yaml:",omitempty"`
}

type DashboardTable

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

type DashboardText

type DashboardText struct {
	Title    string
	Span     float32 `yaml:",omitempty"`
	Height   string  `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"`
}

type GraphAlert

type GraphAlert struct {
	Title            string
	EvaluateEvery    string `yaml:"evaluate_every"`
	For              string
	If               []AlertCondition
	Notify           *int64
	Message          string
	OnNoData         string `yaml:"on_no_data"`
	OnExecutionError string `yaml:"on_execution_error"`
}

type GraphAxes

type GraphAxes struct {
	Left   *GraphAxis
	Right  *GraphAxis
	Bottom *GraphAxis
}

type GraphAxis

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

type PrometheusTarget

type PrometheusTarget struct {
	Query  string
	Legend string `yaml:",omitempty"`
	Ref    string `yaml:",omitempty"`
}

type Target

type Target struct {
	Prometheus *PrometheusTarget
}

type VariableConst

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

type VariableCustom

type VariableCustom struct {
	Name      string
	Label     string
	Default   string
	ValuesMap map[string]string `yaml:"values_map"`
}

type VariableInterval

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

type VariableQuery

type VariableQuery struct {
	Name  string
	Label string

	Datasource string
	Request    string

	IncludeAll bool `yaml:"include_all"`
	DefaultAll bool `yaml:"default_all"`
}