Supervisor 管理后台守护进程

参考原文如下：

http://codinn.com/people/brant/notes/110948/

做了一些注释

+++++++++++引用开始++++++++++++

自己开发的应用往往也希望做到随系统自动启动, 而且启动之后最好还能方便的控制其停止/重启. 传统的做法是在 /etc/init.d/ 下建立启动脚本, 但这个方法非常繁琐, 容易出错, 而且不同服务器/不同版本的配置又有差异.

通常需要借助一些辅助工具. 常用的管理工具有 runit, daemontools 以及用 Python 开发的 Supervisor. 其中以 Supervisor 最为易用, 功能也很完善.

安装

安装命令

    sudo apt-get install supervisor

安装完成, Supervisor 自动会随系统自动启动

命令

Supervisor 有两个可执行程序 – supervisord 和 supervisorctl:

supervisord 是后台管理服务器, 用来依据配置文件的策略管理后台守护进程, 它会随系统自动启动
supervisorctl 用于管理员向后台管理程序发送启动/重启/停止等指令;

它们之间的关系就相当于 Apache 的 httpd 和 apachectl.

主配置文件

配置文件用来指示 Supervisor 有哪些进程需要管理, 以及管理策略.

主配置文件 的路径位于 /etc/supervisor/supervisord.conf, 主配置文件中的末尾两行文本:

[include]

files = /etc/supervisor/conf.d/*.conf

指明了 Supervisor 会去 /etc/supervisor/conf.d/ 目录下查找以 .conf 结尾的子配置文件, 也就是说, 我们只需在 /etc/supervisor/conf.d/ 目录下为每个后台守护应用新建一个配置文件即可.

子配置文件

举个例子, 我们只需新建一个子配置文件 /etc/supervisor/conf.d/iot-kb.conf:

[program:codinn]

command = /srv/codinn/ENV/bin/python /srv/codinn/manage.py runwsgiserver

为了方便管理, 每个后台守护应用对应一个 /etc/supervisor/conf.d/[program-name].conf 子配置文件
program: 后跟随的 codinn 指明后台守护应用的代号, supervisorctl 需要用该代号控制守护进程的启动/停止.
program 区的更多配置请参考: [program:x] Section Settings
子配置基本上只需关心 program 区
command 字段设置的是后台守护应用的启动命令, 注意: 该命令必须是在前台执行的, 即会独占控制台, 否则会导致 supervisor 无法获得标准输出, 并失去进程的控制权.

控制守护进程

每次 修改主配置文件 或 增改子配置文件 都需要执行 supervisorctl update 使新配置生效:

    sudo supervisorctl update

控制守护进程:

    # 控制所有进程

    sudo supervisorctl start all

    sudo supervisorctl stop all

    sudo supervisorctl restart all

    # 定向控制指定进程

    sudo supervisorctl stop iot-kb

    sudo supervisorctl start iot-kb

    sudo supervisorctl restart iot-kb

`supervisorctl` 子命令

$ supervisorctl help

default commands (type help <topic>):

=====================================

add    clear  fg        open  quit    remove  restart   start   stop  update

avail  exit   maintail  pid   reload  reread  shutdown  status  tail  version

+++++++++++引用结束++++++++++++

这里我分享一个我自己设置的配置文件。

一般是这样用的

supervisord -c [/path/to/supervisord.conf]

supervisorctl -c [/path/to/supervisord.conf] start all

请看,在echo_supervisord_conf > /etc/supervisord.conf 后，一个简单的/etc/supervisord.conf

; Sample supervisor config file.

;

; For more information on the config file, please see:

; http://supervisord.org/configuration.html

;

; Note: shell expansion ("~" or "$HOME") is not supported.  Environment

; variables can be expanded using this syntax: "%(ENV_HOME)s".

[unix_http_server]

file=/tmp/supervisor.sock   ; (the path to the socket file)

;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]         ; 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/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:///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

; 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=unexpected        ; whether/when to restart (default: unexpected)

;startsecs=1                   ; 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)

;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=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        ; whether/when to restart (default: unexpected)

;startsecs=1                   ; 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)

;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=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 = relative/directory/*.ini

;This is for Chinese Segmentation APIs built within Torando web framework

[program:segm_cn_8100]

command=python /root/software/segm_cn/center.py --port=8100

directory=/root/software/segm_cn

autorestart=true

redirect_stderr=true

stdout_logfile=/var/log/stdout_segm_cn_8100.log        ; 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=/var/log/stderr_segm_cn_8100.log        ; 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)

[program:segm_cn_8101]

command=python /root/software/segm_cn/center.py --port=8101

directory=/root/software/segm_cn

autorestart=true

redirect_stderr=true

stdout_logfile=/var/log/stdout_segm_cn_8101.log        ; 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=/var/log/stderr_segm_cn_8101.log        ; 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)

上面采用两个program 虽然是同样的功能，但是能非常好的用nginx 分发端口服务。这样能极大的利用效率。有利于高并发的访问。

秒客网

Supervisor 管理后台守护进程

安装

命令

主配置文件

子配置文件

控制守护进程

`supervisorctl` 子命令

相关文章

Supervisor 管理后台守护进程

安装

命令

主配置文件

子配置文件

控制守护进程

supervisorctl 子命令

相关文章

`supervisorctl` 子命令