github.com/pmcatominey/terraform@v0.7.0-rc2.0.20160708105029-1401a52a5cc5/website/source/docs/providers/datadog/r/timeboard.html.markdown (about)

     1  ---
     2  layout: "datadog"
     3  page_title: "Datadog: datadog_timeboard"
     4  sidebar_current: "docs-datadog-resource-timeboard"
     5  description: |-
     6    Provides a Datadog timeboard resource. This can be used to create and manage timeboards.
     7  ---
     8  
     9  # datadog\_timeboard
    10  
    11  Provides a Datadog timeboard resource. This can be used to create and manage Datadog timeboards.
    12  
    13  ## Example Usage
    14  
    15  ```
    16  # Create a new Datadog timeboard
    17  resource "datadog_timeboard" "redis" {
    18  
    19    title = "Redis Timeboard (created via Terraform)"
    20    description = "created using the Datadog provider in Terraform"
    21    read_only = true
    22  
    23    graph {
    24      title = "Redis latency (ms)"
    25      viz = "timeseries"
    26      request {
    27        q = "avg:redis.info.latency_ms{$host}"
    28      }
    29    }
    30    
    31    graph {
    32      title = "Redis memory usage"
    33      viz = "timeseries"
    34      request {
    35        q = "avg:redis.mem.used{$host} - avg:redis.mem.lua{$host}, avg:redis.mem.lua{$host}"
    36        stacked = true
    37      }
    38      request {
    39        q = "avg:redis.mem.rss{$host}"
    40      }
    41    }
    42  
    43    graph {
    44      title = "Top System CPU by Docker container"
    45      viz = "toplist"
    46      request {
    47        q = "top(avg:docker.cpu.system{*} by {container_name}, 10, 'mean', 'desc')"
    48      }
    49    }
    50  
    51    template_variable {
    52      name = "host"
    53      prefix = "host"
    54    }
    55  }
    56  ```
    57  
    58  ## Argument Reference
    59  
    60  The following arguments are supported:
    61  
    62  * `title` - (Required) The name of the dashboard.
    63  * `description` - (Required) A description of the dashboard's content.
    64  * `read_only` - (Optional) The read-only status of the timeboard. Default is false.
    65  * `graph` - (Required) Nested block describing a graph definition. The structure of this block is described below. Multiple graph blocks are allowed within a datadog_timeboard resource.
    66  * `template_variable` - (Optional) Nested block describing a template variable. The structure of this block is described below. Multiple template_variable blocks are allowed within a datadog_timeboard resource.
    67  
    68  ### Nested `graph` blocks
    69  
    70  Nested `graph` blocks have the following structure:
    71  
    72  * `title` - (Required) The name of the graph.
    73  * `viz` - (Required) The type of visualization to use for the graph. Valid choices are "change", "distribution", "heatmap", "hostmap", "query_value", timeseries", and "toplist".
    74  * `request` - Nested block describing a graph definition request (a metric query to plot on the graph). The structure of this block is described below. Multiple request blocks are allowed within a graph block.
    75  
    76  #### Nested `graph` `request` blocks
    77  
    78  Nested `graph` `request` blocks have the following structure:
    79  
    80  * `q` - (Required) The query of the request. Pro tip: Use the JSON tab inside the Datadog UI to help build you query strings.
    81  * `stacked` - (Optional) Boolean value to determin if this is this a stacked area graph. Default: false (line chart).
    82  
    83  ### Nested `template_variable` blocks
    84  
    85  Nested `template_variable` blocks have the following structure:
    86  
    87  * `name` - (Required) The variable name. Can be referenced as $name in `graph` `request` `q` query strings.
    88  * `prefix` - (Optional) The tag group. Default: no tag group.
    89  * `default` - (Required) The default tag. Default: "*" (match all).