Class: Google::Monitoring::V3::AlertPolicy::Condition::MetricThreshold

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/alert.rb

Overview

A condition type that compares a collection of time series against a threshold.

Instance Attribute Summary collapse

Instance Attribute Details

#aggregations ⇒ Array<Google::Monitoring::V3::Aggregation>

Returns 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 +MetricService.ListTimeSeries+ request. It is advisable to use the +ListTimeSeries+ method when debugging this field.

Returns:

  • (Array<Google::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 resrouces). Multiple aggregations are applied in the order specified.

    This field is similar to the one in the +MetricService.ListTimeSeries+ request. It is advisable to use the +ListTimeSeries+ method when debugging this field.



255
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/alert.rb', line 255

class MetricThreshold; end

#comparison ⇒ Google::Monitoring::V3::ComparisonType

Returns 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:

  • (Google::Monitoring::V3::ComparisonType) —

    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.



255
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/alert.rb', line 255

class MetricThreshold; end

#denominator_aggregations ⇒ Array<Google::Monitoring::V3::Aggregation>

Returns 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.

This field is similar to the one in the +MetricService.ListTimeSeries+ request. It is advisable to use the +ListTimeSeries+ method when debugging this field.

Returns:

  • (Array<Google::Monitoring::V3::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.

    This field is similar to the one in the +MetricService.ListTimeSeries+ request. It is advisable to use the +ListTimeSeries+ method when debugging this field.



255
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/alert.rb', line 255

class MetricThreshold; end

#denominator_filter ⇒ String

Returns 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 is similar to the one that is specified in the +MetricService.ListTimeSeries+ request (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.

Returns:

  • (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_filter+ is specified, the time series specified by the +filter+ field will be used as the numerator.

    The filter is similar to the one that is specified in the +MetricService.ListTimeSeries+ request (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.



255
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/alert.rb', line 255

class MetricThreshold; end

#duration ⇒ Google::Protobuf::Duration

Returns 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. 60, 120, or 300 seconds--are supported. If an invalid value is given, an error will be returned. The +Duration.nanos+ field is ignored. 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 +aggregation+ 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:

  • (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. 60, 120, or 300 seconds--are supported. If an invalid value is given, an error will be returned. The +Duration.nanos+ field is ignored. 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 +aggregation+ 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.



255
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/alert.rb', line 255

class MetricThreshold; end

#filter ⇒ String

Returns 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 +MetricService.ListTimeSeries+ request (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.

Returns:

  • (String) —

    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 +MetricService.ListTimeSeries+ request (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.



255
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/alert.rb', line 255

class MetricThreshold; end

#threshold_value ⇒ Float

Returns A value against which to compare the time series.

Returns:

  • (Float) —

    A value against which to compare the time series.



255
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/alert.rb', line 255

class MetricThreshold; end

#trigger ⇒ Google::Monitoring::V3::AlertPolicy::Condition::Trigger

Returns 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:

  • (Google::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 +filter+ and +aggregations+, or by the ratio, if +denominator_filter+ and +denominator_aggregations+ are specified.



255
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/alert.rb', line 255

class MetricThreshold; end