supervisor

 

--转载：

Supervisor (http://supervisord.org) 是一个用 Python 写的进程管理工具，能够很方便的用来启动、重启、关闭进程（不只仅是 Python 进程）。除了对单个进程的控制，还能够同时启动、关闭多个进程，好比很不幸的服务器出问题致使全部应用程序都被杀死，此时能够用 supervisor 同时启动全部应用程序而不是一个一个地敲命令启动。

安装

Supervisor 能够运行在 Linux、Mac OS X 上。如前所述，supervisor 是 Python 编写的，因此安装起来也很方便，能够直接用 pip :

 

1	sudo pip install supervisor

若是是 Ubuntu 系统，还可使用 apt-get 安装。

supervisord 配置

Supervisor 至关强大，提供了很丰富的功能，不过咱们可能只须要用到其中一小部分。安装完成以后，能够编写配置文件，来知足本身的需求。为了方便，咱们把配置分红两部分：supervisord（supervisor 是一个 C/S 模型的程序，这是 server 端，对应的有 client 端：supervisorctl）和应用程序（即咱们要管理的程序）。

首先来看 supervisord 的配置文件。安装完 supervisor 以后，能够运行echo_supervisord_conf 命令输出默认的配置项，也能够重定向到一个配置文件里：

 

1	echo_supervisord_conf > /etc/supervisord.conf

去除里面大部分注释和“不相关”的部分，咱们能够先看这些配置：

 

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33

[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 选项指定配置文件路径，若是不指定会按照这个顺序查找配置文件：$CWD/supervisord.conf, $CWD/etc/supervisord.conf, /etc/supervisord.conf）：

 

1	supervisord -c /etc/supervisord.conf

 

program 配置

上面咱们已经把 supervisrod 运行起来了，如今能够添加咱们要管理的进程的配置文件。能够把全部配置项都写到 supervisord.conf 文件里，但并不推荐这样作，而是经过 include 的方式把不一样的程序（组）写到不一样的配置文件里。

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

 

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

假设有个用 Python 和 Flask 框架编写的用户中心系统，取名 usercenter，用 gunicorn (http://gunicorn.org/) 作 web 服务器。项目代码位于 /home/leon/projects/usercenter，gunicorn 配置文件为 gunicorn.py，WSGI callable 是 wsgi.py 里的 app 属性。因此直接在命令行启动的方式多是这样的：

 

1 2	cd /home/leon/projects/usercenter gunicorn -c gunicorn.py wsgi:app

如今编写一份配置文件来管理这个进程（须要注意：用 supervisord 管理时，gunicorn 的 daemon 选项须要设置为 False）：

 

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16

[program:usercenter] directory = /home/leon/projects/usercenter ; 程序的启动目录 command = gunicorn -c gunicorn.py wsgi:app  ; 启动命令，能够看出与手动在命令行启动的命令是同样的 autostart = true     ; 在 supervisord 启动的时候也自动启动 startsecs = 5        ; 启动 5 秒后没有异常退出，就看成已经正常启动了 autorestart = true   ; 程序异常退出后自动重启 startretries = 3     ; 启动失败自动重试次数，默认是 3 user = leon          ; 用哪一个用户启动 redirect_stderr = true  ; 把 stderr 重定向到 stdout，默认 false stdout_logfile_maxbytes = 20MB  ; stdout 日志文件大小，默认 50MB stdout_logfile_backups = 20     ; stdout 日志文件备份数 ; stdout 日志文件，须要注意当指定目录不存在时没法正常启动，因此须要手动建立目录（supervisord 会自动建立日志文件） stdout_logfile = /data/logs/usercenter_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 界面，而后能够执行不一样的命令了：

 

1 2 3 4 5 6

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

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

 

Supervisor (http://supervisord.org) 是一个用 Python 写的进程管理工具，能够很方便的用来启动、重启、关闭进程（不只仅是 Python 进程）。除了对单个进程的控制，还能够同时启动、关闭多个进程，好比很不幸的服务器出问题致使全部应用程序都被杀死，此时能够用 supervisor 同时启动全部应用程序而不是一个一个地敲命令启动。
安装

Supervisor 能够运行在 Linux、Mac OS X 上。如前所述，supervisor 是 Python 编写的，因此安装起来也很方便，能够直接用 pip :

sudo pip install supervisor
1
sudo pip install supervisor
若是是 Ubuntu 系统，还可使用 apt-get 安装。
supervisord 配置

Supervisor 至关强大，提供了很丰富的功能，不过咱们可能只须要用到其中一小部分。安装完成以后，能够编写配置文件，来知足本身的需求。为了方便，咱们把配置分红两部分：supervisord（supervisor 是一个 C/S 模型的程序，这是 server 端，对应的有 client 端：supervisorctl）和应用程序（即咱们要管理的程序）。
首先来看 supervisord 的配置文件。安装完 supervisor 以后，能够运行echo_supervisord_conf 命令输出默认的配置项，也能够重定向到一个配置文件里：

echo_supervisord_conf > /etc/supervisord.conf
1
echo_supervisord_conf > /etc/supervisord.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=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

[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 选项指定配置文件路径，若是不指定会按照这个顺序查找配置文件：$CWD/supervisord.conf, $CWD/etc/supervisord.conf, /etc/supervisord.conf）：

supervisord -c /etc/supervisord.conf
1
supervisord -c /etc/supervisord.conf
program 配置

上面咱们已经把 supervisrod 运行起来了，如今能够添加咱们要管理的进程的配置文件。能够把全部配置项都写到 supervisord.conf 文件里，但并不推荐这样作，而是经过 include 的方式把不一样的程序（组）写到不一样的配置文件里。
为了举例，咱们新建一个目录 /etc/supervisor/ 用于存放这些配置文件，相应的，把 /etc/supervisord.conf 里 include 部分的的配置修改一下：

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

[include]
files = /etc/supervisor/*.conf
假设有个用 Python 和 Flask 框架编写的用户中心系统，取名 usercenter，用 gunicorn (http://gunicorn.org/) 作 web 服务器。项目代码位于 /home/leon/projects/usercenter，gunicorn 配置文件为 gunicorn.py，WSGI callable 是 wsgi.py 里的 app 属性。因此直接在命令行启动的方式多是这样的：

cd /home/leon/projects/usercenter
gunicorn -c gunicorn.py wsgi:app
1
2
cd /home/leon/projects/usercenter
gunicorn -c gunicorn.py wsgi:app
如今编写一份配置文件来管理这个进程（须要注意：用 supervisord 管理时，gunicorn 的 daemon 选项须要设置为 False）：

[program:usercenter]
directory = /home/leon/projects/usercenter ; 程序的启动目录
command = gunicorn -c gunicorn.py wsgi:app  ; 启动命令，能够看出与手动在命令行启动的命令是同样的
autostart = true     ; 在 supervisord 启动的时候也自动启动
startsecs = 5        ; 启动 5 秒后没有异常退出，就看成已经正常启动了
autorestart = true   ; 程序异常退出后自动重启
startretries = 3     ; 启动失败自动重试次数，默认是 3
user = leon          ; 用哪一个用户启动
redirect_stderr = true  ; 把 stderr 重定向到 stdout，默认 false
stdout_logfile_maxbytes = 20MB  ; stdout 日志文件大小，默认 50MB
stdout_logfile_backups = 20     ; stdout 日志文件备份数
; stdout 日志文件，须要注意当指定目录不存在时没法正常启动，因此须要手动建立目录（supervisord 会自动建立日志文件）
stdout_logfile = /data/logs/usercenter_stdout.log

; 能够经过 environment 来添加须要的环境变量，一种常见的用法是修改 PYTHONPATH
; environment=PYTHONPATH=$PYTHONPATH:/path/to/somewhere

[program:usercenter]
directory = /home/leon/projects/usercenter ; 程序的启动目录
command = gunicorn -c gunicorn.py wsgi:app  ; 启动命令，能够看出与手动在命令行启动的命令是同样的
autostart = true     ; 在 supervisord 启动的时候也自动启动
startsecs = 5        ; 启动 5 秒后没有异常退出，就看成已经正常启动了
autorestart = true   ; 程序异常退出后自动重启
startretries = 3     ; 启动失败自动重试次数，默认是 3
user = leon          ; 用哪一个用户启动
redirect_stderr = true  ; 把 stderr 重定向到 stdout，默认 false
stdout_logfile_maxbytes = 20MB  ; stdout 日志文件大小，默认 50MB
stdout_logfile_backups = 20     ; stdout 日志文件备份数
; stdout 日志文件，须要注意当指定目录不存在时没法正常启动，因此须要手动建立目录（supervisord 会自动建立日志文件）
stdout_logfile = /data/logs/usercenter_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 同样按照顺序查找配置文件。

supervisorctl -c /etc/supervisord.conf
1
supervisorctl -c /etc/supervisord.conf
上面这个命令会进入 supervisorctl 的 shell 界面，而后能够执行不一样的命令了：

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

> status    # 查看程序状态
> stop usercenter   # 关闭 usercenter 程序
> start usercenter  # 启动 usercenter 程序
> restart usercenter    # 重启 usercenter 程序
> reread    ＃ 读取有更新（增长）的配置文件，不会启动新添加的程序
> update    ＃ 重启配置文件修改过的程序
上面这些命令都有相应的输出，除了进入 supervisorctl 的 shell 界面，也能够直接在 bash 终端运行：

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

$ supervisorctl status
$ supervisorctl stop usercenter
$ supervisorctl start usercenter
$ supervisorctl restart usercenter
$ supervisorctl reread
$ supervisorctl update
其它

除了 supervisorctl 以外，还能够配置 supervisrod 启动 web 管理界面，这个 web 后台使用 Basic Auth 的方式进行身份认证。
除了单个进程的控制，还能够配置 group，进行分组管理。
常常查看日志文件，包括 supervisord 的日志和各个 pragram 的日志文件，程序 crash 或抛出异常的信息一半会输出到 stderr，能够查看相应的日志文件来查找问题。
Supervisor 有很丰富的功能，还有其余不少项配置，能够在官方文档获取更多信息：http://supervisord.org/index.html

 

1 2 3 4 5 6

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

 

其它

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

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

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

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

 

 

 

 

 

 

 

 

 

 

 

---------------2016-6-7 10:21:21--

　　source：【1】