Merge remote-tracking branch 'vector-im/j94/call-metrics-alternative'

Author: tulir

mautrix/api.py

@@ -20,12 +20,17 @@
 
 from mautrix.errors import make_request_error, MatrixConnectionError, MatrixRequestError
 from mautrix.util.logging import TraceLogger
+from mautrix.util.opt_prometheus import Counter
 from mautrix import __version__ as mautrix_version, __optional_imports__
 
 if __optional_imports__:
     # Safe to import, but it's not actually needed, so don't force-import the whole types module.
     from mautrix.types import JSON
 
+API_CALLS = Counter("bridge_matrix_api_calls",
+                    "The number of Matrix client API calls made", ("method",))
+API_CALLS_FAILED = Counter("bridge_matrix_api_calls_failed",
+                           "The number of Matrix client API calls which failed", ("method",))
 
 class APIPath(Enum):
     """
@@ -251,7 +256,8 @@ async def request(self, method: Method, path: PathBuilder | str,
                       content: dict | list | bytes | str | None = None,
                       headers: dict[str, str] | None = None,
                       query_params: Mapping[str, str] | None = None,
-                      retry_count: int | None = None) -> JSON:
+                      retry_count: int | None = None,
+                      metrics_method: str | None = "") -> JSON:
         """
         Make a raw Matrix API request.
 
@@ -295,8 +301,12 @@ async def request(self, method: Method, path: PathBuilder | str,
         backoff = 4
         while True:
             self._log_request(method, path, content, orig_content, query_params, req_id)
+            API_CALLS.labels(method=metrics_method).inc()
             try:
                 return await self._send(method, full_url, content, query_params, headers or {})
+            except Exception:
+                API_CALLS_FAILED.labels(method=metrics_method).inc()
+                raise
             except MatrixRequestError as e:
                 if retry_count > 0 and e.http_status in (502, 503, 504):
                     self.log.warning(f"Request #{req_id} failed with HTTP {e.http_status}, "

mautrix/appservice/api/appservice.py

@@ -167,7 +167,8 @@ def request(self, method: Method, path: PathBuilder,
                 content: Optional[Union[Dict, bytes, str]] = None, timestamp: Optional[int] = None,
                 headers: Optional[Dict[str, str]] = None,
                 query_params: Optional[Dict[str, Any]] = None,
-                retry_count: Optional[int] = None) -> Awaitable[Dict]:
+                retry_count: Optional[int] = None, metrics_method: Optional[str] = ""
+                ) -> Awaitable[Dict]:
         """
         Make a raw HTTP request, with optional AppService timestamp massaging and external_url
         setting.
@@ -193,7 +194,8 @@ def request(self, method: Method, path: PathBuilder,
         if not self.is_real_user:
             query_params["user_id"] = self.identity or self.bot_mxid
 
-        return super().request(method, path, content, headers, query_params, retry_count)
+        return super().request(method, path, content, headers, query_params, retry_count,
+                               metrics_method)
 
 
 class ChildAppServiceAPI(AppServiceAPI):

mautrix/client/api/events.py

@@ -54,7 +54,7 @@ def sync(self, since: SyncToken = None, timeout: int = 30000, filter_id: FilterI
             request["full_state"] = "true" if full_state else "false"
         if set_presence:
             request["set_presence"] = str(set_presence)
-        return self.api.request(Method.GET, Path.sync, query_params=request, retry_count=0)
+        return self.api.request(Method.GET, Path.sync, query_params=request, retry_count=0, metrics_method="sync")
 
     # endregion
     # region 8.3 Getting events for a room
@@ -76,7 +76,7 @@ async def get_event(self, room_id: RoomID, event_id: EventID) -> Event:
         .. _/event/{eventId} API reference:
             https://matrix.org/docs/spec/client_server/r0.5.0#get-matrix-client-r0-rooms-roomid-event-eventid
         """
-        content = await self.api.request(Method.GET, Path.rooms[room_id].event[event_id])
+        content = await self.api.request(Method.GET, Path.rooms[room_id].event[event_id], metrics_method="getEvent")
         try:
             return Event.deserialize(content)
         except SerializerError as e:
@@ -102,7 +102,8 @@ async def get_state_event(self, room_id: RoomID, event_type: EventType,
             https://matrix.org/docs/spec/client_server/r0.5.0#get-matrix-client-r0-rooms-roomid-state-eventtype-statekey
         """
         content = await self.api.request(Method.GET,
-                                         Path.rooms[room_id].state[event_type][state_key])
+                                         Path.rooms[room_id].state[event_type][state_key],
+                                         metrics_method="getStateEvent")
         try:
             return state_event_content_map[event_type].deserialize(content)
         except KeyError:
@@ -123,7 +124,7 @@ async def get_state(self, room_id: RoomID) -> List[StateEvent]:
         .. _/state API reference:
             https://matrix.org/docs/spec/client_server/r0.5.0#get-matrix-client-r0-rooms-roomid-state
         """
-        content = await self.api.request(Method.GET, Path.rooms[room_id].state)
+        content = await self.api.request(Method.GET, Path.rooms[room_id].state, metrics_method="getState")
         try:
             return [StateEvent.deserialize(event) for event in content]
         except SerializerError as e:
@@ -161,7 +162,7 @@ async def get_members(self, room_id: RoomID, at: Optional[SyncToken] = None,
         if not_membership:
             query["not_membership"] = not_membership.value
         content = await self.api.request(Method.GET, Path.rooms[room_id].members,
-                                         query_params=query)
+                                         query_params=query, metrics_method="getMembers")
         try:
             return [StateEvent.deserialize(event) for event in content["chunk"]]
         except KeyError:
@@ -188,7 +189,7 @@ async def get_joined_members(self, room_id: RoomID) -> Dict[UserID, Member]:
         .. _/members:
             https://matrix.org/docs/spec/client_server/r0.5.0#get-matrix-client-r0-rooms-roomid-members
         """
-        content = await self.api.request(Method.GET, Path.rooms[room_id].joined_members)
+        content = await self.api.request(Method.GET, Path.rooms[room_id].joined_members, metrics_method="getJoinedMembers")
         try:
             return {user_id: Member(membership=Membership.JOIN,
                                     displayname=member.get("display_name", ""),
@@ -234,7 +235,7 @@ async def get_messages(self, room_id: RoomID, direction: PaginationDirection,
             "filter_json": filter_json,
         }
         content = await self.api.request(Method.GET, Path.rooms[room_id].messages,
-                                         query_params=query_params)
+                                         query_params=query_params, metrics_method="getMessages")
         try:
             return PaginatedMessages(content["start"], content["end"],
                                      [Event.deserialize(event) for event in content["chunk"]])
@@ -276,7 +277,7 @@ async def send_state_event(self, room_id: RoomID, event_type: EventType,
         """
         content = content.serialize() if isinstance(content, Serializable) else content
         resp = await self.api.request(Method.PUT, Path.rooms[room_id].state[event_type][state_key],
-                                      content, **kwargs)
+                                      content, **kwargs, metrics_method="sendStateEvent")
         try:
             return resp["event_id"]
         except KeyError:
@@ -311,7 +312,7 @@ async def send_message_event(self, room_id: RoomID, event_type: EventType,
             raise ValueError("Event type not given")
         url = Path.rooms[room_id].send[event_type][txn_id or self.api.get_txn_id()]
         content = content.serialize() if isinstance(content, Serializable) else content
-        resp = await self.api.request(Method.PUT, url, content, **kwargs)
+        resp = await self.api.request(Method.PUT, url, content, **kwargs, metrics_method="sendMessageEvent")
         try:
             return resp["event_id"]
         except KeyError:
@@ -515,7 +516,7 @@ async def redact(self, room_id: RoomID, event_id: EventID, reason: Optional[str]
             https://matrix.org/docs/spec/client_server/r0.5.0#put-matrix-client-r0-rooms-roomid-redact-eventid-txnid
         """
         url = Path.rooms[room_id].redact[event_id][self.api.get_txn_id()]
-        resp = await self.api.request(Method.PUT, url, content={"reason": reason}, **kwargs)
+        resp = await self.api.request(Method.PUT, url, content={"reason": reason}, **kwargs, metrics_method="redact")
         try:
             return resp["event_id"]
         except KeyError:

pyproject.toml

@@ -0,0 +1,9 @@
+[tool.isort]
+profile = "black"
+force_to_top = "typing"
+from_first = true
+line_length = 99
+
+[tool.black]
+line-length = 99
+target-version = ["py37"]