supervisor是一个进程控制系统,由python编写,它提供了大量的功能来实现对进程的管理.仅仅需要创建配置文件,指定程序的执行路径即可。
1.程序的多进程启动,可以配置同时启动的进程数,而不需要一个个启动
2.程序的退出码,可以根据程序的退出码来判断是否需要自动重启
3.程序所产生日志的处理
4.进程初始化的环境,包括目录,用户,umask,关闭进程所需要的信号等等
5.手动管理进程(开始,启动,重启,查看进程状态)的web界面,和xmlrpc接口
--------------
-------------------
安装方式:
# 我们可以通过pypi安装
sudo easy_install supervisor
# 或者从pypi上下载源码,然后安装
python setup.py
install
# 安装完之后,使用下列命令来生成配置文件
echo_supervisord_conf >
/etc/supervisord
.conf
--------------
-------------------
创建配置文件:
两种创建配置文件的方式:
1.使用root身份创建一个全局配置文件echo_supervisord_conf > /etc/supervisord.conf,supervisord程序在运行后会自动查找并加载此目录配置文件。
2.在当前目录创建配置文件echo_supervisord_conf > supervisord.conf,然后使用-c参数在启动时手动指定配置文件:supervisord -c supervisord.conf。
supervisord.conf,它被supervisord和supervisorctl两者使用。如果程序启动时没有包含-c参数(用于告诉程序加载指定的配置文件名),程序将会按照下列顺序查找supervisord.conf文件,然后使用首个查找到的文件作为结果。
1.$CWD/supervisord.conf
2.$CWD/etc/supervisord.conf
3./etc/supervisord.conf
配置文件解读:
Sample supervisor config file.
;
; For more information on the config file, please see:
;
; Note: shell expansion (
"~"
or
"$HOME"
) is not supported. Environment
; variables can be expanded using this syntax:
"%(ENV_HOME)s"
.
[
unix_http_server
]
; supervisord的unix socket服务配置
file=/tmp/supervisor.sock ; socket文件的保存目录
;chmod=0700 ; socket的文件权限 (default 0700)
;chown=nobody
:nogroup
; socket的拥有者和组名
;username=user ; 默认不需要登陆用户 (open server)
;password=123 ; 默认不需要登陆密码 (open server)
;
[
inet_http_server
]
; supervisord的tcp服务配置
;port=127.0.0.1:9001 ; tcp端口
;username=user ; tcp登陆用户
;password=123 ; tcp登陆密码
[
supervisord
]
; 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文件
nodaemon=false ; 是否以守护进程的方式启动
minfds=1024 ; 最小的有效文件描述符,默认1024
minprocs=200 ; 最小的有效进程描述符,默认200
;umask=022 ; 进程文件的umask,默认200
;user=chrism ; 默认为当前用户,如果为root则必填
;identifier=supervisor ; supervisord的表示符, 默认时
'supervisor
'
;directory=/tmp ; 默认不cd到当前目录
;nocleanup=true ; 不在启动的时候清除临时文件,默认false
;childlogdir=/tmp ; ('AUTO' child log dir, default $TEMP)
;environment=KEY=value ; 初始键值对传递给进程
;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
]
;username=chris ; 如果设置应该与http_username相同
;password=123 ; 如果设置应该与http_password相同
;prompt=mysupervisor ; 命令行提示符,默认
"supervisor"
;history_file=~/.sc_history ; 命令行历史纪录
; 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 ; 运行的程序 (相对使用PATH路径, 可以使用参数)
;process_name=%(program_name)s ; 进程名表达式,默认为%(program_name)s
;numprocs=1 ; 默认启动的进程数目,默认为1
;directory=/tmp ; 在运行前cwd到指定的目录,默认不执行cmd
;umask=022 ; 进程umask,默认None
;priority=999 ; 程序运行的优先级,默认999
;autostart=true ; 默认随supervisord自动启动,默认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 ; 期望的退出码,默认0,2
;stopsignal=QUIT ; 杀死进程的信号,默认TERM
;stopwaitsecs=10 ; max num secs to wait b4 SIGKILL (default 10)
;stopasgroup=false ; 向unix进程组发送停止信号,默认false
;killasgroup=false ; 向unix进程组发送SIGKILL信号,默认false
;user=chrism ; 为运行程序的unix帐号设置setuid
;redirect_stderr=true ; 将标准错误重定向到标准输出,默认false
;stdout_logfile=/a/path ; 标准输出的文件路径NONE=none;默认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 ; 运行的程序 (相对使用PATH路径, 可以使用参数)
;process_name=%(program_name)s ; 进程名表达式,默认为%(program_name)s
;numprocs=1 ; 默认启动的进程数目,默认为1
;events=EVENT ; event notif. types to subscribe to (req
'd
)
;buffer_size=10 ; 事件缓冲区队列大小,默认10
;directory=/tmp ; 在运行前cwd到指定的目录,默认不执行cmd
;umask=022 ; 进程umask,默认None
;priority=-1 ; 程序运行的优先级,默认-1
;autostart=true ; 默认随supervisord自动启动,默认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 ; 期望的退出码,默认0,2
;stopsignal=QUIT ; 杀死进程的信号,默认TERM
;stopwaitsecs=10 ; max num secs to wait b4 SIGKILL (default 10)
;stopasgroup=false ; 向unix进程组发送停止信号,默认false
;killasgroup=false ; 向unix进程组发送SIGKILL信号,默认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 ; 任何在
[
program
:x
]
中定义的x
;priority=999 ; 程序运行的优先级,默认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
--------------
-------------------
添加程序:
写程序:
编辑配置文件supervisord.conf,在后面添加新程序。
[program:spider.py]
command = python /Users/tony/Dropbox/myproject/spider.py
autostart=true
autorestart=true
user=nobody
stdout_logfile = /Users/tony/Dropbox/myproject/spider.stdout.log
stderr_logfile = /Users/tony/Dropbox/myproject/spider.stderr.log
-------------
--------------
启动:
使用指定配置文件启动:supervisord -c supervisord.conf
使用默认配置文件启动:supervisord
-------------
--------------
常用命令:
控制命令基本都通过supervisorctl执行,输入help可以看到命令列表;
-
获得所有程序状态 supervisorctl status
- 关闭目标程序 supervisorctl stop spider
- 启动目标程序 supervisorctl start spider
-
关闭所有程序 supervisorctl shutdown
--------------
-------------------
Web控制台
程序支持使用HTTP方式控制运行状态。在supervisord.conf中开启httpserver:
重新读取配置文件:supervisorctl reload(reload是重新加载整个程序,按照命令描述应该使用reread啊,可是却每次都说没有更新,好奇怪……)
打开浏览器,输入127.0.0.1:9001,用户名user,密码123,就能看到控制台了
--------------
-------------------
在这里可以直接管理所有的子程序,查看运行日志。
原创文章,采用 知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议 进行许可。
转载请注明:转载自 Tony's blog,原文网址:http://itony.me/509.html