背景:
項目中遇到有些腳本需要通過后台進程運行,保證不被異常中斷,之前都是通過nohup、&、screen來實現,帶着能否做一個start/stop/restart/reload的服務啟動的想法找到里Supervisor。關於supervisor的介紹在網上大致搜索總結如下:
Supervisor是用Python開發的一套通用的進程管理程序,能將一個普通的命令行進程變為后台daemon,並監控進程狀態,異常退出時能自動重啟。它是通過fork/exec的方式把這些被管理的進程當作supervisor的子進程來啟動,這樣只要在supervisor的配置文件中,把要管理的進程的可執行文件的路徑寫進去即可。也實現當子進程掛掉的時候,父進程可以准確獲取子進程掛掉的信息的,可以選擇是否自己啟動和報警。supervisor還提供了一個功能,可以為supervisord或者每個子進程,設置一個非root的user,這個user就可以管理它對應的進程。
說明:
1:easy_install 安裝: easy_install supervisor 2:pip 安裝: pip install supervisor 3:Debian / Ubuntu可以直接通過apt安裝: apt-get install supervisor
1)通過apt-get install安裝后,supervisor的配置文件在:
/etc/supervisor/supervisord.conf
supervisor的配置文件默認是不全的,不過在大部分默認的情況下,上面說的基本功能已經滿足。而其管理的子進程配置文件在:
/etc/supervisor/conf.d/*.conf
然后,開始給自己需要的腳本程序編寫一個子進程配置文件,讓supervisor來管理它,放在/etc/supervisor/conf.d/目錄下,以.conf作為擴展名(每個進程的配置文件都可以單獨分拆也可以把相關的腳本放一起)。如任意定義一個和腳本相關的項目名稱的選項組(/etc/supervisor/conf.d/test.conf):
#項目名 [program:blog] #腳本目錄 directory=/opt/bin #腳本執行命令 command=/usr/bin/python /opt/bin/test.py #supervisor啟動的時候是否隨着同時啟動,默認True autostart=true #當程序exit的時候,這個program不會自動重啟,默認unexpected #設置子進程掛掉后自動重啟的情況,有三個選項,false,unexpected和true。如果為false的時候,無論什么情況下,都不會被重新啟動,如果為unexpected,只有當進程的退出碼不在下面的exitcodes里面定義的 autorestart=false #這個選項是子進程啟動多少秒之后,此時狀態如果是running,則我們認為啟動成功了。默認值為1 startsecs=1 #日志輸出 stderr_logfile=/tmp/blog_stderr.log stdout_logfile=/tmp/blog_stdout.log #腳本運行的用戶身份 user = zhoujy #把 stderr 重定向到 stdout,默認 false redirect_stderr = true #stdout 日志文件大小,默認 50MB stdout_logfile_maxbytes = 20M #stdout 日志文件備份數 stdout_logfile_backups = 20 [program:zhoujy] #說明同上 directory=/opt/bin command=/usr/bin/python /opt/bin/zhoujy.py autostart=true autorestart=false stderr_logfile=/tmp/zhoujy_stderr.log stdout_logfile=/tmp/zhoujy_stdout.log #user = zhoujy
2)通過easy_install安裝后,配置文件不存在,需要自己導入。
①:運行echo_supervisord_conf打印出一個配置文件的樣本,樣本說明可以看supervisor(一)基礎篇的詳細說明,要是設置樣本為一個配置文件則:
1:運行 echo_supervisord_conf,查看配置樣本: echo_supervisord_conf 2:創建配置文件: echo_supervisord_conf > /etc/supervisord.conf
②:配置子進程配置文件,可以直接在supervisor中的;[program:theprogramname]里設置。
詳細的子進程配置文件:
樣本:
;[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)
說明:
;[program:theprogramname] ;這個就是咱們要管理的子進程了,":"后面的是名字,最好別亂寫和實際進程 有點關聯最好。這樣的program我們可以設置一個或多個,一個program就是 要被管理的一個進程 ;command=/bin/cat ; 這個就是我們的要啟動進程的命令路徑了,可以帶參數 例子:/home/test.py -a 'hehe' 有一點需要注意的是,我們的command只能是那種在終端運行的進程,不能是 守護進程。這個想想也知道了,比如說command=service httpd start。 httpd這個進程被linux的service管理了,我們的supervisor再去啟動這個命令 這已經不是嚴格意義的子進程了。 這個是個必須設置的項 ;process_name=%(program_name)s ; 這個是進程名,如果我們下面的numprocs參數為1的話,就不用管這個參數 了,它默認值%(program_name)s也就是上面的那個program冒號后面的名字, 但是如果numprocs為多個的話,那就不能這么干了。想想也知道,不可能每個 進程都用同一個進程名吧。 ;numprocs=1 ; 啟動進程的數目。當不為1時,就是進程池的概念,注意process_name的設置 默認為1 。。非必須設置 ;directory=/tmp ; 進程運行前,會前切換到這個目錄 默認不設置。。。非必須設置 ;umask=022 ; 進程掩碼,默認none,非必須 ;priority=999 ; 子進程啟動關閉優先級,優先級低的,最先啟動,關閉的時候最后關閉 默認值為999 。。非必須設置 ;autostart=true ; 如果是true的話,子進程將在supervisord啟動后被自動啟動 默認就是true 。。非必須設置 ;autorestart=unexpected ; 這個是設置子進程掛掉后自動重啟的情況,有三個選項,false,unexpected 和true。如果為false的時候,無論什么情況下,都不會被重新啟動, 如果為unexpected,只有當進程的退出碼不在下面的exitcodes里面定義的退 出碼的時候,才會被自動重啟。當為true的時候,只要子進程掛掉,將會被無 條件的重啟 ;startsecs=1 ; 這個選項是子進程啟動多少秒之后,此時狀態如果是running,則我們認為啟 動成功了 默認值為1 。。非必須設置 ;startretries=3 ; 當進程啟動失敗后,最大嘗試啟動的次數。。當超過3次后,supervisor將把 此進程的狀態置為FAIL 默認值為3 。。非必須設置 ;exitcodes=0,2 ; 注意和上面的的autorestart=unexpected對應。。exitcodes里面的定義的 退出碼是expected的。 ;stopsignal=QUIT ; 進程停止信號,可以為TERM, HUP, INT, QUIT, KILL, USR1, or USR2等信號 默認為TERM 。。當用設定的信號去干掉進程,退出碼會被認為是expected 非必須設置 ;stopwaitsecs=10 ; 這個是當我們向子進程發送stopsignal信號后,到系統返回信息 給supervisord,所等待的最大時間。 超過這個時間,supervisord會向該 子進程發送一個強制kill的信號。 默認為10秒。。非必須設置 ;stopasgroup=false ; 這個東西主要用於,supervisord管理的子進程,這個子進程本身還有 子進程。那么我們如果僅僅干掉supervisord的子進程的話,子進程的子進程 有可能會變成孤兒進程。所以咱們可以設置可個選項,把整個該子進程的 整個進程組都干掉。 設置為true的話,一般killasgroup也會被設置為true。 需要注意的是,該選項發送的是stop信號 默認為false。。非必須設置。。 ;killasgroup=false ; 這個和上面的stopasgroup類似,不過發送的是kill信號 ;user=chrism ; 如果supervisord是root啟動,我們在這里設置這個非root用戶,可以用來 管理該program 默認不設置。。。非必須設置項 ;redirect_stderr=true ; 如果為true,則stderr的日志會被寫入stdout日志文件中 默認為false,非必須設置 ;stdout_logfile=/a/path ; 子進程的stdout的日志路徑,可以指定路徑,AUTO,none等三個選項。 設置為none的話,將沒有日志產生。設置為AUTO的話,將隨機找一個地方 生成日志文件,而且當supervisord重新啟動的時候,以前的日志文件會被 清空。當 redirect_stderr=true的時候,sterr也會寫進這個日志文件 ;stdout_logfile_maxbytes=1MB ; 日志文件最大大小,和[supervisord]中定義的一樣。默認為50 ;stdout_logfile_backups=10 ; 和[supervisord]定義的一樣。默認10 ;stdout_capture_maxbytes=1MB ; 這個東西是設定capture管道的大小,當值不為0的時候,子進程可以從stdout 發送信息,而supervisor可以根據信息,發送相應的event。 默認為0,為0的時候表達關閉管道。。。非必須項 ;stdout_events_enabled=false ; 當設置為ture的時候,當子進程由stdout向文件描述符中寫日志的時候,將 觸發supervisord發送PROCESS_LOG_STDOUT類型的event 默認為false。。。非必須設置 ;stderr_logfile=/a/path ; 這個東西是設置stderr寫的日志路徑,當redirect_stderr=true。這個就不用 設置了,設置了也是白搭。因為它會被寫入stdout_logfile的同一個文件中 默認為AUTO,也就是隨便找個地存,supervisord重啟被清空。。非必須設置 ;stderr_logfile_maxbytes=1MB ; 這個出現好幾次了,就不重復了 ;stderr_logfile_backups=10 ; 這個也是 ;stderr_capture_maxbytes=1MB ; 這個一樣,和stdout_capture一樣。 默認為0,關閉狀態 ;stderr_events_enabled=false ; 這個也是一樣,默認為false ;environment=A="1",B="2" ; 這個是該子進程的環境變量,和別的子進程是不共享的 ;serverurl=AUTO ;
改成自己實際的配置文件:和①上面一樣。
1)apt-get install 安裝的supervisor直接可以通過 /etc/init.d/supervisor 運行:
/etc/init.d/supervisor start
2)通過easy_install 安裝的supervisor運行supervisord 運行:
supervisord
4:web界面操作
需要在supervisor的配置文件里添加[inet_http_server]選項組:之后可以通過http://10.211.55.11:9001來訪問控制子線程的管理。
[inet_http_server] port=10.211.55.11:9001 username=user password=123
效果:

5:子進程管理(supervisorctl)
1) 查看所有子進程的狀態:
# supervisorctl status blog RUNNING pid 2395, uptime 0:08:41 zhoujy RUNNING pid 2396, uptime 0:08:41
2)關閉、開啟指定的子進程:
# supervisorctl stop zhoujy
zhoujy: stopped
# supervisorctl start zhoujy
zhoujy: started
3)關閉、開啟所有的子進程:
# supervisorctl stop all
blog: stopped
zhoujy: stopped
# supervisorctl start all
blog: started
zhoujy: started
4):其他參數:supervisor開啟后子進程自動開啟(autostart=true)和子進程退出后自動啟動(autorestart=ture)
更多的參數可以看官方文檔和supervisor(一)基礎篇的說明。
總結:
我們需要的功能在上面介紹的supervisor的基本功能中已經實現,supervisor還有其他的一些功能:如進程組、web頁面管理子進程、監控子線程情況等等,更多的信息可以去官網上查看。
參考文檔:
