Documentation
¶
Index ¶
- Variables
- func OutputError(ctx context.Context, err error)
- func OutputMessage(ctx context.Context, msg string)
- func OutputWait(ctx context.Context, msg string)
- func OutputWarning(ctx context.Context, msg string)
- func RunForService(ctx context.Context, serverListen ListenType, serverPort ListenPort) error
- func StopDashboardService(ctx context.Context) error
- func WriteServiceStateFile(state *DashboardServiceState) error
- type AvailableDashboardsPayload
- type ClientRequest
- type ClientRequestDashboardPayload
- type ClientRequestPayload
- type ControlEventPayload
- type DashboardClientInfo
- type DashboardMetadata
- type DashboardMetadataPayload
- type DashboardServiceState
- type DisplaySnapshotPayload
- type ErrorPayload
- type ExecutionCompletePayload
- type ExecutionErrorPayload
- type ExecutionStartedPayload
- type InputValuesClearedPayload
- type LeafNodeCompletePayload
- type ListenPort
- type ListenType
- type ModAvailableBenchmark
- type ModAvailableDashboard
- type ModDashboardMetadata
- type Server
- type ServiceState
Constants ¶
This section is empty.
Variables ¶
View Source
var ExecutionCompletePayloadSchemaVersion int64 = 20220929
View Source
var ExecutionStartedSchemaVersion int64 = 20220614
Functions ¶
func OutputError ¶ added in v0.17.0
func OutputMessage ¶
func OutputWait ¶
func OutputWarning ¶ added in v0.17.0
func RunForService ¶
func RunForService(ctx context.Context, serverListen ListenType, serverPort ListenPort) error
RunForService spanws an execution of the 'steampipe dashboard' command. It is used when starting/restarting the steampipe service with the --dashboard flag set
func StopDashboardService ¶
func WriteServiceStateFile ¶
func WriteServiceStateFile(state *DashboardServiceState) error
Types ¶
type AvailableDashboardsPayload ¶
type AvailableDashboardsPayload struct {
Action string `json:"action"`
Dashboards map[string]ModAvailableDashboard `json:"dashboards"`
Benchmarks map[string]ModAvailableBenchmark `json:"benchmarks"`
Snapshots map[string]string `json:"snapshots"`
}
type ClientRequest ¶
type ClientRequest struct {
Action string `json:"action"`
Payload ClientRequestPayload `json:"payload"`
}
type ClientRequestDashboardPayload ¶
type ClientRequestDashboardPayload struct {
FullName string `json:"full_name"`
}
type ClientRequestPayload ¶
type ClientRequestPayload struct {
Dashboard ClientRequestDashboardPayload `json:"dashboard"`
InputValues map[string]interface{} `json:"input_values"`
ChangedInput string `json:"changed_input"`
}
type ControlEventPayload ¶
type ControlEventPayload struct {
Action string `json:"action"`
Control controlstatus.ControlRunStatusProvider `json:"control"`
Name string `json:"name"`
Progress *controlstatus.ControlProgress `json:"progress"`
ExecutionId string `json:"execution_id"`
}
type DashboardClientInfo ¶
type DashboardMetadata ¶
type DashboardMetadata struct {
Mod *ModDashboardMetadata `json:"mod,omitempty"`
InstalledMods map[string]ModDashboardMetadata `json:"installed_mods,omitempty"`
Cloud *steampipeconfig.CloudMetadata `json:"cloud,omitempty"`
Telemetry string `json:"telemetry"`
}
type DashboardMetadataPayload ¶
type DashboardMetadataPayload struct {
Action string `json:"action"`
Metadata DashboardMetadata `json:"metadata"`
}
type DashboardServiceState ¶
type DashboardServiceState struct {
State ServiceState `json:"state"`
Error string `json:"error"`
Pid int `json:"pid"`
Port int `json:"port"`
ListenType string `json:"listen_type"`
Listen []string `json:"listen"`
StructVersion int64 `json:"struct_version"`
}
func GetDashboardServiceState ¶
func GetDashboardServiceState() (*DashboardServiceState, error)
func (*DashboardServiceState) Save ¶
func (s *DashboardServiceState) Save() error
type DisplaySnapshotPayload ¶ added in v0.17.0
type DisplaySnapshotPayload struct {
Action string `json:"action"`
SchemaVersion string `json:"schema_version"`
// snapshot is a map here as we cannot deserialise SteampipeSnapshot into a struct
// (without custom derserialisation code) as the Panels property is an interface
Snapshot map[string]any `json:"snapshot"`
ExecutionId string `json:"execution_id"`
}
type ErrorPayload ¶
type ExecutionCompletePayload ¶
type ExecutionCompletePayload struct {
Action string `json:"action"`
SchemaVersion string `json:"schema_version"`
Snapshot *dashboardtypes.SteampipeSnapshot `json:"snapshot"`
ExecutionId string `json:"execution_id"`
}
type ExecutionErrorPayload ¶
type ExecutionStartedPayload ¶
type ExecutionStartedPayload struct {
SchemaVersion string `json:"schema_version"`
Action string `json:"action"`
ExecutionId string `json:"execution_id"`
Panels map[string]dashboardtypes.SnapshotPanel `json:"panels"`
Layout *dashboardtypes.SnapshotTreeNode `json:"layout"`
Inputs map[string]interface{} `json:"inputs,omitempty"`
Variables map[string]string `json:"variables,omitempty"`
}
type LeafNodeCompletePayload ¶
type LeafNodeCompletePayload struct {
Action string `json:"action"`
DashboardNode dashboardtypes.DashboardNodeRun `json:"dashboard_node"`
ExecutionId string `json:"execution_id"`
}
type ListenPort ¶
type ListenPort int
func (ListenPort) IsValid ¶
func (lp ListenPort) IsValid() error
IsValid is a validator for ListenType known values
type ListenType ¶
type ListenType string
const ( ListenTypeLocal ListenType = "local" ListenTypeNetwork ListenType = "network" )
func (ListenType) IsValid ¶
func (lt ListenType) IsValid() error
IsValid is a validator for ListenType known values
type ModAvailableBenchmark ¶
type ModAvailableBenchmark struct {
Title string `json:"title,omitempty"`
FullName string `json:"full_name"`
ShortName string `json:"short_name"`
Tags map[string]string `json:"tags"`
IsTopLevel bool `json:"is_top_level"`
Children []ModAvailableBenchmark `json:"children,omitempty"`
Trunks [][]string `json:"trunks"`
ModFullName string `json:"mod_full_name"`
}
type ModAvailableDashboard ¶
type ModDashboardMetadata ¶
type Server ¶
type Server struct {
// contains filtered or unexported fields
}
func (*Server) HandleDashboardEvent ¶ added in v0.17.0
func (s *Server) HandleDashboardEvent(event dashboardevents.DashboardEvent)
type ServiceState ¶
type ServiceState string
const ( ServiceStateRunning ServiceState = "running" ServiceStateError ServiceState = "error" ServiceStateStructVersion = 20220411 )
Click to show internal directories.
Click to hide internal directories.