1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
|
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
""" Python code to start a RIPE Atlas UDM (User-Defined
Measurement). This one is for running IPv4 or IPv6 ICMP queries to
test reachability.
You'll need an API key in ~/.atlas/auth.
After launching the measurement, it downloads the results and analyzes
them.
Stéphane Bortzmeyer <stephane+frama@bortzmeyer.org>
"""
import json
import time
import os
import sys
import time
import socket
import copy
import collections
import Blaeu
config = Blaeu.Config()
# Default values
config.tests = 3 # ICMP packets per probe
config.by_probe = False # Default is to count by test, not by probe
config.display_probes = False
class Set():
def __init__(self):
self.failed = True
def is_ip_address(str):
try:
addr = socket.inet_pton(socket.AF_INET6, str)
except socket.error: # not a valid IPv6 address
try:
addr = socket.inet_pton(socket.AF_INET, str)
except socket.error: # not a valid IPv4 address either
return False
return True
def usage(msg=None):
print("Usage: %s target-IP-address ..." % sys.argv[0], file=sys.stderr)
config.usage(msg)
print("""Also:
--tests=N or -d N : send N ICMP packets from each probe (default is %s)
--by_probe : count the percentage of success by probe, not by test (useless if --tests=1)
""" % (config.tests), file=sys.stderr)
def specificParse(config, option, value):
result = True
if option == "--tests" or option == "-d":
config.tests = int(value)
elif option == "--by_probe":
config.by_probe = True
else:
result = False
return result
args, data = config.parse("d:", ["by_probe", "tests="], specificParse,
usage)
targets = args
if len(targets) == 0:
usage("No target found")
sys.exit(1)
if config.verbose and config.machine_readable:
usage("Specify verbose *or* machine-readable output")
sys.exit(1)
if (config.display_probes or config.display_probe_asns) and config.machine_readable:
usage("Display probes *or* machine-readable output")
sys.exit(1)
data["definitions"][0]["type"] = "ping"
del data["definitions"][0]["port"]
data["definitions"][0]["packets"] = config.tests
for target in targets:
if not is_ip_address(target):
print(("Target must be an IP address, NOT AN HOST NAME"), file=sys.stderr)
sys.exit(1)
data["definitions"][0]["target"] = target
data["definitions"][0]["description"] = ("Ping %s" % target) + data["definitions"][0]["description"]
if target.find(':') > -1:
config.ipv4 = False
data["definitions"][0]['af'] = 6
else:
config.ipv4 = True
data["definitions"][0]['af'] = 4
# Yes, it was already done in parse() but we have to do it again now that we
# know the address family of the target. See bug #9. Note that we silently
# override a possible explicit choice of the user (her -4 may be ignored).
if config.include is not None:
data["probes"][0]["tags"]["include"] = copy.copy(config.include)
else:
data["probes"][0]["tags"]["include"] = []
if config.ipv4:
data["probes"][0]["tags"]["include"].append("system-ipv4-works") # Some probes cannot do ICMP outgoing (firewall?)
else:
data["probes"][0]["tags"]["include"].append("system-ipv6-works")
if config.exclude is not None:
data["probes"][0]["tags"]["exclude"] = copy.copy(config.exclude)
if config.measurement_id is None:
if config.verbose:
print(data)
try:
measurement = Blaeu.Measurement(data)
except Blaeu.RequestSubmissionError as error:
print(Blaeu.format_error(error), file=sys.stderr)
sys.exit(1)
if config.old_measurement is None:
config.old_measurement = measurement.id
if config.verbose:
print("Measurement #%s to %s uses %i probes" % (measurement.id, target,
measurement.num_probes))
# Retrieve the results
rdata = measurement.results(wait=True, percentage_required=config.percentage_required)
else:
measurement = Blaeu.Measurement(data=None, id=config.measurement_id)
rdata = measurement.results(wait=False)
if config.verbose:
print("%i results from already-done measurement #%s" % (len(rdata), measurement.id))
if len(rdata) == 0:
print("Warning: zero results. Measurement not terminated? May be retry later with --measurement-ID=%s ?" % measurement.id, file=sys.stderr)
total_rtt = 0
num_rtt = 0
num_error = 0
num_timeout = 0
num_tests = 0
if config.by_probe:
probes_success = 0
probes_failure = 0
num_probes = 0
if not config.machine_readable and config.measurement_id is None:
print(("%s probes reported" % len(rdata)))
if config.display_probe_asns:
config.display_probes = True
if config.display_probes:
failed_probes = collections.defaultdict(Set)
for result in rdata:
probe_ok = False
probe = result["prb_id"]
if config.by_probe:
num_probes += 1
for test in result["result"]:
num_tests += 1
if "rtt" in test:
total_rtt += int(test["rtt"])
num_rtt += 1
probe_ok = True
elif "error" in test:
num_error += 1
elif "x" in test:
num_timeout += 1
else:
print(("Result has no field rtt, or x or error"), file=sys.stderr)
sys.exit(1)
if config.by_probe:
if probe_ok:
probes_success += 1
else:
probes_failure += 1
if not probe_ok:
if config.display_probes:
failed_probes[probe].failed = True
if config.display_probe_asns:
details = Blaeu.ProbeCache.cache_probe_id(config.cache_probes, probe) \
if config.cache_probes else Blaeu.Probe(probe)
failed_probes[probe].asn = getattr(details, "asn_v%i" % (4 if config.ipv4 else 6), None)
if not config.machine_readable:
print(("Test #%s done at %s" % (measurement.id, time.strftime("%Y-%m-%dT%H:%M:%SZ", measurement.time))))
if num_rtt == 0:
if not config.machine_readable:
print("No successful test")
else:
if not config.machine_readable:
if not config.by_probe:
print(("Tests: %i successful tests (%.1f %%), %i errors (%.1f %%), %i timeouts (%.1f %%), average RTT: %i ms" % \
(num_rtt, num_rtt*100.0/num_tests,
num_error, num_error*100.0/num_tests,
num_timeout, num_timeout*100.0/num_tests, total_rtt/num_rtt)))
else:
print(("Tests: %i successful probes (%.1f %%), %i failed (%.1f %%), average RTT: %i ms" % \
(probes_success, probes_success*100.0/num_probes,
probes_failure, probes_failure*100.0/num_probes,
total_rtt/num_rtt)))
if len(targets) > 1 and not config.machine_readable:
print("")
if config.display_probes:
if config.display_probe_asns:
l = [[probe, failed_probes[probe].asn] for probe in failed_probes.keys()]
else:
l = failed_probes.keys()
all = list(l)
if all != []:
print(all)
if config.machine_readable:
if num_rtt != 0:
percent_rtt = total_rtt/num_rtt
else:
percent_rtt = 0
print(",".join([target, str(measurement.id), "%s/%s" % (len(rdata),measurement.num_probes), \
time.strftime("%Y-%m-%dT%H:%M:%SZ", time.gmtime()), "%i" % num_rtt, \
"%.1f" % (num_rtt*100.0/num_tests), "%i" % num_error, "%.1f" % (num_error*100.0/num_tests), \
"%i" % num_timeout, "%.1f" % (num_timeout*100.0/num_tests), "%i" % (percent_rtt)]))
|