Implement web server metrics in Tornado #3

server/handlers/api/addspot.py

@@ -1,12 +1,15 @@
 import json
 import logging
 import re
+from datetime import datetime
 
+import pytz
 import tornado
 
 from core.config import ALLOW_SPOTTING, MAX_SPOT_AGE
 from core.constants import UNKNOWN_BAND
 from core.lookup_helper import lookup_helper
+from core.prometheus_metrics_handler import api_requests_counter
 from core.sig_utils import get_ref_regex_for_sig
 from core.utils import serialize_everything
 from data.sig_ref import SIGRef
@@ -15,11 +18,18 @@ from data.spot import Spot
 
 # API request handler for /api/v1/spot (POST)
 class APISpotHandler(tornado.web.RequestHandler):
-    def initialize(self, spots):
+    def initialize(self, spots, web_server_metrics):
         self.spots = spots
+        self.web_server_metrics = web_server_metrics
 
     def post(self):
         try:
+            # Metrics
+            self.web_server_metrics["last_api_access_time"] = datetime.now(pytz.UTC)
+            self.web_server_metrics["api_access_counter"] += 1
+            self.web_server_metrics["status"] = "OK"
+            api_requests_counter.inc()
+
             # Reject if not allowed
             if not ALLOW_SPOTTING:
                 self.set_status(401)

server/handlers/api/alerts.py

@@ -5,16 +5,24 @@ from datetime import datetime
 import pytz
 import tornado
 
+from core.prometheus_metrics_handler import api_requests_counter
 from core.utils import serialize_everything
 
 
 # API request handler for /api/v1/alerts
 class APIAlertsHandler(tornado.web.RequestHandler):
-    def initialize(self, alerts):
+    def initialize(self, alerts, web_server_metrics):
         self.alerts = alerts
+        self.web_server_metrics = web_server_metrics
 
     def get(self):
         try:
+            # Metrics
+            self.web_server_metrics["last_api_access_time"] = datetime.now(pytz.UTC)
+            self.web_server_metrics["api_access_counter"] += 1
+            self.web_server_metrics["status"] = "OK"
+            api_requests_counter.inc()
+
             # request.arguments contains lists for each param key because technically the client can supply multiple,
             # reduce that to just the first entry, and convert bytes to string
             query_params = {k: v[0].decode("utf-8") for k, v in self.request.arguments.items()}
@@ -39,6 +47,9 @@ class APIAlertsStreamHandler(tornado.web.RequestHandler):
     def get(self):
         # todo
         # try:
+        #     # Metrics
+        #     api_requests_counter.inc()
+        #
         #     response.content_type  = 'text/event-stream'
         #     response.cache_control = 'no-cache'
         #     yield 'retry: 1000\n\n'

server/handlers/api/lookups.py

@@ -1,10 +1,13 @@
 import json
 import logging
 import re
+from datetime import datetime
 
+import pytz
 import tornado
 
 from core.constants import SIGS
+from core.prometheus_metrics_handler import api_requests_counter
 from core.sig_utils import get_ref_regex_for_sig, populate_sig_ref_info
 from core.utils import serialize_everything
 from data.sig_ref import SIGRef
@@ -13,8 +16,17 @@ from data.spot import Spot
 
 # API request handler for /api/v1/lookup/call
 class APILookupCallHandler(tornado.web.RequestHandler):
+    def initialize(self, web_server_metrics):
+        self.web_server_metrics = web_server_metrics
+
     def get(self):
         try:
+            # Metrics
+            self.web_server_metrics["last_api_access_time"] = datetime.now(pytz.UTC)
+            self.web_server_metrics["api_access_counter"] += 1
+            self.web_server_metrics["status"] = "OK"
+            api_requests_counter.inc()
+
             # request.arguments contains lists for each param key because technically the client can supply multiple,
             # reduce that to just the first entry, and convert bytes to string
             query_params = {k: v[0].decode("utf-8") for k, v in self.request.arguments.items()}
@@ -63,8 +75,17 @@ class APILookupCallHandler(tornado.web.RequestHandler):
 
 # API request handler for /api/v1/lookup/sigref
 class APILookupSIGRefHandler(tornado.web.RequestHandler):
+    def initialize(self, web_server_metrics):
+        self.web_server_metrics = web_server_metrics
+
     def get(self):
         try:
+            # Metrics
+            self.web_server_metrics["last_api_access_time"] = datetime.now(pytz.UTC)
+            self.web_server_metrics["api_access_counter"] += 1
+            self.web_server_metrics["status"] = "OK"
+            api_requests_counter.inc()
+
             # request.arguments contains lists for each param key because technically the client can supply multiple,
             # reduce that to just the first entry, and convert bytes to string
             query_params = {k: v[0].decode("utf-8") for k, v in self.request.arguments.items()}

server/handlers/api/options.py

@@ -1,18 +1,28 @@
 import json
+from datetime import datetime
 
+import pytz
 import tornado
 
 from core.config import MAX_SPOT_AGE, ALLOW_SPOTTING, WEB_UI_OPTIONS
 from core.constants import BANDS, ALL_MODES, MODE_TYPES, SIGS, CONTINENTS
+from core.prometheus_metrics_handler import api_requests_counter
 from core.utils import serialize_everything
 
 
 # API request handler for /api/v1/options
 class APIOptionsHandler(tornado.web.RequestHandler):
-    def initialize(self, status_data):
+    def initialize(self, status_data, web_server_metrics):
         self.status_data = status_data
+        self.web_server_metrics = web_server_metrics
 
     def get(self):
+        # Metrics
+        self.web_server_metrics["last_api_access_time"] = datetime.now(pytz.UTC)
+        self.web_server_metrics["api_access_counter"] += 1
+        self.web_server_metrics["status"] = "OK"
+        api_requests_counter.inc()
+
         options = {"bands": BANDS,
                    "modes": ALL_MODES,
                    "mode_types": MODE_TYPES,

server/handlers/api/spots.py

@@ -5,16 +5,24 @@ from datetime import datetime, timedelta
 import pytz
 import tornado
 
+from core.prometheus_metrics_handler import api_requests_counter
 from core.utils import serialize_everything
 
 
 # API request handler for /api/v1/spots
 class APISpotsHandler(tornado.web.RequestHandler):
-    def initialize(self, spots):
+    def initialize(self, spots, web_server_metrics):
         self.spots = spots
+        self.web_server_metrics = web_server_metrics
 
     def get(self):
         try:
+            # Metrics
+            self.web_server_metrics["last_api_access_time"] = datetime.now(pytz.UTC)
+            self.web_server_metrics["api_access_counter"] += 1
+            self.web_server_metrics["status"] = "OK"
+            api_requests_counter.inc()
+
             # request.arguments contains lists for each param key because technically the client can supply multiple,
             # reduce that to just the first entry, and convert bytes to string
             query_params = {k: v[0].decode("utf-8") for k, v in self.request.arguments.items()}
@@ -40,6 +48,9 @@ class APISpotsStreamHandler(tornado.web.RequestHandler):
     def get(self):
         # todo
         # try:
+        #     # Metrics
+        #     api_requests_counter.inc()
+        #
         #     response.content_type  = 'text/event-stream'
         #     response.cache_control = 'no-cache'
         #     yield 'retry: 1000\n\n'

server/handlers/api/status.py

@@ -1,16 +1,26 @@
 import json
+from datetime import datetime
 
+import pytz
 import tornado
 
+from core.prometheus_metrics_handler import api_requests_counter
 from core.utils import serialize_everything
 
 
 # API request handler for /api/v1/status
 class APIStatusHandler(tornado.web.RequestHandler):
-    def initialize(self, status_data):
+    def initialize(self, status_data, web_server_metrics):
         self.status_data = status_data
+        self.web_server_metrics = web_server_metrics
 
     def get(self):
+        # Metrics
+        self.web_server_metrics["last_api_access_time"] = datetime.now(pytz.UTC)
+        self.web_server_metrics["api_access_counter"] += 1
+        self.web_server_metrics["status"] = "OK"
+        api_requests_counter.inc()
+
         self.write(json.dumps(self.status_data, default=serialize_everything))
         self.set_status(200)
         self.set_header("Cache-Control", "no-store")