Hyunsun Moon | db72b8f | 2020-11-02 18:03:39 -0800 | [diff] [blame] | 1 | #!/usr/bin/env python3 |
Hyunsun Moon | 53097ea | 2020-09-04 17:20:29 -0700 | [diff] [blame] | 2 | |
| 3 | # Copyright 2020-present Open Networking Foundation |
| 4 | # |
Hyunsun Moon | 5cd1eec | 2021-04-02 22:33:42 -0700 | [diff] [blame] | 5 | # SPDX-License-Identifier: LicenseRef-ONF-Member-Only-1.0 |
Hyunsun Moon | 53097ea | 2020-09-04 17:20:29 -0700 | [diff] [blame] | 6 | |
| 7 | import sys |
| 8 | import os |
| 9 | import json |
| 10 | import logging |
| 11 | import enum |
Jeremy Ronquillo | 8d10865 | 2021-11-22 17:34:58 -0800 | [diff] [blame] | 12 | import pycurl |
Hyunsun Moon | 53097ea | 2020-09-04 17:20:29 -0700 | [diff] [blame] | 13 | import time |
| 14 | import serial |
Jeremy Ronquillo | d996b51 | 2021-02-13 13:45:47 -0800 | [diff] [blame] | 15 | import subprocess |
Jeremy Ronquillo | ef17e36 | 2021-11-08 10:56:42 -0800 | [diff] [blame] | 16 | import time |
Hyunsun Moon | 53097ea | 2020-09-04 17:20:29 -0700 | [diff] [blame] | 17 | from collections import namedtuple |
Jeremy Ronquillo | e0a8b42 | 2021-11-02 12:49:15 -0700 | [diff] [blame] | 18 | from statistics import median |
Jeremy Ronquillo | c45955a | 2021-11-09 12:04:57 -0800 | [diff] [blame] | 19 | import xml.etree.ElementTree as ET |
Hyunsun Moon | 53097ea | 2020-09-04 17:20:29 -0700 | [diff] [blame] | 20 | |
| 21 | ''' |
Jeremy Ronquillo | a944fbc | 2021-03-30 10:57:45 -0700 | [diff] [blame] | 22 | "Simple" script that checks Aether network operational status periodically |
Hyunsun Moon | 53097ea | 2020-09-04 17:20:29 -0700 | [diff] [blame] | 23 | by controlling the attached 4G/LTE modem with AT commands and |
| 24 | report the result to the central monitoring server. |
| 25 | ''' |
| 26 | |
Jeremy Ronquillo | 6e352b7 | 2021-06-08 10:33:25 -0700 | [diff] [blame] | 27 | # Parse config with backwards compatibility with config.json pre 0.6.6 |
| 28 | config_file_contents = open(os.getenv('CONFIG_FILE', "./config.json")).read() |
| 29 | config_file_contents = config_file_contents.replace("user_plane_ping_test", "dns") |
| 30 | config_file_contents = config_file_contents.replace("speedtest_iperf", "iperf_server") |
Jeremy Ronquillo | c03ba68 | 2021-10-06 10:27:09 -0700 | [diff] [blame] | 31 | config_file_contents = config_file_contents.replace("\"speedtest_ping_dns\": \"1.1.1.1\",", "") |
Hyunsun Moon | 53097ea | 2020-09-04 17:20:29 -0700 | [diff] [blame] | 32 | CONF = json.loads( |
Jeremy Ronquillo | 6e352b7 | 2021-06-08 10:33:25 -0700 | [diff] [blame] | 33 | config_file_contents, object_hook=lambda d: namedtuple('X', d.keys())(*d.values()) |
Hyunsun Moon | 53097ea | 2020-09-04 17:20:29 -0700 | [diff] [blame] | 34 | ) |
| 35 | |
| 36 | logging.basicConfig( |
| 37 | filename=CONF.log_file, |
| 38 | format='%(asctime)s [%(levelname)s] %(message)s', |
Hyunsun Moon | 5cd1eec | 2021-04-02 22:33:42 -0700 | [diff] [blame] | 39 | level=logging.getLevelName(CONF.log_level) |
Hyunsun Moon | 53097ea | 2020-09-04 17:20:29 -0700 | [diff] [blame] | 40 | ) |
| 41 | |
Hyunsun Moon | 53097ea | 2020-09-04 17:20:29 -0700 | [diff] [blame] | 42 | |
| 43 | class State(enum.Enum): |
| 44 | error = "-1" |
| 45 | disconnected = "0" |
| 46 | connected = "1" |
| 47 | |
| 48 | @classmethod |
| 49 | def has_value(cls, value): |
| 50 | return value in cls._value2member_map_ |
| 51 | |
| 52 | |
| 53 | class Modem(): |
| 54 | log = logging.getLogger('aether_edge_monitoring.Modem') |
| 55 | |
| 56 | read_timeout = 0.1 |
| 57 | |
| 58 | def __init__(self, port, baudrate): |
| 59 | self.port = port |
| 60 | self.baudrate = baudrate |
| 61 | self._response = None |
| 62 | |
Don Newton | bd91ae2 | 2021-05-11 14:58:18 -0700 | [diff] [blame] | 63 | def get_modem_port(self): |
| 64 | cmd = "ls " + CONF.modem.port |
| 65 | sp = subprocess.Popen(cmd,shell=True,stdout=subprocess.PIPE, |
| 66 | stderr=subprocess.PIPE, universal_newlines=True) |
| 67 | rc = sp.wait() |
| 68 | ret,err = sp.communicate() |
| 69 | if err != "" : |
Shad Ansari | b234ff8 | 2022-02-17 22:14:35 -0800 | [diff] [blame^] | 70 | self.log.error("unable to find serial port " + err) |
Don Newton | bd91ae2 | 2021-05-11 14:58:18 -0700 | [diff] [blame] | 71 | |
| 72 | ret = ret.replace(CONF.modem.port,"").strip() |
Shad Ansari | b234ff8 | 2022-02-17 22:14:35 -0800 | [diff] [blame^] | 73 | self.log.info("Modem.get_modem_port found " + ret) |
Don Newton | bd91ae2 | 2021-05-11 14:58:18 -0700 | [diff] [blame] | 74 | return ret |
| 75 | |
Hyunsun Moon | 53097ea | 2020-09-04 17:20:29 -0700 | [diff] [blame] | 76 | def connect(self): |
Don Newton | bd91ae2 | 2021-05-11 14:58:18 -0700 | [diff] [blame] | 77 | self.port=self.get_modem_port() |
Shad Ansari | b234ff8 | 2022-02-17 22:14:35 -0800 | [diff] [blame^] | 78 | self.log.info("modem.connect Port: %s, BaudRate: %i",self.port,self.baudrate) |
Hyunsun Moon | 53097ea | 2020-09-04 17:20:29 -0700 | [diff] [blame] | 79 | self.serial = serial.Serial( |
| 80 | port=self.port, |
| 81 | baudrate=self.baudrate, |
| 82 | timeout=1) |
| 83 | |
| 84 | def _write(self, command): |
| 85 | if self.serial.inWaiting() > 0: |
| 86 | self.serial.flushInput() |
| 87 | |
| 88 | self._response = b"" |
| 89 | |
| 90 | self.serial.write(bytearray(command + "\r", "ascii")) |
| 91 | read = self.serial.inWaiting() |
| 92 | while True: |
Shad Ansari | b234ff8 | 2022-02-17 22:14:35 -0800 | [diff] [blame^] | 93 | self.log.debug("Waiting for write to complete...") |
Hyunsun Moon | 53097ea | 2020-09-04 17:20:29 -0700 | [diff] [blame] | 94 | if read > 0: |
| 95 | self._response += self.serial.read(read) |
| 96 | else: |
| 97 | time.sleep(self.read_timeout) |
| 98 | read = self.serial.inWaiting() |
| 99 | if read == 0: |
| 100 | break |
Shad Ansari | b234ff8 | 2022-02-17 22:14:35 -0800 | [diff] [blame^] | 101 | self.log.debug("Write complete...") |
Hyunsun Moon | 53097ea | 2020-09-04 17:20:29 -0700 | [diff] [blame] | 102 | return self._response.decode("ascii").replace('\r\n', ' ') |
| 103 | |
| 104 | def write(self, command, wait_resp=True): |
| 105 | response = self._write(command) |
| 106 | self.log.debug("%s: %s", command, response) |
| 107 | |
| 108 | if wait_resp and "ERROR" in response: |
| 109 | return False, None |
| 110 | return True, response |
| 111 | |
Hyunsun Moon | 5cd1eec | 2021-04-02 22:33:42 -0700 | [diff] [blame] | 112 | def get_state(self): |
Hyunsun Moon | 53097ea | 2020-09-04 17:20:29 -0700 | [diff] [blame] | 113 | success, result = self.write('AT+CGATT?') |
| 114 | if not success or 'CGATT:' not in result: |
| 115 | return State.error |
| 116 | state = result.split('CGATT:')[1].split(' ')[0] |
| 117 | return State(state) |
| 118 | |
| 119 | def close(self): |
| 120 | self.serial.close() |
| 121 | |
| 122 | |
Shad Ansari | b234ff8 | 2022-02-17 22:14:35 -0800 | [diff] [blame^] | 123 | def get_control_plane_state(modem, dongle_stats=None): |
| 124 | if dongle_stats and dongle_stats['Connection'] == 'Connected': |
| 125 | return State.connected |
| 126 | |
Hyunsun Moon | 5cd1eec | 2021-04-02 22:33:42 -0700 | [diff] [blame] | 127 | # Disable radio fuction |
Hyunsun Moon | 53097ea | 2020-09-04 17:20:29 -0700 | [diff] [blame] | 128 | # "echo" works more stable than serial for this action |
Hyunsun Moon | 5cd1eec | 2021-04-02 22:33:42 -0700 | [diff] [blame] | 129 | try: |
Don Newton | bd91ae2 | 2021-05-11 14:58:18 -0700 | [diff] [blame] | 130 | logging.debug("echo 'AT+CFUN=0' > " + modem.port) |
Hyunsun Moon | 5cd1eec | 2021-04-02 22:33:42 -0700 | [diff] [blame] | 131 | subprocess.check_output( |
Don Newton | bd91ae2 | 2021-05-11 14:58:18 -0700 | [diff] [blame] | 132 | "echo 'AT+CFUN=0' > " + modem.port, shell=True) |
Hyunsun Moon | 5cd1eec | 2021-04-02 22:33:42 -0700 | [diff] [blame] | 133 | except subprocess.CalledProcessError as e: |
| 134 | logging.error("Write 'AT+CFUN=0' failed") |
| 135 | return State.error |
Hyunsun Moon | 53097ea | 2020-09-04 17:20:29 -0700 | [diff] [blame] | 136 | |
| 137 | # Wait until the modem is fully disconnected |
| 138 | retry = 0 |
| 139 | state = None |
Hyunsun Moon | 5cd1eec | 2021-04-02 22:33:42 -0700 | [diff] [blame] | 140 | while retry < CONF.detach_timeout: |
| 141 | state = modem.get_state() |
Hyunsun Moon | 53097ea | 2020-09-04 17:20:29 -0700 | [diff] [blame] | 142 | if state is State.disconnected: |
| 143 | break |
| 144 | time.sleep(1) |
| 145 | retry += 1 |
| 146 | |
Hyunsun Moon | 53097ea | 2020-09-04 17:20:29 -0700 | [diff] [blame] | 147 | if state is not State.disconnected: |
Hyunsun Moon | 5cd1eec | 2021-04-02 22:33:42 -0700 | [diff] [blame] | 148 | logging.error("Failed to disconnect") |
| 149 | return State.error |
Hyunsun Moon | 53097ea | 2020-09-04 17:20:29 -0700 | [diff] [blame] | 150 | |
| 151 | time.sleep(2) |
Hyunsun Moon | 5cd1eec | 2021-04-02 22:33:42 -0700 | [diff] [blame] | 152 | # Enable radio function |
Hyunsun Moon | 53097ea | 2020-09-04 17:20:29 -0700 | [diff] [blame] | 153 | # "echo" works more stable than serial for this action |
Hyunsun Moon | 5cd1eec | 2021-04-02 22:33:42 -0700 | [diff] [blame] | 154 | try: |
Don Newton | bd91ae2 | 2021-05-11 14:58:18 -0700 | [diff] [blame] | 155 | logging.debug("echo 'AT+CFUN=1' > " + modem.port) |
Hyunsun Moon | 5cd1eec | 2021-04-02 22:33:42 -0700 | [diff] [blame] | 156 | subprocess.check_output( |
Don Newton | bd91ae2 | 2021-05-11 14:58:18 -0700 | [diff] [blame] | 157 | "echo 'AT+CFUN=1' > " + modem.port, shell=True) |
Hyunsun Moon | 5cd1eec | 2021-04-02 22:33:42 -0700 | [diff] [blame] | 158 | except subprocess.CalledProcessError as e: |
| 159 | logging.error("Write 'AT+CFUN=1' failed") |
| 160 | return State.error |
Hyunsun Moon | 53097ea | 2020-09-04 17:20:29 -0700 | [diff] [blame] | 161 | |
Hyunsun Moon | 5cd1eec | 2021-04-02 22:33:42 -0700 | [diff] [blame] | 162 | # Wait attach_timeout sec for the modem to be fully connected |
Hyunsun Moon | 53097ea | 2020-09-04 17:20:29 -0700 | [diff] [blame] | 163 | retry = 0 |
Hyunsun Moon | 5cd1eec | 2021-04-02 22:33:42 -0700 | [diff] [blame] | 164 | while retry < CONF.attach_timeout: |
| 165 | state = modem.get_state() |
Hyunsun Moon | 53097ea | 2020-09-04 17:20:29 -0700 | [diff] [blame] | 166 | if state is State.connected: |
| 167 | break |
| 168 | time.sleep(1) |
| 169 | retry += 1 |
| 170 | # CGATT sometimes returns None |
| 171 | if state is State.error: |
| 172 | state = State.disconnected |
| 173 | |
Hyunsun Moon | 5cd1eec | 2021-04-02 22:33:42 -0700 | [diff] [blame] | 174 | return state |
Hyunsun Moon | 53097ea | 2020-09-04 17:20:29 -0700 | [diff] [blame] | 175 | |
| 176 | |
| 177 | def get_user_plane_state(modem): |
Jeremy Ronquillo | 56d23b1 | 2021-12-02 14:57:42 -0800 | [diff] [blame] | 178 | if "dry_run" in CONF.ips._fields and CONF.ips.dry_run: # run dry_run latency test as user plane test |
| 179 | dry_run_latency, dry_run_passed = run_ping_test(CONF.ips.dry_run, 3) |
| 180 | if dry_run_passed: |
| 181 | return State.connected, dry_run_latency |
| 182 | else: |
| 183 | logging.warning("User plane test failed") |
| 184 | return State.disconnected, dry_run_latency |
| 185 | else: # run default user plane test |
| 186 | try: |
| 187 | subprocess.check_output( |
| 188 | "ping -c 3 " + CONF.ips.dns + ">/dev/null 2>&1", |
| 189 | shell=True) |
| 190 | return State.connected, None |
| 191 | except subprocess.CalledProcessError as e: |
| 192 | logging.warning("User plane test failed") |
| 193 | return State.disconnected, None |
Hyunsun Moon | 53097ea | 2020-09-04 17:20:29 -0700 | [diff] [blame] | 194 | |
| 195 | |
Jeremy Ronquillo | d996b51 | 2021-02-13 13:45:47 -0800 | [diff] [blame] | 196 | def run_ping_test(ip, count): |
| 197 | ''' |
| 198 | Runs the ping test |
| 199 | Input: IP to ping, # times to ping |
Jeremy Ronquillo | e0a8b42 | 2021-11-02 12:49:15 -0700 | [diff] [blame] | 200 | Returns: Transmitted packets |
| 201 | Received packets |
| 202 | Median ping ms |
| 203 | Min ping ms |
| 204 | Avg ping ms |
| 205 | Max ping ms |
| 206 | Std Dev ping ms |
Jeremy Ronquillo | d996b51 | 2021-02-13 13:45:47 -0800 | [diff] [blame] | 207 | ''' |
Jeremy Ronquillo | e0a8b42 | 2021-11-02 12:49:15 -0700 | [diff] [blame] | 208 | result = {'transmitted': 0, |
| 209 | 'received': 0, |
| 210 | 'median': 0.0, |
| 211 | 'min': 0.0, |
Jeremy Ronquillo | a944fbc | 2021-03-30 10:57:45 -0700 | [diff] [blame] | 212 | 'avg': 0.0, |
| 213 | 'max': 0.0, |
| 214 | 'stddev': 0.0} |
Jeremy Ronquillo | 6e352b7 | 2021-06-08 10:33:25 -0700 | [diff] [blame] | 215 | if not ip: |
Jeremy Ronquillo | 115c5e3 | 2021-09-30 11:15:56 -0700 | [diff] [blame] | 216 | return result, True |
Jeremy Ronquillo | d996b51 | 2021-02-13 13:45:47 -0800 | [diff] [blame] | 217 | try: |
Jeremy Ronquillo | e0a8b42 | 2021-11-02 12:49:15 -0700 | [diff] [blame] | 218 | pingOutput = subprocess.check_output( |
| 219 | "ping -c " + str(count) + " " + \ |
| 220 | ip, shell=True).decode("UTF-8").split() |
| 221 | result['transmitted'] = int(pingOutput[-15]) |
| 222 | result['received'] = int(pingOutput[-12]) |
| 223 | if result['received'] > 0: |
| 224 | pingValues = [] |
| 225 | |
| 226 | # Hack for getting all ping values for median |
| 227 | for word in pingOutput: |
| 228 | if "time=" in word: |
| 229 | pingValues.append(float(word.split("=")[1])) |
| 230 | result['median'] = round(median(pingValues), 3) |
| 231 | |
| 232 | pingResult = pingOutput[-2].split('/') |
| 233 | result['min'] = float(pingResult[0]) |
| 234 | result['avg'] = float(pingResult[1]) |
| 235 | result['max'] = float(pingResult[2]) |
| 236 | result['stddev'] = float(pingResult[3]) |
| 237 | else: |
| 238 | logging.error("No packets received during ping " + ip) |
| 239 | return result, False |
Jeremy Ronquillo | d996b51 | 2021-02-13 13:45:47 -0800 | [diff] [blame] | 240 | except Exception as e: |
| 241 | logging.error("Ping test failed for " + ip + ": %s", e) |
Jeremy Ronquillo | 115c5e3 | 2021-09-30 11:15:56 -0700 | [diff] [blame] | 242 | return result, False |
| 243 | return result, True |
Jeremy Ronquillo | d996b51 | 2021-02-13 13:45:47 -0800 | [diff] [blame] | 244 | |
| 245 | |
Jeremy Ronquillo | 56d23b1 | 2021-12-02 14:57:42 -0800 | [diff] [blame] | 246 | def get_ping_test(modem, dry_run_latency=None): |
Jeremy Ronquillo | d996b51 | 2021-02-13 13:45:47 -0800 | [diff] [blame] | 247 | ''' |
Jeremy Ronquillo | 677c883 | 2021-04-06 13:53:36 -0700 | [diff] [blame] | 248 | Prepares the ping test. |
Jeremy Ronquillo | e0a8b42 | 2021-11-02 12:49:15 -0700 | [diff] [blame] | 249 | Runs ping tests from 'ips' entry in config.json in order. |
Jeremy Ronquillo | 56d23b1 | 2021-12-02 14:57:42 -0800 | [diff] [blame] | 250 | Note: 'dry_run' is not run here; it is run during the user plane test. |
Jeremy Ronquillo | d996b51 | 2021-02-13 13:45:47 -0800 | [diff] [blame] | 251 | ''' |
| 252 | speedtest_ping = {} |
Jeremy Ronquillo | 115c5e3 | 2021-09-30 11:15:56 -0700 | [diff] [blame] | 253 | status = True |
| 254 | ping_test_passed = True |
Jeremy Ronquillo | 6e352b7 | 2021-06-08 10:33:25 -0700 | [diff] [blame] | 255 | |
Jeremy Ronquillo | 56d23b1 | 2021-12-02 14:57:42 -0800 | [diff] [blame] | 256 | if dry_run_latency: |
| 257 | speedtest_ping["dry_run"] = dry_run_latency |
| 258 | |
Jeremy Ronquillo | 6e352b7 | 2021-06-08 10:33:25 -0700 | [diff] [blame] | 259 | for i in range(0, len(CONF.ips)): |
Jeremy Ronquillo | 56d23b1 | 2021-12-02 14:57:42 -0800 | [diff] [blame] | 260 | if CONF.ips._fields[i] == "dry_run": |
| 261 | continue |
| 262 | count = 5 |
Jeremy Ronquillo | e0a8b42 | 2021-11-02 12:49:15 -0700 | [diff] [blame] | 263 | speedtest_ping[CONF.ips._fields[i]], status = run_ping_test(CONF.ips[i], count) |
Jeremy Ronquillo | 115c5e3 | 2021-09-30 11:15:56 -0700 | [diff] [blame] | 264 | if not status: |
| 265 | ping_test_passed = False |
| 266 | logging.error("Ping test failed. Not running further tests.") |
| 267 | return speedtest_ping, ping_test_passed |
Jeremy Ronquillo | d996b51 | 2021-02-13 13:45:47 -0800 | [diff] [blame] | 268 | |
Jeremy Ronquillo | 677c883 | 2021-04-06 13:53:36 -0700 | [diff] [blame] | 269 | def run_iperf_test(ip, port, time_duration, is_downlink): |
| 270 | ''' |
| 271 | Runs iperf test to specified IP in the config file. |
| 272 | - Runs for 10 seconds (10 iterations) |
| 273 | - Retrieves downlink and uplink test results from json output |
| 274 | ''' |
| 275 | result = 0.0 |
Jeremy Ronquillo | c03ba68 | 2021-10-06 10:27:09 -0700 | [diff] [blame] | 276 | if not ip or port == 0: |
Jeremy Ronquillo | 677c883 | 2021-04-06 13:53:36 -0700 | [diff] [blame] | 277 | return result |
Jeremy Ronquillo | 115c5e3 | 2021-09-30 11:15:56 -0700 | [diff] [blame] | 278 | maxRetries = 2 |
Jeremy Ronquillo | 79c3e67 | 2021-09-03 12:54:55 -0700 | [diff] [blame] | 279 | err = None |
Jeremy Ronquillo | 012ac66 | 2021-08-06 12:13:43 -0700 | [diff] [blame] | 280 | for _ in range(0, maxRetries): |
| 281 | try: |
| 282 | iperfResult = json.loads(subprocess.check_output( |
| 283 | "iperf3 -c " + ip + |
| 284 | " -p " + str(port) + |
| 285 | " -t " + str(time_duration) + |
| 286 | (" -R " if is_downlink else "") + |
| 287 | " --json", shell=True).decode("UTF-8")) |
| 288 | received_mbps = iperfResult['end']['sum_received']['bits_per_second'] / 1000000 |
| 289 | sent_mbps = iperfResult['end']['sum_sent']['bits_per_second'] / 1000000.0 |
| 290 | result = received_mbps if is_downlink else sent_mbps |
| 291 | return result |
| 292 | except Exception as e: |
Jeremy Ronquillo | 79c3e67 | 2021-09-03 12:54:55 -0700 | [diff] [blame] | 293 | err = e |
Jeremy Ronquillo | 012ac66 | 2021-08-06 12:13:43 -0700 | [diff] [blame] | 294 | time.sleep(5) |
| 295 | pass |
Jeremy Ronquillo | 79c3e67 | 2021-09-03 12:54:55 -0700 | [diff] [blame] | 296 | logging.error("After " + str(maxRetries) + " retries, iperf test failed for " + ip + ": %s", err) |
Jeremy Ronquillo | 677c883 | 2021-04-06 13:53:36 -0700 | [diff] [blame] | 297 | return result |
| 298 | |
| 299 | |
| 300 | def get_iperf_test(modem): |
| 301 | ''' |
| 302 | Prepares the iperf test. |
| 303 | ''' |
Jeremy Ronquillo | ef17e36 | 2021-11-08 10:56:42 -0800 | [diff] [blame] | 304 | global hour_iperf_scheduled_time_last_ran |
Jeremy Ronquillo | 677c883 | 2021-04-06 13:53:36 -0700 | [diff] [blame] | 305 | speedtest_iperf = {} |
| 306 | speedtest_iperf['cluster'] = {} |
Jeremy Ronquillo | ef17e36 | 2021-11-08 10:56:42 -0800 | [diff] [blame] | 307 | |
| 308 | if "iperf_schedule" in CONF._fields and len(CONF.iperf_schedule) > 0: |
| 309 | if int(time.strftime("%H")) not in CONF.iperf_schedule: # not in the schedule |
| 310 | hour_iperf_scheduled_time_last_ran = -1 |
| 311 | return None |
| 312 | elif int(time.strftime("%H")) == hour_iperf_scheduled_time_last_ran: # already ran this hour |
| 313 | return None |
| 314 | hour_iperf_scheduled_time_last_ran = int(time.strftime("%H")) |
| 315 | |
Jeremy Ronquillo | 6e352b7 | 2021-06-08 10:33:25 -0700 | [diff] [blame] | 316 | speedtest_iperf['cluster']['downlink'] = run_iperf_test(CONF.ips.iperf_server, CONF.iperf_port, 10, True) |
| 317 | speedtest_iperf['cluster']['uplink'] = run_iperf_test(CONF.ips.iperf_server, CONF.iperf_port, 10, False) |
Jeremy Ronquillo | 677c883 | 2021-04-06 13:53:36 -0700 | [diff] [blame] | 318 | |
| 319 | return speedtest_iperf |
| 320 | |
Jeremy Ronquillo | d996b51 | 2021-02-13 13:45:47 -0800 | [diff] [blame] | 321 | |
Shad Ansari | b234ff8 | 2022-02-17 22:14:35 -0800 | [diff] [blame^] | 322 | def get_signal_quality(modem, dongle_stats=None): |
| 323 | if dongle_stats and dongle_stats['RSRQ'] != '' and dongle_stats['RSRP'] != '': |
| 324 | rsrq = int((float(dongle_stats['RSRQ']) + 19.5) * 2) |
| 325 | rsrp = int(float(dongle_stats['RSRP']) + 140) |
| 326 | return {'rsrq': rsrq, 'rsrp': rsrp} |
| 327 | |
Hyunsun Moon | 5cd1eec | 2021-04-02 22:33:42 -0700 | [diff] [blame] | 328 | success, result = modem.write('AT+CESQ') |
Don Newton | bd91ae2 | 2021-05-11 14:58:18 -0700 | [diff] [blame] | 329 | logging.debug("get_signal_quality success %i result %s",success,result) |
Hyunsun Moon | 5cd1eec | 2021-04-02 22:33:42 -0700 | [diff] [blame] | 330 | if not success or 'CESQ: ' not in result: |
| 331 | logging.error("Failed to get signal quality") |
Don Newton | bd91ae2 | 2021-05-11 14:58:18 -0700 | [diff] [blame] | 332 | return {'rsrq':0, 'rsrp':0} |
Hyunsun Moon | 5cd1eec | 2021-04-02 22:33:42 -0700 | [diff] [blame] | 333 | |
| 334 | logging.debug("%s", result) |
| 335 | tmp_rsrq = result.split('CESQ:')[1].split(',')[4] |
| 336 | tmp_rsrp = result.split('CESQ:')[1].split(',')[5] |
| 337 | |
| 338 | rsrq = int(tmp_rsrq.strip()) |
| 339 | rsrp = int(tmp_rsrp.strip().split(' ')[0]) |
| 340 | result = { |
| 341 | 'rsrq': 0 if rsrq is 255 else rsrq, |
| 342 | 'rsrp': 0 if rsrp is 255 else rsrp |
| 343 | } |
| 344 | |
| 345 | return result |
| 346 | |
Shad Ansari | b234ff8 | 2022-02-17 22:14:35 -0800 | [diff] [blame^] | 347 | |
| 348 | def get_dongle_stats(): |
Jeremy Ronquillo | c45955a | 2021-11-09 12:04:57 -0800 | [diff] [blame] | 349 | result = {'SuccessfulFetch' : False} |
Jeremy Ronquillo | 56d23b1 | 2021-12-02 14:57:42 -0800 | [diff] [blame] | 350 | if "report_in_band" in CONF._fields: |
| 351 | result['inBandReporting'] = CONF.report_in_band |
| 352 | else: |
| 353 | result['inBandReporting'] = False |
Jeremy Ronquillo | c45955a | 2021-11-09 12:04:57 -0800 | [diff] [blame] | 354 | XMLkeys = ["MAC", |
| 355 | "PLMNStatus", |
| 356 | "UICCStatus", |
| 357 | "IMEI", |
| 358 | "IMSI", |
| 359 | "PLMNSelected", |
| 360 | "MCC", |
| 361 | "MNC", |
| 362 | "PhyCellID", |
| 363 | "CellGlobalID", |
| 364 | "Band", |
| 365 | "EARFCN", |
| 366 | "BandWidth", |
Shad Ansari | b234ff8 | 2022-02-17 22:14:35 -0800 | [diff] [blame^] | 367 | "RSRP", |
| 368 | "RSRQ", |
Jeremy Ronquillo | c45955a | 2021-11-09 12:04:57 -0800 | [diff] [blame] | 369 | "ServCellState", |
| 370 | "Connection", |
| 371 | "IPv4Addr"] |
| 372 | dongleStatsXML = None |
| 373 | try: |
Jeremy Ronquillo | 56d23b1 | 2021-12-02 14:57:42 -0800 | [diff] [blame] | 374 | dongleStatsXML = ET.fromstring(subprocess.check_output("curl -u admin:admin -s 'http://192.168.0.1:8080/cgi-bin/ltestatus.cgi?Command=Status'", shell=True).decode("UTF-8")) |
Jeremy Ronquillo | c45955a | 2021-11-09 12:04:57 -0800 | [diff] [blame] | 375 | except Exception as e: |
| 376 | logging.error("Failed to fetch dongle stats from URL: " + str(e)) |
| 377 | return result |
| 378 | try: |
| 379 | for key in XMLkeys: |
| 380 | try: |
| 381 | result[key] = dongleStatsXML.find(key).text |
| 382 | except AttributeError as e: |
| 383 | logging.warn("Failed to find " + key + " in XML.") |
| 384 | result[key] = "" |
| 385 | result["SuccessfulFetch"] = True |
| 386 | except Exception as e: |
| 387 | logging.error("Failed to fetch dongle stats from XML: " + str(e)) |
| 388 | return result |
| 389 | return result |
Hyunsun Moon | 5cd1eec | 2021-04-02 22:33:42 -0700 | [diff] [blame] | 390 | |
Jeremy Ronquillo | c45955a | 2021-11-09 12:04:57 -0800 | [diff] [blame] | 391 | |
| 392 | def report_status(signal_quality, dongle_stats, cp_state=None, up_state=None, speedtest_ping=None, speedtest_iperf=None): |
Hyunsun Moon | 5cd1eec | 2021-04-02 22:33:42 -0700 | [diff] [blame] | 393 | report = { |
| 394 | 'name': CONF.edge_name, |
| 395 | 'status': { |
| 396 | 'control_plane': "disconnected", |
| 397 | 'user_plane': "disconnected" |
| 398 | }, |
Jeremy Ronquillo | c45955a | 2021-11-09 12:04:57 -0800 | [diff] [blame] | 399 | 'dongle_stats': { |
| 400 | 'SuccessfulFetch' : False |
| 401 | }, |
Hyunsun Moon | 5cd1eec | 2021-04-02 22:33:42 -0700 | [diff] [blame] | 402 | 'speedtest': { |
| 403 | 'ping': { |
| 404 | 'dns': { |
Jeremy Ronquillo | e0a8b42 | 2021-11-02 12:49:15 -0700 | [diff] [blame] | 405 | 'transmitted' : 0, |
| 406 | 'received' : 0, |
| 407 | 'median' : 0.0, |
Jeremy Ronquillo | 6e352b7 | 2021-06-08 10:33:25 -0700 | [diff] [blame] | 408 | 'min': 0.0, |
| 409 | 'avg': 0.0, |
| 410 | 'max': 0.0, |
| 411 | 'stddev': 0.0 |
Hyunsun Moon | 5cd1eec | 2021-04-02 22:33:42 -0700 | [diff] [blame] | 412 | } |
Jeremy Ronquillo | 677c883 | 2021-04-06 13:53:36 -0700 | [diff] [blame] | 413 | }, |
| 414 | 'iperf': { |
| 415 | 'cluster': { |
| 416 | 'downlink': 0.0, |
| 417 | 'uplink': 0.0 |
| 418 | } |
Hyunsun Moon | 5cd1eec | 2021-04-02 22:33:42 -0700 | [diff] [blame] | 419 | } |
| 420 | }, |
| 421 | 'signal_quality': { |
| 422 | 'rsrq': 0, |
| 423 | 'rsrp': 0 |
| 424 | } |
| 425 | } |
| 426 | |
| 427 | if cp_state is not None: |
| 428 | report['status']['control_plane'] = cp_state.name |
| 429 | if up_state is not None: |
| 430 | report['status']['user_plane'] = up_state.name |
| 431 | if speedtest_ping is not None: |
| 432 | report['speedtest']['ping'] = speedtest_ping |
Jeremy Ronquillo | 677c883 | 2021-04-06 13:53:36 -0700 | [diff] [blame] | 433 | if speedtest_iperf is not None: |
| 434 | report['speedtest']['iperf'] = speedtest_iperf |
Hyunsun Moon | 5cd1eec | 2021-04-02 22:33:42 -0700 | [diff] [blame] | 435 | report['signal_quality'] = signal_quality |
Jeremy Ronquillo | c45955a | 2021-11-09 12:04:57 -0800 | [diff] [blame] | 436 | report['dongle_stats'] = dongle_stats |
Hyunsun Moon | 53097ea | 2020-09-04 17:20:29 -0700 | [diff] [blame] | 437 | |
| 438 | logging.info("Sending report %s", report) |
Don Newton | bd91ae2 | 2021-05-11 14:58:18 -0700 | [diff] [blame] | 439 | global cycles |
| 440 | cycles += 1 |
| 441 | logging.info("Number of cycles since modem restart %i",cycles) |
Jeremy Ronquillo | 8d10865 | 2021-11-22 17:34:58 -0800 | [diff] [blame] | 442 | |
Hyunsun Moon | 53097ea | 2020-09-04 17:20:29 -0700 | [diff] [blame] | 443 | try: |
Jeremy Ronquillo | eff2e6d | 2021-12-06 10:39:37 -0800 | [diff] [blame] | 444 | interface = None |
| 445 | report_via_modem = "report_in_band" in CONF._fields and CONF.report_in_band and \ |
| 446 | "iface" in CONF.modem._fields and CONF.modem.iface |
| 447 | report_via_given_iface = "report_iface" in CONF._fields and CONF.report_iface |
| 448 | |
Jeremy Ronquillo | 8d10865 | 2021-11-22 17:34:58 -0800 | [diff] [blame] | 449 | c = pycurl.Curl() |
| 450 | c.setopt(pycurl.URL, CONF.report_url) |
| 451 | c.setopt(pycurl.POST, True) |
| 452 | c.setopt(pycurl.HTTPHEADER, ['Content-Type: application/json']) |
| 453 | c.setopt(pycurl.TIMEOUT, 10) |
| 454 | c.setopt(pycurl.POSTFIELDS, json.dumps(report)) |
Jeremy Ronquillo | 56d23b1 | 2021-12-02 14:57:42 -0800 | [diff] [blame] | 455 | c.setopt(pycurl.WRITEFUNCTION, lambda x: None) # don't output to console |
Jeremy Ronquillo | eff2e6d | 2021-12-06 10:39:37 -0800 | [diff] [blame] | 456 | |
| 457 | if report_via_modem: # report in-band |
| 458 | interface = CONF.modem.iface |
| 459 | c.setopt(pycurl.INTERFACE, interface) |
| 460 | elif report_via_given_iface: # report over given interface |
| 461 | interface = CONF.report_iface |
| 462 | c.setopt(pycurl.INTERFACE, interface) |
| 463 | # else, reports over default interface |
| 464 | |
| 465 | try: |
| 466 | c.perform() |
| 467 | logging.info("Report sent via " + interface + "!") |
| 468 | except Exception as e: |
| 469 | if report_via_modem and report_via_given_iface: |
| 470 | logging.warning("Sending report via modem failed. Attempting to send report via " + str(CONF.report_iface) + ".") |
| 471 | interface = CONF.report_iface |
| 472 | c.setopt(pycurl.INTERFACE, interface) |
| 473 | c.perform() |
| 474 | logging.info("Report sent via " + interface + "!") |
| 475 | else: |
| 476 | logging.error("Failed to send report: " + str(e)) |
Jeremy Ronquillo | 8d10865 | 2021-11-22 17:34:58 -0800 | [diff] [blame] | 477 | c.close() |
| 478 | except Exception as e: |
| 479 | logging.error("Failed to send report: " + str(e)) |
Jeremy Ronquillo | eff2e6d | 2021-12-06 10:39:37 -0800 | [diff] [blame] | 480 | c.close() |
Jeremy Ronquillo | 8d10865 | 2021-11-22 17:34:58 -0800 | [diff] [blame] | 481 | |
Hyunsun Moon | 5cd1eec | 2021-04-02 22:33:42 -0700 | [diff] [blame] | 482 | time.sleep(CONF.report_interval) |
Jeremy Ronquillo | 82a1461 | 2021-10-08 12:08:20 -0700 | [diff] [blame] | 483 | |
Don Newton | bd91ae2 | 2021-05-11 14:58:18 -0700 | [diff] [blame] | 484 | def reset_usb(): |
Jeremy Ronquillo | 82a1461 | 2021-10-08 12:08:20 -0700 | [diff] [blame] | 485 | try: |
| 486 | # Attempt to run uhubctl |
| 487 | if (int(subprocess.call("which uhubctl",shell=True)) == 0): |
| 488 | cmd = "/usr/sbin/uhubctl -a 0 -l 2" # -a 0 = action is shutdown -l 2 location = bus 2 on pi controls power to all hubs |
| 489 | ret = subprocess.call(cmd,shell=True) |
| 490 | logging.info("Shutting down usb hub 2 results %s" , ret) |
| 491 | time.sleep(10)# let power down process settle out |
| 492 | cmd = "/usr/sbin/uhubctl -a 1 -l 2" # -a 1 = action is start -l 2 location = bus 2 on pi controls power to all hubs |
| 493 | ret = subprocess.call(cmd,shell=True) |
| 494 | logging.info("Starting up usb hub 2 results %s" , ret) |
| 495 | time.sleep(10) #allow dbus to finish |
| 496 | global cycles |
| 497 | cycles = 0 |
| 498 | else: |
| 499 | reboot(120) |
| 500 | except Exception as e: |
| 501 | logging.error("Failed to run uhubctl: %s", e) |
| 502 | reboot(120) |
| 503 | |
| 504 | def reboot(delay): |
| 505 | logging.error("Failed to run uhubctl. Reboot system in " + str(delay) + " second(s).") |
| 506 | time.sleep(delay) |
| 507 | subprocess.check_output("sudo shutdown -r now", shell=True) |
Don Newton | bd91ae2 | 2021-05-11 14:58:18 -0700 | [diff] [blame] | 508 | |
Hyunsun Moon | 53097ea | 2020-09-04 17:20:29 -0700 | [diff] [blame] | 509 | def main(): |
Don Newton | bd91ae2 | 2021-05-11 14:58:18 -0700 | [diff] [blame] | 510 | global cycles |
Jeremy Ronquillo | ef17e36 | 2021-11-08 10:56:42 -0800 | [diff] [blame] | 511 | global hour_iperf_scheduled_time_last_ran |
Don Newton | bd91ae2 | 2021-05-11 14:58:18 -0700 | [diff] [blame] | 512 | cycles = 0 |
Jeremy Ronquillo | ef17e36 | 2021-11-08 10:56:42 -0800 | [diff] [blame] | 513 | hour_iperf_scheduled_time_last_ran = -1 |
Jeremy Ronquillo | 8d10865 | 2021-11-22 17:34:58 -0800 | [diff] [blame] | 514 | |
| 515 | try: |
| 516 | if "report_in_band" in CONF._fields and \ |
| 517 | "iface" in CONF.modem._fields and CONF.modem.iface: |
| 518 | if CONF.report_in_band: # need to add default gateway if reporting in-band |
| 519 | subprocess.check_output("sudo route add default gw " + CONF.modem.ip_addr + " " + CONF.modem.iface + " || true", shell=True) |
| 520 | else: |
| 521 | subprocess.check_output("sudo route del default gw " + CONF.modem.ip_addr + " " + CONF.modem.iface + " || true", shell=True) |
| 522 | except Exception as e: |
| 523 | logging.error("Failed to change default route for modem: " + str(e)) |
| 524 | |
Don Newton | bd91ae2 | 2021-05-11 14:58:18 -0700 | [diff] [blame] | 525 | for ip in CONF.ips: |
| 526 | if not ip: |
| 527 | continue |
| 528 | try: |
| 529 | subprocess.check_output("sudo ip route replace {}/32 via {}".format( |
| 530 | ip, CONF.modem.ip_addr), shell=True) |
| 531 | except subprocess.CalledProcessError as e: |
Jeremy Ronquillo | ef17e36 | 2021-11-08 10:56:42 -0800 | [diff] [blame] | 532 | logging.error("Failed to add routes: " + str(e.returncode) + str(e.output)) |
Jeremy Ronquillo | 82a1461 | 2021-10-08 12:08:20 -0700 | [diff] [blame] | 533 | time.sleep(10) # Sleep for 10 seconds before retry |
Don Newton | bd91ae2 | 2021-05-11 14:58:18 -0700 | [diff] [blame] | 534 | sys.exit(1) |
| 535 | |
Hyunsun Moon | 53097ea | 2020-09-04 17:20:29 -0700 | [diff] [blame] | 536 | modem = Modem(CONF.modem.port, CONF.modem.baud) |
| 537 | try: |
| 538 | modem.connect() |
| 539 | except serial.serialutil.SerialException as e: |
| 540 | logging.error("Failed to connect the modem for %s", e) |
Hyunsun Moon | 2b7d3e1 | 2021-01-04 13:30:19 -0800 | [diff] [blame] | 541 | sys.exit(1) |
Hyunsun Moon | 53097ea | 2020-09-04 17:20:29 -0700 | [diff] [blame] | 542 | |
Hyunsun Moon | 53097ea | 2020-09-04 17:20:29 -0700 | [diff] [blame] | 543 | while True: |
Shad Ansari | b234ff8 | 2022-02-17 22:14:35 -0800 | [diff] [blame^] | 544 | dongle_stats = get_dongle_stats() |
| 545 | cp_state = get_control_plane_state(modem, dongle_stats) |
| 546 | if cp_state != State.connected: |
| 547 | logging.error("Control plane not connected") |
| 548 | continue |
| 549 | signal_quality = get_signal_quality(modem, dongle_stats) |
Hyunsun Moon | 53097ea | 2020-09-04 17:20:29 -0700 | [diff] [blame] | 550 | if cp_state is State.error: |
| 551 | logging.error("Modem is in error state.") |
Don Newton | bd91ae2 | 2021-05-11 14:58:18 -0700 | [diff] [blame] | 552 | reset_usb() |
Hyunsun Moon | f424237 | 2020-10-04 23:32:38 -0700 | [diff] [blame] | 553 | sys.exit(1) |
Hyunsun Moon | 5cd1eec | 2021-04-02 22:33:42 -0700 | [diff] [blame] | 554 | if cp_state is State.disconnected: |
| 555 | # Failed to attach, don't need to run other tests |
Shad Ansari | b234ff8 | 2022-02-17 22:14:35 -0800 | [diff] [blame^] | 556 | logging.error("Check control plane - fail") |
Jeremy Ronquillo | c45955a | 2021-11-09 12:04:57 -0800 | [diff] [blame] | 557 | report_status(signal_quality, dongle_stats) |
Hyunsun Moon | 5cd1eec | 2021-04-02 22:33:42 -0700 | [diff] [blame] | 558 | continue |
Hyunsun Moon | 53097ea | 2020-09-04 17:20:29 -0700 | [diff] [blame] | 559 | |
Jeremy Ronquillo | 56d23b1 | 2021-12-02 14:57:42 -0800 | [diff] [blame] | 560 | up_state, dry_run_latency = get_user_plane_state(modem) |
Hyunsun Moon | 5cd1eec | 2021-04-02 22:33:42 -0700 | [diff] [blame] | 561 | if up_state is State.disconnected: |
Shad Ansari | b234ff8 | 2022-02-17 22:14:35 -0800 | [diff] [blame^] | 562 | logging.error("Check user plane - fail") |
Jeremy Ronquillo | 677c883 | 2021-04-06 13:53:36 -0700 | [diff] [blame] | 563 | # Basic user plane test failed, don't need to run the rest of tests |
Jeremy Ronquillo | c45955a | 2021-11-09 12:04:57 -0800 | [diff] [blame] | 564 | report_status(signal_quality, dongle_stats, cp_state) |
Hyunsun Moon | 5cd1eec | 2021-04-02 22:33:42 -0700 | [diff] [blame] | 565 | continue |
| 566 | |
Jeremy Ronquillo | 56d23b1 | 2021-12-02 14:57:42 -0800 | [diff] [blame] | 567 | speedtest_ping, speedtest_status = get_ping_test(modem, dry_run_latency) |
Jeremy Ronquillo | 115c5e3 | 2021-09-30 11:15:56 -0700 | [diff] [blame] | 568 | if speedtest_status: |
| 569 | speedtest_iperf = get_iperf_test(modem) |
| 570 | else: |
Shad Ansari | b234ff8 | 2022-02-17 22:14:35 -0800 | [diff] [blame^] | 571 | logging.error("Check iperf check - fail") |
Jeremy Ronquillo | c45955a | 2021-11-09 12:04:57 -0800 | [diff] [blame] | 572 | report_status(signal_quality, dongle_stats, cp_state, up_state, speedtest_ping) |
Jeremy Ronquillo | 115c5e3 | 2021-09-30 11:15:56 -0700 | [diff] [blame] | 573 | continue |
Jeremy Ronquillo | 677c883 | 2021-04-06 13:53:36 -0700 | [diff] [blame] | 574 | |
Jeremy Ronquillo | c45955a | 2021-11-09 12:04:57 -0800 | [diff] [blame] | 575 | report_status(signal_quality, dongle_stats, cp_state, up_state, speedtest_ping, speedtest_iperf) |
Hyunsun Moon | 53097ea | 2020-09-04 17:20:29 -0700 | [diff] [blame] | 576 | |
| 577 | modem.close() |
| 578 | |
| 579 | |
| 580 | if __name__ == "__main__": |
| 581 | main() |