python之supervisor進程管理工具
supervisor是python寫的一個管理進程運行的工具，能夠很方便的監聽、啓動、中止、重啓一個或多個進程；有了supervisor後，就不用字節寫啓動和監聽的shell腳本了，很是方便。html
supervisor只支持linux系統，並基於python2環境運行，目前python3尚未官方的版本，但沒有關係，若是項目是python3環境的，能夠同時安裝py2和py3兩個版本。python
安裝環境
通常linux自帶的python2環境是純潔的，沒有setuptools和pip等工具，先安裝。linux
python安裝setuptoolsweb
wget --no-check-certificate https://bootstrap.pypa.io/ez_setup.py python2 ez_setup.py --insecure
- python安裝pip
wget https://bootstrap.pypa.io/get-pip.py --no-check-certificate python2 get-pip.py #更新pip版本 pip2 install --upgrade pip
安裝supervisor
pip2 install supervisor
- 源碼安裝
# 使用root權限 wget https://pypi.python.org/packages/source/s/supervisor/supervisor-3.1.3.tar.gz --no-check-certificat tar -zxvf supervisor-3.1.3.tar.gz cd supervisor-3.1.3 python setup.py install # 能夠在https://pypi.org/project/supervisor/3.1.3/#history網址選擇合適的版本；
- supervisor安裝會在linux環境變量中生成三個執行程序：
supervisortd:守護進程服務，用於接收進程管理命令，執行相關的進程操做；重啓閃退或異常退出的子進程，把子進程的stderr或stdout記錄到日誌文件中，可是其不會把print語句輸出的值記錄到日誌中，須要配合logging模塊使用。 echo_supervisord_conf: 生成初始配置文件程序,能夠指定其路徑。 supervisorctl:客戶端，和守護進程通訊，supervisorctl不只能夠鏈接到本機上的supervisord，還能夠鏈接到遠程的supervisord，在本機上面是經過UNIX socket鏈接的，遠程是經過TCP socket鏈接的；這樣supervisorctl能夠同時管理本地和遠程的進程。
設置supervisor的配置文件
- 通常將配置文件放置在/etc/supervisor/目錄下；
mkdir /etc/supervisor echo_supervisord_conf > /etc/supervisor/supervisord.conf
- 配置文件的解析
[unix_http_server]
file=/tmp/supervisor.sock ; socket文件的路徑，supervisorctl用XML_RPC和supervisord通訊就是經過它進行
的。若是不設置的話，supervisorctl也就不能用了
;chmod=0700 ; 修改上面的那個socket文件的權限爲0700
默認爲0700。 非必須設置
;chown=nobody:nogroup ; 修改上面socket文件的屬組爲user.group
不設置的話，默認爲啓動supervisord進程的用戶及屬組。非必須設置
;username=user ; 使用supervisorctl鏈接supervisord的時候，認證的用戶
不設置的話，默認爲不須要用戶。 非必須設置
;password=123 ; 和上面的用戶名對應的密碼，能夠直接使用明碼，也可使用SHA加密
如：{SHA}82ab876d1387bfafe46cc1c8a2ef074eae50cb1d
默認不設置,非必須設置
;[inet_http_server] ; 偵聽在TCP上的socket，supervisor的server管理服務和遠程的supervisorctl都要用到，
不設置的話，默認爲不開啓網頁管理和遠程管理，非必須設置
;port=127.0.0.1:9001 ; 這個是偵聽的IP和端口，偵聽全部IP用 :9001或*:9001。
這個必須設置，只要上面的[inet_http_server]開啓了，就必須設置它
;username=user ; 認證的用戶
;password=123 ; 密碼
[supervisord] ;這個主要是定義supervisord這個服務端進程的一些參數的，必須設置
logfile=/tmp/supervisord.log ; 這個是supervisord這個主進程的日誌路徑，注意和子進程的日誌無關。
默認路徑$CWD/supervisord.log，$CWD是當前目錄，非必須設置
logfile_maxbytes=50MB ; 這個是上面那個日誌文件的最大的大小，當超過50M的時候，會生成一個新的日
志文件。當設置爲0時，表示不限制文件大小
默認值是50M，非必須設置。
logfile_backups=10 ; 日誌文件保持的數量，上面的日誌文件大於50M時，就會生成一個新文件。文件
數量大於10時，最初的老文件被新文件覆蓋，文件數量將保持爲10
當設置爲0時，表示不限制文件的數量。
loglevel=info ; 日誌級別，有critical, error, warn, info, debug, trace, or blather等
默認爲info，非必須設置項
pidfile=/tmp/supervisord.pid ; supervisord的pid文件路徑。
默認爲$CWD/supervisord.pid。。。非必須設置
nodaemon=false ; 若是是true，supervisord進程將在前臺運行
默認爲false，也就是後臺以守護進程運行。。。非必須設置
minfds=1024 ; 這個是最少系統空閒的文件描述符，低於這個值supervisor將不會啓動。
系統的文件描述符在這裏設置cat /proc/sys/fs/file-max
默認狀況下爲1024。。。非必須設置
minprocs=200 ; 最小可用的進程描述符，低於這個值supervisor也將不會正常啓動。
ulimit -u這個命令，能夠查看linux下面用戶的最大進程數
默認爲200。。。非必須設置
;umask=022 ; 進程建立文件的掩碼
默認爲022。。非必須設置項
;user=chrism ; 這個參數能夠設置一個非root用戶，當咱們以root用戶啓動supervisord以後。
我這裏面設置的這個用戶，也能夠對supervisord進行管理
默認狀況是不設置。。。非必須設置項
;identifier=supervisor ; 這個參數是supervisord的標識符，主要是給XML_RPC用的。當你有多個
supervisor的時候，並且想調用XML_RPC統一管理，就須要爲每一個
supervisor設置不一樣的標識符了
默認是supervisord。。。非必需設置
;directory=/tmp ; 這個參數是當supervisord做爲守護進程運行的時候，設置這個參數的話，啓動
supervisord進程以前，會先切換到這個目錄
默認不設置。。。非必須設置
;nocleanup=true ; 這個參數當爲false的時候，會在supervisord進程啓動的時候，把之前子進程
產生的日誌文件(路徑爲AUTO的狀況下)清除掉。有時候我們想要看歷史日誌，當
然不想日誌被清除了。因此能夠設置爲true
默認是false，有調試需求的同窗能夠設置爲true。。。非必須設置
;childlogdir=/tmp ; 當子進程日誌路徑爲AUTO的時候，子進程日誌文件的存放路徑。
默認路徑是這個東西，執行下面的這個命令看看就OK了，處理的東西就默認路徑
python -c "import tempfile;print tempfile.gettempdir()"
非必須設置
;environment=KEY="value" ; 這個是用來設置環境變量的，supervisord在linux中啓動默認繼承了linux的
環境變量，在這裏能夠設置supervisord進程特有的其餘環境變量。
supervisord啓動子進程時，子進程會拷貝父進程的內存空間內容。 因此設置的
這些環境變量也會被子進程繼承。
小例子：environment=name="haha",age="hehe"
默認爲不設置。。。非必須設置
;strip_ansi=false ; 這個選項若是設置爲true，會清除子進程日誌中的全部ANSI 序列。什麼是ANSI
序列呢？就是咱們的\n,\t這些東西。
默認爲false。。。非必須設置
; the below section must remain in the config file for RPC
; (supervisorctl/web interface) to work, additional interfaces may be
; added by defining them in separate rpcinterface: sections
[rpcinterface:supervisor] ;這個選項是給XML_RPC用的，固然你若是想使用supervisord或者web server 這
個選項必需要開啓的
supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
[supervisorctl] ;這個主要是針對supervisorctl的一些配置
serverurl=unix:///tmp/supervisor.sock ; 這個是supervisorctl本地鏈接supervisord的時候，本地UNIX socket
路徑，注意這個是和前面的[unix_http_server]對應的，
默認值就是unix:///tmp/supervisor.sock，其默認路徑就是/var/tmp/supervisor.sock
;serverurl=http://127.0.0.1:9001 ; 這個是supervisorctl遠程鏈接supervisord的時候，用到的TCP socket路徑
注意這個和前面的[inet_http_server]對應
默認就是http://127.0.0.1:9001,若是開啓這個功能，必須遠程的supervisord服務的[inet_http_server]是開啓的，不然鏈接失敗；
非必須項
;username=chris ; 使用supervisorctl時須要認證的用戶名
默認空。。非必須設置
;password=123 ; 密碼
默認空。。非必須設置
;prompt=mysupervisor ; 輸入用戶名密碼時候的提示符
默認supervisor。。非必須設置
;history_file=~/.sc_history ; 這個參數和shell中的history相似，咱們能夠用上下鍵來查找前面執行過的命令
默認是no file的。。因此咱們想要有這種功能，必須指定一個文件。。。非
必須設置
; The below sample program section shows all possible program subsection values,
; create one or more 'real' program: sections to be able to control them under
; supervisor.
;[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爲多個的話，那就不能這麼幹了；可使用%(program_num)2d進程名字將其區別開；
;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的時候，只要子進程掛掉，將會被無
條件的重啓，也就是說即便使用stop命令中止後也會自動重啓進程；默認unexpected
;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 ;
;stderr_events_enabled=false ;
;environment=A="1",B="2" ; 這個是該子進程的環境變量，和別的子進程是不共享的
;serverurl=AUTO ;
; The below sample eventlistener section shows all possible
; eventlistener subsection values, create one or more 'real'
; eventlistener: sections to be able to handle event notifications
; sent by supervisor.
;[eventlistener:theeventlistenername] ;這個東西其實和program的地位是同樣的，也是suopervisor啓動的子進
程，不過它乾的活是訂閱supervisord發送的event。他的名字就叫
listener了。咱們能夠在listener裏面作一系列處理，好比報警等等
;command=/bin/eventlistener ; 這個和上面的program同樣，表示listener的可執行文件的路徑
;process_name=%(program_name)s ; 這個也同樣，進程名，當下面的numprocs爲多個的時候，才須要。不然默認就
OK了
;numprocs=1 ; 相同的listener啓動的個數
;events=EVENT ; event事件的類型，也就是說，只有寫在這個地方的事件類型。纔會被髮送
;buffer_size=10 ; 這個是event隊列緩存大小，當buffer
超過10的時候，最舊的event將會被清除，並把新的event放進去。
默認值爲10。。非必須選項
;directory=/tmp ; 進程執行前，會切換到這個目錄下執行
默認爲不切換。。。非必須
;umask=022 ; 淹沒，默認爲none，不說了
;priority=-1 ; 啓動優先級，默認-1，也不扯了
;autostart=true ; 是否隨supervisord啓動一塊兒啓動，默認true
;autorestart=unexpected ; 是否自動重啓，和program一個樣，分true,false,unexpected等，注意
unexpected和exitcodes的關係
;startsecs=1 ; 也是同樣，進程啓動後跑了幾秒鐘，才被認定爲成功啓動，默認1
;startretries=3 ; 失敗最大嘗試次數，默認3
;exitcodes=0,2 ; 指望或者說預料中的進程退出碼，
;stopsignal=QUIT ; 幹掉進程的信號，默認爲TERM，好比設置爲QUIT，那麼若是QUIT來幹這個進程
那麼會被認爲是正常維護，退出碼也被認爲是expected中的
;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 ;設置普通用戶，能夠用來管理該listener進程。
默認爲空。。非必須設置
;redirect_stderr=true ; 爲true的話，stderr的log會併入stdout的log裏面
默認爲false。。。非必須設置
;stdout_logfile=/a/path ;
;stdout_logfile_maxbytes=1MB ;
;stdout_logfile_backups=10 ;
;stdout_events_enabled=false ;
;stderr_logfile=/a/path ;
;stderr_logfile_maxbytes=1MB ;
;stderr_logfile_backups ;
;stderr_events_enabled=false ;
;environment=A="1",B="2" ;
;serverurl=AUTO ;
; The below sample group section shows all possible group values,
; create one or more 'real' group: sections to create "heterogeneous"
; process groups.
;[group:thegroupname] ;這個東西就是給programs分組，劃分到組裏面的program。咱們就不用一個一個去操做了
咱們能夠對組名進行統一的操做。 注意：program被劃分到組裏面以後，就至關於原來
的配置從supervisor的配置文件裏消失了，supervisor只會對組進行管理，而再也不
會對組裏面的單個program進行管理了
;programs=progname1,progname2 ; 組成員，用逗號分開
這個是個必須的設置項
;priority=999 ; 優先級，相對於組和組之間說的
默認999。。非必須選項
; The [include] section can just contain the "files" setting. This
; setting can list multiple files (separated by whitespace or
; newlines). It can also contain wildcards. The filenames are
; interpreted as relative to this file. Included files *cannot*
; include files themselves.
;[include] ;這個東西挺有用的，當咱們要管理的進程不少的時候，寫在一個文件裏面
就有點大了。咱們能夠把配置信息寫到多個文件中，而後include過來
;files = relative/directory/*.ini
- 若是想快速上手使用的話，上述的全部配置所有了解是讓人頭暈的，下面說說當只有一兩個進程須要管理的時候的配置。
快速修改配置
# 修改[unix_http_server] [unix_http_server] file=/var/run/supervisor.sock # /tmp中的文件會被系統刪除，因此爲了安全，修改該路徑。 # 修改[inet_http_server] [inet_http_server] # 啓動遠程管理和界面管理 port=:9001 # 監聽端口，綁定ip和端口 username=user # 遠程管理須要的用戶 password=123 # 密碼 # 修改[supervisord] [supervisord] logfile=/var/log/supervisord.log # 日誌路徑改成標準的日誌路徑 pidfile=/var/run/supervisord.pid # 進程文件路徑 # 修改[supervisorctl] [supervisorctl] serverurl=unix:///run/supervisor.sock # 根據[unix_http_server]修改路徑 # 修改[program:theprogramname] [program:test] # 將註釋去掉,爲進程命名 command=python test.py # 進程的啓動命令，能夠帶參數 process_name=%(program_name)s_%(program_num)2d # 若是要開多個進程纔用到這個參數 numprocs=2 # 設置進程的個數，1個就不用設置了 directory=/usr/bin # 執行啓動命令前切換到這個目錄，若是命令是使用全路徑啓動的話就不要設置了 stdout_logfile=/var/log/%(program_name)s_out.log # 設置輸出日誌 stderr_logfile=/var/log/%(program_name)s_err.log # 設置錯誤日誌
啓動supercisord服務端
- 啓動 supervisord 進程，同時咱們在配置文件中設置的進程也會相應啓動。
# 使用默認的配置文件/etc/supervisord.conf supervisord # 明確指定配置文件 supervisord -c /etc/supervisor/supervisord.conf # 使用 user 用戶啓動 supervisord supervisord -u user
supervisorctl相關的管理命令
# 顯示當前管理的全部進程 supervisorctl status # 中止某一個進程，program_name 爲 [program:x] 裏的 x supervisorctl stop program_name # 啓動某個進程 supervisorctl start program_name # 重啓某個進程 supervisorctl restart program_name # 結束全部屬於名爲 groupworker 這個分組的進程 (start，restart 同理) supervisorctl stop groupworker: # 結束 groupworker:name1 這個進程 (start，restart 同理) supervisorctl stop groupworker:name1 # 中止所有進程，注：start、restart、stop 都不會載入最新的配置文件 supervisorctl stop all # 載入最新的配置文件，中止原有進程並按新的配置啓動、管理全部進程 supervisorctl reload # 根據最新的配置文件，啓動新配置或有改動的進程，配置沒有改動的進程不會受影響而重啓 supervisorctl update # 顯示用 stop 中止掉的進程，用 reload 或者 update 都不會自動重啓。
錯誤提醒
若是按以上命令行操做出現如下error:redis
Error: .ini file does not include supervisorctl section For help, use /usr/local/bin/supervisorctl -h 或者 error: <class 'socket.error'>, [Errno 101] Network is unreachable: file: /usr/lib/python2.7/socket.py line: 571
- 切換到/etc/supervisor目錄執行命令行操做，至於緣由，樓主暫時不清楚。
瀏覽器管理進程
- 上述的配置已經開啓了瀏覽器管理功能；
# 在瀏覽器輸入 http://服務器ip:9001 # 輸入用戶名密碼
設置supervisord開機自啓動
# 在/etc/init.d/目錄創建一個文件 touch Ssupervisord.service vi Ssupervisord.service #!/bin/sh # chkconfig 2345 20 80 supervisord -c /etc/supervisor/supervisord.conf # 添加到chkconfig管理 chkconfig --add Ssupervisord.service
設置管理多個進程
- 多個同一類進程
# 好比多個消費者，須要啓動多個相同的文件 # 修改[program:theprogramname] process_name=%(program_name)s_%(program_num)2d # 若是要開多個進程纔用到這個參數 numprocs=2 # 設置進程數
- 多個不一樣進程使用組管理
# 先配置多個[program:theprogramname] [program:programname1] xxxx [program:programname2] xxxx [group:thegroupname] programs=programname1,programname2 priority=999
能夠經過管理thegroupnam來同時管理programname1,programname2shell
設置多個配置文件
- 若是須要管理的進程文件很是多，一個配置文件就會顯得很是的凌亂，可使用多個配置文件。
[include] files = /etc/supervisor/supervisord.d/*.ini # 建立一個新的文件夾，將每一個進程單獨寫成一個配置文件，若是要包含多個不一樣路徑的文件，用空格隔開 # 每一個配置文件的內容 [program:programname1] xxxx
- 例如配置一個redis的進程文件
[program:redis_6390] command=/usr/local/bin/redis-server /etc/redis/6390.conf stdout_logfile=/var/log/redis_6390_out.log stderr_logfile=/var/log/redis-6390_err.log priority=300
相關文章
- 1. supervisor進程管理工具
- 2. supervisor：進程管理工具
- 3. 進程管理工具 Supervisor
- 4. supervisor——進程管理工具
- 5. Supervisor 進程管理工具
- 6. 進程管理工具supervisor
- 7. supervisor 進程管理工具
- 8. Python—守護進程管理工具（Supervisor）
- 9. 【管理工具】進程管理工具Supervisor
- 10. 【管理工具】進程管理工具Supervisor（送書活動）
- 更多相關文章...
- • jQuery Mobile 工具欄 - jQuery Mobile 教程
- • netwox網絡工具集入門教程 - TCP/IP教程
- • PHP開發工具
- • 互聯網組織的未來：剖析GitHub員工的任性之源
相關標籤/搜索
每日一句
-
每一个你不满意的现在，都有一个你没有努力的曾经。
歡迎關注本站公眾號,獲取更多信息
