Remove: tracers (APM) for all protocols (#23)

Having a tracer on every packet send/received has a non-zero impact
on CPU usage, and we do almost nothing with the results.

Author: TrueBrain

openttd_protocol/protocol/content.py

@@ -2,7 +2,6 @@
 import logging
 import struct
 
-from .. import tracer
 from ..wire.exceptions import PacketInvalidData
 from ..wire.read import (
     read_string,
@@ -72,7 +71,6 @@ class ContentProtocol(TCPProtocol):
     PACKET_END = PacketContentType.PACKET_CONTENT_END
 
     @staticmethod
-    @tracer.traced("content")
     def receive_PACKET_CONTENT_CLIENT_INFO_LIST(source, data):
         content_type, data = read_uint8(data)
         openttd_version, data = read_uint32(data)
@@ -143,7 +141,6 @@ def _receive_client_info(data, count, has_content_id=False, has_content_type_and
         return content_infos, data
 
     @classmethod
-    @tracer.traced("content")
     def receive_PACKET_CONTENT_CLIENT_INFO_ID(cls, source, data):
         count, data = read_uint16(data)
 
@@ -155,7 +152,6 @@ def receive_PACKET_CONTENT_CLIENT_INFO_ID(cls, source, data):
         return {"content_infos": content_infos}
 
     @classmethod
-    @tracer.traced("content")
     def receive_PACKET_CONTENT_CLIENT_INFO_EXTID(cls, source, data):
         count, data = read_uint8(data)
 
@@ -167,7 +163,6 @@ def receive_PACKET_CONTENT_CLIENT_INFO_EXTID(cls, source, data):
         return {"content_infos": content_infos}
 
     @classmethod
-    @tracer.traced("content")
     def receive_PACKET_CONTENT_CLIENT_INFO_EXTID_MD5(cls, source, data):
         count, data = read_uint8(data)
 
@@ -181,7 +176,6 @@ def receive_PACKET_CONTENT_CLIENT_INFO_EXTID_MD5(cls, source, data):
         return {"content_infos": content_infos}
 
     @classmethod
-    @tracer.traced("content")
     def receive_PACKET_CONTENT_CLIENT_CONTENT(cls, source, data):
         count, data = read_uint16(data)
 
@@ -192,7 +186,6 @@ def receive_PACKET_CONTENT_CLIENT_CONTENT(cls, source, data):
 
         return {"content_infos": content_infos}
 
-    @tracer.traced("content")
     async def send_PACKET_CONTENT_SERVER_INFO(
         self, content_type, content_id, filesize, name, version, url, description, unique_id, md5sum, dependencies, tags
     ):
@@ -234,7 +227,6 @@ async def send_PACKET_CONTENT_SERVER_INFO(
         write_presend(data, SEND_TCP_COMPAT_MTU)
         await self.send_packet(data)
 
-    @tracer.traced("content")
     async def send_PACKET_CONTENT_SERVER_CONTENT(self, content_type, content_id, filesize, filename, stream):
         # First, send a packet to tell the client it will be receiving a file
         data = write_init(PacketContentType.PACKET_CONTENT_SERVER_CONTENT)

openttd_protocol/protocol/coordinator.py

@@ -1,7 +1,6 @@
 import enum
 import logging
 
-from .. import tracer
 from ..wire.exceptions import PacketInvalidData
 from ..wire.read import (
     read_bytes,
@@ -95,7 +94,6 @@ class CoordinatorProtocol(TCPProtocol):
     PACKET_END = PacketCoordinatorType.PACKET_COORDINATOR_END
 
     @staticmethod
-    @tracer.traced("coordinator")
     def receive_PACKET_COORDINATOR_SERVER_REGISTER(source, data):
         protocol_version, data = read_uint8(data)
 
@@ -130,7 +128,6 @@ def receive_PACKET_COORDINATOR_SERVER_REGISTER(source, data):
         }
 
     @staticmethod
-    @tracer.traced("coordinator")
     def receive_PACKET_COORDINATOR_SERVER_UPDATE(source, data):
         protocol_version, data = read_uint8(data)
 
@@ -243,7 +240,6 @@ def receive_PACKET_COORDINATOR_SERVER_UPDATE(source, data):
         }
 
     @staticmethod
-    @tracer.traced("coordinator")
     def receive_PACKET_COORDINATOR_CLIENT_LISTING(source, data):
         protocol_version, data = read_uint8(data)
 
@@ -272,7 +268,6 @@ def receive_PACKET_COORDINATOR_CLIENT_LISTING(source, data):
         }
 
     @staticmethod
-    @tracer.traced("coordinator")
     def receive_PACKET_COORDINATOR_CLIENT_CONNECT(source, data):
         protocol_version, data = read_uint8(data)
 
@@ -290,7 +285,6 @@ def receive_PACKET_COORDINATOR_CLIENT_CONNECT(source, data):
         }
 
     @staticmethod
-    @tracer.traced("coordinator")
     def receive_PACKET_COORDINATOR_SERCLI_CONNECT_FAILED(source, data):
         protocol_version, data = read_uint8(data)
 
@@ -310,7 +304,6 @@ def receive_PACKET_COORDINATOR_SERCLI_CONNECT_FAILED(source, data):
         }
 
     @staticmethod
-    @tracer.traced("coordinator")
     def receive_PACKET_COORDINATOR_CLIENT_CONNECTED(source, data):
         protocol_version, data = read_uint8(data)
 
@@ -328,7 +321,6 @@ def receive_PACKET_COORDINATOR_CLIENT_CONNECTED(source, data):
         }
 
     @staticmethod
-    @tracer.traced("coordinator")
     def receive_PACKET_COORDINATOR_SERCLI_STUN_RESULT(source, data):
         protocol_version, data = read_uint8(data)
 
@@ -349,7 +341,6 @@ def receive_PACKET_COORDINATOR_SERCLI_STUN_RESULT(source, data):
             "result": result,
         }
 
-    @tracer.traced("coordinator")
     async def send_PACKET_COORDINATOR_GC_ERROR(self, protocol_version, error_no, error_detail):
         data = write_init(PacketCoordinatorType.PACKET_COORDINATOR_GC_ERROR)
 
@@ -367,7 +358,6 @@ async def send_PACKET_COORDINATOR_GC_ERROR(self, protocol_version, error_no, err
         write_presend(data, SEND_TCP_MTU)
         await self.send_packet(data)
 
-    @tracer.traced("coordinator")
     async def send_PACKET_COORDINATOR_GC_REGISTER_ACK(
         self, protocol_version, connection_type, invite_code, invite_code_secret
     ):
@@ -406,7 +396,6 @@ def _fill_NEWGRF_LOOKUP_PACKET(self, newgrf_lookup_table_cursor, newgrf_lookup_t
         if count != 0:
             yield count, data
 
-    @tracer.traced("coordinator")
     async def send_PACKET_COORDINATOR_GC_NEWGRF_LOOKUP(
         self, protocol_version, newgrf_lookup_table_cursor, newgrf_lookup_table
     ):
@@ -424,7 +413,6 @@ async def send_PACKET_COORDINATOR_GC_NEWGRF_LOOKUP(
             write_presend(data, SEND_TCP_MTU)
             await self.send_packet(data)
 
-    @tracer.traced("coordinator")
     async def send_PACKET_COORDINATOR_GC_LISTING(
         self, protocol_version, game_info_version, servers, newgrf_lookup_table
     ):
@@ -503,7 +491,6 @@ async def send_PACKET_COORDINATOR_GC_LISTING(
         write_presend(data, SEND_TCP_MTU)
         await self.send_packet(data)
 
-    @tracer.traced("coordinator")
     async def send_PACKET_COORDINATOR_GC_CONNECTING(self, protocol_version, token, invite_code):
         data = write_init(PacketCoordinatorType.PACKET_COORDINATOR_GC_CONNECTING)
 
@@ -513,7 +500,6 @@ async def send_PACKET_COORDINATOR_GC_CONNECTING(self, protocol_version, token, i
         write_presend(data, SEND_TCP_MTU)
         await self.send_packet(data)
 
-    @tracer.traced("coordinator")
     async def send_PACKET_COORDINATOR_GC_CONNECT_FAILED(self, protocol_version, token):
         data = write_init(PacketCoordinatorType.PACKET_COORDINATOR_GC_CONNECT_FAILED)
 
@@ -522,7 +508,6 @@ async def send_PACKET_COORDINATOR_GC_CONNECT_FAILED(self, protocol_version, toke
         write_presend(data, SEND_TCP_MTU)
         await self.send_packet(data)
 
-    @tracer.traced("coordinator")
     async def send_PACKET_COORDINATOR_GC_DIRECT_CONNECT(self, protocol_version, token, tracking_number, hostname, port):
         data = write_init(PacketCoordinatorType.PACKET_COORDINATOR_GC_DIRECT_CONNECT)
 
@@ -534,7 +519,6 @@ async def send_PACKET_COORDINATOR_GC_DIRECT_CONNECT(self, protocol_version, toke
         write_presend(data, SEND_TCP_MTU)
         await self.send_packet(data)
 
-    @tracer.traced("coordinator")
     async def send_PACKET_COORDINATOR_GC_STUN_REQUEST(self, protocol_version, token):
         data = write_init(PacketCoordinatorType.PACKET_COORDINATOR_GC_STUN_REQUEST)
 
@@ -543,7 +527,6 @@ async def send_PACKET_COORDINATOR_GC_STUN_REQUEST(self, protocol_version, token)
         write_presend(data, SEND_TCP_MTU)
         await self.send_packet(data)
 
-    @tracer.traced("coordinator")
     async def send_PACKET_COORDINATOR_GC_STUN_CONNECT(
         self, protocol_version, token, tracking_number, interface_number, hostname, port
     ):
@@ -558,7 +541,6 @@ async def send_PACKET_COORDINATOR_GC_STUN_CONNECT(
         write_presend(data, SEND_TCP_MTU)
         await self.send_packet(data)
 
-    @tracer.traced("coordinator")
     async def send_PACKET_COORDINATOR_GC_TURN_CONNECT(
         self, protocol_version, token, tracking_number, ticket, connection_string
     ):

openttd_protocol/protocol/game.py

@@ -1,7 +1,6 @@
 import enum
 import logging
 
-from .. import tracer
 from ..wire.exceptions import PacketInvalidData
 from ..wire.read import (
     read_bytes,
@@ -54,7 +53,6 @@ class GameProtocol(TCPProtocol):
     PACKET_END = PacketGameType.PACKET_END
 
     @staticmethod
-    @tracer.traced("game")
     def receive_PACKET_SERVER_GAME_INFO(source, data):
         game_info_version, data = read_uint8(data)
 
@@ -160,14 +158,12 @@ def receive_PACKET_SERVER_GAME_INFO(source, data):
         }
 
     @staticmethod
-    @tracer.traced("game")
     def receive_PACKET_SERVER_SHUTDOWN(source, data):
         if len(data) != 0:
             raise PacketInvalidData("more bytes than expected in SERVER_SHUTDOWN; remaining: ", len(data))
 
         return {}
 
-    @tracer.traced("game")
     async def send_PACKET_CLIENT_GAME_INFO(self):
         data = write_init(PacketGameType.PACKET_CLIENT_GAME_INFO)
         write_presend(data, SEND_TCP_MTU)

openttd_protocol/protocol/stun.py

@@ -1,7 +1,6 @@
 import enum
 import logging
 
-from .. import tracer
 from ..wire.exceptions import PacketInvalidData
 from ..wire.read import (
     read_string,
@@ -22,7 +21,6 @@ class StunProtocol(TCPProtocol):
     PACKET_END = PacketStunType.PACKET_STUN_END
 
     @staticmethod
-    @tracer.traced("stun")
     def receive_PACKET_STUN_SERCLI_STUN(source, data):
         protocol_version, data = read_uint8(data)
 

openttd_protocol/protocol/turn.py

@@ -1,7 +1,6 @@
 import enum
 import logging
 
-from .. import tracer
 from ..wire.exceptions import PacketInvalidData
 from ..wire.read import (
     read_string,
@@ -30,7 +29,6 @@ class TurnProtocol(TCPProtocol):
     PACKET_END = PacketTurnType.PACKET_TURN_END
 
     @staticmethod
-    @tracer.traced("turn")
     def receive_PACKET_TURN_SERCLI_CONNECT(source, data):
         protocol_version, data = read_uint8(data)
 
@@ -44,7 +42,6 @@ def receive_PACKET_TURN_SERCLI_CONNECT(source, data):
 
         return {"protocol_version": protocol_version, "ticket": ticket}
 
-    @tracer.traced("turn")
     async def send_PACKET_TURN_TURN_CONNECTED(self, protocol_version, hostname):
         data = write_init(PacketTurnType.PACKET_TURN_TURN_CONNECTED)
 

openttd_protocol/tracer.py

@@ -14,7 +14,6 @@
     read_uint16,
 )
 from .source import Source
-from .. import tracer
 
 log = logging.getLogger(__name__)
 
@@ -174,17 +173,14 @@ async def _process_queue(self):
             if await self._callback.receive_raw(self.source, data):
                 return
 
-        with tracer.tracer("tcp.receive-packet"):
-            try:
-                packet_type, kwargs = self.receive_packet(self.source, data)
-            except PacketInvalid as err:
-                log.info("Dropping invalid packet from %s:%d: %r", self.source.ip, self.source.port, err)
-                raise SocketClosed
+        try:
+            packet_type, kwargs = self.receive_packet(self.source, data)
+        except PacketInvalid as err:
+            log.info("Dropping invalid packet from %s:%d: %r", self.source.ip, self.source.port, err)
+            raise SocketClosed
 
-            with tracer.tracer("tcp.packet-handler"):
-                await getattr(self._callback, f"receive_{packet_type.name}")(self.source, **kwargs)
+        await getattr(self._callback, f"receive_{packet_type.name}")(self.source, **kwargs)
 
-    @tracer.traced("tcp")
     def receive_packet(self, source, data):
         # Check length of packet
         length, data = read_uint16(data)
@@ -202,13 +198,10 @@ def receive_packet(self, source, data):
         if func is None:
             raise PacketInvalidType(packet_type)
 
-        tracer.add_trace_field("command", f"receive.{packet_type.name}")
-
         # Process this packet
         kwargs = func(source, data)
         return packet_type, kwargs
 
-    @tracer.traced("tcp")
     async def send_packet(self, data):
         await self._can_write.wait()