发布于 2017-09-03 tech Supervisor

Ubuntu/Debian下Supervisor安装与配置

在Linux社本学期第一次技术交流会上，子卓社长讲解了使用Docker和Cloud9搭建web端IDE，之后留下了一个任务，即使用Supervisor管理进程，所以小编会在本篇博客中介绍Supervisor安装与配置。

简介

Supervisor（http://supervisord.org/）是用Python开发的一个client/server服务，是Linux/Unix系统下的一个进程管理工具，不支持Windows系统。它可以很方便的监听、启动、停止、重启一个或多个进程。用Supervisor管理的进程，当一个进程意外被杀死，supervisort监听到进程死后，会自动将它重新拉起，很方便的做到进程自动恢复的功能，不再需要自己写shell脚本来控制。

Supervisor

安装

//因为Supervisor是用Python开发的一个client/server服务，所以首先检测系统是否安装了Python2.4以上版本

//检测命令
python 

//quit()退出

//如果没有安装 
sudo apt-get install python2.7

//安装supervisor
apt-get install supervisor

supervisor安装完成后会生成三个执行程序：supervisord、supervisorctl、echo_supervisord_conf，分别是supervisor的守护进程服务（用于接收进程管理命令）、客户端（用于和守护进程通信，发送管理进程的指令）、生成初始配置文件程序。

Supervisord配置

运行supervisord服务的时候，需要指定supervisor配置文件，如果没有显示指定，默认在以下目录查找

$CWD/supervisord.conf
$CWD/etc/supervisord.conf
/etc/supervisord.conf
/etc/supervisor/supervisord.conf (since Supervisor 3.3.0)
../etc/supervisord.conf (Relative to the executable)
../supervisord.conf (Relative to the executable)

$CWD表示运行supervisord程序的目录

可以通过运行echo_supervisord_conf来输出默认的配置项，也可以重定向到一个配置文件里

1 2	echo_supervisord_conf > /etc/supervisord.conf //root权限下

去除里面大部分注释和不相关的部分，我们可以先看这些配置

[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://127.0.0.1:9001 ; 通过 HTTP 的方式连接 supervisord

; 包含其他的配置文件
[include]
files = relative/directory/*.ini    ; 可以是 *.conf 或 *.ini

我们把上边这部分配置保存到 /etc/supervisord.conf (或其他任意有权限访问的文件)，然后启动 supervisord (通过 -c 选项指定配置文件路径，如果不指定会按照默认目录查找)

1	supervisord -c /etc/supervisord.conf

Program配置

上面我们已经把supervisord 运行起来了，现在可以添加我们要管理的进程的配置文件。可以把所有配置项都写到 supervisord.conf 文件里，但并不推荐这样做，而是通过 include 的方式把不同的程序（组）写到不同的配置文件里。

举个例子，我们新建一个目录 /etc/supervisord/用于存放这些配置文件，相应的修改 /etc/supervisord.conf里include部分的配置修改一下

1 2	[include] files = /etc/supervisor/*.conf

现在编写一份配置文件来管理Cloud9进程

[program:ide]
directory = /root/c9sdk ;程序的启动目录
command = node server.js --listen 0.0.0.0 --port 3456 --auth jiang:jiang ;启动命令，可以看出与手动启动命令相同
autostart = true ;在supervisord 启动的时候也自动启动
startsecs = 5 ;启动5秒后没有退出就当做已经正常启动
autorestart = true ;程序异常退出后自动重启
startretries = 3 ;启动失败自动重试次数 3
user = root ;用哪个用户启动
redirect_stderr = true ;把 stderr 重定向到 stdout 默认 false
stdout_logfile_maxbytes = 20MB  ; stdout 日志文件大小，默认 50MB
stdout_logfile_backups = 20     ; stdout 日志文件备份数
; stdout 日志文件，需要注意当指定目录不存在时无法正常启动，所以需要手动创建目录（supervisord 会自动创建日志文件）
stdout_logfile = /data/logs/ide_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 是 supervisord 的一个命令行客户端工具，启动时需要指定与 supervisord 使用同一份配置文件，否则与 supervisord 一样按照顺序查找配置文件。

1	supervisorctl -c /etc/supervisord.conf

上面这个命令会进入 supervisorctl 的 shell 界面，然后可以执行不同的命令了：

> status #查看程序状态
> stop ide #关闭程序
> start ide #启动程序
> restart ide #重启程序
> reread    ＃ 读取有更新（增加）的配置文件，不会启动新添加的程序
> update    ＃ 重启配置文件修改过的程序

上面这些命令都有相应的输出，除了进入 supervisorctl 的 shell 界面，也可以直接在 bash 终端运行：

$ supervisorctl status
$ supervisorctl stop ide
$ supervisorctl start ide
$ supervisorctl restart ide
$ supervisorctl reread
$ supervisorctl update

其他

除了 supervisorctl 之外，还可以配置 supervisrod 启动 web 管理界面，这个 web 后台使用 Basic Auth 的方式进行身份认证。

除了单个进程的控制，还可以配置 group，进行分组管理。

经常查看日志文件，包括 supervisord 的日志和各个 pragram 的日志文件，程序 crash 或抛出异常的信息一半会输出到 stderr，可以查看相应的日志文件来查找问题。

Supervisor 有很丰富的功能，还有其他很多项配置，可以在官方文档获取更多信息：http://supervisord.org/index.html

参考博客

运维生存空间

CSDN

之前在微信中看过一份调查，最近一段时间，Python可以说是大火，所以下面几篇博客我想简单的介绍一下Python入门，可能需要好多篇文章，所以欢迎对Python感兴趣的同学和小编我交流分享学习Python的经验。

Any question please contact 1-riverfish

上一篇: Moon框架入门教程5 下一篇: Moon框架入门教程4

Share&Joy

Ginger' Blog

Ubuntu/Debian下Supervisor安装与配置

简介

安装

Supervisord配置

Program配置

Supervisorctl使用

其他

参考博客