add Ping tool to api 07/19/2022

[aanon4]

This is a simple ping tool to complement the existing iperf3 tool. It allows someone to initiate a ping test from any node to any other node. The test is limited to 10 seconds.

The goal is to enable improved network monitoring by allowing specific links in the network to be tested. Right now, although nodes can be tested, the path will always be from the initiator to the target, which is not necessarily what you want.

The use mirrors the "api" we use for the iperf tool.

[ab7pa]

Works well on my test node.

[dman776]

What do you think about adding a getPing function to aredn.utils and exposing in the api. This is the same approach as the traceroute takes. http://localnode.local.mesh:8080/cgi-bin/api?traceroute=TARGETNODENAME
it could be: http://192.168.0.47:8080/cgi-bin/api?ping=TARGETNODENAME

[dman776]

see comment about adding to api

[aanon4]

I had no idea that was even there!
Could do - was just using iperf as a basis for this, but could use traceroute instead - not fussed either way

[ab7pa]

I'll wait to wrap up the documentation for this feature until we decide whether to accomplish it through cgi-bin/ping or cgi-bin/api -- either way it looks like a good addition. I suppose that cgi-bin/iperf could eventually be converted to the api approach at some point. Thanks, @aanon4 Tim!

[dman776]

May as well move them to api for future. We can always have a "html" readable page in the interim that essentially calls the api and formats for html if you think it's necessary. That is my strong preference.

[dman776]

See previous comment Thanks, Darryl

…

On Jul 19, 2022, at 8:01 PM, Steve AB7PA ***@***.***> wrote:  One issue with using cgi-bin/api is that the results are displayed in json rather than in plain text in the browser. This PR still seems valuable (as well as cgi-bin/iperf) for displaying the results in simple text. — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because your review was requested.

[aanon4]

@dman776 Tried to match the traceroute api with what seems like sensible json data. Output looks like this:

{
   "pages": {
     "ping": {
       "kn6plv-services": {
         "summary": {
           "tx": "11",
           "minMs": "0.517",
           "rx": "10",
           "lossPercentage": "9",
           "maxMs": "0.698",
           "avgMs": "0.573",
           "ip": "10.72.238.17"
         },
         "pings": [
           {
             "timeMs": "0.669",
             "ttl": "64",
             "seq": "0",
             "ip": "10.72.238.17"
           },
           {
             "timeMs": "0.596",
             "ttl": "64",
             "seq": "1",
             "ip": "10.72.238.17"
           },
           {
             "timeMs": "0.569",
             "ttl": "64",
             "seq": "2",
             "ip": "10.72.238.17"
           },
           {
             "timeMs": "0.540",
             "ttl": "64",
             "seq": "3",
             "ip": "10.72.238.17"
           },
           {
             "timeMs": "0.532",
             "ttl": "64",
             "seq": "4",
             "ip": "10.72.238.17"
           },
           {
             "timeMs": "0.517",
             "ttl": "64",
             "seq": "5",
             "ip": "10.72.238.17"
           },
           {
             "timeMs": "0.517",
             "ttl": "64",
             "seq": "6",
             "ip": "10.72.238.17"
           },
           {
             "timeMs": "0.698",
             "ttl": "64",
             "seq": "7",
             "ip": "10.72.238.17"
           },
           {
             "timeMs": "0.572",
             "ttl": "64",
             "seq": "8",
             "ip": "10.72.238.17"
           },
           {
             "timeMs": "0.529",
             "ttl": "64",
             "seq": "9",
             "ip": "10.72.238.17"
           }
         ]
       }
     }
   },
   "api_version": "1.4"
 }

[dman776]

need to increment the api version to 1.5

[dman776]

also, is the ttl value needed? It's always going to be the same 64, right?

[aanon4]

Bump.
TTL - I decided to include all the information I was given, because maybe it would be useful.

[dman776]

looks good.