dora_deployments
Creates, updates, deletes, gets or lists a dora_deployments
resource.
Overview
Name | dora_deployments |
Type | Resource |
Id | datadog.software_delivery.dora_deployments |
Fields
The following fields are returned by SELECT
queries:
- get_doradeployment
- list_doradeployments
Name | Datatype | Description |
---|---|---|
id | string | The ID of the event. |
attributes | object | The attributes of the event. |
type | string | The type of the event. |
Name | Datatype | Description |
---|---|---|
data | array | The list of DORA events. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get_doradeployment | select | deployment_id , region | Use this API endpoint to get a deployment event. | |
list_doradeployments | select | region | Use this API endpoint to get a list of deployment events. | |
create_doradeployment | insert | region , data__data | Use this API endpoint to provide data about deployments for DORA metrics. This is necessary for: - Deployment Frequency - Change Lead Time - Change Failure Rate |
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 |
---|---|---|
deployment_id | string | The ID of the deployment event. |
region | string | (default: datadoghq.com) |
SELECT
examples
- get_doradeployment
- list_doradeployments
Use this API endpoint to get a deployment event.
SELECT
id,
attributes,
type
FROM datadog.software_delivery.dora_deployments
WHERE deployment_id = '{{ deployment_id }}' -- required
AND region = '{{ region }}' -- required
;
Use this API endpoint to get a list of deployment events.
SELECT
data
FROM datadog.software_delivery.dora_deployments
WHERE region = '{{ region }}' -- required
;
INSERT
examples
- create_doradeployment
- Manifest
Use this API endpoint to provide data about deployments for DORA metrics.
This is necessary for:
- Deployment Frequency
- Change Lead Time
- Change Failure Rate
INSERT INTO datadog.software_delivery.dora_deployments (
data__data,
region
)
SELECT
'{{ data }}' /* required */,
'{{ region }}'
RETURNING
data
;
# Description fields are for documentation purposes
- name: dora_deployments
props:
- name: region
value: string
description: Required parameter for the dora_deployments resource.
- name: data
value: object
description: |
The JSON:API data.