supervisor ubuntu Ubuntu24.04
大家好,今天小编来为大家解答以下的问题,关于supervisor ubuntu,Ubuntu24.04这个很多人还不知道,现在让我们一起来看看吧!
Linux下进程管理工具Supervisor的安装配置和基本使用
Supervisor()是一个用 Python写的进程管理工具,可以很方便的用来启动、重启、关闭进程(不仅仅是 Python进程)。除了对单个进程的控制,还可以同时启动、关闭多个进程,比如很不幸的服务器出问题导致所有应用程序都被杀死,此时可以用 supervisor同时启动所有应用程序而不是一个一个地敲命令启动。
安装
Supervisor可以运行在 Linux、Mac OS X上。如前所述,supervisor是 Python编写的,所以安装起来也很方便,可以直接用 pip:
复制代码代码如下:
sudo pip install supervisor
如果是 Ubuntu系统,还可以使用 apt-get安装。
supervisord配置
Supervisor相当强大,提供了很丰富的功能,不过我们可能只需要用到其中一小部分。安装完成之后,可以编写配置文件,来满足自己的需求。为了方便,我们把配置分成两部分:supervisord(supervisor是一个 C/S模型的程序,这是 server端,对应的有 client端:supervisorctl)和应用程序(即我们要管理的程序)。
首先来看 supervisord的配置文件。安装完 supervisor之后,可以运行echo_supervisord_conf命令输出默认的配置项,也可以重定向到一个配置文件里:
复制代码代码如下:
echo_supervisord_conf>/etc/supervisord.conf
去除里面大部分注释和“不相关”的部分,我们可以先看这些配置:
[unix_http_server]
file=/tmp/supervisor.sock; UNIX socket文件,supervisorctl会使用
;chmod=0700; socket文件的 mode,默认是 0700
;chown=nobody:nogroup; socket文件的 owner,格式: uid:gid
;[inet_http_server]; HTTP服务器,提供 web管理界面
;port=127.0.0.1:9001; Web管理后台运行的 IP和端口,如果开放到公网,需要注意安全性
;username=user;登录管理后台的用户名
;password=123;登录管理后台的密码
[supervisord]
logfile=/tmp/supervisord.log;日志文件,默认是$CWD/supervisord.log
logfile_maxbytes=50MB;日志文件大小,超出会 rotate,默认 50MB
logfile_backups=10;日志文件保留备份数量默认 10
loglevel=info;日志级别,默认 info,其它: debug,warn,trace
pidfile=/tmp/supervisord.pid; pid文件
nodaemon=false;是否在前台启动,默认是 false,即以 daemon的方式启动
minfds=1024;可以打开的文件描述符的最小值,默认 1024
minprocs=200;可以打开的进程数的最小值,默认 200
; 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;通过 UNIX socket连接 supervisord,路径与 unix_http_server部分的 file一致
;serverurl=;通过 HTTP的方式连接 supervisord
;包含其他的配置文件
[include]
files= relative/directory/*.ini;可以是*.conf或*.ini
[unix_http_server]
file=/tmp/supervisor.sock; UNIX socket文件,supervisorctl会使用
;chmod=0700; socket文件的 mode,默认是 0700
;chown=nobody:nogroup; socket文件的 owner,格式: uid:gid
;[inet_http_server]; HTTP服务器,提供 web管理界面
;port=127.0.0.1:9001; Web管理后台运行的 IP和端口,如果开放到公网,需要注意安全性
;username=user;登录管理后台的用户名
;password=123;登录管理后台的密码
[supervisord]
logfile=/tmp/supervisord.log;日志文件,默认是$CWD/supervisord.log
logfile_maxbytes=50MB;日志文件大小,超出会 rotate,默认 50MB
logfile_backups=10;日志文件保留备份数量默认 10
loglevel=info;日志级别,默认 info,其它: debug,warn,trace
pidfile=/tmp/supervisord.pid; pid文件
nodaemon=false;是否在前台启动,默认是 false,即以 daemon的方式启动
minfds=1024;可以打开的文件描述符的最小值,默认 1024
minprocs=200;可以打开的进程数的最小值,默认 200
; 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;通过 UNIX socket连接 supervisord,路径与 unix_http_server部分的 file一致
;serverurl=;通过 HTTP的方式连接 supervisord
;包含其他的配置文件
[include]
files= relative/directory/*.ini;可以是*.conf或*.ini
我们把上面这部分配置保存到/etc/supervisord.conf(或其他任意有权限访问的文件),然后启动 supervisord(通过-c选项指定配置文件路径,如果不指定会按照这个顺序查找配置文件:$CWD/supervisord.conf,$CWD/etc/supervisord.conf,/etc/supervisord.conf):
复制代码代码如下:
supervisord-c/etc/supervisord.conf
program配置
上面我们已经把 supervisrod运行起来了,现在可以添加我们要管理的进程的配置文件。可以把所有配置项都写到 supervisord.conf文件里,但并不推荐这样做,而是通过 include的方式把不同的程序(组)写到不同的配置文件里。
为了举例,我们新建一个目录/etc/supervisor/用于存放这些配置文件,相应的,把/etc/supervisord.conf里 include部分的的配置修改一下:
复制代码代码如下:
[include]
files=/etc/supervisor/*.conf
假设有个用 Python和 Flask框架编写的用户中心系统,取名 usercenter,用 gunicorn()做 web服务器。项目代码位于/home/leon/projects/usercenter,gunicorn配置文件为 gunicorn.py,WSGI callable是 wsgi.py里的 app属性。所以直接在命令行启动的方式可能是这样的:
复制代码代码如下:
cd/home/leon/projects/usercenter
gunicorn-c gunicorn.py wsgi:app
现在编写一份配置文件来管理这个进程(需要注意:用 supervisord管理时,gunicorn的 daemon选项需要设置为 False):
[program:usercenter]
directory=/home/leon/projects/usercenter;程序的启动目录
command= gunicorn-c gunicorn.py wsgi:app;启动命令,可以看出与手动在命令行启动的命令是一样的
autostart= true;在 supervisord启动的时候也自动启动
startsecs= 5;启动 5秒后没有异常退出,就当作已经正常启动了
autorestart= true;程序异常退出后自动重启
startretries= 3;启动失败自动重试次数,默认是 3
user= leon;用哪个用户启动
redirect_stderr= true;把 stderr重定向到 stdout,默认 false
stdout_logfile_maxbytes= 20MB; stdout日志文件大小,默认 50MB
stdout_logfile_backups= 20; stdout日志文件备份数
; stdout日志文件,需要注意当指定目录不存在时无法正常启动,所以需要手动创建目录(supervisord会自动创建日志文件)
stdout_logfile=/data/logs/usercenter_stdout.log
;可以通过 environment来添加需要的环境变量,一种常见的用法是修改 PYTHONPATH
; environment=PYTHONPATH=$PYTHONPATH:/path/to/somewhere
[program:usercenter]
directory=/home/leon/projects/usercenter;程序的启动目录
command= gunicorn-c gunicorn.py wsgi:app;启动命令,可以看出与手动在命令行启动的命令是一样的
autostart= true;在 supervisord启动的时候也自动启动
startsecs= 5;启动 5秒后没有异常退出,就当作已经正常启动了
autorestart= true;程序异常退出后自动重启
startretries= 3;启动失败自动重试次数,默认是 3
user= leon;用哪个用户启动
redirect_stderr= true;把 stderr重定向到 stdout,默认 false
stdout_logfile_maxbytes= 20MB; stdout日志文件大小,默认 50MB
stdout_logfile_backups= 20; stdout日志文件备份数
; stdout日志文件,需要注意当指定目录不存在时无法正常启动,所以需要手动创建目录(supervisord会自动创建日志文件)
stdout_logfile=/data/logs/usercenter_stdout.log
;可以通过 environment来添加需要的环境变量,一种常见的用法是修改 PYTHONPATH
; environment=PYTHONPATH=$PYTHONPATH:/path/to/somewhere
一份配置文件至少需要一个 [program:x]部分的配置,来告诉 supervisord需要管理那个进程。[program:x]语法中的 x表示 program name,会在客户端(supervisorctl或 web界面)显示,在 supervisorctl中通过这个值来对程序进行 start、restart、stop等操作。
supervisorctl子命令
复制代码代码如下:
$ supervisorctl help
default commands(type help):
=====================================
add clear fg open quit remove restart start stop update
avail exit maintail pid reload reread shutdown status tail version
使用 supervisorctl
Supervisorctl是 supervisord的一个命令行客户端工具,启动时需要指定与 supervisord使用同一份配置文件,否则与 supervisord一样按照顺序查找配置文件。
复制代码代码如下:
supervisorctl-c/etc/supervisord.conf
上面这个命令会进入 supervisorctl的 shell界面,然后可以执行不同的命令了:
复制代码代码如下:
> status#查看程序状态
> stop usercenter#关闭 usercenter程序
> start usercenter#启动 usercenter程序
> restart usercenter#重启 usercenter程序
> reread#读取有更新(增加)的配置文件,不会启动新添加的程序
> update#重启配置文件修改过的程序
上面这些命令都有相应的输出,除了进入 supervisorctl的 shell界面,也可以直接在 bash终端运行:
复制代码代码如下:
$ supervisorctl status
$ supervisorctl stop usercenter
$ supervisorctl start usercenter
$ supervisorctl restart usercenter
$ supervisorctl reread
$ supervisorctl update
控制守护进程
每次修改主配置文件或增改子配置文件都需要执行 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
Linux系统下的进程监控工具Supervisor的基本使用方法
Supervisor是一个C/S系统,它允许用户在类UNIX系统上控制一些进程。它具有以下特性:
1简单
Supervisor通过INI格式配置文件进行配置,很容易掌握,它为每个进程提供了很多配置选项,可以使你很容易的重启进程或者自动的轮转日志。
2统一
Supervisor提供了一种统一的方式来start、stop、monitor你的进程,进程可以单独控制,也可以成组的控制。你可以在本地或者远程命令行或者web接口来配置Supervisor。
3有效
Supervisor通过fork/exec启动它的子进程,子进程并不是守护进程。当一个进程终止的时候,操作系统会立即给Supervisor发送一个信号,而不是像其他解决方案依赖PID文件。
4可扩展
Supervisor包含一个简单的事件通知协议,因此任何程序都可以监控它,而且提供一个XML-RPC控制接口。
5兼容
除了windows平台,其他平台都可运行。
Supervisor系统的组件:
supervisord:
服务会启动supervisord服务,它负责调用自己启动子程序,响应来自客户端的命令,重启crash或者退出的进程,记录进程的输出信息,收集事件信息。该服务的配置文件在/etc/supervisor/supervisord.conf
supervisorctl:
客户端的命令行工具,提供一个类shell接口,通过它你可以连接到不同的supervisord进程上来管理它们各自的子程序。客户端命令通过UNIX socket或者TCP来和服务通讯,服务端可以要求客户端提供身份验证之后才能进行操作([supervisorctl])。
Web Server:
一个小的web接口被集成进了supervisorctl,重启supervisord之后就可以访问了([inet_http_server])。
XML-RPC Interface:
就像HTTP提供WEB UI一样,同时还提供了XML-RPC接口来控制supervisor和由它运行的程序。
安装:
supervisor是python编写的,显然用easy_install、pip都可以安装,我懒,直接apt-get了,在ubuntu14.04下安装完后版本是3.0b2。
Supervisor服务的启动
其实启动Supervisor很简单,supervisord-h看看就知道了,最简单的-c根配置文件即可:
复制代码代码如下:
supervisord-- run a set of applications as daemons.
Usage:/usr/bin/supervisord [options]
Options:
-c/--configuration FILENAME-- configuration file
-n/--nodaemon-- run in the foreground(same as'nodaemon true' in config file)
-h/--help-- print this usage message and exit
-v/--version-- print supervisord version number and exit
-u/--user USER-- run supervisord as this user(or numeric uid)
-m/--umask UMASK-- use this umask for daemon subprocess(default is 022)
-d/--directory DIRECTORY-- directory to chdir to when daemonized
-l/--logfile FILENAME-- use FILENAME as logfile path
-y/--logfile_maxbytes BYTES-- use BYTES to limit the max size of logfile
-z/--logfile_backups NUM-- number of backups to keep when max bytes reached
-e/--loglevel LEVEL-- use LEVEL as log level(debug,info,warn,error,critical)
-j/--pidfile FILENAME-- write a pid file for the daemon process to FILENAME
-i/--identifier STR-- identifier used for this instance of supervisord
-q/--childlogdir DIRECTORY-- the log directory for child process logs
-k/--nocleanup-- prevent the process from performing cleanup(removal of
old automatic child log files) at startup.
-a/--minfds NUM-- the minimum number of file descriptors for start success
-t/--strip_ansi-- strip ansi escape codes from process output
--minprocs NUM-- the minimum number of processes available for start success
--profile_options OPTIONS-- run supervisord under profiler and output
results based on OPTIONS, which is a comma-sep'd
list of'cumulative','calls', and/or'callers',
e.g.'cumulative,callers')
不过既然我这懒人是用apt-get安装的,那安装包的规范必然符合debian系的风格了,直接service supervisor start即可启动,且慢,我们还没配置supervisor的配置文件呢,启动了也没什么效果。我们后面详解配置文件的配置。
supervisorctl客户端的使用
supervisorctl有两种模式,一种是交互模式,一种是命令行模式。在命令行输入supervisorctl直接回车,即可进入交互模式。
复制代码代码如下:
supervisorctl-- control applications run by supervisord from the cmd line.
Usage:/usr/bin/supervisorctl [options] [action [arguments]]
Options:
-c/--configuration-- configuration file path(default/etc/supervisor.conf)
-h/--help-- print usage message and exit
-i/--interactive-- start an interactive shell after executing commands
-s/--serverurl URL-- URL on which supervisord server is listening
(default"").
-u/--username-- username to use for authentication with server
-p/--password-- password to use for authentication with server
-r/--history-file-- keep a readline history(if readline is available)
复制代码代码如下:
action [arguments]-- see below
Actions are commands like"tail" or"stop". If-i is specified or no action is
specified on the command line, a"shell" interpreting actions typed
interactively is started. Use the action"help" to find out about available
actions.
Supervisor的开机自启动
如果你是pip或者easy_install安装的,开机服务自启动还真是个麻烦事,不过官方已经给出一些rc.d脚本示例了,在github上,不过由于我是apt-get安装的,显然这个开机自启动是不用担心的,用debian的update-rc.d即可搞定。
Supervisor的进程安全
既然是用Supervisor来保证其他进程的正常运行,但是万一Supervisor进程挂了怎么办,我们可以使用daemontools来保证Supervisor正常运行,就类似于监控的监控。
supervisord的配置文件主要由几个配置段构成,配置项以K/V格式呈现,下面就看看各个配置端需要怎样配置:
[unix_http_server]
在该配置块的参数项表示的是一个监听在socket上的HTTP server,如果[unix_http_server]块不在配置文件中,则不会启动基于socket的HTTP server。
file:一个unix domain socket的文件路径,HTTP/XML-RPC会监听在这上面
chmod:在启动时修改unix domain socket的mode
chown:修改socket文件的属主
username:HTTP server在认证时的用户名
password:认证密码
eg:
复制代码代码如下:
[unix_http_server]
file=/tmp/supervisor.sock
chmod= 0777
chown= nobody:nogroup
username= user
password= 123
[inet_http_server]
在该配置块的参数项表示的是一个监听在TCP上的HTTP server,如果[inet_http_server]块不在配置文件中,则不会启动基于TCP的HTTP server。
port:TCP监听的地址和端口(ip:port),这个地址会被HTTP/XML-RPC监听
username:HTTP server在认证时的用户名
password:认证密码
eg:
复制代码代码如下:
[inet_http_server]
port= 127.0.0.1:9001
username= user
password= 123
[supervisord]
该配置块的参数项是关于supervisord进程的全局配置项。
logfile:log文件路径
logfile_maxbytes:log文件达到多少后自动进行轮转,单位是KB、MB、GB。如果设置为0则表示不限制日志文件大小
logfile_backups:轮转日志备份的数量,默认是10,如果设置为0,则不备份
loglevel:error、warn、info、debug、trace、blather、critical
pidfile:pid文件路径
umask:umask值,默认022
nodaemon:如果设置为true,则supervisord在前台启动,而不是以守护进程启动
minfds:supervisord在成功启动前可用的最小文件描述符数量,默认1024
minprocs:supervisord在成功启动前可用的最小进程描述符数量,默认200
nocleanup:防止supervisord在启动的时候清除已经存在的子进程日志文件
childlogdir:自动启动的子进程的日志目录
user:supervisord的运行用户
directory:supervisord以守护进程运行的时候切换到这个目录
strip_ansi:消除子进程日志文件中的转义序列
environment:一个k/v对的list列表
eg:
复制代码代码如下:
[supervisord]
logfile=/tmp/supervisord.log
logfile_maxbytes= 50MB
logfile_backups=10
loglevel= info
pidfile=/tmp/supervisord.pid
nodaemon= false
minfds= 1024
minprocs= 200
umask= 022
user= chrism
identifier= supervisor
directory=/tmp
nocleanup= true
childlogdir=/tmp
strip_ansi= false
environment= KEY1="value1",KEY2="value2"
[supervisorctl]
该配置块参数是关于supervisorctl
serverurl:这个url是用来访问supervisord服务的(),或者是个sockets文件(unix:///absolute/path/to/file.sock)
username:supervisorctl连接supervisord的认证用户
password:认证密码
prompt:默认是supervisor
history_file:history文件路径
eg:
复制代码代码如下:
[supervisorctl]
serverurl= unix:///tmp/supervisor.sock
username= chris
password= 123
prompt= mysupervisor
[program:x]
该配置块包含一个或者多个program段,program来表明supervisord要控制哪些程序。该配置块的头部是有固定格式的,一个关键字program,后面跟着一个冒号,接下来才是程序名。例如:[program:foo],foo就是程序名,在使用supervisorctl来操作程序的时候,就是以foo来标明的。
command:启动程序使用的命令,可以是绝对路径或者相对路径
process_name:一个python字符串表达式,用来表示supervisor进程启动的这个的名称,默认值是%(program_name)s
numprocs:Supervisor启动这个程序的多个实例,如果numprocs>1,则process_name的表达式必须包含%(process_num)s,默认是1
numprocs_start:一个int偏移值,当启动实例的时候用来计算numprocs的值
priority:权重,可以控制程序启动和关闭时的顺序,权重越低:越早启动,越晚关闭。默认值是999
autostart:如果设置为true,当supervisord启动的时候,进程会自动重启。
autorestart:值可以是false、true、unexpected。false:进程不会自动重启,unexpected:当程序退出时的退出码不是exitcodes中定义的时,进程会重启,true:进程会无条件重启当退出的时候。
startsecs:程序启动后等待多长时间后才认为程序启动成功
startretries:supervisord尝试启动一个程序时尝试的次数。默认是3
exitcodes:一个预期的退出返回码,默认是0,2。
stopsignal:当收到stop请求的时候,发送信号给程序,默认是TERM信号,也可以是 HUP, INT, QUIT, KILL, USR1, or USR2。
stopwaitsecs:在操作系统给supervisord发送SIGCHILD信号时等待的时间
stopasgroup:如果设置为true,则会使supervisor发送停止信号到整个进程组
killasgroup:如果设置为true,则在给程序发送SIGKILL信号的时候,会发送到整个进程组,它的子进程也会受到影响。
user:如果supervisord以root运行,则会使用这个设置用户启动子程序
redirect_stderr:如果设置为true,进程则会把标准错误输出到supervisord后台的标准输出文件描述符。
stdout_logfile:把进程的标准输出写入文件中,如果stdout_logfile没有设置或者设置为AUTO,则supervisor会自动选择一个文件位置。
stdout_logfile_maxbytes:标准输出log文件达到多少后自动进行轮转,单位是KB、MB、GB。如果设置为0则表示不限制日志文件大小
stdout_logfile_backups:标准输出日志轮转备份的数量,默认是10,如果设置为0,则不备份
stdout_capture_maxbytes:当进程处于stderr capture mode模式的时候,写入FIFO队列的最大bytes值,单位可以是KB、MB、GB
stdout_events_enabled:如果设置为true,当进程在写它的stderr到文件描述符的时候,PROCESS_LOG_STDERR事件会被触发
stderr_logfile:把进程的错误日志输出一个文件中,除非redirect_stderr参数被设置为true
stderr_logfile_maxbytes:错误log文件达到多少后自动进行轮转,单位是KB、MB、GB。如果设置为0则表示不限制日志文件大小
stderr_logfile_backups:错误日志轮转备份的数量,默认是10,如果设置为0,则不备份
stderr_capture_maxbytes:当进程处于stderr capture mode模式的时候,写入FIFO队列的最大bytes值,单位可以是KB、MB、GB
stderr_events_enabled:如果设置为true,当进程在写它的stderr到文件描述符的时候,PROCESS_LOG_STDERR事件会被触发
environment:一个k/v对的list列表
directory:supervisord在生成子进程的时候会切换到该目录
umask:设置进程的umask
serverurl:是否允许子进程和内部的HTTP服务通讯,如果设置为AUTO,supervisor会自动的构造一个url
eg:
复制代码代码如下:
[program:cat]
command=/bin/cat
process_name=%(program_name)s
numprocs=1
directory=/tmp
umask=022
priority=999
autostart=true
autorestart=true
startsecs=10
startretries=3
exitcodes=0,2
stopsignal=TERM
stopwaitsecs=10
user=chrism
redirect_stderr=false
stdout_logfile=/a/path
stdout_logfile_maxbytes=1MB
stdout_logfile_backups=10
stdout_capture_maxbytes=1MB
stderr_logfile=/a/path
stderr_logfile_maxbytes=1MB
stderr_logfile_backups=10
stderr_capture_maxbytes=1MB
environment=A="1",B="2"
serverurl=AUTO
ubuntu安装supervisor
Supervisor是用Python开发的一套通用的进程管理程序,能将一个普通的命令行进程变为后台daemon,并监控进程状态,异常退出时能自动重启。它是通过fork/exec的方式把这些被管理的进程当作supervisor的子进程来启动,这样只要在supervisor的配置文件中,把要管理的进程的可执行文件的路径写进去即可。也实现当子进程挂掉的时候,父进程可以准确获取子进程挂掉的信息的,可以选择是否自己启动和报警。supervisor还提供了一个功能,可以为supervisord或者每个子进程,设置一个非root的user,这个user就可以管理它对应的进程
1.修改配置
2.复制
安装成功后的supervisor会在/etc下生成一个supervisor目录和supervisor.conf文件,默认/etc/supervisor.conf为空,需要将/etc/supervisor/supervisor.conf的内容复制一份到/etc/supervisor.conf中,否则启动不了。
3.编写队列配置
默认情况下,supervisor会读取/etc/supervisor/conf.d下的所有.conf文件配置
1、更新配置后必须执行更新命令才生效
2、查看supervisor进程
3、启动某个supervisor进程
4、停止某个supervisor进程
5、停止所有supervisor进程
6、重启某个supervisor进程