Skip to main content

ICMP

Performs ICMP (ping) requests for information on ICMP packet loss, duration and response.

info

Canary checker supports both privileged and unprivileged ping modes using the PING_MODE environment variable or pingMode helm value.

When using unprivileged you need to run:

sudo sysctl -w net.ipv4.ping_group_range="0 2147483647"
imcp-check.yaml
apiVersion: canaries.flanksource.com/v1
kind: Canary
metadata:
name: icmp-check
spec:
interval: 30
icmp:
- name: github
endpoint: api.github.com
thresholdMillis: 600
packetLossThreshold: 10
packetCount: 2

FieldDescriptionSchemeRequired
endpointHost to pingstringYes
packetCountTotal number of packets to send per check, defaults to 5int
packetLossThresholdPercent of total packets that are allowed to be lostint64
thresholdMillisExpected response time threshold in msint64
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

Metrics

Metric
canary_check_icmp_packetloss{'{'}endpoint = "", ip = ""{'}'}GaugePacket loss percentage in ICMP check