Documentation
¶
Index ¶
- Variables
- func UnmarshalYAML(input io.Reader) (dashboard.Builder, error)
- type Alert
- type AlertCondition
- type AlertGraphite
- type AlertLoki
- type AlertPrometheus
- type AlertStackdriver
- type AlertTarget
- type AzureLogTarget
- type DashboardExternalLink
- type DashboardGauge
- type DashboardGraph
- type DashboardHeatmap
- type DashboardInternalLink
- type DashboardLogs
- type DashboardModel
- type DashboardPanel
- type DashboardPanelLink
- type DashboardPanelLinks
- type DashboardRow
- type DashboardSingleStat
- type DashboardStat
- type DashboardTable
- type DashboardText
- type DashboardTimeSeries
- type DashboardVariable
- type GaugeThresholdStep
- type GraphAxes
- type GraphAxis
- type GraphSeriesOverride
- type GraphVisualization
- type GraphiteTarget
- type HeatmapTooltip
- type HeatmapYAxis
- type InfluxDBTarget
- type LogsTarget
- type LogsVisualization
- type LokiTarget
- type PrometheusTarget
- type StackdriverAlertAlignment
- type StackdriverAlertFilters
- type StackdriverAlignment
- type StackdriverFilters
- type StackdriverTarget
- type StatThresholdStep
- type Target
- type TimeSeriesAxis
- type TimeSeriesOverride
- type TimeSeriesOverrideMatcher
- type TimeSeriesOverrideProperties
- type TimeSeriesVisualization
- type VariableConst
- type VariableCustom
- type VariableDatasource
- type VariableInterval
- type VariableQuery
- type VariableText
Constants ¶
This section is empty.
Variables ¶
View Source
var ErrInvalidAlertOperand = fmt.Errorf("invalid alert operand")
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 ErrInvalidDeduplicationStrategy = fmt.Errorf("invalid deduplication strategy")
View Source
var ErrInvalidGaugeOrientation = fmt.Errorf("invalid gauge orientation")
View Source
var ErrInvalidGaugeThresholdMode = fmt.Errorf("invalid gauge threshold mode")
View Source
var ErrInvalidGaugeValueType = fmt.Errorf("invalid gauge value type")
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 ErrInvalidLineInterpolationMode = fmt.Errorf("invalid line interpolation mode")
View Source
var ErrInvalidLookback = fmt.Errorf("invalid lookback")
View Source
var ErrInvalidOverrideMatcher = fmt.Errorf("invalid override matcher")
View Source
var ErrInvalidSingleStatValueType = fmt.Errorf("invalid single stat value type")
View Source
var ErrInvalidSortOrder = fmt.Errorf("invalid sort order")
View Source
var ErrInvalidSparkLineMode = fmt.Errorf("invalid sparkline mode")
View Source
var ErrInvalidStackMode = fmt.Errorf("invalid stack mode")
View Source
var ErrInvalidStackdriverAggregation = fmt.Errorf("invalid stackdriver aggregation type")
View Source
var ErrInvalidStackdriverAlignment = fmt.Errorf("invalid stackdriver alignment method")
View Source
var ErrInvalidStackdriverPreprocessor = fmt.Errorf("invalid stackdriver preprocessor")
View Source
var ErrInvalidStackdriverType = fmt.Errorf("invalid stackdriver target type")
View Source
var ErrInvalidStatColorMode = fmt.Errorf("invalid stat color mode")
View Source
var ErrInvalidStatOrientation = fmt.Errorf("invalid orientation")
View Source
var ErrInvalidStatTextMode = fmt.Errorf("invalid text mode")
View Source
var ErrInvalidStatThresholdMode = fmt.Errorf("invalid stat threshold mode")
View Source
var ErrInvalidStatValueType = fmt.Errorf("invalid stat value type")
View Source
var ErrInvalidTimezone = fmt.Errorf("invalid timezone")
View Source
var ErrInvalidTooltipMode = fmt.Errorf("invalid tooltip mode")
View Source
var ErrMissingRef = fmt.Errorf("target ref missing")
View Source
var ErrNoAlertThresholdDefined = fmt.Errorf("no threshold defined")
View Source
var ErrNoConditionOnAlert = fmt.Errorf("no condition defined on alert")
View Source
var ErrNoTargetOnAlert = fmt.Errorf("no target defined on alert")
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 ¶
type Alert struct {
Summary string
Description string `yaml:",omitempty"`
Runbook string `yaml:",omitempty"`
Tags map[string]string `yaml:",omitempty"`
EvaluateEvery string `yaml:"evaluate_every"`
For string
OnNoData string `yaml:"on_no_data"`
OnExecutionError string `yaml:"on_execution_error"`
If []AlertCondition
Targets []AlertTarget
}
type AlertCondition ¶
type AlertCondition struct {
Operand *string `yaml:"operand,omitempty"`
// Query reducers, only one should be used
Avg *string `yaml:"avg,omitempty"`
Sum *string `yaml:"sum,omitempty"`
Count *string `yaml:"count,omitempty"`
Last *string `yaml:"last,omitempty"`
Min *string `yaml:"min,omitempty"`
Max *string `yaml:"max,omitempty"`
Median *string `yaml:"median,omitempty"`
Diff *string `yaml:"diff,omitempty"`
PercentDiff *string `yaml:"percent_diff,omitempty"`
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 AlertGraphite ¶
type AlertPrometheus ¶
type AlertStackdriver ¶
type AlertStackdriver struct {
Ref string `yaml:",omitempty"`
Lookback string `yaml:",omitempty"`
Project string `yaml:",omitempty"`
Type string
Metric string
Filters StackdriverAlertFilters `yaml:",omitempty"`
Aggregation string `yaml:",omitempty"`
Alignment *StackdriverAlertAlignment `yaml:",omitempty"`
Legend string `yaml:",omitempty"`
Preprocessor string `yaml:",omitempty"`
Hidden bool `yaml:",omitempty"`
GroupBy []string `yaml:"group_by,omitempty"`
}
type AlertTarget ¶
type AlertTarget struct {
Prometheus *AlertPrometheus `yaml:",omitempty"`
Loki *AlertLoki `yaml:",omitempty"`
Graphite *AlertGraphite `yaml:",omitempty"`
Stackdriver *AlertStackdriver `yaml:",omitempty"`
}
type AzureLogTarget ¶
type DashboardExternalLink ¶
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 DashboardGauge ¶
type DashboardGauge 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"`
RepeatDirection string `yaml:"repeat_direction,omitempty"`
Links DashboardPanelLinks `yaml:",omitempty"`
Targets []Target
Unit string `yaml:",omitempty"`
Decimals *int `yaml:",omitempty"`
Orientation string `yaml:",omitempty"`
ValueType string `yaml:"value_type,omitempty"`
TitleFontSize int `yaml:"title_font_size,omitempty"`
ValueFontSize int `yaml:"value_font_size,omitempty"`
ThresholdMode string `yaml:"threshold_mode,omitempty"`
Thresholds []GaugeThresholdStep `yaml:",omitempty"`
}
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"`
RepeatDirection string `yaml:"repeat_direction,omitempty"`
Targets []Target
Links DashboardPanelLinks `yaml:",omitempty"`
Axes *GraphAxes `yaml:",omitempty"`
Legend []string `yaml:",omitempty,flow"`
Alert *Alert `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"`
RepeatDirection string `yaml:"repeat_direction,omitempty"`
DataFormat string `yaml:"data_format,omitempty"`
HideZeroBuckets bool `yaml:"hide_zero_buckets"`
HighlightCards bool `yaml:"highlight_cards"`
Links DashboardPanelLinks `yaml:",omitempty"`
Targets []Target
ReverseYBuckets bool `yaml:"reverse_y_buckets,omitempty"`
Tooltip *HeatmapTooltip `yaml:",omitempty"`
YAxis *HeatmapYAxis `yaml:",omitempty"`
}
DashboardHeatmap represents a heatmap panel.
type DashboardInternalLink ¶
type DashboardInternalLink struct {
Title string `yaml:"title"`
Tags []string `yaml:"tags"`
AsDropdown bool `yaml:"as_dropdown,omitempty"`
IncludeTimeRange bool `yaml:"include_time_range,omitempty"`
IncludeVariableValues bool `yaml:"include_variable_values,omitempty"`
OpenInNewTab bool `yaml:"open_in_new_tab,omitempty"`
}
type DashboardLogs ¶
type DashboardLogs 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"`
RepeatDirection string `yaml:"repeat_direction,omitempty"`
Links DashboardPanelLinks `yaml:",omitempty"`
Targets []LogsTarget `yaml:",omitempty"`
Visualization *LogsVisualization `yaml:",omitempty"`
}
type DashboardModel ¶
type DashboardModel struct {
Title string
Slug string `yaml:",omitempty"`
UID string `yaml:"uid,omitempty"`
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"`
DashboardLinks []DashboardInternalLink `yaml:"dashboard_links,omitempty"`
Rows []DashboardRow
}
type DashboardPanel ¶
type DashboardPanel struct {
Graph *DashboardGraph `yaml:",omitempty"`
Table *DashboardTable `yaml:",omitempty"`
SingleStat *DashboardSingleStat `yaml:"single_stat,omitempty"`
Stat *DashboardStat `yaml:"stat,omitempty"`
Text *DashboardText `yaml:",omitempty"`
Heatmap *DashboardHeatmap `yaml:",omitempty"`
TimeSeries *DashboardTimeSeries `yaml:"timeseries,omitempty"`
Logs *DashboardLogs `yaml:"logs,omitempty"`
Gauge *DashboardGauge `yaml:"gauge,omitempty"`
}
type DashboardPanelLink ¶
type DashboardPanelLinks ¶
type DashboardPanelLinks []DashboardPanelLink
type DashboardRow ¶
type DashboardRow struct {
Name string
Repeat string `yaml:"repeat_for,omitempty"`
Collapse bool `yaml:",omitempty"`
HideTitle bool `yaml:"hide_title,omitempty"`
Panels []DashboardPanel
}
DashboardRow represents a dashboard row.
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"`
RepeatDirection string `yaml:"repeat_direction,omitempty"`
Links DashboardPanelLinks `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 DashboardStat ¶
type DashboardStat 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"`
RepeatDirection string `yaml:"repeat_direction,omitempty"`
Links DashboardPanelLinks `yaml:",omitempty"`
Targets []Target
Unit string `yaml:",omitempty"`
Decimals *int `yaml:",omitempty"`
SparkLine bool `yaml:"sparkline,omitempty"`
Orientation string `yaml:",omitempty"`
Text string `yaml:",omitempty"`
ValueType string `yaml:"value_type,omitempty"`
ColorMode string `yaml:"color_mode,omitempty"`
TitleFontSize int `yaml:"title_font_size,omitempty"`
ValueFontSize int `yaml:"value_font_size,omitempty"`
ThresholdMode string `yaml:"threshold_mode,omitempty"`
Thresholds []StatThresholdStep `yaml:",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"`
Links DashboardPanelLinks `yaml:",omitempty"`
Targets []Target
HiddenColumns []string `yaml:"hidden_columns,flow"`
TimeSeriesAggregations []table.Aggregation `yaml:"time_series_aggregations"`
}
DashboardTable represents a table panel.
type DashboardText ¶
type DashboardTimeSeries ¶
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"`
RepeatDirection string `yaml:"repeat_direction,omitempty"`
Links DashboardPanelLinks `yaml:",omitempty"`
Targets []Target
Legend []string `yaml:",omitempty,flow"`
Alert *Alert `yaml:",omitempty"`
Visualization *TimeSeriesVisualization `yaml:",omitempty"`
Axis *TimeSeriesAxis `yaml:",omitempty"`
Overrides []TimeSeriesOverride `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"`
Text *VariableText `yaml:",omitempty"`
}
type GaugeThresholdStep ¶
type GraphSeriesOverride ¶
type GraphVisualization ¶
type GraphVisualization struct {
NullValue string `yaml:",omitempty"`
Staircase bool `yaml:",omitempty"`
Overrides []GraphSeriesOverride `yaml:"overrides,omitempty"`
}
type GraphiteTarget ¶
type HeatmapTooltip ¶
type HeatmapYAxis ¶
type InfluxDBTarget ¶
type LogsTarget ¶
type LogsTarget struct {
Loki *LokiTarget `yaml:",omitempty"`
}
type LogsVisualization ¶
type LogsVisualization struct {
Time bool `yaml:",omitempty"`
UniqueLabels bool `yaml:"unique_labels,omitempty"`
CommonLabels bool `yaml:"common_labels,omitempty"`
WrapLines bool `yaml:"wrap_lines,omitempty"`
PrettifyJSON bool `yaml:"prettify_json,omitempty"`
HideLogDetails bool `yaml:"hide_log_details,omitempty"`
Order string `yaml:",omitempty"`
Deduplication string `yaml:",omitempty"`
}
type LokiTarget ¶
type PrometheusTarget ¶
type StackdriverAlertFilters ¶
type StackdriverAlignment ¶
type StackdriverFilters ¶
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"`
Preprocessor string `yaml:",omitempty"`
Ref string `yaml:",omitempty"`
Hidden bool `yaml:",omitempty"`
GroupBy []string `yaml:"group_by,omitempty"`
}
type StatThresholdStep ¶
type Target ¶
type Target struct {
Prometheus *PrometheusTarget `yaml:",omitempty"`
Graphite *GraphiteTarget `yaml:",omitempty"`
InfluxDB *InfluxDBTarget `yaml:"influxdb,omitempty"`
Stackdriver *StackdriverTarget `yaml:",omitempty"`
Loki *LokiTarget `yaml:",omitempty"`
AzureLog *AzureLogTarget `yaml:"azurelog,omitempty"`
}
type TimeSeriesAxis ¶
type TimeSeriesAxis struct {
SoftMin *int `yaml:"soft_min,omitempty"`
SoftMax *int `yaml:"soft_max,omitempty"`
Min *float64 `yaml:",omitempty"`
Max *float64 `yaml:",omitempty"`
Decimals *int `yaml:",omitempty"`
Display string `yaml:",omitempty"`
Scale string `yaml:",omitempty"`
Unit string `yaml:",omitempty"`
Label string `yaml:",omitempty"`
}
type TimeSeriesOverride ¶
type TimeSeriesOverride struct {
Matcher TimeSeriesOverrideMatcher `yaml:"match,flow"`
Properties TimeSeriesOverrideProperties
}
type TimeSeriesVisualization ¶
type TimeSeriesVisualization struct {
GradientMode string `yaml:"gradient_mode,omitempty"`
Tooltip string `yaml:"tooltip,omitempty"`
Stack string `yaml:"stack,omitempty"`
FillOpacity *int `yaml:"fill_opacity,omitempty"`
PointSize *int `yaml:"point_size,omitempty"`
LineInterpolation string `yaml:"line_interpolation,omitempty"`
LineWidth *int `yaml:"line_width,omitempty"`
}
type VariableConst ¶
type VariableCustom ¶
type VariableCustom struct {
Name string
Label string `yaml:",omitempty"`
Default string `yaml:",omitempty"`
ValuesMap map[string]string `yaml:"values_map"`
IncludeAll bool `yaml:"include_all"`
AllValue string `yaml:"all_value,omitempty"`
Hide string `yaml:",omitempty"`
Multiple bool `yaml:",omitempty"`
}
type VariableDatasource ¶
type VariableInterval ¶
type VariableQuery ¶
type VariableQuery struct {
Name string
Label string `yaml:",omitempty"`
Datasource string `yaml:",omitempty"`
Request string
Regex string `yaml:",omitempty"`
IncludeAll bool `yaml:"include_all"`
DefaultAll bool `yaml:"default_all"`
AllValue string `yaml:"all_value,omitempty"`
Hide string `yaml:",omitempty"`
Multiple bool `yaml:",omitempty"`
}
type VariableText ¶
Click to show internal directories.
Click to hide internal directories.