github.com/danp/terraform@v0.9.5-0.20170426144147-39d740081351/website/source/docs/providers/librato/r/alert.html.markdown (about)

     1  ---
     2  layout: "librato"
     3  page_title: "Librato: librato_alert"
     4  sidebar_current: "docs-librato-resource-alert"
     5  description: |-
     6    Provides a Librato Alert resource. This can be used to create and manage alerts on Librato.
     7  ---
     8  
     9  # librato\_alert
    10  
    11  Provides a Librato Alert resource. This can be used to
    12  create and manage alerts on Librato.
    13  
    14  ## Example Usage
    15  
    16  ```hcl
    17  # Create a new Librato alert
    18  resource "librato_alert" "myalert" {
    19    name        = "MyAlert"
    20    description = "A Test Alert"
    21    services    = ["${librato_service.myservice.id}"]
    22  
    23    condition {
    24      type        = "above"
    25      threshold   = 10
    26      metric_name = "librato.cpu.percent.idle"
    27    }
    28  }
    29  ```
    30  
    31  ## Argument Reference
    32  
    33  The following arguments are supported:
    34  
    35  * `name` - (Required) The name of the alert.
    36  * `description` - (Required) Description of the alert.
    37  * `active` - whether the alert is active (can be triggered). Defaults to true.
    38  * `rearm_seconds` - minimum amount of time between sending alert notifications, in seconds.
    39  * `services` - list of notification service IDs.
    40  * `condition` - A trigger condition for the alert. Conditions documented below.
    41  * `attributes` - A hash of additional attribtues for the alert. Attributes documented below.
    42  
    43  ## Attributes Reference
    44  
    45  The following attributes are exported:
    46  
    47  * `id` - The ID of the alert.
    48  * `name` - The name of the alert.
    49  * `description` - (Required) Description of the alert.
    50  * `active` - whether the alert is active (can be triggered). Defaults to true.
    51  * `rearm_seconds` - minimum amount of time between sending alert notifications, in seconds.
    52  * `services` - list of notification service IDs.
    53  * `condition` - A trigger condition for the alert. Conditions documented below.
    54  
    55  Conditions (`condition`) support the following:
    56  
    57  * `type` - The type of condition. Must be one of `above`, `below` or `absent`.
    58  * `metric_name`- The name of the metric this alert condition applies to.
    59  * `source`- A source expression which identifies which sources for the given metric to monitor.
    60  * `detect_reset` - boolean: toggles the method used to calculate the delta from the previous sample when the summary_function is `derivative`.
    61  * `duration` - number of seconds condition must be true to fire the alert (required for type `absent`).
    62  * `threshold` - float: measurements over this number will fire the alert (only for `above` or `below`).
    63  * `summary_function` - Indicates which statistic of an aggregated measurement to alert on. ((only for `above` or `below`).
    64  
    65  Attributes (`attributes`) support the following:
    66  
    67  * `runbook_url` - a URL for the runbook to be followed when this alert is firing. Used in the Librato UI if set.