Skip to content

Commit

Permalink
Doc Review #1
Browse files Browse the repository at this point in the history
Co-authored-by: Margot Lepizzera <[email protected]>
  • Loading branch information
alai97 and MargotLepizzera authored Oct 19, 2021
1 parent 5c6914a commit f53eb6d
Showing 1 changed file with 14 additions and 12 deletions.
26 changes: 14 additions & 12 deletions content/en/monitors/create/types/metric.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,25 +173,27 @@ As you change a threshold, the preview graph in the editor displays a marker sho

This setting allows you to change when the alerting engine considers a monitor as a candidate for evaluation.

**Do not require** (default)- A monitor is evaluated as soon as it is recognized. Consider using this value if your data points might be sparse. With this configuration, the monitor evaluates even if there is a single data point in the evaluation timeframe.
**Do not require** (Default): A monitor is evaluated as soon as it is recognized. Consider using this value if your data points might be sparse. With this configuration, the monitor evaluates even if there is a single data point in the evaluation timeframe.

**Require**: A monitor is not evaluated until the evaluation window is considered to be `filled` with data. To be notified if there is data over the entire evaluation timeframe, use this option.

**Require** - A monitor is not evaluated until the evaluation window is considered as `filled` with data. Use this option only if you want to be notified if there is data over the entire evaluation timeframe.
To define if the evaluation timeframe is `filled` with data, the timeframe is split into smaller buckets.
The logic to determine the bucket size is as follows:

* Evaluation timeframe in minutes: bucket is 1 min
* Evaluation timeframe in hours: bucket is 10 minutes
* Evaluation timeframe in days: bucket is 1h
* Evaluation timeframe in month: bucket is 4h
The following logic determines the bucket size:

* Evaluation timeframe in minutes: bucket size is 1 minute
* Evaluation timeframe in hours: bucket size is 10 minutes
* Evaluation timeframe in days: bucket size is 1 hour
* Evaluation timeframe in month: bucket size is 4 hours

To be considered as a "full window", there must be both:
In order to be considered as a "full window", the monitor requires:

1. At least one data point in the first bucket
2. At most 3 buckets in total with no data points (including the first one)
1. At least one data point in the first bucket.
2. At most three buckets in total with no data points (including the first one).

If the condition are met, the monitor is evaluated. Otherwise, the evaluation is canceled and the monitor state unchanged.
If the conditions are met, the monitor is evaluated. Otherwise, the evaluation is canceled and the monitor state is unchanged.

**Example**: A monitor that evaluates over the last `2h` is split in 12 buckets of 10 minutes. It is considered full if the first bucket has data and at most 3 buckets in total are empty.
For example, a monitor that evaluates over the last `2h` is split in 12 buckets of 10 minutes. The monitor is considered full if the first bucket has data and at most three buckets in total are empty.

| data | B0 | B1 | B2 | B3 | B4 | B5 | B6 | B7 | B8 | B9 | B10 | B11 | Full window?|
|--------|----|----|----|----|----|----|----|----|----|----|-----|-----|-------------|
Expand Down

0 comments on commit f53eb6d

Please sign in to comment.