dashboard

Documentation

Index

• Constants
• func AddVariables(datasourceName string) []dashboard.Option
• func InlineLokiAlertParams(queryType, testName, genName string) string
• func RPSPanel(dataSource string, query map[string]string) row.Option
• func RPSVUPerScheduleSegmentsPanel(dataSource string, query map[string]string) row.Option
• func WASPDebugDataRow(dataSource string, query map[string]string, collapse bool) dashboard.Option
• func WASPLoadStatsRow(dataSource string, query map[string]string) dashboard.Option
• type Dashboard
  • func NewDashboard(reqs []WaspAlert, opts []dashboard.Option) (*Dashboard, error)
  • func (m *Dashboard) Build(dashboardName, datasourceName string, requirements []WaspAlert) error
  • func (m *Dashboard) Deploy() (*grabana.Dashboard, error)
  • func (m *Dashboard) JSON() ([]byte, error)
• type WaspAlert

Constants

const (
	DefaultStatTextSize       = 12
	DefaultStatValueSize      = 20
	DefaultAlertEvaluateEvery = "10s"
	DefaultAlertFor           = "10s"
	DefaultDashboardUUID      = "Wasp"

	DefaultRequirementLabelKey = "requirement_name"
)

const (
	AlertTypeQuantile99 = "quantile_99"
	AlertTypeErrors     = "errors"
	AlertTypeTimeouts   = "timeouts"
)

Functions

func AddVariables

func AddVariables(datasourceName string) []dashboard.Option

func InlineLokiAlertParams

func InlineLokiAlertParams(queryType, testName, genName string) string

InlineLokiAlertParams is specific params for predefined alerts for wasp dashboard

func RPSPanel

func RPSPanel(dataSource string, query map[string]string) row.Option

func RPSVUPerScheduleSegmentsPanel

func RPSVUPerScheduleSegmentsPanel(dataSource string, query map[string]string) row.Option

func WASPDebugDataRow

func WASPDebugDataRow(dataSource string, query map[string]string, collapse bool) dashboard.Option

func WASPLoadStatsRow

func WASPLoadStatsRow(dataSource string, query map[string]string) dashboard.Option

Types

type Dashboard

type Dashboard struct {
	Name           string
	DataSourceName string
	Folder         string
	GrafanaURL     string
	GrafanaToken   string
	// contains filtered or unexported fields
}

Dashboard is a Wasp dashboard

func NewDashboard

func NewDashboard(reqs []WaspAlert, opts []dashboard.Option) (*Dashboard, error)

NewDashboard creates new dashboard

func (*Dashboard) Build

func (m *Dashboard) Build(dashboardName, datasourceName string, requirements []WaspAlert) error

Build creates dashboard instance

func (*Dashboard) Deploy

func (m *Dashboard) Deploy() (*grabana.Dashboard, error)

Deploy deploys this dashboard to some Grafana folder

func (*Dashboard) JSON

func (m *Dashboard) JSON() ([]byte, error)

JSON render dashboard as JSON

type WaspAlert

type WaspAlert struct {
	Name                 string
	AlertType            string
	TestName             string
	GenName              string
	RequirementGroupName string
	AlertIf              alert.ConditionEvaluator
	CustomAlert          timeseries.Option
}