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, prevModResources *resources.PowerpipeModResources)
  • 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.ModTreeItemDiffs
	ChangedContainers          []*modconfig.ModTreeItemDiffs
	ChangedControls            []*modconfig.ModTreeItemDiffs
	ChangedBenchmarks          []*modconfig.ModTreeItemDiffs
	ChangedCategories          []*modconfig.ModTreeItemDiffs
	ChangedCards               []*modconfig.ModTreeItemDiffs
	ChangedCharts              []*modconfig.ModTreeItemDiffs
	ChangedDetections          []*modconfig.ModTreeItemDiffs
	ChangedDetectionBenchmarks []*modconfig.ModTreeItemDiffs
	ChangedFlows               []*modconfig.ModTreeItemDiffs
	ChangedGraphs              []*modconfig.ModTreeItemDiffs
	ChangedHierarchies         []*modconfig.ModTreeItemDiffs
	ChangedImages              []*modconfig.ModTreeItemDiffs
	ChangedInputs              []*modconfig.ModTreeItemDiffs
	ChangedTables              []*modconfig.ModTreeItemDiffs
	ChangedTexts               []*modconfig.ModTreeItemDiffs
	ChangedNodes               []*modconfig.ModTreeItemDiffs
	ChangedEdges               []*modconfig.ModTreeItemDiffs

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

	DeletedDashboards          []*resources.Dashboard
	DeletedContainers          []*resources.DashboardContainer
	DeletedControls            []*resources.Control
	DeletedBenchmarks          []*resources.Benchmark
	DeletedCards               []*resources.DashboardCard
	DeletedCategories          []*resources.DashboardCategory
	DeletedCharts              []*resources.DashboardChart
	DeletedDetections          []*resources.Detection
	DeletedDetectionBenchmarks []*resources.DetectionBenchmark
	DeletedFlows               []*resources.DashboardFlow
	DeletedGraphs              []*resources.DashboardGraph
	DeletedHierarchies         []*resources.DashboardHierarchy
	DeletedImages              []*resources.DashboardImage
	DeletedInputs              []*resources.DashboardInput
	DeletedTables              []*resources.DashboardTable
	DeletedTexts               []*resources.DashboardText
	DeletedNodes               []*resources.DashboardNode
	DeletedEdges               []*resources.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, prevModResources *resources.PowerpipeModResources)

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]steampipeconfig.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