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"
icmp.yaml
apiVersion: canaries.flanksource.com/v1
kind: Canary
metadata:
name: icmp
spec:
schedule: "@every 5m"
icmp:
- name: ICMP test
url: https://api.github.com
thresholdMillis: 600
packetLossThreshold: 10
packetCount: 2
FieldDescriptionScheme
endpoint*

Host to ping

string

name*

Name of the check, must be unique within the canary

string

packetCount

Total number of packets to send per check. Defaults to 5

integer

packetLossThreshold

Percent of total packets that are allowed to be lost

int64

thresholdMillis

Threshold response time from DNS server

integer

description

Description for the check

string

display

Expression to change the formatting of the display

Expression

icon

Icon for overwriting default icon on the dashboard

Icon

labels

Labels for check

map[string]string

metrics

Metrics to export from

[]Metrics

test

Evaluate whether a check is healthy

Expression

transform

Transform data from a check into multiple individual checks

Expression

Metrics

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