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

Inherits:

Object

Object
Google::Cloud::Monitoring::V3::AlertPolicy::Condition::MetricThreshold

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/monitoring/v3/alert.rb

Overview

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

Defined Under Namespace

Classes: ForecastOptions

Instance Attribute Summary collapse

#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).
#comparison ⇒ ::Google::Cloud::Monitoring::V3::ComparisonType
The comparison to apply between the time series (indicated by filter and aggregation) and the threshold (indicated by threshold_value).
#denominator_aggregations ⇒ ::Array<::Google::Cloud::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).
#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.
#duration ⇒ ::Google::Protobuf::Duration
The amount of time that a time series must violate the threshold to be considered failing.
#evaluation_missing_data ⇒ ::Google::Cloud::Monitoring::V3::AlertPolicy::Condition::EvaluationMissingData
A condition control that determines how metric-threshold conditions are evaluated when data stops arriving.
#filter ⇒ ::String
Required.
#forecast_options ⇒ ::Google::Cloud::Monitoring::V3::AlertPolicy::Condition::MetricThreshold::ForecastOptions
When this field is present, the MetricThreshold condition forecasts whether the time series is predicted to violate the threshold within the forecast_horizon.
#threshold_value ⇒ ::Float
A value against which to compare the time series.
#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.

Instance Attribute Details

#aggregations ⇒ `::Array<::Google::Cloud::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 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:

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

# File 'proto_docs/google/monitoring/v3/alert.rb', line 356

class MetricThreshold
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Options used when forecasting the time series and testing
  # the predicted value against the threshold.
  # @!attribute [rw] forecast_horizon
  #   @return [::Google::Protobuf::Duration]
  #     Required. The length of time into the future to forecast whether a
  #     time series will violate the threshold. If the predicted value is
  #     found to violate the threshold, and the violation is observed in all
  #     forecasts made for the configured `duration`, then the time series is
  #     considered to be failing.
  #     The forecast horizon can range from 1 hour to 60 hours.
  class ForecastOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#comparison ⇒ `::Google::Cloud::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::Cloud::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.

# File 'proto_docs/google/monitoring/v3/alert.rb', line 356

class MetricThreshold
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Options used when forecasting the time series and testing
  # the predicted value against the threshold.
  # @!attribute [rw] forecast_horizon
  #   @return [::Google::Protobuf::Duration]
  #     Required. The length of time into the future to forecast whether a
  #     time series will violate the threshold. If the predicted value is
  #     found to violate the threshold, and the violation is observed in all
  #     forecasts made for the configured `duration`, then the time series is
  #     considered to be failing.
  #     The forecast horizon can range from 1 hour to 60 hours.
  class ForecastOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#denominator_aggregations ⇒ `::Array<::Google::Cloud::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.

Returns:

(::Array<::Google::Cloud::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.

# File 'proto_docs/google/monitoring/v3/alert.rb', line 356

class MetricThreshold
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Options used when forecasting the time series and testing
  # the predicted value against the threshold.
  # @!attribute [rw] forecast_horizon
  #   @return [::Google::Protobuf::Duration]
  #     Required. The length of time into the future to forecast whether a
  #     time series will violate the threshold. If the predicted value is
  #     found to violate the threshold, and the violation is observed in all
  #     forecasts made for the configured `duration`, then the time series is
  #     considered to be failing.
  #     The forecast horizon can range from 1 hour to 60 hours.
  class ForecastOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
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 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 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.

# File 'proto_docs/google/monitoring/v3/alert.rb', line 356

class MetricThreshold
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Options used when forecasting the time series and testing
  # the predicted value against the threshold.
  # @!attribute [rw] forecast_horizon
  #   @return [::Google::Protobuf::Duration]
  #     Required. The length of time into the future to forecast whether a
  #     time series will violate the threshold. If the predicted value is
  #     found to violate the threshold, and the violation is observed in all
  #     forecasts made for the configured `duration`, then the time series is
  #     considered to be failing.
  #     The forecast horizon can range from 1 hour to 60 hours.
  class ForecastOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
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., 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:

(::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 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.

# File 'proto_docs/google/monitoring/v3/alert.rb', line 356

class MetricThreshold
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Options used when forecasting the time series and testing
  # the predicted value against the threshold.
  # @!attribute [rw] forecast_horizon
  #   @return [::Google::Protobuf::Duration]
  #     Required. The length of time into the future to forecast whether a
  #     time series will violate the threshold. If the predicted value is
  #     found to violate the threshold, and the violation is observed in all
  #     forecasts made for the configured `duration`, then the time series is
  #     considered to be failing.
  #     The forecast horizon can range from 1 hour to 60 hours.
  class ForecastOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#evaluation_missing_data ⇒ `::Google::Cloud::Monitoring::V3::AlertPolicy::Condition::EvaluationMissingData`

Returns A condition control that determines how metric-threshold conditions are evaluated when data stops arriving. To use this control, the value of the duration field must be greater than or equal to 60 seconds.

Returns:

(::Google::Cloud::Monitoring::V3::AlertPolicy::Condition::EvaluationMissingData) —
A condition control that determines how metric-threshold conditions are evaluated when data stops arriving. To use this control, the value of the duration field must be greater than or equal to 60 seconds.

# File 'proto_docs/google/monitoring/v3/alert.rb', line 356

class MetricThreshold
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Options used when forecasting the time series and testing
  # the predicted value against the threshold.
  # @!attribute [rw] forecast_horizon
  #   @return [::Google::Protobuf::Duration]
  #     Required. The length of time into the future to forecast whether a
  #     time series will violate the threshold. If the predicted value is
  #     found to violate the threshold, and the violation is observed in all
  #     forecasts made for the configured `duration`, then the time series is
  #     considered to be failing.
  #     The forecast horizon can range from 1 hour to 60 hours.
  class ForecastOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#filter ⇒ `::String`

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

(::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 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.

# File 'proto_docs/google/monitoring/v3/alert.rb', line 356

class MetricThreshold
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Options used when forecasting the time series and testing
  # the predicted value against the threshold.
  # @!attribute [rw] forecast_horizon
  #   @return [::Google::Protobuf::Duration]
  #     Required. The length of time into the future to forecast whether a
  #     time series will violate the threshold. If the predicted value is
  #     found to violate the threshold, and the violation is observed in all
  #     forecasts made for the configured `duration`, then the time series is
  #     considered to be failing.
  #     The forecast horizon can range from 1 hour to 60 hours.
  class ForecastOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#forecast_options ⇒ `::Google::Cloud::Monitoring::V3::AlertPolicy::Condition::MetricThreshold::ForecastOptions`

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

(::Google::Cloud::Monitoring::V3::AlertPolicy::Condition::MetricThreshold::ForecastOptions) —
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.

# File 'proto_docs/google/monitoring/v3/alert.rb', line 356

class MetricThreshold
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Options used when forecasting the time series and testing
  # the predicted value against the threshold.
  # @!attribute [rw] forecast_horizon
  #   @return [::Google::Protobuf::Duration]
  #     Required. The length of time into the future to forecast whether a
  #     time series will violate the threshold. If the predicted value is
  #     found to violate the threshold, and the violation is observed in all
  #     forecasts made for the configured `duration`, then the time series is
  #     considered to be failing.
  #     The forecast horizon can range from 1 hour to 60 hours.
  class ForecastOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
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.

# File 'proto_docs/google/monitoring/v3/alert.rb', line 356

class MetricThreshold
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Options used when forecasting the time series and testing
  # the predicted value against the threshold.
  # @!attribute [rw] forecast_horizon
  #   @return [::Google::Protobuf::Duration]
  #     Required. The length of time into the future to forecast whether a
  #     time series will violate the threshold. If the predicted value is
  #     found to violate the threshold, and the violation is observed in all
  #     forecasts made for the configured `duration`, then the time series is
  #     considered to be failing.
  #     The forecast horizon can range from 1 hour to 60 hours.
  class ForecastOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#trigger ⇒ `::Google::Cloud::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::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 filter and aggregations, or by the ratio, if denominator_filter and denominator_aggregations are specified.

# File 'proto_docs/google/monitoring/v3/alert.rb', line 356

class MetricThreshold
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Options used when forecasting the time series and testing
  # the predicted value against the threshold.
  # @!attribute [rw] forecast_horizon
  #   @return [::Google::Protobuf::Duration]
  #     Required. The length of time into the future to forecast whether a
  #     time series will violate the threshold. If the predicted value is
  #     found to violate the threshold, and the violation is observed in all
  #     forecasts made for the configured `duration`, then the time series is
  #     considered to be failing.
  #     The forecast horizon can range from 1 hour to 60 hours.
  class ForecastOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

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

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Instance Attribute Details

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

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

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

#denominator_filter ⇒ ::String

#duration ⇒ ::Google::Protobuf::Duration

#evaluation_missing_data ⇒ ::Google::Cloud::Monitoring::V3::AlertPolicy::Condition::EvaluationMissingData

#filter ⇒ ::String

#forecast_options ⇒ ::Google::Cloud::Monitoring::V3::AlertPolicy::Condition::MetricThreshold::ForecastOptions

#threshold_value ⇒ ::Float

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

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

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

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

#denominator_filter ⇒ `::String`

#duration ⇒ `::Google::Protobuf::Duration`

#evaluation_missing_data ⇒ `::Google::Cloud::Monitoring::V3::AlertPolicy::Condition::EvaluationMissingData`

#filter ⇒ `::String`

#forecast_options ⇒ `::Google::Cloud::Monitoring::V3::AlertPolicy::Condition::MetricThreshold::ForecastOptions`

#threshold_value ⇒ `::Float`

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