supervisor詳解

supervisor詳解

Supervisor是一個進程管理系統，允許其用戶監視和控制類UNIX操作系統上的大量進程。

其通過fork/exec的方式將這些被管理的進程當作supervisor的子進程來啓動，
我們只需要將被管理進程配置文件置於配置子模塊中。此時被管理進程被視爲supervisor的子進程，若該子進程異常終端，則父進程可以準確的獲取子進程異常終端的信息。
 

supervisor配置文件：

; Sample supervisor config file.

[unix_http_server]
file=/var/run/supervisor/supervisor.sock   ; (the path to the socket file)
;chmod=0700                 ; sockef 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]         ; inet (TCP) server disabled by default
;port=127.0.0.1:9001        ; (ip_address:port specifier, *:port for all iface)
;username=user              ; (default is no username (open server))
;password=123               ; (default is no password (open server))

[supervisord]
logfile=/var/log/supervisor/supervisord.log  ; (main log file;default $CWD/supervisord.log)
logfile_maxbytes=50MB       ; (max main logfile bytes b4 rotation;default 50MB)
logfile_backups=10          ; (num of main logfile rotation backups;default 10)
loglevel=info               ; (log level;default info; others: debug,warn,trace)
pidfile=/var/run/supervisord.pid ; (supervisord pidfile;default supervisord.pid)
nodaemon=false              ; (start in foreground if true;default false)
minfds=1024                 ; (min. avail startup file descriptors;default 1024)
minprocs=200                ; (min. avail process descriptors;default 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 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]
;command=/bin/cat              ; 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)
;directory=/tmp                ; directory to cwd to before exec (def no cwd)
;umask=022                     ; umask for process (default None)
;priority=999                  ; the relative start priority (default 999)
;autostart=true                ; start at supervisord start (default: true)
;autorestart=true              ; retstart at unexpected quit (default: true)
;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_capture_maxbytes=1MB   ; number of bytes in 'capturemode' (default 0)
;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_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           ; process environment additions (def no adds)
;serverurl=AUTO                ; override serverurl computation (childutils)

; 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]
;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  ; 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 = supervisord.d/*.conf

 
此文件配置分爲一下幾個部分：

• [unix_http_server]: 這部分爲以socket方式啓動的supervisor的啓動配置項
  • file: socket套接字的文件目錄，默認爲 /var/run/supervisor.sock
  • chmod：改變supervisor.sock的權限
  • username: 配置登錄系統的的賬號
  • password：登錄密碼
     
• [inet_http_server]: 這部分爲以bind端口的方式啓動的supervisor的啓動配置項
  • port: 以端口的方式啓動，默認爲 127.0.0.1:9001 （此配置一般不啓用，socket方式更安全）
  • username: 配置登錄系統的的賬號
  • password：登錄密碼
     
• [supervisord]: 這部分爲supervisor的core部分,所有的特性都在此配置選項
  • logfile：日誌文件的輸出路徑
  • logfile_maxbytes：輸出日誌的單個文件最大文件上限 默認爲50M
  • logfile_backups：備份日誌文件的個數 默認爲10
  • loglevel：日誌等級
  • pidfile：pid輸出文件路徑 默認爲 /var/run/supervisord.pid 注意：不要改成temp目錄下，會被操作系統誤刪除pid文件
  • nodaemon：前臺運行，默認後臺
  • minfds：文件描述符
  • minprocs：進程描述符
  • umask: 創建文件權限
  • user: 啓動用戶
  • identifier: 驗證
  • directory: 啓動目錄
  • nocleanup: 不刪除臨時文件
  • childlogdir: 子日誌輸出目錄
  • environment: 環境變量 以K、V的方式
  • strip_ansi: 在日誌中剝離ANSI轉義代碼
     
• [supervisorctl] : 這部分爲supervisor的客戶端配置,包含web，以及cli方式
  • serverurl：客戶端有兩種連接方式，socket套接字和http端口連接（界面）
  • username：界面賬號
  • password：界面密碼
  • prompt：命令行
  • history_file：使用readline的歷史提示
     
• [include]: 包含了所需被管理進程的配置選項
  • files：統一的子進程模塊目錄 默認 /etc/supervisor/conf.d/ 下
     
• [program:x]：配置文件必須包括至少一個進程，x是進程名稱
  • command：包含一個命令，當這個program啓動時執行
  • directroy：執行子進程時supervisord暫時切換到該目錄 （說實話，運行的時候沒有切換。。。可能我沒理解對）
  • user：程序運行用戶名
  • autostart: 跟隨supervisor啓動
  • autorestart：自動重啓
  • startretries： 嘗試啓動
  • environment： 可以針對單個程序設置環境變量，比如: JAVA
  • startsecs：進程從STARING狀態轉換到RUNNING狀態program所需要保持運行的時間（不是delay時間，反正我試過，就是個顯示狀態）
  • redirect_stderr：如果是true，則進程的stderr輸出被髮送回其stdout文件描述符上的supervisord
  • stdout_logfile：將進程stdout輸出到指定文件
  • stdout_logfile_maxbytes：stdout_logfile指定日誌文件最大字節數，默認爲50MB，可以加KB、MB或GB等單位
  • stdout_logfile_backups：要保存的stdout_logfile備份的數量
     

    Tomcat 實例

     

    [program:tomcat]
    environment=JAVA_HOME="/usr/local/java"
    command=/usr/local/tomcat/bin/catalina.sh run
    user=root
    autostart = true
    startsecs = 5
    autorestart = true
    startretries = 3