介紹

Supervisor在百度百科上給的定義是超級用戶，監(jiān)管員。Supervisor是一個進程管理工具，當進程中斷的時候Supervisor能自動重新啟動它制跟。可以運行在各種類unix的機器上酱虎，supervisor就是用Python開發(fā)的一套通用的進程管理程序雨膨，能將一個普通的命令行進程變?yōu)楹笈_daemon，并監(jiān)控進程狀態(tài)读串，異常退出時能自動重啟聊记。

1）下載并解壓安裝包：

wget https://pypi.python.org/packages/source/s/supervisor/supervisor-4.2.2.tar.gz

tar zvxf supervisor-4.2.2.tar.gz -C ./

2）安裝：

cd supervisor-4.2.2/

python3 setup.py install

3）驗證安裝是否成功？

執(zhí)行 echo_supervisord_conf 命令恢暖，輸出一堆配置信息即可排监，類似于：

image.png

4）創(chuàng)建目錄，初始化配置

mkdir /usr/supervisor
echo_supervisord_conf > /usr/supervisor/supervisord.conf

• /usr/supervisor/supervisord.conf 配置文件中 ; (英文分號)表示注釋*

• 添加自己的配置目錄：
  mkdir /var/run/supervisor
  mkdir -p /var/log/supervisor/
  mkdir /usr/supervisor/supervisord.d/
  vim /usr/supervisor/supervisord.conf # 修改如下：

    ; include 上面新建的supervisord.d文件夾下所有的conf
    [include]
    files = /usr/supervisor/supervisord.d/*.conf

    ; 若需要web查看進程杰捂，則去掉[inet_http_server]的注釋
    [inet_http_server] ; inet (TCP) server disabled by default
    port=ip:9001 ; ip_address:port specifier, *:port for all iface
    username=admin ; default is no username (open server)
    password=123456 ; default is no password (open server)
 
[unix_http_server]
file=/var/run/supervisor/supervisor.sock ; socket 路徑

[supervisord] ; supervisord 全局配置
logfile=/var/log/supervisor/supervisord.log ; supervisor 日志路徑

pidfile=/var/run/supervisord.pid ; pid 文件路徑

[supervisorctl]
serverurl=unix:///var/run/supervisor/supervisor.sock ; use a unix:// URL for a unix socket

5）啟動

python3 /usr/local/python3/bin/supervisord -c /usr/supervisor/supervisord.conf

• 查看端口監(jiān)聽

   lsof -i:9001

image.png

• 訪問web頁面：

  http://ip:9001/
  admin/123456

6）添加配置文件舆床，監(jiān)控維護自己的進程

注意：添加自己的某個進程之前，需要先kill掉該進程嫁佳。supervisor會自動啟動配置里的進程

• vim /usr/supervisor/supervisord.d/test.conf

[program:test1]
    directory=/xx/xx      ;程序目錄
    command=nohup java -Xms128m -Xmx128m -jar xx.jar >/dev/null 2>&1 & ; 被監(jiān)控的進程路徑
    priority=1 ; 數(shù)字越高挨队，優(yōu)先級越高
    numprocs=1 ; 啟動幾個進程
    autostart=true ; 隨著supervisord的啟動而啟動
    autorestart=true ; 自動重啟
    startretries=10 ; 啟動失敗時的最多重試次數(shù)
    exitcodes=0 ; 正常退出代碼
    stopsignal=KILL ; 用來殺死進程的信號
    stopwaitsecs=10 ; 發(fā)送SIGKILL前的等待時間
    redirect_stderr=true ; 重定向stderr到stdout
   stdout_logfile_maxbytes = 20MB ; stdout 日志文件大小，默認 50MB
   stdout_logfile_backups = 20 ; stdout 日志文件備份數(shù)
    ; stdout 日志文件蒿往，需要注意當指定目錄不存在時無法正常啟動瞒瘸，所以需要手動創(chuàng)建目錄（supervisord 會自動創(chuàng)建日志文件）
    stdout_logfile = /xx/logs/xxx.log

• 重載配置文件

supervisorctl -c /usr/supervisor/supervisord.conf
    > reload

• 查看自己添加的進程是否起來
  ps -ef |grep xx.jar

7) supervisord添加開機自啟動

新建 vim /usr/lib/systemd/system/supervisord.service ,并添加配置內(nèi)容：

[Unit]
Description=Process Monitoring and Control Daemon
After=rc-local.service nss-user-lookup.target

[Service]
Type=forking
ExecStart=/usr/bin/python3 /usr/local/bin/supervisord -c /usr/supervisor/supervisord.conf
ExecStop=/usr/local/bin/supervisord shutdown
ExecReload=/usr/local/bin/supervisord reload
Restart=on-failure
RestartSec=42s

[Install]
WantedBy=multi-user.target

啟動服務
systemctl enable supervisord

驗證一下是否為開機啟動
systemctl is-enabled supervisord

啟動服務
systemctl start supervisord

輸出： enabled

8） supervisor常用命令

• 查看supervisorctl支持的命令

supervisorctl help 

image.png

• 命令解釋：

  status 查看當前運行的進程列表
  update 更新新的配置到supervisord（不會重啟原來已運行的程序）
  reload 載入所有配置文件，并按新的配置啟動熄浓、管理所有進程（會重啟原來已運行的程序）
  start xxx: 啟動某個進程
  restart xxx: 重啟某個進程
  stop xxx: 停止某一個進程(xxx)情臭，xxx為[program:theprogramname]里配置的值
  stop groupworker: 重啟所有屬于名為groupworker這個分組的進程(start,restart同理)
  stop all，停止全部進程赌蔑，注：start俯在、restart、stop都不會載入最新的配置文
  reread娃惯，當一個服務由自動啟動修改為手動啟動時執(zhí)行一下就ok</pre>

• 命令使用示例：

supervisorctl -c /usr/supervisor/supervisord.conf
> reload

9）echo_supervisord_conf 配置詳解：

; 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 管理的服務狀態(tài)）
;port=127.0.0.1:9001 ; 監(jiān)聽的IP及端口
;username=user ; 用戶名
;password=123 ; 密碼

[supervisord] ; supervisord 全局配置
logfile=/var/log/supervisor/supervisord.log ; supervisor 日志路徑
logfile_maxbytes=50MB ; 單個日志文件最大數(shù)
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 ; 最小文件打開數(shù)愕提，對應系統(tǒng)limit.conf 中的nofile ,默認最小為1024，最大為4096
minprocs=200 ; 最小的進程打開數(shù)皿哨，對應系統(tǒng)的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](unix://confluence.yzf.net/var/run/supervisor/supervisor.sock) ; use a unix:// URL for a unix socket
;serverurl=[http://127.0.0.1:9001](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嘗試啟動一個程序時嘗試的次數(shù)。默認是3
;exitcodes=0,2 ; 一個預期的退出返回碼过牙，默認是0,2甥厦。
;stopsignal=QUIT ; 當收到stop請求的時候，發(fā)送信號給程序寇钉，默認是TERM信號刀疙，也可以是 HUP, INT, QUIT, KILL, USR1, or USR2
;stopwaitsecs=10 ; 在操作系統(tǒng)給supervisord發(fā)送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 ; 標準輸出日志輪轉備份的數(shù)量集歇，默認是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參數(shù)被設置為true
;stderr_logfile_maxbytes=1MB ; 錯誤log文件達到多少后自動進行輪轉它掂，單位是KB、MB、GB虐秋。如果設置為0則表示不限制日志文件大小
;stderr_logfile_backups=10 ; 錯誤日志輪轉備份的數(shù)量榕茧，默認是10，如果設置為0，則不備份
;stderr_capture_maxbytes=1MB ; 當進程處于stderr capture mode模式的時候，寫入FIFO隊列的最大bytes值诡渴，單位可以是KB缴允、MB、GB
;stderr_events_enabled=false ; 如果設置為true沫浆，當進程在寫它的stderr到文件描述符的時候，PROCESS_LOG_STDERR事件會被觸發(fā)
;environment=A=1,B=2 ; 一個k/v對的list列表
;serverurl=AUTO ; 是否允許子進程和內(nèi)部的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 環(huán)境變量
user=elk ; 啟動elasticsearch 的用戶
directory=/usr/local/elasticsearch ; 進入到這個目錄中
command=/usr/local/elasticsearch/bin/elasticsearch ; 執(zhí)行啟動命令
numprocs=1 ; Supervisor啟動這個程序的多個實例，如果numprocs>1坑匠，則process_name的表達式必須包含%(process_num)s血崭，默認是1
autostart=true ; 設置為隨 supervisord 啟動而啟動
autorestart=true ; 設置為隨 supervisord 重啟而重啟
startretries=3 ; 設置elasticsearch 重啟的重試次數(shù)
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