Skip to content

Moves API heartbeat to it's own thread. #7331

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.

Sign up for GitHub

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

Open
dkliban wants to merge 1 commit into
base: main
Choose a base branch
from
+20 −1
Open

Moves API heartbeat to it's own thread. #7331

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions CHANGES/7315.bugfix
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fixed bug where API process would miss heartbeats during long uploads.
20 changes: 19 additions & 1 deletion pulpcore/app/entrypoint.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
from logging import getLogger
import os
import sys
import threading
import time

import click
import django
Expand All @@ -22,9 +24,18 @@


class PulpApiWorker(SyncWorker):

def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.heartbeat_thread = None

def notify(self):
Copy link
Member

@mdellweg mdellweg Feb 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

First i thought, this is dead code. Now i think we have the opportunity to check in on the thread here.

super().notify()
self.heartbeat()

def _heartbeat_loop(self):
Copy link
Member

@mdellweg mdellweg Feb 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What happens if the thread dies?

while self.alive:
Copy link
Member

@mdellweg mdellweg Feb 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is this for?

self.heartbeat()
time.sleep(self.heartbeat_interval)

def heartbeat(self):
try:
Expand Down Expand Up @@ -76,6 +87,13 @@ def init_process(self):
logger.error(f"An API app with name {self.name} already exists in the database.")
exit(Arbiter.WORKER_BOOT_ERROR)

# Store heartbeat interval for the heartbeat thread
Copy link
Member

@mdellweg mdellweg Feb 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Store heartbeat interval for the heartbeat thread
# Store the value of one third of the desired API application's time to live to the heartbeat interval on the current instance to be accessible by the heartbeat thread.

:mild sarcasm:

self.heartbeat_interval = settings.API_APP_TTL // 3

# Start heartbeat thread before entering the main loop
Copy link
Member

@mdellweg mdellweg Feb 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now why don't we then put all of that stuff right before entering the main loop?

self.heartbeat_thread = threading.Thread(target=self._heartbeat_loop, daemon=True)
self.heartbeat_thread.start()

super().init_process()

def run(self):
Expand Down