Google Cloud Monitoring v3 API - Class AlertPolicy (3.12.0) 

public sealed class AlertPolicy : IMessage<AlertPolicy>, IEquatable<AlertPolicy>, IDeepCloneable<AlertPolicy>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Monitoring v3 API class 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 alerting policies, see Introduction to Alerting.

Inheritance

object > AlertPolicy

Namespace

Google.Cloud.Monitoring.V3

Assembly

Google.Cloud.Monitoring.V3.dll

Constructors

AlertPolicy()

public AlertPolicy()

AlertPolicy(AlertPolicy)

public AlertPolicy(AlertPolicy other)
Parameter
Name Description
other AlertPolicy

Properties

AlertPolicyName

public AlertPolicyName AlertPolicyName { get; set; }

AlertPolicyName-typed view over the Name resource name property.

Property Value
Type Description
AlertPolicyName

AlertStrategy

public AlertPolicy.Types.AlertStrategy AlertStrategy { get; set; }

Control over how this alerting policy's notification channels are notified.

Property Value
Type Description
AlertPolicyTypesAlertStrategy

Combiner

public AlertPolicy.Types.ConditionCombinerType Combiner { get; set; }

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.

Property Value
Type Description
AlertPolicyTypesConditionCombinerType

Conditions

public RepeatedField<AlertPolicy.Types.Condition> Conditions { get; }

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.

Property Value
Type Description
RepeatedFieldAlertPolicyTypesCondition

CreationRecord

public MutationRecord CreationRecord { get; set; }

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.

Property Value
Type Description
MutationRecord

DisplayName

public string DisplayName { get; set; }

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.

Property Value
Type Description
string

Documentation

public AlertPolicy.Types.Documentation Documentation { get; set; }

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.

Property Value
Type Description
AlertPolicyTypesDocumentation

Enabled

public bool? Enabled { get; set; }

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.

Property Value
Type Description
bool

MutationRecord

public MutationRecord MutationRecord { get; set; }

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.

Property Value
Type Description
MutationRecord

Name

public string Name { get; set; }

Identifier. 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.

Property Value
Type Description
string

NotificationChannels

public RepeatedField<string> NotificationChannels { get; }

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]
Property Value
Type Description
RepeatedFieldstring

ResourceName

public IResourceName ResourceName { get; set; }

IResourceName-typed view over the Name resource name property.

Property Value
Type Description
IResourceName

Severity

public AlertPolicy.Types.Severity Severity { get; set; }

Optional. The severity of an alerting policy indicates how important incidents generated by that policy are. The severity level will be displayed on the Incident detail page and in notifications.

Property Value
Type Description
AlertPolicyTypesSeverity

UserLabels

public MapField<string, string> UserLabels { get; }

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.

Property Value
Type Description
MapFieldstringstring

Validity

public Status Validity { get; set; }

Read-only description of how the alerting policy is invalid. This field is only set when the alerting policy is invalid. An invalid alerting policy will not generate incidents.

Property Value
Type Description
Status