Skip to main content

Exec

Standard Edition Required

Executes a bash (linux) or powershell (windows) script. The check is considered passing if the script exits with 0

apiVersion: canaries.flanksource.com/v1
kind: Canary
metadata:
name: exec-check
spec:
interval: 30
exec:
- description: "exec dummy check"
script: |
echo "hello"
name: exec-pass-check
test:
expr: 'results.Stdout == "hello"'
FieldDescriptionSchemeRequired
scriptScript can be a inline script or a path to a script that needs to be executed. On windows executed via Powershell and in darwin and linux executed using bash.stringYes
nameName of the check, must be unique within the canarystringYes
descriptionDescription for the checkstring
iconIcon for overwriting default icon on the dashboardstring
labelsLabels for checkmap[string]string
testEvaluate whether a check is healthyExpression
displayExpression to change the formatting of the displayExpression
transformTransform data from a check into multiple individual checksExpression
metricsMetrics to export from[]Metrics
Docker Image variants