supervisor学习记录

梦里梦外; 2022-05-09 02:26 177阅读 0赞

### 1.supervisor 简介 ###

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

### 2. supervisor 安装 ###

sudo apt-get install supervisor

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

### 3.生成配置文件 ###

echo_supervisord_conf > /etc/supervisor/supervisord.conf

### 4. 配置文件参数说明 ###

[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结束的配置文件

### 5. 配置管理进程 ###

进程管理配置参数，不建议全都写在supervisord.conf文件中，应该每个进程写一个配置文件放在include指定的目录下包含进supervisord.conf文件中。 修改/etc/supervisor/supervisord.conf中的include参数，将/etc/supervisor/conf.d目录添加到include中（关于\*.ini，大部分资料用的都是\*.conf格式作为配置文件。这个地方建议大家也都用\*.conf不要用\*.ini）

[include]
    files = /etc/supervisor/conf.d/*.ini
    改为
    [include]
    files = /etc/supervisor/conf.d/*.conf

在conf.d文件夹下新建tomcat.conf文件，向其添加

[program:tomcat]
    command=/opt/tomcat/bin/catalina.sh run # catalina.sh 目录
    environment=JAVA_HOME="/usr/local/jdk/",JAVA_BIN="/usr/local/jdk/bin" # java目录
    directory=/opt/tomcat # Tomcat的根目录
    autostart = true
    autorestart=true
    redirect_stderr=true
    stopasgroup=true
    killasgroup=true

**注意**

关于在command中，执行.sh脚本 请参照此配置文件中command的写法，直接写command=source xxx，会报source不认识：

[program:blog]
    command=/bin/bash -c 'source /var/ftp_root/program/blog/startall.sh'
    user=root
    autostart=true
    autorestart=true
    redirect_stderr=True
    stdout_logfile=/tmp/blog.log
    stderr_logfile=/tmp/blog.err
    stopasgroup=true
    killasgroup=true

### 6. 启动supervisor 服务 ###

supervisord -c /etc/supervisor/supervisord.conf

### 7. 控制进程 ###

*  7.1 交互终端
    
    supervisord启动成功后，可以通过supervisorctl客户端控制进程，启动、停止、重启。运行supervisorctl命令，不加参数，会进入supervisor客户端的交互终端，并会列出当前所管理的所有进程。

![20180929112851.png][]

输入help可以查看可以执行的命令列表，如果想看某个命令的作用，运行help 命令名称，如：help stop

stop tomcat  // 表示停止tomcat进程
    stop all     // 表示停止所有进程
    ...

*  7.2 supervisor的常用命令

supervisorctl status #查看所管理的进程状态
    # 在修改好配置文件之后使用下面两个命令进行更新
    supervisorctl reread  
    supervisorctl update
    #重新启动配置中的所有程序
    supervisorctl reload  
    启动某个进程(program_name=你配置中写的程序名称)
    supervisorctl start program_name  
    查看正在管理的进程
    supervisorctl  
    # 停止某一进程 (program_name=你配置中写的程序名称)
    supervisorctl stop program_name  
    # 停止全部进程
    supervisorctl stop all

*  7.3 web管理页面

于安全考虑，默认配置是没有开启web管理界面，需要修改supervisord.conf配置文件打开http访权限，将下面的配置：

;[inet_http_server]         ; inet (TCP) server disabled by default
    ;port=127.0.0.1:9001        ; (ip_address:port specifier, *:port for all iface)
    ;username=user              ; (default is no username (open server))
    ;password=123               ; (default is no password (open server))
    
    改为
    
    [inet_http_server]         ; inet (TCP) server disabled by default
    port=0.0.0.0:9001          ; (ip_address:port specifier, *:port for all iface)
    username=user              ; (default is no username (open server))
    password=123               ; (default is no password (open server))

port：绑定访问IP和端口，这里是绑定的是本地IP和9001端口 ,注意要把127.0.0.1修改成0.0.0.0,否则外网访问不了。

username：登录管理后台的用户名

password：登录管理后台的密码

### 8. supervisor开机自启 ###

编辑/etc/rc.local文件，在 exit 0 之前加入以下命令

service supervisor start

或者  
使用supervisor 官方开机启动脚本 [https://github.com/Supervisor/initscripts][https_github.com_Supervisor_initscripts]

[20180929112851.png]: https://raw.githubusercontent.com/zhaozhen197/my_markdown_img/master/20180929112851.png
[https_github.com_Supervisor_initscripts]: https://github.com/Supervisor/initscripts