supervisor从安装到使用

supervisor 从安装到使用

 

一、安装

• 源码安装

先下载最新的supervisor安装包：https://pypi.python.org/pypi/supervisor ， 如：

cd /usr/local/src

wget https://pypi.python.org/packages/7b/17/88adf8cb25f80e2bc0d18e094fcd7ab300632ea00b601cbbbb84c2419eae/supervisor-3.3.2.tar.gz

tar -zxvf supervisor-3.3.2.tar.gz

cd supervisor-3.3.2

python setup.py install #本地python版本为python2.7

# python2.7 setup.py install #本地python版本为python3以上

二、配置

1.生成配置文件

echo_supervisord_conf > /etc/supervisord.conf

2.启动

supervisord -c /etc/supervisord.conf

查看 supervisord 是否在运行：

ps aux | grep supervisord

3.配置

打开配置文件

vim /etc/supervisord.conf

在配置文件底部，配置include

[include]
files=/etc/supervisor/*.conf #若你本地无/etc/supervisor目录，请自建

用supervisor管理进程，配置如下：

cd /etc/supervisor
vim ossfs.conf # 这里的文件名称自定义

加入以下内容：

; 设置进程的名称，使用 supervisorctl 来管理进程时需要使用该进程名
[program:your_program_name]
command=python server.py --port=9000
;numprocs=1                 ; 默认为1
;process_name=%(program_name)s   ; 默认为 %(program_name)s，即 [program:x] 中的 x
directory=/home/python/tornado_server ; 执行 command 之前，先切换到工作目录
user=oxygen                 ; 使用 oxygen 用户来启动该进程
; 程序崩溃时自动重启，重启次数是有限制的，默认为3次
autorestart=true           
redirect_stderr=true        ; 重定向输出的日志
stdout_logfile = /var/log/supervisord/tornado_server.log
loglevel=info

这里是启动要配置的参数，请根据自己的项目自定义添加

更改了supervisor配置文件，需要重启,运行以下指令：

supervisorctl reload

4.supervisorctl的用法

supervisord : 启动supervisor
supervisorctl reload :修改完配置文件后重新启动supervisor
supervisorctl status :查看supervisor监管的进程状态
supervisorctl start 进程名 ：启动XXX进程
supervisorctl stop 进程名 ：停止XXX进程
supervisorctl stop all：停止全部进程，注：start、restart、stop都不会载入最新的配置文件。
supervisorctl update：根据最新的配置文件，启动新配置或有改动的进程，配置没有改动的进程不会受影响而重启

5.若不使用控制台来管理进程，用浏览器来管理，该如何配置？

打开配置文件

vim /etc/supervisord.conf

配置 inet_http_server

[inet_http_server]      
port=127.0.0.1:9001     ; 服务器ip
username=xxx        ;自定义
password=xxx        ;自定义

三、设置开机启动 (不好用，未实践成功)

vim /etc/init.d/supervisord

添加以下脚本

#! /bin/sh

### BEGIN INIT INFO

# Provides:          supervisord

# Required-Start:    $remote_fs

# Required-Stop:     $remote_fs

# Default-Start:     2 3 4 5

# Default-Stop:      0 1 6

# Short-Description: Example initscript

# Description:       This file should be used to construct scripts to be

#                    placed in /etc/init.d.

### END INIT INFO



# Author: Dan MacKinlay <danielm@phm.gov.au>

# Based on instructions by Bertrand Mathieu

# http://zebert.blogspot.com/2009/05/installing-django-solr-varnish-and.html



# Do NOT "set -e"



# PATH should only include /usr/* if it runs after the mountnfs.sh script

PATH=/usr/local/sbin:/usr/local/bin:/sbin:/usr/sbin:/bin:/usr/bin

DESC="Description of the service"

NAME=supervisord

DAEMON=/usr/local/bin/supervisord

DAEMON_ARGS=" -c /etc/supervisord.conf"

#PIDFILE=/var/run/$NAME.pid

PIDFILE=/tmp/$NAME.pid

SCRIPTNAME=/etc/init.d/$NAME



# Exit if the package is not installed

[ -x "$DAEMON" ] || exit 0



# Read configuration variable file if it is present

[ -r /etc/default/$NAME ] && . /etc/default/$NAME



# Load the VERBOSE setting and other rcS variables

. /lib/init/vars.sh



# Define LSB log_* functions.

# Depend on lsb-base (>= 3.0-6) to ensure that this file is present.

. /lib/lsb/init-functions



#

# Function that starts the daemon/service

#

do_start()

{

    # Return

    #   0 if daemon has been started

    #   1 if daemon was already running

    #   2 if daemon could not be started

    start-stop-daemon --start --quiet --pidfile $PIDFILE --exec$DAEMON --test > /dev/null \

        || return 1

    start-stop-daemon --start --quiet --pidfile $PIDFILE --exec$DAEMON -- \

        $DAEMON_ARGS \

        || return 2

    # Add code here, if necessary, that waits for the process to be ready

    # to handle requests from services started subsequently which depend

    # on this one.  As a last resort, sleep for some time.

}



#

# Function that stops the daemon/service

#

do_stop()

{

    # Return

    #   0 if daemon has been stopped

    #   1 if daemon was already stopped

    #   2 if daemon could not be stopped

    #   other if a failure occurred

    start-stop-daemon --stop --quiet --retry=TERM/30/KILL/5 --pidfile $PIDFILE --name $NAME

    RETVAL="$?"

    [ "$RETVAL" = 2 ] && return 2

    # Wait for children to finish too if this is a daemon that forks

    # and if the daemon is only ever run from this initscript.

    # If the above conditions are not satisfied then add some other code

    # that waits for the process to drop all resources that could be

    # needed by services started subsequently.  A last resort is to

    # sleep for some time.

    start-stop-daemon --stop --quiet --oknodo --retry=0/30/KILL/5 --exec$DAEMON

    [ "$?" = 2 ] && return 2

    # Many daemons don't delete their pidfiles when they exit.

    rm -f $PIDFILE

    return"$RETVAL"

}



#

# Function that sends a SIGHUP to the daemon/service

#

do_reload() {

    #

    # If the daemon can reload its configuration without

    # restarting (for example, when it is sent a SIGHUP),

    # then implement that here.

    #

    start-stop-daemon --stop --signal 1 --quiet --pidfile $PIDFILE --name $NAME

    return 0

}



case"$1"in

  start)

    [ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC""$NAME"

    do_start

    case"$?"in

        0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;

        2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;

    esac

    ;;

  stop)

    [ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC""$NAME"

    do_stop

    case"$?"in

        0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;

        2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;

    esac

    ;;

  #reload|force-reload)

    #

    # If do_reload() is not implemented then leave this commented out

    # and leave 'force-reload' as an alias for 'restart'.

    #

    #log_daemon_msg "Reloading $DESC" "$NAME"

    #do_reload

    #log_end_msg $?

    #;;

  restart|force-reload)

    #

    # If the "reload" option is implemented then remove the

    # 'force-reload' alias

    #

    log_daemon_msg "Restarting $DESC""$NAME"

    do_stop

    case"$?"in

      0|1)

        do_start

        case"$?"in

            0) log_end_msg 0 ;;

            1) log_end_msg 1 ;; # Old process is still running

            *) log_end_msg 1 ;; # Failed to start

        esac

        ;;

      *)

        # Failed to stop

        log_end_msg 1

        ;;

    esac

    ;;

  *)

    #echo "Usage: $SCRIPTNAME {start|stop|restart|reload|force-reload}" >&2

    echo"Usage: $SCRIPTNAME {start|stop|restart|force-reload}" >&2

    exit 3

    ;;

esac



:

# 设置该脚本为可以执行

sudo chmod +x /etc/init.d/supervisord

# 设置为开机自动运行

sudo update-rc.d supervisord defaults

# 试一下，是否工作正常

service supervisord stop

service supervisord start

若报错：insserv: warning: script 'service' missing LSB tags and overrides，请执行:

sudo apt-get remove insserv

 

四、Web端控制（原创）

vim /etc/supervisord.conf



[inet_http_server]         ; inet (TCP) server disabled by default

port=192.168.10.11:9002                    ; ip_address:port specifier, *:port for all iface

username=user              ; default is no username (open server)

password=123               ; default is no password (open server)



[supervisorctl]

serverurl=unix:///tmp/supervisor.sock ; use a unix:// URL  for a unix socket

serverurl=http://192.168.10.11:9002 ; use an http:// url to specify an inet socket

username=user              ; should be same as in [*_http_server] if set

password=123                ; should be same as in [*_http_server] if set



[inet_http_server] 和 [supervisorctl] 中的ip、端口、用户名、密码要一一对应。

最后重启 service supervisord restart

即可访问 http://192.168.10.11:9002。

 

五、命令

supervisord : 启动supervisor

supervisorctl reload :修改完配置文件后重新启动supervisor

supervisorctl status :查看supervisor监管的进程状态

supervisorctl start 进程名 ：启动XXX进程

supervisorctl stop 进程名 ：停止XXX进程

supervisorctl stop all：停止全部进程，注：start、restart、stop都不会载入最新的配置文件。

supervisorctl update：根据最新的配置文件，启动新配置或有改动的进程，配置没有改动的进程不会受影响而重启

 

六、多个进程管理

 

 

按照官方文档的定义，一个 [program:x] 实际上是表示一组相同特征或同类的进程组，也就是说一个 [program:x] 可以启动多个进程。这组进程的成员是通过 numprocs 和 process_name 这两个参数来确定的，这句话什么意思呢，我们来看这个例子。

; 设置进程的名称，使用 supervisorctl 来管理进程时需要使用该进程名

[program:foo]



; 可以在 command 这里用 python 表达式传递不同的参数给每个进程

command=python server.py --port=90%(process_num)02d



directory=/home/python/tornado_server ; 执行 command 之前，先切换到工作目录



; 若 numprocs 不为1，process_name 的表达式中一定要包含 process_num 来区分不同的进程

numprocs=2                  

process_name=%(program_name)s_%(process_num)02d;



user=oxygen                 ; 使用 oxygen 用户来启动该进程



autorestart=true  ; 程序崩溃时自动重启



redirect_stderr=true      ; 重定向输出的日志



stdout_logfile = /var/log/supervisord/

tornado_server.log

loglevel=info

上面这个例子会启动两个进程，process_name 分别为 foo:foo_01 和 foo:foo_02。通过这样一种方式，就可以用一个 [program:x] 配置项，来启动一组非常类似的进程。 



更详细配置，点击这里

Supervisor 同时还提供了另外一种进程组的管理方式，通过这种方式，可以使用 supervisorctl 命令来管理一组进程。跟 [program:x] 的进程组不同的是，这里的进程是一个个的 [program:x] 。

[group:thegroupname]

programs=progname1,progname2  ; each refers to'x'in [program:x] definitions

priority=999                  ; the relative start priority (default999)

当添加了上述配置后，progname1 和 progname2 的进程名就会变成 thegroupname:progname1 和 thegroupname:progname2 以后就要用这个名字来管理进程了，而不是之前的 progname1。

以后执行 supervisorctl stop thegroupname: 就能同时结束 progname1 和 progname2，执行 supervisorctl stop thegroupname:progname1 就能结束 progname1。

 

七、注意

1.

numprocs>1时，process_name 的表达式中一定要包含 process_num 来区分不同的进程。

process_name=%(program_name)s_%(process_num)02d

 

2.重启

 

改完配置之后，重启

supervisorctl restart program_name

或者

supervisorctl reload