Enviar un evento de fallo
POST
https://api.datadoghq.com/api/v2/dora/failurehttps://api.us3.datadoghq.com/api/v2/dora/failurehttps://api.us5.datadoghq.com/api/v2/dora/failurehttps://api.datadoghq.eu/api/v2/dora/failurehttps://api.ap1.datadoghq.com/api/v2/dora/failurehttps://api.ap2.datadoghq.com/api/v2/dora/failurehttps://api.uk1.datadoghq.com/api/v2/dora/failurehttps://api.ddog-gov.com/api/v2/dora/failurehttps://api.us2.ddog-gov.com/api/v2/dora/failureDescripción general
Utiliza este endpoint de la API para proporcionar datos sobre fallos.
Esto es necesario para:
- Cambiar la tasa de fallos
- Tiempo de restauración
Solicitud
Body Data (required)
Campo
Type
Descripción
data [required]object
Solicitud para crear un evento de fallo de DORA.
attributes [required]object
Attributes to create a DORA incident event.
custom_tags[string]
A list of user-defined tags. The tags must follow the key:value pattern. Up to 100 may be added per event.
envstring
Environment name that was impacted by the incident.
finished_atint64
Unix timestamp when the incident finished. It must be in nanoseconds, milliseconds, or seconds.
gitobject
Git info for DORA Metrics events.
commit_sha [required]string
Git Commit SHA.
repository_url [required]string
Git Repository URL
idstring
Incident ID. Must be 16-128 characters and contain only alphanumeric characters, hyphens, underscores, periods, and colons (a-z, A-Z, 0-9, -, _, ., :).
namestring
Incident name.
services[string]
Service names impacted by the incident. If possible, use names registered in the Service Catalog. Required when the team field is not provided.
severitystring
Incident severity.
started_at [required]int64
Unix timestamp when the incident started. It must be in nanoseconds, milliseconds, or seconds.
teamstring
Name of the team owning the services impacted. If possible, use team handles registered in Datadog. Required when the services field is not provided.
{
"data": {
"attributes": {
"custom_tags": [
"language:java",
"department:engineering"
],
"env": "staging",
"finished_at": 1693491984000000000,
"git": {
"commit_sha": "66adc9350f2cc9b250b69abddab733dd55e1a588",
"repository_url": "https://github.com/organization/example-repository"
},
"id": "string",
"name": "Webserver is down failing all requests.",
"services": [
"shopist"
],
"severity": "High",
"started_at": 1693491974000000000,
"team": "backend",
"version": "v1.12.07"
}
}
}Respuesta
OK
Response after receiving a DORA incident event.
Campo
Type
Descripción
data [required]object
Response after receiving a DORA incident event.
id [required]string
The ID of the received DORA incident event.
typeenum
JSON:API type for DORA incident events.
dora_failureAllowed enum values:
dora_failure{
"data": {
"id": "4242fcdd31586083",
"type": "dora_failure"
}
}OK - but delayed due to incident
Response after receiving a DORA incident event.
Campo
Type
Descripción
data [required]object
Response after receiving a DORA incident event.
id [required]string
The ID of the received DORA incident event.
typeenum
JSON:API type for DORA incident events.
dora_failureAllowed enum values:
dora_failure{
"data": {
"id": "4242fcdd31586083",
"type": "dora_failure"
}
}Bad Request
API error response.
Campo
Type
Descripción
errors [required][object]
A list of errors.
detailstring
A human-readable explanation specific to this occurrence of the error.
metaobject
Non-standard meta-information about the error
sourceobject
References to the source of the error.
headerstring
A string indicating the name of a single request header which caused the error.
parameterstring
A string indicating which URI query parameter caused the error.
pointerstring
A JSON pointer to the value in the request document that caused the error.
statusstring
Status code of the response.
titlestring
Short human-readable summary of the error.
{
"errors": [
{
"detail": "Missing required attribute in body",
"meta": {},
"source": {
"header": "Authorization",
"parameter": "limit",
"pointer": "/data/attributes/title"
},
"status": "400",
"title": "Bad Request"
}
]
}Not Authorized
API error response.
Campo
Type
Descripción
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Too many requests
API error response.
Campo
Type
Descripción
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Ejemplo de código
Enviar un evento de fallo
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
export DD_API_KEY="<DD_API_KEY>"
curl -X POST "https://api.${DD_SITE}/api/v2/dora/failure" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-d @- << EOF
{
"data": {
"attributes": {
"custom_tags": [
"language:java",
"department:engineering"
],
"env": "staging",
"finished_at": 1693491984000000000,
"git": {
"commit_sha": "66adc9350f2cc9b250b69abddab733dd55e1a588",
"repository_url": "https://github.com/organization/example-repository"
},
"name": "Webserver is down failing all requests.",
"services": [
"test-service"
],
"severity": "High",
"started_at": 1693491974000000000,
"team": "backend",
"version": "v1.12.07"
}
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
export DD_API_KEY="<DD_API_KEY>"
curl -X POST "https://api.${DD_SITE}/api/v2/dora/failure" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-d @- << EOF
{
"data": {
"attributes": {
"custom_tags": [
"language:java",
"department:engineering"
],
"env": "staging",
"finished_at": 1693491984000000000,
"git": {
"commit_sha": "66adc9350f2cc9b250b69abddab733dd55e1a588",
"repository_url": "https://github.com/organization/example-repository"
},
"name": "Webserver is down failing all requests.",
"services": [
"test-service"
],
"severity": "High",
"started_at": 1693491974000000000,
"team": "backend",
"version": "v1.12.07"
}
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
export DD_API_KEY="<DD_API_KEY>"
curl -X POST "https://api.${DD_SITE}/api/v2/dora/failure" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-d @- << EOF
{
"data": {
"attributes": {
"custom_tags": [
"language:java",
"department:engineering"
],
"env": "staging",
"finished_at": 1693491984000000000,
"git": {
"commit_sha": "66adc9350f2cc9b250b69abddab733dd55e1a588",
"repository_url": "https://github.com/organization/example-repository"
},
"name": "Webserver is down failing all requests.",
"services": [
"test-service"
],
"severity": "High",
"started_at": 1693491974000000000,
"team": "backend",
"version": "v1.12.07"
}
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
export DD_API_KEY="<DD_API_KEY>"
curl -X POST "https://api.${DD_SITE}/api/v2/dora/failure" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-d @- << EOF
{
"data": {
"attributes": {
"custom_tags": [
"language:java",
"department:engineering"
],
"env": "staging",
"finished_at": 1693491984000000000,
"git": {
"commit_sha": "66adc9350f2cc9b250b69abddab733dd55e1a588",
"repository_url": "https://github.com/organization/example-repository"
},
"name": "Webserver is down failing all requests.",
"services": [
"test-service"
],
"severity": "High",
"started_at": 1693491974000000000,
"team": "backend",
"version": "v1.12.07"
}
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
export DD_API_KEY="<DD_API_KEY>"
curl -X POST "https://api.${DD_SITE}/api/v2/dora/failure" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-d @- << EOF
{
"data": {
"attributes": {
"custom_tags": [
"language:java",
"department:engineering"
],
"env": "staging",
"finished_at": 1693491984000000000,
"git": {
"commit_sha": "66adc9350f2cc9b250b69abddab733dd55e1a588",
"repository_url": "https://github.com/organization/example-repository"
},
"name": "Webserver is down failing all requests.",
"services": [
"test-service"
],
"severity": "High",
"started_at": 1693491974000000000,
"team": "backend",
"version": "v1.12.07"
}
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
export DD_API_KEY="<DD_API_KEY>"
curl -X POST "https://api.${DD_SITE}/api/v2/dora/failure" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-d @- << EOF
{
"data": {
"attributes": {
"custom_tags": [
"language:java",
"department:engineering"
],
"env": "staging",
"finished_at": 1693491984000000000,
"git": {
"commit_sha": "66adc9350f2cc9b250b69abddab733dd55e1a588",
"repository_url": "https://github.com/organization/example-repository"
},
"name": "Webserver is down failing all requests.",
"services": [
"test-service"
],
"severity": "High",
"started_at": 1693491974000000000,
"team": "backend",
"version": "v1.12.07"
}
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
export DD_API_KEY="<DD_API_KEY>"
curl -X POST "https://api.${DD_SITE}/api/v2/dora/failure" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-d @- << EOF
{
"data": {
"attributes": {
"custom_tags": [
"language:java",
"department:engineering"
],
"env": "staging",
"finished_at": 1693491984000000000,
"git": {
"commit_sha": "66adc9350f2cc9b250b69abddab733dd55e1a588",
"repository_url": "https://github.com/organization/example-repository"
},
"name": "Webserver is down failing all requests.",
"services": [
"test-service"
],
"severity": "High",
"started_at": 1693491974000000000,
"team": "backend",
"version": "v1.12.07"
}
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
export DD_API_KEY="<DD_API_KEY>"
curl -X POST "https://api.${DD_SITE}/api/v2/dora/failure" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-d @- << EOF
{
"data": {
"attributes": {
"custom_tags": [
"language:java",
"department:engineering"
],
"env": "staging",
"finished_at": 1693491984000000000,
"git": {
"commit_sha": "66adc9350f2cc9b250b69abddab733dd55e1a588",
"repository_url": "https://github.com/organization/example-repository"
},
"name": "Webserver is down failing all requests.",
"services": [
"test-service"
],
"severity": "High",
"started_at": 1693491974000000000,
"team": "backend",
"version": "v1.12.07"
}
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
export DD_API_KEY="<DD_API_KEY>"
curl -X POST "https://api.${DD_SITE}/api/v2/dora/failure" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-d @- << EOF
{
"data": {
"attributes": {
"custom_tags": [
"language:java",
"department:engineering"
],
"env": "staging",
"finished_at": 1693491984000000000,
"git": {
"commit_sha": "66adc9350f2cc9b250b69abddab733dd55e1a588",
"repository_url": "https://github.com/organization/example-repository"
},
"name": "Webserver is down failing all requests.",
"services": [
"test-service"
],
"severity": "High",
"started_at": 1693491974000000000,
"team": "backend",
"version": "v1.12.07"
}
}
}
EOF