一:什么是 supervisor
超级用户,监管员的意思,Supervisor是一个进程管理工具,当进程中断的时候Supervisor能自动重新启动它。可以运行在各种类unix的机器上,supervisor就是用Python开发的一套通用的进程管理程序,能将一个普通的命令行进程变为后台daemon(守护进程),并监控进程状态,异常退出时能自动重启。
-supervisord:运行 Supervisor 时会启动一个进程 supervisord,它负责启动所管理的进程,并将所管理的进程作为自己的子进程来启动,而且可以在所管理的进程出现崩溃时自动重启。
- supervisorctl:是命令行管理工具,可以用来执行 stop、start、restart 等命令,来对这些子进程进行管理。
二:安装 supervisor
CentOS Linux release 7.5.1804 (Core)
pip3 install supervisor 安装supervisor
pip3 list
supervisor安装成功后,会生成三个执行程序,分别为 supervisord(用于接收进程管理命令)、supervisorctl(用于接收客户端命令,和守护进程通信,发送管理进程的指令)、echo_supervisord_conf(生成初始配置文件的程序)
supervisor是一个C/S模型的程序,客户/服务端,supervisord是server端,supervisorctl是client端
在home下新建一个conf文件夹,可以通过运行echo_supervisord_conf程序生成supervisor的初始化配置文件
conf下多出了一个文件
vim看看配置文件的一些参数;开头的文件表示注释
; 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". ; - Quotes around values are not supported, except in the case of ; the environment= options as shown below. ; - Comments must have a leading space: "a=b ;comment" not "a=b;comment". ; - Command will be truncated if it looks like a config file comment, e.g. ; "command=bash -c 'foo ; bar'" will truncate to "command=bash -c 'foo ". ; ; Warning: ; Paths throughout this example file use /tmp because it is available on most ; systems. You will likely need to change these to locations more appropriate ; for your system. Some systems periodically delete older files in /tmp. ; Notably, if the socket file defined in the [unix_http_server] section below ; is deleted, supervisorctl will be unable to connect to supervisord. [unix_http_server] # 系统配置 file=/tmp/supervisor.sock ; the path to the socket file # 系统socket文件,supervisorctl会使用这个 ;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) ; Security Warning: ; The inet HTTP server is not enabled by default. The inet HTTP server is ; enabled by uncommenting the [inet_http_server] section below. The inet ; HTTP server is intended for use within a trusted environment only. It ; should only be bound to localhost or only accessible from within an ; isolated, trusted network. The inet HTTP server does not support any ; form of encryption. The inet HTTP server does not use authentication ; by default (see the username= and password= options to add authentication). ; Never expose the inet HTTP server to the public internet. ;[inet_http_server] ; inet (TCP) server disabled by default # web管理页面 ;port=127.0.0.1:9001 ; ip_address:port specifier, *:port for all iface # web管理后台运行的IP和端口,可以开放到公网 ;username=user ; default is no username (open server) ;password=123 ; default is no password (open server) [supervisord] # 服务端 logfile=/tmp/supervisord.log ; main log file; default $CWD/supervisord.log # 默认日志文件 logfile_maxbytes=50MB ; max main logfile bytes b4 rotation; default 50MB logfile_backups=10 ; # of main logfile backups; 0 means none, default 10 loglevel=info ; log level; default info; others: debug,warn,trace pidfile=/tmp/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=supervisord ; setuid to this UNIX account at startup; recommended 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 # 是否前台启动,默认是false,以deamon的方式启动 ;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 rpcinterface:supervisor 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:x] sections. [rpcinterface:supervisor] supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface ; The supervisorctl section configures how supervisorctl will connect to ; supervisord. configure it match the settings in either the unix_http_server ; or inet_http_server section. [supervisorctl] # 客户端 serverurl=unix:///tmp/supervisor.sock ; use a unix:// URL for a unix socket # 通过unix socket连接 superviosrd,路径与unix_http_server相同 ;serverurl=http://127.0.0.1:9001 ; use an http:// url to specify an inet socket ;username=chris ; should be same as in [*_http_server] if set ;password=123 ; should be same as in [*_http_server] if set ;prompt=mysupervisor ; cmd line prompt (default "supervisor") ;history_file=~/.sc_history ; use readline history if available ; The sample program section below 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) # 进程启动的优先级,默认999,值越小,越先启动,几个进程的时候,先后顺序通过这个值控制。 ;autostart=true ; start at supervisord start (default: true) # 在supervisord启动的时候也自动启动 ;startsecs=1 ; # of secs prog must stay up to be running (def. 1) # 启动1秒后没有异常退出,就表示进程正常启动了,默认是1秒,这个值可以设置为10秒。 ;startretries=3 ; max # of serial start failures when starting (default 3) # 启动失败自动重试次数 ;autorestart=unexpected ; when to restart if exited after running (def: unexpected) # 程序退出后自动启动,三个可选值[unexpected,true,false],默认是是unexpected,表示进程意外杀死才重启。 ;exitcodes=0 ; 'expected' exit codes used with autorestart (default 0) ;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 # 用哪个用户启动进程,默认是chrism,一般修改为root ;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 (0 means none, default 10) ;stdout_capture_maxbytes=1MB ; number of bytes in 'capturemode' (default 0) ;stdout_events_enabled=false ; emit events on stdout writes (default false) ;stdout_syslog=false ; send stdout to syslog with process name (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 (0 means none, default 10) ;stderr_capture_maxbytes=1MB ; number of bytes in 'capturemode' (default 0) ;stderr_events_enabled=false ; emit events on stderr writes (default false) ;stderr_syslog=false ; send stderr to syslog with process name (default false) ;environment=A="1",B="2" ; process environment additions (def no adds) ;serverurl=AUTO ; override serverurl computation (childutils) ; The sample eventlistener section below shows all possible eventlistener ; subsection values. Create one or more 'real' eventlistener: sections to be ; able to handle event notifications sent by supervisord. ;[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 ; 'expected' exit codes used with autorestart (default 0) ;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 (0 means none, default 10) ;stdout_events_enabled=false ; emit events on stdout writes (default false) ;stdout_syslog=false ; send stdout to syslog with process name (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 (0 means none, default 10) ;stderr_events_enabled=false ; emit events on stderr writes (default false) ;stderr_syslog=false ; send stderr to syslog with process name (default false) ;environment=A="1",B="2" ; process environment additions ;serverurl=AUTO ; override serverurl computation (childutils) ; The sample group section below 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
三:实际项目的配置 inout_manage.conf /etc/supervisord.d/
[program: inoutctrl] # 名称,supervisorctl 会显示这个名称 command=/usr/bin/python3 passcolony_manager.py ; 指定python解释器运行程序的命令 directory=/root/jgw/qlzy_platform/inOrOutCenter ; 命令执行的目录 autorestart=true ; 程序意外退出是否自动重启 autostart=true ; 是否自动启动 stderr_logfile=/var/log/inoutctrl_py.err.log ; 错误日志文件 stdout_logfile=/var/log/inoutctrl_py.out.log ; 输出日志文件 environment=ASPNETCORE_ENVIRONMENT=Production ; 进程环境变量 user=root ; 进程执行的用户身份 stopsignal=INT startsecs=10 ; 自动重启间隔 stopwaitsecs = 600 priority=15
supervisord启动成功后,可以通过supervisorctl客户端控制进程,启动、停止、重启。运行supervisorctl命令,不加参数,会进入supervisor客户端的交互终端,并会列出当前所管理的所有进程。
help查看,可以执行的指令
四:自己配置的supervisord启动方式
首先保证启动server端, supervisord -c /home/conf/supervisord.conf
这里是server客户端读取指定路径下的配置文件,默认是从/usr/local/etc/supervisord.conf, /usr/local/supervisord.conf, supervisord.conf, etc/supervisord.conf, /etc/supervisord.conf, /etc/supervisor/supervisord.conf,这几个路径去读取。因为在第二步,修改了supervisord.conf的路径,因此要指定路径去启动
启动server后,启动客户端,出现以上提示:查看supervisord.conf
;serverurl=http://127.0.0.1:9001 ; use an http:// url to specify an inet socket
这一项注释着,使用的socket进行启动的,还是指定路径进行启动
此时没有任何进程被指定
创建一个test.py的文件
import time
while 1:
print(1)
然后在 /home/conf/conf.d 创建一个文件夹 conf.d,在conf.d里面创建 test.ini
[program:test] command=/usr/bin/python3 test.py directory=/home autorestart=true autostart=true environment=ASPNETCORE_ENVIRONMENT=Production user=root stopsignal=INT startsecs=10 stopwaitsecs = 600 priority=15
然后修改 /home/conf/supervisord.conf 里面的include的file路径
[include]
files = /home/conf/conf.d/*.ini
重启 supervisord
supervisord -c /home/conf/supervisord.conf
supervisorctl -c /home/conf/supervisord.conf
unix:///tmp/supervisor.sock no such file" 错误处理 :http://www.cashqian.net/blog/001472975510127673ea63db9234c4e8293cf43cefcafde000
新添加一个 ini后,启动 supervisord报错
Error: Another program is already listening on a port that one of our HTTP servers is configured to use. Shut this program down first before starting supervisord.
For help, use /usr/local/bin/supervisord -h
解决办法:unlink /var/run/supervisor.sock
然后执行
supervisord -c /home/conf/supervisord.conf
supervisorctl -c /home/conf/supervisord.conf
六:supervisor管理celery定时任务
# TODO