supervisor 使用详解

一、介绍及安装配置

1.1 介绍

• supervisord

运行 Supervisor 时会启动一个进程 supervisord，它负责启动所管理的进程，并将所管理的进程作为自己的子进程来启动，而且可以在所管理的进程出现崩溃时自动重启。

• supervisorctl

是命令行管理工具，可以用来执行 stop、start、restart 等命令，来对这些子进程进行管理。
supervisor是所有进程的父进程，管理着启动的子进展，supervisor以子进程的PID来管理子进程，当子进程异常退出时supervisor可以收到相应的信号量。

1.2 安装

# Debian/Ubuntu可通过apt安装
apt-get install supervisor

# 通过 pip 安装
pip install supervisor

# easy_install 安装
easy_install supervisor

1.3 配置文件

1.3.1 查看配置文件

echo_supervisord_conf
# 或者
cat /etc/supervisord/supervisord.conf

• 子进程配置文件路径： /etc/supervisord.d/
  • 默认子进程配置文件为 .ini 格式，可在 supervisor 主配置文件中修改

1.3.2 注意事项

• 千万不要先运行 supervisor，先把配置文件里的默认** tmp** 文件路径统统改掉；打开 conf 文件，修改 sock, log, pid 的文件目录，因为tmp里的文件说没就没了
• 分号后面是注释，如果要加分号，分号前面记得补一个空格

二、常用命令

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

三、配置文件说明

3.1 配置文件说明

[unix_http_server]
file=/var/run/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=/var/log/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.sock ;通过UNIX socket连接supervisord，路径与unix_http_server部分的file一致
;serverurl=http://127.0.0.1:9001 ; 通过HTTP的方式连接supervisord
 
; [program:xx]是被管理的进程配置参数，xx是进程的名称
[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结束的配置文件
;files = /etc/supervisor/conf.d/*.conf

说明：

• [unix_http_server]: 设置 http 服务器监听的 Unix domain socket
  • file：指向 Unix domain socket，即： file=/tmp/supervisor.sock
  • chmod：启动时，改变 supervisor.sock 的权限
• [supervisord]：与 supervisord 有关的全局配置需要在这部分设置
  • logfile: 指向记录 supervisord 进程的 log 文件
  • pidfile：pidfile 保存子进程的路径
  • childlogdir：子进程 log 目录设为 AUTO 的 log 目录
• [supervisorctl]：
  • serverurl：进入 supervisord 的URL， 对于 UNIX domain sockets, 应设为 unix:///absolute/path/to/file.sock
• [include]：如果配置文件包含该部分，则该部分必须包含一个 files 键
  • files：包含一个或多个文件，这里包含了 /etc/supervisor/conf.d/ 目录下所有的 .conf 文件，可以在该目录下增加我们自己的配置文件，在该配置文件中增加 [program:xx] 部分，用来运行我们自己的程序，如下：
    • [program:xx]：配置文件必须包括至少一个 program，xx 是 program 名称，必须写上，不能为空
    • command：包含一个命令，当这个 program 启动时执行
    • directory：执行子进程时 supervisord 暂时切换到该目录
    • user：账户名
    • startsecs：进程从 STARING 状态转换到 RUNNING 状态 program 所需要保持运行的时间（单位：秒）
    • redirect_stderr：如果是 true ，则进程的 stderr 输出被发送回其 stdout 文件描述符上的 supervisord
    • stdout_logfile：将进程 stdout 输出到指定文件
    • stdout_logfile_maxbytes：stdout_logfile 指定日志文件最大字节数，默认为50MB，可以加KB、MB或GB等单位
    • stdout_logfile_backups：要保存的 stdout_logfile 备份的数量

3.2 用例

# testapp.sh
#! /bin/bash
if test -e $HOME/supervisor
then 
	echo "The $HOME/supervisor is exist!"
else
	mkdir $HOME/supervisor
	echo "Directory created successfully！"
	ls -ld $HOME/supervisor
fi

cd $HOME/supervisor
suffix=".txt"
i=0
while true
do
	#filename = `date +'%Y-%m-%d %H:%M:%S'`	# +与后面内容中间无空格
	filename=`date +'%Y%m%d%H%M%S'`
	
	fileCnt=`ls -l *.tar.gz | wc -l` #统计当前文件夹下的文件数量
	echo "`pwd` 当前备份文件数: $fileCnt"
	if test $fileCnt -gt 10
	then 
		gzlist=`ls *.tar.gz`
		rm -fr $gzlist
	fi

	if test $(($i % 3)) -eq 0
	then 
		filelist=`ls *.txt`
		echo $filelist
		tar -zcf $filename."tar.gz" $filelist
		rm -fr $filelist
	fi
	
	if test -e $filename
	then 
		echo "The $filename is exist!"
	else
		#touch $filename$suffix
		#解决let问题: sudo ln -sf /bin/bash /bin/sh
		let i+=1 # or ((i++))
		echo `date` > $filename$suffix
		echo "The file $filename$suffix created successfully！"
		#ls -ld $HOME/supervisor
	fi
	sleep 2
done

配置文件：/etc/supervisor/conf.d/testapp.conf

;根据主配置文件确定文件后缀，/etc/supervisor/supervisord.conf  /etc/supervisord.conf
;/etc/supervisor/conf.d/testapp.conf
;/etc/supervisor/conf.d/testapp.ini

[program:testapp]	; 程序名称，在 supervisorctl 中通过这个值来对程序进行一系列的操作
command     = sh $HOME/supervisor/example.sh	; 启动命令，与手动在命令行启动的命令是一样的
directory   = $HOME/supervisor/				; 程序的启动目录
;user        = kali		; 用哪个用户启动进程，默认是root
;password    = 1
;autostart  = true      ; 在supervisord启动的时候也自动启动
autorestart = true 		; 程序异常退出后自动重启
startsecs   = 2	    	; 启动2秒后没有异常退出，就表示进程正常启动了，默认为1秒
;startretries=3       	; 启动失败自动重试次数，默认是3
;priority = 999         ; 进程启动优先级，默认999，值小的优先启动

;日志
redirect_stderr         	  = true 	; 把 stderr 重定向到 stdout，默认 false
stdout_logfile_maxbytlogstash = 50MB	; stdout 日志文件大小，默认 50MB
stdout_logfile_backups  	  = 10		; stdout 日志文件备份数
; stdout 日志文件，需要注意当指定目录不存在时无法正常启动，所以需要手动创建目录（supervisord 会自动创建日志文件）
stdout_logfile                = /var/log/supervisor/testapp.log

;进程处理
stopasgroup = false     ;默认为false,进程被杀死时,是否向这个进程组发送stop信号,包括子进程
killasgroup = false     ;默认为false,进程组发送kill信号,包括子进程

启动服务和程序

# 启动 supervisor
supervisord -c /etc/supervisor/supervisord.conf
# 启动 testapp
supervisorctl start testapp
# 查看所有进程状态
supervisorctl status testapp
# 关闭进程
supervisorctl stop testapp

日志查看

四、常见问题

4.1 unix:///var/run/supervisor.sock no such file

问题描述：安装好supervisor没有开启服务直接使用supervisorctl报的错
解决办法：

1. 导入配置文件：

# 若配置过程中出现错误或搞不定，想重新来，重新执行该命令即可
echo_supervisord_conf > /etc/supervisord.conf

2. 启动服务

supervisord -c /etc/supervisord.conf
# supervisord -c /etc/supervisor/supervisord.conf

4.2 启动了多个supervisord服务，导致无法正常关闭服务

问题描述：在运行supervisord -c /etc/supervisord.conf之前，运行过supervisord -c /etc/supervisord.d/xx.conf导致有些进程被多个 superviord 管理，无法正常关闭进程。
解决办法：使用ps -fe | grep supervisord查看所有启动过的supervisord服务，kill 相关的进程。