Elcker-Supervisor的使用教程

简介

Supervisor是用Python开发的一套通用的进程管理程序,能将一个普通的命令行进程变为后台daemon,并监控进程状态,异常退出时能自动重启。它是通过fork/exec的方式把这些被管理的进程当作supervisor的子进程来启动,这样只要在supervisor的配置文件中,把要管理的进程的可执行文件的路径写进去即可。也实现当子进程挂掉的时候,父进程可以准确获取子进程挂掉的信息的,可以选择是否自己启动和报警。
supervisor还提供了一个功能,可以为supervisord或者每个子进程,设置一个非root的user,这个user就可以管理它对应的进程。

supervisor主要包含以下四个部分:

supervisord:这个是supervisor服务的主要管理器,负责管理我们配置的子进程,包括重启崩溃或异常退出的子进程,同时也响应来自客户端的请求。
supervisorctl:supervisord服务的客户端命令行。听过这个,我们可以获得由主进程控制的子进程的状态,停止和启动子进程,并获得主进程的运行列表。
Web Server:和supervisorctl功能娉美。这个是通过web界面查看和控制进程状态。 XML-RPC
Interface:服务于web UI的同一个HTTP服务器提供一个XML-RPC接口,可以用来询问和控制管理程序及其运行的程序

Supervisor 特点

简单

为啥简单呢?因为咱们通常管理linux进程的时候,一般来说都需要自己编写一个能够实现进程start/stop/restart/reload功能的脚本,然后丢到/etc/init.d/下面。这么做有很多不好的地方,第一我们要编写这个脚本,这就很耗时耗力了。第二,当这个进程挂掉的时候,linux不会自动重启它的,想要自动重启的话,我们还要自己写一个监控重启脚本。而,supervisor则可以完美的解决这些问题。好,怎么解决的呢,其实supervisor管理进程,就是通过fork/exec的方式把这些被管理的进程,当作supervisor的子进程来启动。这样的话,我们只要在supervisor的配置文件中,把要管理的进程的可执行文件的路径写进去就OK了。这样就省下了我们如同linux管理进程的时候,自己写控制脚本的麻烦了。第二,被管理进程作为supervisor的子进程,当子进程挂掉的时候,父进程可以准确获取子进程挂掉的信息的,所以当然也就可以对挂掉的子进程进行自动重启了,当然重启还是不重启,也要看你的配置文件里面有木有设置autostart=true了,这是后话

精确

为啥说精确呢?因为linux对进程状态的反馈,有时候不太准确。为啥不准确?这个楼主也不知道啊,官方文档是这么说的,知道的告诉楼主一下吧,感激不尽。而supervisor监控子进程,得到的子进程状态无疑是准确的。

进程组

supervisor可以对进程组统一管理,也就是说咱们可以把需要管理的进程写到一个组里面,然后我们把这个组作为一个对象进行管理,如启动,停止,重启等等操作。而linux系统则是没有这种功能的,我们想要停止一个进程,只能一个一个的去停止,要么就自己写个脚本去批量停止。

集中式管理

supervisor管理的进程,进程组信息,全部都写在一个ini格式的文件里就OK了。而且,我们管理supervisor的时候的可以在本地进行管理,也可以远程管理,而且supervisor提供了一个web界面,我们可以在web界面上监控,管理进程。
当然了,本地,远程和web管理的时候,需要调用supervisor的xml_rpc接口,这个也是后话。

有效性

当supervisor的子进程挂掉的时候,操作系统会直接给supervisor发信号。而其他的一些类似supervisor的工具,则是通过进程的pid文件,来发送信号的,然后定期轮询来重启失败的进程。显然supervisor更加高效。。。至于是哪些类似supervisor工具,这个楼主就不太清楚了,楼主还听说过god,director,但是没用过。有兴趣的朋友可以玩玩

可扩展性

supervisor是个开源软件,牛逼点的,可以直接去改软件。不过咱们大多数人还是老老实实研究supervisot提供的接口吧,supervisor主要提供了两个可扩展的功能。一个是event机制,这个就是楼主这两天干的活要用到的东西。再一个是xml_rpc,supervisor的web管理端和远程调用的时候,就要用到它了。

权限

大伙都知道linux的进程,特别是侦听在1024端口之下的进程,一般用户大多数情况下,是不能对其进行控制的。想要控制的话,必须要有root权限。而supervisor提供了一个功能,可以为supervisord或者每个子进程,设置一个非root的user,这个user就可以管理它对应的进程了。

安装

1.Debian/Ubuntu可通过apt安装
apt-get install supervisor
2.其他linux版本
第一步:
   yum install python-setuptools
   easy_install supervisor
   或者 
wget https://pypi.python.org/packages/source/s/supervisor/supervisor-3.1.3.tar.gz
tar zxvf supervisor-4.2.2.tar.gz
cd supervisor-4.2.2
python setup.py install
内网的安装包参见:http://10.10.10.105:4001/#group&do=file&gid=2&fid=323
 第二步(或者拷贝 http://10.10.10.105:4001/#group&do=file&gid=2&fid=323/supervisor 目录下的文件到指定位置)
       创建目录,mkdir /etc/supervisor
       生成配置文件,
echo_supervisord_conf > /etc/supervisor/supervisord.conf
  第三步
    启动   supervisord。supervisord -c /eyc/supervisor/supervisord.conf
3.查看安装石佛成功
echo_supervisord_conf

配置说明

Supervisor 是一个 C/S 模型的程序,supervisord 是 server 端,supervisorctl 是 client
端。 supervisor配置文件:/etc/supervisord.conf
注:supervisor的配置文件默认是不全的,不过在大部分默认的情况下,上面说的基本功能已经满足。
子进程配置文件路径:/etc/supervisord.d/ 注:默认子进程配置文件为ini格式,可在supervisor主配置文件中修改。

supervisor.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=0.0.0.0:9001        ;Web管理后台运行的IP和端口,如果开放到公网,需要注意安全性
;username=user              ;登录管理后台的用户名
;password=123               ;登录管理后台的密码
 
[supervisord]
logfile=/tmp/supervisord.log ;日志文件,默认是 $CWD/supervisord.log
logfile_maxbytes=50MB        ;日志文件大小,超出会rotate,默认 50MB,如果设成0,表示不限制大小
logfile_backups=10           ;日志文件保留备份数量默认10,设为0表示不备份
loglevel=info                ;日志级别,默认info,其它: debug,warn,trace
pidfile=/tmp/supervisord.pid ;pid 文件
nodaemon=false               ;是否在前台启动,默认是false,即以 daemon 的方式启动
minfds=1024                  ;可以打开的文件描述符的最小值,默认 1024
minprocs=200                 ;可以打开的进程数的最小值,默认 200
 
[supervisorctl]
serverurl=unix:///tmp/supervisor.sock ;通过UNIX socket连接supervisord,路径与unix_http_server部分的file一致
;serverurl=http://127.0.0.1:9001 ; 通过HTTP的方式连接supervisord
 
; [program:xx]是被管理的进程配置参数,xx是进程的名称,在 supervisorctl 中通过这个值来对程序进行一系列的操作
[program:xx]
command=/opt/apache-tomcat-8.0.35/bin/catalina.sh run  ; 程序启动命令
autostart=true       ; 在supervisord启动的时候也自动启动
startsecs=10         ; 启动10秒后没有异常退出,就表示进程正常启动了,默认为1秒
autorestart=true     ; 程序退出后自动重启,可选值:[unexpected,true,false],默认为unexpected,表示进程意外杀死后才重启
startretries=3       ; 启动失败自动重试次数,默认是3
user=tomcat          ; 用哪个用户启动进程,默认是root
priority=999         ; 进程启动优先级,默认999,值小的优先启动
redirect_stderr=true ; 把stderr重定向到stdout,默认false
stdout_logfile_maxbytes=20MB  ; stdout 日志文件大小,默认50MB
stdout_logfile_backups = 20   ; stdout 日志文件备份数,默认是10
; stdout 日志文件,需要注意当指定目录不存在时无法正常启动,所以需要手动创建目录(supervisord 会自动创建日志文件)
stdout_logfile=/opt/apache-tomcat-8.0.35/logs/catalina.out
stopasgroup=false     ;默认为false,进程被杀死时,是否向这个进程组发送stop信号,包括子进程
killasgroup=false     ;默认为false,向进程组发送kill信号,包括子进程
 
;包含其它配置文件
[include]
files = /etc/supervisor/conf.d/*.ini    ;可以指定一个或多个以.ini结束的配置文件,当然也可以是其他类型的文件

子进程配置文件说明:

给需要管理的子进程(程序)编写一个配置文件,放在/etc/supervisor.d/目录下,以.ini/.conf作为扩展名:

;项目名
[program:akcloud]
;脚本目录,; 程序的启动目录
directory=/opt/bin
;脚本执行命令
command=java -jar /home/greatwall/sxhmak/akcloud/ak-cloud-services-pm-0.0.1-SNAPSHOT.jar TaskTestOne  ; 被监控的进程路径
;supervisor启动的时候是否随着同时启动,默认True
autostart=true
;当程序exit的时候,这个program不会自动重启,默认unexpected,设置子进程挂掉后自动重启的情况,有三个选项,false,unexpected和true。如果为false的时候,无论什么情况下,都不会被重新启动,如果为unexpected,只有当进程的退出码不在下面的exitcodes里面定义的
autorestart=true
;这个选项是子进程启动多少秒之后,此时状态如果是running,则我们认为启动成功了。默认值为1
startsecs=1
;脚本运行的用户身份 
user = greatwall
stderr_logfile=/home/greatwall/sxhmak/logs/akcloud_stderr.log  ;日志输出 
stdout_logfile=/home/greatwall/sxhmak/logs/akcloud_stdout.log 
;把stderr重定向到stdout,默认 false
redirect_stderr = true
;stdout日志文件大小,默认 50MB
stdout_logfile_maxbytes = 20MB
;stdout日志文件备份数
stdout_logfile_backups = 20
numprocs=1                     ; 启动几个进程
priority=1                    ; 数字越高,优先级越高
startretries=10               ; 启动失败时的最多重试次数
exitcodes=0                   ; 正常退出代码
stopsignal=KILL               ; 用来杀死进程的信号
stopwaitsecs=10               ; 发送SIGKILL前的等待时间

supervisorctl命令说明
supervisorctl status        //查看所有进程的状态
supervisorctl stop program_name       //停止指定程序
supervisorctl start program_name      //启动指定程序
supervisorctl restart program_name    //重启指定程序5 supervisorctl update //配置文件修改后使用该命令加载新的配置 6 supervisorctl reload //重新启动配置中的所有程序注:把program_name换成all可以管理配置中的所有进程。

WEB页面

开启 supervisor.conf配置文件说明: 标红的内容,便可以开启 web端的界面; 注意:“;” 在此文件中为注释
生产环境不建议开启,机器性能不好的情况下。 接入如图:

登录界面(密码为设置的):
Elcker-Supervisor的使用教程

运维界面
Elcker-Supervisor的使用教程

开机启动

非安装包安装的应用,安装时会自动安装开启启动服务,

建验是否开机启动:

systemctl is-enabled supervisor 非enabled 的话就是不可以的;

在目录/usr/lib/systemd/system/ 新建文件supervisord.service,并添加配置内容

[Unit]
Description=Process Monitoring and Control Daemon
After=rc-local.service nss-user-lookup.target

[Service]
Type=forking
ExecStart=/usr/bin/supervisord -c /etc/supervisor/supervisord.conf ;开机启动时执行
ExecStop=/usr/bin/supervisord shutdown
ExecReload=/usr/bin/supervisord reload
killMode=process
Restart=on-failure
RestartSec=42s

[Install]
WantedBy=multi-user.target

启动服务:systemctl enable supervisord

上一篇:Supervisor 进程管理系统


下一篇:Supervisor进程管理随笔