Reference documentation and code samples for the Cloud Monitoring V3 API class Google::Cloud::Monitoring::V3::AlertPolicy.
A description of the conditions under which some aspect of your system is considered to be "unhealthy" and the ways to notify people or services about this state. For an overview of alert policies, see Introduction to Alerting.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#alert_strategy
def alert_strategy() -> ::Google::Cloud::Monitoring::V3::AlertPolicy::AlertStrategy
- (::Google::Cloud::Monitoring::V3::AlertPolicy::AlertStrategy) — Control over how this alert policy's notification channels are notified.
#alert_strategy=
def alert_strategy=(value) -> ::Google::Cloud::Monitoring::V3::AlertPolicy::AlertStrategy
- value (::Google::Cloud::Monitoring::V3::AlertPolicy::AlertStrategy) — Control over how this alert policy's notification channels are notified.
- (::Google::Cloud::Monitoring::V3::AlertPolicy::AlertStrategy) — Control over how this alert policy's notification channels are notified.
#combiner
def combiner() -> ::Google::Cloud::Monitoring::V3::AlertPolicy::ConditionCombinerType
-
(::Google::Cloud::Monitoring::V3::AlertPolicy::ConditionCombinerType) — How to combine the results of multiple conditions to determine if an
incident should be opened.
If
condition_time_series_query_language
is present, this must beCOMBINE_UNSPECIFIED
.
#combiner=
def combiner=(value) -> ::Google::Cloud::Monitoring::V3::AlertPolicy::ConditionCombinerType
-
value (::Google::Cloud::Monitoring::V3::AlertPolicy::ConditionCombinerType) — How to combine the results of multiple conditions to determine if an
incident should be opened.
If
condition_time_series_query_language
is present, this must beCOMBINE_UNSPECIFIED
.
-
(::Google::Cloud::Monitoring::V3::AlertPolicy::ConditionCombinerType) — How to combine the results of multiple conditions to determine if an
incident should be opened.
If
condition_time_series_query_language
is present, this must beCOMBINE_UNSPECIFIED
.
#conditions
def conditions() -> ::Array<::Google::Cloud::Monitoring::V3::AlertPolicy::Condition>
-
(::Array<::Google::Cloud::Monitoring::V3::AlertPolicy::Condition>) — A list of conditions for the policy. The conditions are combined by AND or
OR according to the
combiner
field. If the combined conditions evaluate to true, then an incident is created. A policy can have from one to six conditions. Ifcondition_time_series_query_language
is present, it must be the onlycondition
. Ifcondition_monitoring_query_language
is present, it must be the onlycondition
.
#conditions=
def conditions=(value) -> ::Array<::Google::Cloud::Monitoring::V3::AlertPolicy::Condition>
-
value (::Array<::Google::Cloud::Monitoring::V3::AlertPolicy::Condition>) — A list of conditions for the policy. The conditions are combined by AND or
OR according to the
combiner
field. If the combined conditions evaluate to true, then an incident is created. A policy can have from one to six conditions. Ifcondition_time_series_query_language
is present, it must be the onlycondition
. Ifcondition_monitoring_query_language
is present, it must be the onlycondition
.
-
(::Array<::Google::Cloud::Monitoring::V3::AlertPolicy::Condition>) — A list of conditions for the policy. The conditions are combined by AND or
OR according to the
combiner
field. If the combined conditions evaluate to true, then an incident is created. A policy can have from one to six conditions. Ifcondition_time_series_query_language
is present, it must be the onlycondition
. Ifcondition_monitoring_query_language
is present, it must be the onlycondition
.
#creation_record
def creation_record() -> ::Google::Cloud::Monitoring::V3::MutationRecord
- (::Google::Cloud::Monitoring::V3::MutationRecord) — A read-only record of the creation of the alerting policy. If provided in a call to create or update, this field will be ignored.
#creation_record=
def creation_record=(value) -> ::Google::Cloud::Monitoring::V3::MutationRecord
- value (::Google::Cloud::Monitoring::V3::MutationRecord) — A read-only record of the creation of the alerting policy. If provided in a call to create or update, this field will be ignored.
- (::Google::Cloud::Monitoring::V3::MutationRecord) — A read-only record of the creation of the alerting policy. If provided in a call to create or update, this field will be ignored.
#display_name
def display_name() -> ::String
-
(::String) — A short name or phrase used to identify the policy in dashboards,
notifications, and incidents. To avoid confusion, don't use the same
display name for multiple policies in the same project. The name is
limited to 512 Unicode characters.
The convention for the display_name of a PrometheusQueryLanguageCondition is "{rule group name}/{alert name}", where the {rule group name} and {alert name} should be taken from the corresponding Prometheus configuration file. This convention is not enforced. In any case the display_name is not a unique key of the AlertPolicy.
#display_name=
def display_name=(value) -> ::String
-
value (::String) — A short name or phrase used to identify the policy in dashboards,
notifications, and incidents. To avoid confusion, don't use the same
display name for multiple policies in the same project. The name is
limited to 512 Unicode characters.
The convention for the display_name of a PrometheusQueryLanguageCondition is "{rule group name}/{alert name}", where the {rule group name} and {alert name} should be taken from the corresponding Prometheus configuration file. This convention is not enforced. In any case the display_name is not a unique key of the AlertPolicy.
-
(::String) — A short name or phrase used to identify the policy in dashboards,
notifications, and incidents. To avoid confusion, don't use the same
display name for multiple policies in the same project. The name is
limited to 512 Unicode characters.
The convention for the display_name of a PrometheusQueryLanguageCondition is "{rule group name}/{alert name}", where the {rule group name} and {alert name} should be taken from the corresponding Prometheus configuration file. This convention is not enforced. In any case the display_name is not a unique key of the AlertPolicy.
#documentation
def documentation() -> ::Google::Cloud::Monitoring::V3::AlertPolicy::Documentation
- (::Google::Cloud::Monitoring::V3::AlertPolicy::Documentation) — Documentation that is included with notifications and incidents related to this policy. Best practice is for the documentation to include information to help responders understand, mitigate, escalate, and correct the underlying problems detected by the alerting policy. Notification channels that have limited capacity might not show this documentation.
#documentation=
def documentation=(value) -> ::Google::Cloud::Monitoring::V3::AlertPolicy::Documentation
- value (::Google::Cloud::Monitoring::V3::AlertPolicy::Documentation) — Documentation that is included with notifications and incidents related to this policy. Best practice is for the documentation to include information to help responders understand, mitigate, escalate, and correct the underlying problems detected by the alerting policy. Notification channels that have limited capacity might not show this documentation.
- (::Google::Cloud::Monitoring::V3::AlertPolicy::Documentation) — Documentation that is included with notifications and incidents related to this policy. Best practice is for the documentation to include information to help responders understand, mitigate, escalate, and correct the underlying problems detected by the alerting policy. Notification channels that have limited capacity might not show this documentation.
#enabled
def enabled() -> ::Google::Protobuf::BoolValue
- (::Google::Protobuf::BoolValue) — Whether or not the policy is enabled. On write, the default interpretation if unset is that the policy is enabled. On read, clients should not make any assumption about the state if it has not been populated. The field should always be populated on List and Get operations, unless a field projection has been specified that strips it out.
#enabled=
def enabled=(value) -> ::Google::Protobuf::BoolValue
- value (::Google::Protobuf::BoolValue) — Whether or not the policy is enabled. On write, the default interpretation if unset is that the policy is enabled. On read, clients should not make any assumption about the state if it has not been populated. The field should always be populated on List and Get operations, unless a field projection has been specified that strips it out.
- (::Google::Protobuf::BoolValue) — Whether or not the policy is enabled. On write, the default interpretation if unset is that the policy is enabled. On read, clients should not make any assumption about the state if it has not been populated. The field should always be populated on List and Get operations, unless a field projection has been specified that strips it out.
#mutation_record
def mutation_record() -> ::Google::Cloud::Monitoring::V3::MutationRecord
- (::Google::Cloud::Monitoring::V3::MutationRecord) — A read-only record of the most recent change to the alerting policy. If provided in a call to create or update, this field will be ignored.
#mutation_record=
def mutation_record=(value) -> ::Google::Cloud::Monitoring::V3::MutationRecord
- value (::Google::Cloud::Monitoring::V3::MutationRecord) — A read-only record of the most recent change to the alerting policy. If provided in a call to create or update, this field will be ignored.
- (::Google::Cloud::Monitoring::V3::MutationRecord) — A read-only record of the most recent change to the alerting policy. If provided in a call to create or update, this field will be ignored.
#name
def name() -> ::String
-
(::String) — Required if the policy exists. The resource name for this policy. The
format is:
projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
[ALERT_POLICY_ID]
is assigned by Cloud Monitoring when the policy is created. When calling the alertPolicies.create method, do not include thename
field in the alerting policy passed as part of the request.
#name=
def name=(value) -> ::String
-
value (::String) — Required if the policy exists. The resource name for this policy. The
format is:
projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
[ALERT_POLICY_ID]
is assigned by Cloud Monitoring when the policy is created. When calling the alertPolicies.create method, do not include thename
field in the alerting policy passed as part of the request.
-
(::String) — Required if the policy exists. The resource name for this policy. The
format is:
projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
[ALERT_POLICY_ID]
is assigned by Cloud Monitoring when the policy is created. When calling the alertPolicies.create method, do not include thename
field in the alerting policy passed as part of the request.
#notification_channels
def notification_channels() -> ::Array<::String>
-
(::Array<::String>) —
Identifies the notification channels to which notifications should be sent when incidents are opened or closed or when new violations occur on an already opened incident. Each element of this array corresponds to the
name
field in each of theNotificationChannel
objects that are returned from the [ListNotificationChannels
] [google.monitoring.v3.NotificationChannelService.ListNotificationChannels] method. The format of the entries in this field is:projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
#notification_channels=
def notification_channels=(value) -> ::Array<::String>
-
value (::Array<::String>) —
Identifies the notification channels to which notifications should be sent when incidents are opened or closed or when new violations occur on an already opened incident. Each element of this array corresponds to the
name
field in each of theNotificationChannel
objects that are returned from the [ListNotificationChannels
] [google.monitoring.v3.NotificationChannelService.ListNotificationChannels] method. The format of the entries in this field is:projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
-
(::Array<::String>) —
Identifies the notification channels to which notifications should be sent when incidents are opened or closed or when new violations occur on an already opened incident. Each element of this array corresponds to the
name
field in each of theNotificationChannel
objects that are returned from the [ListNotificationChannels
] [google.monitoring.v3.NotificationChannelService.ListNotificationChannels] method. The format of the entries in this field is:projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
#user_labels
def user_labels() -> ::Google::Protobuf::Map{::String => ::String}
-
(::Google::Protobuf::Map{::String => ::String}) — User-supplied key/value data to be used for organizing and
identifying the
AlertPolicy
objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.
Note that Prometheus {alert name} is a valid Prometheus label names, whereas Prometheus {rule group} is an unrestricted UTF-8 string. This means that they cannot be stored as-is in user labels, because they may contain characters that are not allowed in user-label values.
#user_labels=
def user_labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
-
value (::Google::Protobuf::Map{::String => ::String}) — User-supplied key/value data to be used for organizing and
identifying the
AlertPolicy
objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.
Note that Prometheus {alert name} is a valid Prometheus label names, whereas Prometheus {rule group} is an unrestricted UTF-8 string. This means that they cannot be stored as-is in user labels, because they may contain characters that are not allowed in user-label values.
-
(::Google::Protobuf::Map{::String => ::String}) — User-supplied key/value data to be used for organizing and
identifying the
AlertPolicy
objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.
Note that Prometheus {alert name} is a valid Prometheus label names, whereas Prometheus {rule group} is an unrestricted UTF-8 string. This means that they cannot be stored as-is in user labels, because they may contain characters that are not allowed in user-label values.
#validity
def validity() -> ::Google::Rpc::Status
- (::Google::Rpc::Status) — Read-only description of how the alert policy is invalid. This field is only set when the alert policy is invalid. An invalid alert policy will not generate incidents.
#validity=
def validity=(value) -> ::Google::Rpc::Status
- value (::Google::Rpc::Status) — Read-only description of how the alert policy is invalid. This field is only set when the alert policy is invalid. An invalid alert policy will not generate incidents.
- (::Google::Rpc::Status) — Read-only description of how the alert policy is invalid. This field is only set when the alert policy is invalid. An invalid alert policy will not generate incidents.