From ea1902aa4dd8e38a97b73cf2956c2129aa926dd0 Mon Sep 17 00:00:00 2001 From: "ci.datadog-api-spec" Date: Mon, 16 Nov 2026 17:37:35 +0000 Subject: [PATCH] Regenerate client from commit 28b85e0 of spec repo --- .generator/schemas/v1/openapi.yaml | 78 ++++++++- .../v1/monitors/CreateMonitor_1267012748.rb | 40 +++++ .../v1/monitors/CreateMonitor_1302731819.rb | 36 ++++ features/v1/monitors.feature | 24 +++ generated-test/test-runner-data/manifest.json | 14 ++ ...-duration-monitor-returns-ok-response.json | 56 ++++++ ...tra-query-dialect-returns-ok-response.json | 52 ++++++ .../test-server-data/v1/monitors.json | 164 ++++++++++++++++++ lib/datadog_api_client/inflector.rb | 2 + lib/datadog_api_client/v1/api/monitors_api.rb | 16 ++ ..._and_function_data_jobs_monitor_options.rb | 108 ++++++++++++ ...and_function_data_jobs_query_definition.rb | 37 +++- ...nd_function_data_quality_detection_type.rb | 28 +++ ...d_function_data_quality_monitor_options.rb | 42 ++++- ..._function_data_quality_query_definition.rb | 16 +- 15 files changed, 698 insertions(+), 15 deletions(-) create mode 100644 examples/v1/monitors/CreateMonitor_1267012748.rb create mode 100644 examples/v1/monitors/CreateMonitor_1302731819.rb create mode 100644 generated-test/test-runner-data/v1/monitors/create-a-data-jobs-duration-monitor-returns-ok-response.json create mode 100644 generated-test/test-runner-data/v1/monitors/create-a-data-jobs-monitor-with-the-aastra-query-dialect-returns-ok-response.json create mode 100644 lib/datadog_api_client/v1/models/monitor_formula_and_function_data_jobs_monitor_options.rb create mode 100644 lib/datadog_api_client/v1/models/monitor_formula_and_function_data_quality_detection_type.rb diff --git a/.generator/schemas/v1/openapi.yaml b/.generator/schemas/v1/openapi.yaml index a0bee37b6436..f2d8715f8726 100644 --- a/.generator/schemas/v1/openapi.yaml +++ b/.generator/schemas/v1/openapi.yaml @@ -9793,30 +9793,53 @@ components: - data_source - query type: object + MonitorFormulaAndFunctionDataJobsMonitorOptions: + description: Monitor configuration options for data jobs queries. + properties: + alert_on_every_failure: + description: |- + Alert separately for each failed run instead of on the count of trailing failures. + Only supported for `failed_runs` monitors with the `aastra` query dialect. It requires + a `> 0` threshold with no warning threshold, an evaluation window of at most two days, + and renotification disabled. + example: true + type: boolean + type: object MonitorFormulaAndFunctionDataJobsQueryDefinition: description: A formula and functions data jobs query. properties: job_type: description: |- The type of job being monitored. Valid values include: - `databricks.job`, `spark.application`, `airflow.dag`, - `dbt.job`, `dbt.model`, `dbt.test`, `glue.job`. + `databricks.job`, `spark.application`, `airflow.dag`, `dbt.job`, `glue.job`, `adf.pipeline`. + The `aastra` dialect also accepts `airflow.job`, `dbt.model`, and `dbt.test`. Custom job types are supported with the `custom.ol.` prefix. example: "databricks.job" type: string jobs_query: - description: Filter expression used to select the jobs to monitor. + description: |- + Filter expression used to select the jobs to monitor. Its syntax depends on `query_dialect`: + a metric tag filter such as `job_name:smoke*` for `metric`, or an Aastra entity search + such as ``search for databricks_job where `@team:data-eng` `` for `aastra`. example: "job_name:smoke*" type: string + monitor_options: + $ref: "#/components/schemas/MonitorFormulaAndFunctionDataJobsMonitorOptions" name: description: Name of the query for use in formulas. Must be `run_query`. example: "run_query" type: string query_dialect: description: |- - Query dialect for data jobs queries. Currently only `metric` is supported. + Query dialect for data jobs queries. Valid values are `metric` and `aastra`. example: "metric" type: string + run_filter: + description: |- + Optional filter on individual runs, using metrics filter syntax. + Only supported with the `aastra` query dialect. + example: "env:prod" + type: string required: - name - jobs_query @@ -9831,6 +9854,18 @@ components: type: string x-enum-varnames: - DATA_QUALITY_METRICS + MonitorFormulaAndFunctionDataQualityDetectionType: + description: |- + How a `data-jobs alert` job duration monitor detects a breach. Must match the + `.detection()` call in the monitor query. Required for job duration monitors. + enum: + - static + - anomaly + example: "anomaly" + type: string + x-enum-varnames: + - STATIC + - ANOMALY MonitorFormulaAndFunctionDataQualityDiffFunction: description: |- Function applied to the measure before it is compared against the predicted bounds. @@ -9891,7 +9926,8 @@ components: The data quality measure to query. Common values include: `bytes`, `cardinality`, `custom`, `freshness`, `max`, `mean`, `min`, `nullness`, `percent_negative`, `percent_zero`, `row_count`, `stddev`, - `sum`, `uniqueness`. Additional values may be supported. + `sum`, `uniqueness`. `data-jobs alert` job duration monitors use `duration`. + Additional values may be supported. example: "row_count" type: string MonitorFormulaAndFunctionDataQualityModelBoundsOverride: @@ -9961,6 +9997,14 @@ components: MonitorFormulaAndFunctionDataQualityMonitorOptions: description: Monitor configuration options for data quality queries. properties: + consecutive_runs: + description: |- + Number of consecutive runs that must breach before the monitor alerts. + Only supported by `data-jobs alert` job duration monitors. Defaults to `1`. + example: 1 + format: int64 + minimum: 1 + type: integer crontab_override: description: Crontab expression to override the default schedule. example: "* * * 10" @@ -9973,6 +10017,8 @@ components: description: Custom WHERE clause for the query. example: "USER_ID = 123" type: string + detection_type: + $ref: "#/components/schemas/MonitorFormulaAndFunctionDataQualityDetectionType" group_by_columns: description: Columns to group results by. example: ["col1", "col2"] @@ -10020,6 +10066,12 @@ components: description: Name of the query for use in formulas. example: "query1" type: string + run_filter: + description: |- + Optional filter on individual runs, using metrics filter syntax. + Only supported by `data-jobs alert` job duration monitors. + example: "env:prod" + type: string schema_version: description: Schema version for the data quality query. example: "0.0.1" @@ -37279,6 +37331,22 @@ paths: - `time_window` #m (between 1 and 2880), #h (between 1 and 48). - `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`. - `#` an integer or decimal number used to set the threshold. + + **Data Jobs Alert Query** + + Job status example: `formula("failed_runs(run_query)").by(group_keys).last(time_window) > #` + + Job duration examples: `formula("job_duration(run_query)").detection(static).by(group_keys) > duration` + and `formula("job_duration(run_query)").detection(anomaly).by(group_keys) > 0` + + - `run_query`: The name of the single query variable in `options.variables`. Job status monitors + use a data jobs query; job duration monitors use a data quality query with the `duration` measure. + - `group_keys`: The tags to group by, such as `entity_id,name,workspace_name`. + - `time_window`: Number of minutes (#m), hours (#h), or days (#d), up to `10d`. + - `#`: The number of trailing failed runs to alert above, as a non-negative integer. + - `duration`: The duration to alert above, such as `2h`, `30m`, or a number of seconds. + - `options.thresholds.critical`: Must equal the query threshold, in seconds for job duration. + Anomaly job duration monitors omit `options.thresholds`. operationId: CreateMonitor requestBody: content: diff --git a/examples/v1/monitors/CreateMonitor_1267012748.rb b/examples/v1/monitors/CreateMonitor_1267012748.rb new file mode 100644 index 000000000000..ef918690665d --- /dev/null +++ b/examples/v1/monitors/CreateMonitor_1267012748.rb @@ -0,0 +1,40 @@ +# Create a Data Jobs duration monitor returns "OK" response + +require "datadog_api_client" +DatadogAPIClient.configure do |config| + config.access_token = ENV["DD_BEARER_TOKEN"] +end +api_instance = DatadogAPIClient::V1::MonitorsAPI.new + +body = DatadogAPIClient::V1::Monitor.new({ + name: "Example-Monitor", + type: DatadogAPIClient::V1::MonitorType::DATA_JOBS_ALERT, + query: 'formula("job_duration(run_query)").detection(anomaly).by(name,workspace_name,entity_id) > 0', + message: "Data jobs duration alert triggered", + tags: [ + "test:examplemonitor", + "env:ci", + ], + options: DatadogAPIClient::V1::MonitorOptions.new({ + variables: [ + DatadogAPIClient::V1::MonitorFormulaAndFunctionDataQualityQueryDefinition.new({ + name: "run_query", + data_source: DatadogAPIClient::V1::MonitorFormulaAndFunctionDataQualityDataSource::DATA_QUALITY_METRICS, + schema_version: "0.0.1", + measure: "duration", + filter: "search for databricks_job", + run_filter: "env:prod", + group_by: [ + "name", + "workspace_name", + "entity_id", + ], + monitor_options: DatadogAPIClient::V1::MonitorFormulaAndFunctionDataQualityMonitorOptions.new({ + detection_type: DatadogAPIClient::V1::MonitorFormulaAndFunctionDataQualityDetectionType::ANOMALY, + consecutive_runs: 2, + }), + }), + ], + }), +}) +p api_instance.create_monitor(body) diff --git a/examples/v1/monitors/CreateMonitor_1302731819.rb b/examples/v1/monitors/CreateMonitor_1302731819.rb new file mode 100644 index 000000000000..6bf6101d075b --- /dev/null +++ b/examples/v1/monitors/CreateMonitor_1302731819.rb @@ -0,0 +1,36 @@ +# Create a Data Jobs monitor with the aastra query dialect returns "OK" response + +require "datadog_api_client" +DatadogAPIClient.configure do |config| + config.access_token = ENV["DD_BEARER_TOKEN"] +end +api_instance = DatadogAPIClient::V1::MonitorsAPI.new + +body = DatadogAPIClient::V1::Monitor.new({ + name: "Example-Monitor", + type: DatadogAPIClient::V1::MonitorType::DATA_JOBS_ALERT, + query: 'formula("failed_runs(run_query)").by(name,workspace_name,entity_id).last(1d) > 0', + message: "Data jobs alert triggered", + tags: [ + "test:examplemonitor", + "env:ci", + ], + options: DatadogAPIClient::V1::MonitorOptions.new({ + thresholds: DatadogAPIClient::V1::MonitorThresholds.new({ + critical: 0, + }), + variables: [ + DatadogAPIClient::V1::MonitorFormulaAndFunctionDataJobsQueryDefinition.new({ + name: "run_query", + jobs_query: "search for databricks_job", + job_type: "databricks.job", + query_dialect: "aastra", + run_filter: "env:prod", + monitor_options: DatadogAPIClient::V1::MonitorFormulaAndFunctionDataJobsMonitorOptions.new({ + alert_on_every_failure: true, + }), + }), + ], + }), +}) +p api_instance.create_monitor(body) diff --git a/features/v1/monitors.feature b/features/v1/monitors.feature index 5584472ab288..ef8d3d387b30 100644 --- a/features/v1/monitors.feature +++ b/features/v1/monitors.feature @@ -42,6 +42,18 @@ Feature: Monitors When the request is sent Then the response status is 200 OK + @team:ddoghq/monitor-app + Scenario: Create a Data Jobs duration monitor returns "OK" response + Given new "CreateMonitor" request + And body with value {"name": "{{ unique }}", "type": "data-jobs alert", "query": "formula(\"job_duration(run_query)\").detection(anomaly).by(name,workspace_name,entity_id) > 0", "message": "Data jobs duration alert triggered", "tags": ["test:{{ unique_lower_alnum }}", "env:ci"], "options": {"variables": [{"name": "run_query", "data_source": "data_quality_metrics", "schema_version": "0.0.1", "measure": "duration", "filter": "search for databricks_job", "run_filter": "env:prod", "group_by": ["name", "workspace_name", "entity_id"], "monitor_options": {"detection_type": "anomaly", "consecutive_runs": 2}}]}} + When the request is sent + Then the response status is 200 OK + And the response "name" is equal to "{{ unique }}" + And the response "type" is equal to "data-jobs alert" + And the response "options.variables[0].run_filter" is equal to "env:prod" + And the response "options.variables[0].monitor_options.detection_type" is equal to "anomaly" + And the response "options.variables[0].monitor_options.consecutive_runs" is equal to 2 + @team:ddoghq/monitor-app Scenario: Create a Data Jobs monitor returns "OK" response Given new "CreateMonitor" request @@ -51,6 +63,18 @@ Feature: Monitors And the response "name" is equal to "{{ unique }}" And the response "type" is equal to "data-jobs alert" + @team:ddoghq/monitor-app + Scenario: Create a Data Jobs monitor with the aastra query dialect returns "OK" response + Given new "CreateMonitor" request + And body with value {"name": "{{ unique }}", "type": "data-jobs alert", "query": "formula(\"failed_runs(run_query)\").by(name,workspace_name,entity_id).last(1d) > 0", "message": "Data jobs alert triggered", "tags": ["test:{{ unique_lower_alnum }}", "env:ci"], "options": {"thresholds": {"critical": 0}, "variables": [{"name": "run_query", "jobs_query": "search for databricks_job", "job_type": "databricks.job", "query_dialect": "aastra", "run_filter": "env:prod", "monitor_options": {"alert_on_every_failure": true}}]}} + When the request is sent + Then the response status is 200 OK + And the response "name" is equal to "{{ unique }}" + And the response "type" is equal to "data-jobs alert" + And the response "options.variables[0].query_dialect" is equal to "aastra" + And the response "options.variables[0].run_filter" is equal to "env:prod" + And the response "options.variables[0].monitor_options.alert_on_every_failure" is equal to true + @team:ddoghq/monitor-app Scenario: Create a Data Quality monitor returns "OK" response Given new "CreateMonitor" request diff --git a/generated-test/test-runner-data/manifest.json b/generated-test/test-runner-data/manifest.json index 9629ebb901db..83051700ec76 100644 --- a/generated-test/test-runner-data/manifest.json +++ b/generated-test/test-runner-data/manifest.json @@ -1435,6 +1435,13 @@ "scenario": "Create a Cost Monitor returns \"OK\" response", "version": "v1" }, + { + "feature": "Monitors", + "feature_file": "../../features/v1/monitors.feature", + "file": "v1/monitors/create-a-data-jobs-duration-monitor-returns-ok-response.json", + "scenario": "Create a Data Jobs duration monitor returns \"OK\" response", + "version": "v1" + }, { "feature": "Monitors", "feature_file": "../../features/v1/monitors.feature", @@ -1442,6 +1449,13 @@ "scenario": "Create a Data Jobs monitor returns \"OK\" response", "version": "v1" }, + { + "feature": "Monitors", + "feature_file": "../../features/v1/monitors.feature", + "file": "v1/monitors/create-a-data-jobs-monitor-with-the-aastra-query-dialect-returns-ok-response.json", + "scenario": "Create a Data Jobs monitor with the aastra query dialect returns \"OK\" response", + "version": "v1" + }, { "feature": "Monitors", "feature_file": "../../features/v1/monitors.feature", diff --git a/generated-test/test-runner-data/v1/monitors/create-a-data-jobs-duration-monitor-returns-ok-response.json b/generated-test/test-runner-data/v1/monitors/create-a-data-jobs-duration-monitor-returns-ok-response.json new file mode 100644 index 000000000000..97b89686c1af --- /dev/null +++ b/generated-test/test-runner-data/v1/monitors/create-a-data-jobs-duration-monitor-returns-ok-response.json @@ -0,0 +1,56 @@ +{ + "api": "Monitors", + "expected_status": 200, + "feature": "Monitors", + "id": "v1/Monitors/Create a Data Jobs duration monitor returns \"OK\" response", + "operation_id": "CreateMonitor", + "request": { + "body": { + "schema": { + "format": null, + "ref": "Monitor", + "type": "object" + }, + "source": "inline", + "value": { + "message": "Data jobs duration alert triggered", + "name": "{{ unique }}", + "options": { + "variables": [ + { + "data_source": "data_quality_metrics", + "filter": "search for databricks_job", + "group_by": [ + "name", + "workspace_name", + "entity_id" + ], + "measure": "duration", + "monitor_options": { + "consecutive_runs": 2, + "detection_type": "anomaly" + }, + "name": "run_query", + "run_filter": "env:prod", + "schema_version": "0.0.1" + } + ] + }, + "query": "formula(\"job_duration(run_query)\").detection(anomaly).by(name,workspace_name,entity_id) > 0", + "tags": [ + "test:{{ unique_lower_alnum }}", + "env:ci" + ], + "type": "data-jobs alert" + } + }, + "content_type": "application/json", + "method": "POST", + "pagination": false, + "parameters": [], + "path": "/api/v1/monitor" + }, + "scenario": "Create a Data Jobs duration monitor returns \"OK\" response", + "schema_version": 1, + "version": "v1" +} diff --git a/generated-test/test-runner-data/v1/monitors/create-a-data-jobs-monitor-with-the-aastra-query-dialect-returns-ok-response.json b/generated-test/test-runner-data/v1/monitors/create-a-data-jobs-monitor-with-the-aastra-query-dialect-returns-ok-response.json new file mode 100644 index 000000000000..9f662996b9b7 --- /dev/null +++ b/generated-test/test-runner-data/v1/monitors/create-a-data-jobs-monitor-with-the-aastra-query-dialect-returns-ok-response.json @@ -0,0 +1,52 @@ +{ + "api": "Monitors", + "expected_status": 200, + "feature": "Monitors", + "id": "v1/Monitors/Create a Data Jobs monitor with the aastra query dialect returns \"OK\" response", + "operation_id": "CreateMonitor", + "request": { + "body": { + "schema": { + "format": null, + "ref": "Monitor", + "type": "object" + }, + "source": "inline", + "value": { + "message": "Data jobs alert triggered", + "name": "{{ unique }}", + "options": { + "thresholds": { + "critical": 0 + }, + "variables": [ + { + "job_type": "databricks.job", + "jobs_query": "search for databricks_job", + "monitor_options": { + "alert_on_every_failure": true + }, + "name": "run_query", + "query_dialect": "aastra", + "run_filter": "env:prod" + } + ] + }, + "query": "formula(\"failed_runs(run_query)\").by(name,workspace_name,entity_id).last(1d) > 0", + "tags": [ + "test:{{ unique_lower_alnum }}", + "env:ci" + ], + "type": "data-jobs alert" + } + }, + "content_type": "application/json", + "method": "POST", + "pagination": false, + "parameters": [], + "path": "/api/v1/monitor" + }, + "scenario": "Create a Data Jobs monitor with the aastra query dialect returns \"OK\" response", + "schema_version": 1, + "version": "v1" +} diff --git a/generated-test/test-server-data/v1/monitors.json b/generated-test/test-server-data/v1/monitors.json index 1242fc1f2c20..b1fd4a2ab73c 100644 --- a/generated-test/test-server-data/v1/monitors.json +++ b/generated-test/test-server-data/v1/monitors.json @@ -192,6 +192,90 @@ "scenario": "Create a Cost Monitor returns \"OK\" response", "version": "v1" }, + { + "feature": "Monitors", + "frozen_at": "2026-11-06T16:42:00.361Z", + "interactions": [ + { + "request": { + "body": { + "type": "json", + "value": { + "message": "Data jobs duration alert triggered", + "name": "Test-Create_a_Data_Jobs_duration_monitor_returns_OK_response-1793983320", + "options": { + "variables": [ + { + "data_source": "data_quality_metrics", + "filter": "search for databricks_job", + "group_by": [ + "name", + "workspace_name", + "entity_id" + ], + "measure": "duration", + "monitor_options": { + "consecutive_runs": 2, + "detection_type": "anomaly" + }, + "name": "run_query", + "run_filter": "env:prod", + "schema_version": "0.0.1" + } + ] + }, + "query": "formula(\"job_duration(run_query)\").detection(anomaly).by(name,workspace_name,entity_id) > 0", + "tags": [ + "test:testcreateadatajobsdurationmonitorreturnsokresponse1793983320", + "env:ci" + ], + "type": "data-jobs alert" + } + }, + "content_type": "application/json", + "method": "POST", + "path": "/api/v1/monitor", + "query": [] + }, + "response": { + "body": { + "encoding": "text", + "value": "{\"id\":341751249,\"org_id\":321813,\"type\":\"data-jobs alert\",\"name\":\"Test-Create_a_Data_Jobs_duration_monitor_returns_OK_response-1793983320\",\"message\":\"Data jobs duration alert triggered\",\"tags\":[\"test:testcreateadatajobsdurationmonitorreturnsokresponse1793983320\",\"env:ci\"],\"query\":\"formula(\\\"job_duration(run_query)\\\").detection(anomaly).by(name,workspace_name,entity_id) > 0\",\"options\":{\"variables\":[{\"data_source\":\"data_quality_metrics\",\"filter\":\"search for databricks_job\",\"group_by\":[\"name\",\"workspace_name\",\"entity_id\"],\"measure\":\"duration\",\"monitor_options\":{\"consecutive_runs\":2,\"detection_type\":\"anomaly\"},\"name\":\"run_query\",\"run_filter\":\"env:prod\",\"schema_version\":\"0.0.1\"}],\"notify_no_data\":false,\"notify_audit\":false,\"new_host_delay\":300,\"include_tags\":true,\"silenced\":{}},\"multi\":true,\"created_at\":1793983320000,\"created\":\"2026-11-06T16:42:00.590725+00:00\",\"modified\":\"2026-11-06T16:42:00.590725+00:00\",\"deleted\":null,\"priority\":null,\"restricted_roles\":null,\"restriction_policy\":null,\"draft_status\":\"published\",\"assets\":[],\"overall_state_modified\":null,\"overall_state\":\"No Data\",\"creator\":{\"name\":\"C\\u00e9dric Van Rompay\",\"handle\":\"cedric.vanrompay@datadoghq.com\",\"email\":\"cedric.vanrompay@datadoghq.com\",\"id\":68397867}}\n" + }, + "headers": { + "content-type": "application/json" + }, + "reason": "OK", + "status": 200 + } + }, + { + "request": { + "body": { + "type": "empty", + "value": null + }, + "content_type": "", + "method": "DELETE", + "path": "/api/v1/monitor/341751249", + "query": [] + }, + "response": { + "body": { + "encoding": "text", + "value": "{\"deleted_monitor_id\":341751249}\n" + }, + "headers": { + "content-type": "application/json" + }, + "reason": "OK", + "status": 200 + } + } + ], + "scenario": "Create a Data Jobs duration monitor returns \"OK\" response", + "version": "v1" + }, { "feature": "Monitors", "frozen_at": "2026-05-14T10:58:54.153Z", @@ -268,6 +352,86 @@ "scenario": "Create a Data Jobs monitor returns \"OK\" response", "version": "v1" }, + { + "feature": "Monitors", + "frozen_at": "2026-11-06T16:42:01.032Z", + "interactions": [ + { + "request": { + "body": { + "type": "json", + "value": { + "message": "Data jobs alert triggered", + "name": "Test-Create_a_Data_Jobs_monitor_with_the_aastra_query_dialect_returns_OK_response-1793983321", + "options": { + "thresholds": { + "critical": 0 + }, + "variables": [ + { + "job_type": "databricks.job", + "jobs_query": "search for databricks_job", + "monitor_options": { + "alert_on_every_failure": true + }, + "name": "run_query", + "query_dialect": "aastra", + "run_filter": "env:prod" + } + ] + }, + "query": "formula(\"failed_runs(run_query)\").by(name,workspace_name,entity_id).last(1d) > 0", + "tags": [ + "test:testcreateadatajobsmonitorwiththeaastraquerydialectreturnsokresponse1793983321", + "env:ci" + ], + "type": "data-jobs alert" + } + }, + "content_type": "application/json", + "method": "POST", + "path": "/api/v1/monitor", + "query": [] + }, + "response": { + "body": { + "encoding": "text", + "value": "{\"id\":341751253,\"org_id\":321813,\"type\":\"data-jobs alert\",\"name\":\"Test-Create_a_Data_Jobs_monitor_with_the_aastra_query_dialect_returns_OK_response-1793983321\",\"message\":\"Data jobs alert triggered\",\"tags\":[\"test:testcreateadatajobsmonitorwiththeaastraquerydialectreturnsokresponse1793983321\",\"env:ci\"],\"query\":\"formula(\\\"failed_runs(run_query)\\\").by(name,workspace_name,entity_id).last(1d) > 0\",\"options\":{\"thresholds\":{\"critical\":0.0},\"variables\":[{\"job_type\":\"databricks.job\",\"jobs_query\":\"search for databricks_job\",\"monitor_options\":{\"alert_on_every_failure\":true},\"name\":\"run_query\",\"query_dialect\":\"aastra\",\"run_filter\":\"env:prod\"}],\"notify_no_data\":false,\"notify_audit\":false,\"new_host_delay\":300,\"include_tags\":true,\"silenced\":{}},\"multi\":true,\"created_at\":1793983321000,\"created\":\"2026-11-06T16:42:01.177378+00:00\",\"modified\":\"2026-11-06T16:42:01.177378+00:00\",\"deleted\":null,\"priority\":null,\"restricted_roles\":null,\"restriction_policy\":null,\"draft_status\":\"published\",\"assets\":[],\"overall_state_modified\":null,\"overall_state\":\"No Data\",\"creator\":{\"name\":\"C\\u00e9dric Van Rompay\",\"handle\":\"cedric.vanrompay@datadoghq.com\",\"email\":\"cedric.vanrompay@datadoghq.com\",\"id\":68397867}}\n" + }, + "headers": { + "content-type": "application/json" + }, + "reason": "OK", + "status": 200 + } + }, + { + "request": { + "body": { + "type": "empty", + "value": null + }, + "content_type": "", + "method": "DELETE", + "path": "/api/v1/monitor/341751253", + "query": [] + }, + "response": { + "body": { + "encoding": "text", + "value": "{\"deleted_monitor_id\":341751253}\n" + }, + "headers": { + "content-type": "application/json" + }, + "reason": "OK", + "status": 200 + } + } + ], + "scenario": "Create a Data Jobs monitor with the aastra query dialect returns \"OK\" response", + "version": "v1" + }, { "feature": "Monitors", "frozen_at": "2026-01-12T17:23:49.629Z", diff --git a/lib/datadog_api_client/inflector.rb b/lib/datadog_api_client/inflector.rb index ff6d8495dc40..36ab8f2db077 100644 --- a/lib/datadog_api_client/inflector.rb +++ b/lib/datadog_api_client/inflector.rb @@ -468,8 +468,10 @@ def overrides "v1.monitor_formula_and_function_cost_aggregator" => "MonitorFormulaAndFunctionCostAggregator", "v1.monitor_formula_and_function_cost_data_source" => "MonitorFormulaAndFunctionCostDataSource", "v1.monitor_formula_and_function_cost_query_definition" => "MonitorFormulaAndFunctionCostQueryDefinition", + "v1.monitor_formula_and_function_data_jobs_monitor_options" => "MonitorFormulaAndFunctionDataJobsMonitorOptions", "v1.monitor_formula_and_function_data_jobs_query_definition" => "MonitorFormulaAndFunctionDataJobsQueryDefinition", "v1.monitor_formula_and_function_data_quality_data_source" => "MonitorFormulaAndFunctionDataQualityDataSource", + "v1.monitor_formula_and_function_data_quality_detection_type" => "MonitorFormulaAndFunctionDataQualityDetectionType", "v1.monitor_formula_and_function_data_quality_diff_function" => "MonitorFormulaAndFunctionDataQualityDiffFunction", "v1.monitor_formula_and_function_data_quality_diff_type" => "MonitorFormulaAndFunctionDataQualityDiffType", "v1.monitor_formula_and_function_data_quality_entity_metric_config" => "MonitorFormulaAndFunctionDataQualityEntityMetricConfig", diff --git a/lib/datadog_api_client/v1/api/monitors_api.rb b/lib/datadog_api_client/v1/api/monitors_api.rb index d8d6b74c09bc..9363754a36ee 100644 --- a/lib/datadog_api_client/v1/api/monitors_api.rb +++ b/lib/datadog_api_client/v1/api/monitors_api.rb @@ -335,6 +335,22 @@ def create_monitor(body, opts = {}) # - `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`. # - `#` an integer or decimal number used to set the threshold. # + # **Data Jobs Alert Query** + # + # Job status example: `formula("failed_runs(run_query)").by(group_keys).last(time_window) > #` + # + # Job duration examples: `formula("job_duration(run_query)").detection(static).by(group_keys) > duration` + # and `formula("job_duration(run_query)").detection(anomaly).by(group_keys) > 0` + # + # - `run_query`: The name of the single query variable in `options.variables`. Job status monitors + # use a data jobs query; job duration monitors use a data quality query with the `duration` measure. + # - `group_keys`: The tags to group by, such as `entity_id,name,workspace_name`. + # - `time_window`: Number of minutes (#m), hours (#h), or days (#d), up to `10d`. + # - `#`: The number of trailing failed runs to alert above, as a non-negative integer. + # - `duration`: The duration to alert above, such as `2h`, `30m`, or a number of seconds. + # - `options.thresholds.critical`: Must equal the query threshold, in seconds for job duration. + # Anomaly job duration monitors omit `options.thresholds`. + # # @param body [Monitor] Create a monitor request body. # @param opts [Hash] the optional parameters # @return [Array<(Monitor, Integer, Hash)>] Monitor data, response status code and response headers diff --git a/lib/datadog_api_client/v1/models/monitor_formula_and_function_data_jobs_monitor_options.rb b/lib/datadog_api_client/v1/models/monitor_formula_and_function_data_jobs_monitor_options.rb new file mode 100644 index 000000000000..e9ca023f46ab --- /dev/null +++ b/lib/datadog_api_client/v1/models/monitor_formula_and_function_data_jobs_monitor_options.rb @@ -0,0 +1,108 @@ +=begin +#Datadog API V1 Collection + +#Collection of all Datadog Public endpoints. + +The version of the OpenAPI document: 1.0 +Contact: support@datadoghq.com +Generated by: https://github.com/DataDog/datadog-api-client-ruby/tree/master/.generator + + Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. + This product includes software developed at Datadog (https://www.datadoghq.com/). + Copyright 2020-Present Datadog, Inc. + +=end + +require 'date' +require 'time' + +module DatadogAPIClient::V1 + # Monitor configuration options for data jobs queries. + class MonitorFormulaAndFunctionDataJobsMonitorOptions + include BaseGenericModel + + # Alert separately for each failed run instead of on the count of trailing failures. + # Only supported for `failed_runs` monitors with the `aastra` query dialect. It requires + # a `> 0` threshold with no warning threshold, an evaluation window of at most two days, + # and renotification disabled. + attr_accessor :alert_on_every_failure + + attr_accessor :additional_properties + + # Attribute mapping from ruby-style variable name to JSON key. + # @!visibility private + def self.attribute_map + { + :'alert_on_every_failure' => :'alert_on_every_failure' + } + end + + # Attribute type mapping. + # @!visibility private + def self.openapi_types + { + :'alert_on_every_failure' => :'Boolean' + } + end + + # Initializes the object + # @param attributes [Hash] Model attributes in the form of hash + # @!visibility private + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V1::MonitorFormulaAndFunctionDataJobsMonitorOptions` initialize method" + end + + self.additional_properties = {} + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + self.additional_properties[k.to_sym] = v + else + h[k.to_sym] = v + end + } + + if attributes.key?(:'alert_on_every_failure') + self.alert_on_every_failure = attributes[:'alert_on_every_failure'] + end + end + + # Returns the object in the form of hash, with additionalProperties support. + # @return [Hash] Returns the object in the form of hash + # @!visibility private + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + self.additional_properties.each_pair do |attr, value| + hash[attr] = value + end + hash + end + + # Checks equality by comparing each attribute. + # @param o [Object] Object to be compared + # @!visibility private + def ==(o) + return true if self.equal?(o) + self.class == o.class && + alert_on_every_failure == o.alert_on_every_failure && + additional_properties == o.additional_properties + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + # @!visibility private + def hash + [alert_on_every_failure, additional_properties].hash + end + end +end diff --git a/lib/datadog_api_client/v1/models/monitor_formula_and_function_data_jobs_query_definition.rb b/lib/datadog_api_client/v1/models/monitor_formula_and_function_data_jobs_query_definition.rb index e15fab8e2cb5..724588439a3d 100644 --- a/lib/datadog_api_client/v1/models/monitor_formula_and_function_data_jobs_query_definition.rb +++ b/lib/datadog_api_client/v1/models/monitor_formula_and_function_data_jobs_query_definition.rb @@ -22,20 +22,29 @@ class MonitorFormulaAndFunctionDataJobsQueryDefinition include BaseGenericModel # The type of job being monitored. Valid values include: - # `databricks.job`, `spark.application`, `airflow.dag`, - # `dbt.job`, `dbt.model`, `dbt.test`, `glue.job`. + # `databricks.job`, `spark.application`, `airflow.dag`, `dbt.job`, `glue.job`, `adf.pipeline`. + # The `aastra` dialect also accepts `airflow.job`, `dbt.model`, and `dbt.test`. # Custom job types are supported with the `custom.ol.` prefix. attr_reader :job_type - # Filter expression used to select the jobs to monitor. + # Filter expression used to select the jobs to monitor. Its syntax depends on `query_dialect`: + # a metric tag filter such as `job_name:smoke*` for `metric`, or an Aastra entity search + # such as ``search for databricks_job where `@team:data-eng` `` for `aastra`. attr_reader :jobs_query + # Monitor configuration options for data jobs queries. + attr_accessor :monitor_options + # Name of the query for use in formulas. Must be `run_query`. attr_reader :name - # Query dialect for data jobs queries. Currently only `metric` is supported. + # Query dialect for data jobs queries. Valid values are `metric` and `aastra`. attr_reader :query_dialect + # Optional filter on individual runs, using metrics filter syntax. + # Only supported with the `aastra` query dialect. + attr_accessor :run_filter + attr_accessor :additional_properties # Attribute mapping from ruby-style variable name to JSON key. @@ -44,8 +53,10 @@ def self.attribute_map { :'job_type' => :'job_type', :'jobs_query' => :'jobs_query', + :'monitor_options' => :'monitor_options', :'name' => :'name', - :'query_dialect' => :'query_dialect' + :'query_dialect' => :'query_dialect', + :'run_filter' => :'run_filter' } end @@ -55,8 +66,10 @@ def self.openapi_types { :'job_type' => :'String', :'jobs_query' => :'String', + :'monitor_options' => :'MonitorFormulaAndFunctionDataJobsMonitorOptions', :'name' => :'String', - :'query_dialect' => :'String' + :'query_dialect' => :'String', + :'run_filter' => :'String' } end @@ -86,6 +99,10 @@ def initialize(attributes = {}) self.jobs_query = attributes[:'jobs_query'] end + if attributes.key?(:'monitor_options') + self.monitor_options = attributes[:'monitor_options'] + end + if attributes.key?(:'name') self.name = attributes[:'name'] end @@ -93,6 +110,10 @@ def initialize(attributes = {}) if attributes.key?(:'query_dialect') self.query_dialect = attributes[:'query_dialect'] end + + if attributes.key?(:'run_filter') + self.run_filter = attributes[:'run_filter'] + end end # Check to see if the all the properties in the model are valid @@ -174,8 +195,10 @@ def ==(o) self.class == o.class && job_type == o.job_type && jobs_query == o.jobs_query && + monitor_options == o.monitor_options && name == o.name && query_dialect == o.query_dialect && + run_filter == o.run_filter && additional_properties == o.additional_properties end @@ -183,7 +206,7 @@ def ==(o) # @return [Integer] Hash code # @!visibility private def hash - [job_type, jobs_query, name, query_dialect, additional_properties].hash + [job_type, jobs_query, monitor_options, name, query_dialect, run_filter, additional_properties].hash end end end diff --git a/lib/datadog_api_client/v1/models/monitor_formula_and_function_data_quality_detection_type.rb b/lib/datadog_api_client/v1/models/monitor_formula_and_function_data_quality_detection_type.rb new file mode 100644 index 000000000000..15973a98f37d --- /dev/null +++ b/lib/datadog_api_client/v1/models/monitor_formula_and_function_data_quality_detection_type.rb @@ -0,0 +1,28 @@ +=begin +#Datadog API V1 Collection + +#Collection of all Datadog Public endpoints. + +The version of the OpenAPI document: 1.0 +Contact: support@datadoghq.com +Generated by: https://github.com/DataDog/datadog-api-client-ruby/tree/master/.generator + + Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. + This product includes software developed at Datadog (https://www.datadoghq.com/). + Copyright 2020-Present Datadog, Inc. + +=end + +require 'date' +require 'time' + +module DatadogAPIClient::V1 + # How a `data-jobs alert` job duration monitor detects a breach. Must match the + # `.detection()` call in the monitor query. Required for job duration monitors. + class MonitorFormulaAndFunctionDataQualityDetectionType + include BaseEnumModel + + STATIC = "static".freeze + ANOMALY = "anomaly".freeze + end +end diff --git a/lib/datadog_api_client/v1/models/monitor_formula_and_function_data_quality_monitor_options.rb b/lib/datadog_api_client/v1/models/monitor_formula_and_function_data_quality_monitor_options.rb index 3edd26160aa5..c7d56c26991a 100644 --- a/lib/datadog_api_client/v1/models/monitor_formula_and_function_data_quality_monitor_options.rb +++ b/lib/datadog_api_client/v1/models/monitor_formula_and_function_data_quality_monitor_options.rb @@ -21,6 +21,10 @@ module DatadogAPIClient::V1 class MonitorFormulaAndFunctionDataQualityMonitorOptions include BaseGenericModel + # Number of consecutive runs that must breach before the monitor alerts. + # Only supported by `data-jobs alert` job duration monitors. Defaults to `1`. + attr_reader :consecutive_runs + # Crontab expression to override the default schedule. attr_accessor :crontab_override @@ -30,6 +34,10 @@ class MonitorFormulaAndFunctionDataQualityMonitorOptions # Custom WHERE clause for the query. attr_accessor :custom_where + # How a `data-jobs alert` job duration monitor detects a breach. Must match the + # `.detection()` call in the monitor query. Required for job duration monitors. + attr_accessor :detection_type + # Columns to group results by. attr_accessor :group_by_columns @@ -54,9 +62,11 @@ class MonitorFormulaAndFunctionDataQualityMonitorOptions # @!visibility private def self.attribute_map { + :'consecutive_runs' => :'consecutive_runs', :'crontab_override' => :'crontab_override', :'custom_sql' => :'custom_sql', :'custom_where' => :'custom_where', + :'detection_type' => :'detection_type', :'group_by_columns' => :'group_by_columns', :'model_configuration' => :'model_configuration', :'model_type_override' => :'model_type_override', @@ -69,9 +79,11 @@ def self.attribute_map # @!visibility private def self.openapi_types { + :'consecutive_runs' => :'Integer', :'crontab_override' => :'String', :'custom_sql' => :'String', :'custom_where' => :'String', + :'detection_type' => :'MonitorFormulaAndFunctionDataQualityDetectionType', :'group_by_columns' => :'Array', :'model_configuration' => :'MonitorFormulaAndFunctionDataQualityModelConfiguration', :'model_type_override' => :'MonitorFormulaAndFunctionDataQualityModelTypeOverride', @@ -98,6 +110,10 @@ def initialize(attributes = {}) end } + if attributes.key?(:'consecutive_runs') + self.consecutive_runs = attributes[:'consecutive_runs'] + end + if attributes.key?(:'crontab_override') self.crontab_override = attributes[:'crontab_override'] end @@ -110,6 +126,10 @@ def initialize(attributes = {}) self.custom_where = attributes[:'custom_where'] end + if attributes.key?(:'detection_type') + self.detection_type = attributes[:'detection_type'] + end + if attributes.key?(:'group_by_columns') if (value = attributes[:'group_by_columns']).is_a?(Array) self.group_by_columns = value @@ -133,6 +153,24 @@ def initialize(attributes = {}) end end + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + # @!visibility private + def valid? + return false if !@consecutive_runs.nil? && @consecutive_runs < 1 + true + end + + # Custom attribute writer method with validation + # @param consecutive_runs [Object] Object to be assigned + # @!visibility private + def consecutive_runs=(consecutive_runs) + if !consecutive_runs.nil? && consecutive_runs < 1 + fail ArgumentError, 'invalid value for "consecutive_runs", must be greater than or equal to 1.' + end + @consecutive_runs = consecutive_runs + end + # Returns the object in the form of hash, with additionalProperties support. # @return [Hash] Returns the object in the form of hash # @!visibility private @@ -159,9 +197,11 @@ def to_hash def ==(o) return true if self.equal?(o) self.class == o.class && + consecutive_runs == o.consecutive_runs && crontab_override == o.crontab_override && custom_sql == o.custom_sql && custom_where == o.custom_where && + detection_type == o.detection_type && group_by_columns == o.group_by_columns && model_configuration == o.model_configuration && model_type_override == o.model_type_override && @@ -174,7 +214,7 @@ def ==(o) # @return [Integer] Hash code # @!visibility private def hash - [crontab_override, custom_sql, custom_where, group_by_columns, model_configuration, model_type_override, sensitivity, source_to_target_config, additional_properties].hash + [consecutive_runs, crontab_override, custom_sql, custom_where, detection_type, group_by_columns, model_configuration, model_type_override, sensitivity, source_to_target_config, additional_properties].hash end end end diff --git a/lib/datadog_api_client/v1/models/monitor_formula_and_function_data_quality_query_definition.rb b/lib/datadog_api_client/v1/models/monitor_formula_and_function_data_quality_query_definition.rb index 581fdf5b2b76..fe9cef66d062 100644 --- a/lib/datadog_api_client/v1/models/monitor_formula_and_function_data_quality_query_definition.rb +++ b/lib/datadog_api_client/v1/models/monitor_formula_and_function_data_quality_query_definition.rb @@ -33,7 +33,8 @@ class MonitorFormulaAndFunctionDataQualityQueryDefinition # The data quality measure to query. Common values include: # `bytes`, `cardinality`, `custom`, `freshness`, `max`, `mean`, `min`, # `nullness`, `percent_negative`, `percent_zero`, `row_count`, `stddev`, - # `sum`, `uniqueness`. Additional values may be supported. + # `sum`, `uniqueness`. `data-jobs alert` job duration monitors use `duration`. + # Additional values may be supported. attr_reader :measure # Monitor configuration options for data quality queries. @@ -42,6 +43,10 @@ class MonitorFormulaAndFunctionDataQualityQueryDefinition # Name of the query for use in formulas. attr_reader :name + # Optional filter on individual runs, using metrics filter syntax. + # Only supported by `data-jobs alert` job duration monitors. + attr_accessor :run_filter + # Schema version for the data quality query. attr_accessor :schema_version @@ -61,6 +66,7 @@ def self.attribute_map :'measure' => :'measure', :'monitor_options' => :'monitor_options', :'name' => :'name', + :'run_filter' => :'run_filter', :'schema_version' => :'schema_version', :'scope' => :'scope' } @@ -76,6 +82,7 @@ def self.openapi_types :'measure' => :'String', :'monitor_options' => :'MonitorFormulaAndFunctionDataQualityMonitorOptions', :'name' => :'String', + :'run_filter' => :'String', :'schema_version' => :'String', :'scope' => :'String' } @@ -125,6 +132,10 @@ def initialize(attributes = {}) self.name = attributes[:'name'] end + if attributes.key?(:'run_filter') + self.run_filter = attributes[:'run_filter'] + end + if attributes.key?(:'schema_version') self.schema_version = attributes[:'schema_version'] end @@ -217,6 +228,7 @@ def ==(o) measure == o.measure && monitor_options == o.monitor_options && name == o.name && + run_filter == o.run_filter && schema_version == o.schema_version && scope == o.scope && additional_properties == o.additional_properties @@ -226,7 +238,7 @@ def ==(o) # @return [Integer] Hash code # @!visibility private def hash - [data_source, filter, group_by, measure, monitor_options, name, schema_version, scope, additional_properties].hash + [data_source, filter, group_by, measure, monitor_options, name, run_filter, schema_version, scope, additional_properties].hash end end end