supervisor简介

Supervisor is a client/server system that allows its users to monitor and control a number of processes on UNIX-like operating systems.

It shares some of the same goals of programs like launchd, daemontools, and runit. Unlike some of these programs, it is not meant to be run as a substitute for init as “process id 1”. Instead it is meant to be used to control processes related to a project or a customer, and is meant to start like any other program at boot time.

官方文档:点击此处

以上摘自官网,简单来说,supervisor是一个基于Python开发的通用的进程管理程序,是Linux/Unix系统上的进程监控工具,可以管理和监控Linux上面的进程,能将一个普通的命令行进程变为后台daemon,并监控进程状态。

使用

安装

  1. 直接使用pip安装

    pip install supervisor

  2. 使用easy_install

    yum/apt-get install python-setuptools

    easy_install supervisor

配置

安装完成后首先设置配置文件

echo_supervisord_conf > 目标文件夹/supervisod.conf

设置配置文件(最简配置)

[inet_http_server] 
port=127.0.0.1:9001; # 开启web server,外网访问请设置成0.0.0.0

[supervisorctl]
serverurl=unix:///tmp/supervisor.sock ; 
serverurl=http://127.0.0.1:9001 ;

[include]
files = *.ini # 包含当前目录下的所有.ini的配置文件

使用

supervisor包含命令行与网页模式。

supervisorctl:命令行工具,提供一个类似shell的操作接口,通过它你可以连接到不同的supervisord进程上来管理它们各自的子程序,命令通过UNIX socket或者TCP来和服务通讯。

相关命令:

status:查看当前所有托管程序列表

update: 更新所有/选择程序状态

reload:重启supervisor

start 【program_name】:启动某个进程

restart 【program_name】:重启某个进程

stop 【program_name】:停止【program_name】进程

stop groupworker:重启所有属于名为groupworker这个分组的进程(start,restart同理)

stop all:停止全部进程,注:start、restart、stop都不会载入最新的配置文

reread:当一个服务由自动启动修改为手动启动时执行一下就ok

Web Server:通过web控制进程。

PS:需要设置[inet_http_server]配置项

启动

supervisord -c supervisor配置文件夹/supervisord.conf

托管程序配置文件示例

test.ini

[program:显示名称]
command=x x x ;需要执行的命令,可携带路径
directory=XXX/XXX ; 工作路径
priority=999 ; 优先级,默认999
startsecs = 5 ; 启动 5 秒后没有异常退出,则认为正常启动
autorestart = true ; 程序异常退出后自动重启
startretries = 3 ; 启动失败自动重试次数,默认3
enviroment=PATH="使用环境" ;例如:/xxx/xxx/虚拟环境/bin/
stdout_logfile = /xxx/logs/scheduler.log ;输出日志
stderr_logfile = /xxx/logs/scheduler_err.log ;错误输出日志
#把stderr重定向到stdout,默认 false
redirect_stderr = false
# 防止出现僵尸进程
stopasgroup=true
killasgroup=true

扩展

配置参数介绍

[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,如果设成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是进程的名称
[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 = relative/directory/*.ini ;可以指定一个或多个以.ini结束的配置文件