Improved usability, telemetry, 9 new plugins →

Mod Resources

General

TypeDescription
localsLocals are internal, module level variables.
modThe mod block contains metadata, documentation, and dependency data for the mod.
queryQueries define common SQL statements that may be used alone, or referenced by arguments in other blocks like reports and actions.
variableVariables are module level objects that essentially act as parameters for a module.

Benchmarks and Controls

TypeDescription
benchmarkBenchmark provides a mechanism for organizing controls into hierarchical structures.
controlControls provide a defined structure and interface for queries that draw a specific conclusion (e.g. 'ok', 'alarm') about each row.

Dashboards

TypeDescriptionValid children typesAllowed at top-level
dashboardCompose resources to meet a reporting requirement. Within the steampipe dashboard UI, each dashboard will be presented as an available item to run.chart
container
control
card
hierarchy
image
input
table
text
Yes
containerLay out reporting resources within a dashboard. Conceptually similar to a dashboard, except it will not be presented as an available item to run within the steampipe dashboard UI.chart
container
control
card
hierarchy
image
input
table
text
Yes
chartVisualize SQL data in a chart e.g. bar, column, line, pie etc.NoneYes
cardDisplay a simple value in different styles e.g. plain, alert etc. Supports static values, or derived from SQL.NoneYes
flowVisualize flow data using things such as sankey.NoneYes
hierarchyVisualize hierarchical data using things such as tree.NoneYes
imageEmbed images in reports. Supports static URLs, or can be derived from SQL.NoneYes
inputEnable dynamic dashboards based on user-provided input.NoneYes
tableDisplay tabular data in a dashboard.NoneYes
textAdd GitHub-flavoured markdown to a dashboard.NoneYes