Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve import stats performance by emitting start and end together #2417

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 44 additions & 35 deletions modal/_telemetry.py
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ def get_resource_reader(self, fullname: str):


class ImportInterceptor(importlib.abc.MetaPathFinder):
loading: typing.Dict[str, typing.Tuple[str, float]]
loading: typing.Dict[str, float]
tracing_socket: socket.socket
events: queue.Queue

Expand All @@ -78,7 +78,7 @@ def connect(cls, socket_filename: str) -> "ImportInterceptor":
def __init__(self, tracing_socket: socket.socket):
self.loading = {}
self.tracing_socket = tracing_socket
self.events = queue.Queue(maxsize=16 * 1024)
self.events = queue.Queue(maxsize=8 * 1024)
sender = threading.Thread(target=self._send, daemon=True)
sender.start()

Expand All @@ -95,51 +95,60 @@ def find_spec(self, fullname, path, target=None):

def load_start(self, name):
t0 = time.monotonic()
span_id = str(uuid.uuid4())
self.emit(
{"span_id": span_id, "timestamp": time.time(), "event": MODULE_LOAD_START, "attributes": {"name": name}}
)
self.loading[name] = (span_id, t0)
self.loading[name] = t0

def load_end(self, name):
span_id, t0 = self.loading.pop(name, (None, None))
t1 = time.monotonic()
timestamp1 = time.time()

t0 = self.loading.pop(name, None)
if t0 is None:
return
latency = time.monotonic() - t0
self.emit(
{
"span_id": span_id,
"timestamp": time.time(),
"event": MODULE_LOAD_END,
"attributes": {
"name": name,
"latency": latency,
},
}
)

def emit(self, event):

span_id = str(uuid.uuid4())
latency = t1 - t0
timestamp0 = timestamp1 - latency

event_start = {
"span_id": span_id,
"timestamp": timestamp0,
"event": MODULE_LOAD_START,
"attributes": {"name": name},
}
event_end = {
"span_id": span_id,
"timestamp": timestamp1,
"event": MODULE_LOAD_END,
"attributes": {
"name": name,
"latency": latency,
},
}
self.emit((event_start, event_end))

def emit(self, events):
try:
self.events.put_nowait(event)
self.events.put_nowait(events)
except queue.Full:
logger.debug("failed to emit event: queue full")

def _send(self):
while True:
event = self.events.get()
try:
msg = json.dumps(event).encode("utf-8")
except BaseException as e:
logger.debug(f"failed to serialize event: {e}")
continue
try:
encoded_len = pack(MESSAGE_HEADER_FORMAT, len(msg))
self.tracing_socket.send(encoded_len + msg)
except OSError as e:
logger.debug(f"failed to send event: {e}")
events = self.events.get()
for event in events:
try:
msg = json.dumps(event).encode("utf-8")
except BaseException as e:
logger.debug(f"failed to serialize event: {e}")
continue
try:
encoded_len = pack(MESSAGE_HEADER_FORMAT, len(msg))
self.tracing_socket.send(encoded_len + msg)
except OSError as e:
logger.debug(f"failed to send event: {e}")

def install(self):
sys.meta_path = [self] + sys.meta_path # type: ignore
sys.meta_path.insert(0, self) # type: ignore

def remove(self):
sys.meta_path.remove(self) # type: ignore
Expand Down
16 changes: 9 additions & 7 deletions test/telemetry_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,9 @@ def _listen(self):
while not self.stopped:
try:
conn, _ = self.server.accept()
self.connections.add(conn)
receiver = threading.Thread(target=self._recv, args=(conn,), daemon=True)
receiver.start()
self.connections.add(conn)
except OSError as e:
logging.debug(f"listener got exception, exiting: {e}")
return
Expand Down Expand Up @@ -102,9 +102,9 @@ def test_import_tracing(monkeypatch):
from .telemetry import tracing_module_1 # noqa

expected_messages: list[typing.Dict[str, typing.Any]] = [
{"event": "module_load_start", "attributes": {"name": "test.telemetry.tracing_module_1"}},
{"event": "module_load_start", "attributes": {"name": "test.telemetry.tracing_module_2"}},
{"event": "module_load_end", "attributes": {"name": "test.telemetry.tracing_module_2"}},
{"event": "module_load_start", "attributes": {"name": "test.telemetry.tracing_module_1"}},
{"event": "module_load_end", "attributes": {"name": "test.telemetry.tracing_module_1"}},
]

Expand All @@ -122,22 +122,24 @@ def test_import_tracing(monkeypatch):


# For manual testing
def generate_import_telemetry(telemetry_socket):
def generate_import_telemetry(import_name, telemetry_socket):
instrument_imports(telemetry_socket)
t0 = time.monotonic()
import kubernetes # noqa
__import__(import_name)

return time.monotonic() - t0


# For manual testing
def main():
import_name = sys.argv[1] if len(sys.argv) >= 2 else "kubernetes"
telemetry_socket = os.environ.get("MODAL_TELEMETRY_SOCKET")
if telemetry_socket:
latency = generate_import_telemetry(telemetry_socket)
latency = generate_import_telemetry(import_name, telemetry_socket)
else:
with TelemetryConsumer() as consumer:
latency = generate_import_telemetry(consumer.socket_filename.absolute().as_posix())
telemetry_socket = consumer.socket_filename.absolute().as_posix()
latency = generate_import_telemetry(import_name, telemetry_socket)

while True:
try:
Expand All @@ -146,7 +148,7 @@ def main():
except queue.Empty:
break

print(f"import kubernetes took {latency:.02}s")
print(f"'import {import_name}' took {latency:.02}s")


if __name__ == "__main__":
Expand Down
Loading