grafana_dashboard

Documentation

Index

• Variables
• func DashboardFilename(documentBytes []byte, productName string) string
• func ToGrafanaDashboard(document v1.IndicatorDocument, indicatorType v1.IndicatorType) (*sdk.Board, error)
• func ToGrafanaDescription(docs map[string]string) *string
• func ToGrafanaPanel(spec v1.IndicatorSpec) *sdk.Panel
• func ToGrafanaThresholds(thresholds []v1.Threshold) []sdk.Threshold
• type GrafanaAnnotation
• type GrafanaAnnotations
• type GrafanaDashboard
• type GrafanaPanel
• type GrafanaRow
• type GrafanaTarget
• type GrafanaThreshold

Variables

var HEIGHT = 10

var WIDTH = 24

Functions

func DashboardFilename

func DashboardFilename(documentBytes []byte, productName string) string

func ToGrafanaDashboard

func ToGrafanaDashboard(document v1.IndicatorDocument, indicatorType v1.IndicatorType) (*sdk.Board, error)

func ToGrafanaDescription

func ToGrafanaDescription(docs map[string]string) *string

func ToGrafanaPanel

func ToGrafanaPanel(spec v1.IndicatorSpec) *sdk.Panel

func ToGrafanaThresholds

func ToGrafanaThresholds(thresholds []v1.Threshold) []sdk.Threshold

Types

type GrafanaAnnotation

type GrafanaAnnotation struct {
	Enable      bool   `json:"enable"`
	Expr        string `json:"expr"`
	TagKeys     string `json:"tagKeys"`
	TitleFormat string `json:"titleFormat"`
	IconColor   string `json:"iconColor"`
}

type GrafanaAnnotations

type GrafanaAnnotations struct {
	List []GrafanaAnnotation `json:"list"`
}

type GrafanaDashboard

type GrafanaDashboard struct {
	Title       string             `json:"title"`
	Rows        []GrafanaRow       `json:"rows"`
	Annotations GrafanaAnnotations `json:"annotations"`
}

GrafanaDashboards represent the layout of a dashboard in grafana. When `json.Marshall`ed, Grafana can load them from disk to populate its visualizations.

type GrafanaPanel

type GrafanaPanel struct {
	Title       string             `json:"title"`
	Type        string             `json:"type"`
	Description string             `json:"description,omitempty"`
	Targets     []GrafanaTarget    `json:"targets"`
	Thresholds  []GrafanaThreshold `json:"thresholds"`
}

type GrafanaRow

type GrafanaRow struct {
	Title  string         `json:"title"`
	Panels []GrafanaPanel `json:"panels"`
}

type GrafanaTarget

type GrafanaTarget struct {
	Expression string `json:"expr"`
}

type GrafanaThreshold

type GrafanaThreshold struct {
	Value     float64 `json:"value"`
	ColorMode string  `json:"colorMode"`
	Op        string  `json:"op"`
	Fill      bool    `json:"fill"`
	Line      bool    `json:"line"`
	Yaxis     string  `json:"yaxis"`
}