This commit is contained in:
Matthew Stratford 2021-09-22 19:49:24 +01:00
parent b8c6f087c6
commit a172d03f0e
7 changed files with 237 additions and 221 deletions

View file

@ -2,6 +2,8 @@ from helpers.alert_manager import AlertProvider
from package import BETA
from baps_types.alert import WARNING, Alert
# Dummy alert provider for testing basics like UI without needing to actually cause errors.
class DummyAlertProvider(AlertProvider):
def get_alerts(self):

View file

@ -9,10 +9,11 @@ from baps_types.happytime import happytime
MODULE = "Player" # This should match the log file, so the UI will link to the logs page.
class PlayerAlertProvider(AlertProvider):
_server_state: Dict[str, Any]
_states: List[Optional[Dict[str,Any]]] = []
_states: List[Optional[Dict[str, Any]]] = []
_player_count: int
def __init__(self):
@ -23,7 +24,8 @@ class PlayerAlertProvider(AlertProvider):
self._player_count = int(self._server_state["num_channels"])
self._states = [None] * self._player_count
# To simplify monitoring (and allow detection of things going super weird), we are going to read from the state file to work out the alerts.
# To simplify monitoring (and allow detection of things going super
# weird), we are going to read from the state file to work out the alerts.
def get_alerts(self):
for channel in range(self._player_count):
with open(resolve_external_file_path("state/Player{}.json".format(channel))) as file:
@ -82,7 +84,7 @@ class PlayerAlertProvider(AlertProvider):
"id": "player_{}_restarted".format(channel),
"title": "Player {} restarted after the server started.".format(channel),
"description":
"""Player {} last restarted at {}, after the server first started at {}, suggesting a failure.
"""Player {} last restarted at {}, after the server first started at {}, suggesting a failure.
This likely means there was an unhandled exception in the player code, causing the server to restart the player.

View file

@ -9,15 +9,17 @@ from baps_types.happytime import happytime
MODULE = "BAPSicleServer" # This should match the log file, so the UI will link to the logs page.
class ServerAlertProvider(AlertProvider):
_state: Dict[str, Any]
# To simplify monitoring (and allow detection of things going super weird), we are going to read from the state file to work out the alerts.
# To simplify monitoring (and allow detection of things going super
# weird), we are going to read from the state file to work out the alerts.
def get_alerts(self):
with open(resolve_external_file_path("state/BAPSicleServer.json")) as file:
self._state = json.loads(file.read())
funcs = [self._api_key, self._start_time]
alerts: List[Alert] = []
@ -62,7 +64,7 @@ class ServerAlertProvider(AlertProvider):
"id": "server_restarted",
"title": "BAPSicle restarted recently.",
"description":
"""The BAPSicle server restarted at {}, less than a day ago.
"""The BAPSicle server restarted at {}, less than a day ago.
It may have been automatically restarted by the OS.

View file

@ -4,6 +4,7 @@ from datetime import datetime
CRITICAL = "Critical"
WARNING = "Warning"
class Alert:
start_time: datetime
last_time: datetime
@ -14,7 +15,6 @@ class Alert:
module: str
severity: str
@property
def ui_class(self) -> str:
if self.severity == CRITICAL:
@ -32,7 +32,6 @@ class Alert:
def cleared(self):
self.end_time = datetime.now()
@property
def __dict__(self):
attrs = ["start_time", "last_time", "end_time", "id", "title", "description", "module", "severity"]
@ -42,7 +41,7 @@ class Alert:
return out
def __init__(self, new_data: Dict[str,Any]):
def __init__(self, new_data: Dict[str, Any]):
required_vars = [
"start_time", # Just in case an alert wants to show starting earlier than it is reported.
"id",
@ -56,14 +55,14 @@ class Alert:
if key not in new_data.keys():
raise KeyError("Key {} is missing from data to create Alert.".format(key))
#if type(new_data[key]) != type(getattr(self,key)):
# if type(new_data[key]) != type(getattr(self,key)):
# raise TypeError("Key {} has type {}, was expecting {}.".format(key, type(new_data[key]), type(getattr(self,key))))
# Account for if the creator didn't want to set a custom time.
if key == "start_time" and new_data[key] == -1:
new_data[key] = datetime.now()
setattr(self,key,new_data[key])
setattr(self, key, new_data[key])
self.last_time = self.start_time
self.end_time = None

View file

@ -1,3 +1,5 @@
from datetime import datetime
def happytime(date: datetime):
return date.strftime("%Y-%m-%d %H:%M:%S")

View file

@ -1,14 +1,15 @@
from typing import Any, List, Optional
#Magic for importing alert providers from alerts directory.
# Magic for importing alert providers from alerts directory.
from pkgutil import iter_modules
from importlib import import_module
from inspect import getmembers,isclass
from inspect import getmembers, isclass
from sys import modules
from baps_types.alert import CRITICAL, Alert
import alerts
def iter_namespace(ns_pkg):
# Specifying the second argument (prefix) to iter_modules makes the
# returned name an absolute name instead of a relative one. This allows
@ -25,6 +26,7 @@ class AlertProvider():
def get_alerts(self):
return []
class AlertManager():
_alerts: List[Alert]
_providers: List[AlertProvider] = []
@ -40,7 +42,10 @@ class AlertManager():
}
for provider in providers:
classes: List[Any] = [mem[1] for mem in getmembers(modules[provider], isclass) if mem[1].__module__ == modules[provider].__name__]
classes: List[Any] = [
mem[1] for mem in getmembers(
modules[provider],
isclass) if mem[1].__module__ == modules[provider].__name__]
if (len(classes) != 1):
print(classes)
@ -48,7 +53,6 @@ class AlertManager():
self._providers.append(classes[0]())
print("Discovered alert providers: ", self._providers)
def poll_alerts(self):
@ -76,7 +80,7 @@ class AlertManager():
new_alerts[index] = None # We're going to merge the existing and new, so clear the new one out.
found = True
break
if found == False:
if not found:
# The existing alert is gone, mark it as ended.
existing.cleared()

View file

@ -99,6 +99,7 @@ def render_template(file, data, status=200):
def _filter_happytime(date):
return happytime(date)
env.filters["happytime"] = _filter_happytime
logger: LoggingManager
@ -114,14 +115,17 @@ player_from_q: List[Queue] = []
@app.exception(NotFound)
def page_not_found(request, e: Any):
data = {"ui_page": "404", "ui_title": "404", "code": 404, "title": "Page Not Found", "message": "Looks like you fell off the tip of the iceberg." }
data = {"ui_page": "404", "ui_title": "404", "code": 404, "title": "Page Not Found",
"message": "Looks like you fell off the tip of the iceberg."}
return render_template("error.html", data=data, status=404)
@app.exception(Exception, ServerError)
def server_error(request, e: Exception):
data = {"ui_page": "500", "ui_title": "500", "code": 500, "title": "Something went very wrong!", "message": "Looks like the server fell over. Try viewing the WebServer logs for more details." }
# Future use.
def error_page(code=500, ui_title="500", title="Something went very wrong!",
message="Looks like the server fell over. Try viewing the WebServer logs for more details."):
data = {"ui_page": ui_title, "ui_title": ui_title, "code": code, "title": title, "message": message}
return render_template("error.html", data=data, status=500)
@app.route("/")
def ui_index(request):
config = server_state.get()
@ -148,6 +152,7 @@ def ui_status(request):
"ui_page": "status", "ui_title": "Status"}
return render_template("status.html", data=data)
@app.route("/alerts")
def ui_alerts(request):
data = {