Skip to content

Variables

Quentin Manfroi edited this page Nov 11, 2020 · 20 revisions

Every variables have different properties:

  • required: not to be confused with the terraform notion which make any variable without default value required. Here it means required to declare in the detectors templating. These variables could be dormant (empty value) but are declared as terraform variable in the module and this variable is used in the terraform resources.
  • scopes: a variable must have, at least, one scope. In case of multiple scopes are supported so there exist different variable for each scope which could override the scope of its "higher version" variable. It could be global, per detector (prefix name with [id]_) or per rule per detector (prefix name with [id]_ and suffix it with _[severity].
  • type which refer to terraform type constaints
  • description: a short summary of what it does

environment

description: Infrastructure environment

type: string

required: true

scopes: global

notifications

description: Default notification recipients list per severity

type: object({ critical=list(string) major=list(string) minor=list(string) warning=list(string) info=list(string) })

required: true

scopes: global, detector

prefixes

description: Prefixes list to prepend between brackets on every monitors names before environment

type: list

required: true

scopes: global

filter_custom_includes

description:"List of tags to include when custom filtering is used"

type: list

required: true

scopes: global

filter_custom_excludes

description:"List of tags to exclude when custom filtering is used"

type: list

required: true

scopes: global

disabled

description:"Disable all detectors in this module"

type: bool

required: true

scopes: global, detector, rule

aggregation_function

description: Aggregation function and group by for [id] detector (i.e. .mean(by=['host']))

type: string

required: true

scopes: detector

transformation_function

description: Transformation function for [id] detector (i.e. .mean(over='5m'))"

type: string

required: true

scopes: detector

threshold

description: [severity] threshold for [id] detector"

type: number

required: false

scopes: rule

lasting_duration_seconds

description: Minimum duration that conditions must be true before raising alert (in seconds)

type: number

required: false

scopes: detector

}

variable "at_least_percentage" { description: Percentage of lasting that conditions must be true before raising alert (>= 0.0 and <= 1.0)

type: number

required: false

scopes: detector }

Clone this wiki locally