github.com/netdata/go.d.plugin@v0.58.1/modules/ping/metadata.yaml (about)

     1  plugin_name: go.d.plugin
     2  modules:
     3    - meta:
     4        id: collector-go.d.plugin-ping
     5        plugin_name: go.d.plugin
     6        module_name: ping
     7        monitored_instance:
     8          name: Ping
     9          link: ""
    10          icon_filename: globe.svg
    11          categories:
    12            - data-collection.synthetic-checks
    13        keywords:
    14          - ping
    15        related_resources:
    16          integrations:
    17            list: []
    18        info_provided_to_referring_integrations:
    19          description: ""
    20        most_popular: false
    21      overview:
    22        data_collection:
    23          metrics_description: |
    24            This module measures round-tripe time and packet loss by sending ping messages to network hosts.
    25            
    26            There are two operational modes:
    27            
    28            - privileged (send raw ICMP ping, default). Requires
    29              CAP_NET_RAW [capability](https://man7.org/linux/man-pages/man7/capabilities.7.html) or root privileges:
    30              > **Note**: set automatically during Netdata installation.
    31            
    32              ```bash
    33              sudo setcap CAP_NET_RAW=eip <INSTALL_PREFIX>/usr/libexec/netdata/plugins.d/go.d.plugin
    34              ```
    35            
    36            - unprivileged (send UDP ping, Linux only).
    37              Requires configuring [ping_group_range](https://www.man7.org/linux/man-pages/man7/icmp.7.html):
    38            
    39              ```bash
    40              sudo sysctl -w net.ipv4.ping_group_range="0 2147483647"
    41              ```
    42              To persist the change add `net.ipv4.ping_group_range="0 2147483647"` to `/etc/sysctl.conf` and
    43              execute `sudo sysctl -p`.
    44          method_description: ""
    45        supported_platforms:
    46          include: []
    47          exclude: []
    48        multi_instance: true
    49        additional_permissions:
    50          description: ""
    51        default_behavior:
    52          auto_detection:
    53            description: ""
    54          limits:
    55            description: ""
    56          performance_impact:
    57            description: ""
    58      setup:
    59        prerequisites:
    60          list: []
    61        configuration:
    62          file:
    63            name: go.d/ping.conf
    64          options:
    65            description: |
    66              The following options can be defined globally: update_every, autodetection_retry.
    67            folding:
    68              title: Config options
    69              enabled: true
    70            list:
    71              - name: update_every
    72                description: Data collection frequency.
    73                default_value: 5
    74                required: false
    75              - name: autodetection_retry
    76                description: Recheck interval in seconds. Zero means no recheck will be scheduled.
    77                default_value: 0
    78                required: false
    79              - name: hosts
    80                description: Network hosts.
    81                default_value: ""
    82                required: true
    83              - name: network
    84                description: "Allows configuration of DNS resolution. Supported options: ip (select IPv4 or IPv6), ip4 (select IPv4), ip6 (select IPv6)."
    85                default_value: "ip"
    86                required: false
    87              - name: privileged
    88                description: Ping packets type. "no" means send an "unprivileged" UDP ping,  "yes" - raw ICMP ping.
    89                default_value: true
    90                required: false
    91              - name: packets
    92                description: Number of ping packets to send.
    93                default_value: 5
    94                required: false
    95              - name: interval
    96                description: Timeout between sending ping packets.
    97                default_value: 100ms
    98                required: false
    99          examples:
   100            folding:
   101              title: Config
   102              enabled: true
   103            list:
   104              - name: IPv4 hosts
   105                description: An example configuration.
   106                config: |
   107                  jobs:
   108                    - name: example
   109                      hosts:
   110                        - 192.0.2.0
   111                        - 192.0.2.1
   112              - name: Unprivileged mode
   113                description: An example configuration.
   114                config: |
   115                  jobs:
   116                    - name: example
   117                      privileged: no
   118                      hosts:
   119                        - 192.0.2.0
   120                        - 192.0.2.1
   121              - name: Multi-instance
   122                description: |
   123                  > **Note**: When you define multiple jobs, their names must be unique.
   124                  
   125                  Multiple instances.
   126                config: |
   127                  jobs:
   128                    - name: example1
   129                      hosts:
   130                        - 192.0.2.0
   131                        - 192.0.2.1
   132                  
   133                    - name: example2
   134                      packets: 10
   135                      hosts:
   136                        - 192.0.2.3
   137                        - 192.0.2.4
   138      troubleshooting:
   139        problems:
   140          list: []
   141      alerts:
   142        - name: ping_host_reachable
   143          metric: ping.host_packet_loss
   144          info: "network host ${lab1el:host} reachability status"
   145          link: https://github.com/netdata/netdata/blob/master/src/health/health.d/ping.conf
   146        - name: ping_packet_loss
   147          metric: ping.host_packet_loss
   148          info: "packet loss percentage to the network host ${label:host} over the last 10 minutes"
   149          link: https://github.com/netdata/netdata/blob/master/src/health/health.d/ping.conf
   150        - name: ping_host_latency
   151          metric: ping.host_rtt
   152          info: "average latency to the network host ${label:host} over the last 10 seconds"
   153          link: https://github.com/netdata/netdata/blob/master/src/health/health.d/ping.conf
   154      metrics:
   155        folding:
   156          title: Metrics
   157          enabled: false
   158        description: ""
   159        availability: []
   160        scopes:
   161          - name: host
   162            description: These metrics refer to the remote host.
   163            labels:
   164              - name: host
   165                description: remote host
   166            metrics:
   167              - name: ping.host_rtt
   168                description: Ping round-trip time
   169                unit: milliseconds
   170                chart_type: line
   171                dimensions:
   172                  - name: min
   173                  - name: max
   174                  - name: avg
   175              - name: ping.host_std_dev_rtt
   176                description: Ping round-trip time standard deviation
   177                unit: milliseconds
   178                chart_type: line
   179                dimensions:
   180                  - name: std_dev
   181              - name: ping.host_packet_loss
   182                description: Ping packet loss
   183                unit: percentage
   184                chart_type: line
   185                dimensions:
   186                  - name: loss
   187              - name: ping.host_packets
   188                description: Ping packets transferred
   189                unit: packets
   190                chart_type: line
   191                dimensions:
   192                  - name: received
   193                  - name: sent