Supervisor使用详解

一、supervisor简介

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

二、supervisor安装

配置好yum源后,可以直接安装

yum install epel-release  #安装yum源
yum install -y supervisor

修改配置文件

$ /etc/supervisord.conf

[unix_http_server]
file=/var/run/supervisor/supervisor.sock   ; (the path to the socket file)
chmod=0700                 ; sockef file mode (default 0700)
[inet_http_server]         ; inet (TCP) server disabled by default
port=*:9001        ; (ip_address:port specifier, *:port for all iface)
username=admin              ; (default is no username (open server))
password=admin             ; (default is no password (open server))
[supervisord]
logfile=/var/log/supervisor/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)
[rpcinterface:supervisor]
supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
[supervisorctl]
serverurl=unix:///var/run/supervisor/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=admin              ; should be same as http_username if set
password=admin                ; should be same as http_password if set
[include]
files = supervisord.d/*.ini

启动 supervisor

systemctl enable supervisord && systemctl start supervisord

三、supervisor使用

supervisor配置文件:/etc/supervisord.conf

子进程配置文件路径:/etc/supervisord.d/*.ini

四、配置文件说明

/etc/supervisord.conf

[unix_http_server]
file=/var/run/supervisor/supervisor.sock   ;UNIX socket 文件,supervisorctl 会使用
chmod=0700                  ;socket文件的mode,默认是0700
chown=root:root        ;socket文件的owner,格式:uid:gid

;HTTP服务器,提供web管理界面
[inet_http_server]         
port=*:9001        ;Web管理后台运行的IP和端口,如果开放到公网,需要注意安全性
username=admin              ;登录管理后台的用户名
password=admin               ;登录管理后台的密码
 
[supervisord]
logfile=/var/log/supervisor/supervisord.log ;日志文件,默认是 $CWD/supervisord.log
logfile_maxbytes=50MB        ;日志文件大小,超出会rotate,默认 50MB,如果设成0,表示不限制大小
logfile_backups=10           ;日志文件保留备份数量默认10,设为0表示不备份
loglevel=info                ;日志级别,默认info,其它: debug,warn,trace
pidfile=/var/run/supervisord.pid ;pid 文件
nodaemon=false               ;是否在前台启动,默认是false,即以 daemon 的方式启动
minfds=1024                  ;可以打开的文件描述符的最小值,默认 1024
minprocs=200                 ;可以打开的进程数的最小值,默认 200
 
[supervisorctl]
serverurl=unix:///var/run/supervisor/supervisor.sock ;通过UNIX socket连接supervisord,路径与unix_http_server部分的file一致
serverurl=http://127.0.0.1:9001       ;通过HTTP的方式连接supervisord
username=admin              ; (default is no username (open server))
password=admin             ; (default is no password (open server))s
 
;包含其它配置文件
[include]
files = relative/directory/*.ini      ;可以指定一个或多个以.ini结束的配置文件

子进程配置文件说明:

给需要管理的子进程(程序)编写一个配置文件,放在/etc/supervisor.d/目录下,以.ini作为扩展名(每个进程的配置文件都可以单独分拆也可以把相关的脚本放一起)

如任意定义一个和脚本相关的项目名称的选项组(/etc/supervisord.d/grafana.ini):

;项目名
[program:grafana]
;脚本目录
directory=/data/grafana
;脚本执行命令
command=/data/grafana/bin/grafana-server

;supervisor启动的时候是否随着同时启动,默认True
autostart=true
;当程序exit的时候自动重启,可选值:[unexpected,true,false],默认为unexpected,表示进程意外杀死后才重启,false是永不重启,true是自动重启
autorestart=true
; 启动失败自动重试次数,默认是3
startretries=3
;这个选项是子进程启动多少秒之后,此时状态如果是running,则我们认为启动成功了。默认值为1
startsecs=1
;程序启动使用的用户身份 
user = root

;stdout 日志文件,需要注意当指定目录不存在时无法正常启动,所以需要手动创建目录(supervisord 会自动创建日志文件)
stdout_logfile=/data/grafana/blog_stdout.log
;把stderr重定向到stdout,默认 false
redirect_stderr = true
;stdout日志文件大小,默认 50MB
stdout_logfile_maxbytes = 20MB
;stdout日志文件备份数
stdout_logfile_backups = 10

五、supervisor命令说明

常用命令

supervisorctl status        # 查看所有进程的状态
supervisorctl stop es       # 停止es
supervisorctl start es      # 启动es
supervisorctl restart es    # 重启es
supervisorctl update        # 配置文件修改后使用该命令加载新的配置
supervisorctl reload        # 重新启动配置中的所有程序,等同于supervisorctl restart all

注:把es换成all可以管理配置中的所有进程。直接输入supervisorctl进入supervisorctl的shell交互界面,此时上面的命令不带supervisorctl可直接使用。

Supervisor官网:http://supervisord.org