-
Notifications
You must be signed in to change notification settings - Fork 48
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add custom schedule to monitor scheduling options (#1681)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
- Loading branch information
1 parent
f74ac02
commit f079744
Showing
11 changed files
with
282 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| """ | ||
| Create a metric monitor with a custom schedule returns "OK" response | ||
| """ | ||
|
|
||
| from datadog_api_client import ApiClient, Configuration | ||
| from datadog_api_client.v1.api.monitors_api import MonitorsApi | ||
| from datadog_api_client.v1.model.monitor import Monitor | ||
| from datadog_api_client.v1.model.monitor_options import MonitorOptions | ||
| from datadog_api_client.v1.model.monitor_options_custom_schedule import MonitorOptionsCustomSchedule | ||
| from datadog_api_client.v1.model.monitor_options_custom_schedule_recurrence import ( | ||
| MonitorOptionsCustomScheduleRecurrence, | ||
| ) | ||
| from datadog_api_client.v1.model.monitor_options_scheduling_options import MonitorOptionsSchedulingOptions | ||
| from datadog_api_client.v1.model.monitor_options_scheduling_options_evaluation_window import ( | ||
| MonitorOptionsSchedulingOptionsEvaluationWindow, | ||
| ) | ||
| from datadog_api_client.v1.model.monitor_thresholds import MonitorThresholds | ||
| from datadog_api_client.v1.model.monitor_type import MonitorType | ||
| from datadog_api_client.v1.model.on_missing_data_option import OnMissingDataOption | ||
|
|
||
| body = Monitor( | ||
| message="some message Notify: @hipchat-channel", | ||
| name="Example-Monitor", | ||
| query="avg(current_1mo):avg:system.load.5{*} > 0.5", | ||
| tags=[], | ||
| options=MonitorOptions( | ||
| thresholds=MonitorThresholds( | ||
| critical=0.5, | ||
| ), | ||
| notify_audit=False, | ||
| on_missing_data=OnMissingDataOption.DEFAULT, | ||
| include_tags=False, | ||
| scheduling_options=MonitorOptionsSchedulingOptions( | ||
| evaluation_window=MonitorOptionsSchedulingOptionsEvaluationWindow( | ||
| day_starts="04:00", | ||
| month_starts=1, | ||
| ), | ||
| custom_schedule=MonitorOptionsCustomSchedule( | ||
| recurrences=[ | ||
| MonitorOptionsCustomScheduleRecurrence( | ||
| rrule="FREQ=DAILY;INTERVAL=1", | ||
| timezone="America/Los_Angeles", | ||
| start="2024-10-26T09:13:00", | ||
| ), | ||
| ], | ||
| ), | ||
| ), | ||
| ), | ||
| type=MonitorType.QUERY_ALERT, | ||
| ) | ||
|
|
||
| configuration = Configuration() | ||
| with ApiClient(configuration) as api_client: | ||
| api_instance = MonitorsApi(api_client) | ||
| response = api_instance.create_monitor(body=body) | ||
|
|
||
| print(response) |
46 changes: 46 additions & 0 deletions
46
src/datadog_api_client/v1/model/monitor_options_custom_schedule.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| # 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 2019-Present Datadog, Inc. | ||
| from __future__ import annotations | ||
|
|
||
| from typing import List, Union, TYPE_CHECKING | ||
|
|
||
| from datadog_api_client.model_utils import ( | ||
| ModelNormal, | ||
| cached_property, | ||
| unset, | ||
| UnsetType, | ||
| ) | ||
|
|
||
|
|
||
| if TYPE_CHECKING: | ||
| from datadog_api_client.v1.model.monitor_options_custom_schedule_recurrence import ( | ||
| MonitorOptionsCustomScheduleRecurrence, | ||
| ) | ||
|
|
||
|
|
||
| class MonitorOptionsCustomSchedule(ModelNormal): | ||
| @cached_property | ||
| def openapi_types(_): | ||
| from datadog_api_client.v1.model.monitor_options_custom_schedule_recurrence import ( | ||
| MonitorOptionsCustomScheduleRecurrence, | ||
| ) | ||
|
|
||
| return { | ||
| "recurrences": ([MonitorOptionsCustomScheduleRecurrence],), | ||
| } | ||
|
|
||
| attribute_map = { | ||
| "recurrences": "recurrences", | ||
| } | ||
|
|
||
| def __init__(self_, recurrences: Union[List[MonitorOptionsCustomScheduleRecurrence], UnsetType] = unset, **kwargs): | ||
| """ | ||
| Configuration options for the custom schedule. **This feature is in private beta.** | ||
| :param recurrences: Array of custom schedule recurrences. | ||
| :type recurrences: [MonitorOptionsCustomScheduleRecurrence], optional | ||
| """ | ||
| if recurrences is not unset: | ||
| kwargs["recurrences"] = recurrences | ||
| super().__init__(kwargs) |
56 changes: 56 additions & 0 deletions
56
src/datadog_api_client/v1/model/monitor_options_custom_schedule_recurrence.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| # 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 2019-Present Datadog, Inc. | ||
| from __future__ import annotations | ||
|
|
||
| from typing import Union | ||
|
|
||
| from datadog_api_client.model_utils import ( | ||
| ModelNormal, | ||
| cached_property, | ||
| unset, | ||
| UnsetType, | ||
| ) | ||
|
|
||
|
|
||
| class MonitorOptionsCustomScheduleRecurrence(ModelNormal): | ||
| @cached_property | ||
| def openapi_types(_): | ||
| return { | ||
| "rrule": (str,), | ||
| "start": (str,), | ||
| "timezone": (str,), | ||
| } | ||
|
|
||
| attribute_map = { | ||
| "rrule": "rrule", | ||
| "start": "start", | ||
| "timezone": "timezone", | ||
| } | ||
|
|
||
| def __init__( | ||
| self_, | ||
| rrule: Union[str, UnsetType] = unset, | ||
| start: Union[str, UnsetType] = unset, | ||
| timezone: Union[str, UnsetType] = unset, | ||
| **kwargs, | ||
| ): | ||
| """ | ||
| Configuration for a recurrence set on the monitor options for custom schedule. | ||
| :param rrule: Defines the recurrence rule (RRULE) for a given schedule. | ||
| :type rrule: str, optional | ||
| :param start: Defines the start date and time of the recurring schedule. | ||
| :type start: str, optional | ||
| :param timezone: Defines the timezone the schedule runs on. | ||
| :type timezone: str, optional | ||
| """ | ||
| if rrule is not unset: | ||
| kwargs["rrule"] = rrule | ||
| if start is not unset: | ||
| kwargs["start"] = start | ||
| if timezone is not unset: | ||
| kwargs["timezone"] = timezone | ||
| super().__init__(kwargs) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1 change: 1 addition & 0 deletions
1
..._scenarios/test_create_a_metric_monitor_with_a_custom_schedule_returns_ok_response.frozen
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| 2023-10-04T18:33:20.272Z |
44 changes: 44 additions & 0 deletions
44
...st_scenarios/test_create_a_metric_monitor_with_a_custom_schedule_returns_ok_response.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| interactions: | ||
| - request: | ||
| body: '{"message":"some message Notify: @hipchat-channel","name":"Test-Create_a_metric_monitor_with_a_custom_schedule_returns_OK_response-1696444400","options":{"include_tags":false,"notify_audit":false,"on_missing_data":"default","scheduling_options":{"custom_schedule":{"recurrences":[{"rrule":"FREQ=DAILY;INTERVAL=1","start":"2024-10-26T09:13:00","timezone":"America/Los_Angeles"}]},"evaluation_window":{"day_starts":"04:00","month_starts":1}},"thresholds":{"critical":0.5}},"query":"avg(current_1mo):avg:system.load.5{*} | ||
| > 0.5","tags":[],"type":"query alert"}' | ||
| headers: | ||
| accept: | ||
| - application/json | ||
| content-type: | ||
| - application/json | ||
| method: POST | ||
| uri: https://api.datadoghq.com/api/v1/monitor | ||
| response: | ||
| body: | ||
| string: '{"id":132537965,"org_id":321813,"type":"query alert","name":"Test-Create_a_metric_monitor_with_a_custom_schedule_returns_OK_response-1696444400","message":"some | ||
| message Notify: @hipchat-channel","tags":[],"query":"avg(current_1mo):avg:system.load.5{*} | ||
| > 0.5","options":{"include_tags":false,"notify_audit":false,"on_missing_data":"default","scheduling_options":{"custom_schedule":{"recurrences":[{"rrule":"FREQ=DAILY;INTERVAL=1","start":"2024-10-26T09:13:00","timezone":"America/Los_Angeles"}]},"evaluation_window":{"day_starts":"04:00","month_starts":1}},"thresholds":{"critical":0.5},"new_host_delay":300,"silenced":{}},"multi":false,"created_at":1696444400000,"created":"2023-10-04T18:33:20.388003+00:00","modified":"2023-10-04T18:33:20.388003+00:00","deleted":null,"restricted_roles":null,"priority":null,"overall_state_modified":null,"overall_state":"No | ||
| Data","creator":{"name":"CI Account","handle":"9919ec9b-ebc7-49ee-8dc8-03626e717cca","email":"team-intg-tools-libs-spam@datadoghq.com","id":2320499}} | ||
| ' | ||
| headers: | ||
| content-type: | ||
| - application/json | ||
| status: | ||
| code: 200 | ||
| message: OK | ||
| - request: | ||
| body: null | ||
| headers: | ||
| accept: | ||
| - application/json | ||
| method: DELETE | ||
| uri: https://api.datadoghq.com/api/v1/monitor/132537965 | ||
| response: | ||
| body: | ||
| string: '{"deleted_monitor_id":132537965} | ||
| ' | ||
| headers: | ||
| content-type: | ||
| - application/json | ||
| status: | ||
| code: 200 | ||
| message: OK | ||
| version: 1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters