MetricThreshold class
A condition type that compares a collection of time series against a threshold.
Constructors
- MetricThreshold()
-
MetricThreshold.fromJson(Map _json
)
Properties
-
aggregations
↔ List<
Aggregation> -
Specifies the alignment of data points in individual time series as well
as how to combine the retrieved time series together (such as when
aggregating multiple streams on each resource to a single stream for each
resource or when aggregating streams across all members of a group of
resrouces). Multiple aggregations are applied in the order specified.This
field is similar to the one in the ListTimeSeries request
(https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).
It is advisable to use the ListTimeSeries method when debugging this
field.
read / write
- comparison ↔ String
-
The comparison to apply between the time series (indicated by filter and
aggregation) and the threshold (indicated by threshold_value). The
comparison is applied on each time series, with the time series on the
left-hand side and the threshold on the right-hand side.Only COMPARISON_LT
and COMPARISON_GT are supported currently.
Possible string values are: [...]
read / write
-
denominatorAggregations
↔ List<
Aggregation> -
Specifies the alignment of data points in individual time series selected
by denominatorFilter as well as how to combine the retrieved time series
together (such as when aggregating multiple streams on each resource to a
single stream for each resource or when aggregating streams across all
members of a group of resources).When computing ratios, the aggregations
and denominator_aggregations fields must use the same alignment period and
produce time series that have the same periodicity and labels.
read / write
- denominatorFilter ↔ String
-
A filter (https://cloud.google.com/monitoring/api/v3/filters) that
identifies a time series that should be used as the denominator of a ratio
that will be compared with the threshold. If a denominator_filter is
specified, the time series specified by the filter field will be used as
the numerator.The filter must specify the metric type and optionally may
contain restrictions on resource type, resource labels, and metric labels.
This field may not exceed 2048 Unicode characters in length.
read / write
- duration ↔ String
-
The amount of time that a time series must violate the threshold to be
considered failing. Currently, only values that are a multiple of a
minute--e.g., 0, 60, 120, or 300 seconds--are supported. If an invalid
value is given, an error will be returned. When choosing a duration, it is
useful to keep in mind the frequency of the underlying time series data
(which may also be affected by any alignments specified in the
aggregations field); a good duration is long enough so that a single
outlier does not generate spurious alerts, but short enough that unhealthy
states are detected and alerted on quickly.
read / write
- filter ↔ String
-
A filter (https://cloud.google.com/monitoring/api/v3/filters) that
identifies which time series should be compared with the threshold.The
filter is similar to the one that is specified in the ListTimeSeries
request
(https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list)
(that call is useful to verify the time series that will be retrieved /
processed) and must specify the metric type and optionally may contain
restrictions on resource type, resource labels, and metric labels. This
field may not exceed 2048 Unicode characters in length.
read / write
- thresholdValue ↔ double
-
A value against which to compare the time series.
read / write
- trigger ↔ Trigger
-
The number/percent of time series for which the comparison must hold in
order for the condition to trigger. If unspecified, then the condition
will trigger if the comparison is true for any of the time series that
have been identified by filter and aggregations, or by the ratio, if
denominator_filter and denominator_aggregations are specified.
read / write
- hashCode → int
-
The hash code for this object. [...]
read-only, inherited
- runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
Methods
-
toJson(
) → Map< String, Object> -
noSuchMethod(
Invocation invocation ) → dynamic -
Invoked when a non-existent method or property is accessed. [...]
inherited
-
toString(
) → String -
Returns a string representation of this object.
inherited
Operators
-
operator ==(
dynamic other ) → bool -
The equality operator. [...]
inherited