1.Supervisor介紹
介紹1:supervisor是一個管理進程的工具,使用python語言開發的通用的管理程序,可以管理和監控Linux上的指定進程,能將進程變成後臺的daemon,並監控進程狀態,出現異常退出時能自動重啓。
介紹2:在 web 應用部署到線上後,需要保證應用一直處於運行狀態,在遇到程序異常、報錯等情況,導致 web 應用終止時,需要保證程序可以立刻重啓,繼續提供服務。所以,就需要一個工具,時刻監控 web 應用的運行情況,管理該進程。Supervisor 就是解決這種需求的工具,可以保證程序崩潰後,重新把程序啓動起來等功能。
2.安裝與配置
2.1安裝
我使用的是centos版本,各版本安裝可能有區別,請自行百度
執行以下命令:
yum install epel-release
繼續執行以下命令
yum install -y supervisor
2.1.1 查看是否安裝成功
echo_supervisord_conf
出現以上信息就說明安裝成功了
tip: 相關命令
# systemctl enable supervisord # 開機自啓動
# systemctl start supervisord # 啓動supervisord服務
# systemctl status supervisord # 查看supervisord服務狀態
# ps -ef|grep supervisord # 查看是否存在supervisord進程
2.2 配置
2.2.1 初始化配置文件到指定目錄
mkdir /usr/supervisor //創建目錄
echo_supervisord_conf > /usr/supervisor/supervisord.conf 初始化配置到指定文件
查看路勁/usr/supervisor/supervisord.conf 的配置文件,這裏解釋一下
supervisord.conf文件介紹
[root@centos-011 ~ 07:50:00]#cat /etc/supervisord.conf.bak
; Sample supervisor config file.
[unix_http_server]
file=/var/run/supervisor/supervisor.sock ; socket 路徑
;chmod=0700 ; socket 文件的權限
;chown=nobody:nogroup ; socket 所屬用戶及組
;username=user ; 用戶名
;password=123 ; 密碼
;[inet_http_server] ; 是否啓用服務,默認是關閉的(啓用的話可以看到supervisor 管理的服務狀態)
;port=127.0.0.1:9001 ; 監聽的IP及端口
;username=user ; 用戶名
;password=123 ; 密碼
[supervisord] ; supervisord 全局配置
logfile=/var/log/supervisor/supervisord.log ; supervisor 日誌路徑
logfile_maxbytes=50MB ; 單個日誌文件最大數
logfile_backups=10 ; 保留多少個日誌文件(默認10個)
loglevel=info ; (log level;default info; others: debug,warn,trace)
pidfile=/var/run/supervisord.pid ; pid 文件路徑
nodaemon=false ; 啓動是否丟到前臺,設置爲false ,表示以daemon 的方式啓動
minfds=1024 ; 最小文件打開數,對應系統limit.conf 中的nofile ,默認最小爲1024,最大爲4096
minprocs=200 ; 最小的進程打開數,對應系統的limit.conf 中的nproc,默認爲200
;umask=022 ; (process file creation umask;default 022)
;user=chrism ; 啓動supervisord 服務的用戶,默認爲root
;identifier=supervisor ; (supervisord identifier, default is 'supervisor')
;directory=/tmp ; 這裏的目錄指的是服務的工作目錄
;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 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]
supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
[supervisorctl]
serverurl=unix:///var/run/supervisor/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
;prompt=mysupervisor ; cmd line prompt (default "supervisor")
;history_file=~/.sc_history ; use readline history if available
; 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] ; 定義一個守護進程 ,比如下面的elasticsearch
;command=/bin/cat ; 啓動程序使用的命令,可以是絕對路徑或者相對路徑
;process_name=%(program_name)s ; 一個python字符串表達式,用來表示supervisor進程啓動的這個的名稱,默認值是%(program_name)s
;numprocs=1 ; Supervisor啓動這個程序的多個實例,如果numprocs>1,則process_name的表達式必須包含%(process_num)s,默認是1
;directory=/tmp ; supervisord在生成子進程的時候會切換到該目錄
;umask=022 ; umask for process (default None)
;priority=999 ; 權重,可以控制程序啓動和關閉時的順序,權重越低:越早啓動,越晚關閉。默認值是999
;autostart=true ; 如果設置爲true,當supervisord啓動的時候,進程會自動啓動
;autorestart=true ; 設置爲隨 supervisord 重啓而重啓,值可以是false、true、unexpected。false:進程不會自動重啓
;startsecs=10 ; 程序啓動後等待多長時間後才認爲程序啓動成功,默認是10秒
;startretries=3 ; supervisord嘗試啓動一個程序時嘗試的次數。默認是3
;exitcodes=0,2 ; 一個預期的退出返回碼,默認是0,2。
;stopsignal=QUIT ; 當收到stop請求的時候,發送信號給程序,默認是TERM信號,也可以是 HUP, INT, QUIT, KILL, USR1, or USR2
;stopwaitsecs=10 ; 在操作系統給supervisord發送SIGCHILD信號時等待的時間
;user=chrism ; 如果supervisord以root運行,則會使用這個設置用戶啓動子程序
;redirect_stderr=true ; 如果設置爲true,進程則會把標準錯誤輸出到supervisord後臺的標準輸出文件描述符
;stdout_logfile=/a/path ; 把進程的標準輸出寫入文件中,如果stdout_logfile沒有設置或者設置爲AUTO,則supervisor會自動選擇一個文件位置
;stdout_logfile_maxbytes=1MB ; 標準輸出log文件達到多少後自動進行輪轉,單位是KB、MB、GB。如果設置爲0則表示不限制日誌文件大小
;stdout_logfile_backups=10 ; 標準輸出日誌輪轉備份的數量,默認是10,如果設置爲0,則不備份
;stdout_capture_maxbytes=1MB ; 當進程處於stderr capture mode模式的時候,寫入FIFO隊列的最大bytes值,單位可以是KB、MB、GB
;stdout_events_enabled=false ; 如果設置爲true,當進程在寫它的stderr
;stderr_logfile=/a/path ; 把進程的錯誤日誌輸出一個文件中,除非redirect_stderr參數被設置爲true
;stderr_logfile_maxbytes=1MB ; 錯誤log文件達到多少後自動進行輪轉,單位是KB、MB、GB。如果設置爲0則表示不限制日誌文件大小
;stderr_logfile_backups=10 ; 錯誤日誌輪轉備份的數量,默認是10,如果設置爲0,則不備份
;stderr_capture_maxbytes=1MB ; 當進程處於stderr capture mode模式的時候,寫入FIFO隊列的最大bytes值,單位可以是KB、MB、GB
;stderr_events_enabled=false ; 如果設置爲true,當進程在寫它的stderr到文件描述符的時候,PROCESS_LOG_STDERR事件會被觸發
;environment=A=1,B=2 ; 一個k/v對的list列表
;serverurl=AUTO ; 是否允許子進程和內部的HTTP服務通訊,如果設置爲AUTO,supervisor會自動的構造一個url
; 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.
#這個地方是自定義一個守護進程
[program:elasticsearch] ; 定義一個守護進程 elasticsearch
environment=ES_HOME=/usr/local/elasticsearch ; 設置ES_HOME 環境變量
user=elk ; 啓動elasticsearch 的用戶
directory=/usr/local/elasticsearch ; 進入到這個目錄中
command=/usr/local/elasticsearch/bin/elasticsearch ; 執行啓動命令
numprocs=1 ; Supervisor啓動這個程序的多個實例,如果numprocs>1,則process_name的表達式必須包含%(process_num)s,默認是1
autostart=true ; 設置爲隨 supervisord 啓動而啓動
autorestart=true ; 設置爲隨 supervisord 重啓而重啓
startretries=3 ; 設置elasticsearch 重啓的重試次數
priority=1 ; 權重,可以控制程序啓動和關閉時的順序,權重越低:越早啓動,越晚關閉。默認值是999
;[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)
;autorestart=unexpected ; restart at unexpected quit (default: unexpected)
;startsecs=10 ; number of secs prog must stay running (def. 1)
;startretries=3 ; max # of serial start failures (default 3)
;exitcodes=0,2 ; 'expected' exit codes for process (default 0,2)
;stopsignal=QUIT ; signal used to kill process (default TERM)
;stopwaitsecs=10 ; max num secs to wait b4 SIGKILL (default 10)
;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_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 ; # of stderr logfile backups (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 below sample group section shows all possible group values,
; create one or more 'real' group: sections to create "heterogeneous"
; process groups.
;[group:thegroupname] ; 服務組管理,可以將多個服務名寫到這裏管理(組名自定義)
;programs=progname1,progname2 ; 上面配置好的服務名,比如elasticsearch,kibana,logstash
;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 = supervisord.d/*.ini
注:修改文件中下圖圈中的三個地方
2.2.2 爲了方便管理配置文件,新建一個應用程序配置文件夾
mkdir /usr/supervisor/supervisord.d/
2.2.3 修改系統配置文件,也就是剛纔解釋的supervisord.conf文件
vim /usr/supervisor/supervisord.conf
在supervisord.conf文件末尾添加自定義的配置文件夾
tip:若需要web查看進程,則去掉[inet_http_server]的註釋,我選擇不去掉,沒多大用
2.2.4 在2.2.2步驟創建的自定義配置文件夾中創建一個自定義配置文件 myapp.conf
我是直接使用vi命令創建文件
輸入以下內容保存退出:
解釋:
[program:blog-admin] //app1 被管理的後臺應用名,可以自定義
command=java -jar /workspace/servers/supervisord/blog-admin.jar //執行的命令和文件路徑
priority=1 //被守護的優先級 數字越高,優先級越高
numprocs=1 //啓動幾個進程
autostart=true //隨着supervisord的啓動而啓動
autorestart=true //自動重啓
startretries=5 //啓動失敗重試次數
exitcodes=0 //正常退出代碼
stopsignal=KILL //用來殺死進程的信號
stopwaitsecs=10 //發送SIGKILL前的等待時間
redirect_stderr=true //重定向stderr到stdout
2.2.5 啓動supervisor 刷新配置
supervisorctl -c /usr/supervisor/supervisord.conf
2.2.6 執行命令查看配置的應用程序
可以看到,我們配置的程序已經伴隨着supervisor啓動而啓動了,在查看一下應用程序及端口
netstat -nltp
程序正常起來了
2.2.7 測一下接口
然後修改自定義配置文件myapp.conf,在新配置兩個應用程序
使用命令 刷新下配置
supervisorctl update
然後查看新配置的應用程序有沒有生效:
supervisorctl
成功,到此結束!
tip:貼一下supervisor常用命令
#supervisorctl update 更新新的配置到supervisord(不會重啓原來已運行的程序)
#supervisorctl reload,載入所有配置文件,並按新的配置啓動、管理所有進程(會重啓原來已運行的程序)
#supervisorctl start xxx: 啓動某個進程
#supervisorctl restart xxx: 重啓某個進程
#supervisorctl stop xxx: 停止某一個進程(xxx),xxx爲[program:theprogramname]裏配置的值
#supervisorctl stop groupworker: 重啓所有屬於名爲groupworker這個分組的進程(start,restart同理)
#supervisorctl stop all,停止全部進程
以上命令都可以先執行 supervisorctl後,然後再執行啓動,停止等操作(啓動,停止我喜歡這樣),類似於這樣:
注:start、restart、stop都不會載入最新的配置文
總結:
這個工具我們是用來管理微服務多個服務的,由於演示,我只配置了一個項目,實際上如果只有一個項目完全沒有必要用這個,用這個管理多個服務jar包非常方便!
ps:安裝這個鬼東西,花了我不少時間,遇到一些奇奇怪怪的錯誤,有些莫名奇妙又好了,所以我沒記錄,如果大家遇到就查一下,有問題再給我留言。