ping_exporter

README

ping_exporter

Prometheus exporter for ICMP echo requests using https://github.com/digineo/go-ping

This is a simple server that scrapes go-ping stats and exports them via HTTP for Prometheus consumption. The go-ping library is build and maintained by Digineo GmbH. For more information check the source code.

Getting Started

Exported metrics

• ping_rtt_best_ms: Best round trip time in millis
• ping_rtt_worst_ms: Worst round trip time in millis
• ping_rtt_median_ms: Median round trip time in millis
• ping_rtt_mean_ms: Mean round trip time in millis
• ping_rtt_std_deviation_ms: Standard deviation in millis
• ping_packet_sent: Number of sent Packets
• ping_packet_loss: Number of loss Packets

Each metric has labels ip (the target's IP address), ip_version (4 or 6, corresponding to the IP version), and target (the target's name).

Additionally, a ping_up metric reports whether the exporter is running (and in which version).

Config

Exporter config

Targets can be specified in a YAML based config file (/etc/prometheus/ping-exporter.yml):

targets:
  - 8.8.8.8
  - 8.8.4.4
  - 2001:4860:4860::8888
  - 2001:4860:4860::8844
  - google.com
  
ping:
  interval: 1s
  timeout: 2s
  history-size: 10
  payload-size: 120

Defaults for systemd service

Defaults config in /etc/default/prometheus-ping-exporter

ARGS='--web.listen-address="127.0.0.1:9427" --config.path=/etc/prometheus/ping-exporter.yml'

Prometheus config

Add scrape job in to prometheus yaml comfiguration (/etc/prometheus/prometheus.yaml)

scrape_configs:
  - job_name: 'ping'
    scrape_interval: 10s
    scrape_timeout: 3s
    static_configs:
      - targets: ['127.0.0.1:9427']

Shell

To run the exporter:

$ ./ping_exporter [options] target1 target2 ...

or

$ ./ping_exporter --config.path my-config-file [options]

Help on flags:

$ ./ping_exporter --help

Getting the results for testing via cURL:

$ curl http://localhost:9427/metrics

Contribute

Simply fork and create a pull-request. We'll try to respond in a timely fashion.

License

MIT License, Copyright (c) 2018 Philip Berndroth pberndro Daniel Czerwonk dan_nrw