dora_failures

Creates, updates, deletes, gets or lists a dora_failures resource.

Overview

Name	dora_failures
Type	Resource
Id	datadog.software_delivery.dora_failures

Fields

The following fields are returned by SELECT queries:

get_dorafailure

Name	Datatype	Description
id	string	The ID of the incident event.
attributes	object	The attributes of the incident event.
type	string	JSON:API type for DORA incident events. (dora_failure) (default: dora_failure, example: dora_failure)

list_dorafailures

Name	Datatype	Description
data	array	The list of DORA incident events.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_dorafailure	select	failure_id		Use this API endpoint to get an incident event.
list_dorafailures	select			Use this API endpoint to get a list of incident events.
create_dorafailure	insert	data		Use this API endpoint to provide incident data for DORA Metrics.<br />Note that change failure rate and failed deployment recovery time are computed from change failures detected on deployments, not from incident events sent through this endpoint.<br />Tracking incidents gives a side-by-side view of how failed deployments translate into real-world incidents, including their severity and frequency.
delete_dorafailure	delete	failure_id		Use this API endpoint to delete an incident event.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
failure_id	string	The ID of the incident event to delete.
site	string	The Datadog site (region) for your organization, for example datadoghq.com, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, datadoghq.eu, ddog-gov.com. Resolved from the DD_SITE environment variable when set. Optional: defaults to datadoghq.com, or the value of the DD_SITE environment variable when set; a WHERE value overrides both.

SELECT examples

get_dorafailure

Use this API endpoint to get an incident event.

SELECT
id,
attributes,
type
FROM datadog.software_delivery.dora_failures
WHERE failure_id = '{{ failure_id }}' -- required
;

list_dorafailures

Use this API endpoint to get a list of incident events.

SELECT
data
FROM datadog.software_delivery.dora_failures
;

INSERT examples

create_dorafailure

Use this API endpoint to provide incident data for DORA Metrics.<br />Note that change failure rate and failed deployment recovery time are computed from change failures detected on deployments, not from incident events sent through this endpoint.<br />Tracking incidents gives a side-by-side view of how failed deployments translate into real-world incidents, including their severity and frequency.

INSERT INTO datadog.software_delivery.dora_failures (
data
)
SELECT 
'{{ data }}' /* required */
RETURNING
data
;

Manifest

# Description fields are for documentation purposes
- name: dora_failures
props:
  - name: data
    description: |
      The JSON:API data.
    value:
      attributes:
        custom_tags:
          - "{{ custom_tags }}"
        env: "{{ env }}"
        finished_at: {{ finished_at }}
        git:
          commit_sha: "{{ commit_sha }}"
          repository_url: "{{ repository_url }}"
        id: "{{ id }}"
        name: "{{ name }}"
        services:
          - "{{ services }}"
        severity: "{{ severity }}"
        started_at: {{ started_at }}
        team: "{{ team }}"
        version: "{{ version }}"

DELETE examples

delete_dorafailure

Use this API endpoint to delete an incident event.

DELETE FROM datadog.software_delivery.dora_failures
WHERE failure_id = '{{ failure_id }}' --required
;