Project: Netdata (Observability and Analysis / Observability)
File: ping.md

<!--startmeta customediturl: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/ping/README.md" meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/ping/metadata.yaml" sidebar_label: "Ping" learn_status: "Published" learnrelpath: "Collecting Metrics/Synthetic Checks" most_popular: False message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" endmeta--> <img src="https://netdata.cloud/img/globe.svg" width="150"/> Plugin: go.d.plugin Module: ping <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> This module measures round-tripe time and packet loss by sending ping messages to network hosts. There are two operational modes: privileged (send raw ICMP ping, default). Requires CAPNETRAW or root privileges: > Note: set automatically during Netdata installation. ```bash sudo setcap CAPNETRAW=eip <INSTALL_PREFIX>/usr/libexec/netdata/plugins.d/go.d.plugin ``` unprivileged (send UDP ping, Linux only). Requires configuring : ```bash sudo sysctl -w net.ipv4.pinggrouprange="0 2147483647" ``` To persist the change add `net.ipv4.pinggrouprange="0 2147483647"` to `/etc/sysctl.conf` and execute `sudo sysctl -p`. This collector is supported on all platforms. This collector supports collecting metrics from multiple instances of this integration, including remote instances. This integration doesn't support auto-detection. The default configuration for this integration does not impose any limits on data collection. The default configuration for this integration is not expected to impose a significant performance impact on the system. Metrics grouped by scope. The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. These metrics refer to the remote host. Labels: | Label | Description | |:--|:-| | host | remote host | Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | ping.host_rtt | min, max, avg | milliseconds | | ping.hoststddevrtt | stddev | milliseconds | | ping.hostpacketloss | loss | percentage | | ping.host_packets | received, sent | packets | The following alerts are available: | Alert name | On metric | Description | |:|:-|:| | | ping.hostpacketloss | network host ${lab1el:host} reachability status | | | ping.hostpacketloss | packet loss percentage to the network host ${label:host} over the last 10 minutes | | |

| average latency to the network host ${label:host} over the last 10 seconds | No action required. The configuration file name for this integration is `go.d/ping.conf`. You can edit the configuration file using the `edit-config` script from the Netdata . ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata sudo ./edit-config go.d/ping.conf ``` The following options can be defined globally: updateevery, autodetectionretry. <details><summary>Config options</summary> | Name | Description | Default | Required | |:-|:--|:-|:--:| | update_every | Data collection frequency. | 5 | no | | autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no | | hosts | Network hosts. | | yes | | network | Allows configuration of DNS resolution. Supported options: ip (select IPv4 or IPv6), ip4 (select IPv4), ip6 (select IPv6). | ip | no | | privileged | Ping packets type. "no" means send an "unprivileged" UDP ping, "yes" - raw ICMP ping. | yes | no | | packets | Number of ping packets to send. | 5 | no | | interval | Timeout between sending ping packets. | 100ms | no | </details> An example configuration. <details><summary>Config</summary> ```yaml jobs: name: example hosts: 192.0.2.0 192.0.2.1 ``` </details> An example configuration. <details><summary>Config</summary> ```yaml jobs: name: example privileged: no hosts: 192.0.2.0 192.0.2.1 ``` </details> Note: When you define multiple jobs, their names must be unique. Multiple instances. <details><summary>Config</summary> ```yaml jobs: name: example1 hosts: 192.0.2.0 192.0.2.1 name: example2 packets: 10 hosts: 192.0.2.3 192.0.2.4 ``` </details> To troubleshoot issues with the `ping` collector, run the `go.d.plugin` with the debug option enabled. The output should give you clues as to why the collector isn't working. Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`. ```bash cd /usr/libexec/netdata/plugins.d/ ``` Switch to the `netdata` user. ```bash sudo -u netdata -s ``` Run the `go.d.plugin` to debug the collector: ```bash ./go.d.plugin -d -m ping ```