MetricThreshold(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A condition type that compares a collection of time series against a threshold.
Attributes | |
---|---|
Name | Description |
filter |
str
A filter __
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 |
aggregations |
Sequence[
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 |
denominator_filter |
str
A filter __
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.
|
denominator_aggregations |
Sequence[
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.
|
comparison |
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.
|
threshold_value |
float
A value against which to compare the time series. |
duration |
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.
|
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.
|