1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
|
import contextlib
import errno
import logging
import os
import signal
import time
from collections.abc import Iterable
from enum import Enum
from multiprocessing import Process
# TODO: Change import path to "collections.abc" after we stop supporting Python 3.8
from typing import TYPE_CHECKING, NamedTuple, Optional, Union
from uuid import uuid4
from redis import ConnectionPool, Redis
from rq.serializers import DefaultSerializer
from .connections import parse_connection
from .defaults import DEFAULT_LOGGING_DATE_FORMAT, DEFAULT_LOGGING_FORMAT
from .job import Job
from .logutils import setup_loghandlers
from .queue import Queue
from .utils import parse_names
from .worker import BaseWorker, Worker
if TYPE_CHECKING:
from rq.serializers import Serializer
class WorkerData(NamedTuple):
name: str
pid: int
process: Process
class WorkerPool:
class Status(Enum):
IDLE = 1
STARTED = 2
STOPPED = 3
def __init__(
self,
queues: Iterable[Union[str, Queue]],
connection: Redis,
num_workers: int = 1,
worker_class: type[BaseWorker] = Worker,
serializer: 'Serializer' = DefaultSerializer,
job_class: type[Job] = Job,
queue_class: type[Queue] = Queue,
*args,
**kwargs,
):
self.num_workers: int = num_workers
self._workers: list[Worker] = []
setup_loghandlers('INFO', DEFAULT_LOGGING_DATE_FORMAT, DEFAULT_LOGGING_FORMAT, name=__name__)
self.log: logging.Logger = logging.getLogger(__name__)
# self.log: logging.Logger = logger
self._queue_names: list[str] = parse_names(queues)
self.connection = connection
self.name: str = uuid4().hex
self._burst: bool = True
self._sleep: int = 0
self.status: self.Status = self.Status.IDLE # type: ignore
self.worker_class: type[BaseWorker] = worker_class
self.serializer: Serializer = serializer
self.job_class: type[Job] = job_class
self.queue_class: type[Queue] = queue_class
# A dictionary of WorkerData keyed by worker name
self.worker_dict: dict[str, WorkerData] = {}
self._connection_class, self._pool_class, self._pool_kwargs = parse_connection(connection)
@property
def queues(self) -> list[Queue]:
"""Returns a list of Queue objects"""
return [self.queue_class(name, connection=self.connection) for name in self._queue_names]
@property
def number_of_active_workers(self) -> int:
"""Returns a list of Queue objects"""
return len(self.worker_dict)
def _install_signal_handlers(self):
"""Installs signal handlers for handling SIGINT and SIGTERM
gracefully.
"""
signal.signal(signal.SIGINT, self.request_stop)
signal.signal(signal.SIGTERM, self.request_stop)
def request_stop(self, signum=None, frame=None):
"""Toggle self._stop_requested that's checked on every loop"""
self.log.info('Received SIGINT/SIGTERM, shutting down...')
self.status = self.Status.STOPPED
self.stop_workers()
def all_workers_have_stopped(self) -> bool:
"""Returns True if all workers have stopped."""
self.reap_workers()
# `bool(self.worker_dict)` sometimes returns True even if the dict is empty
return self.number_of_active_workers == 0
def reap_workers(self):
"""Removes dead workers from worker_dict"""
self.log.debug('Reaping dead workers')
worker_datas = list(self.worker_dict.values())
for data in worker_datas:
data.process.join(0.1)
if data.process.is_alive():
self.log.debug('Worker %s with pid %d is alive', data.name, data.pid)
else:
self.handle_dead_worker(data)
continue
# I'm still not sure why this is sometimes needed, temporarily commenting
# this out until I can figure it out.
# with contextlib.suppress(HorseMonitorTimeoutException):
# with UnixSignalDeathPenalty(1, HorseMonitorTimeoutException):
# try:
# # If wait4 returns, the process is dead
# os.wait4(data.process.pid, 0) # type: ignore
# self.handle_dead_worker(data)
# except ChildProcessError:
# # Process is dead
# self.handle_dead_worker(data)
# continue
def handle_dead_worker(self, worker_data: WorkerData):
"""
Handle a dead worker
"""
self.log.info('Worker %s with pid %d is dead', worker_data.name, worker_data.pid)
with contextlib.suppress(KeyError):
self.worker_dict.pop(worker_data.name)
def check_workers(self, respawn: bool = True) -> None:
"""
Check whether workers are still alive
"""
self.log.debug('Checking worker processes')
self.reap_workers()
# If we have less number of workers than num_workers,
# respawn the difference
if respawn and self.status != self.Status.STOPPED:
delta = self.num_workers - len(self.worker_dict)
if delta:
for i in range(delta):
self.start_worker(burst=self._burst, _sleep=self._sleep)
def get_worker_process(
self,
name: str,
burst: bool,
_sleep: float = 0,
logging_level: str = 'INFO',
) -> Process:
"""Returns the worker process"""
return Process(
target=run_worker,
args=(name, self._queue_names, self._connection_class, self._pool_class, self._pool_kwargs),
kwargs={
'_sleep': _sleep,
'burst': burst,
'logging_level': logging_level,
'worker_class': self.worker_class,
'job_class': self.job_class,
'serializer': self.serializer,
},
name=f'Worker {name} (WorkerPool {self.name})',
)
def start_worker(
self,
count: Optional[int] = None,
burst: bool = True,
_sleep: float = 0,
logging_level: str = 'INFO',
):
"""
Starts a worker and adds the data to worker_datas.
* sleep: waits for X seconds before creating worker, for testing purposes
"""
name = uuid4().hex
process = self.get_worker_process(name, burst=burst, _sleep=_sleep, logging_level=logging_level)
process.start()
worker_data = WorkerData(name=name, pid=process.pid, process=process) # type: ignore
self.worker_dict[name] = worker_data
self.log.debug('Spawned worker: %s with PID %d', name, process.pid)
def start_workers(self, burst: bool = True, _sleep: float = 0, logging_level: str = 'INFO'):
"""
Run the workers
* sleep: waits for X seconds before creating worker, only for testing purposes
"""
self.log.debug(f'Spawning {self.num_workers} workers')
for i in range(self.num_workers):
self.start_worker(i + 1, burst=burst, _sleep=_sleep, logging_level=logging_level)
def stop_worker(self, worker_data: WorkerData, sig=signal.SIGINT):
"""
Send stop signal to worker and catch "No such process" error if the worker is already dead.
"""
try:
os.kill(worker_data.pid, sig)
self.log.info('Sent shutdown command to worker with %s', worker_data.pid)
except OSError as e:
if e.errno == errno.ESRCH:
# "No such process" is fine with us
self.log.debug('Horse already dead')
else:
raise
def stop_workers(self):
"""Send SIGINT to all workers"""
self.log.info('Sending stop signal to %s workers', len(self.worker_dict))
worker_datas = list(self.worker_dict.values())
for worker_data in worker_datas:
self.stop_worker(worker_data)
def start(self, burst: bool = False, logging_level: str = 'INFO'):
self._burst = burst
respawn = not burst # Don't respawn workers if burst mode is on
setup_loghandlers(logging_level, DEFAULT_LOGGING_DATE_FORMAT, DEFAULT_LOGGING_FORMAT, name=__name__)
self.log.info(f'Starting worker pool {self.name} with pid %d...', os.getpid())
self.status = self.Status.STARTED
self.start_workers(burst=self._burst, logging_level=logging_level)
self._install_signal_handlers()
while True:
if self.status == self.Status.STOPPED:
if self.all_workers_have_stopped():
self.log.info('All workers stopped, exiting...')
break
else:
self.log.info('Waiting for workers to shutdown...')
time.sleep(1)
continue
else:
self.check_workers(respawn=respawn)
if burst and self.number_of_active_workers == 0:
self.log.info('All workers stopped, exiting...')
break
time.sleep(1)
def run_worker(
worker_name: str,
queue_names: Iterable[str],
connection_class,
connection_pool_class,
connection_pool_kwargs: dict,
worker_class: type[BaseWorker] = Worker,
serializer: 'Serializer' = DefaultSerializer,
job_class: type[Job] = Job,
queue_class: type[Queue] = Queue,
burst: bool = True,
logging_level: str = 'INFO',
_sleep: int = 0,
):
connection = connection_class(
connection_pool=ConnectionPool(connection_class=connection_pool_class, **connection_pool_kwargs)
)
queues = [queue_class(name, connection=connection) for name in queue_names]
worker = worker_class(
queues,
name=worker_name,
connection=connection,
serializer=serializer,
job_class=job_class,
queue_class=queue_class,
)
worker.log.info('Starting worker started with PID %s', os.getpid())
time.sleep(_sleep)
worker.work(burst=burst, with_scheduler=True, logging_level=logging_level)
|