Class: Google::Apis::MonitoringV3::MetricThreshold

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/monitoring_v3/classes.rb,
lib/google/apis/monitoring_v3/representations.rb,
lib/google/apis/monitoring_v3/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ MetricThreshold

Returns a new instance of MetricThreshold.



2958
2959
2960
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 2958

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#aggregations ⇒ Array<Google::Apis::MonitoringV3::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 (https://cloud.google.com/monitoring/api/ ref_v3/rest/v3/projects.timeSeries/list). It is advisable to use the ListTimeSeries method when debugging this field. Corresponds to the JSON property aggregations

Returns:



2877
2878
2879
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 2877

def aggregations
  @aggregations
end

#comparison ⇒ String

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. Corresponds to the JSON property comparison

Returns:

  • (String) 


2886
2887
2888
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 2886

def comparison
  @comparison
end

#denominator_aggregations ⇒ Array<Google::Apis::MonitoringV3::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. Corresponds to the JSON property denominatorAggregations

Returns:



2897
2898
2899
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 2897

def denominator_aggregations
  @denominator_aggregations
end

#denominator_filter ⇒ String

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. Corresponds to the JSON property denominatorFilter

Returns:

  • (String) 


2908
2909
2910
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 2908

def denominator_filter
  @denominator_filter
end

#duration ⇒ String

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. Corresponds to the JSON property duration

Returns:

  • (String) 


2921
2922
2923
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 2921

def duration
  @duration
end

#evaluation_missing_data ⇒ String

A condition control that determines how metric-threshold conditions are evaluated when data stops arriving. Corresponds to the JSON property evaluationMissingData

Returns:

  • (String) 


2927
2928
2929
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 2927

def evaluation_missing_data
  @evaluation_missing_data
end

#filter ⇒ String

Required. 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/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list) (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. Corresponds to the JSON property filter

Returns:

  • (String) 


2939
2940
2941
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 2939

def filter
  @filter
end

#forecast_options ⇒ Google::Apis::MonitoringV3::ForecastOptions

Options used when forecasting the time series and testing the predicted value against the threshold. Corresponds to the JSON property forecastOptions

Returns:



2945
2946
2947
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 2945

def forecast_options
  @forecast_options
end

#threshold_value ⇒ Float

A value against which to compare the time series. Corresponds to the JSON property thresholdValue

Returns:

  • (Float) 


2950
2951
2952
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 2950

def threshold_value
  @threshold_value
end

#trigger ⇒ Google::Apis::MonitoringV3::Trigger

Specifies how many time series must fail a predicate to trigger a condition. If not specified, then a count: 1 trigger is used. Corresponds to the JSON property trigger

Returns:



2956
2957
2958
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 2956

def trigger
  @trigger
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 2963

def update!(**args)
  @aggregations = args[:aggregations] if args.key?(:aggregations)
  @comparison = args[:comparison] if args.key?(:comparison)
  @denominator_aggregations = args[:denominator_aggregations] if args.key?(:denominator_aggregations)
  @denominator_filter = args[:denominator_filter] if args.key?(:denominator_filter)
  @duration = args[:duration] if args.key?(:duration)
  @evaluation_missing_data = args[:evaluation_missing_data] if args.key?(:evaluation_missing_data)
  @filter = args[:filter] if args.key?(:filter)
  @forecast_options = args[:forecast_options] if args.key?(:forecast_options)
  @threshold_value = args[:threshold_value] if args.key?(:threshold_value)
  @trigger = args[:trigger] if args.key?(:trigger)
end