Supervisor: 進程控制系統

概述：Supervisor是一個 Client/Server模式的系統，允許用戶在類unix操作系統上監視和控制多個進程，或者可以說是多個程序。

它與launchd，daemontools，runit等程序有着相同的功能，與其中某些程序不同的是，它並不作為“id 為 1的進程”而替代init。相反，它用於控制應用程序，像啟動其它程序一樣，通俗理解就是，把Supervisor服務管理的進程程序，它們作為supervisor的子進程來運行，而supervisor是父進程。supervisor來監控管理子進程的啟動關閉和異常退出后的自動啟動。

一、Supervisor與系統自帶init 進程管理比較

方便：有些編譯運行的程序，在安裝完成后，需要為他們編寫啟動停止管理腳本，寫入和維護可能很痛苦，而且進程在異常崩潰結束時，許多程序都不會正確重新啟動的。Supervisord啟動管理的程序進程是作為其子進程來運行的，並且可以配置為在進程崩潰停止時自動重新啟動它們。

准確：在Unix上的進程通常很難獲得准確的up/down狀態。Pidfiles經常說謊。Supervisord將進程作為子進程啟動，所以它總是知道其子進程的正確的up/down狀態，可以方便的對這些數據進行查詢

進程分組：進程支持分組啟動和停止，也支持啟動順序，即‘優先級’，supervisor允許為進程分配優先級，並允許用戶通過supervisorctl客戶端發出命令，如“全部啟動”和”重新啟動所有“，它們以預先分配的優先級順序啟動。還可以將進程分為”進程組“，一組邏輯關聯的進程可以作為一個單元停止或啟動。

Supervisor的特點：

簡單：supervisor通過簡單的INI風格的配置文件進行配置管理，易於學習，並提供了許多每個進程選項，如重新啟動失敗的進程和日志的自動切割。

集中：supervisor提供一個start、stop和監控進程的地方，進程可以單獨或分組進行控制。可以通過supervisor的本地或遠程命令行管理和web管理（一般為了安全，web通常需要禁用）

高效：supervisor通過fork/exec啟動子進程，子進程需要前台運行，操作系統進程終止時去通知supervisor，而不像一些我們需要寫腳本去定期輪詢PID文件來重新啟動失敗的進程。

可擴展：supervisor有一個簡單的事件（event）通知協議，還有一個用於控制的XML-RPC接口，可以用Python開發人員來擴展構建。

兼容：supervisor由Python編寫，在除Windows操作系統以外基本都支持，如linux，Mac OS x,solaris,FreeBSD系統

 

Supervisor的組建構成

Supervisord：supervisor服務器的進程名是supervisord。它主要負責在自己的調用中啟動子程序，響應客戶端的命令，重新啟動崩潰或退出的進程，記錄其子進程stdout和stderr的輸出，以及生成和處理對應於子進程生命周期中的”event“

服務器進程使用的配置文件，通常路徑存放在/etc/supervisord.confa中。此配置文件是INI格式的配置文件。

supervisorctl：supervisor命令行的客戶端名稱是supervisorctl。它為supervisord提供了一個類似於shell的交互界面。使用supervisorctl，用戶可以查看不同的supervisord進程列表，獲取控制子進程的狀態，如停止和啟動子進程

web服務器：一個可以通過Web界面來查看和控制進程的狀態，默認監聽在9091上。

 

二、Supervisord的安裝配置

1.安裝

安裝分為有網絡安裝和無網絡安裝，由於無網絡安裝環節需要在有網絡的主機上進行依賴包下載，所以相對繁瑣麻煩，如果本機沒有網絡，可以考慮使用squid代理來進行安裝，本文介紹的是有網絡安裝。

安裝命令可以使用easy_install supervisor或者 pip install supervisor 或者去pypi官網上下載最新版本進行解壓安裝。也可以使用yum或者apt，但不保證是最新版本。

我這里使用的是pip方式來安裝。默認系統里是沒有pip python包管理程序的，先來安裝下pip吧。更新下yum 源

# curl -o /etc/yum.repos.d/CentOS-Base.repo http://mirrors.aliyun.com/repo/Centos-6.repo

下載pip安裝腳本並直接安裝

# curl -o /tmp/get-pip.py https://bootstrap.pypa.io/get-pip.py && python /tmp/get-pip.py

 安裝今天的豬腳supervisor程序

# pip install supervisor

2.生成配置文件

用supervisor自帶命令生成一個標准的配置文件

/usr/bin/echo_supervisord_conf > /etc/supervisord.conf

遇到的故障 1：如果在這生成配置文件時，遇到以下故障：

 ~]# echo_supervisord_conf > /etc/supervisord.conf
Traceback (most recent call last):
  File "/usr/bin/echo_supervisord_conf", line 5, in <module>
    from pkg_resources import load_entry_point
  File "/usr/lib/python2.6/site-packages/pkg_resources.py", line 2655, in <module>
    working_set.require(__requires__)
  File "/usr/lib/python2.6/site-packages/pkg_resources.py", line 648, in require
    needed = self.resolve(parse_requirements(requirements))
  File "/usr/lib/python2.6/site-packages/pkg_resources.py", line 546, in resolve
    raise DistributionNotFound(req)
pkg_resources.DistributionNotFound: meld3>=0.6.5

解決:檢查你的meld3版本有沒有安裝，另外安裝時，不要使用最新的版本（在本文發表之前一直最新版本是meld3-1.0.2）,可以安裝除1.0.2之前的並且大於0.6.5的版本，使用

pip命令檢查當前的meld3版本，可以看到當前版本默認安裝了最新版1.0.2

 ~]# pip list
distribute (0.6.10)
iniparse (0.3.1)
meld3 (1.0.2)
pip (9.0.1)
pycurl (7.19.0)
pygpgme (0.1)
setuptools (0.6rc11)
supervisor (3.3.1)
urlgrabber (3.9.1)
yum-metadata-parser (1.1.2)

先卸載當前meld3，之后用pip install 安裝指定版本即可，如下：

 ~]# pip uninstall meld3
 ~]# pip install meld3==1.0.0

 然后再運行第1部分處生成配置文件的命令。
本文屬於原創文章，碼字辛苦，轉載前請注明出處，飛走不可：Supervisor: 進程控制系統 http://www.cnblogs.com/hanyifeng/p/6728151.html

3. 這里穿插下supervisor 和supervisorctl命令使用的配置文件含義

 ~]# cat /etc/supervisord.conf
; Sample supervisor config file.
;
; For more information on the config file, please see:
; http://supervisord.org/configuration.html
;
; Notes:
;  - Shell expansion ("~" or "$HOME") is not supported.  Environment
;    variables can be expanded using this syntax: "%(ENV_HOME)s".
;  - Comments must have a leading space: "a=b ;comment" not "a=b;comment".

[unix_http_server]
file=/tmp/supervisor.sock   ; (socket 文件的路徑)
;chmod=0700                 ; socket 文件權限 (default 0700)
;chown=nobody:nogroup       ; socket 文件屬主:屬組
;username=user              ; (啟動http的用戶 (open server))
;password=123               ; (默認的密碼 (open server))

;[inet_http_server]         ; 默認禁用tcp監聽的http 服務
;port=127.0.0.1:9001        ; (指定監聽在本機ip地址和端口)
;username=user              ; (默認啟動http服務的用戶)
;password=123               ; (默認的密碼)

[supervisord]
logfile=/tmp/supervisord.log ; (主日志文件的存放位置，默認在程序的工作啟動目錄)
logfile_maxbytes=50MB        ; (主日志文件的最大值，之后進行切割;默認 50MB)
logfile_backups=10           ; (主日志文件備份的數目;默認 10)
loglevel=info                ; (日志級別;默認是info; 其它: debug,warn,trace)
pidfile=/tmp/supervisord.pid ; (supervisord 運行時的pidfile路徑;默認 supervisord.pid)
nodaemon=false               ; (如果為true，程序就以前台運行;默認是 false)
minfds=1024                  ; (min. 啟動有效的文件描述符數目;默認 1024)
minprocs=200                 ; (min. 有效進程描述符;默認 200)
;umask=022                   ; (進程文件創建的默認權限;默認 022)
;user=chrism                 ; (默認是當前啟動的用戶)
;identifier=supervisor       ; (supervisord 標識符, 默認是'supervisor')
;directory=/tmp              ; (默認啟動時間不會切換)
;nocleanup=true              ; (在啟動時不清理臨時文件；默認值為false)
;childlogdir=/tmp            ; ('AUTO' 子進程日志目錄, 默認 $TEMP)
;environment=KEY="value"     ; (增加一個環境變量鍵值對：key=”value“)
;strip_ansi=false            ; (在log日志里去掉ansi轉義編碼; 默認是 false)

; 下面的部分選項必須保留在RPC的配置文件中
; (supervisorctl/web 接口) 使用以下配置來管理
; added by defining them in separate rpcinterface: sections
[rpcinterface:supervisor]
supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface

[supervisorctl]
serverurl=unix:///tmp/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

; 以下是被管理的示例程序顯示所有可能用到的配置。
; 創建一個或“多個”程序: 要遵循以下的鍵值對規則。
; supervisor.

;[program:theprogramname]
;command=/bin/cat              ; 程序的啟動命令 (使用絕對路徑)
;process_name=%(program_name)s ; process_name 表示 (默認是 %(program_name)s)
;numprocs=1                    ; 啟動時的進程數 (默認 1)
;directory=/tmp                ; 執行時切換到的目錄 (def no cwd)
;umask=022                     ; umask for process (default None)
;priority=999                  ; 相對啟動優先級(default 999)
;autostart=true                ; 是否跟隨supervisord程序啟動該監控程序 (default: true)
;startsecs=1                   ; # 在設定時間內，程序必須保持運行 (def. 1)
;startretries=3                ; 當啟動失敗時嘗試的最大次數(default 3)
;autorestart=unexpected        ; 如果退出后，什么狀態退出的去重啟，默認非意外的(def: unexpected)
;exitcodes=0,2                 ; 'expected' 符合退出代碼之后去重啟 (default 0,2)
;stopsignal=QUIT               ; 用於殺死進程的信號 (default TERM)
;stopwaitsecs=10               ; 最大等待秒數 SIGKILL (default 10)
;stopasgroup=false             ; 發送停止信號到Unix進程組 (default false)
;killasgroup=false             ; SIGKILL UNIX進程組 (def false)
;user=chrism                   ; setuid to this UNIX account to run the program
;redirect_stderr=true          ; 是否開啟程序標准錯誤輸出的重定向 (default false)
;stdout_logfile=/a/path        ; 標准輸出路徑; default AUTO
;stdout_logfile_maxbytes=1MB   ; 文件最大大小 # 日志文件進行切割 (default 50MB)
;stdout_logfile_backups=10     ; # 日志文件備份數目 (default 10)
;stdout_capture_maxbytes=1MB   ; ‘捕獲模式’中的字節數 (default 0)
;stdout_events_enabled=false   ; 在標准輸出寫入文件時發出事件 (default false)
;stderr_logfile=/a/path        ; 標准錯誤輸出, NONE for none; default AUTO
;stderr_logfile_maxbytes=1MB   ; 文件最大大小 # 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"       ; 添加進程環境變量 (def no adds)
;serverurl=AUTO                ; 覆蓋serverurl計算 (childutils)

;下面是event事件部分所有可能設置的值，大部分同上面一樣。
; eventlistener subsection values, create one or more 'real'
; eventlistener: sections to be able to handle event notifications
; sent by supervisor.

;[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 (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 (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  ; 這里的progname1，progname2就是定義的監控管理程序的名字，如[program:x]這里就是x
;priority=999                  ; the relative start priority (default 999)

;  下面的 [include] 選項只能包含一個files 設置，功能是定義supervisor管理程序的配置文件，可以單獨的移除去，和主配置文件分開，方便。
; 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         ；定義管理監控程序的配置文件的路徑

 4.創建supervisor 存放監控程序的目錄，並修改supervisod.conf文件

~]# mkdir -pv /etc/supervisor/config.d

修改supervisord 主程序文件，可以

sed -i '$ a [include]' /etc/supervisord.conf
sed -i '$ a files = /etc/supervisor/config.d/*.ini' /etc/supervisord.conf

 5.然后拷貝以下supervisor程序的 啟動停止控制腳本內容到init.d下，並賦予執行權限。腳本內容如下：

#!/bin/sh
#
# /etc/init.d/supervisord
#
# Supervisor is a client/server system that
# allows its users to monitor and control a
# number of processes on UNIX-like operating
# systems.
#
# chkconfig: - 64 36
# description: Supervisor Server
# processname: supervisord
# config: /etc/supervisord.conf
# pidfile: /var/run/supervisord.pid

# Source init functions
. /etc/rc.d/init.d/functions

prog="supervisord"

prefix="/usr/"
exec_prefix="${prefix}"
prog_bin="${exec_prefix}/bin/supervisord"
PIDFILE="/var/run/$prog.pid"

start()
{
       echo -n $"Starting $prog: "
       daemon $prog_bin -c /etc/supervisord.conf --pidfile $PIDFILE
       [ -f $PIDFILE ] && failure $"$prog startup" || success $"$prog startup"
       echo
}

stop()
{
       echo -n $"Shutting down $prog: "
       [ -f $PIDFILE ] && killproc $prog || success $"$prog shutdown"
       echo
}

case "$1" in

 start)
   start
 ;;

 stop)
   stop
 ;;

 status)
       status $prog
 ;;

 restart)
   stop
   start
 ;;

 *)
   echo "Usage: $0 {start|stop|restart|status}"
 ;;

esac

6.設置tomcat的配置文件和guacd的配置文件,存放到之前設置的文件存放目錄/etc/supervisor/config.d/.,

tomcat.ini

#!/usr/bin/python
[program:tomcat]
command=/usr/share/tomcat/bin/catalina.sh run
stdout_logfile=/var/log/tomcat/catalina.out
stdout_logfile_maxbytes=20MB
autostart=true
autorestart=true
startsecs=5
priority=3
stopasgroup=true
killasgroup=true

 guacd.ini

#!/usr/bin/python
[program:guacd]
command=/usr/local/sbin/guacd -b 0.0.0.0 -l 4822 -p /var/run/guacd.pid -f
stdout_logfile=/var/log/guacd/guacd.log
stdout_logfile_maxbytes=100MB
user=root
autostart=true
autorestart=true
startsecs=5
priority=3
stopasgroup=true
killasgroup=true

根據guacd 程序的配置，需要給其創建一個程序的日志目錄。

~]# mkdir /var/log/guacd

7.將原有的服務，從daemon方式停止掉，並禁止開機自啟動。讓supervisor來管理服務

 ~]# service tomcat stop
 ~]# service guacd stop
 ~]# chkconfig tomcat off
 ~]# chkconfig guacd off

8.啟動supervisor 程序，

]# /etc/init.d/supervisord start
Starting supervisord:                                      [  OK  ]

這時沒問題的話，tomcat服務和guacd服務已經由supervisord父進程來控制了。可以使用supervisorctl 客戶端命令來交互檢查服務運行

 ~]# supervisorctl 
guacd                            RUNNING   pid 2222, uptime 0:00:08
tomcat                           RUNNING   pid 2223, uptime 0:00:08

 也可以使用命令行里試用supervisorctl 來檢查控制被監控進程

 

 ~]# supervisorctl status tomcat
tomcat                           RUNNING   pid 2223, uptime 0:06:24
 ~]# supervisorctl stop tomcat
tomcat: stopped
 ~]# supervisorctl status tomcat
tomcat                           STOPPED   Apr 27 05:06 PM

9.測試驗證進程是否自動守護

先檢查下guacd服務的運行狀態

~]# supervisorctl status guacd
guacd                            RUNNING   pid 2222, uptime 0:10:23

之后手動殺死該進程

~]# kill 2222

間隔幾秒鍾，程序就會自動啟動該程序。按設定的應該是5秒。可以設置2~5秒。

~]# supervisorctl status guacd
guacd                            RUNNING   pid 2552, uptime 0:06:24

從上面可以看到，supervisord程序很快的啟動了一個guacd的進程。guacd服務也很快恢復到正常狀態。

 

三、總結

　　supervisor程序的特性就是可以很好的控制我們的一些前端運行（不是以dameon方式運行的）的程序，或者說該程序在運行時不穩定，有會被異常殺死的情況（可能是內存泄漏，可能是異常崩潰，等其他問題），通過使用supervisor來管理監控程序的運行，當失敗的時候，自動啟動服務。

　　文中如有錯誤之處，還望大家及時指出。也歡迎大家在留言區交流哈。

 

本文屬於原創文章，碼字辛苦，轉載前請注明出處，飛走不可：Supervisor: 進程控制系統 http://www.cnblogs.com/hanyifeng/p/6728151.html

 

 

 

參考鏈接：

http://supervisord.org/index.html