Class: Google::Apis::MonitoringV3::MetricThreshold
- Inherits:
-
Object
- Object
- Google::Apis::MonitoringV3::MetricThreshold
- 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
-
#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 resrouces).
-
#comparison ⇒ String
The comparison to apply between the time series (indicated by filter and aggregation) and the threshold (indicated by threshold_value).
-
#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.This field is similar to the one in the MetricService.ListTimeSeries request.
-
#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 ⇒ String
The amount of time that a time series must violate the threshold to be considered failing.
-
#filter ⇒ 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.
-
#threshold_value ⇒ Float
A value against which to compare the time series.
-
#trigger ⇒ Google::Apis::MonitoringV3::Trigger
Specifies how many time series must fail a predicate to trigger a condition.
Instance Method Summary collapse
-
#initialize(**args) ⇒ MetricThreshold
constructor
A new instance of MetricThreshold.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ MetricThreshold
Returns a new instance of MetricThreshold
1914 1915 1916 |
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1914 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 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.
Corresponds to the JSON property aggregations
1844 1845 1846 |
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1844 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
1853 1854 1855 |
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1853 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.This field is similar to
the one in the MetricService.ListTimeSeries request. It is advisable to use
the ListTimeSeries method when debugging this field.
Corresponds to the JSON property denominatorAggregations
1866 1867 1868 |
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1866 def denominator_aggregations @denominator_aggregations end |
#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. 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.
Corresponds to the JSON property denominatorFilter
1878 1879 1880 |
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1878 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
1891 1892 1893 |
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1891 def duration @duration end |
#filter ⇒ 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.
Corresponds to the JSON property filter
1901 1902 1903 |
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1901 def filter @filter end |
#threshold_value ⇒ Float
A value against which to compare the time series.
Corresponds to the JSON property thresholdValue
1906 1907 1908 |
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1906 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
1912 1913 1914 |
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1912 def trigger @trigger end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 |
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1919 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 |