Django與supervisor 管理進(jìn)程

1、前言

在Django項(xiàng)目中，我們需要用到一些獨(dú)立于Django框架外的腳本。這樣一些腳本可能需要獨(dú)立的持續(xù)運(yùn)行，且具有很強(qiáng)的可維護(hù)性，這個(gè)時(shí)候supervisor就可以排上用場(chǎng)了。

image

  • 基于python編寫，安裝方便

  • 進(jìn)程管理工具，可以很方便的對(duì)用戶定義的進(jìn)程進(jìn)行啟動(dòng)，關(guān)閉，重啟，并且對(duì)意外關(guān)閉的進(jìn)程進(jìn)行重啟 ，只需要簡(jiǎn)單的配置一下即可，且有web端，狀態(tài)、日志查看清晰明了。

  • 組成部分

    • supervisord[服務(wù)端，所以要通過這個(gè)來啟動(dòng)它]
    • supervisorctl[客戶端，可以來執(zhí)行stop等命令]

  • 官方文檔地址：

    http://supervisord.org/

2、安裝

直接使用pip進(jìn)行

pip install supervisor

3、使用說明

使用supervisor很簡(jiǎn)單，只需要修改一些配置文件，就可以使用了。

3.1 查看默認(rèn)配置

運(yùn)行

echo_supervisord_conf

即可看到默認(rèn)配置情況，但是一般情況下，我們都不要去修改默認(rèn)的配置，而是將默認(rèn)配置重定向到另外的文件中，不同的進(jìn)程運(yùn)用不同的配置文件去對(duì)默認(rèn)文件進(jìn)行復(fù)寫即可。

echo_supervisord_conf > /etc/supervisord.conf

默認(rèn)配置說明

默認(rèn)的配置文件是下面這樣的，但是這里有個(gè)坑需要注意，supervisord.pid 以及 supervisor.sock 是放在 /tmp 目錄下，但是 /tmp 目錄是存放臨時(shí)文件，里面的文件是會(huì)被 Linux 系統(tǒng)刪除的，一旦這些文件丟失，就無法再通過 supervisorctl 來執(zhí)行 restart 和 stop 命令了，將只會(huì)得到 unix:///tmp/supervisor.sock 不存在的錯(cuò)誤 。

[unix_http_server]
;file=/tmp/supervisor.sock   ; (the path to the socket file)
;建議修改為 /var/run 目錄，避免被系統(tǒng)刪除
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 目錄，避免被系統(tǒng)刪除
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           ; 日志文件保留備份數(shù)量(num of main logfile rotation backups;default 10)
loglevel=info                ; 日志級(jí)別(log level;default info; others: debug,warn,trace)
;pidfile=/tmp/supervisord.pid ; (supervisord pidfile;default supervisord.pid)
;建議修改為 /var/run 目錄，避免被系統(tǒng)刪除
pidfile=/var/run/supervisord.pid ; (supervisord pidfile;default supervisord.pid)
;設(shè)置啟動(dòng)supervisord的用戶，一般情況下不要輕易用root用戶來啟動(dòng)，除非你真的確定要這么做
;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'里面的設(shè)定匹配
;serverurl=unix:///tmp/supervisor.sock ; use a unix:// URL  for a unix socket
;建議修改為 /var/run 目錄，避免被系統(tǒng)刪除
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

配置文件都有說明，且很簡(jiǎn)單，就不做多的描述了，在上面有一些建議修改的目錄，若做了修改，則應(yīng)先創(chuàng)建這些文件，需要注意權(quán)限問題，很多錯(cuò)誤都是沒有權(quán)限造成的。

3.2 啟動(dòng)服務(wù)端

現(xiàn)在，讓我們來啟動(dòng)supervisor服務(wù)。

supervisord -c /etc/supervisord.conf

查看supervisord 是否運(yùn)行：

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 項(xiàng)目配置及運(yùn)行

上面我們已經(jīng)把 supervisrod 運(yùn)行起來了，現(xiàn)在可以添加我們要管理的進(jìn)程的配置文件?？梢园阉信渲庙?xiàng)都寫到 supervisord.conf 文件里，但并不推薦這樣做，而是通過 include 的方式把不同的程序（組）寫到不同的配置文件里，對(duì)，就是默認(rèn)配置中的最后的那個(gè)include。下面來對(duì)項(xiàng)目進(jìn)行簡(jiǎn)單的配置。
假設(shè)我們把項(xiàng)目配置文件放在這個(gè)目錄中:/etc/supervisor/
則我們需要修改/etc/supervisord.conf 中的include為：

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

測(cè)試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        ; 啟動(dòng) 5 秒后沒有異常退出，就當(dāng)作已經(jīng)正常啟動(dòng)了
autorestart = true   ; 程序異常退出后自動(dòng)重啟
startretries = 3     ; 啟動(dòng)失敗自動(dòng)重試次數(shù)，默認(rèn)是 3
stdout_logfile = /root/myporject/supervisor.log

配置完成以后，即可運(yùn)行：

supervisord -c /etc/supervisord.conf

查看運(yùn)行狀態(tài)

[root@localhost ~]# supervisorctl status
testpy                           RUNNING   pid 2391, uptime 0:00:54

打開瀏覽器，輸入127.0.0.9001,輸入用戶名與密碼（如果配置文件中inet_http_server中作了設(shè)置），可以看到下面這個(gè)界面：

image

3.3 使用supervisorctl

在啟動(dòng)服務(wù)之后，運(yùn)行：

supervisorctl -c /etc/supervisord.conf

或者直接supervisorctl

[root@localhost ~]# supervisorctl
testpy                           RUNNING   pid 2391, uptime 0:01:45

若成功，則會(huì)進(jìn)入supervisorctl的shell界面，有以下方法：

  • status # 查看程序狀態(tài)
  • stop testpy # 關(guān)閉 testpy 程序
  • start testpy # 啟動(dòng) testpy 程序
  • restart testpy # 重啟 testpy 程序
  • reread ＃ 讀取有更新（增加）的配置文件，不會(huì)啟動(dòng)新添加的程序
  • update ＃ 重啟配置文件修改過的程序

執(zhí)行相關(guān)操作后，可以在web端看到具體的變化情況，如stop 程序

stop testpy
image

其實(shí)，也可以不使用supervisorctl shell界面，而在bash終端運(yùn)行：

$ supervisorctl status
$ supervisorctl stop usercenter
$ supervisorctl start usercenter
$ supervisorctl restart usercenter
$ supervisorctl reread
$ supervisorctl update

3.4 多個(gè)進(jìn)程管理

按照官方文檔的定義，一個(gè) [program:x] 實(shí)際上是表示一組相同特征或同類的進(jìn)程組，也就是說一個(gè) [program:x] 可以啟動(dòng)多個(gè)進(jìn)程。這組進(jìn)程的成員是通過 numprocs 和 process_name 這兩個(gè)參數(shù)來確定的，這句話什么意思呢，我們來看這個(gè)例子。

; 設(shè)置進(jìn)程的名稱，使用 supervisorctl 來管理進(jìn)程時(shí)需要使用該進(jìn)程名
[program:foo] 

; 可以在 command 這里用 python 表達(dá)式傳遞不同的參數(shù)給每個(gè)進(jìn)程
command=python server.py --port=90%(process_num)02d

directory=/home/python/tornado_server ; 執(zhí)行 command 之前，先切換到工作目錄

; 若 numprocs 不為1，process_name 的表達(dá)式中一定要包含 process_num 來區(qū)分不同的進(jìn)程
numprocs=2                   
process_name=%(program_name)s_%(process_num)02d; 

user=oxygen                 ; 使用 oxygen 用戶來啟動(dòng)該進(jìn)程

autorestart=true  ; 程序崩潰時(shí)自動(dòng)重啟

redirect_stderr=true      ; 重定向輸出的日志

stdout_logfile = /var/log/supervisord/
tornado_server.log
loglevel=info

上面這個(gè)例子會(huì)啟動(dòng)兩個(gè)進(jìn)程，process_name 分別為 foo:foo_01 和 foo:foo_02。通過這樣一種方式，就可以用一個(gè) [program:x] 配置項(xiàng)，來啟動(dòng)一組非常類似的進(jìn)程。
更詳細(xì)配置，點(diǎn)擊這里

Supervisor 同時(shí)還提供了另外一種進(jìn)程組的管理方式，通過這種方式，可以使用 supervisorctl 命令來管理一組進(jìn)程。跟 [program:x] 的進(jìn)程組不同的是，這里的進(jìn)程是一個(gè)個(gè)的 [program:x] 。

[group:thegroupname]
programs=progname1,progname2  ; each refers to 'x' in [program:x] definitions
priority=999                  ; the relative start priority (default 999)

當(dāng)添加了上述配置后，progname1 和 progname2 的進(jìn)程名就會(huì)變成 thegroupname:progname1 和 thegroupname:progname2 以后就要用這個(gè)名字來管理進(jìn)程了，而不是之前的 progname1。

以后執(zhí)行 supervisorctl stop thegroupname: 就能同時(shí)結(jié)束 progname1 和 progname2，執(zhí)行 supervisorctl stop thegroupname:progname1 就能結(jié)束 progname1。

4. 結(jié)尾

實(shí)際上，默認(rèn)情況下，supervisored 也是一個(gè)進(jìn)程，最理想的的情況應(yīng)該是將其安裝為系統(tǒng)服務(wù)，安裝方法可以參考這里,安裝腳本參考這里,由于沒有做具體的實(shí)驗(yàn)，此處不展開說明。

其實(shí)還有一個(gè)簡(jiǎn)單的方法，因?yàn)?Linux 在啟動(dòng)的時(shí)候會(huì)執(zhí)行 /etc/rc.local 里面的腳本，所以只要在這里添加執(zhí)行命令就可以

# 如果是 Ubuntu 添加以下內(nèi)容
/usr/local/bin/supervisord -c /etc/supervisord.conf

# 如果是 Centos 添加以下內(nèi)容
/usr/bin/supervisord -c /etc/supervisord.conf

以上內(nèi)容需要添加在 exit 命令前，而且由于在執(zhí)行 rc.local 腳本時(shí)，PATH 環(huán)境變量未全部初始化，因此命令需要使用絕對(duì)路徑。

在添加前，先在終端測(cè)試一下命令是否能正常執(zhí)行，如果找不到 supervisord，可以用如下命令找到

sudo find / -name supervisord

output:
/usr/local/bin/supervisord

參考資料：

這段日子真的很難 http://www.itdecent.cn/p/bf2b3f4dec73

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容