supervisor 安裝與配置

進程管理supervisor的簡單說明

 

背景:

      項目中遇到有些腳本須要經過後臺進程運行,保證不被異常中斷,以前都是經過nohup、&、screen來實現,帶着可否作一個start/stop/restart/reload的服務啓動的想法找到裏Supervisor。關於supervisor的介紹在網上大體搜索總結以下:php

      Supervisor是用Python開發的一套通用的進程管理程序,能將一個普通的命令行進程變爲後臺daemon,並監控進程狀態,異常退出時能自動重啓。它是經過fork/exec的方式把這些被管理的進程看成supervisor的子進程來啓動,這樣只要在supervisor的配置文件中,把要管理的進程的可執行文件的路徑寫進去便可。也實現當子進程掛掉的時候,父進程能夠準確獲取子進程掛掉的信息的,能夠選擇是否本身啓動和報警。supervisor還提供了一個功能,能夠爲supervisord或者每一個子進程,設置一個非root的user,這個user就能夠管理它對應的進程。html

說明:

1,安裝python

複製代碼
1:easy_install 安裝:
easy_install supervisor

2:pip 安裝:
pip install supervisor

3:Debian / Ubuntu能夠直接經過apt安裝:
apt-get install supervisor
複製代碼

2,配置文件linux

1)經過apt-get install安裝後,supervisor的配置文件在:nginx

/etc/supervisor/supervisord.conf web

supervisor的配置文件默認是不全的,不過在大部分默認的狀況下,上面說的基本功能已經知足。而其管理的子進程配置文件在:docker

/etc/supervisor/conf.d/*.confyii

而後,開始給本身須要的腳本程序編寫一個子進程配置文件,讓supervisor來管理它,放在/etc/supervisor/conf.d/目錄下,以.conf做爲擴展名(每一個進程的配置文件均可以單獨分拆也能夠把相關的腳本放一塊兒)。如任意定義一個和腳本相關的項目名稱的選項組(/etc/supervisor/conf.d/test.conf):ide

複製代碼
#項目名
[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安裝後,配置文件不存在,須要本身導入。post

①:運行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                ; 

  

改爲本身實際的配置文件:和①上面同樣。

3:運行

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頁面管理子進程、監控子線程狀況等等,更多的信息能夠去官網上查看。

參考文檔:

Supervisor官方文檔

Supervisor(一)基礎篇

Supervisor(二)event

Supervisor(三)xml_rpc

 

docker Alpine容器下安裝

apk add supervisor

 查看配置

echo_supervisord_conf

 /etc/supervisord.conf

基本配置

 讀取執行腳本的地址

 

 創建.ini 文件

yii

[program:yii-queue-worker]
process_name=%(process_num)02d
command=php /var/www/html/yii mqueue/listen 1
autostart=true
autorestart=true
numprocs=3
stdout_logfile=NONE
stderr_logfile=NONE
user=nginx

  

lumen

[program:services-queue-email]
process_name=%(process_num)02d
command=php /var/www/html/lumen/artisan queue:work --queue=email --sleep=3 --tries=1 --daemon
autostart=true
autorestart=true
numprocs=1
stdout_logfile=NONE
stderr_logfile=NONE
user=nginx

  

初次啓動

supervisord -c /etc/supervisord.conf

  

重啓

supervisor> reload
相關文章
相關標籤/搜索