1、前言
在Django項目中,我們需要用到一些獨立於Django框架外的腳本。這樣一些腳本可能需要獨立的持續運行,且具有很強的可維護性,這個時候supervisor就可以排上用場了。

-
基於python編寫,安裝方便
-
進程管理工具,可以很方便的對用戶定義的進程進行啟動,關閉,重啟,並且對意外關閉的進程進行重啟 ,只需要簡單的配置一下即可,且有web端,狀態、日志查看清晰明了。
-
組成部分
- supervisord[服務端,所以要通過這個來啟動它]
- supervisorctl[客戶端,可以來執行stop等命令]
-
官方文檔地址:
2、安裝
直接使用pip進行
pip install supervisor
3、使用說明
使用supervisor很簡單,只需要修改一些配置文件,就可以使用了。
3.1 查看默認配置
運行
echo_supervisord_conf
即可看到默認配置情況,但是一般情況下,我們都不要去修改默認的配置,而是將默認配置重定向到另外的文件中,不同的進程運用不同的配置文件去對默認文件進行復寫即可。
echo_supervisord_conf > /etc/supervisord.conf
默認配置說明
默認的配置文件是下面這樣的,但是這里有個坑需要注意,supervisord.pid 以及 supervisor.sock 是放在 /tmp 目錄下,但是 /tmp 目錄是存放臨時文件,里面的文件是會被 Linux 系統刪除的,一旦這些文件丟失,就無法再通過 supervisorctl 來執行 restart 和 stop 命令了,將只會得到 unix:///tmp/supervisor.sock 不存在的錯誤 。
[unix_http_server]
;file=/tmp/supervisor.sock ; (the path to the socket file)
;建議修改為 /var/run 目錄,避免被系統刪除
file=/var/run/supervisor.sock ; (the path to the socket file)
;chmod=0700 ; socket file mode (default 0700)
;chown=nobody:nogroup ; socket file uid:gid owner
;username=user ; (default is no username (open server))
;password=123 ; (default is no password (open server))
;[inet_http_server] ; inet (TCP) server disabled by default
;port=127.0.0.1:9001 ; (ip_address:port specifier, *:port for ;all iface)
;username=user ; (default is no username (open server))
;password=123 ; (default is no password (open server))
...
[supervisord]
;logfile=/tmp/supervisord.log ; 日志文件(main log file;default $CWD/supervisord.log)
;建議修改為 /var/log 目錄,避免被系統刪除
logfile=/var/log/supervisor/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=/tmp/supervisord.pid ; (supervisord pidfile;default supervisord.pid)
;建議修改為 /var/run 目錄,避免被系統刪除
pidfile=/var/run/supervisord.pid ; (supervisord pidfile;default supervisord.pid)
;設置啟動supervisord的用戶,一般情況下不要輕易用root用戶來啟動,除非你真的確定要這么做
;user=chrism ; (default is current user, required if root)
nodaemon=false ; (start in foreground if true;default false)
minfds=1024 ; (min. avail startup file descriptors;default 1024)
minprocs=200 ; (min. avail process descriptors;default 200)
;umask=022 ; (process file creation umask;default 022)
;identifier=supervisor ; (supervisord identifier, default is 'supervisor')
;directory=/tmp ; (default is not to cd during start)
;nocleanup=true ; (don't clean up tempfiles at start;default false)
;childlogdir=/tmp ; ('AUTO' child log dir, default $TEMP)
;environment=KEY="value" ; (key value pairs to add to environment)
;strip_ansi=false ; (strip ansi escape codes in logs; def. false)
[unix_http_server]
file=/tmp/supervisor.sock ; (the path to the socket file)
;chmod=0700 ; socket file mode (default 0700)
;chown=nobody:nogroup ; socket file uid:gid owner
;username=user ; (default is no username (open server))
;password=123 ; (default is no password (open server))
[supervisorctl]
; 必須和'unix_http_server'里面的設定匹配
;serverurl=unix:///tmp/supervisor.sock ; use a unix:// URL for a unix socket
;建議修改為 /var/run 目錄,避免被系統刪除
serverurl=unix:///var/run/supervisor.sock ; use a unix:// URL for a unix socket
;serverurl=http://127.0.0.1:9001 ; use an http:// url to specify an inet socket
;username=chris ; should be same as http_username if set
;password=123 ; should be same as http_password if set
。。。
[include]
files = /etc/supervisor/*.conf
配置文件都有說明,且很簡單,就不做多的描述了,在上面有一些建議修改的目錄,若做了修改,則應先創建這些文件,需要注意權限問題,很多錯誤都是沒有權限造成的。
3.2 啟動服務端
現在,讓我們來啟動supervisor服務。
supervisord -c /etc/supervisord.conf
查看supervisord 是否運行:
ps aux|grep superviosrd
output:xxxx 82039 1 0 11:22 ? 00:00:00 /usr/local/bin/python /usr/local/bin/supervisord -c /etc/supervisord.conf
3.2 項目配置及運行
上面我們已經把 supervisrod 運行起來了,現在可以添加我們要管理的進程的配置文件。可以把所有配置項都寫到 supervisord.conf 文件里,但並不推薦這樣做,而是通過 include 的方式把不同的程序(組)寫到不同的配置文件里,對,就是默認配置中的最后的那個include。下面來對項目進行簡單的配置。
假設我們把項目配置文件放在這個目錄中:/etc/supervisor/
則我們需要修改/etc/supervisord.conf 中的include為:
[include]
files = /etc/supervisor/*.conf
測試py文件:
import time
while True:
print('i am ok')
time.sleep(5)
以下為配置文件目錄/etc/supervisor/test.conf:
[program:testpy]
command=python test.py ; the program (relative uses PATH, can take args)
;process_name=%(program_name)s ; process_name expr (default %(program_name)s)
;numprocs=1 ; number of processes copies to start (def 1)
directory=/root/myporject/ ; directory to cwd to before exec (def no cwd)
;umask=022 ; umask for process (default None)
priority=999 ; the relative start priority (default 999)
startsecs = 5 ; 啟動 5 秒后沒有異常退出,就當作已經正常啟動了
autorestart = true ; 程序異常退出后自動重啟
startretries = 3 ; 啟動失敗自動重試次數,默認是 3
stdout_logfile = /root/myporject/supervisor.log
配置完成以后,即可運行:
supervisord -c /etc/supervisord.conf
查看運行狀態
[root@localhost ~]# supervisorctl status
testpy RUNNING pid 2391, uptime 0:00:54
打開瀏覽器,輸入127.0.0.9001,輸入用戶名與密碼(如果配置文件中inet_http_server中作了設置),可以看到下面這個界面:

3.3 使用supervisorctl
在啟動服務之后,運行:
supervisorctl -c /etc/supervisord.conf
或者直接supervisorctl
[root@localhost ~]# supervisorctl
testpy RUNNING pid 2391, uptime 0:01:45
若成功,則會進入supervisorctl的shell界面,有以下方法:
- status # 查看程序狀態
- stop testpy # 關閉 testpy 程序
- start testpy # 啟動 testpy 程序
- restart testpy # 重啟 testpy 程序
- reread # 讀取有更新(增加)的配置文件,不會啟動新添加的程序
- update # 重啟配置文件修改過的程序
執行相關操作后,可以在web端看到具體的變化情況,如stop 程序
stop testpy

其實,也可以不使用supervisorctl shell界面,而在bash終端運行:
$ supervisorctl status
$ supervisorctl stop usercenter
$ supervisorctl start usercenter
$ supervisorctl restart usercenter
$ supervisorctl reread
$ supervisorctl update
3.4 多個進程管理
按照官方文檔的定義,一個 [program:x] 實際上是表示一組相同特征或同類的進程組,也就是說一個 [program:x] 可以啟動多個進程。這組進程的成員是通過 numprocs 和 process_name 這兩個參數來確定的,這句話什么意思呢,我們來看這個例子。
; 設置進程的名稱,使用 supervisorctl 來管理進程時需要使用該進程名
[program:foo]
; 可以在 command 這里用 python 表達式傳遞不同的參數給每個進程
command=python server.py --port=90%(process_num)02d
directory=/home/python/tornado_server ; 執行 command 之前,先切換到工作目錄
; 若 numprocs 不為1,process_name 的表達式中一定要包含 process_num 來區分不同的進程
numprocs=2
process_name=%(program_name)s_%(process_num)02d;
user=oxygen ; 使用 oxygen 用戶來啟動該進程
autorestart=true ; 程序崩潰時自動重啟
redirect_stderr=true ; 重定向輸出的日志
stdout_logfile = /var/log/supervisord/
tornado_server.log
loglevel=info
上面這個例子會啟動兩個進程,process_name 分別為 foo:foo_01 和 foo:foo_02。通過這樣一種方式,就可以用一個 [program:x] 配置項,來啟動一組非常類似的進程。
更詳細配置,點擊這里
Supervisor 同時還提供了另外一種進程組的管理方式,通過這種方式,可以使用 supervisorctl 命令來管理一組進程。跟 [program:x] 的進程組不同的是,這里的進程是一個個的 [program:x] 。
[group:thegroupname]
programs=progname1,progname2 ; each refers to 'x' in [program:x] definitions
priority=999 ; the relative start priority (default 999)
當添加了上述配置后,progname1 和 progname2 的進程名就會變成 thegroupname:progname1 和 thegroupname:progname2 以后就要用這個名字來管理進程了,而不是之前的 progname1。
以后執行 supervisorctl stop thegroupname: 就能同時結束 progname1 和 progname2,執行 supervisorctl stop thegroupname:progname1 就能結束 progname1。
4. 結尾
實際上,默認情況下,supervisored 也是一個進程,最理想的的情況應該是將其安裝為系統服務,安裝方法可以參考這里,安裝腳本參考這里,由於沒有做具體的實驗,此處不展開說明。
其實還有一個簡單的方法,因為 Linux 在啟動的時候會執行 /etc/rc.local 里面的腳本,所以只要在這里添加執行命令就可以
# 如果是 Ubuntu 添加以下內容
/usr/local/bin/supervisord -c /etc/supervisord.conf
# 如果是 Centos 添加以下內容
/usr/bin/supervisord -c /etc/supervisord.conf
以上內容需要添加在 exit 命令前,而且由於在執行 rc.local 腳本時,PATH 環境變量未全部初始化,因此命令需要使用絕對路徑。
在添加前,先在終端測試一下命令是否能正常執行,如果找不到 supervisord,可以用如下命令找到
sudo find / -name supervisord
output:
/usr/local/bin/supervisord
