google-cloud-monitoring-v3 1.0.1 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +30 -20
- data/lib/google/cloud/monitoring/v3/alert_policy_service/client.rb +38 -15
- data/lib/google/cloud/monitoring/v3/group_service/client.rb +29 -7
- data/lib/google/cloud/monitoring/v3/metric_service/client.rb +30 -10
- data/lib/google/cloud/monitoring/v3/notification_channel_service/client.rb +39 -21
- data/lib/google/cloud/monitoring/v3/query_service/client.rb +28 -2
- data/lib/google/cloud/monitoring/v3/service_monitoring_service/client.rb +29 -11
- data/lib/google/cloud/monitoring/v3/snooze_service/client.rb +28 -5
- data/lib/google/cloud/monitoring/v3/uptime_check_service/client.rb +29 -7
- data/lib/google/cloud/monitoring/v3/version.rb +1 -1
- data/lib/google/monitoring/v3/alert_pb.rb +2 -1
- data/lib/google/monitoring/v3/alert_service_pb.rb +1 -1
- data/lib/google/monitoring/v3/notification_pb.rb +2 -1
- data/lib/google/monitoring/v3/notification_service_pb.rb +1 -1
- data/lib/google/monitoring/v3/snooze_pb.rb +1 -1
- data/proto_docs/google/api/client.rb +39 -0
- data/proto_docs/google/api/metric.rb +18 -0
- data/proto_docs/google/monitoring/v3/alert.rb +39 -20
- data/proto_docs/google/monitoring/v3/alert_service.rb +10 -9
- data/proto_docs/google/monitoring/v3/notification.rb +1 -1
- data/proto_docs/google/monitoring/v3/notification_service.rb +10 -10
- data/proto_docs/google/monitoring/v3/snooze.rb +1 -1
- metadata +5 -5
@@ -23,12 +23,12 @@ module Google
|
|
23
23
|
module V3
|
24
24
|
# A description of the conditions under which some aspect of your system is
|
25
25
|
# considered to be "unhealthy" and the ways to notify people or services about
|
26
|
-
# this state. For an overview of
|
26
|
+
# this state. For an overview of alerting policies, see
|
27
27
|
# [Introduction to Alerting](https://cloud.google.com/monitoring/alerts/).
|
28
28
|
# @!attribute [rw] name
|
29
29
|
# @return [::String]
|
30
|
-
# Required if the policy exists. The resource name for this
|
31
|
-
# format is:
|
30
|
+
# Identifier. Required if the policy exists. The resource name for this
|
31
|
+
# policy. The format is:
|
32
32
|
#
|
33
33
|
# projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
|
34
34
|
#
|
@@ -97,9 +97,9 @@ module Google
|
|
97
97
|
# a field projection has been specified that strips it out.
|
98
98
|
# @!attribute [rw] validity
|
99
99
|
# @return [::Google::Rpc::Status]
|
100
|
-
# Read-only description of how the
|
101
|
-
# only set when the
|
102
|
-
# generate incidents.
|
100
|
+
# Read-only description of how the alerting policy is invalid. This field is
|
101
|
+
# only set when the alerting policy is invalid. An invalid alerting policy
|
102
|
+
# will not generate incidents.
|
103
103
|
# @!attribute [rw] notification_channels
|
104
104
|
# @return [::Array<::String>]
|
105
105
|
# Identifies the notification channels to which notifications should be sent
|
@@ -122,12 +122,12 @@ module Google
|
|
122
122
|
# provided in a call to create or update, this field will be ignored.
|
123
123
|
# @!attribute [rw] alert_strategy
|
124
124
|
# @return [::Google::Cloud::Monitoring::V3::AlertPolicy::AlertStrategy]
|
125
|
-
# Control over how this
|
125
|
+
# Control over how this alerting policy's notification channels are notified.
|
126
126
|
# @!attribute [rw] severity
|
127
127
|
# @return [::Google::Cloud::Monitoring::V3::AlertPolicy::Severity]
|
128
|
-
# Optional. The severity of an
|
129
|
-
# generated by that policy are. The severity level will be
|
130
|
-
# Incident detail page and in notifications.
|
128
|
+
# Optional. The severity of an alerting policy indicates how important
|
129
|
+
# incidents generated by that policy are. The severity level will be
|
130
|
+
# displayed on the Incident detail page and in notifications.
|
131
131
|
class AlertPolicy
|
132
132
|
include ::Google::Protobuf::MessageExts
|
133
133
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -140,7 +140,7 @@ module Google
|
|
140
140
|
# The content may not exceed 8,192 Unicode characters and may not exceed
|
141
141
|
# more than 10,240 bytes when encoded in UTF-8 format, whichever is
|
142
142
|
# smaller. This text can be [templatized by using
|
143
|
-
# variables](https://cloud.google.com/monitoring/alerts/doc-variables).
|
143
|
+
# variables](https://cloud.google.com/monitoring/alerts/doc-variables#doc-vars).
|
144
144
|
# @!attribute [rw] mime_type
|
145
145
|
# @return [::String]
|
146
146
|
# The format of the `content` field. Presently, only the value
|
@@ -158,7 +158,7 @@ module Google
|
|
158
158
|
# it is common to define textual fields in databases as VARCHAR(255).
|
159
159
|
#
|
160
160
|
# The contents of the subject line can be [templatized by using
|
161
|
-
# variables](https://cloud.google.com/monitoring/alerts/doc-variables).
|
161
|
+
# variables](https://cloud.google.com/monitoring/alerts/doc-variables#doc-vars).
|
162
162
|
# If this field is missing or empty, a default subject line will be
|
163
163
|
# generated.
|
164
164
|
# @!attribute [rw] links
|
@@ -460,7 +460,7 @@ module Google
|
|
460
460
|
end
|
461
461
|
end
|
462
462
|
|
463
|
-
# A condition type that allows
|
463
|
+
# A condition type that allows alerting policies to be defined using
|
464
464
|
# [Monitoring Query Language](https://cloud.google.com/monitoring/mql).
|
465
465
|
# @!attribute [rw] query
|
466
466
|
# @return [::String]
|
@@ -495,7 +495,7 @@ module Google
|
|
495
495
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
496
496
|
end
|
497
497
|
|
498
|
-
# A condition type that allows
|
498
|
+
# A condition type that allows alerting policies to be defined using
|
499
499
|
# [Prometheus Query Language
|
500
500
|
# (PromQL)](https://prometheus.io/docs/prometheus/latest/querying/basics/).
|
501
501
|
#
|
@@ -553,7 +553,7 @@ module Google
|
|
553
553
|
# Label names [must be
|
554
554
|
# valid](https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels).
|
555
555
|
# Label values can be [templatized by using
|
556
|
-
# variables](https://cloud.google.com/monitoring/alerts/doc-variables).
|
556
|
+
# variables](https://cloud.google.com/monitoring/alerts/doc-variables#doc-vars).
|
557
557
|
# The only available variable names are the names of the labels in the
|
558
558
|
# PromQL result, including "__name__" and "value". "labels" may be empty.
|
559
559
|
# @!attribute [rw] rule_group
|
@@ -624,12 +624,19 @@ module Google
|
|
624
624
|
# are notified when this alert fires.
|
625
625
|
# @!attribute [rw] notification_rate_limit
|
626
626
|
# @return [::Google::Cloud::Monitoring::V3::AlertPolicy::AlertStrategy::NotificationRateLimit]
|
627
|
-
# Required for
|
627
|
+
# Required for log-based alerting policies, i.e. policies with a `LogMatch`
|
628
|
+
# condition.
|
628
629
|
#
|
629
|
-
# This limit is not implemented for
|
630
|
+
# This limit is not implemented for alerting policies that do not have
|
631
|
+
# a LogMatch condition.
|
632
|
+
# @!attribute [rw] notification_prompts
|
633
|
+
# @return [::Array<::Google::Cloud::Monitoring::V3::AlertPolicy::AlertStrategy::NotificationPrompt>]
|
634
|
+
# For log-based alert policies, the notification prompts is always
|
635
|
+
# [OPENED]. For non log-based alert policies, the notification prompts can
|
636
|
+
# be [OPENED] or [OPENED, CLOSED].
|
630
637
|
# @!attribute [rw] auto_close
|
631
638
|
# @return [::Google::Protobuf::Duration]
|
632
|
-
# If an
|
639
|
+
# If an alerting policy that was active has no data for this long, any open
|
633
640
|
# incidents will close
|
634
641
|
# @!attribute [rw] notification_channel_strategy
|
635
642
|
# @return [::Array<::Google::Cloud::Monitoring::V3::AlertPolicy::AlertStrategy::NotificationChannelStrategy>]
|
@@ -638,7 +645,7 @@ module Google
|
|
638
645
|
include ::Google::Protobuf::MessageExts
|
639
646
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
640
647
|
|
641
|
-
# Control over the rate of notifications sent to this
|
648
|
+
# Control over the rate of notifications sent to this alerting policy's
|
642
649
|
# notification channels.
|
643
650
|
# @!attribute [rw] period
|
644
651
|
# @return [::Google::Protobuf::Duration]
|
@@ -667,6 +674,18 @@ module Google
|
|
667
674
|
include ::Google::Protobuf::MessageExts
|
668
675
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
669
676
|
end
|
677
|
+
|
678
|
+
# Control when notifications will be sent out.
|
679
|
+
module NotificationPrompt
|
680
|
+
# No strategy specified. Treated as error.
|
681
|
+
NOTIFICATION_PROMPT_UNSPECIFIED = 0
|
682
|
+
|
683
|
+
# Notify when an incident is opened.
|
684
|
+
OPENED = 1
|
685
|
+
|
686
|
+
# Notify when an incident is closed.
|
687
|
+
CLOSED = 3
|
688
|
+
end
|
670
689
|
end
|
671
690
|
|
672
691
|
# @!attribute [rw] key
|
@@ -699,7 +718,7 @@ module Google
|
|
699
718
|
AND_WITH_MATCHING_RESOURCE = 3
|
700
719
|
end
|
701
720
|
|
702
|
-
# An enumeration of possible severity level for an
|
721
|
+
# An enumeration of possible severity level for an alerting policy.
|
703
722
|
module Severity
|
704
723
|
# No severity is specified. This is the default value.
|
705
724
|
SEVERITY_UNSPECIFIED = 0
|
@@ -74,27 +74,28 @@ module Google
|
|
74
74
|
# operation, instead.
|
75
75
|
# @!attribute [rw] filter
|
76
76
|
# @return [::String]
|
77
|
-
# If provided, this field specifies the criteria that must be met
|
78
|
-
# alert policies to be included in the response.
|
77
|
+
# Optional. If provided, this field specifies the criteria that must be met
|
78
|
+
# by alert policies to be included in the response.
|
79
79
|
#
|
80
80
|
# For more details, see [sorting and
|
81
81
|
# filtering](https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).
|
82
82
|
# @!attribute [rw] order_by
|
83
83
|
# @return [::String]
|
84
|
-
# A comma-separated list of fields by which to sort the result.
|
85
|
-
# the same set of field references as the `filter` field. Entries
|
86
|
-
# prefixed with a minus sign to sort by the field in descending order.
|
84
|
+
# Optional. A comma-separated list of fields by which to sort the result.
|
85
|
+
# Supports the same set of field references as the `filter` field. Entries
|
86
|
+
# can be prefixed with a minus sign to sort by the field in descending order.
|
87
87
|
#
|
88
88
|
# For more details, see [sorting and
|
89
89
|
# filtering](https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).
|
90
90
|
# @!attribute [rw] page_size
|
91
91
|
# @return [::Integer]
|
92
|
-
# The maximum number of results to return in a single response.
|
92
|
+
# Optional. The maximum number of results to return in a single response.
|
93
93
|
# @!attribute [rw] page_token
|
94
94
|
# @return [::String]
|
95
|
-
# If this field is not empty then it must contain the
|
96
|
-
# returned by a previous call to this method. Using
|
97
|
-
# method to return more results from the previous
|
95
|
+
# Optional. If this field is not empty then it must contain the
|
96
|
+
# `nextPageToken` value returned by a previous call to this method. Using
|
97
|
+
# this field causes the method to return more results from the previous
|
98
|
+
# method call.
|
98
99
|
class ListAlertPoliciesRequest
|
99
100
|
include ::Google::Protobuf::MessageExts
|
100
101
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -78,7 +78,7 @@ module Google
|
|
78
78
|
# field.
|
79
79
|
# @!attribute [rw] name
|
80
80
|
# @return [::String]
|
81
|
-
# The full REST resource name for this channel. The format is:
|
81
|
+
# Identifier. The full REST resource name for this channel. The format is:
|
82
82
|
#
|
83
83
|
# projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
|
84
84
|
#
|
@@ -115,27 +115,27 @@ module Google
|
|
115
115
|
# operation.
|
116
116
|
# @!attribute [rw] filter
|
117
117
|
# @return [::String]
|
118
|
-
# If provided, this field specifies the criteria that must be met
|
119
|
-
# notification channels to be included in the response.
|
118
|
+
# Optional. If provided, this field specifies the criteria that must be met
|
119
|
+
# by notification channels to be included in the response.
|
120
120
|
#
|
121
121
|
# For more details, see [sorting and
|
122
122
|
# filtering](https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).
|
123
123
|
# @!attribute [rw] order_by
|
124
124
|
# @return [::String]
|
125
|
-
# A comma-separated list of fields by which to sort the result.
|
126
|
-
# the same set of fields as in `filter`. Entries can be prefixed
|
127
|
-
# a minus sign to sort in descending rather than ascending order.
|
125
|
+
# Optional. A comma-separated list of fields by which to sort the result.
|
126
|
+
# Supports the same set of fields as in `filter`. Entries can be prefixed
|
127
|
+
# with a minus sign to sort in descending rather than ascending order.
|
128
128
|
#
|
129
129
|
# For more details, see [sorting and
|
130
130
|
# filtering](https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).
|
131
131
|
# @!attribute [rw] page_size
|
132
132
|
# @return [::Integer]
|
133
|
-
# The maximum number of results to return in a single response. If
|
133
|
+
# Optional. The maximum number of results to return in a single response. If
|
134
134
|
# not set to a positive number, a reasonable value will be chosen by the
|
135
135
|
# service.
|
136
136
|
# @!attribute [rw] page_token
|
137
137
|
# @return [::String]
|
138
|
-
# If non-empty, `page_token` must contain a value returned as the
|
138
|
+
# Optional. If non-empty, `page_token` must contain a value returned as the
|
139
139
|
# `next_page_token` in a previous response to request the next set
|
140
140
|
# of results.
|
141
141
|
class ListNotificationChannelsRequest
|
@@ -176,7 +176,7 @@ module Google
|
|
176
176
|
# The `UpdateNotificationChannel` request.
|
177
177
|
# @!attribute [rw] update_mask
|
178
178
|
# @return [::Google::Protobuf::FieldMask]
|
179
|
-
# The fields to update.
|
179
|
+
# Optional. The fields to update.
|
180
180
|
# @!attribute [rw] notification_channel
|
181
181
|
# @return [::Google::Cloud::Monitoring::V3::NotificationChannel]
|
182
182
|
# Required. A description of the changes to be applied to the specified
|
@@ -198,8 +198,8 @@ module Google
|
|
198
198
|
# @return [::Boolean]
|
199
199
|
# If true, the notification channel will be deleted regardless of its
|
200
200
|
# use in alert policies (the policies will be updated to remove the
|
201
|
-
# channel). If false,
|
202
|
-
#
|
201
|
+
# channel). If false, this operation will fail if the notification channel
|
202
|
+
# is referenced by existing alerting policies.
|
203
203
|
class DeleteNotificationChannelRequest
|
204
204
|
include ::Google::Protobuf::MessageExts
|
205
205
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -27,7 +27,7 @@ module Google
|
|
27
27
|
# `interval.start_time` through `interval.end_time`.
|
28
28
|
# @!attribute [rw] name
|
29
29
|
# @return [::String]
|
30
|
-
# Required. The name of the `Snooze`. The format is:
|
30
|
+
# Required. Identifier. The name of the `Snooze`. The format is:
|
31
31
|
#
|
32
32
|
# projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID]
|
33
33
|
#
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-monitoring-v3
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.0
|
4
|
+
version: 1.2.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2024-
|
11
|
+
date: 2024-12-10 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|
@@ -16,7 +16,7 @@ dependencies:
|
|
16
16
|
requirements:
|
17
17
|
- - ">="
|
18
18
|
- !ruby/object:Gem::Version
|
19
|
-
version: 0.
|
19
|
+
version: 0.24.0
|
20
20
|
- - "<"
|
21
21
|
- !ruby/object:Gem::Version
|
22
22
|
version: 2.a
|
@@ -26,7 +26,7 @@ dependencies:
|
|
26
26
|
requirements:
|
27
27
|
- - ">="
|
28
28
|
- !ruby/object:Gem::Version
|
29
|
-
version: 0.
|
29
|
+
version: 0.24.0
|
30
30
|
- - "<"
|
31
31
|
- !ruby/object:Gem::Version
|
32
32
|
version: 2.a
|
@@ -174,7 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
174
174
|
- !ruby/object:Gem::Version
|
175
175
|
version: '0'
|
176
176
|
requirements: []
|
177
|
-
rubygems_version: 3.5.
|
177
|
+
rubygems_version: 3.5.23
|
178
178
|
signing_key:
|
179
179
|
specification_version: 4
|
180
180
|
summary: Manages your Cloud Monitoring data and configurations.
|