public sealed class MetricThreshold : IMessage<AlertPolicy.Types.Condition.Types.MetricThreshold>, IEquatable<AlertPolicy.Types.Condition.Types.MetricThreshold>, IDeepCloneable<AlertPolicy.Types.Condition.Types.MetricThreshold>, IBufferMessage, IMessageA condition type that compares a collection of time series against a threshold.
Implements
IMessage<AlertPolicy.Types.Condition.Types.MetricThreshold>, IEquatable<AlertPolicy.Types.Condition.Types.MetricThreshold>, IDeepCloneable<AlertPolicy.Types.Condition.Types.MetricThreshold>, IBufferMessage, IMessageNamespace
Google.Cloud.Monitoring.V3Assembly
Google.Cloud.Monitoring.V3.dll
Constructors
MetricThreshold()
public MetricThreshold()MetricThreshold(AlertPolicy.Types.Condition.Types.MetricThreshold)
public MetricThreshold(AlertPolicy.Types.Condition.Types.MetricThreshold other)| Parameter | |
|---|---|
| Name | Description |
other | AlertPolicy.Types.Condition.Types.MetricThreshold |
Properties
Aggregations
public RepeatedField<Aggregation> Aggregations { get; }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.
| Property Value | |
|---|---|
| Type | Description |
RepeatedField<Aggregation> | |
Comparison
public ComparisonType Comparison { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
ComparisonType | |
DenominatorAggregations
public RepeatedField<Aggregation> DenominatorAggregations { get; }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.
| Property Value | |
|---|---|
| Type | Description |
RepeatedField<Aggregation> | |
DenominatorFilter
public string DenominatorFilter { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
String | |
Duration
public Duration Duration { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
Duration | |
Filter
public string Filter { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
String | |
ThresholdValue
public double ThresholdValue { get; set; }A value against which to compare the time series.
| Property Value | |
|---|---|
| Type | Description |
Double | |
Trigger
public AlertPolicy.Types.Condition.Types.Trigger Trigger { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
AlertPolicy.Types.Condition.Types.Trigger | |