Add prometheus metrics (#527)

changelog.d/527.misc

@@ -0,0 +1 @@
+Add some prometheus metrics and make `prometheus_client` dependency mandatory.

pyproject.toml

@@ -62,7 +62,6 @@ mypy_path = "stubs"
 module = [
     "idna",
     "netaddr",
-    "prometheus_client",
     "signedjson.*",
     "sortedcontainers",
 ]
@@ -101,7 +100,7 @@ netaddr = ">=0.7.0"
 matrix-common = "^1.1.0"
 phonenumbers = ">=8.12.32"
 # prometheus-client's lower bound is copied from Synapse.
-prometheus-client = { version = ">=0.4.0", optional = true }
+prometheus-client = ">=0.4.0"
 pynacl = ">=1.2.1"
 pyOpenSSL = ">=16.0.0"
 pyyaml = ">=3.11"

stubs/twisted/web/resource.pyi

@@ -1,5 +1,6 @@
-from typing import ClassVar
+from typing import Any, ClassVar
 
+from twisted.web.server import Request
 from zope.interface import Interface, implementer
 
 class IResource(Interface):
@@ -11,3 +12,4 @@ class IResource(Interface):
 class Resource:
     isLeaf: ClassVar[bool]
     def putChild(self, path: bytes, child: IResource) -> None: ...
+    def render(self, request: Request) -> Any: ...

sydent/http/servlets/__init__.py

@@ -18,6 +18,7 @@
 import logging
 from typing import Any, Awaitable, Callable, Dict, Iterable, TypeVar
 
+from prometheus_client import Counter
 from twisted.internet import defer
 from twisted.web import server
 from twisted.web.resource import Resource
@@ -29,6 +30,25 @@
 logger = logging.getLogger(__name__)
 
 
+request_counter = Counter(
+    "sydent_http_received_requests",
+    "Received requests",
+    labelnames=("servlet", "method"),
+)
+
+
+class SydentResource(Resource):
+    """A subclass of resource that tracks request metrics"""
+
+    def __init__(self) -> None:
+        self._name = self.__class__.__name__
+        super().__init__()
+
+    def render(self, request: Request) -> Any:
+        request_counter.labels(self._name, request.method).inc()
+        return super().render(request)
+
+
 class MatrixRestError(Exception):
     """
     Handled by the jsonwrap wrapper. Any servlets that don't use this

sydent/http/servlets/accountservlet.py

@@ -14,22 +14,21 @@
 
 from typing import TYPE_CHECKING
 
-from twisted.web.resource import Resource
 from twisted.web.server import Request
 
 from sydent.http.auth import authV2
-from sydent.http.servlets import jsonwrap, send_cors
+from sydent.http.servlets import SydentResource, jsonwrap, send_cors
 from sydent.types import JsonDict
 
 if TYPE_CHECKING:
     from sydent.sydent import Sydent
 
 
-class AccountServlet(Resource):
+class AccountServlet(SydentResource):
     isLeaf = False
 
     def __init__(self, syd: "Sydent") -> None:
-        Resource.__init__(self)
+        super().__init__()
         self.sydent = syd
 
     @jsonwrap

sydent/http/servlets/authenticated_bind_threepid_servlet.py

@@ -14,24 +14,23 @@
 
 from typing import TYPE_CHECKING
 
-from twisted.web.resource import Resource
 from twisted.web.server import Request
 
-from sydent.http.servlets import get_args, jsonwrap, send_cors
+from sydent.http.servlets import SydentResource, get_args, jsonwrap, send_cors
 from sydent.types import JsonDict
 
 if TYPE_CHECKING:
     from sydent.sydent import Sydent
 
 
-class AuthenticatedBindThreePidServlet(Resource):
+class AuthenticatedBindThreePidServlet(SydentResource):
     """A servlet which allows a caller to bind any 3pid they want to an mxid
 
     It is assumed that authentication happens out of band
     """
 
     def __init__(self, sydent: "Sydent") -> None:
-        Resource.__init__(self)
+        super().__init__()
         self.sydent = sydent
 
     @jsonwrap

sydent/http/servlets/authenticated_unbind_threepid_servlet.py

@@ -14,24 +14,23 @@
 
 from typing import TYPE_CHECKING
 
-from twisted.web.resource import Resource
 from twisted.web.server import Request
 
-from sydent.http.servlets import get_args, jsonwrap, send_cors
+from sydent.http.servlets import SydentResource, get_args, jsonwrap, send_cors
 from sydent.types import JsonDict
 
 if TYPE_CHECKING:
     from sydent.sydent import Sydent
 
 
-class AuthenticatedUnbindThreePidServlet(Resource):
+class AuthenticatedUnbindThreePidServlet(SydentResource):
     """A servlet which allows a caller to unbind any 3pid they want from an mxid
 
     It is assumed that authentication happens out of band
     """
 
     def __init__(self, sydent: "Sydent") -> None:
-        Resource.__init__(self)
+        super().__init__()
         self.sydent = sydent
 
     @jsonwrap

sydent/http/servlets/blindlysignstuffservlet.py

@@ -17,12 +17,17 @@
 
 import signedjson.key
 import signedjson.sign
-from twisted.web.resource import Resource
 from twisted.web.server import Request
 
 from sydent.db.invite_tokens import JoinTokenStore
 from sydent.http.auth import authV2
-from sydent.http.servlets import MatrixRestError, get_args, jsonwrap, send_cors
+from sydent.http.servlets import (
+    MatrixRestError,
+    SydentResource,
+    get_args,
+    jsonwrap,
+    send_cors,
+)
 from sydent.types import JsonDict
 
 if TYPE_CHECKING:
@@ -31,10 +36,11 @@
 logger = logging.getLogger(__name__)
 
 
-class BlindlySignStuffServlet(Resource):
+class BlindlySignStuffServlet(SydentResource):
     isLeaf = True
 
     def __init__(self, syd: "Sydent", require_auth: bool = False) -> None:
+        super().__init__()
         self.sydent = syd
         self.server_name = syd.config.general.server_name
         self.tokenStore = JoinTokenStore(syd)

sydent/http/servlets/bulklookupservlet.py

@@ -15,11 +15,16 @@
 import logging
 from typing import TYPE_CHECKING
 
-from twisted.web.resource import Resource
 from twisted.web.server import Request
 
 from sydent.db.threepid_associations import GlobalAssociationStore
-from sydent.http.servlets import MatrixRestError, get_args, jsonwrap, send_cors
+from sydent.http.servlets import (
+    MatrixRestError,
+    SydentResource,
+    get_args,
+    jsonwrap,
+    send_cors,
+)
 from sydent.types import JsonDict
 
 if TYPE_CHECKING:
@@ -28,10 +33,11 @@
 logger = logging.getLogger(__name__)
 
 
-class BulkLookupServlet(Resource):
+class BulkLookupServlet(SydentResource):
     isLeaf = True
 
     def __init__(self, syd: "Sydent") -> None:
+        super().__init__()
         self.sydent = syd
 
     @jsonwrap

sydent/http/servlets/emailservlet.py

@@ -14,11 +14,10 @@
 
 from typing import TYPE_CHECKING, Optional
 
-from twisted.web.resource import Resource
 from twisted.web.server import Request
 
 from sydent.http.auth import authV2
-from sydent.http.servlets import get_args, jsonwrap, send_cors
+from sydent.http.servlets import SydentResource, get_args, jsonwrap, send_cors
 from sydent.types import JsonDict
 from sydent.util.emailutils import EmailAddressException, EmailSendException
 from sydent.util.stringutils import MAX_EMAIL_ADDRESS_LENGTH, is_valid_client_secret
@@ -33,10 +32,11 @@
     from sydent.sydent import Sydent
 
 
-class EmailRequestCodeServlet(Resource):
+class EmailRequestCodeServlet(SydentResource):
     isLeaf = True
 
     def __init__(self, syd: "Sydent", require_auth: bool = False) -> None:
+        super().__init__()
         self.sydent = syd
         self.require_auth = require_auth
 
@@ -122,10 +122,11 @@ def render_OPTIONS(self, request: Request) -> bytes:
         return b""
 
 
-class EmailValidateCodeServlet(Resource):
+class EmailValidateCodeServlet(SydentResource):
     isLeaf = True
 
     def __init__(self, syd: "Sydent", require_auth: bool = False) -> None:
+        super().__init__()
         self.sydent = syd
         self.require_auth = require_auth
 

sydent/http/servlets/getvalidated3pidservlet.py

@@ -14,12 +14,11 @@
 
 from typing import TYPE_CHECKING
 
-from twisted.web.resource import Resource
 from twisted.web.server import Request
 
 from sydent.db.valsession import ThreePidValSessionStore
 from sydent.http.auth import authV2
-from sydent.http.servlets import get_args, jsonwrap, send_cors
+from sydent.http.servlets import SydentResource, get_args, jsonwrap, send_cors
 from sydent.types import JsonDict
 from sydent.util.stringutils import is_valid_client_secret
 from sydent.validators import (
@@ -33,10 +32,11 @@
     from sydent.sydent import Sydent
 
 
-class GetValidated3pidServlet(Resource):
+class GetValidated3pidServlet(SydentResource):
     isLeaf = True
 
     def __init__(self, syd: "Sydent", require_auth: bool = False) -> None:
+        super().__init__()
         self.sydent = syd
         self.require_auth = require_auth
 

sydent/http/servlets/hashdetailsservlet.py

@@ -15,11 +15,10 @@
 import logging
 from typing import TYPE_CHECKING
 
-from twisted.web.resource import Resource
 from twisted.web.server import Request
 
 from sydent.http.auth import authV2
-from sydent.http.servlets import jsonwrap, send_cors
+from sydent.http.servlets import SydentResource, jsonwrap, send_cors
 from sydent.types import JsonDict
 
 if TYPE_CHECKING:
@@ -28,11 +27,12 @@
 logger = logging.getLogger(__name__)
 
 
-class HashDetailsServlet(Resource):
+class HashDetailsServlet(SydentResource):
     isLeaf = True
     known_algorithms = ["sha256", "none"]
 
     def __init__(self, syd: "Sydent", lookup_pepper: str) -> None:
+        super().__init__()
         self.sydent = syd
         self.lookup_pepper = lookup_pepper
 

sydent/http/servlets/logoutservlet.py

@@ -15,12 +15,11 @@
 import logging
 from typing import TYPE_CHECKING
 
-from twisted.web.resource import Resource
 from twisted.web.server import Request
 
 from sydent.db.accounts import AccountStore
 from sydent.http.auth import authV2, tokenFromRequest
-from sydent.http.servlets import MatrixRestError, jsonwrap, send_cors
+from sydent.http.servlets import MatrixRestError, SydentResource, jsonwrap, send_cors
 from sydent.types import JsonDict
 
 if TYPE_CHECKING:
@@ -29,10 +28,11 @@
 logger = logging.getLogger(__name__)
 
 
-class LogoutServlet(Resource):
+class LogoutServlet(SydentResource):
     isLeaf = True
 
     def __init__(self, syd: "Sydent") -> None:
+        super().__init__()
         self.sydent = syd
 
     @jsonwrap

sydent/http/servlets/lookupservlet.py

@@ -17,11 +17,10 @@
 from typing import TYPE_CHECKING
 
 import signedjson.sign
-from twisted.web.resource import Resource
 from twisted.web.server import Request
 
 from sydent.db.threepid_associations import GlobalAssociationStore
-from sydent.http.servlets import get_args, jsonwrap, send_cors
+from sydent.http.servlets import SydentResource, get_args, jsonwrap, send_cors
 from sydent.types import JsonDict
 from sydent.util import json_decoder
 
@@ -31,10 +30,11 @@
 logger = logging.getLogger(__name__)
 
 
-class LookupServlet(Resource):
+class LookupServlet(SydentResource):
     isLeaf = True
 
     def __init__(self, syd: "Sydent") -> None:
+        super().__init__()
         self.sydent = syd
 
     @jsonwrap

sydent/http/servlets/lookupv2servlet.py

@@ -15,12 +15,11 @@
 import logging
 from typing import TYPE_CHECKING
 
-from twisted.web.resource import Resource
 from twisted.web.server import Request
 
 from sydent.db.threepid_associations import GlobalAssociationStore
 from sydent.http.auth import authV2
-from sydent.http.servlets import get_args, jsonwrap, send_cors
+from sydent.http.servlets import SydentResource, get_args, jsonwrap, send_cors
 from sydent.http.servlets.hashdetailsservlet import HashDetailsServlet
 from sydent.types import JsonDict
 
@@ -30,10 +29,11 @@
 logger = logging.getLogger(__name__)
 
 
-class LookupV2Servlet(Resource):
+class LookupV2Servlet(SydentResource):
     isLeaf = True
 
     def __init__(self, syd: "Sydent", lookup_pepper: str) -> None:
+        super().__init__()
         self.sydent = syd
         self.globalAssociationStore = GlobalAssociationStore(self.sydent)
         self.lookup_pepper = lookup_pepper