ICMP options
Elastic Cloud Serverless projects are autoscaled environments, fully managed by Elastic and available on Elastic Cloud. Availability This functionality is generally available and ready for production usage. Serverless interfaces and procedures might differ from classic Elastic Stack deployments. The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability This functionality is generally available and ready for production usage. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.
Serverless
Generally available
Stack
Generally available
Also see Common monitor options.
The options described here configure Heartbeat to use ICMP (v4 and v6) Echo Requests to check the configured hosts. Please note that on most platforms you must execute Heartbeat with elevated permissions to perform ICMP pings.
On Linux, regular users may perform pings if the right file capabilities are set. Run sudo setcap cap_net_raw+eip /path/to/heartbeat to grant Heartbeat ping capabilities on Linux.
The binary has the correct capabilities already set on the container image, however your container runtime must allow the use of these privileges for them to be used. On docker this can be achieved with --cap-add=NET_RAW.
Other platforms may require Heartbeat to run as root or administrator to execute pings.
Example configuration:
- type: icmp
id: ping-myhost
name: My Host Ping
hosts: ["myhost"]
schedule: '*/5 * * * * * *'
A list of hosts to ping.
The duration to wait before emitting another ICMP Echo Request if no response is received. The default is 1 second (1s).