supervisor使用教程（django例子）_supervisor django-优快云博客

本文链接：https://blog.youkuaiyun.com/lin_keys/article/details/112985186

前言

Supervisor是用Python开发的一套通用的进程管理程序，能将一个普通的命令行进程变为后台daemon，可以很方便的监听、启动、停止、重启一个或多个进程。它是通过fork/exec的方式把这些被管理的进程当作supervisor的子进程来启动，这样只要在supervisor的配置文件中，把要管理的进程的可执行文件的路径写进去即可。也实现当子进程挂掉的时候，父进程可以准确获取子进程挂掉的信息的，可以选择是否自己启动和报警。supervisor还提供了一个功能，可以为supervisord或者每个子进程，设置一个非root的user，这个user就可以管理它对应的进程。

安装

安装supervisor可以采用下面两种方法进行安装：

第一种方法通过pip（联网情况下）：

yum install python-setuptools
pip install supervisor

第二种方法通过安装包（不可以联网情况下）

#将安装下下来
wget https://pypi.python.org/packages/source/s/supervisor/supervisor-3.1.3.tar.gz
# 放到服务器通过python来安装
tar zxvf supervisor-3.1.3.tar.gz
cd supervisor-3.1.3
python setup.py install

使用supervisor监督django

第一步生成 supervisord.conf 配置文件

新建supervisor文件夹

mkdir /usr/supervisor

生成 supervisord.conf 配置文件

echo_supervisord_conf > /usr/supervisor/supervisord.conf

注意： echo_supervisord_conf 命令是输出一个Supervisor 示例配置文件到终端

supervisord.conf 配置文件解释：

; Sample supervisor config file.  ; supervisor配置文件
;
; For more information on the config file, please see:
; http://supervisord.org/configuration.html
;
; Notes:
;  - Shell expansion ("~" or "$HOME") is not supported.  Environment
;    variables can be expanded using this syntax: "%(ENV_HOME)s".
;  - Quotes around values are not supported, except in the case of
;    the environment= options as shown below.
;  - Comments must have a leading space: "a=b ;comment" not "a=b;comment".
;  - Command will be truncated if it looks like a config file comment, e.g.
;    "command=bash -c 'foo ; bar'" will truncate to "command=bash -c 'foo ".
;
; Warning:
;此示例文件中的所有路径都使用/ tmp，因为它在大多数系统上都可用。 
;您可能需要将它们更改为更适合您的系统的位置。 某些系统会定期删除/ tmp中的旧文件。
; 值得注意的是，如果删除了下面[unix_http_server]部分中定义的套接字文件，supervisorctl将无法连接到supervisor。

;监听 Unix domain socket 的 HTTP 服务器的配置参数。
;如果配置文件中没有[ unix_HTTP_server ]部分，则不会启动 Unix domain socket HTTP 服务器
[unix_http_server]
file=/tmp/supervisor.sock   ; socket 路径
;chmod=0700                 ; socket 文件的权限(默认 700)
;chown=nobody:nogroup       ; socket 所属用户及组:gid owner
;username=user              ; 用户名 
;password=123               ; 密码 

; Security Warning:
;默认情况下，未启用inet HTTP服务器。 通过取消注释下面的[inet_http_server]部分，可以启用inet HTTP服务器。
; inet HTTP服务器仅在受信任的环境中使用。 它仅应绑定到localhost或只能从隔离的受信任网络中访问。
; inet HTTP服务器不支持任何形式的加密。 默认情况下，Inet HTTP服务器不使用身份验证（请参阅用于添加身份验证的username =和password =选项）。
; 切勿将inet HTTP服务器暴露给公共互联网。

;[inet_http_server]         ; 是否启用服务，默认是关闭的（启用的话可以看到supervisor 管理的服务状态）
;port=127.0.0.1:9001        ; 监听的IP及端口, *:所有端口
;username=user              ; 用户名
;password=123               ; 密码 

[supervisord] ;supervisord 全局配置
logfile=/tmp/supervisord.log ; supervisor 日志路径, 默认 $CWD/supervisord.log
logfile_maxbytes=50MB        ; 单个日志文件最大数; 默认 50MB
logfile_backups=10           ; 保留多少个日志文件 默认 10
loglevel=info                ; 日志等级; 默认 info; 另支持: debug,warn,trace
pidfile=/tmp/supervisord.pid ; pid 文件路径 
nodaemon=false               ; 启动是否丢到前台，设置为false ，表示以daemon 的方式启动
silent=false                 ; 如果为 true 且未经守护化，则不会将日志定向到 stdout
minfds=1024                  ; 最小文件打开数，对应系统limit.conf 中的nofile ,默认最小为1024，最大为4096
minprocs=200                 ; 最小的进程打开数，对应系统的limit.conf 中的nproc,默认为200
;umask=022                   ; 处理文件创建umask; 默认 22
;user=supervisord            ;  启动supervisord 服务的用户，默认为root
;identifier=supervisor       ; supervisord 标志, default is 'supervisor'
;directory=/tmp              ; 这里的目录指的是服务的工作目录
;nocleanup=true              ; 不要在启动时清理临时文件; 默认 false
;childlogdir=/tmp            ;子日志文件, default $TEMP
;environment=KEY="value"     ; key value pairs to add to environment
;strip_ansi=false            ; 在日志中删除ansi转义码; 默认. false

; rpcinterface：supervisor部分必须保留在配置文件中才能使RPC（supervisorctl / web接口）正常工作。
 ;通过在单独的[rpcinterface：x]节中定义它们，可以添加其他接口。

[rpcinterface:supervisor]
supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface

; 超级用户节配置超级用户将如何连接到超级用户。 
; 配置它以与unix_http_server或inet_http_server部分中的设置匹配。

[supervisorctl]
serverurl=unix:///tmp/supervisor.sock ; use a unix:// URL  for a unix socket
;serverurl=http://127.0.0.1:9001 ; use an http:// url to specify an inet socket
;username=chris              ; should be same as in [*_http_server] if set
;password=123                ; should be same as in [*_http_server] if set
;prompt=mysupervisor         ; cmd line prompt (default "supervisor")
;history_file=~/.sc_history  ; use readline history if available

;下面的示例程序部分显示了所有可能的程序子部分值。 创建一个或多个“real”程序：可以在主管下控制它们的部分。

;[program:theprogramname]  ;定义一个守护进程
;command=/bin/cat              ; 启动程序使用的命令，可以是绝对路径或者相对路径
;process_name=%(program_name)s ; 一个python字符串表达式，用来表示supervisor进程启动的这个的名称，默认值是%(program_name)s
;numprocs=1                    ; Supervisor启动这个程序的多个实例，如果numprocs>1，则process_name的表达式必须包含%(process_num)s，默认是1
;directory=/tmp                ; supervisord在生成子进程的时候会切换到该目录
;umask=022                     ; umask for process (default None)
;priority=999                  ; 权重，可以控制程序启动和关闭时的顺序，权重越低：越早启动，越晚关闭。默认值是999
;autostart=true                ; 如果设置为true，当supervisord启动的时候，进程会自动启动
;autorestart=true              ; 设置为随 supervisord 重启而重启，值可以是false、true、unexpected。false：进程不会自动重启
;startsecs=10                  ; 程序启动后等待多长时间后才认为程序启动成功，默认是10秒
;startretries=3                ; supervisord尝试启动一个程序时尝试的次数。默认是3
;exitcodes=0,2                 ; 一个预期的退出返回码，默认是0,2。
;stopsignal=QUIT               ; 当收到stop请求的时候，发送信号给程序，默认是TERM信号，也可以是 HUP, INT, QUIT, KILL, USR1, or USR2
;stopwaitsecs=10               ; 在操作系统给supervisord发送SIGCHILD信号时等待的时间
;user=chrism                   ; 如果supervisord以root运行，则会使用这个设置用户启动子程序
;redirect_stderr=true          ; 如果设置为true，进程则会把标准错误输出到supervisord后台的标准输出文件描述符
;stdout_logfile=/a/path        ; 把进程的标准输出写入文件中，如果stdout_logfile没有设置或者设置为AUTO，则supervisor会自动选择一个文件位置
;stdout_logfile_maxbytes=1MB   ; 标准输出log文件达到多少后自动进行轮转，单位是KB、MB、GB。如果设置为0则表示不限制日志文件大小
;stdout_logfile_backups=10     ; 标准输出日志轮转备份的数量，默认是10，如果设置为0，则不备份
;stdout_capture_maxbytes=1MB   ; 当进程处于stderr capture mode模式的时候，写入FIFO队列的最大bytes值，单位可以是KB、MB、GB
;stdout_events_enabled=false   ; 如果设置为true，当进程在写它的stderr
;stderr_logfile=/a/path        ; 把进程的错误日志输出一个文件中，除非redirect_stderr参数被设置为true
;stderr_logfile_maxbytes=1MB   ; 错误log文件达到多少后自动进行轮转，单位是KB、MB、GB。如果设置为0则表示不限制日志文件大小
;stderr_logfile_backups=10     ; 错误日志轮转备份的数量，默认是10，如果设置为0，则不备份
;stderr_capture_maxbytes=1MB   ; 当进程处于stderr capture mode模式的时候，写入FIFO队列的最大bytes值，单位可以是KB、MB、GB
;stderr_events_enabled=false   ; 如果设置为true，当进程在写它的stderr到文件描述符的时候，PROCESS_LOG_STDERR事件会被触发
;environment=A=1,B=2           ; 一个k/v对的list列表
;serverurl=AUTO                ; 是否允许子进程和内部的HTTP服务通讯，如果设置为AUTO，supervisor会自动的构造一个url

; 下面的示例事件侦听器部分显示了所有可能的事件侦听器子部分的值。 
;创建一个或多个“真实的”事件监听器：以便处理主管发送的事件通知的部分。

;[eventlistener:theeventlistenername]   ;事件侦听
;command=/bin/eventlistener    ; the program (relative uses PATH, can take args)
;process_name=%(program_name)s ; process_name expr (default %(program_name)s)
;numprocs=1                    ; number of processes copies to start (def 1)
;events=EVENT                  ; event notif. types to subscribe to (req'd)
;buffer_size=10                ; event buffer queue size (default 10)
;directory=/tmp                ; directory to cwd to before exec (def no cwd)
;umask=022                     ; umask for process (default None)
;priority=-1                   ; the relative start priority (default -1)
;autostart=true                ; start at supervisord start (default: true)
;startsecs=1                   ; # of secs prog must stay up to be running (def. 1)
;startretries=3                ; max # of serial start failures when starting (default 3)
;autorestart=unexpected        ; autorestart if exited after running (def: unexpected)
;exitcodes=0                   ; 'expected' exit codes used with autorestart (default 0)
;stopsignal=QUIT               ; signal used to kill process (default TERM)
;stopwaitsecs=10               ; max num secs to wait b4 SIGKILL (default 10)
;stopasgroup=false             ; send stop signal to the UNIX process group (default false)
;killasgroup=false             ; SIGKILL the UNIX process group (def false)
;user=chrism                   ; setuid to this UNIX account to run the program
;redirect_stderr=false         ; redirect_stderr=true is not allowed for eventlisteners
;stdout_logfile=/a/path        ; stdout log path, NONE for none; default AUTO
;stdout_logfile_maxbytes=1MB   ; max # logfile bytes b4 rotation (default 50MB)
;stdout_logfile_backups=10     ; # of stdout logfile backups (0 means none, default 10)
;stdout_events_enabled=false   ; emit events on stdout writes (default false)
;stdout_syslog=false           ; send stdout to syslog with process name (default false)
;stderr_logfile=/a/path        ; stderr log path, NONE for none; default AUTO
;stderr_logfile_maxbytes=1MB   ; max # logfile bytes b4 rotation (default 50MB)
;stderr_logfile_backups=10     ; # of stderr logfile backups (0 means none, default 10)
;stderr_events_enabled=false   ; emit events on stderr writes (default false)
;stderr_syslog=false           ; send stderr to syslog with process name (default false)
;environment=A="1",B="2"       ; process environment additions
;serverurl=AUTO                ; override serverurl computation (childutils)

; The sample group section below shows all possible group values.  Create one
; or more 'real' group: sections to create "heterogeneous" process groups.

;[group:thegroupname] ; 服务组管理，可以将多个服务名写到这里管理(组名自定义）
;programs=progname1,progname2  ; 上面配置好的服务名
;priority=999                  ; the relative start priority (default 999)

; The [include] section can just contain the "files" setting.  This
; setting can list multiple files (separated by whitespace or
; newlines).  It can also contain wildcards.  The filenames are
; interpreted as relative to this file.  Included files *cannot*
; include files themselves.

;[include]
;files = relative/directory/*.ini

管理配置文件

新建配置管理文件夹

mkdir /usr/supervisor/supervisord.d/

修改前面生成的supervisord.conf

vim /usr/supervisor/supervisord.conf

[include] 改为如下所示

[include]
files = /usr/supervisor/supervisord.d/*.conf

打开可视化管理平台

[inet_http_server]
；下面配置自己根据实际情况配置
port=127.0.0.1:9061   
username=user              
password=123

注意：打开管理平台可能会导致CPU和内存占用率高，后期使用建议关闭这项服务

新增supervisor_django.conf配置文件

在/usr/supervisor/supervisord.d/下新建一个supervisor_django.conf配置文件

[program:test_supervisor]
directory=/home/linjian/documents/django_project  ; 先cd到django项目目录去
command= python manage.py runserver 0.0.0.0:9561  ; 被监控的进程
priority=1                    ; 数字越高，优先级越高
numprocs=1                    ; 启动几个进程
autostart=true                ; 随着supervisord的启动而启动
autorestart=true              ; 自动重启
startretries=10               ; 启动失败时的最多重试次数
exitcodes=0                   ; 正常退出代码
stopsignal=KILL               ; 用来杀死进程的信号
stopwaitsecs=10               ; 发送SIGKILL前的等待时间
redirect_stderr=true          ; 重定向stderr到stdout
stdout_logfile= path          ;输出日志路径
stderr_logfile= path          ;错误日志路径

配置文件解释

- command：启动程序使用的命令，可以是绝对路径或者相对路径
- process_name：一个python字符串表达式，用来表示supervisor进程启动的这个的名称，默认值是%(program_name)s
- numprocs：Supervisor启动这个程序的多个实例，如果numprocs>1，则process_name的表达式必须包含%(process_num)s，默认是1
- numprocs_start：一个int偏移值，当启动实例的时候用来计算numprocs的值
- priority：权重，可以控制程序启动和关闭时的顺序，权重越低：越早启动，越晚关闭。默认值是999
- autostart：如果设置为true，当supervisord启动的时候，进程会自动重启。
- autorestart：值可以是false、true、unexpected。false：进程不会自动重启，unexpected：当程序退出时的退出码不是exitcodes中定义的时，进程会重启，true：进程会无条件重启当退出的时候。
- startsecs：程序启动后等待多长时间后才认为程序启动成功
- startretries：supervisord尝试启动一个程序时尝试的次数。默认是3
- exitcodes：一个预期的退出返回码，默认是0,2。
- stopsignal：当收到stop请求的时候，发送信号给程序，默认是TERM信号，也可以是 HUP, INT, QUIT, KILL, USR1, or USR2。
- stopwaitsecs：在操作系统给supervisord发送SIGCHILD信号时等待的时间
- stopasgroup：如果设置为true，则会使supervisor发送停止信号到整个进程组
- killasgroup：如果设置为true，则在给程序发送SIGKILL信号的时候，会发送到整个进程组，它的子进程也会受到影响。
- user：如果supervisord以root运行，则会使用这个设置用户启动子程序
- redirect_stderr：如果设置为true，进程则会把标准错误输出到supervisord后台的标准输出文件描述符。
- stdout_logfile：把进程的标准输出写入文件中，如果stdout_logfile没有设置或者设置为AUTO，则supervisor会自动选择一个文件位置。
- stdout_logfile_maxbytes：标准输出log文件达到多少后自动进行轮转，单位是KB、MB、GB。如果设置为0则表示不限制日志文件大小
- stdout_logfile_backups：标准输出日志轮转备份的数量，默认是10，如果设置为0，则不备份
- stdout_capture_maxbytes：当进程处于stderr capture mode模式的时候，写入FIFO队列的最大bytes值，单位可以是KB、MB、GB
- stdout_events_enabled：如果设置为true，当进程在写它的stderr到文件描述符的时候，PROCESS_LOG_STDERR事件会被触发
- stderr_logfile：把进程的错误日志输出一个文件中，除非redirect_stderr参数被设置为true
- stderr_logfile_maxbytes：错误log文件达到多少后自动进行轮转，单位是KB、MB、GB。如果设置为0则表示不限制日志文件大小
- stderr_logfile_backups：错误日志轮转备份的数量，默认是10，如果设置为0，则不备份
- stderr_capture_maxbytes：当进程处于stderr capture mode模式的时候，写入FIFO队列的最大bytes值，单位可以是KB、MB、GB
- stderr_events_enabled：如果设置为true，当进程在写它的stderr到文件描述符的时候，PROCESS_LOG_STDERR事件会被触发
- environment：一个k/v对的list列表
- directory：supervisord在生成子进程的时候会切换到该目录
- umask：设置进程的umask
- serverurl：是否允许子进程和内部的HTTP服务通讯，如果设置为AUTO，supervisor会自动的构造一个url

启动supervisor服务

执行supervisord -c /usr/supervisor/supervisord.conf 启动服务了，但是我们可以supervisorctl 进行交互

[root@lj supervisord.d]# supervisorctl -c /usr/supervisor/supervisord.conf
test_supervisor                  RUNNING   pid 8097, uptime 3:10:42
supervisor> status
test_supervisor                  RUNNING   pid 13767, uptime 0:01:11
supervisor> reload

校验是否运行成功

lsof -i:9061

运行之后我们可以去管理平台查看结果（地址是前面配置的127.0.0.1:9061 ）

常用命令

支持的命令

[root@lj supervisord.d]# supervisorctl help

default commands (type help <topic>):
=====================================
add    exit      open  reload  restart   start   tail   
avail  fg        pid   remove  shutdown  status  update 
clear  maintail  quit  reread  signal    stop    version

update 更新新的配置到supervisord（不会重启原来已运行的程序）

reload，载入所有配置文件，并按新的配置启动、管理所有进程（会重启原来已运行的程序）

start : 启动某个进程

restart : 重启某个进程

stop : 停止某一个进程，[program:theprogramname]里配置的值

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

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

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

supervisor开机自启动

/usr/lib/systemd/system/ 新建文件supervisord.service

[Unit]
Description=Process Monitoring and Control Daemon
After=rc-local.service nss-user-lookup.target

[Service]
Type=forking
ExecStart=/usr/bin/supervisord -c /usr/supervisor/supervisord.conf ;开机启动时执行
ExecStop=/usr/bin/supervisord shutdown
ExecReload=/usr/bin/supervisord reload
killMode=process
Restart=on-failure
RestartSec=42s

[Install]
WantedBy=multi-user.target

启动服务

systemctl enable supervisord

验证是否配置成功

systemctl is-enabled supervisord

监控组件介绍

supervisord

supervisord在服务器起监督员作用。它负责在自己的调用中启动子程序，响应来自客户机的命令，重新启动崩溃或退出子处理器，记录其子处理器 stdout 和 stderr 输出，并生成和处理与子处理器生命周期中的点对应的“事件”。服务器进程使用一个配置文件（ /usr/supervisor/supervisord.conf）。这个配置文件是一个“ Windows-INI”风格的配置文件。重要的是要保持这个文件的安全，通过正确的访问许可权/密码，因为它可能包含未加密的用户名和密码。