A condition is a true/false test that determines when an alerting policy should open an incident. If a condition evaluates to true, it signifies that something is wrong. .. attribute:: name
Required if the condition exists. The unique resource name for
this condition. Its format is: :: projects/[PROJECT_ID_O
R_NUMBER]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID]
[CONDITION_ID] is assigned by Stackdriver Monitoring when
the condition is created as part of a new or updated alerting
policy. When calling the [alertPolicies.create][google.monito
ring.v3.AlertPolicyService.CreateAlertPolicy] method, do not
include the name field in the conditions of the requested
alerting policy. Stackdriver Monitoring creates the condition
identifiers and includes them in the new policy. When calling
the [alertPolicies.update][google.monitoring.v3.AlertPolicySer
vice.UpdateAlertPolicy] method to update a policy, including a
condition name causes the existing condition to be
updated. Conditions without names are added to the updated
policy. Existing conditions are deleted if they are not
updated. Best practice is to preserve [CONDITION_ID] if
you make only small changes, such as those to condition
thresholds, durations, or trigger values. Otherwise, treat the
change as a new condition and let the existing condition be
deleted.
Only one of the following condition types will be specified.
A condition that checks that a time series continues to receive new data points.
Classes
MetricAbsence
A condition type that checks that monitored resources are reporting
data. The configuration defines a metric and a set of monitored
resources. The predicate is considered in violation when a time series
for the specified metric of a monitored resource does not include any
data in the specified duration.
.. attribute:: filter
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/m
onitoring/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.
The amount of time that a time series must fail to report new
data to be considered failing. Currently, only values that are
a multiple of a minute--e.g. 60, 120, or 300 seconds--are
supported. If an invalid value is given, an error will be
returned. The Duration.nanos field is ignored.
MetricThreshold
A condition type that compares a collection of time series against a threshold. .. attribute:: filter
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/m
onitoring/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.
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.
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.
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.
TimeSeriesQueryLanguageCondition
A condition type that allows alert policies to be defined using Monitoring Query Language. .. attribute:: query
Monitoring Query Language query that generates time series data and describes a condition for alerting on that data.
Trigger
Specifies how many time series must fail a predicate to trigger a
condition. If not specified, then a {count: 1} trigger is used.
.. attribute:: type
A type of trigger.
The percentage of time series that must fail the predicate for the condition to be triggered.