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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/monitoring_v3/classes.rb,
generated/google/apis/monitoring_v3/representations.rb,
generated/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

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ MetricThreshold

Returns a new instance of MetricThreshold.



2504
2505
2506
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2504

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

Instance Attribute Details

#aggregationsArray<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 resrouces). 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



2435
2436
2437
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2435

def aggregations
  @aggregations
end

#comparisonString

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)


2444
2445
2446
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2444

def comparison
  @comparison
end

#denominator_aggregationsArray<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



2455
2456
2457
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2455

def denominator_aggregations
  @denominator_aggregations
end

#denominator_filterString

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)


2466
2467
2468
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2466

def denominator_filter
  @denominator_filter
end

#durationString

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)


2479
2480
2481
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2479

def duration
  @duration
end

#filterString

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

Returns:

  • (String)


2491
2492
2493
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2491

def filter
  @filter
end

#threshold_valueFloat

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

Returns:

  • (Float)


2496
2497
2498
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2496

def threshold_value
  @threshold_value
end

#triggerGoogle::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



2502
2503
2504
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2502

def trigger
  @trigger
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2509

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)
  @filter = args[:filter] if args.key?(:filter)
  @threshold_value = args[:threshold_value] if args.key?(:threshold_value)
  @trigger = args[:trigger] if args.key?(:trigger)
end