Merge pull request #5376 from AlanCoding/logger_full_reload

Add supervisor command to restart select services on reload event

awx/main/tasks.py

@@ -33,7 +33,6 @@ import pexpect
 # Celery
 from celery import Task, task
 from celery.signals import celeryd_init, worker_process_init
-from celery import current_app
 
 # Django
 from django.conf import settings
@@ -54,6 +53,7 @@ from awx.main.task_engine import TaskEnhancer
 from awx.main.utils import (get_ansible_version, get_ssh_version, decrypt_field, update_scm_url,
                             check_proot_installed, build_proot_temp_dir, wrap_args_with_proot,
                             get_system_task_capacity, OutputEventFilter, parse_yaml_or_json)
+from awx.main.utils.reload import restart_local_services
 from awx.main.utils.handlers import configure_external_logger
 from awx.main.consumers import emit_channel_notification
 
@@ -93,25 +93,6 @@ def task_set_logger_pre_run(*args, **kwargs):
     configure_external_logger(settings, async_flag=False, is_startup=False)
 
 
-def _uwsgi_reload():
-    # http://uwsgi-docs.readthedocs.io/en/latest/MasterFIFO.html#available-commands
-    logger.warn('Initiating uWSGI chain reload of server')
-    TRIGGER_CHAIN_RELOAD = 'c'
-    if settings.DEBUG:
-        uWSGI_FIFO_LOCATION = '/awxfifo'
-    else:
-        uWSGI_FIFO_LOCATION = '/var/lib/awx/awxfifo'
-    with open(uWSGI_FIFO_LOCATION, 'w') as awxfifo:
-        awxfifo.write(TRIGGER_CHAIN_RELOAD)
-
-
-def _reset_celery_logging():
-    # Send signal to restart thread pool
-    app = current_app._get_current_object()
-    app.control.broadcast('pool_restart', arguments={'reload': True},
-                          destination=['celery@{}'.format(settings.CLUSTER_HOST_ID)], reply=False)
-
-
 def _clear_cache_keys(set_of_keys):
     logger.debug('cache delete_many(%r)', set_of_keys)
     cache.delete_many(set_of_keys)
@@ -125,8 +106,7 @@ def process_cache_changes(cache_keys):
     _clear_cache_keys(set_of_keys)
     for setting_key in set_of_keys:
         if setting_key.startswith('LOG_AGGREGATOR_'):
-            _uwsgi_reload()
-            _reset_celery_logging()
+            restart_local_services(['uwsgi', 'celery', 'beat', 'callback', 'fact'])
             break
 
 

awx/main/tests/unit/utils/test_reload.py

@@ -0,0 +1,38 @@
+# awx.main.utils.reload
+from awx.main.utils import reload
+
+
+def test_produce_supervisor_command(mocker):
+    with mocker.patch.object(reload.subprocess, 'Popen'):
+        reload._supervisor_service_restart(['beat', 'callback', 'fact'])
+        reload.subprocess.Popen.assert_called_once_with(
+            ['supervisorctl', 'restart', 'tower-processes:receiver', 'tower-processes:factcacher'])
+
+
+def test_routing_of_service_restarts_works(mocker):
+    '''
+    This tests that the parent restart method will call the appropriate
+    service restart methods, depending on which services are given in args
+    '''
+    with mocker.patch.object(reload, '_uwsgi_reload'),\
+            mocker.patch.object(reload, '_reset_celery_thread_pool'),\
+            mocker.patch.object(reload, '_supervisor_service_restart'):
+        reload.restart_local_services(['uwsgi', 'celery', 'flower', 'daphne'])
+        reload._uwsgi_reload.assert_called_once_with()
+        reload._reset_celery_thread_pool.assert_called_once_with()
+        reload._supervisor_service_restart.assert_called_once_with(['flower', 'daphne'])
+
+
+
+def test_routing_of_service_restarts_diables(mocker):
+    '''
+    Test that methods are not called if not in the args
+    '''
+    with mocker.patch.object(reload, '_uwsgi_reload'),\
+            mocker.patch.object(reload, '_reset_celery_thread_pool'),\
+            mocker.patch.object(reload, '_supervisor_service_restart'):
+        reload.restart_local_services(['flower'])
+        reload._uwsgi_reload.assert_not_called()
+        reload._reset_celery_thread_pool.assert_not_called()
+        reload._supervisor_service_restart.assert_called_once_with(['flower'])
+

awx/main/utils/reload.py

@@ -0,0 +1,68 @@
+# Copyright (c) 2017 Ansible Tower by Red Hat
+# All Rights Reserved.
+
+# Python
+import subprocess
+import logging
+
+# Django
+from django.conf import settings
+
+# Celery
+from celery import current_app
+
+logger = logging.getLogger('awx.main.utils.reload')
+
+
+def _uwsgi_reload():
+    # http://uwsgi-docs.readthedocs.io/en/latest/MasterFIFO.html#available-commands
+    logger.warn('Initiating uWSGI chain reload of server')
+    TRIGGER_CHAIN_RELOAD = 'c'
+    with open(settings.UWSGI_FIFO_LOCATION, 'w') as awxfifo:
+        awxfifo.write(TRIGGER_CHAIN_RELOAD)
+
+
+def _reset_celery_thread_pool():
+    # Send signal to restart thread pool
+    app = current_app._get_current_object()
+    app.control.broadcast('pool_restart', arguments={'reload': True},
+                          destination=['celery@{}'.format(settings.CLUSTER_HOST_ID)], reply=False)
+
+
+def _supervisor_service_restart(service_internal_names):
+    '''
+    Service internal name options:
+     - beat - celery - callback - channels - uwsgi - daphne
+     - fact - nginx
+    example use pattern of supervisorctl:
+    # supervisorctl restart tower-processes:receiver tower-processes:factcacher
+    '''
+    group_name = 'tower-processes'
+    args = ['supervisorctl']
+    if settings.DEBUG:
+        args.extend(['-c', '/supervisor.conf'])
+    programs = []
+    name_translation_dict = settings.SERVICE_NAME_DICT
+    for n in service_internal_names:
+        if n in name_translation_dict:
+            programs.append('{}:{}'.format(group_name, name_translation_dict[n]))
+    args.extend(['restart'])
+    args.extend(programs)
+    logger.debug('Issuing command to restart services, args={}'.format(args))
+    subprocess.Popen(args)
+
+
+def restart_local_services(service_internal_names):
+    logger.warn('Restarting services {} on this node in response to user action'.format(service_internal_names))
+    if 'uwsgi' in service_internal_names:
+        _uwsgi_reload()
+        service_internal_names.remove('uwsgi')
+    restart_celery = False
+    if 'celery' in service_internal_names:
+        restart_celery = True
+        service_internal_names.remove('celery')
+    _supervisor_service_restart(service_internal_names)
+    if restart_celery:
+        # Celery restarted last because this probably includes current process
+        _reset_celery_thread_pool()
+

awx/settings/development.py

@@ -112,3 +112,15 @@ except ImportError:
 CLUSTER_HOST_ID = socket.gethostname()
 CELERY_ROUTES['awx.main.tasks.cluster_node_heartbeat'] = {'queue': CLUSTER_HOST_ID, 'routing_key': CLUSTER_HOST_ID}
 
+# Supervisor service name dictionary used for programatic restart
+SERVICE_NAME_DICT = {
+    "celery": "celeryd",
+    "callback": "receiver",
+    "runworker": "channels",
+    "uwsgi": "uwsgi",
+    "daphne": "daphne",
+    "fact": "factcacher",
+    "nginx": "nginx"}
+# Used for sending commands in automatic restart
+UWSGI_FIFO_LOCATION = '/awxfifo'
+

awx/settings/production.py

@@ -57,6 +57,18 @@ LOGGING['handlers']['fact_receiver']['filename'] = '/var/log/tower/fact_receiver
 LOGGING['handlers']['system_tracking_migrations']['filename'] = '/var/log/tower/tower_system_tracking_migrations.log'
 LOGGING['handlers']['rbac_migrations']['filename'] = '/var/log/tower/tower_rbac_migrations.log'
 
+# Supervisor service name dictionary used for programatic restart
+SERVICE_NAME_DICT = {
+    "beat": "awx-celeryd-beat",
+    "celery": "awx-celeryd",
+    "callback": "awx-callback-receiver",
+    "channels": "awx-channels-worker",
+    "uwsgi": "awx-uwsgi",
+    "daphne": "awx-daphne",
+    "fact": "awx-fact-cache-receiver"}
+# Used for sending commands in automatic restart
+UWSGI_FIFO_LOCATION = '/var/lib/awx/awxfifo'
+
 # Store a snapshot of default settings at this point before loading any
 # customizable config files.
 DEFAULTS_SNAPSHOT = {}