dashboardevents

Documentation

Index

• type ControlComplete
  • func (*ControlComplete) IsDashboardEvent()
• type ControlError
  • func (*ControlError) IsDashboardEvent()
• type DashboardChanged
  • func (c *DashboardChanged) AddChanged(item modconfig.ModTreeItem)
  • func (c *DashboardChanged) HasChanges() bool
  • func (*DashboardChanged) IsDashboardEvent()
  • func (c *DashboardChanged) SetParentsChanged(item modconfig.ModTreeItem, prevResourceMaps *modconfig.ResourceMaps)
  • func (c *DashboardChanged) WalkChangedResources(resourceFunc func(item modconfig.ModTreeItem) (bool, error)) error
• type DashboardEvent
• type DashboardEventHandler
• type ExecutionComplete
  • func (*ExecutionComplete) IsDashboardEvent()
• type ExecutionError
  • func (*ExecutionError) IsDashboardEvent()
• type ExecutionStarted
  • func (*ExecutionStarted) IsDashboardEvent()
• type InputValuesCleared
  • func (*InputValuesCleared) IsDashboardEvent()
• type LeafNodeUpdated
  • func NewLeafNodeUpdate(r dashboardtypes.DashboardTreeRun, session, executionId string) (*LeafNodeUpdated, error)
  • func (*LeafNodeUpdated) IsDashboardEvent()
• type WorkspaceError
  • func (*WorkspaceError) IsDashboardEvent()

Types

type ControlComplete

type ControlComplete struct {
	Progress    *controlstatus.ControlProgress
	Control     controlstatus.ControlRunStatusProvider
	Name        string
	Session     string
	ExecutionId string
	Timestamp   time.Time
}

func (*ControlComplete) IsDashboardEvent

func (*ControlComplete) IsDashboardEvent()

IsDashboardEvent implements DashboardEvent interface

type ControlError

type ControlError struct {
	Control     controlstatus.ControlRunStatusProvider
	Progress    *controlstatus.ControlProgress
	Name        string
	Session     string
	ExecutionId string
	Timestamp   time.Time
}

func (*ControlError) IsDashboardEvent

func (*ControlError) IsDashboardEvent()

IsDashboardEvent implements DashboardEvent interface

type DashboardChanged

type DashboardChanged struct {
	ChangedDashboards  []*modconfig.DashboardTreeItemDiffs
	ChangedContainers  []*modconfig.DashboardTreeItemDiffs
	ChangedControls    []*modconfig.DashboardTreeItemDiffs
	ChangedBenchmarks  []*modconfig.DashboardTreeItemDiffs
	ChangedCategories  []*modconfig.DashboardTreeItemDiffs
	ChangedCards       []*modconfig.DashboardTreeItemDiffs
	ChangedCharts      []*modconfig.DashboardTreeItemDiffs
	ChangedFlows       []*modconfig.DashboardTreeItemDiffs
	ChangedGraphs      []*modconfig.DashboardTreeItemDiffs
	ChangedHierarchies []*modconfig.DashboardTreeItemDiffs
	ChangedImages      []*modconfig.DashboardTreeItemDiffs
	ChangedInputs      []*modconfig.DashboardTreeItemDiffs
	ChangedTables      []*modconfig.DashboardTreeItemDiffs
	ChangedTexts       []*modconfig.DashboardTreeItemDiffs
	ChangedNodes       []*modconfig.DashboardTreeItemDiffs
	ChangedEdges       []*modconfig.DashboardTreeItemDiffs

	NewDashboards  []*modconfig.Dashboard
	NewContainers  []*modconfig.DashboardContainer
	NewControls    []*modconfig.Control
	NewBenchmarks  []*modconfig.Benchmark
	NewCards       []*modconfig.DashboardCard
	NewCategories  []*modconfig.DashboardCategory
	NewCharts      []*modconfig.DashboardChart
	NewFlows       []*modconfig.DashboardFlow
	NewGraphs      []*modconfig.DashboardGraph
	NewHierarchies []*modconfig.DashboardHierarchy
	NewImages      []*modconfig.DashboardImage
	NewInputs      []*modconfig.DashboardInput
	NewTables      []*modconfig.DashboardTable
	NewTexts       []*modconfig.DashboardText
	NewNodes       []*modconfig.DashboardNode
	NewEdges       []*modconfig.DashboardEdge

	DeletedDashboards  []*modconfig.Dashboard
	DeletedContainers  []*modconfig.DashboardContainer
	DeletedControls    []*modconfig.Control
	DeletedBenchmarks  []*modconfig.Benchmark
	DeletedCards       []*modconfig.DashboardCard
	DeletedCategories  []*modconfig.DashboardCategory
	DeletedCharts      []*modconfig.DashboardChart
	DeletedFlows       []*modconfig.DashboardFlow
	DeletedGraphs      []*modconfig.DashboardGraph
	DeletedHierarchies []*modconfig.DashboardHierarchy
	DeletedImages      []*modconfig.DashboardImage
	DeletedInputs      []*modconfig.DashboardInput
	DeletedTables      []*modconfig.DashboardTable
	DeletedTexts       []*modconfig.DashboardText
	DeletedNodes       []*modconfig.DashboardNode
	DeletedEdges       []*modconfig.DashboardEdge
}

func (*DashboardChanged) AddChanged

func (c *DashboardChanged) AddChanged(item modconfig.ModTreeItem)

func (*DashboardChanged) HasChanges

func (c *DashboardChanged) HasChanges() bool

func (*DashboardChanged) IsDashboardEvent

func (*DashboardChanged) IsDashboardEvent()

IsDashboardEvent implements DashboardEvent interface

func (*DashboardChanged) SetParentsChanged

func (c *DashboardChanged) SetParentsChanged(item modconfig.ModTreeItem, prevResourceMaps *modconfig.ResourceMaps)

func (*DashboardChanged) WalkChangedResources

func (c *DashboardChanged) WalkChangedResources(resourceFunc func(item modconfig.ModTreeItem) (bool, error)) error

type DashboardEvent

type DashboardEvent interface {
	IsDashboardEvent()
}

type DashboardEventHandler

type DashboardEventHandler func(context.Context, DashboardEvent)

type ExecutionComplete

type ExecutionComplete struct {
	Root        dashboardtypes.DashboardTreeRun
	Session     string
	ExecutionId string
	Panels      map[string]dashboardtypes.SnapshotPanel
	Inputs      map[string]interface{}
	Variables   map[string]string
	SearchPath  []string
	StartTime   time.Time
	EndTime     time.Time
}

func (*ExecutionComplete) IsDashboardEvent

func (*ExecutionComplete) IsDashboardEvent()

IsDashboardEvent implements DashboardEvent interface

type ExecutionError

type ExecutionError struct {
	Error     error
	Session   string
	Timestamp time.Time
}

ExecutionError is an event which is sent if an error occusrs _before execution has started_ e.g. a failure to create the execution tree

func (*ExecutionError) IsDashboardEvent

func (*ExecutionError) IsDashboardEvent()

IsDashboardEvent implements DashboardEvent interface

type ExecutionStarted

type ExecutionStarted struct {
	Root        dashboardtypes.DashboardTreeRun `json:"dashboard"`
	Panels      map[string]any
	Session     string
	ExecutionId string
	Inputs      map[string]any
	Variables   map[string]string
	StartTime   time.Time
	// immutable representation of event data - to avoid mutation before we send it
	JsonData []byte
}

func (*ExecutionStarted) IsDashboardEvent

func (*ExecutionStarted) IsDashboardEvent()

IsDashboardEvent implements DashboardEvent interface

type InputValuesCleared

type InputValuesCleared struct {
	ClearedInputs []string
	Session       string
	ExecutionId   string
}

func (*InputValuesCleared) IsDashboardEvent

func (*InputValuesCleared) IsDashboardEvent()

IsDashboardEvent implements DashboardEvent interface

type LeafNodeUpdated

type LeafNodeUpdated struct {
	LeafNode    map[string]any
	Session     string
	ExecutionId string
	Timestamp   time.Time
}

func NewLeafNodeUpdate

func NewLeafNodeUpdate(r dashboardtypes.DashboardTreeRun, session, executionId string) (*LeafNodeUpdated, error)

func (*LeafNodeUpdated) IsDashboardEvent

func (*LeafNodeUpdated) IsDashboardEvent()

IsDashboardEvent implements DashboardEvent interface

type WorkspaceError

type WorkspaceError struct {
	Error error
}

func (*WorkspaceError) IsDashboardEvent

func (*WorkspaceError) IsDashboardEvent()

IsDashboardEvent implements DashboardEvent interface