Datadog Service Check with YAML

YAML parameters for Datadog Service Check

NameTypeDescription
integration_id
Required
IntegerThe ID of the integration.
name
Required
StringThe name of the action.
trigger_time
Required
StringSpecifies when the action should be executed. Can be one of ON_EVERY_EXECUTION, ON_FAILURE or ON_BACK_TO_SUCCESS.
type
Required
StringThe type of the action. Should be set to DATADOG_STATUS_CHECK.
host_nameStringThe Host name to associate with the event. Any tags associated with the host will also be applied to this event.
statusIntegerAn integer for the status of the check.
checkStringThe text for the message.
messageStringA description of why this status occurred.
regionStringThe Datadog region. Can be one of NA or EU. If not set, the default is NA.
trigger_conditionStringDefines when the build action should be run. Can be one of ALWAYS, ON_CHANGE, ON_CHANGE_AT_PATH, VAR_IS, VAR_IS_NOT or VAR_CONTAINS.
trigger_condition_pathsString[]Required when trigger_condition is set to ON_CHANGE_AT_PATH.
trigger_variable_keyStringRequired when trigger_condition is set to VAR_IS, VAR_IS_NOT or VAR_CONTAINS. Defines the name of the desired variable.
trigger_variable_valueStringRequired when trigger_condition is set to VAR_IS, VAR_IS_NOT or VAR_CONTAINS. Defines the value of the desired variable which will be compared with its current value.
disabledBooleanWhen set to true the action is disabled. By default it is set to false.
variablesVariable[]The list of variables defined for this action.

YAML example for Datadog Service Check

actions:
- action: "Datadog Service Check Action"
type: "DATADOG_STATUS_CHECK"
trigger_time: "ON_EVERY_EXECUTION"
host_name: "linux"
status: 2
check: "Pipeline Execution"
message: "And let me tell you all about it here!"
region: "EU"
integration_id: 1
variables:
- key: "ftp_login"
value: "userLogin123"
description: "The name of user to FTP."
- key: "ftp_password"
value: "secure!14ivLMxPgv7TX6c9+ITX/g=="
encrypted: true
description: "The password for ftp."