Add critical_query / critical_recovery_query to MonitorThresholds (DataDog#3368)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>

Author: api-clients-generation-pipeline[bot]

.generator/schemas/v1/openapi.yaml

@@ -9229,11 +9229,19 @@ components:
           description: The monitor `CRITICAL` threshold.
           format: double
           type: number
+        critical_query:
+          description: Query evaluated as a dynamic `CRITICAL` threshold. Only supported on metric monitors with a formula query and options['variables']. Cannot be combined with static thresholds. This field is in preview.
+          example: 'formula("2 * query1").rollup("avg").last("6mo")'
+          type: string
         critical_recovery:
           description: The monitor `CRITICAL` recovery threshold.
           format: double
           nullable: true
           type: number
+        critical_recovery_query:
+          description: Query evaluated as a dynamic `CRITICAL` recovery threshold. Only supported on metric monitors with a formula query and options['variables']. Cannot be combined with static thresholds. This field is in preview.
+          example: 'formula("1.5 * query1").rollup("avg").last("3mo")'
+          type: string
         ok:
           description: The monitor `OK` threshold.
           format: double
@@ -33700,6 +33708,10 @@ paths:
         - `operator`: <, <=, >, >=, ==, or !=
         - `#`: an integer or decimal number used to set the threshold
 
+        To use a dynamic threshold on a metric monitor with a formula query, replace `#` with the `threshold` keyword
+        (for example, `... > threshold`) and provide the threshold as a query via `critical_query` on `options.thresholds`.
+        This feature is in preview.
+
         If you are using the `_change_` or `_pct_change_` time aggregator, instead use `change_aggr(time_aggr(time_window),
         timeshift):space_aggr:metric{tags} [by {key}] operator #` with:
 

features/v1/monitors.feature

@@ -219,7 +219,7 @@ Feature: Monitors
   Scenario: Edit a monitor returns "Bad Request" response
     Given new "UpdateMonitor" request
     And request contains "monitor_id" parameter from "REPLACE.ME"
-    And body with value {"assets": [{"category": "runbook", "name": "Monitor Runbook", "resource_key": "12345", "resource_type": "notebook", "url": "/notebooks/12345"}], "draft_status": "published", "options": {"evaluation_delay": null, "include_tags": true, "min_failure_duration": 0, "min_location_failed": 1, "new_group_delay": null, "new_host_delay": 300, "no_data_timeframe": null, "notification_preset_name": "show_all", "notify_audit": false, "notify_by": [], "on_missing_data": "default", "renotify_interval": null, "renotify_occurrences": null, "renotify_statuses": ["alert"], "scheduling_options": {"custom_schedule": {"recurrences": [{"rrule": "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR", "start": "2023-08-31T16:30:00", "timezone": "Europe/Paris"}]}, "evaluation_window": {"day_starts": "04:00", "hour_starts": 0, "month_starts": 1, "timezone": "Europe/Paris"}}, "synthetics_check_id": null, "threshold_windows": {"recovery_window": null, "trigger_window": null}, "thresholds": {"critical_recovery": null, "ok": null, "unknown": null, "warning": null, "warning_recovery": null}, "timeout_h": null, "variables": [{"compute": {"aggregation": "avg", "interval": 60000, "metric": "@duration", "name": "compute_result", "source": "filter_query"}, "data_source": "rum", "group_by": [{"facet": "status", "limit": 10, "sort": {"aggregation": "avg", "order": "desc"}, "source": "filter_query"}], "indexes": ["days-3", "days-7"], "name": "query_errors", "search": {"query": "service:query"}}]}, "priority": null, "restricted_roles": [], "tags": [], "type": "query alert"}
+    And body with value {"assets": [{"category": "runbook", "name": "Monitor Runbook", "resource_key": "12345", "resource_type": "notebook", "url": "/notebooks/12345"}], "draft_status": "published", "options": {"evaluation_delay": null, "include_tags": true, "min_failure_duration": 0, "min_location_failed": 1, "new_group_delay": null, "new_host_delay": 300, "no_data_timeframe": null, "notification_preset_name": "show_all", "notify_audit": false, "notify_by": [], "on_missing_data": "default", "renotify_interval": null, "renotify_occurrences": null, "renotify_statuses": ["alert"], "scheduling_options": {"custom_schedule": {"recurrences": [{"rrule": "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR", "start": "2023-08-31T16:30:00", "timezone": "Europe/Paris"}]}, "evaluation_window": {"day_starts": "04:00", "hour_starts": 0, "month_starts": 1, "timezone": "Europe/Paris"}}, "synthetics_check_id": null, "threshold_windows": {"recovery_window": null, "trigger_window": null}, "thresholds": {"critical_query": "formula(\"2 * query1\").rollup(\"avg\").last(\"6mo\")", "critical_recovery": null, "critical_recovery_query": "formula(\"1.5 * query1\").rollup(\"avg\").last(\"3mo\")", "ok": null, "unknown": null, "warning": null, "warning_recovery": null}, "timeout_h": null, "variables": [{"compute": {"aggregation": "avg", "interval": 60000, "metric": "@duration", "name": "compute_result", "source": "filter_query"}, "data_source": "rum", "group_by": [{"facet": "status", "limit": 10, "sort": {"aggregation": "avg", "order": "desc"}, "source": "filter_query"}], "indexes": ["days-3", "days-7"], "name": "query_errors", "search": {"query": "service:query"}}]}, "priority": null, "restricted_roles": [], "tags": [], "type": "query alert"}
     When the request is sent
     Then the response status is 400 Bad Request
 

lib/datadog_api_client/v1/api/monitors_api.rb

@@ -147,6 +147,10 @@ def create_monitor(body, opts = {})
     # - `operator`: <, <=, >, >=, ==, or !=
     # - `#`: an integer or decimal number used to set the threshold
     #
+    # To use a dynamic threshold on a metric monitor with a formula query, replace `#` with the `threshold` keyword
+    # (for example, `... > threshold`) and provide the threshold as a query via `critical_query` on `options.thresholds`.
+    # This feature is in preview.
+    #
     # If you are using the `_change_` or `_pct_change_` time aggregator, instead use `change_aggr(time_aggr(time_window),
     # timeshift):space_aggr:metric{tags} [by {key}] operator #` with:
     #

lib/datadog_api_client/v1/models/monitor_thresholds.rb

@@ -24,9 +24,15 @@ class MonitorThresholds
     # The monitor `CRITICAL` threshold.
     attr_accessor :critical
 
+    # Query evaluated as a dynamic `CRITICAL` threshold. Only supported on metric monitors with a formula query and options['variables']. Cannot be combined with static thresholds. This field is in preview.
+    attr_accessor :critical_query
+
     # The monitor `CRITICAL` recovery threshold.
     attr_accessor :critical_recovery
 
+    # Query evaluated as a dynamic `CRITICAL` recovery threshold. Only supported on metric monitors with a formula query and options['variables']. Cannot be combined with static thresholds. This field is in preview.
+    attr_accessor :critical_recovery_query
+
     # The monitor `OK` threshold.
     attr_accessor :ok
 
@@ -46,7 +52,9 @@ class MonitorThresholds
     def self.attribute_map
       {
         :'critical' => :'critical',
+        :'critical_query' => :'critical_query',
         :'critical_recovery' => :'critical_recovery',
+        :'critical_recovery_query' => :'critical_recovery_query',
         :'ok' => :'ok',
         :'unknown' => :'unknown',
         :'warning' => :'warning',
@@ -59,7 +67,9 @@ def self.attribute_map
     def self.openapi_types
       {
         :'critical' => :'Float',
+        :'critical_query' => :'String',
         :'critical_recovery' => :'Float',
+        :'critical_recovery_query' => :'String',
         :'ok' => :'Float',
         :'unknown' => :'Float',
         :'warning' => :'Float',
@@ -101,10 +111,18 @@ def initialize(attributes = {})
         self.critical = attributes[:'critical']
       end
 
+      if attributes.key?(:'critical_query')
+        self.critical_query = attributes[:'critical_query']
+      end
+
       if attributes.key?(:'critical_recovery')
         self.critical_recovery = attributes[:'critical_recovery']
       end
 
+      if attributes.key?(:'critical_recovery_query')
+        self.critical_recovery_query = attributes[:'critical_recovery_query']
+      end
+
       if attributes.key?(:'ok')
         self.ok = attributes[:'ok']
       end
@@ -149,7 +167,9 @@ def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
           critical == o.critical &&
+          critical_query == o.critical_query &&
           critical_recovery == o.critical_recovery &&
+          critical_recovery_query == o.critical_recovery_query &&
           ok == o.ok &&
           unknown == o.unknown &&
           warning == o.warning &&
@@ -161,7 +181,7 @@ def ==(o)
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [critical, critical_recovery, ok, unknown, warning, warning_recovery, additional_properties].hash
+      [critical, critical_query, critical_recovery, critical_recovery_query, ok, unknown, warning, warning_recovery, additional_properties].hash
     end
   end
 end