AlertPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)
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 <https://cloud.google.com/monitoring/alerts/>
__.
Attributes | |
---|---|
Name | Description |
name |
str
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][google.monitoring.v3.AlertPolicyService.CreateAlertPolicy]
method, do not include the name field in the alerting
policy passed as part of the request.
|
display_name |
str
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 |
google.cloud.monitoring_v3.types.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. |
user_labels |
MutableMapping[str, str]
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 |
conditions |
MutableSequence[google.cloud.monitoring_v3.types.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. If condition_time_series_query_language is
present, it must be the only condition . If
condition_monitoring_query_language is present, it must
be the only condition .
|
combiner |
google.cloud.monitoring_v3.types.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 be COMBINE_UNSPECIFIED .
|
enabled |
google.protobuf.wrappers_pb2.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. |
validity |
google.rpc.status_pb2.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. |
notification_channels |
MutableSequence[str]
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 the
[NotificationChannel ][google.monitoring.v3.NotificationChannel]
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]
|
creation_record |
google.cloud.monitoring_v3.types.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. |
mutation_record |
google.cloud.monitoring_v3.types.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. |
alert_strategy |
google.cloud.monitoring_v3.types.AlertPolicy.AlertStrategy
Control over how this alert policy's notification channels are notified. |
severity |
google.cloud.monitoring_v3.types.AlertPolicy.Severity
Optional. The severity of an alert policy indicates how important incidents generated by that policy are. The severity level will be displayed on the Incident detail page and in notifications. |
Classes
AlertStrategy
AlertStrategy(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Control over how the notification channels in
notification_channels
are notified when this alert fires.
Condition
Condition(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A condition is a true/false test that determines when an alerting policy should open an incident. If a condition evaluates to true, it signifies that something is wrong.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ConditionCombinerType
ConditionCombinerType(value)
Operators for combining conditions.
Values:
COMBINE_UNSPECIFIED (0):
An unspecified combiner.
AND (1):
Combine conditions using the logical AND
operator. An
incident is created only if all the conditions are met
simultaneously. This combiner is satisfied if all conditions
are met, even if they are met on completely different
resources.
OR (2):
Combine conditions using the logical OR
operator. An
incident is created if any of the listed conditions is met.
AND_WITH_MATCHING_RESOURCE (3):
Combine conditions using logical AND
operator, but
unlike the regular AND
option, an incident is created
only if all conditions are met simultaneously on at least
one resource.
Documentation
Documentation(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Documentation that is included in the notifications and incidents pertaining to this policy.
Severity
Severity(value)
An enumeration of possible severity level for an Alert Policy.
Values: SEVERITY_UNSPECIFIED (0): No severity is specified. This is the default value. CRITICAL (1): This is the highest severity level. Use this if the problem could cause significant damage or downtime. ERROR (2): This is the medium severity level. Use this if the problem could cause minor damage or downtime. WARNING (3): This is the lowest severity level. Use this if the problem is not causing any damage or downtime, but could potentially lead to a problem in the future.
UserLabelsEntry
UserLabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
Parameters | |
---|---|
Name | Description |
kwargs |
dict
Keys and values corresponding to the fields of the message. |
mapping |
Union[dict,
A dictionary or message to be used to determine the values for this message. |
ignore_unknown_fields |
Optional(bool)
If True, do not raise errors for unknown fields. Only applied if |