Reference documentation and code samples for the Stackdriver Monitoring V3 Client class MetricThreshold.
A condition type that compares a collection of time series against a threshold.
Generated from protobuf message google.monitoring.v3.AlertPolicy.Condition.MetricThreshold
Namespace
Google \ Cloud \ Monitoring \ V3 \ AlertPolicy \ ConditionMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ filter |
string
Required. 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 |
↳ aggregations |
array<Google\Cloud\Monitoring\V3\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 resources). Multiple aggregations are applied in the order specified. This field is similar to the one in the |
↳ denominator_filter |
string
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_aggregations |
array<Google\Cloud\Monitoring\V3\Aggregation>
Specifies the alignment of data points in individual time series selected by |
↳ forecast_options |
Google\Cloud\Monitoring\V3\AlertPolicy\Condition\MetricThreshold\ForecastOptions
When this field is present, the |
↳ comparison |
int
The comparison to apply between the time series (indicated by |
↳ threshold_value |
float
A value against which to compare the time series. |
↳ duration |
Google\Protobuf\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 |
↳ trigger |
Google\Cloud\Monitoring\V3\AlertPolicy\Condition\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 |
↳ evaluation_missing_data |
int
A condition control that determines how metric-threshold conditions are evaluated when data stops arriving. |
getFilter
Required. 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
(that call is useful to verify the time series that will be retrieved /
processed). The filter must specify the metric type and the resource
type. Optionally, it can specify resource labels and metric labels.
This field must not exceed 2048 Unicode characters in length.
| Returns | |
|---|---|
| Type | Description |
string | |
setFilter
Required. 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
(that call is useful to verify the time series that will be retrieved /
processed). The filter must specify the metric type and the resource
type. Optionally, it can specify resource labels and metric labels.
This field must not exceed 2048 Unicode characters in length.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAggregations
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 resources). Multiple aggregations are applied in the order specified.
This field is similar to the one in the ListTimeSeries
request.
It is advisable to use the ListTimeSeries method when debugging this
field.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setAggregations
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 resources). Multiple aggregations are applied in the order specified.
This field is similar to the one in the ListTimeSeries
request.
It is advisable to use the ListTimeSeries method when debugging this
field.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Monitoring\V3\Aggregation>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDenominatorFilter
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.
| Returns | |
|---|---|
| Type | Description |
string | |
setDenominatorFilter
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDenominatorAggregations
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setDenominatorAggregations
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Monitoring\V3\Aggregation>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getForecastOptions
When this field is present, the MetricThreshold condition forecasts
whether the time series is predicted to violate the threshold within
the forecast_horizon. When this field is not set, the
MetricThreshold tests the current value of the timeseries against the
threshold.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Monitoring\V3\AlertPolicy\Condition\MetricThreshold\ForecastOptions|null | |
hasForecastOptions
clearForecastOptions
setForecastOptions
When this field is present, the MetricThreshold condition forecasts
whether the time series is predicted to violate the threshold within
the forecast_horizon. When this field is not set, the
MetricThreshold tests the current value of the timeseries against the
threshold.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Monitoring\V3\AlertPolicy\Condition\MetricThreshold\ForecastOptions
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getComparison
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.
| Returns | |
|---|---|
| Type | Description |
int | |
setComparison
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getThresholdValue
A value against which to compare the time series.
| Returns | |
|---|---|
| Type | Description |
float | |
setThresholdValue
A value against which to compare the time series.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDuration
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null | |
hasDuration
clearDuration
setDuration
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTrigger
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.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Monitoring\V3\AlertPolicy\Condition\Trigger|null | |
hasTrigger
clearTrigger
setTrigger
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Monitoring\V3\AlertPolicy\Condition\Trigger
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEvaluationMissingData
A condition control that determines how metric-threshold conditions are evaluated when data stops arriving.
| Returns | |
|---|---|
| Type | Description |
int | |
setEvaluationMissingData
A condition control that determines how metric-threshold conditions are evaluated when data stops arriving.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |