Files
neutron/neutron/worker.py
T
Rodolfo Alonso Hernandez aa18156e29 Add worker lifecycle DEBUG logging decorator
Introduce ``log_worker_lifecycle`` in ``neutron.common.utils`` to log
when worker start, wait, stop, and reset methods are called and
finished. Apply it to ``PeriodicWorker``, ``RpcWorker``,
``AllServicesNeutronWorker`` and ``BGPWorker``, so operators can trace
child process behavior at DEBUG level.

Related-Bug: #2154192
Signed-off-by: Rodolfo Alonso Hernandez <ralonsoh@redhat.com>
Change-Id: Iaac0993da9ecf0d1b587bb8c01e3683a0994b7c2
2026-05-26 15:55:39 +02:00

69 lines
2.3 KiB
Python

# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
from neutron_lib import worker
from oslo_config import cfg
from oslo_service import loopingcall
from neutron.common import utils as common_utils
class NeutronBaseWorker(worker.BaseWorker):
def __init__(self, worker_process_count=1, set_proctitle=None,
desc=None):
set_proctitle = set_proctitle or cfg.CONF.setproctitle
super().__init__(
worker_process_count=worker_process_count,
set_proctitle=set_proctitle,
desc=desc,
)
def start(self, name="neutron-server", desc=None):
super().start(name=name, desc=desc)
class PeriodicWorker(NeutronBaseWorker):
"""A worker that runs a function at a fixed interval."""
def __init__(self, check_func, interval, initial_delay,
desc=None):
super().__init__(worker_process_count=0, desc=desc)
self._check_func = check_func
self._loop = None
self._interval = interval
self._initial_delay = initial_delay
@common_utils.log_worker_lifecycle(lambda self: self.desc)
def start(self, **kwargs):
super().start()
if self._loop is None:
self._loop = loopingcall.FixedIntervalLoopingCall(
f=self._check_func)
self._loop.start(interval=self._interval,
initial_delay=self._initial_delay)
@common_utils.log_worker_lifecycle(lambda self: self.desc)
def wait(self):
if self._loop is not None:
self._loop.wait()
@common_utils.log_worker_lifecycle(lambda self: self.desc)
def stop(self):
if self._loop is not None:
self._loop.stop()
@common_utils.log_worker_lifecycle(lambda self: self.desc)
def reset(self):
self.stop()
self.wait()
self.start()