用Supervisord管理Python進程

Supervisord是用Python實現的一款非常實用的進程管理工具，類似於monit(關於monit見我的博客:用monit監控系統關鍵進程)，monit和supervisord的一個比較大的差異是supervisord管理的進程必須由supervisord來啓動，monit可以管理已經在運行的程序；supervisord還要求管理的程序是非daemon程序，supervisord會幫你把它轉成daemon程序，因此如果用supervisord來管理nginx的話，必須在nginx的配置文件裏添加一行設置daemon off讓nginx以非daemon方式啓動。

Supervisord安裝

Supervisord可以通過sudo easy_install supervisor安裝，當然也可以通過Supervisord官網下載後setup.py install安裝。

Supervisord配置

Supervisord默認的配置文件路徑爲/etc/supervisord.conf，通過文本編輯器修改這個文件，下面是一個示例的配置文件：

;/etc/supervisord.conf
[unix_http_server]
file = /var/run/supervisor.sock
chmod = 0777
chown= root:felinx

[inet_http_server]
# Web管理界面設定
port=9001
username = admin
password = yourpassword

[supervisorctl]
; 必須和'unix_http_server'裏面的設定匹配
serverurl = unix:///var/run/supervisord.sock

[supervisord]
logfile=/var/log/supervisord/supervisord.log ; (main log file;default $CWD/supervisord.log)
logfile_maxbytes=50MB       ; (max main logfile bytes b4 rotation;default 50MB)
logfile_backups=10          ; (num of main logfile rotation backups;default 10)
loglevel=info               ; (log level;default info; others: debug,warn,trace)
pidfile=/var/run/supervisord.pid ; (supervisord pidfile;default supervisord.pid)
nodaemon=true              ; (start in foreground if true;default false)
minfds=1024                 ; (min. avail startup file descriptors;default 1024)
minprocs=200                ; (min. avail process descriptors;default 200)
user=root                 ; (default is current user, required if root)
childlogdir=/var/log/supervisord/            ; ('AUTO' child log dir, default $TEMP)

[rpcinterface:supervisor]
supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface

; 管理的單個進程的配置，可以添加多個program
[program:chatdemon]
command=python /home/felinx/demos/chat/chatdemo.py
autostart = true
startsecs = 5
user = felinx
redirect_stderr = true
；這對這個program的log的配置，上面的logfile_maxbytes是supervisord本身的log配置
stdout_logfile_maxbytes = 20MB
stdoiut_logfile_backups = 20
stdout_logfile = /var/log/supervisord/chatdemo.log

; 配置一組進程，對於類似的program可以通過這種方式添加，避免手工一個個添加
[program:groupworker]
command=python /home/felinx/demos/groupworker/worker.py
numprocs=24
process_name=%(program_name)s_%(process_num)02d
autostart = true
startsecs = 5
user = felinx
redirect_stderr = true
stdout_logfile = /var/log/supervisord/groupworker.log

Supervisord管理

Supervisord安裝完成後有兩個可用的命令行supervisor和supervisorctl，命令使用解釋如下：

• supervisord，初始啓動Supervisord，啓動、管理配置中設置的進程。
• supervisorctl stop programxxx，停止某一個進程(programxxx)，programxxx爲[program:chatdemon]裏配置的值，這個示例就是chatdemon。
• supervisorctl start programxxx，啓動某個進程
• supervisorctl restart programxxx，重啓某個進程
• supervisorctl stop groupworker: ，重啓所有屬於名爲groupworker這個分組的進程(start,restart同理)
• supervisorctl stop all，停止全部進程，注：start、restart、stop都不會載入最新的配置文件。
• supervisorctl reload，載入最新的配置文件，停止原有進程並按新的配置啓動、管理所有進程。
• supervisorctl update，根據最新的配置文件，啓動新配置或有改動的進程，配置沒有改動的進程不會受影響而重啓。
• 注意：顯示用stop停止掉的進程，用reload或者update都不會自動重啓。

轉載請註明出處：http://feilong.me/2011/03/monitor-processes-with-supervisord

Supervisor 管理後臺守護進程

自己開發的應用往往也希望做到隨系統自動啓動, 而且啓動之後最好還能方便的控制其停止/重啓. 傳統的做法是在 /etc/init.d/ 下建立啓動腳本, 但這個方法非常繁瑣, 容易出錯, 而且不同服務器/不同版本的配置又有差異.

通常需要藉助一些輔助工具. 常用的管理工具有 runit, daemontools 以及用 Python 開發的 Supervisor. 其中以 Supervisor 最爲易用, 功能也很完善.

安裝

• 安裝命令

    sudo apt-get install supervisor

• 安裝完成, Supervisor 自動會隨系統自動啓動

命令

Supervisor 有兩個可執行程序 – supervisord 和 supervisorctl:

• supervisord 是後臺管理服務器, 用來依據配置文件的策略管理後臺守護進程, 它會隨系統自動啓動
• supervisorctl 用於管理員向後臺管理程序發送 啓動/重啓/停止 等指令;

它們之間的關係就相當於 Apache 的 httpd 和 apachectl.

主配置文件

配置文件 用來指示 Supervisor 有哪些進程需要管理, 以及管理策略.

主配置文件 的路徑位於 /etc/supervisor/supervisord.conf, 主配置文件中的末尾兩行文本:

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

指明瞭 Supervisor 會去 /etc/supervisor/conf.d/ 目錄下查找以 .conf 結尾的子配置文件, 也就是說, 我們只需在 /etc/supervisor/conf.d/ 目錄下爲每個後臺守護應用新建一個配置文件即可.

子配置文件

舉個例子, 我們只需新建一個子配置文件 /etc/supervisor/conf.d/iot-kb.conf:

[program:codinn]
command = /srv/codinn/ENV/bin/python /srv/codinn/manage.py runwsgiserver

• 爲了方便管理, 每個後臺守護應用對應一個 /etc/supervisor/conf.d/[program-name].conf 子配置文件
• program: 後跟隨的 codinn 指明後臺守護應用的代號, supervisorctl 需要用該代號控制守護進程的啓動/停止.
• program 區的更多配置請參考: [program:x] Section Settings
• 子配置基本上只需關心 program 區
• command 字段設置的是後臺守護應用的啓動命令, 注意: 該命令必須是在前臺執行的, 即會獨佔控制檯, 否則會導致 supervisor 無法獲得標準輸出, 並失去進程的控制權.

控制守護進程

• 每次 修改主配置文件 或 增改子配置文件 都需要執行 supervisorctl update 使新配置生效:

    sudo supervisorctl update

• 控制守護進程:

    # 控制所有進程
    sudo supervisorctl start all
    sudo supervisorctl stop all
    sudo supervisorctl restart all

    # 定向控制指定進程
    sudo supervisorctl stop iot-kb
    sudo supervisorctl start iot-kb
    sudo supervisorctl restart iot-kb

supervisorctl 子命令

$ supervisorctl help

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