Встановлення та налаштування Supervisor в Ubuntu 16.04

Супервізор — це система клієнт/сервер, яка використовується для керування кількома процесами UNIX, точніше процесами, пов’язаними з проектом або клієнтом. Наприклад, ви можете використовувати супервізор для створення та моніторингу довільної кількості робочих черг вашого веб-додатка.

Складовими цієї системи є:

• supervisord: серверна частина системи.
• supervisorctl: інтерфейс командного рядка, який використовується для взаємодії з сервером.
• Веб-сервер: простий веб-сервер і веб-інтерфейс користувача з базовою функціональністю порівняно з supervisorctl .
• Інтерфейс XML-RPC: той самий сервер HTTP, який використовується веб-клієнтом, обслуговує інтерфейс XML-RPC, який можна використовувати для керування програмами супервізора.

У цьому посібнику ми встановимо найновішу версію supervisor, продемонструємо, як створювати програми та керувати ними через supervisorctl, а також налаштуємо веб-інтерфейс для керування нашими програмами.

Установка та базова конфігурація

Ми будемо встановлювати супервізор через easy_install, особливість setuptools python.

Спочатку оновіть список локальних пакетів, а потім встановіть python setuptools.

sudo apt-get update && sudo apt-get install python-setuptools

Тепер ми можемо встановити супервізор.

sudo easy_install supervisor

Після завершення інсталяції ми повинні створити наш файл конфігурації. Створіть папку з іменем supervisorвсередині /etc.

sudo mkdir /etc/supervisor

А потім виконайте наступне.

echo_supervisord_conf >  /etc/supervisor/supervisord.conf

Якщо ви не ввійшли в систему з rootкористувачем, ви можете отримати Permission deniedпомилку (навіть з sudo). Це пов’язано з переадресацією. Щоб подолати це, увійдіть як root.

sudo su

Потім ви можете знову виконати команду.

echo_supervisord_conf > /etc/supervisor/supervisord.conf

Тепер ви можете залишити rootкористувача з exitкомандою. echo_supervisord_confКоманда була надана нашої установкою супервізора.

Базова конфігурація

Відкрийте /etc/supervisor/supervisord.confфайл і перевірте його вміст. Ви помітите, що цей файл конфігурації дотримується INIсинтаксису, і він поділений на розділи (представлені в дужках, як у [section-name]).

Щоб додати програми, якими буде керувати супервізор, нам просто потрібно створити відповідні [program]розділи. Однак, щоб уникнути лазіння з основним конфігураційним файлом щоразу, коли нам потрібно додати (або змінити) програму, ми будемо використовувати [include]розділ. Знайдіть цей розділ, розкоментуйте його, а потім відредагуйте, щоб він виглядав так.

[include]
files=conf.d/*.conf

Тепер для кожної програми, яку ми хочемо додати, ми створимо .iniфайл всередині /etc/supervisor/conf.d/каталогу. Давайте створимо цю папку.

sudo mkdir /etc/supervisor/conf.d

Запуск сервера супервізора

Як зазначалося раніше, супервізор складається з сервера та клієнтів, які підключаються до нього. Щоб мати можливість керувати програмами, нам потрібно запустити сервер. Для цього ми зареєструємо сервер супервізора в systemd, щоб сервер можна було запустити під час запуску системи.

Для цього створіть файл із назвою supervisord.serviceв /etc/systemd/systemкаталозі.

sudo touch /etc/systemd/system/supervisord.service

Додайте наступний вміст до файлу.

[Unit]
Description=Supervisor daemon
Documentation=http://supervisord.org
After=network.target

[Service]
ExecStart=/usr/local/bin/supervisord -n -c /etc/supervisor/supervisord.conf
ExecStop=/usr/local/bin/supervisorctl $OPTIONS shutdown
ExecReload=/usr/local/bin/supervisorctl $OPTIONS reload
KillMode=process
Restart=on-failure
RestartSec=42s

[Install]
WantedBy=multi-user.target
Alias=supervisord.service

Активуйте службу нагляду.

sudo systemctl start supervisord.service

Поки службовий файл знаходиться в /etc/systemd/systemкаталозі, він автоматично запускатиметься під час запуску системи.

Ви можете перевірити стан послуги.

systemctl status supervisord.service

Також ви можете переглянути журнали.

sudo journalctl -u supervisord.service

Додавання програм

Програми, якими керує супервізор, представлені різними [program]розділами конфігурації. Для кожної програми, якою ми хочемо керувати, ми створимо окремий файл конфігурації, який інформує шлях до виконання команди, будь-які змінні середовища, як виконувати у разі завершення роботи.

По-перше, давайте створимо простий скрипт, який реєструє мітку часу. Створіть файл під назвою hello_supervisor.sh(де завгодно, ми будемо посилатися на повний шлях до цього сценарію).

touch hello_supervisor.sh

Тепер помістіть в нього наступний вміст

#!/bin/bash
while true
do 
    # Echo current timestamp to stdout
    echo Hello Supervisor: `date`
    # Echo 'error!' to stderr
    echo An error ocurred at `date`! >&2
    sleep 1
done

Тепер зробіть його виконуваним

chmod +x hello_supervisor.sh

У практичному плані цей сценарій майже марний. Однак ми можемо використовувати це, щоб продемонструвати силу супервізора. Створіть відповідний файл конфігурації, виконавши наступне.

sudo touch /etc/supervisor/conf.d/hello_supervisor.conf

Тепер помістіть наступний вміст у цей файл.

[program:hello_supervisor]
command=/home/USER/hello_supervisor.sh
autostart=true
autorestart=true
stderr_logfile=/var/log/hello_supervisor.err.log
stdout_logfile=/var/log/hello_supervisor.out.log

Примітка. Обов’язково замініть USERсвоє ім’я користувача.

Ми розглянемо цю конфігурацію крок за кроком.

[program:hello_supervisor]
command=/home/USER/hello_supervisor.sh

Спочатку конфігурація починається з визначення програми з іменем hello_supervisor . Він також повідомляє повний шлях до виконуваного файлу, який потрібно запустити.

autostart=true

У цьому рядку зазначено, що ця програма повинна запускатися автоматично при запуску супервізора.

autorestart=true

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

stderr_logfile=/var/log/hello_supervisor.err.log
stdout_logfile=/var/log/hello_supervisor.out.log

Ці рядки визначають розташування файлу журналу для stderrта stdout, відповідно.

Управління програмами

Тепер, коли ми встановили та налаштували супервізор, ми можемо керувати нашими процесами.

Після додавання нової програми ми повинні запустити наступні дві команди, щоб повідомити серверу про повторне читання файлів конфігурації та застосування будь-яких змін.

sudo supervisorctl reread
sudo supervisorctl update

Тепер запустіть supervisorctlклієнта.

sudo supervisorctl

Вас зустріне список зареєстрованих процесів. Ви побачите процес, викликаний hello_supervisorзі RUNNINGстатусом.

hello_supervisor                 RUNNING   pid 6853, uptime 0:22:30
supervisor>

Введіть helpсписок доступних команд.

supervisor> help

default commands (type help <topic>):
=====================================
add    exit      open  reload  restart   start   tail   
avail  fg        pid   remove  shutdown  status  update 
clear  maintail  quit  reread  signal    stop    version

У двох словах, ми можемо start, stopі restartпрограми, передаючи його ім'я програми в якості аргументу відповідної команди.

supervisor> stop hello_supervisor 
hello_supervisor: stopped
supervisor> start hello_supervisor 
hello_supervisor: started
supervisor> restart hello_supervisor 
hello_supervisor: stopped
hello_supervisor: started
supervisor> 

Ми також можемо поглянути на вихід програми за допомогою tailкоманди.

supervisor> tail hello_supervisor 
Hello Supervisor: Mon Sep 25 19:27:29 UTC 2017
Hello Supervisor: Mon Sep 25 19:27:30 UTC 2017
Hello Supervisor: Mon Sep 25 19:27:31 UTC 2017

Для stderrвиходу також можна використовувати tail.

supervisor> tail hello_supervisor stderr
An error ocurred at Mon Sep 25 19:31:12 UTC 2017!
An error ocurred at Mon Sep 25 19:31:13 UTC 2017!
An error ocurred at Mon Sep 25 19:31:14 UTC 2017!

Викликавши statusкоманду, можна переглянути стан усіх зареєстрованих програм.

Як тільки ви закінчите, ви можете кинути.

supervisor> quit

Клієнт веб-сервера

Щоб дозволити доступ до веб-сервера супервізора, відкрийте файл конфігурації супервізора та знайдіть [inet_http_server]розділ.

nano /etc/supervisor/supervisord.conf

Тепер оновіть конфігурацію цього розділу за допомогою наступного.

[inet_http_server]
port=*:9001
username=your_username
password=your_password

Замініть your_usernameта your_passwordз потрібними обліковими даними, збережіть свої зміни та перезапустіть службу супервізора.

sudo systemctl restart supervisord.service

Не забудьте дозволити TCPдоступ до порту 9001вашого брандмауера, а потім отримати доступ http://{server-ip}:9001із вашого браузера. Коли запитають, надайте свої usernameта password. Тепер ви можете керувати своїми процесами з Інтернету.

Висновок

Ми встановили найновішу версію supervisord, дізналися, як налаштувати її для автоматичного запуску системи за допомогою systemd, а також розглянули базове використання supervisorctl. Для більш розширених конфігурацій та випадків використання ви можете звернутися до офіційної документації супервізора .