chart

Powerpipe is now the recommended way to run dashboards and benchmarks! Mods still work as normal in Steampipe for now, but they are deprecated and will be removed in a future release:

• Steampipe Unbundled →
• Powerpipe for Steampipe users →

A chart enables visualisation of queries in a variety of charting types such as bar, column, donut, line or pie.

The chart types share key properties such as shape of the data and configuration. So, for example, if you change the type of chart from bar to line it just works.

Chart blocks can be declared as named resources at the top level of a mod, or be declared as anonymous blocks inside a dashboard or container, or be re-used inside a dashboard or container by using a chart with base = <mod>.chart.<chart_resource_name>.

Example Usage

chart {
  type  = "bar"
  title = "AWS S3 Buckets by Region"

  sql = <<-EOQ
    select
        region as Region,
        count(*) as Total
    from
        aws_s3_bucket
    group by
        region
    order by
        Total desc
  EOQ
}

Argument Reference

Data Format

Data can be provided in 2 formats. Either in classic "Excel-like" column format, where each series data is contained in its own column:

Alternatively, data can be provided with the series data in rows.

The chart will automatically crosstab the data into the below format. See transform:

Common Chart Properties

axes

Applicable to bar, column, line and scatter.

x

y

axis title

transform

What data transform to apply.

Defaults to auto, which will automatically crosstab row series data into column series data if it detects a 3-column dataset, with the first 2 columns non-numeric and the 3rd column numeric.

Alternative values are none, which applies no data transforms, or crosstab which explicitly applies the crosstab transform that auto may apply.

labels

legend

series

point

More Examples

Multi-series bar chart with custom properties

chart {
  type  = "bar"
  title = "Bucket Versioning by Region"
  width = 4 

  legend {
    display  = "auto"
    position = "top"
  }

  series versioned {
    title = "Versioned Buckets"
    color = "green"
  }
  series nonversioned {
    title = "Non-Versioned Buckets"
    color = "red"
  }
  axes {
    x {
      title {
        value  = "Regions"
      }
      labels {
        display = "auto"
      }
    }
    y {
      title {
        value  = "Totals"
      }
      labels {
        display = "show"
      }
      min    = 0
      max    = 100
    }
  }
  sql = <<-EOQ
    with versioned_buckets_by_region as (
      select
        region,
        count(*) as versioned
      from
        aws_s3_bucket
      where
        versioning_enabled
      group by
        region
    ),
    nonversioned_buckets_by_region as (
      select
        region,
        count(*) as nonversioned
      from
        aws_s3_bucket
      where
        not versioning_enabled
      group by
        region
    )
    select
      v.region,
      v.versioned,
      n.nonversioned
    from
      versioned_buckets_by_region as v
      full join nonversioned_buckets_by_region n on v.region = n.region;
  EOQ
}

Bar Chart

chart {
  type  = "bar"
  title = "AWS S3 Buckets by Region"

  sql = <<-EOQ
    select
        region as Region,
        count(*) as Total
    from
        aws_s3_bucket
    group by
        region
    order by
        Total desc
  EOQ
}

Column Chart

chart {
  type = "column"
  title = "AWS S3 Buckets by Region"

  sql = <<-EOQ
    select
        region as Region,
        count(*) as Total
    from
        aws_s3_bucket
    group by
        region
    order by
        Total desc
  EOQ
}

Donut Chart

chart {
  type = "donut"
  title = "AWS S3 Buckets by Region"

  sql = <<-EOQ
    select
        region as Region,
        count(*) as Total
    from
        aws_s3_bucket
    group by
        region
    order by
        Total desc
  EOQ
}

Multiple donut charts

chart "db_base" {
  series "mentions" {
    point "Citus" {
      color = "green"
    }
    point "MongoDB" {
      color = "gray"
    }
    point "MySQL|MariaDB" {
      color = "orange"
    }
    point "Oracle" {
      color = "red"
    }
    point "Postgres" {
      color = "lightblue"
    }
    point "SQL Server" {
      color = "blue"
    }
    point "Supabase" {
      color = "yellow"
    }
    point "Redis" {
       color = "#065E5B"
    }
    point "SQLite" {
      color = "purple"
    }

  }

Line Chart

chart {
  type = "line"
  title = "AWS S3 Buckets by Region"

  sql = <<-EOQ
    select
        region as Region,
        count(*) as Total
    from
        aws_s3_bucket
    group by
        region
    order by
        Total desc
  EOQ
}

Pie Chart

chart {
  type = "pie"
  title = "AWS S3 Buckets by Region"

  sql = <<-EOQ
    select
        region as Region,
        count(*) as Total
    from
        aws_s3_bucket
    group by
        region
    order by
        Total desc
  EOQ
}

Stack Chart

chart {
  type  = "column"
  title = "EBS total Storage by Region"
  width = 4 

  sql = <<-EOQ
    select
      region,
      state, 
      sum(size) 
    from 
      aws_ebs_volume
    group by
      region,
      state
  EOQ
}

Comparison Chart

chart {
  type  = "column"
  title = "EBS total Storage by Region"
  grouping = "compare"
  width = 4 

  sql = <<-EOQ
    select
      region,
      state, 
      sum(size) 
    from 
      aws_ebs_volume
    group by
      region,
      state
  EOQ
}