Как правильно обработать сигнал SIGTERM?

197

Давайте предположим, что у нас есть такой тривиальный демон, написанный на python:

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()изящно остановиться?

zerkms
источник
2
Я сделал то, что вы просили раньше, используя signalfdи маскируя доставку SIGTERMпроцесса.
Эрик Урбан

Ответы:

278

Чистое в использовании решение на основе классов:

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
Спасибо за идею! Я использовал модифицированный подход в reboot-guard. github.com/ryran/reboot-guard/blob/master/rguard#L284:L304
rsaw
7
Это лучший ответ (не требующий обсуждения), и он должен быть предпочтительным методом первой попытки.
jose.angel.jimenez
2
@ Mausy5043 Python позволяет вам не использовать круглые скобки для определения классов. Хотя это отлично подходит для python 3.x, но для python 2.x лучше всего использовать «класс XYZ (объект):». Причина: docs.python.org/2/reference/datamodel.html#newstyle
Mayank
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
Хорошо работает для меня, также в контексте Docker. Спасибо!
Мариан
4
Если вы просто установите флаг и не будете вызывать исключение, то оно будет таким же, как и для потока. Так что использование потока здесь излишне.
Suor
28

Я думаю, что вы близки к возможному решению.

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

moliware
источник
4
Да, отдельная тема - это то, как я наконец решил ее, спасибо
zerkms
7
Темы здесь не требуются. В самой однопоточной программе вы можете сначала зарегистрировать обработчик сигнала (регистрация обработчика сигнала не блокируется), а затем записать основной цикл. Функция обработчика сигнала должна устанавливать флаг, когда и цикл должен проверять этот флаг. Я вставил решение на основе класса для того же здесь .
Маянк Джайсвал
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
thoughtarray
источник
11

Основываясь на предыдущих ответах, я создал менеджер контекста, который защищает от sigint и sigterm.

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")
Okke
источник
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)
loretoparisi
источник