ICMP
Performs ICMP (ping) requests for information on ICMP packet loss, duration, and response.
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"
icmp.yamlapiVersion: canaries.flanksource.com/v1
kind: Canary
metadata:
name: icmp
spec:
interval: 30
icmp:
- endpoint: https://api.github.com
thresholdMillis: 600
packetLossThreshold: 10
packetCount: 2
Field | Description | Scheme |
---|---|---|
endpoint* | Host to ping |
|
name* | Name of the check, must be unique within the canary |
|
packetCount | Total number of packets to send per check. Defaults to |
|
packetLossThreshold | Percent of total packets that are allowed to be lost | int64 |
thresholdMillis | Threshold response time from DNS server |
|
description | Description for the check |
|
display | Expression to change the formatting of the display | |
icon | Icon for overwriting default icon on the dashboard | |
labels | Labels for check | map[string]string |
metrics | Metrics to export from | |
test | Evaluate whether a check is healthy | |
transform | Transform data from a check into multiple individual checks |
Metrics
Metric | ||
---|---|---|
canary_check_icmp_packetloss{endpoint = "", ip = ""} | Gauge | Packet loss percentage in ICMP check |