table of contents Table of contents

Dashboards

On this page

Dashboards allow you to display checks and their related metrics on a single page. They come with their own dedicated resource:

resource "checkly_dashboard" "dashboard-main" {
  custom_url      = "danube"   // A unique subdomain name under "checklyhq.com"
  custom_domain   = "status.danube.com" // A custom user domain
  logo            = "https://www.danube-web.shop/logo.png"  // URL pointing to an image/logo for the page
  header          = "My dashboard"  // What text to display at the top of your dashboard
  refresh_rate    = 60          // How often to refresh the dashboard in seconds
  paginate        = false       // Determines if pagination is on or off
  pagination_rate = 30          // How often to trigger pagination in seconds
  hide_tags       = false       // Whether to show or hide the tags on the dashboard
  width           = "FULL"      // Determines whether to use the full screen or focus in the center
  isPrivate       = "false"     // Sets the dashboard to private. Will return a `key` to be used as password
  tags = [                      // One or more tags that filter which checks to display on the dashboard
    "auto"    
  ]
}
By default, if no check is specified, all checks in the account will be shown in the dashboard. If instead you want to show specific checks, you will need to use tags.

You can see all the configuration options for checks, as well as more examples, on the official Terraform registry documentation page.

Private Dashboards

Available as of v1.6.6

You can control your dashboards private/public status via Terraform by setting the isPrivate boolean to true. If activated, upon applying your terraform configuration changes, you will be returned a read-only key value for the dashboard which represents the password you can use to login via the browser. The password is stored in your tfstate file.


Last updated on June 26, 2024. You can contribute to this documentation by editing this page on Github