supervisor 管理進程簡明教程

supervisor 管理進程簡明教程

一、Introduction

(1) 基於python編寫，安裝方便
(2) 進程管理工具，能夠很方便的對用戶定義的進程進行啓動，關閉，重啓，而且對意外關閉的進程進行重啓 ，只須要簡單的配置一下便可，且有web端，狀態、日誌查看清晰明瞭。
(3) 組成部分 supervisord[服務端，因此要經過這個來啓動它]
            supervisorctl[客戶端，能夠來執行stop等命令]
(4) 官方文檔地址：http://supervisord.org/

二、安裝

python 第三方包的安裝方法，此處不詳細描述

pip install supervisor

三、使用說明

使用supervisor很簡單，只須要修改一些配置文件，就可使用了。

3.1 查看默認配置

運行

echo_supervisord_conf

便可看到默認配置狀況，可是通常狀況下，咱們都不要去修改默認的配置，而是將默認配置重定向到另外的文件中，不一樣的進程運用不一樣的配置文件去對默認文件進行復寫便可。

echo_supervisord_conf > /etc/supervisord.conf

3.1 默認配置說明

默認的配置文件是下面這樣的，可是這裏有個坑須要注意，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

;[program:theprogramname]
;command=/bin/cat              ; 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=/tmp                ; directory to cwd to before exec (def no cwd)
;umask=022                     ; umask for process (default None)
;priority=999                  ; the relative start priority (default 999)
;autostart=true                ; start at supervisord start (default: true)
;startsecs=1                   ; # of secs prog must stay up to be running (def. 1)
;startretries=3                ; max # of serial start failures when starting (default 3)
;autorestart=unexpected        ; when to restart if exited after running (def: unexpected)
;exitcodes=0,2                 ; 'expected' exit codes used with autorestart (default 0,2)
;stopsignal=QUIT               ; signal used to kill process (default TERM)
;stopwaitsecs=10               ; max num secs to wait b4 SIGKILL (default 10)
;stopasgroup=false             ; send stop signal to the UNIX process group (default false)
;killasgroup=false             ; SIGKILL the UNIX process group (def false)
;user=chrism                   ; setuid to this UNIX account to run the program
;redirect_stderr=true          ; redirect proc stderr to stdout (default false)
;stdout_logfile=/a/path        ; stdout log path, NONE for none; default AUTO
;stdout_logfile_maxbytes=1MB   ; max # logfile bytes b4 rotation (default 50MB)
;stdout_logfile_backups=10     ; # of stdout logfile backups (default 10)
;stdout_capture_maxbytes=1MB   ; number of bytes in 'capturemode' (default 0)
;stdout_events_enabled=false   ; emit events on stdout writes (default false)
;stderr_logfile=/a/path        ; stderr log path, NONE for none; default AUTO
;stderr_logfile_maxbytes=1MB   ; max # logfile bytes b4 rotation (default 50MB)
;stderr_logfile_backups=10     ; # of stderr logfile backups (default 10)
;stderr_capture_maxbytes=1MB   ; number of bytes in 'capturemode' (default 0)
;stderr_events_enabled=false   ; emit events on stderr writes (default false)
;environment=A="1",B="2"       ; process environment additions (def no adds)
;serverurl=AUTO                ; override serverurl computation (childutils)

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


[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

如下爲本人的配置文件目錄：

/etc/supervisor/update_ip.conf

[program:update_ip] ;項目名稱
directory = /home/xxxx/works/ip_update/ip_update_on_server_no_1/ ; 程序的啓動目錄
command = python /home/xxxx/works/ip_update/ip_update_on_server_no_1/update_ip_internal.py  ; 啓動命令，能夠看出與手動在命令行啓動的命令是同樣
autostart = true     ; 在 supervisord 啓動的時候也自動啓動
startsecs = 5        ; 啓動 5 秒後沒有異常退出，就看成已經正常啓動了
autorestart = true   ; 程序異常退出後自動重啓
startretries = 3     ; 啓動失敗自動重試次數，默認是 3
user = shimeng          ; 用哪一個用戶啓動
redirect_stderr = true  ; 把 stderr 重定向到 stdout，默認 false
stdout_logfile_maxbytes = 50MB  ; stdout 日誌文件大小，默認 50MB
stdout_logfile_backups = 20     ; stdout 日誌文件備份數
; stdout 日誌文件，須要注意當指定目錄不存在時沒法正常啓動，因此須要手動建立目錄（supervisord 會自動建立日誌文件）
stdout_logfile = /home/xxxx/works/ip_update/ip_update_on_server_no_1/supervisor.log
loglevel=info

[supervisorctl]
serverurl=unix:///tmp/supervisor.sock ; use a unix:// URL  for a unix socket

[unix_http_server]
file=/tmp/supervisor.sock   ; (the path to the socket file)
chmod=0777                 ; socket file mode (default 0700)
;chown=nobody:nogroup       ; socket file uid:gid owner
;username=shimeng              ; (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=shimeng              ; (default is no username (open server))
password=123

配置詳解：
a)  在supervisord.conf文件中，分號「；」後面的內容表示註釋
b)  [group:組名]，設置一個服務分組，programs後面跟組內全部服務的名字，以分號分格。
c)  [program：服務名]，下面是這個服務的具體設置：
Command:啓用Tornado服務文件的命令，也就是咱們手動啓動的命令。
Directory:服務文件所在的目錄
User:啓用服務的用戶
Autorestart:是否自動重啓服務
stdout_logfile：服務的產生的日起文件
loglevel:日誌級別

配置完成之後，便可運行：

supervisord -c /etc/supervisord.conf

查看運行狀態

$ supervisorctl status

out:
update_ip         RUNNING   pid 62040, uptime 0:10:09

打開瀏覽器，輸入127.0.0.9001,輸入用戶名與密碼（若是配置文件中inet_http_server中做了設置），能夠看到下面這個界面：

3.3 使用supervisorctl

在啓動服務以後，運行：

supervisorctl -c /etc/supervisord.conf

out:
update_ip         RUNNING   pid 62040, uptime 0:10:09

若成功，則會進入supervisorctl的shell界面，有如下方法：

status    # 查看程序狀態
stop update_ip   # 關閉 update_ip 程序
start update_ip  # 啓動 update_ip 程序
restart update_ip    # 重啓 update_ip 程序
reread    ＃ 讀取有更新（增長）的配置文件，不會啓動新添加的程序
update    ＃ 重啓配置文件修改過的程序

執行相關操做後，能夠在web端看到具體的變化狀況，如stop 程序

stop update_ip

其實，也能夠不使用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