supervisor模塊學習使用

時間 2019-11-19

標籤 supervisor 模塊學習使用简体版

原文原文鏈接

supervisor組件html

supervisordjava

supervisord是supervisor的服務端程序。python

啓動supervisor程序自身，啓動supervisor管理的子進程，響應來自clients的請求，重啓閃退或異常退出的子進程，把子進程的stderr或stdout記錄到日誌文件中，生成和處理Eventlinux
supervisorctlweb

客戶端的命令行工具，提供一個相似shell的操做接口，經過它你能夠鏈接到不一樣的supervisord進程上來管理它們各自的子程序，最牛逼的一點是，supervisorctl不只能夠鏈接到本機上的supervisord，還能夠鏈接到遠程的supervisord，固然在本機上面是經過UNIX socket鏈接的，遠程是經過TCP socket鏈接的。supervisorctl和supervisord之間的通訊，是經過xml_rpc完成的。服務端也能夠要求客戶端提供身份驗證以後才能進行操做相應的配置在[supervisorctl]shell
Web Server安全

Web Server主要能夠在界面上管理進程，Web Server實際上是經過XML_RPC來實現的，能夠向supervisor請求數據，也能夠控制supervisor及子進程。配置在[inet_http_server]python2.7
XML_RPC接口socket

供遠程調用，supervisorctl和Web Server須要使用tcp

安裝

supervisor安裝完成後會生成三個執行程序：supervisortd、supervisorctl、echo_supervisord_conf，分別是supervisor的守護進程服務（用於接收進程管理命令）、客戶端（用於和守護進程通訊，發送管理進程的指令）、生成初始配置文件程序。

pip install supervisor

生成配置文件

安裝好supervisor以後，默認是沒有生成配置文件的。能夠經過如下命令生成配置文件（咱們一般是把配置文件放到/etc/下面，固然也能夠放到任意路徑下面）

echo_supervisord_conf > /etc/supervisord.conf

配置文件裏每一行開頭都是分號；這個符號用來表示註釋，去掉須要配置項的分號並做修改便可

[unix_http_server] 
         
file=/home/supervisor.sock   ;socket文件的路徑，supervisorctl用XML_RPC和supervisord通訊就是經過它進行
                             的。若是不設置的話，supervisorctl也就不能用了，非必須設置
;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]          ;偵聽在TCP上的socket，Web Server和遠程的supervisorctl都要用到他(提供web管理界面)，非必須

port=xx.xx.xx.xxx:9001      ;Web管理後臺運行的IP和端口，若是開放到公網，須要注意安全性，非必須設置
;username=user              ; default is no username (open server)
;password=123               ; default is no password (open server)

 [supervisord]  ; 主要是定義supervisord這個服務端進程的一些參數的,必須設置

logfile=/home/supervisord.log ; supervisor服務的日誌文件 main log file; default $CWD/supervisord.log，$CWD爲當前目錄非必須設置
logfile_maxbytes=50MB ; 日誌文件大小當超過50M的時候，會生成一個新的日誌文件。當設置爲0時，表示不限制文件大小，默認值爲50M，非必須設置
logfile_backups=10           ;日誌文件保持的數量，上面的日誌文件大於50M時，就會生成一個新文件。文件數量大於10時，最初的老文件被新文件覆蓋，   
                              文件數量將保持爲10當設置爲0時，表示不限制文件的數量默認狀況下爲10。。。非必須設置
loglevel=warn                ; 日誌級別，默認是info log level; default info; others: debug,warn,trace。程序穩定的狀況下，維護用warn就夠了
pidfile=/tmp/supervisord.pid ; supervisord pidfile; default 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                   ; process file creation umask; default 022
;user=chrism                 ; default is current user, required if root
;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
; The rpcinterface:supervisor 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:x] sections.

[rpcinterface:supervisor] ;給XML_RPC用的，若是想使用supervisord或者web server 都必須設置

supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
; The supervisorctl section configures how supervisorctl will connect to
; supervisord.  configure it match the settings in either the unix_http_server
; or inet_http_server section.

 [supervisorctl];supervisorctl的一些配置

serverurl=unix:///home/supervisor.sock   ;use a unix:// URL  for a unix socket這個是supervisorctl本地鏈接supervisord的時候，本地UNIX socket
                                          路徑，注意這個是和前面的[unix_http_server]對應的默認值就是unix:///tmp/supervisor.sock。。非必須設置
serverurl=http://xx.21.21.xxx:9001       ;use an http:// url to specify an inet socket這個是supervisorctl遠程鏈接supervisord的時候，
                                          用到的TCP socket路徑注意這個和前面的[inet_http_server]對應默認就是http://127.0.0.1:9001。非必須項
;username=chris              ; should be same as in [*_http_server] if set
;password=123                ; should be same as in [*_http_server] if set
;prompt=mysupervisor         ; cmd line prompt (default "supervisor")
;history_file=~/.sc_history  ; use readline history if available
; The sample program section below shows all possible program subsection values.
; Create one or more 'real' program: sections to be able to control them under
; supervisor.

 [program:f5_manage] command=nohup java -jar /home/soft/jarpackage/sr_f5_manage-0.0.1-SNAPSHOT.jar & ; the program (relative uses PATH, can take args)

;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                ; override serverurl computation (childutils)

; The sample eventlistener section below shows all possible eventlistener ; subsection values. Create one or more 'real' eventlistener: sections to be ; able to handle event notifications sent by supervisord. ;[eventlistener:theeventlistenername] ;command=/bin/eventlistener ; 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) ;events=EVENT ; event notif. types to subscribe to (req'd) ;buffer_size=10 ; event buffer queue size (default 10) ;directory=/tmp ; directory to cwd to before exec (def no cwd) ;umask=022 ; umask for process (default None) ;priority=-1 ; the relative start priority (default -1) ;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 ; autorestart 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=false ; redirect_stderr=true is not allowed for eventlisteners ;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 (0 means none, default 10) ;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 (0 means none, default 10) ;stderr_events_enabled=false ; emit events on stderr writes (default false)
 ;environment=A="1",B="2" ; process environment additions ;serverurl=AUTO ; override serverurl computation (childutils) ; The sample group section below shows all possible group values. Create one ; or more 'real' group: sections to create "heterogeneous" process groups. ;[group:thegroupname] ;programs=progname1,progname2 ; each refers to 'x' in [program:x] definitions ;priority=999 ; the relative start priority (default 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] ;files = relative/directory/*.ini

啓動：

1.supervisord  #直接啓動
2.supervisord -c /etc/supervisord.conf  #指定配置文件啓動服務

[root@localhost tmp]# supervisord
/usr/lib/python2.7/site-packages/supervisor/options.py:461: UserWarning: Supervisord is running as root and it is searching for its configuration file in default locations (including its current working directory); you probably want to specify a "-c" argument specifying an absolute path to a configuration file for improved security.
  'Supervisord is running as root and it is searching '
Error: Another program is already listening on a port that one of our HTTP servers is configured to use.  Shut this program down first before starting supervisord.
For help, use /usr/bin/supervisord -h

①【啓動錯誤】若是報這個錯是由於supervisord已經在運行了，

ps -ef | grep supervisord

[root@localhost tmp]# ps -ef | grep supervisord 
root      2886     1  0 16:07 ?        00:00:02 /usr/bin/python /usr/bin/supervisord
#下面這行的意思是用戶root在執行grep --color=auto supervisord的命令，不用管
root 3076 2588 0 19:53 pts/0 00:00:00 grep --color=auto supervisord

#殺掉supervisord服務
kill -9 2886

#再次啓動服務

root@localhost tmp]# supervisord

#下面的提示是但願啓動服務的時候指定具體的配置文件而非默認的，
#當服務有幾個不一樣的配置文件的時候，每次啓動服務的時候能夠根據業務需求選擇使用的配置文件
/usr/lib/python2.7/site-packages/supervisor/options.py:461: UserWarning: Supervisord is running as root and it is searching for its configuration file in default locations (including its current working directory); you probably want to specify a "-c" argument specifying an absolute path to a configuration file for improved security.
'Supervisord is running as root and it is searching '

#這個提示，每次重啓都會提示這個，沒有搞明白爲何，有什麼影響
Unlinking stale socket /tmp/supervisor.sock
#能夠執行下面的命令解決，
sudo unlink /tmp/supervisor.sock

②【使用supervisorctl命令行報錯】一開始supervisorctl沒有配置好就啓動服務了，更改配置後要從新啓動supervisord服務纔可使用命令行

error: <class 'socket.error'>, [Errno 111] Connection refused: file: /usr/lib64/python2.7/socket.py line: 571

③【直接kill掉supervisord以後又重啓，子進程會出現異常】在關閉supervisord服務以前須要先手工關閉被supervisor啓動的子進程。若是直接關掉supervisord服務，那麼被管理的子進程變爲孤兒進程，還存在，以後再重啓supervisord，它會一直嘗試啓動子進程。supervisorctl status查到的pid一直在動態變化，其實就是在嘗試啓動被管理的服務。手工殺掉以前的孤兒進程纔會正常

[root@localhost ~]# netstat -nlp | grep 8007
tcp6       0      0 :::8007                 :::*                    LISTEN      711/java            
[root@localhost ~]# supervisorctl status
f5_manage                        RUNNING   pid 791, uptime 0:00:04
[root@localhost ~]# supervisorctl status
f5_manage                        RUNNING   pid 861, uptime 0:00:05
[root@localhost ~]# supervisorctl status
f5_manage                        RUNNING   pid 885, uptime 0:00:02
[root@localhost ~]# supervisorctl status
f5_manage                        RUNNING   pid 885, uptime 0:00:05
[root@localhost ~]# supervisorctl status
f5_manage                        RUNNING   pid 885, uptime 0:00:08
[root@localhost ~]# supervisorctl status
f5_manage                        STARTING  
[root@localhost ~]# supervisorctl status
f5_manage                        RUNNING   pid 935, uptime 0:00:03
[root@localhost ~]# supervisorctl status
f5_manage                        RUNNING   pid 1006, uptime 0:00:03
[root@localhost ~]# netstat -nlp | grep 8007
tcp6       0      0 :::8007                 :::*                    LISTEN      711/java

　[root@localhost ~]# kill -9 711
　[root@localhost ~]# netstat -nlp | grep 8007
　tcp6 0 0 :::8007 :::* LISTEN 2551/java
　[root@localhost ~]# netstat -nlp | grep 8007
　tcp6 0 0 :::8007 :::* LISTEN 2551/java
　[root@localhost ~]# netstat -nlp | grep 8007
　tcp6 0 0 :::8007 :::* LISTEN 2551/java
　[root@localhost ~]# supervisorctl status f5_manage
　f5_manage RUNNING pid 2551, uptime 0:00:30

ps：正確的操做

①經過supervisorctl加載配置，重啓

# 載入最新的配置文件，中止原有進程並按新的配置啓動、管理全部進程
supervisorctl reload
# 根據最新的配置文件，啓動新配置或有改動的進程，配置沒有改動的進程不會受影響而重啓
supervisorctl update

②經過supervisorctl先停掉全部的子進程再kill supervisord以及重啓

# 中止所有進程，注：start、restart、stop 都不會載入最新的配置文件
supervisorctl stop all

supervisord啓動成功後，能夠經過supervisorctl客戶端控制進程，啓動、中止、重啓。運行supervisorctl命令，不加參數，會進入supervisor客戶端的交互終端，並會列出當前所管理的全部進程

supervisorctl經常使用命令

# 中止某一個進程，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

參考文章：

https://www.cnblogs.com/zhaoding/p/6257363.html

https://www.cnblogs.com/wswang/p/5795766.html

http://blog.51cto.com/lixcto/1539136

https://blog.csdn.net/xyang81/article/details/51555473

https://www.cnblogs.com/zhoujinyi/p/6073705.html

官方文檔:

http://supervisord.org/