Skip to content

Add backfilled degradation and maintenance endpoints to Status Pages #3776

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 #3776

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
392 changes: 392 additions & 0 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

107 changes: 107 additions & 0 deletions examples/v2/status-pages/CreateBackfilledDegradation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
// Create backfilled degradation returns "Created" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.StatusPagesApi;
import com.datadog.api.client.v2.model.CreateBackfilledDegradationRequest;
import com.datadog.api.client.v2.model.CreateBackfilledDegradationRequestData;
import com.datadog.api.client.v2.model.CreateBackfilledDegradationRequestDataAttributes;
import com.datadog.api.client.v2.model.CreateBackfilledDegradationRequestDataAttributesUpdatesItems;
import com.datadog.api.client.v2.model.CreateDegradationRequestDataAttributesComponentsAffectedItems;
import com.datadog.api.client.v2.model.CreateDegradationRequestDataAttributesStatus;
import com.datadog.api.client.v2.model.Degradation;
import com.datadog.api.client.v2.model.PatchDegradationRequestDataType;
import com.datadog.api.client.v2.model.StatusPagesComponentDataAttributesStatus;
import java.time.OffsetDateTime;
import java.util.Arrays;
import java.util.Collections;
import java.util.UUID;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
StatusPagesApi apiInstance = new StatusPagesApi(defaultClient);

// there is a valid "status_page" in the system
UUID STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID = null;
try {
STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID =
UUID.fromString(
System.getenv("STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID"));
} catch (IllegalArgumentException e) {
System.err.println("Error parsing UUID: " + e.getMessage());
}
UUID STATUS_PAGE_DATA_ID = null;
try {
STATUS_PAGE_DATA_ID = UUID.fromString(System.getenv("STATUS_PAGE_DATA_ID"));
} catch (IllegalArgumentException e) {
System.err.println("Error parsing UUID: " + e.getMessage());
}

CreateBackfilledDegradationRequest body =
new CreateBackfilledDegradationRequest()
.data(
new CreateBackfilledDegradationRequestData()
.attributes(
new CreateBackfilledDegradationRequestDataAttributes()
.title("Past API Outage")
.updates(
Arrays.asList(
new CreateBackfilledDegradationRequestDataAttributesUpdatesItems()
.componentsAffected(
Collections.singletonList(
new CreateDegradationRequestDataAttributesComponentsAffectedItems()
.id(
STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID)
.status(
StatusPagesComponentDataAttributesStatus
.DEGRADED)))
.description("We detected elevated error rates in the API.")
.startedAt(OffsetDateTime.now().plusHours(-1))
.status(
CreateDegradationRequestDataAttributesStatus
.INVESTIGATING),
new CreateBackfilledDegradationRequestDataAttributesUpdatesItems()
.componentsAffected(
Collections.singletonList(
new CreateDegradationRequestDataAttributesComponentsAffectedItems()
.id(
STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID)
.status(
StatusPagesComponentDataAttributesStatus
.DEGRADED)))
.description(
"Root cause identified as a misconfigured deployment.")
.startedAt(OffsetDateTime.now().plusMinutes(-30))
.status(
CreateDegradationRequestDataAttributesStatus
.IDENTIFIED),
new CreateBackfilledDegradationRequestDataAttributesUpdatesItems()
.componentsAffected(
Collections.singletonList(
new CreateDegradationRequestDataAttributesComponentsAffectedItems()
.id(
STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID)
.status(
StatusPagesComponentDataAttributesStatus
.OPERATIONAL)))
.description(
"The issue has been resolved and API is operating"
+ " normally.")
.startedAt(OffsetDateTime.now())
.status(
CreateDegradationRequestDataAttributesStatus
.RESOLVED))))
.type(PatchDegradationRequestDataType.DEGRADATIONS));

try {
Degradation result = apiInstance.createBackfilledDegradation(STATUS_PAGE_DATA_ID, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling StatusPagesApi#createBackfilledDegradation");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
91 changes: 91 additions & 0 deletions examples/v2/status-pages/CreateBackfilledMaintenance.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
// Create backfilled maintenance returns "Created" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.StatusPagesApi;
import com.datadog.api.client.v2.model.CreateBackfilledMaintenanceRequest;
import com.datadog.api.client.v2.model.CreateBackfilledMaintenanceRequestData;
import com.datadog.api.client.v2.model.CreateBackfilledMaintenanceRequestDataAttributes;
import com.datadog.api.client.v2.model.CreateBackfilledMaintenanceRequestDataAttributesUpdatesItems;
import com.datadog.api.client.v2.model.CreateBackfilledMaintenanceRequestDataAttributesUpdatesItemsStatus;
import com.datadog.api.client.v2.model.CreateMaintenanceRequestDataAttributesComponentsAffectedItems;
import com.datadog.api.client.v2.model.Maintenance;
import com.datadog.api.client.v2.model.PatchMaintenanceRequestDataAttributesComponentsAffectedItemsStatus;
import com.datadog.api.client.v2.model.PatchMaintenanceRequestDataType;
import java.time.OffsetDateTime;
import java.util.Arrays;
import java.util.Collections;
import java.util.UUID;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
StatusPagesApi apiInstance = new StatusPagesApi(defaultClient);

// there is a valid "status_page" in the system
UUID STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID = null;
try {
STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID =
UUID.fromString(
System.getenv("STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID"));
} catch (IllegalArgumentException e) {
System.err.println("Error parsing UUID: " + e.getMessage());
}
UUID STATUS_PAGE_DATA_ID = null;
try {
STATUS_PAGE_DATA_ID = UUID.fromString(System.getenv("STATUS_PAGE_DATA_ID"));
} catch (IllegalArgumentException e) {
System.err.println("Error parsing UUID: " + e.getMessage());
}

CreateBackfilledMaintenanceRequest body =
new CreateBackfilledMaintenanceRequest()
.data(
new CreateBackfilledMaintenanceRequestData()
.attributes(
new CreateBackfilledMaintenanceRequestDataAttributes()
.title("Past Database Maintenance")
.updates(
Arrays.asList(
new CreateBackfilledMaintenanceRequestDataAttributesUpdatesItems()
.componentsAffected(
Collections.singletonList(
new CreateMaintenanceRequestDataAttributesComponentsAffectedItems()
.id(
STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID)
.status(
PatchMaintenanceRequestDataAttributesComponentsAffectedItemsStatus
.MAINTENANCE)))
.description("Database maintenance is in progress.")
.startedAt(OffsetDateTime.now().plusHours(-1))
.status(
CreateBackfilledMaintenanceRequestDataAttributesUpdatesItemsStatus
.IN_PROGRESS),
new CreateBackfilledMaintenanceRequestDataAttributesUpdatesItems()
.componentsAffected(
Collections.singletonList(
new CreateMaintenanceRequestDataAttributesComponentsAffectedItems()
.id(
STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID)
.status(
PatchMaintenanceRequestDataAttributesComponentsAffectedItemsStatus
.OPERATIONAL)))
.description(
"Database maintenance has been completed successfully.")
.startedAt(OffsetDateTime.now())
.status(
CreateBackfilledMaintenanceRequestDataAttributesUpdatesItemsStatus
.COMPLETED))))
.type(PatchMaintenanceRequestDataType.MAINTENANCES));

try {
Maintenance result = apiInstance.createBackfilledMaintenance(STATUS_PAGE_DATA_ID, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling StatusPagesApi#createBackfilledMaintenance");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Loading
Loading