Skip to content

Add backfilled degradation and maintenance endpoints to Status Pages #3464

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
api-clients-generation-pipeline wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add backfilled degradation and maintenance endpoints to Status Pages #3464

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
554 changes: 434 additions & 120 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

119 changes: 112 additions & 7 deletions docs/datadog_api_client.v2.model.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6367,6 +6367,76 @@ datadog\_api\_client.v2.model.create\_attachment\_request\_data\_attributes\_att
:members:
:show-inheritance:

datadog\_api\_client.v2.model.create\_backfilled\_degradation\_request module
-----------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.create_backfilled_degradation_request
:members:
:show-inheritance:

datadog\_api\_client.v2.model.create\_backfilled\_degradation\_request\_data module
-----------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.create_backfilled_degradation_request_data
:members:
:show-inheritance:

datadog\_api\_client.v2.model.create\_backfilled\_degradation\_request\_data\_attributes module
-----------------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.create_backfilled_degradation_request_data_attributes
:members:
:show-inheritance:

datadog\_api\_client.v2.model.create\_backfilled\_degradation\_request\_data\_attributes\_updates\_items module
---------------------------------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.create_backfilled_degradation_request_data_attributes_updates_items
:members:
:show-inheritance:

datadog\_api\_client.v2.model.create\_backfilled\_degradation\_request\_data\_attributes\_updates\_items\_components\_affected\_items module
--------------------------------------------------------------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.create_backfilled_degradation_request_data_attributes_updates_items_components_affected_items
:members:
:show-inheritance:

datadog\_api\_client.v2.model.create\_backfilled\_maintenance\_request module
-----------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.create_backfilled_maintenance_request
:members:
:show-inheritance:

datadog\_api\_client.v2.model.create\_backfilled\_maintenance\_request\_data module
-----------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.create_backfilled_maintenance_request_data
:members:
:show-inheritance:

datadog\_api\_client.v2.model.create\_backfilled\_maintenance\_request\_data\_attributes module
-----------------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.create_backfilled_maintenance_request_data_attributes
:members:
:show-inheritance:

datadog\_api\_client.v2.model.create\_backfilled\_maintenance\_request\_data\_attributes\_updates\_items module
---------------------------------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.create_backfilled_maintenance_request_data_attributes_updates_items
:members:
:show-inheritance:

datadog\_api\_client.v2.model.create\_backfilled\_maintenance\_request\_data\_attributes\_updates\_items\_components\_affected\_items module
--------------------------------------------------------------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.create_backfilled_maintenance_request_data_attributes_updates_items_components_affected_items
:members:
:show-inheritance:

datadog\_api\_client.v2.model.create\_campaign\_request module
--------------------------------------------------------------

Expand Down Expand Up @@ -6584,6 +6654,20 @@ datadog\_api\_client.v2.model.create\_degradation\_request\_data\_attributes\_st
:members:
:show-inheritance:

datadog\_api\_client.v2.model.create\_degradation\_request\_data\_attributes\_updates\_items module
---------------------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.create_degradation_request_data_attributes_updates_items
:members:
:show-inheritance:

datadog\_api\_client.v2.model.create\_degradation\_request\_data\_attributes\_updates\_items\_components\_affected\_items module
--------------------------------------------------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.create_degradation_request_data_attributes_updates_items_components_affected_items
:members:
:show-inheritance:

datadog\_api\_client.v2.model.create\_deployment\_gate\_params module
---------------------------------------------------------------------

Expand Down Expand Up @@ -6759,6 +6843,27 @@ datadog\_api\_client.v2.model.create\_maintenance\_request\_data\_attributes\_co
:members:
:show-inheritance:

datadog\_api\_client.v2.model.create\_maintenance\_request\_data\_attributes\_updates\_items module
---------------------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.create_maintenance_request_data_attributes_updates_items
:members:
:show-inheritance:

datadog\_api\_client.v2.model.create\_maintenance\_request\_data\_attributes\_updates\_items\_components\_affected\_items module
--------------------------------------------------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.create_maintenance_request_data_attributes_updates_items_components_affected_items
:members:
:show-inheritance:

datadog\_api\_client.v2.model.create\_maintenance\_request\_data\_attributes\_updates\_items\_status module
-----------------------------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.create_maintenance_request_data_attributes_updates_items_status
:members:
:show-inheritance:

datadog\_api\_client.v2.model.create\_notification\_channel\_attributes module
------------------------------------------------------------------------------

Expand Down Expand Up @@ -23027,13 +23132,6 @@ datadog\_api\_client.v2.model.org\_group\_memberships\_relationship module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.org\_group\_pagination\_links module
------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.org_group_pagination_links
:members:
:show-inheritance:

datadog\_api\_client.v2.model.org\_group\_pagination\_meta module
-----------------------------------------------------------------

Expand Down Expand Up @@ -23706,6 +23804,13 @@ datadog\_api\_client.v2.model.patch\_degradation\_request\_data\_type module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.patch\_degradation\_template\_request\_data\_attributes\_components\_affected\_items\_status module
---------------------------------------------------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.patch_degradation_template_request_data_attributes_components_affected_items_status
:members:
:show-inheritance:

datadog\_api\_client.v2.model.patch\_incident\_notification\_template\_request module
-------------------------------------------------------------------------------------

Expand Down
86 changes: 86 additions & 0 deletions examples/v2/status-pages/CreateBackfilledDegradation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
"""
Create backfilled degradation returns "Created" response
"""

from datetime import datetime
from dateutil.relativedelta import relativedelta
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.status_pages_api import StatusPagesApi
from datadog_api_client.v2.model.create_backfilled_degradation_request import CreateBackfilledDegradationRequest
from datadog_api_client.v2.model.create_backfilled_degradation_request_data import (
CreateBackfilledDegradationRequestData,
)
from datadog_api_client.v2.model.create_backfilled_degradation_request_data_attributes import (
CreateBackfilledDegradationRequestDataAttributes,
)
from datadog_api_client.v2.model.create_backfilled_degradation_request_data_attributes_updates_items import (
CreateBackfilledDegradationRequestDataAttributesUpdatesItems,
)
from datadog_api_client.v2.model.create_backfilled_degradation_request_data_attributes_updates_items_components_affected_items import (
CreateBackfilledDegradationRequestDataAttributesUpdatesItemsComponentsAffectedItems,
)
from datadog_api_client.v2.model.create_degradation_request_data_attributes_status import (
CreateDegradationRequestDataAttributesStatus,
)
from datadog_api_client.v2.model.patch_degradation_request_data_type import PatchDegradationRequestDataType
from datadog_api_client.v2.model.patch_degradation_template_request_data_attributes_components_affected_items_status import (
PatchDegradationTemplateRequestDataAttributesComponentsAffectedItemsStatus,
)

# there is a valid "status_page" in the system
STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID = environ[
"STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID"
]
STATUS_PAGE_DATA_ID = environ["STATUS_PAGE_DATA_ID"]

body = CreateBackfilledDegradationRequest(
data=CreateBackfilledDegradationRequestData(
attributes=CreateBackfilledDegradationRequestDataAttributes(
title="Past API Outage",
updates=[
CreateBackfilledDegradationRequestDataAttributesUpdatesItems(
components_affected=[
CreateBackfilledDegradationRequestDataAttributesUpdatesItemsComponentsAffectedItems(
id=STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID,
status=PatchDegradationTemplateRequestDataAttributesComponentsAffectedItemsStatus.DEGRADED,
),
],
description="We detected elevated error rates in the API.",
started_at=(datetime.now() + relativedelta(hours=-1)),
status=CreateDegradationRequestDataAttributesStatus.INVESTIGATING,
),
CreateBackfilledDegradationRequestDataAttributesUpdatesItems(
components_affected=[
CreateBackfilledDegradationRequestDataAttributesUpdatesItemsComponentsAffectedItems(
id=STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID,
status=PatchDegradationTemplateRequestDataAttributesComponentsAffectedItemsStatus.DEGRADED,
),
],
description="Root cause identified as a misconfigured deployment.",
started_at=(datetime.now() + relativedelta(minutes=-30)),
status=CreateDegradationRequestDataAttributesStatus.IDENTIFIED,
),
CreateBackfilledDegradationRequestDataAttributesUpdatesItems(
components_affected=[
CreateBackfilledDegradationRequestDataAttributesUpdatesItemsComponentsAffectedItems(
id=STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID,
status=PatchDegradationTemplateRequestDataAttributesComponentsAffectedItemsStatus.OPERATIONAL,
),
],
description="The issue has been resolved and API is operating normally.",
started_at=datetime.now(),
status=CreateDegradationRequestDataAttributesStatus.RESOLVED,
),
],
),
type=PatchDegradationRequestDataType.DEGRADATIONS,
),
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = StatusPagesApi(api_client)
response = api_instance.create_backfilled_degradation(page_id=STATUS_PAGE_DATA_ID, body=body)

print(response)
75 changes: 75 additions & 0 deletions examples/v2/status-pages/CreateBackfilledMaintenance.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
"""
Create backfilled maintenance returns "Created" response
"""

from datetime import datetime
from dateutil.relativedelta import relativedelta
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.status_pages_api import StatusPagesApi
from datadog_api_client.v2.model.create_backfilled_maintenance_request import CreateBackfilledMaintenanceRequest
from datadog_api_client.v2.model.create_backfilled_maintenance_request_data import (
CreateBackfilledMaintenanceRequestData,
)
from datadog_api_client.v2.model.create_backfilled_maintenance_request_data_attributes import (
CreateBackfilledMaintenanceRequestDataAttributes,
)
from datadog_api_client.v2.model.create_backfilled_maintenance_request_data_attributes_updates_items import (
CreateBackfilledMaintenanceRequestDataAttributesUpdatesItems,
)
from datadog_api_client.v2.model.create_backfilled_maintenance_request_data_attributes_updates_items_components_affected_items import (
CreateBackfilledMaintenanceRequestDataAttributesUpdatesItemsComponentsAffectedItems,
)
from datadog_api_client.v2.model.create_maintenance_request_data_attributes_updates_items_status import (
CreateMaintenanceRequestDataAttributesUpdatesItemsStatus,
)
from datadog_api_client.v2.model.patch_maintenance_request_data_attributes_components_affected_items_status import (
PatchMaintenanceRequestDataAttributesComponentsAffectedItemsStatus,
)
from datadog_api_client.v2.model.patch_maintenance_request_data_type import PatchMaintenanceRequestDataType

# there is a valid "status_page" in the system
STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID = environ[
"STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID"
]
STATUS_PAGE_DATA_ID = environ["STATUS_PAGE_DATA_ID"]

body = CreateBackfilledMaintenanceRequest(
data=CreateBackfilledMaintenanceRequestData(
attributes=CreateBackfilledMaintenanceRequestDataAttributes(
title="Past Database Maintenance",
updates=[
CreateBackfilledMaintenanceRequestDataAttributesUpdatesItems(
components_affected=[
CreateBackfilledMaintenanceRequestDataAttributesUpdatesItemsComponentsAffectedItems(
id=STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID,
status=PatchMaintenanceRequestDataAttributesComponentsAffectedItemsStatus.MAINTENANCE,
),
],
description="Database maintenance is in progress.",
started_at=(datetime.now() + relativedelta(hours=-1)),
status=CreateMaintenanceRequestDataAttributesUpdatesItemsStatus.IN_PROGRESS,
),
CreateBackfilledMaintenanceRequestDataAttributesUpdatesItems(
components_affected=[
CreateBackfilledMaintenanceRequestDataAttributesUpdatesItemsComponentsAffectedItems(
id=STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID,
status=PatchMaintenanceRequestDataAttributesComponentsAffectedItemsStatus.OPERATIONAL,
),
],
description="Database maintenance has been completed successfully.",
started_at=datetime.now(),
status=CreateMaintenanceRequestDataAttributesUpdatesItemsStatus.COMPLETED,
),
],
),
type=PatchMaintenanceRequestDataType.MAINTENANCES,
),
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = StatusPagesApi(api_client)
response = api_instance.create_backfilled_maintenance(page_id=STATUS_PAGE_DATA_ID, body=body)

print(response)
2 changes: 2 additions & 0 deletions src/datadog_api_client/configuration.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -517,6 +517,8 @@ def __init__(
"v2.list_custom_rule_revisions": False,
"v2.revert_custom_rule_revision": False,
"v2.update_custom_ruleset": False,
"v2.create_backfilled_degradation": False,
"v2.create_backfilled_maintenance": False,
"v2.add_member_team": False,
"v2.list_member_teams": False,
"v2.remove_member_team": False,
Expand Down
Loading
Loading