Documentation
¶
Index ¶
- Variables
- func UnmarshalYAML(input io.Reader) (dashboard.Builder, error)
- type Alert
- type AlertCondition
- type AlertThreshold
- type AlertValue
- type DashboardExternalLink
- type DashboardGraph
- type DashboardHeatmap
- type DashboardModel
- type DashboardPanel
- type DashboardRow
- type DashboardSingleStat
- type DashboardTable
- type DashboardText
- type DashboardTimeSeries
- type DashboardVariable
- 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 TimeSeriesAxis
- type TimeSeriesVisualization
- type VariableConst
- type VariableCustom
- type VariableDatasource
- type VariableInterval
- type VariableQuery
Constants ¶
This section is empty.
Variables ¶
View Source
var ErrInvalidAlertValueFunc = fmt.Errorf("invalid alert value function")
View Source
var ErrInvalidAxisDisplay = fmt.Errorf("invalid axis display")
View Source
var ErrInvalidAxisScale = fmt.Errorf("invalid axis scale")
View Source
var ErrInvalidColoringTarget = fmt.Errorf("invalid coloring target")
View Source
var ErrInvalidDataFormat = fmt.Errorf("invalid data format")
View Source
var ErrInvalidGradientMode = fmt.Errorf("invalid gradient mode")
View Source
var ErrInvalidHideValue = fmt.Errorf("invalid hide value. Valid values are: 'label', 'variable', empty")
View Source
var ErrInvalidLegendAttribute = fmt.Errorf("invalid legend attribute")
View Source
var ErrInvalidSingleStatValueType = fmt.Errorf("invalid single stat value type")
View Source
var ErrInvalidSparkLineMode = fmt.Errorf("invalid sparkline mode")
View Source
var ErrInvalidStackdriverAggregation = fmt.Errorf("invalid stackdriver aggregation type")
View Source
var ErrInvalidStackdriverAlignment = fmt.Errorf("invalid stackdriver alignment method")
View Source
var ErrInvalidStackdriverType = fmt.Errorf("invalid stackdriver target type")
View Source
var ErrInvalidTimezone = fmt.Errorf("invalid timezone")
View Source
var ErrInvalidTooltipMode = fmt.Errorf("invalid tooltip mode")
View Source
var ErrNoAlertThresholdDefined = fmt.Errorf("no threshold defined")
View Source
var ErrPanelNotConfigured = fmt.Errorf("panel not configured")
View Source
var ErrTargetNotConfigured = fmt.Errorf("target not configured")
View Source
var ErrVariableNotConfigured = fmt.Errorf("variable not configured")
Functions ¶
Types ¶
type Alert ¶ added in v0.19.0
type Alert 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 AlertCondition ¶ added in v0.6.0
type AlertCondition struct {
Operand string
Value AlertValue `yaml:",flow"`
Threshold AlertThreshold
}
type AlertThreshold ¶ added in v0.6.0
type AlertValue ¶ added in v0.6.0
type DashboardExternalLink ¶ added in v0.17.5
type DashboardExternalLink struct {
Title string
URL string `yaml:"url"`
Description string `yaml:",omitempty"`
Icon string `yaml:"icon,omitempty"`
IncludeTimeRange bool `yaml:"include_time_range,omitempty"`
IncludeVariableValues bool `yaml:"include_variable_values,omitempty"`
OpenInNewTab bool `yaml:"open_in_new_tab,omitempty"`
}
type DashboardGraph ¶ added in v0.6.0
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 *Alert `yaml:",omitempty"`
Visualization *GraphVisualization `yaml:",omitempty"`
}
type DashboardHeatmap ¶ added in v0.13.0
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"`
}
DashboardHeatmap represents a heatmap panel.
type DashboardModel ¶ added in v0.6.0
type DashboardModel struct {
Title string
Editable bool
Tags []string
AutoRefresh string `yaml:"auto_refresh"`
Time [2]string
Timezone string `yaml:",omitempty"`
TagsAnnotation []dashboard.TagAnnotation `yaml:"tags_annotations,omitempty"`
Variables []DashboardVariable `yaml:",omitempty"`
ExternalLinks []DashboardExternalLink `yaml:"external_links,omitempty"`
Rows []DashboardRow
}
type DashboardPanel ¶ added in v0.6.0
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"`
TimeSeries *DashboardTimeSeries `yaml:"timeseries,omitempty"`
}
type DashboardRow ¶ added in v0.6.0
type DashboardRow struct {
Name string
Repeat string `yaml:"repeat_for,omitempty"`
Collapse bool `yaml:",omitempty"`
Panels []DashboardPanel
}
DashboardRow represents a dashboard row.
type DashboardSingleStat ¶ added in v0.6.0
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 ¶ added in v0.6.0
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"`
}
DashboardTable represents a table panel.
type DashboardText ¶ added in v0.6.0
type DashboardTimeSeries ¶ added in v0.19.0
type DashboardTimeSeries 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
Legend []string `yaml:",omitempty,flow"`
Alert *Alert `yaml:",omitempty"`
Visualization *TimeSeriesVisualization `yaml:",omitempty"`
Axis *TimeSeriesAxis `yaml:",omitempty"`
}
type DashboardVariable ¶ added in v0.6.0
type DashboardVariable struct {
Interval *VariableInterval `yaml:",omitempty"`
Custom *VariableCustom `yaml:",omitempty"`
Query *VariableQuery `yaml:",omitempty"`
Const *VariableConst `yaml:",omitempty"`
Datasource *VariableDatasource `yaml:",omitempty"`
}
type GraphSeriesOverride ¶ added in v0.15.2
type GraphVisualization ¶ added in v0.12.11
type GraphVisualization struct {
NullValue string `yaml:",omitempty"`
Staircase bool `yaml:",omitempty"`
Overrides []GraphSeriesOverride `yaml:"overrides,omitempty"`
}
type GraphiteTarget ¶ added in v0.14.0
type HeatmapTooltip ¶ added in v0.13.0
type HeatmapYAxis ¶ added in v0.17.0
type InfluxDBTarget ¶ added in v0.15.0
type PrometheusTarget ¶ added in v0.6.0
type StackdriverAlignment ¶ added in v0.11.0
type StackdriverFilters ¶ added in v0.11.0
type StackdriverTarget ¶ added in v0.11.0
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:"group_by,omitempty"`
}
type Target ¶ added in v0.6.0
type Target struct {
Prometheus *PrometheusTarget `yaml:",omitempty"`
Graphite *GraphiteTarget `yaml:",omitempty"`
InfluxDB *InfluxDBTarget `yaml:"influxdb,omitempty"`
Stackdriver *StackdriverTarget `yaml:",omitempty"`
}
type TimeSeriesAxis ¶ added in v0.19.0
type TimeSeriesAxis struct {
SoftMin *int `yaml:"soft_min,omitempty"`
SoftMax *int `yaml:"soft_max,omitempty"`
Min *int `yaml:",omitempty"`
Max *int `yaml:",omitempty"`
Decimals *int `yaml:",omitempty"`
Display string `yaml:",omitempty"`
Scale string `yaml:",omitempty"`
Unit string `yaml:",omitempty"`
Label string `yaml:",omitempty"`
}
type TimeSeriesVisualization ¶ added in v0.19.0
type VariableConst ¶ added in v0.6.0
type VariableCustom ¶ added in v0.6.0
type VariableDatasource ¶ added in v0.12.9
type VariableInterval ¶ added in v0.6.0
Click to show internal directories.
Click to hide internal directories.