feat: Added support for evaluating missing data in AlertPolicy

Google APIs · copybara-github · commit 9f7c0ffdaa8c · 2022-08-05T14:39:38.000-07:00
PiperOrigin-RevId: 465650583
diff --git a/google/monitoring/v3/alert.proto b/google/monitoring/v3/alert.proto
@@ -1,4 +1,4 @@
-// Copyright 2021 Google LLC
+// Copyright 2022 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -51,7 +51,8 @@ message AlertPolicy {
     // The text of the documentation, interpreted according to `mime_type`.
     // The content may not exceed 8,192 Unicode characters and may not exceed
     // more than 10,240 bytes when encoded in UTF-8 format, whichever is
-    // smaller.
+    // smaller. This text can be [templatized by using
+    // variables](https://cloud.google.com/monitoring/alerts/doc-variables).
     string content = 1;
 
     // The format of the `content` field. Presently, only the value
@@ -87,6 +88,26 @@ message AlertPolicy {
       }
     }
 
+    // A condition control that determines how metric-threshold conditions
+    // are evaluated when data stops arriving.
+    // This control doesn't affect metric-absence policies.
+    enum EvaluationMissingData {
+      // An unspecified evaluation missing data option.  Equivalent to
+      // EVALUATION_MISSING_DATA_NO_OP.
+      EVALUATION_MISSING_DATA_UNSPECIFIED = 0;
+
+      // If there is no data to evaluate the condition, then evaluate the
+      // condition as false.
+      EVALUATION_MISSING_DATA_INACTIVE = 1;
+
+      // If there is no data to evaluate the condition, then evaluate the
+      // condition as true.
+      EVALUATION_MISSING_DATA_ACTIVE = 2;
+
+      // Do not evaluate the condition to any value if there is no data.
+      EVALUATION_MISSING_DATA_NO_OP = 3;
+    }
+
     // A condition type that compares a collection of time series
     // against a threshold.
     message MetricThreshold {
@@ -168,6 +189,10 @@ message AlertPolicy {
       // or by the ratio, if `denominator_filter` and `denominator_aggregations`
       // are specified.
       Trigger trigger = 7;
+
+      // A condition control that determines how metric-threshold conditions
+      // are evaluated when data stops arriving.
+      EvaluationMissingData evaluation_missing_data = 11;
     }
 
     // A condition type that checks that monitored resources
@@ -267,20 +292,24 @@ message AlertPolicy {
       // or by the ratio, if `denominator_filter` and `denominator_aggregations`
       // are specified.
       Trigger trigger = 3;
+
+      // A condition control that determines how metric-threshold conditions
+      // are evaluated when data stops arriving.
+      EvaluationMissingData evaluation_missing_data = 4;
     }
 
     // Required if the condition exists. The unique resource name for this
     // condition. Its format is:
     //
     //     projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID]
     //
-    // `[CONDITION_ID]` is assigned by Stackdriver Monitoring when the
+    // `[CONDITION_ID]` is assigned by Cloud Monitoring when the
     // condition is created as part of a new or updated alerting policy.
     //
     // When calling the
     // [alertPolicies.create][google.monitoring.v3.AlertPolicyService.CreateAlertPolicy]
     // method, do not include the `name` field in the conditions of the
-    // requested alerting policy. Stackdriver Monitoring creates the
+    // requested alerting policy. Cloud Monitoring creates the
     // condition identifiers and includes them in the new policy.
     //
     // When calling the
@@ -320,26 +349,6 @@ message AlertPolicy {
     }
   }
 
-  // Control over how the notification channels in `notification_channels`
-  // are notified when this alert fires.
-  message AlertStrategy {
-    // Control over the rate of notifications sent to this alert policy's
-    // notification channels.
-    message NotificationRateLimit {
-      // Not more than one notification per `period`.
-      google.protobuf.Duration period = 1;
-    }
-
-    // Required for alert policies with a `LogMatch` condition.
-    //
-    // This limit is not implemented for alert policies that are not log-based.
-    NotificationRateLimit notification_rate_limit = 1;
-
-    // If an alert policy that was active has no data for this long, any open
-    // incidents will close
-    google.protobuf.Duration auto_close = 3;
-  }
-
   // Operators for combining conditions.
   enum ConditionCombinerType {
     // An unspecified combiner.
@@ -361,12 +370,32 @@ message AlertPolicy {
     AND_WITH_MATCHING_RESOURCE = 3;
   }
 
+  // Control over how the notification channels in `notification_channels`
+  // are notified when this alert fires.
+  message AlertStrategy {
+    // Control over the rate of notifications sent to this alert policy's
+    // notification channels.
+    message NotificationRateLimit {
+      // Not more than one notification per `period`.
+      google.protobuf.Duration period = 1;
+    }
+
+    // Required for alert policies with a `LogMatch` condition.
+    //
+    // This limit is not implemented for alert policies that are not log-based.
+    NotificationRateLimit notification_rate_limit = 1;
+
+    // If an alert policy that was active has no data for this long, any open
+    // incidents will close
+    google.protobuf.Duration auto_close = 3;
+  }
+
   // 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 Stackdriver Monitoring when the policy
+  // `[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
diff --git a/google/monitoring/v3/alert_service.proto b/google/monitoring/v3/alert_service.proto
@@ -1,4 +1,4 @@
-// Copyright 2021 Google LLC
+// Copyright 2022 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -33,14 +33,14 @@ option php_namespace = "Google\\Cloud\\Monitoring\\V3";
 option ruby_package = "Google::Cloud::Monitoring::V3";
 
 // The AlertPolicyService API is used to manage (list, create, delete,
-// edit) alert policies in Stackdriver Monitoring. An alerting policy is
+// edit) alert policies in Cloud Monitoring. An alerting policy is
 // 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. In addition to using this API, alert
 // policies can also be managed through
-// [Stackdriver Monitoring](https://cloud.google.com/monitoring/docs/),
+// [Cloud Monitoring](https://cloud.google.com/monitoring/docs/),
 // which can be reached by clicking the "Monitoring" tab in
-// [Cloud Console](https://console.cloud.google.com/).
+// [Cloud console](https://console.cloud.google.com/).
 service AlertPolicyService {
   option (google.api.default_host) = "monitoring.googleapis.com";
   option (google.api.oauth_scopes) =
@@ -103,7 +103,7 @@ message CreateAlertPolicyRequest {
   //
   // Note that this field names the parent container in which the alerting
   // policy will be written, not the name of the created policy. |name| must be
-  // a host project of a workspace, otherwise INVALID_ARGUMENT error will
+  // a host project of a Metrics Scope, otherwise INVALID_ARGUMENT error will
   // return. The alerting policy that is returned will have a name that contains
   // a normalized representation of this name as a prefix but adds a suffix of
   // the form `/alertPolicies/[ALERT_POLICY_ID]`, identifying the policy in the
