Class: Google::Apis::MonitoringV1::Aggregation
 Inherits:

Object
 Object
 Google::Apis::MonitoringV1::Aggregation
 Includes:
 Core::Hashable, Core::JsonObjectSupport
 Defined in:
 generated/google/apis/monitoring_v1/classes.rb,
generated/google/apis/monitoring_v1/representations.rb,
generated/google/apis/monitoring_v1/representations.rb
Overview
Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/ aggregation).
Instance Attribute Summary collapse

#alignment_period ⇒ String
The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time.

#cross_series_reducer ⇒ String
The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series.

#group_by_fields ⇒ Array<String>
The set of fields to preserve when cross_series_reducer is specified.

#per_series_aligner ⇒ String
An Aligner describes how to bring the data points in a single time series into temporal alignment.
Instance Method Summary collapse

#initialize(**args) ⇒ Aggregation
constructor
A new instance of Aggregation.

#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Aggregation
Returns a new instance of Aggregation.
106 107 108 
# File 'generated/google/apis/monitoring_v1/classes.rb', line 106 def initialize(**args) update!(**args) end 
Instance Attribute Details
#alignment_period ⇒ String
The alignment_period specifies a time interval, in seconds, that is used to
divide the data in all the time series into consistent blocks of time. This
will be done before the perseries aligner can be applied to the data.The
value must be at least 60 seconds. If a perseries aligner other than
ALIGN_NONE is specified, this field is required or an error is returned. If no
perseries aligner is specified, or the aligner ALIGN_NONE is specified, then
this field is ignored.The maximum value of the alignment_period is 2 years, or
104 weeks.
Corresponds to the JSON property alignmentPeriod
59 60 61 
# File 'generated/google/apis/monitoring_v1/classes.rb', line 59 def alignment_period @alignment_period end 
#cross_series_reducer ⇒ String
The reduction operation to be used to combine time series into a single time
series, where the value of each data point in the resulting series is a
function of all the already aligned values in the input time series.Not all
reducer operations can be applied to all time series. The valid choices depend
on the metric_kind and the value_type of the original time series. Reduction
can yield a time series with a different metric_kind or value_type than the
input time series.Time series data must first be aligned (see
per_series_aligner) in order to perform crosstime series reduction. If
cross_series_reducer is specified, then per_series_aligner must be specified,
and must not be ALIGN_NONE. An alignment_period must also be specified;
otherwise, an error is returned.
Corresponds to the JSON property crossSeriesReducer
74 75 76 
# File 'generated/google/apis/monitoring_v1/classes.rb', line 74 def cross_series_reducer @cross_series_reducer end 
#group_by_fields ⇒ Array<String>
The set of fields to preserve when cross_series_reducer is specified. The
group_by_fields determine how the time series are partitioned into subsets
prior to applying the aggregation operation. Each subset contains time series
that have the same value for each of the grouping fields. Each individual time
series is a member of exactly one subset. The cross_series_reducer is applied
to each subset of time series. It is not possible to reduce across different
resource types, so this field implicitly contains resource.type. Fields not
specified in group_by_fields are aggregated away. If group_by_fields is not
specified and all the time series have the same resource type, then the time
series are aggregated into a single output time series. If
cross_series_reducer is not defined, this field is ignored.
Corresponds to the JSON property groupByFields
89 90 91 
# File 'generated/google/apis/monitoring_v1/classes.rb', line 89 def group_by_fields @group_by_fields end 
#per_series_aligner ⇒ String
An Aligner describes how to bring the data points in a single time series into
temporal alignment. Except for ALIGN_NONE, all alignments cause all the data
points in an alignment_period to be mathematically grouped together, resulting
in a single data point for each alignment_period with end timestamp at the end
of the period.Not all alignment operations may be applied to all time series.
The valid choices depend on the metric_kind and value_type of the original
time series. Alignment can change the metric_kind or the value_type of the
time series.Time series data must be aligned in order to perform crosstime
series reduction. If cross_series_reducer is specified, then
per_series_aligner must be specified and not equal to ALIGN_NONE and
alignment_period must be specified; otherwise, an error is returned.
Corresponds to the JSON property perSeriesAligner
104 105 106 
# File 'generated/google/apis/monitoring_v1/classes.rb', line 104 def per_series_aligner @per_series_aligner end 
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
111 112 113 114 115 116 
# File 'generated/google/apis/monitoring_v1/classes.rb', line 111 def update!(**args) @alignment_period = args[:alignment_period] if args.key?(:alignment_period) @cross_series_reducer = args[:cross_series_reducer] if args.key?(:cross_series_reducer) @group_by_fields = args[:group_by_fields] if args.key?(:group_by_fields) @per_series_aligner = args[:per_series_aligner] if args.key?(:per_series_aligner) end 