Як граціозно обробити сигнал SIGTERM?


198

Припустимо, у нас є такий тривіальний демон, записаний пітоном:

def mainloop():
    while True:
        # 1. do
        # 2. some
        # 3. important
        # 4. job
        # 5. sleep

mainloop()

і ми демонструємо його, використовуючи start-stop-daemonякий за замовчуванням надсилає SIGTERM( TERM) сигнал --stop.

Припустимо, виконується поточний крок #2. І саме в цей момент ми посилаємо TERMсигнал.

Що трапляється, це виконання припиняється негайно.

Я виявив, що я можу обробляти сигнальну подію за допомогою, signal.signal(signal.SIGTERM, handler)але річ у тому, що вона все-таки перериває поточне виконання і передає керування handler.

Отже, моє запитання - чи можна не перервати поточне виконання, а обробляти TERMсигнал окремим потоком (?), Щоб я зміг встановити shutdown_flag = Trueтак, що mainloop()мав шанс витончено зупинитися?


2
Я зробив те, що ви просили раніше, використовуючи signalfdта маскуючи доставку SIGTERMцього процесу.
Ерік Урбан

Відповіді:


280

Чистий у використанні розчин на основі класу:

import signal
import time

class GracefulKiller:
  kill_now = False
  def __init__(self):
    signal.signal(signal.SIGINT, self.exit_gracefully)
    signal.signal(signal.SIGTERM, self.exit_gracefully)

  def exit_gracefully(self,signum, frame):
    self.kill_now = True

if __name__ == '__main__':
  killer = GracefulKiller()
  while not killer.kill_now:
    time.sleep(1)
    print("doing something in a loop ...")

  print("End of the program. I was killed gracefully :)")

1
Дякую за ідею! Я використовував модифікований підхід при перезавантаженні. github.com/ryran/reboot-guard/blob/master/rguard#L284:L304
rsaw

7
Це найкраща відповідь (не потрібні нитки), і слід вважати кращим підхід із першого спробу.
jose.angel.jimenez

2
@ Mausy5043 Python дозволяє не мати дужок для визначення класів. Хоча це ідеально підходить для python 3.x, але для python 2.x, найкращою практикою є використання "class XYZ (object):". Причина: docs.python.org/2/reference/datamodel.html#newstyle
Mayank Jaiswal

2
Слідкуйте за тим, щоб вас мотивували, дякую. Цим я користуюся постійно.
chrisfauerbach

2
У гіршому випадку це просто означатиме зробити ще одну ітерацію, перш ніж граціозно закрити. FalseЗначення встановлюється тільки один раз, а потім він може йти тільки від Помилкового до справжнього так множинний доступ не є проблема.
Alceste_

52

По-перше, я не впевнений, що вам потрібна друга нитка для встановлення shutdown_flag.
Чому б не встановити його безпосередньо в обробці SIGTERM?

Альтернативою є підняти виняток із SIGTERMобробника, який буде розповсюджуватися вгору на стек. Якщо припустимо, що у вас є правильне поводження з винятками (наприклад, з with/contextmanager та try: ... finally:блоками), це має бути досить витонченим відключенням, подібним, як якщо б ви були для Ctrl+Cвашої програми.

Приклад програми signals-test.py:

#!/usr/bin/python

from time import sleep
import signal
import sys


def sigterm_handler(_signo, _stack_frame):
    # Raises SystemExit(0):
    sys.exit(0)

if sys.argv[1] == "handle_signal":
    signal.signal(signal.SIGTERM, sigterm_handler)

try:
    print "Hello"
    i = 0
    while True:
        i += 1
        print "Iteration #%i" % i
        sleep(1)
finally:
    print "Goodbye"

Тепер дивіться Ctrl+Cповедінку:

$ ./signals-test.py default
Hello
Iteration #1
Iteration #2
Iteration #3
Iteration #4
^CGoodbye
Traceback (most recent call last):
  File "./signals-test.py", line 21, in <module>
    sleep(1)
KeyboardInterrupt
$ echo $?
1

Цього разу я надсилаю його SIGTERMпісля 4 ітерацій із kill $(ps aux | grep signals-test | awk '/python/ {print $2}'):

$ ./signals-test.py default
Hello
Iteration #1
Iteration #2
Iteration #3
Iteration #4
Terminated
$ echo $?
143

Цього разу я вмикаю свій власний SIGTERMобробник і надсилаю його SIGTERM:

$ ./signals-test.py handle_signal
Hello
Iteration #1
Iteration #2
Iteration #3
Iteration #4
Goodbye
$ echo $?
0

3
"Чому б не встановити його безпосередньо в обробці SIGTERM" --- тому що робоча нитка перерветься у випадковому місці. Якщо ви помістите кілька заяв у робочий цикл, ви побачите, що ваше рішення скасовує працівника у випадковій позиції, яка залишає роботу в невідомому стані.
zerkms

Добре працює для мене, також у докерському контексті. Дякую!
Маріан

4
Якщо ви просто встановите прапор і не зробите виняток, він буде таким самим, як і для потоку. Тож використання нитки тут зайве.
Suor

28

Я думаю, що ти поруч із можливим рішенням.

Виконайте mainloopв окремому потоці і розгорніть його властивістю shutdown_flag. Сигнал може бути зафіксований signal.signal(signal.SIGTERM, handler)у головній нитці (не в окремій потоці). Обробник сигналу повинен встановити shutdown_flagзначення True і дочекатися закінчення потокуthread.join()


4
Так, відокремлена нитка - це, як я нарешті вирішив це, дякую
zerkms

7
Нитки тут не потрібні. У самій програмі з одним потоком ви можете спочатку зареєструвати обробник сигналу (реєстрація обробника сигналу не блокується), а потім записати основний цикл. Функція обробника сигналу повинна встановити прапор, коли і цикл повинен перевірити цей прапор. Я приклеїв рішення на основі класу для того ж тут .
Mayank Jaiswal

2
Ні в якому разі не потрібно мати другу нитку. Зареєструйте обробник сигналу.
oneloop

корисна сторінка: g-loaded.eu/2016/11/24/…
Каміль Сінді

26

Ось простий приклад без тем або класів.

import signal

run = True

def handler_stop_signals(signum, frame):
    global run
    run = False

signal.signal(signal.SIGINT, handler_stop_signals)
signal.signal(signal.SIGTERM, handler_stop_signals)

while run:
    pass # do stuff including other IO stuff

11

На основі попередніх відповідей я створив менеджер контексту, який захищає від підпису та ознаки.

import logging
import signal
import sys


class TerminateProtected:
    """ Protect a piece of code from being killed by SIGINT or SIGTERM.
    It can still be killed by a force kill.

    Example:
        with TerminateProtected():
            run_func_1()
            run_func_2()

    Both functions will be executed even if a sigterm or sigkill has been received.
    """
    killed = False

    def _handler(self, signum, frame):
        logging.error("Received SIGINT or SIGTERM! Finishing this block, then exiting.")
        self.killed = True

    def __enter__(self):
        self.old_sigint = signal.signal(signal.SIGINT, self._handler)
        self.old_sigterm = signal.signal(signal.SIGTERM, self._handler)

    def __exit__(self, type, value, traceback):
        if self.killed:
            sys.exit(0)
        signal.signal(signal.SIGINT, self.old_sigint)
        signal.signal(signal.SIGTERM, self.old_sigterm)


if __name__ == '__main__':
    print("Try pressing ctrl+c while the sleep is running!")
    from time import sleep
    with TerminateProtected():
        sleep(10)
        print("Finished anyway!")
    print("This only prints if there was no sigint or sigterm")

4

Знайдений для мене найпростіший спосіб. Ось приклад з вилкою для наочності, що цей спосіб корисний для контролю потоку.

import signal
import time
import sys
import os

def handle_exit(sig, frame):
    raise(SystemExit)

def main():
    time.sleep(120)

signal.signal(signal.SIGTERM, handle_exit)

p = os.fork()
if p == 0:
    main()
    os._exit()

try:
    os.waitpid(p, 0)
except (KeyboardInterrupt, SystemExit):
    print('exit handled')
    os.kill(p, 15)
    os.waitpid(p, 0)

0

Найпростіше рішення, яке я знайшов, натхнення відповідями вище - це

class SignalHandler:

    def __init__(self):

        # register signal handlers
        signal.signal(signal.SIGINT, self.exit_gracefully)
        signal.signal(signal.SIGTERM, self.exit_gracefully)

        self.logger = Logger(level=ERROR)

    def exit_gracefully(self, signum, frame):
        self.logger.info('captured signal %d' % signum)
        traceback.print_stack(frame)

        ###### do your resources clean up here! ####

        raise(SystemExit)
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.