google-cloud-monitoring 0.38.0 → 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.yardopts +2 -1
- data/AUTHENTICATION.md +51 -54
- data/LICENSE.md +203 -0
- data/MIGRATING.md +361 -0
- data/README.md +34 -50
- data/lib/google-cloud-monitoring.rb +6 -5
- data/lib/google/cloud/monitoring.rb +255 -443
- data/lib/google/cloud/monitoring/dashboard.rb +88 -117
- data/lib/google/cloud/monitoring/{v3/doc/google/protobuf/wrappers.rb → dashboard/version.rb} +12 -9
- data/lib/google/cloud/monitoring/version.rb +6 -2
- metadata +71 -128
- data/LICENSE +0 -201
- data/lib/google/cloud/monitoring/dashboard/v1.rb +0 -148
- data/lib/google/cloud/monitoring/dashboard/v1/credentials.rb +0 -46
- data/lib/google/cloud/monitoring/dashboard/v1/dashboards_service_client.rb +0 -457
- data/lib/google/cloud/monitoring/dashboard/v1/dashboards_service_client_config.json +0 -51
- data/lib/google/cloud/monitoring/dashboard/v1/doc/google/monitoring/dashboard/v1/common.rb +0 -394
- data/lib/google/cloud/monitoring/dashboard/v1/doc/google/monitoring/dashboard/v1/dashboard.rb +0 -53
- data/lib/google/cloud/monitoring/dashboard/v1/doc/google/monitoring/dashboard/v1/dashboards_service.rb +0 -82
- data/lib/google/cloud/monitoring/dashboard/v1/doc/google/monitoring/dashboard/v1/layouts.rb +0 -71
- data/lib/google/cloud/monitoring/dashboard/v1/doc/google/monitoring/dashboard/v1/metrics.rb +0 -151
- data/lib/google/cloud/monitoring/dashboard/v1/doc/google/monitoring/dashboard/v1/scorecard.rb +0 -102
- data/lib/google/cloud/monitoring/dashboard/v1/doc/google/monitoring/dashboard/v1/text.rb +0 -43
- data/lib/google/cloud/monitoring/dashboard/v1/doc/google/monitoring/dashboard/v1/widget.rb +0 -41
- data/lib/google/cloud/monitoring/dashboard/v1/doc/google/monitoring/dashboard/v1/xychart.rb +0 -141
- data/lib/google/cloud/monitoring/dashboard/v1/doc/google/protobuf/duration.rb +0 -91
- data/lib/google/cloud/monitoring/dashboard/v1/doc/google/protobuf/empty.rb +0 -29
- data/lib/google/cloud/monitoring/v3.rb +0 -532
- data/lib/google/cloud/monitoring/v3/alert_policy_service_client.rb +0 -553
- data/lib/google/cloud/monitoring/v3/alert_policy_service_client_config.json +0 -51
- data/lib/google/cloud/monitoring/v3/credentials.rb +0 -44
- data/lib/google/cloud/monitoring/v3/doc/google/api/distribution.rb +0 -200
- data/lib/google/cloud/monitoring/v3/doc/google/api/label.rb +0 -42
- data/lib/google/cloud/monitoring/v3/doc/google/api/metric.rb +0 -245
- data/lib/google/cloud/monitoring/v3/doc/google/api/monitored_resource.rb +0 -108
- data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/alert.rb +0 -344
- data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/alert_service.rb +0 -138
- data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/common.rb +0 -449
- data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/group.rb +0 -75
- data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/group_service.rb +0 -167
- data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/metric.rb +0 -85
- data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/metric_service.rb +0 -230
- data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/mutation_record.rb +0 -29
- data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/notification.rb +0 -156
- data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/notification_service.rb +0 -221
- data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/service.rb +0 -361
- data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/service_service.rb +0 -197
- data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/uptime.rb +0 -364
- data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/uptime_service.rb +0 -136
- data/lib/google/cloud/monitoring/v3/doc/google/protobuf/any.rb +0 -131
- data/lib/google/cloud/monitoring/v3/doc/google/protobuf/duration.rb +0 -91
- data/lib/google/cloud/monitoring/v3/doc/google/protobuf/empty.rb +0 -29
- data/lib/google/cloud/monitoring/v3/doc/google/protobuf/field_mask.rb +0 -222
- data/lib/google/cloud/monitoring/v3/doc/google/protobuf/struct.rb +0 -74
- data/lib/google/cloud/monitoring/v3/doc/google/protobuf/timestamp.rb +0 -113
- data/lib/google/cloud/monitoring/v3/doc/google/rpc/status.rb +0 -39
- data/lib/google/cloud/monitoring/v3/group_service_client.rb +0 -606
- data/lib/google/cloud/monitoring/v3/group_service_client_config.json +0 -56
- data/lib/google/cloud/monitoring/v3/metric_service_client.rb +0 -750
- data/lib/google/cloud/monitoring/v3/metric_service_client_config.json +0 -66
- data/lib/google/cloud/monitoring/v3/notification_channel_service_client.rb +0 -811
- data/lib/google/cloud/monitoring/v3/notification_channel_service_client_config.json +0 -76
- data/lib/google/cloud/monitoring/v3/service_monitoring_service_client.rb +0 -788
- data/lib/google/cloud/monitoring/v3/service_monitoring_service_client_config.json +0 -76
- data/lib/google/cloud/monitoring/v3/uptime_check_service_client.rb +0 -550
- data/lib/google/cloud/monitoring/v3/uptime_check_service_client_config.json +0 -56
- data/lib/google/monitoring/dashboard/v1/common_pb.rb +0 -95
- data/lib/google/monitoring/dashboard/v1/dashboard_pb.rb +0 -29
- data/lib/google/monitoring/dashboard/v1/dashboards_service_pb.rb +0 -51
- data/lib/google/monitoring/dashboard/v1/dashboards_service_services_pb.rb +0 -76
- data/lib/google/monitoring/dashboard/v1/drilldowns_pb.rb +0 -17
- data/lib/google/monitoring/dashboard/v1/layouts_pb.rb +0 -41
- data/lib/google/monitoring/dashboard/v1/metrics_pb.rb +0 -76
- data/lib/google/monitoring/dashboard/v1/scorecard_pb.rb +0 -38
- data/lib/google/monitoring/dashboard/v1/service_pb.rb +0 -17
- data/lib/google/monitoring/dashboard/v1/text_pb.rb +0 -28
- data/lib/google/monitoring/dashboard/v1/widget_pb.rb +0 -32
- data/lib/google/monitoring/dashboard/v1/xychart_pb.rb +0 -66
- data/lib/google/monitoring/v3/alert_pb.rb +0 -87
- data/lib/google/monitoring/v3/alert_service_pb.rb +0 -53
- data/lib/google/monitoring/v3/alert_service_services_pb.rb +0 -63
- data/lib/google/monitoring/v3/common_pb.rb +0 -95
- data/lib/google/monitoring/v3/dropped_labels_pb.rb +0 -19
- data/lib/google/monitoring/v3/group_pb.rb +0 -24
- data/lib/google/monitoring/v3/group_service_pb.rb +0 -73
- data/lib/google/monitoring/v3/group_service_services_pb.rb +0 -66
- data/lib/google/monitoring/v3/metric_pb.rb +0 -82
- data/lib/google/monitoring/v3/metric_service_pb.rb +0 -130
- data/lib/google/monitoring/v3/metric_service_services_pb.rb +0 -66
- data/lib/google/monitoring/v3/mutation_record_pb.rb +0 -21
- data/lib/google/monitoring/v3/notification_pb.rb +0 -47
- data/lib/google/monitoring/v3/notification_service_pb.rb +0 -90
- data/lib/google/monitoring/v3/notification_service_services_pb.rb +0 -94
- data/lib/google/monitoring/v3/service_pb.rb +0 -149
- data/lib/google/monitoring/v3/service_service_pb.rb +0 -86
- data/lib/google/monitoring/v3/service_service_services_pb.rb +0 -65
- data/lib/google/monitoring/v3/span_context_pb.rb +0 -19
- data/lib/google/monitoring/v3/uptime_pb.rb +0 -123
- data/lib/google/monitoring/v3/uptime_service_pb.rb +0 -63
- data/lib/google/monitoring/v3/uptime_service_services_pb.rb +0 -67
@@ -1,138 +0,0 @@
|
|
1
|
-
# Copyright 2020 Google LLC
|
2
|
-
#
|
3
|
-
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
-
# you may not use this file except in compliance with the License.
|
5
|
-
# You may obtain a copy of the License at
|
6
|
-
#
|
7
|
-
# https://www.apache.org/licenses/LICENSE-2.0
|
8
|
-
#
|
9
|
-
# Unless required by applicable law or agreed to in writing, software
|
10
|
-
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
-
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
-
# See the License for the specific language governing permissions and
|
13
|
-
# limitations under the License.
|
14
|
-
|
15
|
-
|
16
|
-
module Google
|
17
|
-
module Monitoring
|
18
|
-
module V3
|
19
|
-
# The protocol for the `CreateAlertPolicy` request.
|
20
|
-
# @!attribute [rw] name
|
21
|
-
# @return [String]
|
22
|
-
# Required. The project in which to create the alerting policy. The format is:
|
23
|
-
#
|
24
|
-
# projects/[PROJECT_ID_OR_NUMBER]
|
25
|
-
#
|
26
|
-
# Note that this field names the parent container in which the alerting
|
27
|
-
# policy will be written, not the name of the created policy. The alerting
|
28
|
-
# policy that is returned will have a name that contains a normalized
|
29
|
-
# representation of this name as a prefix but adds a suffix of the form
|
30
|
-
# `/alertPolicies/[ALERT_POLICY_ID]`, identifying the policy in the
|
31
|
-
# container.
|
32
|
-
# @!attribute [rw] alert_policy
|
33
|
-
# @return [Google::Monitoring::V3::AlertPolicy]
|
34
|
-
# Required. The requested alerting policy. You should omit the `name` field in this
|
35
|
-
# policy. The name will be returned in the new policy, including
|
36
|
-
# a new `[ALERT_POLICY_ID]` value.
|
37
|
-
class CreateAlertPolicyRequest; end
|
38
|
-
|
39
|
-
# The protocol for the `GetAlertPolicy` request.
|
40
|
-
# @!attribute [rw] name
|
41
|
-
# @return [String]
|
42
|
-
# Required. The alerting policy to retrieve. The format is:
|
43
|
-
#
|
44
|
-
# projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
|
45
|
-
class GetAlertPolicyRequest; end
|
46
|
-
|
47
|
-
# The protocol for the `ListAlertPolicies` request.
|
48
|
-
# @!attribute [rw] name
|
49
|
-
# @return [String]
|
50
|
-
# Required. The project whose alert policies are to be listed. The format is:
|
51
|
-
#
|
52
|
-
# projects/[PROJECT_ID_OR_NUMBER]
|
53
|
-
#
|
54
|
-
# Note that this field names the parent container in which the alerting
|
55
|
-
# policies to be listed are stored. To retrieve a single alerting policy
|
56
|
-
# by name, use the
|
57
|
-
# {Google::Monitoring::V3::AlertPolicyService::GetAlertPolicy GetAlertPolicy}
|
58
|
-
# operation, instead.
|
59
|
-
# @!attribute [rw] filter
|
60
|
-
# @return [String]
|
61
|
-
# If provided, this field specifies the criteria that must be met by
|
62
|
-
# alert policies to be included in the response.
|
63
|
-
#
|
64
|
-
# For more details, see [sorting and
|
65
|
-
# filtering](https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).
|
66
|
-
# @!attribute [rw] order_by
|
67
|
-
# @return [String]
|
68
|
-
# A comma-separated list of fields by which to sort the result. Supports
|
69
|
-
# the same set of field references as the `filter` field. Entries can be
|
70
|
-
# prefixed with a minus sign to sort by the field in descending order.
|
71
|
-
#
|
72
|
-
# For more details, see [sorting and
|
73
|
-
# filtering](https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).
|
74
|
-
# @!attribute [rw] page_size
|
75
|
-
# @return [Integer]
|
76
|
-
# The maximum number of results to return in a single response.
|
77
|
-
# @!attribute [rw] page_token
|
78
|
-
# @return [String]
|
79
|
-
# If this field is not empty then it must contain the `nextPageToken` value
|
80
|
-
# returned by a previous call to this method. Using this field causes the
|
81
|
-
# method to return more results from the previous method call.
|
82
|
-
class ListAlertPoliciesRequest; end
|
83
|
-
|
84
|
-
# The protocol for the `ListAlertPolicies` response.
|
85
|
-
# @!attribute [rw] alert_policies
|
86
|
-
# @return [Array<Google::Monitoring::V3::AlertPolicy>]
|
87
|
-
# The returned alert policies.
|
88
|
-
# @!attribute [rw] next_page_token
|
89
|
-
# @return [String]
|
90
|
-
# If there might be more results than were returned, then this field is set
|
91
|
-
# to a non-empty value. To see the additional results,
|
92
|
-
# use that value as `page_token` in the next call to this method.
|
93
|
-
class ListAlertPoliciesResponse; end
|
94
|
-
|
95
|
-
# The protocol for the `UpdateAlertPolicy` request.
|
96
|
-
# @!attribute [rw] update_mask
|
97
|
-
# @return [Google::Protobuf::FieldMask]
|
98
|
-
# Optional. A list of alerting policy field names. If this field is not
|
99
|
-
# empty, each listed field in the existing alerting policy is set to the
|
100
|
-
# value of the corresponding field in the supplied policy (`alert_policy`),
|
101
|
-
# or to the field's default value if the field is not in the supplied
|
102
|
-
# alerting policy. Fields not listed retain their previous value.
|
103
|
-
#
|
104
|
-
# Examples of valid field masks include `display_name`, `documentation`,
|
105
|
-
# `documentation.content`, `documentation.mime_type`, `user_labels`,
|
106
|
-
# `user_label.nameofkey`, `enabled`, `conditions`, `combiner`, etc.
|
107
|
-
#
|
108
|
-
# If this field is empty, then the supplied alerting policy replaces the
|
109
|
-
# existing policy. It is the same as deleting the existing policy and
|
110
|
-
# adding the supplied policy, except for the following:
|
111
|
-
#
|
112
|
-
# * The new policy will have the same `[ALERT_POLICY_ID]` as the former
|
113
|
-
# policy. This gives you continuity with the former policy in your
|
114
|
-
# notifications and incidents.
|
115
|
-
# * Conditions in the new policy will keep their former `[CONDITION_ID]` if
|
116
|
-
# the supplied condition includes the `name` field with that
|
117
|
-
# `[CONDITION_ID]`. If the supplied condition omits the `name` field,
|
118
|
-
# then a new `[CONDITION_ID]` is created.
|
119
|
-
# @!attribute [rw] alert_policy
|
120
|
-
# @return [Google::Monitoring::V3::AlertPolicy]
|
121
|
-
# Required. The updated alerting policy or the updated values for the
|
122
|
-
# fields listed in `update_mask`.
|
123
|
-
# If `update_mask` is not empty, any fields in this policy that are
|
124
|
-
# not in `update_mask` are ignored.
|
125
|
-
class UpdateAlertPolicyRequest; end
|
126
|
-
|
127
|
-
# The protocol for the `DeleteAlertPolicy` request.
|
128
|
-
# @!attribute [rw] name
|
129
|
-
# @return [String]
|
130
|
-
# Required. The alerting policy to delete. The format is:
|
131
|
-
#
|
132
|
-
# projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
|
133
|
-
#
|
134
|
-
# For more information, see {Google::Monitoring::V3::AlertPolicy AlertPolicy}.
|
135
|
-
class DeleteAlertPolicyRequest; end
|
136
|
-
end
|
137
|
-
end
|
138
|
-
end
|
@@ -1,449 +0,0 @@
|
|
1
|
-
# Copyright 2020 Google LLC
|
2
|
-
#
|
3
|
-
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
-
# you may not use this file except in compliance with the License.
|
5
|
-
# You may obtain a copy of the License at
|
6
|
-
#
|
7
|
-
# https://www.apache.org/licenses/LICENSE-2.0
|
8
|
-
#
|
9
|
-
# Unless required by applicable law or agreed to in writing, software
|
10
|
-
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
-
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
-
# See the License for the specific language governing permissions and
|
13
|
-
# limitations under the License.
|
14
|
-
|
15
|
-
|
16
|
-
module Google
|
17
|
-
module Monitoring
|
18
|
-
module V3
|
19
|
-
# A single strongly-typed value.
|
20
|
-
# @!attribute [rw] bool_value
|
21
|
-
# @return [true, false]
|
22
|
-
# A Boolean value: `true` or `false`.
|
23
|
-
# @!attribute [rw] int64_value
|
24
|
-
# @return [Integer]
|
25
|
-
# A 64-bit integer. Its range is approximately ±9.2x10<sup>18</sup>.
|
26
|
-
# @!attribute [rw] double_value
|
27
|
-
# @return [Float]
|
28
|
-
# A 64-bit double-precision floating-point number. Its magnitude
|
29
|
-
# is approximately ±10<sup>±300</sup> and it has 16
|
30
|
-
# significant digits of precision.
|
31
|
-
# @!attribute [rw] string_value
|
32
|
-
# @return [String]
|
33
|
-
# A variable-length string value.
|
34
|
-
# @!attribute [rw] distribution_value
|
35
|
-
# @return [Google::Api::Distribution]
|
36
|
-
# A distribution value.
|
37
|
-
class TypedValue; end
|
38
|
-
|
39
|
-
# A closed time interval. It extends from the start time to the end time, and includes both: `[startTime, endTime]`. Valid time intervals depend on the [`MetricKind`](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors#MetricKind) of the metric value. In no case can the end time be earlier than the start time.
|
40
|
-
#
|
41
|
-
# * For a `GAUGE` metric, the `startTime` value is technically optional; if
|
42
|
-
# no value is specified, the start time defaults to the value of the
|
43
|
-
# end time, and the interval represents a single point in time. If both
|
44
|
-
# start and end times are specified, they must be identical. Such an
|
45
|
-
# interval is valid only for `GAUGE` metrics, which are point-in-time
|
46
|
-
# measurements.
|
47
|
-
#
|
48
|
-
# * For `DELTA` and `CUMULATIVE` metrics, the start time must be earlier
|
49
|
-
# than the end time.
|
50
|
-
#
|
51
|
-
# * In all cases, the start time of the next interval must be
|
52
|
-
# at least a millisecond after the end time of the previous interval.
|
53
|
-
# Because the interval is closed, if the start time of a new interval
|
54
|
-
# is the same as the end time of the previous interval, data written
|
55
|
-
# at the new start time could overwrite data written at the previous
|
56
|
-
# end time.
|
57
|
-
# @!attribute [rw] end_time
|
58
|
-
# @return [Google::Protobuf::Timestamp]
|
59
|
-
# Required. The end of the time interval.
|
60
|
-
# @!attribute [rw] start_time
|
61
|
-
# @return [Google::Protobuf::Timestamp]
|
62
|
-
# Optional. The beginning of the time interval. The default value
|
63
|
-
# for the start time is the end time. The start time must not be
|
64
|
-
# later than the end time.
|
65
|
-
class TimeInterval; end
|
66
|
-
|
67
|
-
# Describes how to combine multiple time series to provide a different view of
|
68
|
-
# the data. Aggregation of time series is done in two steps. First, each time
|
69
|
-
# series in the set is _aligned_ to the same time interval boundaries, then the
|
70
|
-
# set of time series is optionally _reduced_ in number.
|
71
|
-
#
|
72
|
-
# Alignment consists of applying the `per_series_aligner` operation
|
73
|
-
# to each time series after its data has been divided into regular
|
74
|
-
# `alignment_period` time intervals. This process takes _all_ of the data
|
75
|
-
# points in an alignment period, applies a mathematical transformation such as
|
76
|
-
# averaging, minimum, maximum, delta, etc., and converts them into a single
|
77
|
-
# data point per period.
|
78
|
-
#
|
79
|
-
# Reduction is when the aligned and transformed time series can optionally be
|
80
|
-
# combined, reducing the number of time series through similar mathematical
|
81
|
-
# transformations. Reduction involves applying a `cross_series_reducer` to
|
82
|
-
# all the time series, optionally sorting the time series into subsets with
|
83
|
-
# `group_by_fields`, and applying the reducer to each subset.
|
84
|
-
#
|
85
|
-
# The raw time series data can contain a huge amount of information from
|
86
|
-
# multiple sources. Alignment and reduction transforms this mass of data into
|
87
|
-
# a more manageable and representative collection of data, for example "the
|
88
|
-
# 95% latency across the average of all tasks in a cluster". This
|
89
|
-
# representative data can be more easily graphed and comprehended, and the
|
90
|
-
# individual time series data is still available for later drilldown. For more
|
91
|
-
# details, see [Filtering and
|
92
|
-
# aggregation](https://cloud.google.com/monitoring/api/v3/aggregation).
|
93
|
-
# @!attribute [rw] alignment_period
|
94
|
-
# @return [Google::Protobuf::Duration]
|
95
|
-
# The `alignment_period` specifies a time interval, in seconds, that is used
|
96
|
-
# to divide the data in all the
|
97
|
-
# {Google::Monitoring::V3::TimeSeries time series} into consistent blocks of
|
98
|
-
# time. This will be done before the per-series aligner can be applied to
|
99
|
-
# the data.
|
100
|
-
#
|
101
|
-
# The value must be at least 60 seconds. If a per-series aligner other than
|
102
|
-
# `ALIGN_NONE` is specified, this field is required or an error is returned.
|
103
|
-
# If no per-series aligner is specified, or the aligner `ALIGN_NONE` is
|
104
|
-
# specified, then this field is ignored.
|
105
|
-
# @!attribute [rw] per_series_aligner
|
106
|
-
# @return [Google::Monitoring::V3::Aggregation::Aligner]
|
107
|
-
# An `Aligner` describes how to bring the data points in a single
|
108
|
-
# time series into temporal alignment. Except for `ALIGN_NONE`, all
|
109
|
-
# alignments cause all the data points in an `alignment_period` to be
|
110
|
-
# mathematically grouped together, resulting in a single data point for
|
111
|
-
# each `alignment_period` with end timestamp at the end of the period.
|
112
|
-
#
|
113
|
-
# Not all alignment operations may be applied to all time series. The valid
|
114
|
-
# choices depend on the `metric_kind` and `value_type` of the original time
|
115
|
-
# series. Alignment can change the `metric_kind` or the `value_type` of
|
116
|
-
# the time series.
|
117
|
-
#
|
118
|
-
# Time series data must be aligned in order to perform cross-time
|
119
|
-
# series reduction. If `cross_series_reducer` is specified, then
|
120
|
-
# `per_series_aligner` must be specified and not equal to `ALIGN_NONE`
|
121
|
-
# and `alignment_period` must be specified; otherwise, an error is
|
122
|
-
# returned.
|
123
|
-
# @!attribute [rw] cross_series_reducer
|
124
|
-
# @return [Google::Monitoring::V3::Aggregation::Reducer]
|
125
|
-
# The reduction operation to be used to combine time series into a single
|
126
|
-
# time series, where the value of each data point in the resulting series is
|
127
|
-
# a function of all the already aligned values in the input time series.
|
128
|
-
#
|
129
|
-
# Not all reducer operations can be applied to all time series. The valid
|
130
|
-
# choices depend on the `metric_kind` and the `value_type` of the original
|
131
|
-
# time series. Reduction can yield a time series with a different
|
132
|
-
# `metric_kind` or `value_type` than the input time series.
|
133
|
-
#
|
134
|
-
# Time series data must first be aligned (see `per_series_aligner`) in order
|
135
|
-
# to perform cross-time series reduction. If `cross_series_reducer` is
|
136
|
-
# specified, then `per_series_aligner` must be specified, and must not be
|
137
|
-
# `ALIGN_NONE`. An `alignment_period` must also be specified; otherwise, an
|
138
|
-
# error is returned.
|
139
|
-
# @!attribute [rw] group_by_fields
|
140
|
-
# @return [Array<String>]
|
141
|
-
# The set of fields to preserve when `cross_series_reducer` is
|
142
|
-
# specified. The `group_by_fields` determine how the time series are
|
143
|
-
# partitioned into subsets prior to applying the aggregation
|
144
|
-
# operation. Each subset contains time series that have the same
|
145
|
-
# value for each of the grouping fields. Each individual time
|
146
|
-
# series is a member of exactly one subset. The
|
147
|
-
# `cross_series_reducer` is applied to each subset of time series.
|
148
|
-
# It is not possible to reduce across different resource types, so
|
149
|
-
# this field implicitly contains `resource.type`. Fields not
|
150
|
-
# specified in `group_by_fields` are aggregated away. If
|
151
|
-
# `group_by_fields` is not specified and all the time series have
|
152
|
-
# the same resource type, then the time series are aggregated into
|
153
|
-
# a single output time series. If `cross_series_reducer` is not
|
154
|
-
# defined, this field is ignored.
|
155
|
-
class Aggregation
|
156
|
-
# The `Aligner` specifies the operation that will be applied to the data
|
157
|
-
# points in each alignment period in a time series. Except for
|
158
|
-
# `ALIGN_NONE`, which specifies that no operation be applied, each alignment
|
159
|
-
# operation replaces the set of data values in each alignment period with
|
160
|
-
# a single value: the result of applying the operation to the data values.
|
161
|
-
# An aligned time series has a single data value at the end of each
|
162
|
-
# `alignment_period`.
|
163
|
-
#
|
164
|
-
# An alignment operation can change the data type of the values, too. For
|
165
|
-
# example, if you apply a counting operation to boolean values, the data
|
166
|
-
# `value_type` in the original time series is `BOOLEAN`, but the `value_type`
|
167
|
-
# in the aligned result is `INT64`.
|
168
|
-
module Aligner
|
169
|
-
# No alignment. Raw data is returned. Not valid if cross-series reduction
|
170
|
-
# is requested. The `value_type` of the result is the same as the
|
171
|
-
# `value_type` of the input.
|
172
|
-
ALIGN_NONE = 0
|
173
|
-
|
174
|
-
# Align and convert to
|
175
|
-
# {Google::Api::MetricDescriptor::MetricKind::DELTA DELTA}.
|
176
|
-
# The output is `delta = y1 - y0`.
|
177
|
-
#
|
178
|
-
# This alignment is valid for
|
179
|
-
# {Google::Api::MetricDescriptor::MetricKind::CUMULATIVE CUMULATIVE} and
|
180
|
-
# `DELTA` metrics. If the selected alignment period results in periods
|
181
|
-
# with no data, then the aligned value for such a period is created by
|
182
|
-
# interpolation. The `value_type` of the aligned result is the same as
|
183
|
-
# the `value_type` of the input.
|
184
|
-
ALIGN_DELTA = 1
|
185
|
-
|
186
|
-
# Align and convert to a rate. The result is computed as
|
187
|
-
# `rate = (y1 - y0)/(t1 - t0)`, or "delta over time".
|
188
|
-
# Think of this aligner as providing the slope of the line that passes
|
189
|
-
# through the value at the start and at the end of the `alignment_period`.
|
190
|
-
#
|
191
|
-
# This aligner is valid for `CUMULATIVE`
|
192
|
-
# and `DELTA` metrics with numeric values. If the selected alignment
|
193
|
-
# period results in periods with no data, then the aligned value for
|
194
|
-
# such a period is created by interpolation. The output is a `GAUGE`
|
195
|
-
# metric with `value_type` `DOUBLE`.
|
196
|
-
#
|
197
|
-
# If, by "rate", you mean "percentage change", see the
|
198
|
-
# `ALIGN_PERCENT_CHANGE` aligner instead.
|
199
|
-
ALIGN_RATE = 2
|
200
|
-
|
201
|
-
# Align by interpolating between adjacent points around the alignment
|
202
|
-
# period boundary. This aligner is valid for `GAUGE` metrics with
|
203
|
-
# numeric values. The `value_type` of the aligned result is the same as the
|
204
|
-
# `value_type` of the input.
|
205
|
-
ALIGN_INTERPOLATE = 3
|
206
|
-
|
207
|
-
# Align by moving the most recent data point before the end of the
|
208
|
-
# alignment period to the boundary at the end of the alignment
|
209
|
-
# period. This aligner is valid for `GAUGE` metrics. The `value_type` of
|
210
|
-
# the aligned result is the same as the `value_type` of the input.
|
211
|
-
ALIGN_NEXT_OLDER = 4
|
212
|
-
|
213
|
-
# Align the time series by returning the minimum value in each alignment
|
214
|
-
# period. This aligner is valid for `GAUGE` and `DELTA` metrics with
|
215
|
-
# numeric values. The `value_type` of the aligned result is the same as
|
216
|
-
# the `value_type` of the input.
|
217
|
-
ALIGN_MIN = 10
|
218
|
-
|
219
|
-
# Align the time series by returning the maximum value in each alignment
|
220
|
-
# period. This aligner is valid for `GAUGE` and `DELTA` metrics with
|
221
|
-
# numeric values. The `value_type` of the aligned result is the same as
|
222
|
-
# the `value_type` of the input.
|
223
|
-
ALIGN_MAX = 11
|
224
|
-
|
225
|
-
# Align the time series by returning the mean value in each alignment
|
226
|
-
# period. This aligner is valid for `GAUGE` and `DELTA` metrics with
|
227
|
-
# numeric values. The `value_type` of the aligned result is `DOUBLE`.
|
228
|
-
ALIGN_MEAN = 12
|
229
|
-
|
230
|
-
# Align the time series by returning the number of values in each alignment
|
231
|
-
# period. This aligner is valid for `GAUGE` and `DELTA` metrics with
|
232
|
-
# numeric or Boolean values. The `value_type` of the aligned result is
|
233
|
-
# `INT64`.
|
234
|
-
ALIGN_COUNT = 13
|
235
|
-
|
236
|
-
# Align the time series by returning the sum of the values in each
|
237
|
-
# alignment period. This aligner is valid for `GAUGE` and `DELTA`
|
238
|
-
# metrics with numeric and distribution values. The `value_type` of the
|
239
|
-
# aligned result is the same as the `value_type` of the input.
|
240
|
-
ALIGN_SUM = 14
|
241
|
-
|
242
|
-
# Align the time series by returning the standard deviation of the values
|
243
|
-
# in each alignment period. This aligner is valid for `GAUGE` and
|
244
|
-
# `DELTA` metrics with numeric values. The `value_type` of the output is
|
245
|
-
# `DOUBLE`.
|
246
|
-
ALIGN_STDDEV = 15
|
247
|
-
|
248
|
-
# Align the time series by returning the number of `True` values in
|
249
|
-
# each alignment period. This aligner is valid for `GAUGE` metrics with
|
250
|
-
# Boolean values. The `value_type` of the output is `INT64`.
|
251
|
-
ALIGN_COUNT_TRUE = 16
|
252
|
-
|
253
|
-
# Align the time series by returning the number of `False` values in
|
254
|
-
# each alignment period. This aligner is valid for `GAUGE` metrics with
|
255
|
-
# Boolean values. The `value_type` of the output is `INT64`.
|
256
|
-
ALIGN_COUNT_FALSE = 24
|
257
|
-
|
258
|
-
# Align the time series by returning the ratio of the number of `True`
|
259
|
-
# values to the total number of values in each alignment period. This
|
260
|
-
# aligner is valid for `GAUGE` metrics with Boolean values. The output
|
261
|
-
# value is in the range [0.0, 1.0] and has `value_type` `DOUBLE`.
|
262
|
-
ALIGN_FRACTION_TRUE = 17
|
263
|
-
|
264
|
-
# Align the time series by using [percentile
|
265
|
-
# aggregation](https://en.wikipedia.org/wiki/Percentile). The resulting
|
266
|
-
# data point in each alignment period is the 99th percentile of all data
|
267
|
-
# points in the period. This aligner is valid for `GAUGE` and `DELTA`
|
268
|
-
# metrics with distribution values. The output is a `GAUGE` metric with
|
269
|
-
# `value_type` `DOUBLE`.
|
270
|
-
ALIGN_PERCENTILE_99 = 18
|
271
|
-
|
272
|
-
# Align the time series by using [percentile
|
273
|
-
# aggregation](https://en.wikipedia.org/wiki/Percentile). The resulting
|
274
|
-
# data point in each alignment period is the 95th percentile of all data
|
275
|
-
# points in the period. This aligner is valid for `GAUGE` and `DELTA`
|
276
|
-
# metrics with distribution values. The output is a `GAUGE` metric with
|
277
|
-
# `value_type` `DOUBLE`.
|
278
|
-
ALIGN_PERCENTILE_95 = 19
|
279
|
-
|
280
|
-
# Align the time series by using [percentile
|
281
|
-
# aggregation](https://en.wikipedia.org/wiki/Percentile). The resulting
|
282
|
-
# data point in each alignment period is the 50th percentile of all data
|
283
|
-
# points in the period. This aligner is valid for `GAUGE` and `DELTA`
|
284
|
-
# metrics with distribution values. The output is a `GAUGE` metric with
|
285
|
-
# `value_type` `DOUBLE`.
|
286
|
-
ALIGN_PERCENTILE_50 = 20
|
287
|
-
|
288
|
-
# Align the time series by using [percentile
|
289
|
-
# aggregation](https://en.wikipedia.org/wiki/Percentile). The resulting
|
290
|
-
# data point in each alignment period is the 5th percentile of all data
|
291
|
-
# points in the period. This aligner is valid for `GAUGE` and `DELTA`
|
292
|
-
# metrics with distribution values. The output is a `GAUGE` metric with
|
293
|
-
# `value_type` `DOUBLE`.
|
294
|
-
ALIGN_PERCENTILE_05 = 21
|
295
|
-
|
296
|
-
# Align and convert to a percentage change. This aligner is valid for
|
297
|
-
# `GAUGE` and `DELTA` metrics with numeric values. This alignment returns
|
298
|
-
# `((current - previous)/previous) * 100`, where the value of `previous` is
|
299
|
-
# determined based on the `alignment_period`.
|
300
|
-
#
|
301
|
-
# If the values of `current` and `previous` are both 0, then the returned
|
302
|
-
# value is 0. If only `previous` is 0, the returned value is infinity.
|
303
|
-
#
|
304
|
-
# A 10-minute moving mean is computed at each point of the alignment period
|
305
|
-
# prior to the above calculation to smooth the metric and prevent false
|
306
|
-
# positives from very short-lived spikes. The moving mean is only
|
307
|
-
# applicable for data whose values are `>= 0`. Any values `< 0` are
|
308
|
-
# treated as a missing datapoint, and are ignored. While `DELTA`
|
309
|
-
# metrics are accepted by this alignment, special care should be taken that
|
310
|
-
# the values for the metric will always be positive. The output is a
|
311
|
-
# `GAUGE` metric with `value_type` `DOUBLE`.
|
312
|
-
ALIGN_PERCENT_CHANGE = 23
|
313
|
-
end
|
314
|
-
|
315
|
-
# A Reducer operation describes how to aggregate data points from multiple
|
316
|
-
# time series into a single time series, where the value of each data point
|
317
|
-
# in the resulting series is a function of all the already aligned values in
|
318
|
-
# the input time series.
|
319
|
-
module Reducer
|
320
|
-
# No cross-time series reduction. The output of the `Aligner` is
|
321
|
-
# returned.
|
322
|
-
REDUCE_NONE = 0
|
323
|
-
|
324
|
-
# Reduce by computing the mean value across time series for each
|
325
|
-
# alignment period. This reducer is valid for
|
326
|
-
# {Google::Api::MetricDescriptor::MetricKind::DELTA DELTA} and
|
327
|
-
# {Google::Api::MetricDescriptor::MetricKind::GAUGE GAUGE} metrics with
|
328
|
-
# numeric or distribution values. The `value_type` of the output is
|
329
|
-
# {Google::Api::MetricDescriptor::ValueType::DOUBLE DOUBLE}.
|
330
|
-
REDUCE_MEAN = 1
|
331
|
-
|
332
|
-
# Reduce by computing the minimum value across time series for each
|
333
|
-
# alignment period. This reducer is valid for `DELTA` and `GAUGE` metrics
|
334
|
-
# with numeric values. The `value_type` of the output is the same as the
|
335
|
-
# `value_type` of the input.
|
336
|
-
REDUCE_MIN = 2
|
337
|
-
|
338
|
-
# Reduce by computing the maximum value across time series for each
|
339
|
-
# alignment period. This reducer is valid for `DELTA` and `GAUGE` metrics
|
340
|
-
# with numeric values. The `value_type` of the output is the same as the
|
341
|
-
# `value_type` of the input.
|
342
|
-
REDUCE_MAX = 3
|
343
|
-
|
344
|
-
# Reduce by computing the sum across time series for each
|
345
|
-
# alignment period. This reducer is valid for `DELTA` and `GAUGE` metrics
|
346
|
-
# with numeric and distribution values. The `value_type` of the output is
|
347
|
-
# the same as the `value_type` of the input.
|
348
|
-
REDUCE_SUM = 4
|
349
|
-
|
350
|
-
# Reduce by computing the standard deviation across time series
|
351
|
-
# for each alignment period. This reducer is valid for `DELTA` and
|
352
|
-
# `GAUGE` metrics with numeric or distribution values. The `value_type`
|
353
|
-
# of the output is `DOUBLE`.
|
354
|
-
REDUCE_STDDEV = 5
|
355
|
-
|
356
|
-
# Reduce by computing the number of data points across time series
|
357
|
-
# for each alignment period. This reducer is valid for `DELTA` and
|
358
|
-
# `GAUGE` metrics of numeric, Boolean, distribution, and string
|
359
|
-
# `value_type`. The `value_type` of the output is `INT64`.
|
360
|
-
REDUCE_COUNT = 6
|
361
|
-
|
362
|
-
# Reduce by computing the number of `True`-valued data points across time
|
363
|
-
# series for each alignment period. This reducer is valid for `DELTA` and
|
364
|
-
# `GAUGE` metrics of Boolean `value_type`. The `value_type` of the output
|
365
|
-
# is `INT64`.
|
366
|
-
REDUCE_COUNT_TRUE = 7
|
367
|
-
|
368
|
-
# Reduce by computing the number of `False`-valued data points across time
|
369
|
-
# series for each alignment period. This reducer is valid for `DELTA` and
|
370
|
-
# `GAUGE` metrics of Boolean `value_type`. The `value_type` of the output
|
371
|
-
# is `INT64`.
|
372
|
-
REDUCE_COUNT_FALSE = 15
|
373
|
-
|
374
|
-
# Reduce by computing the ratio of the number of `True`-valued data points
|
375
|
-
# to the total number of data points for each alignment period. This
|
376
|
-
# reducer is valid for `DELTA` and `GAUGE` metrics of Boolean `value_type`.
|
377
|
-
# The output value is in the range [0.0, 1.0] and has `value_type`
|
378
|
-
# `DOUBLE`.
|
379
|
-
REDUCE_FRACTION_TRUE = 8
|
380
|
-
|
381
|
-
# Reduce by computing the [99th
|
382
|
-
# percentile](https://en.wikipedia.org/wiki/Percentile) of data points
|
383
|
-
# across time series for each alignment period. This reducer is valid for
|
384
|
-
# `GAUGE` and `DELTA` metrics of numeric and distribution type. The value
|
385
|
-
# of the output is `DOUBLE`.
|
386
|
-
REDUCE_PERCENTILE_99 = 9
|
387
|
-
|
388
|
-
# Reduce by computing the [95th
|
389
|
-
# percentile](https://en.wikipedia.org/wiki/Percentile) of data points
|
390
|
-
# across time series for each alignment period. This reducer is valid for
|
391
|
-
# `GAUGE` and `DELTA` metrics of numeric and distribution type. The value
|
392
|
-
# of the output is `DOUBLE`.
|
393
|
-
REDUCE_PERCENTILE_95 = 10
|
394
|
-
|
395
|
-
# Reduce by computing the [50th
|
396
|
-
# percentile](https://en.wikipedia.org/wiki/Percentile) of data points
|
397
|
-
# across time series for each alignment period. This reducer is valid for
|
398
|
-
# `GAUGE` and `DELTA` metrics of numeric and distribution type. The value
|
399
|
-
# of the output is `DOUBLE`.
|
400
|
-
REDUCE_PERCENTILE_50 = 11
|
401
|
-
|
402
|
-
# Reduce by computing the [5th
|
403
|
-
# percentile](https://en.wikipedia.org/wiki/Percentile) of data points
|
404
|
-
# across time series for each alignment period. This reducer is valid for
|
405
|
-
# `GAUGE` and `DELTA` metrics of numeric and distribution type. The value
|
406
|
-
# of the output is `DOUBLE`.
|
407
|
-
REDUCE_PERCENTILE_05 = 12
|
408
|
-
end
|
409
|
-
end
|
410
|
-
|
411
|
-
# Specifies an ordering relationship on two arguments, called `left` and
|
412
|
-
# `right`.
|
413
|
-
module ComparisonType
|
414
|
-
# No ordering relationship is specified.
|
415
|
-
COMPARISON_UNSPECIFIED = 0
|
416
|
-
|
417
|
-
# True if the left argument is greater than the right argument.
|
418
|
-
COMPARISON_GT = 1
|
419
|
-
|
420
|
-
# True if the left argument is greater than or equal to the right argument.
|
421
|
-
COMPARISON_GE = 2
|
422
|
-
|
423
|
-
# True if the left argument is less than the right argument.
|
424
|
-
COMPARISON_LT = 3
|
425
|
-
|
426
|
-
# True if the left argument is less than or equal to the right argument.
|
427
|
-
COMPARISON_LE = 4
|
428
|
-
|
429
|
-
# True if the left argument is equal to the right argument.
|
430
|
-
COMPARISON_EQ = 5
|
431
|
-
|
432
|
-
# True if the left argument is not equal to the right argument.
|
433
|
-
COMPARISON_NE = 6
|
434
|
-
end
|
435
|
-
|
436
|
-
# Obsolete.
|
437
|
-
module ServiceTier
|
438
|
-
# Obsolete.
|
439
|
-
SERVICE_TIER_UNSPECIFIED = 0
|
440
|
-
|
441
|
-
# Obsolete.
|
442
|
-
SERVICE_TIER_BASIC = 1
|
443
|
-
|
444
|
-
# Obsolete.
|
445
|
-
SERVICE_TIER_PREMIUM = 2
|
446
|
-
end
|
447
|
-
end
|
448
|
-
end
|
449
|
-
end
|