Class: Google::Apis::MonitoringV1::TimeSeriesFilter
- Inherits:
-
Object
- Object
- Google::Apis::MonitoringV1::TimeSeriesFilter
- 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
A filter that defines a subset of time series data that is displayed in a widget. Time series data is fetched using the ListTimeSeries method.
Instance Attribute Summary collapse
-
#aggregation ⇒ Google::Apis::MonitoringV1::Aggregation
Describes how to combine multiple time series to provide a different view of the data.
-
#filter ⇒ String
Required.
-
#pick_time_series_filter ⇒ Google::Apis::MonitoringV1::PickTimeSeriesFilter
Describes a ranking-based time series filter.
Instance Method Summary collapse
-
#initialize(**args) ⇒ TimeSeriesFilter
constructor
A new instance of TimeSeriesFilter.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ TimeSeriesFilter
Returns a new instance of TimeSeriesFilter.
924 925 926 |
# File 'generated/google/apis/monitoring_v1/classes.rb', line 924 def initialize(**args) update!(**args) end |
Instance Attribute Details
#aggregation ⇒ Google::Apis::MonitoringV1::Aggregation
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
Aggregating Time Series.
Corresponds to the JSON property aggregation
906 907 908 |
# File 'generated/google/apis/monitoring_v1/classes.rb', line 906 def aggregation @aggregation end |
#filter ⇒ String
Required. The monitoring filter that identifies the metric types, resources,
and projects to query.
Corresponds to the JSON property filter
912 913 914 |
# File 'generated/google/apis/monitoring_v1/classes.rb', line 912 def filter @filter end |
#pick_time_series_filter ⇒ Google::Apis::MonitoringV1::PickTimeSeriesFilter
Describes a ranking-based time series filter. Each input time series is ranked
with an aligner. The filter will allow up to num_time_series time series to
pass through it, selecting them based on the relative ranking.For example, if
ranking_method is METHOD_MEAN,direction is BOTTOM, and num_time_series is 3,
then the 3 times series with the lowest mean values will pass through the
filter.
Corresponds to the JSON property pickTimeSeriesFilter
922 923 924 |
# File 'generated/google/apis/monitoring_v1/classes.rb', line 922 def pick_time_series_filter @pick_time_series_filter end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
929 930 931 932 933 |
# File 'generated/google/apis/monitoring_v1/classes.rb', line 929 def update!(**args) @aggregation = args[:aggregation] if args.key?(:aggregation) @filter = args[:filter] if args.key?(:filter) @pick_time_series_filter = args[:pick_time_series_filter] if args.key?(:pick_time_series_filter) end |