michaelReal-time monitoring and graphing of ping
I’ve been around, and let me tell you, sometimes it’s not all it’s cracked up to be, especially the networking, the Wi-Fi and wired connections both. Recently my productivity has been sorely challenged by exceedingly poor infrastructure. What’s a coder to do? Well, write some code, of course.
Goal: I’d like to measure some quality of the connection between my computer and another one out there on the ‘net. I’ll show you how to see that connection quality first in text format, and then in graphic form. Each has its uses. You’ll thank me later :-)
NOTE: My efforts were done in bash on macOS, which is a UNIX variant called ‘darwin’. I believe all this code is portable to Linux and Ubuntu for Windows. If you find a bug, please let me know. Code fragments will be used to describe useful patters; the complete source code appears at the bottom.
Aim for a target
A network consists of (at minimum) two computers, yours and one other. On your local networks, and the Internet, there are many computers. You can “reach” many of them. Which to pick as our target?
If you’re doing this for a work project, then you possibly have some local computer in mind, something that’s vital to your business and must be reachable at all times. For the rest of us, we just want something “out there” that will serve as our target.
A very common US-centric target is the Google DNS cluster, identified by the very easy-to-remember IP address of 8.8.8.8. Feel free to substitute something appropriate for your country. The use case of working behind the Great Firewall of China is covered below.
For the moment, though, we’ll use
target='8.8.8.8' # Aim at Google's DNS nameserver
and anywhere in the following, when you read $target, you’ll know that it’s pointing to a comuter, run by Google to do something useful, and which has a known address.
Is there a network?
Before we can do any network performance checking, much less any graphing, we need to have a network. A simple, lightweight, way of checking is:
# -----------------------------------------------------------------------------
# Is there a network?
# -----------------------------------------------------------------------------
if eval nc -z -w 1 "$target" 80 >& /dev/null ; then
echo "the network is up, continuing..."
#
# put your code here
#
else
echo "network is down, giving up..." ; exit 0
fi
The code above reaches out to $target on port 80, throwing the reported data into the trash, /dev/null. We’re interested only in the true-false result, which tells us whether the network is up. Fret not about targets and ports: as an analogy, think of $target as the street address, ond the port as the apartment number. To get to dinner you have to get the building and apartment correct. :-)
ping
We’ll be using UNIX’s ping program, which sends a packet information to the target, and will receive one in return. We type the ping command into a “terminal”, with some mandiatory additional data, like this:
ping -i $interval_in_seconds $target
Here’s how it all looks like: the computer tells you it’s ready for you by showing you a %. (Your terminal may show something different, like yourname $, but you get the idea.) We’re going to tell ping to, well, ping computer 8.8.8.8 repeatedly, at an interval of 1 second between pings.
In response, ping will forever hit that machine, reporting (at the end of each line) how long it took for a message to go between the computers, in milliseconds. Shorter times are better; longer times result in your interactions with that computer feel laggy.
Messages don’t go directly through the tubes from your computer to the target. Instead, they hop through computer after computer, like a demented game of hopscotch. There’s a command to show you about the path the message is taking – traceroute – but we’ll get to that some other day.
% ping -i 1 8.8.8.8
PING 8.8.8.8 (8.8.8.8): 56 data bytes
64 bytes from 8.8.8.8: icmp_seq=0 ttl=50 time=90.733 ms
64 bytes from 8.8.8.8: icmp_seq=1 ttl=50 time=89.013 ms
64 bytes from 8.8.8.8: icmp_seq=2 ttl=50 time=86.486 ms
64 bytes from 8.8.8.8: icmp_seq=3 ttl=50 time=89.420 ms
64 bytes from 8.8.8.8: icmp_seq=4 ttl=50 time=86.697 ms
64 bytes from 8.8.8.8: icmp_seq=5 ttl=50 time=213.006 ms
^C
--- 8.8.8.8 ping statistics ---
6 packets transmitted, 6 packets received, 0.0% packet loss
round-trip min/avg/max/stddev = 86.486/109.226/213.006/46.436 ms
%
The ^C shows where I’ve interrupted the program by typing Control-C on my keyboard.
Many things impact the time it takes for a message to reach the target: physical distance the message has to travel, the quality of the connection between each of the computer through which the message hops, and the type of connection. (You can reach the Internet from a cruise ship, but the latency of the connection makes it an unpleasant experience; the lag, not the cruise.
To be complete, not every ping is as successful as the one shown above, able to report a connection and a time. If your network is down you’ll see something like:
Request timeout for icmp_seq 11
ping: sendto: No route to host
ping: sendto: No route to host
The parts of our live-graphing utility
Look at that, we’re already past the preamble. Not a lot of requisite experience needed. Let’s move on to our program, which is broken into two interacting parts:
- The collector, gathering data on the health of the connection between your computer and
$arget, and - The grapher, which will pictorially display the data.
The collector
The collector code is:
ping -i "$interval" "$target" | \
/usr/local/bin/grep --line-buffered -oP "time=\K(\d*)\.\d*" 2>&1 >> "$outfile" &
echo "Collecting data..." # warn about sleep()
sleep $(( interval * 2 )) # time to get several data points
We’ll specify $outfile later. The above does the ping command, sending it’s output through grep (to which I’ve specified a filter that returns only the time portion), which is added to the end of $outfile, and because I’ve finished up that line with & the ping runs in the background, hidden from sight. Then the foreground program sleeps for twice the $interval in order to gather enough data to begin graphing. The phrase Collecting data... reassures the human that everything is proceeding as planned.
NOTE: I had to specify /usr/local/bin/grep to get the optionally-installed version that I use, rather than the system-installed default version, to have the “–line-buffered` functionality.
The grapher
Now that we are collecting data, we have something to graph. We’ll be using gnuplot, a free, widely-available program, to plot our data. The grapher code looks like:
while true ; do # continue forever until ^C at terminal
gnuplot -persist <<-END # start plotting, leaving the output
set terminal dumb 90 28 # show only simple keyboard characters
# ---------------------------------------------------------------------
# Plot the last 20 lines of $outfile, using grep to get the ping times.
# Plot using only simple keyboard characters, like *, -, +, etc.
# ---------------------------------------------------------------------
plot ' with impulses title 'ping $target (ms)'
pause "$interval" # let the next datapoint to be caught
reread # re-read the input and plot new data
END
done # the end of the infinite loop
With these commands in a file we’ll call pinger.sh, typing:
% bash pinger.sh
Will result in:
 |
which is updated every $interval.
And there you go: live graphing of generated data!
There are so many possible improvements, starting with passing the target on the command line, to dealing with being in China, to using a Caca terminal to get prcetty graphic output instead of keyboard characters on a dumb terminal.
The Great Firewall of China 防火长城
Great Firewall of China (防火长城), officially Project Golden Shield, is a censorship and surveillance project that blocks politically inexpedient data from foreign countries arriving over the Internet.
If you’re a businessperson visiting China, or a resident, you’ll find that the Google infrastructure – from search to Gmail to Google Maps and Photos – are blocked. To bore a tunnel through the Golden Shield, we use a virtual private network, or VPN. (It’s beyond this document to discuss the evaluation, installation, and use of a VPN, but OpenVPN, a program that will work on your laptop and smartphones, is a good place to start.
The following code presumes you’re inside of China: it simplistically tests for the presence of an active VPN, and, assuming you’re surrounded by the Great Firewall, if the VPN is active, it’ll set the target to a Google server, if not, it’ll reach for something available in the Middle Kingdom. If you’re never in a place that has restrictive connection rules, or you never use a VPN, just ignore this code fragment.
vpn=$( netstat -rn | grep -c utun1 ) # check for any tunnels in action
if [[ $vpn -eq 0 ]] ; then
# ----------> no VPN, assume Great Firewall of China, use baidu <---------- target='baidu.com' # the machine we're trying to ping else # ----------> VPN, so use Google services <--------------------------------
target='www.google.com' # the machine we're trying to ping
fi
The whole solution
As you’re perusing the code for pinger.shnote please two coding styles that I heartily recommend:
- Defensive programming – because I long-ago learned that if I didn’t take time to write code to test all the possible things that can go wrong then I’ll spend way longer when something unexpected is encountered and my program falls over.
-
Copious comments – because there’s nothing quite a frustrating as spending time figuring out what you were thinking when you wrote the code that just fell over. Stream-of-consciousness commenting, adding explanations as you’re actually writing the code, saves countless hours later. Trust me on both of these points.
pinger.sh. may be found at github.