Class CommandHandlers

gunicorn/ctl/handlers.py:17–585

Command handlers with access to arbiter state. All handler methods return dictionaries that will be sent as the response data.

class CommandHandlers:
    """
    Command handlers with access to arbiter state.

    All handler methods return dictionaries that will be sent
    as the response data.
    """

    def __init__(self, arbiter):
        """
        Initialize handlers with arbiter reference.

        Args:
            arbiter: The Gunicorn arbiter instance
        """
        self.arbiter = arbiter

    def show_workers(self) -> dict:
        """
        Return list of HTTP workers.

        Returns:
            Dictionary with workers list containing:
            - pid: Worker process ID
            - age: Worker age (spawn order)
            - requests: Number of requests handled (if available)
            - booted: Whether worker has finished booting
            - last_heartbeat: Seconds since last heartbeat
        """
        workers = []
        now = time.monotonic()

        for pid, worker in self.arbiter.WORKERS.items():
            try:
                last_update = worker.tmp.last_update()
                last_heartbeat = round(now - last_update, 2)
            except (OSError, ValueError):
                last_heartbeat = None

            workers.append({
                "pid": pid,
                "age": worker.age,
                "booted": worker.booted,
                "aborted": worker.aborted,
                "last_heartbeat": last_heartbeat,
            })

        # Sort by age (oldest first)
        workers.sort(key=lambda w: w["age"])

        return {"workers": workers, "count": len(workers)}

    def show_dirty(self) -> dict:
        """
        Return dirty workers and apps information.

        Returns:
            Dictionary with: