Skip to content

Commit

Permalink
Update the range field in moniroting_slo documentation (#5015) (#9703)
Browse files Browse the repository at this point in the history 
Signed-off-by: Modular Magician <[email protected]>
  • Loading branch information
@modular-magician
modular-magician authored Aug 2, 2021
1 parent f864da1 commit de49375
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 28 deletions.
3 changes: 3 additions & 0 deletions .changelog/5015.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:none

```
28 changes: 14 additions & 14 deletions google/resource_monitoring_slo.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -230,8 +230,8 @@ MetricKind = DELTA or MetricKind = CUMULATIVE.`,
Required: true,
Description: `Range of numerical values. The computed good_service
will be the count of values x in the Distribution such
that range.min <= x < range.max. inclusive of min and
exclusive of max. Open ranges can be defined by setting
that range.min <= x <= range.max. inclusive of min and
max. Open ranges can be defined by setting
just one of min or max.`,
MaxItems: 1,
Elem: &schema.Resource{
Expand Down Expand Up @@ -477,8 +477,8 @@ MetricKind = DELTA or MetricKind = CUMULATIVE.`,
Required: true,
Description: `Range of numerical values. The computed good_service
will be the count of values x in the Distribution such
that range.min <= x < range.max. inclusive of min and
exclusive of max. Open ranges can be defined by setting
that range.min <= x <= range.max. inclusive of min and
max. Open ranges can be defined by setting
just one of min or max.`,
MaxItems: 1,
Elem: &schema.Resource{
Expand Down Expand Up @@ -583,7 +583,7 @@ One of 'good_bad_metric_filter',
'good_total_ratio_threshold', 'metric_mean_in_range',
'metric_sum_in_range' must be set for 'windows_based_sli'.
Average value X of 'time_series' should satisfy
'range.min <= X < range.max' for a good window.`,
'range.min <= X <= range.max' for a good window.`,
MaxItems: 1,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
Expand All @@ -592,10 +592,10 @@ Average value X of 'time_series' should satisfy
Required: true,
Description: `Range of numerical values. The computed good_service
will be the count of values x in the Distribution such
that range.min <= x < range.max. inclusive of min and
exclusive of max. Open ranges can be defined by setting
that range.min <= x <= range.max. inclusive of min and
max. Open ranges can be defined by setting
just one of min or max. Mean value 'X' of 'time_series'
values should satisfy 'range.min <= X < range.max' for a
values should satisfy 'range.min <= X <= range.max' for a
good service.`,
MaxItems: 1,
Elem: &schema.Resource{
Expand Down Expand Up @@ -626,7 +626,7 @@ will be set to "-infinity", defining an open range
specifying the TimeSeries to use for evaluating window
The provided TimeSeries must have ValueType = INT64 or
ValueType = DOUBLE and MetricKind = GAUGE. Mean value 'X'
should satisfy 'range.min <= X < range.max'
should satisfy 'range.min <= X <= range.max'
under good service.`,
},
},
Expand All @@ -639,7 +639,7 @@ under good service.`,
Description: `Criterion that describes a window as good if the metric's value
is in a good range, *summed* across returned streams.
Summed value 'X' of 'time_series' should satisfy
'range.min <= X < range.max' for a good window.
'range.min <= X <= range.max' for a good window.
One of 'good_bad_metric_filter',
'good_total_ratio_threshold', 'metric_mean_in_range',
Expand All @@ -652,10 +652,10 @@ One of 'good_bad_metric_filter',
Required: true,
Description: `Range of numerical values. The computed good_service
will be the count of values x in the Distribution such
that range.min <= x < range.max. inclusive of min and
exclusive of max. Open ranges can be defined by setting
that range.min <= x <= range.max. inclusive of min and
max. Open ranges can be defined by setting
just one of min or max. Summed value 'X' should satisfy
'range.min <= X < range.max' for a good window.`,
'range.min <= X <= range.max' for a good window.`,
MaxItems: 1,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
Expand Down Expand Up @@ -688,7 +688,7 @@ ValueType = INT64 or ValueType = DOUBLE and
MetricKind = GAUGE.
Summed value 'X' should satisfy
'range.min <= X < range.max' for a good window.`,
'range.min <= X <= range.max' for a good window.`,
},
},
},
Expand Down
28 changes: 14 additions & 14 deletions website/docs/r/monitoring_slo.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -437,8 +437,8 @@ The `distribution_cut` block supports:
(Required)
Range of numerical values. The computed good_service
will be the count of values x in the Distribution such
that range.min <= x < range.max. inclusive of min and
exclusive of max. Open ranges can be defined by setting
that range.min <= x <= range.max. inclusive of min and
max. Open ranges can be defined by setting
just one of min or max.
Structure is documented below.

Expand Down Expand Up @@ -489,15 +489,15 @@ The `windows_based_sli` block supports:
`good_total_ratio_threshold`, `metric_mean_in_range`,
`metric_sum_in_range` must be set for `windows_based_sli`.
Average value X of `time_series` should satisfy
`range.min <= X < range.max` for a good window.
`range.min <= X <= range.max` for a good window.
Structure is documented below.

* `metric_sum_in_range` -
(Optional)
Criterion that describes a window as good if the metric's value
is in a good range, *summed* across returned streams.
Summed value `X` of `time_series` should satisfy
`range.min <= X < range.max` for a good window.
`range.min <= X <= range.max` for a good window.
One of `good_bad_metric_filter`,
`good_total_ratio_threshold`, `metric_mean_in_range`,
`metric_sum_in_range` must be set for `windows_based_sli`.
Expand Down Expand Up @@ -587,8 +587,8 @@ The `distribution_cut` block supports:
(Required)
Range of numerical values. The computed good_service
will be the count of values x in the Distribution such
that range.min <= x < range.max. inclusive of min and
exclusive of max. Open ranges can be defined by setting
that range.min <= x <= range.max. inclusive of min and
max. Open ranges can be defined by setting
just one of min or max.
Structure is documented below.

Expand Down Expand Up @@ -669,17 +669,17 @@ The `metric_mean_in_range` block supports:
specifying the TimeSeries to use for evaluating window
The provided TimeSeries must have ValueType = INT64 or
ValueType = DOUBLE and MetricKind = GAUGE. Mean value `X`
should satisfy `range.min <= X < range.max`
should satisfy `range.min <= X <= range.max`
under good service.

* `range` -
(Required)
Range of numerical values. The computed good_service
will be the count of values x in the Distribution such
that range.min <= x < range.max. inclusive of min and
exclusive of max. Open ranges can be defined by setting
that range.min <= x <= range.max. inclusive of min and
max. Open ranges can be defined by setting
just one of min or max. Mean value `X` of `time_series`
values should satisfy `range.min <= X < range.max` for a
values should satisfy `range.min <= X <= range.max` for a
good service.
Structure is documented below.

Expand Down Expand Up @@ -708,16 +708,16 @@ The `metric_sum_in_range` block supports:
ValueType = INT64 or ValueType = DOUBLE and
MetricKind = GAUGE.
Summed value `X` should satisfy
`range.min <= X < range.max` for a good window.
`range.min <= X <= range.max` for a good window.

* `range` -
(Required)
Range of numerical values. The computed good_service
will be the count of values x in the Distribution such
that range.min <= x < range.max. inclusive of min and
exclusive of max. Open ranges can be defined by setting
that range.min <= x <= range.max. inclusive of min and
max. Open ranges can be defined by setting
just one of min or max. Summed value `X` should satisfy
`range.min <= X < range.max` for a good window.
`range.min <= X <= range.max` for a good window.
Structure is documented below.


Expand Down

0 comments on commit de49375

Please sign in to comment.