supervisor使用方法
2024-06-20 07:16:41
title: supervisor使用方法
date: 2018-04-28 03:10:45
tags:
- supervisor
categories: python
背景
自己做个python小项目，发现公司都是使用supervisor管理项目的运行状态，因此学习一下
介绍
Supervisor (http://supervisord.org) 是一个用 Python 写的进程管理工具，可以很方便的用来启动、重启、关闭进程（不仅仅是 Python 进程）。除了对单个进程的控制，还可以同时启动、关闭多个进程，比如很不幸的服务器出问题导致所有应用程序都被杀死，此时可以用 supervisor 同时启动所有应用程序而不是一个一个地敲命令启动。
安装
supervisor安装非常方便，在python环境下，直接使用pip安装即可
pip install supervisor
supervisord配置
supervisor属于c/s模式，需要启动一个服务supervisord，而我们使用supervisorctl来管理其他应用程序
安装完supervisor后，可以使用以下命令将默认配置文件输出
echo_supervisord_conf > /etc/supervisord.conf
配置文件详解
[unix_http_server]
file=/tmp/supervisor.sock ; socket文件的路径，supervisorctl用XML_RPC和supervisord通信就是通过它进行的。如果不设置的话，supervisorctl也就不能用了 不设置的话，默认为none。 非必须设置
;chmod=0700 ; 这个简单，就是修改上面的那个socket文件的权限为0700不设置的话，默认为0700。 非必须设置
;chown=nobody:nogroup ; 这个一样，修改上面的那个socket文件的属组为user.group不设置的话，默认为启动supervisord进程的用户及属组。非必须设置
;username=user ; 使用supervisorctl连接的时候，认证的用户不设置的话，默认为不需要用户。 非必须设置
;password=123 ; 和上面的用户名对应的密码，可以直接使用明码，也可以使用SHA加密如：{SHA}82ab876d1387bfafe46cc1c8a2ef074eae50cb1d默认不设置。。。非必须设置;[inet_http_server] ; 侦听在TCP上的socket，Web Server和远程的supervisorctl都要用到他不设置的话，默认为不开启。非必须设置
;port=127.0.0.1:9001 ; 这个是侦听的IP和端口，侦听所有IP用 :9001或*:9001。这个必须设置，只要上面的[inet_http_server]开启了，就必须设置它
;username=user ; 这个和上面的uinx_http_server一个样。非必须设置
;password=123 ; 这个也一个样。非必须设置[supervisord] ;这个主要是定义supervisord这个服务端进程的一些参数的这个必须设置，不设置，supervisor就不用干活了
logfile=/tmp/supervisord.log ; 这个是supervisord这个主进程的日志路径，注意和子进程的日志不搭嘎。默认路径$CWD/supervisord.log，$CWD是当前目录。。非必须设置
logfile_maxbytes=50MB ; 这个是上面那个日志文件的最大的大小，当超过50M的时候，会生成一个新的日 志文件。当设置为0时，表示不限制文件大小默认值是50M，非必须设置。
logfile_backups=10 ; 日志文件保持的数量，上面的日志文件大于50M时，就会生成一个新文件。文件数量大于10时，最初的老文件被新文件覆盖，文件数量将保持为10当设置为0时，表示不限制文件的数量。默认情况下为10。。。非必须设置
loglevel=info ; 日志级别，有critical, error, warn, info, debug, trace, or blather等默认为info。。。非必须设置项
pidfile=/tmp/supervisord.pid ; supervisord的pid文件路径。默认为$CWD/supervisord.pid。。。非必须设置
nodaemon=false ; 如果是true，supervisord进程将在前台运行默认为false，也就是后台以守护进程运行。。。非必须设置
minfds=1024 ; 这个是最少系统空闲的文件描述符，低于这个值supervisor将不会启动。系统的文件描述符在这里设置cat /proc/sys/fs/file-max默认情况下为1024。。。非必须设置
minprocs=200 ; 最小可用的进程描述符，低于这个值supervisor也将不会正常启动。ulimit -u这个命令，可以查看linux下面用户的最大进程数默认为200。。。非必须设置
;umask=022 ; 进程创建文件的掩码默认为022。。非必须设置项
;user=chrism ; 这个参数可以设置一个非root用户，当我们以root用户启动supervisord之后。我这里面设置的这个用户，也可以对supervisord进行管理默认情况是不设置。。。非必须设置项
;identifier=supervisor ; 这个参数是supervisord的标识符，主要是给XML_RPC用的。当你有多个supervisor的时候，而且想调用XML_RPC统一管理，就需要为每个supervisor设置不同的标识符了默认是supervisord。。。非必需设置
;directory=/tmp ; 这个参数是当supervisord作为守护进程运行的时候，设置这个参数的话，启动supervisord进程之前，会先切换到这个目录默认不设置。。。非必须设置
;nocleanup=true ; 这个参数当为false的时候，会在supervisord进程启动的时候，把以前子进程产生的日志文件(路径为AUTO的情况下)清除掉。有时候咱们想要看历史日志，当 然不想日志被清除了。所以可以设置为true默认是false，有调试需求的同学可以设置为true。。。非必须设置
;childlogdir=/tmp ; 当子进程日志路径为AUTO的时候，子进程日志文件的存放路径。默认路径是这个东西，执行下面的这个命令看看就OK了，处理的东西就默认路径python -c "import tempfile;print tempfile.gettempdir()"非必须设置
;environment=KEY="value" ; 这个是用来设置环境变量的，supervisord在linux中启动默认继承了linux的环境变量，在这里可以设置supervisord进程特有的其他环境变量。supervisord启动子进程时，子进程会拷贝父进程的内存空间内容。 所以设置的这些环境变量也会被子进程继承。小例子：environment=name="haha",age="hehe"默认为不设置。。。非必须设置
;strip_ansi=false ; 这个选项如果设置为true，会清除子进程日志中的所有ANSI 序列。什么是ANSI序列呢？就是我们的\n,\t这些东西。默认为false。。。非必须设置; 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] ;这个选项是给XML_RPC用的，当然你如果想使用supervisord或者web server 这 个选项必须要开启的
supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface [supervisorctl] ;这个主要是针对supervisorctl的一些配置
serverurl=unix:///tmp/supervisor.sock ; 这个是supervisorctl本地连接supervisord的时候，本地UNIX socket路径，注意这个是和前面的[unix_http_server]对应的默认值就是unix:///tmp/supervisor.sock。。非必须设置
;serverurl=http://127.0.0.1:9001 ; 这个是supervisorctl远程连接supervisord的时候，用到的TCP socket路径注意这个和前面的[inet_http_server]对应默认就是http://127.0.0.1:9001。。。非必须项;username=chris ; 用户名默认空。。非必须设置
;password=123 ; 密码默认空。。非必须设置
;prompt=mysupervisor ; 输入用户名密码时候的提示符默认supervisor。。非必须设置
;history_file=~/.sc_history ; 这个参数和shell中的history类似，我们可以用上下键来查找前面执行过的命令默认是no file的。。所以我们想要有这种功能，必须指定一个文件。。。非必须设置; The below sample program section shows all possible program subsection values,
; create one or more 'real' program: sections to be able to control them under
; supervisor.;[program:theprogramname] ;这个就是咱们要管理的子进程了，":"后面的是名字，最好别乱写和实际进程有点关联最好。这样的program我们可以设置一个或多个，一个program就是要被管理的一个进程
;command=/bin/cat ; 这个就是我们的要启动进程的命令路径了，可以带参数例子：/home/test.py -a 'hehe'有一点需要注意的是，我们的command只能是那种在终端运行的进程，不能是守护进程。这个想想也知道了，比如说command=service httpd start。httpd这个进程被linux的service管理了，我们的supervisor再去启动这个命令这已经不是严格意义的子进程了。这个是个必须设置的项
;process_name=%(program_name)s ; 这个是进程名，如果我们下面的numprocs参数为1的话，就不用管这个参数了，它默认值%(program_name)s也就是上面的那个program冒号后面的名字，但是如果numprocs为多个的话，那就不能这么干了。想想也知道，不可能每个进程都用同一个进程名吧。;numprocs=1 ; 启动进程的数目。当不为1时，就是进程池的概念，注意process_name的设置默认为1 。。非必须设置
;directory=/tmp ; 进程运行前，会前切换到这个目录默认不设置。。。非必须设置
;umask=022 ; 进程掩码，默认none，非必须
;priority=999 ; 子进程启动关闭优先级，优先级低的，最先启动，关闭的时候最后关闭默认值为999 。。非必须设置
;autostart=true ; 如果是true的话，子进程将在supervisord启动后被自动启动默认就是true 。。非必须设置
;autorestart=unexpected ; 这个是设置子进程挂掉后自动重启的情况，有三个选项，false,unexpected和true。如果为false的时候，无论什么情况下，都不会被重新启动，如果为unexpected，只有当进程的退出码不在下面的exitcodes里面定义的退 出码的时候，才会被自动重启。当为true的时候，只要子进程挂掉，将会被无条件的重启
;startsecs=1 ; 这个选项是子进程启动多少秒之后，此时状态如果是running，则我们认为启动成功了默认值为1 。。非必须设置
;startretries=3 ; 当进程启动失败后，最大尝试启动的次数。。当超过3次后，supervisor将把此进程的状态置为FAIL默认值为3 。。非必须设置
;exitcodes=0,2 ; 注意和上面的的autorestart=unexpected对应。。exitcodes里面的定义的退出码是expected的。
;stopsignal=QUIT ; 进程停止信号，可以为TERM, HUP, INT, QUIT, KILL, USR1, or USR2等信号默认为TERM 。。当用设定的信号去干掉进程，退出码会被认为是expected非必须设置
;stopwaitsecs=10 ; 这个是当我们向子进程发送stopsignal信号后，到系统返回信息给supervisord，所等待的最大时间。 超过这个时间，supervisord会向该子进程发送一个强制kill的信号。默认为10秒。。非必须设置
;stopasgroup=false ; 这个东西主要用于，supervisord管理的子进程，这个子进程本身还有子进程。那么我们如果仅仅干掉supervisord的子进程的话，子进程的子进程有可能会变成孤儿进程。所以咱们可以设置可个选项，把整个该子进程的整个进程组都干掉。 设置为true的话，一般killasgroup也会被设置为true。需要注意的是，该选项发送的是stop信号默认为false。。非必须设置。。
;killasgroup=false ; 这个和上面的stopasgroup类似，不过发送的是kill信号
;user=chrism ; 如果supervisord是root启动，我们在这里设置这个非root用户，可以用来管理该program默认不设置。。。非必须设置项
;redirect_stderr=true ; 如果为true，则stderr的日志会被写入stdout日志文件中默认为false，非必须设置
;stdout_logfile=/a/path ; 子进程的stdout的日志路径，可以指定路径，AUTO，none等三个选项。设置为none的话，将没有日志产生。设置为AUTO的话，将随机找一个地方生成日志文件，而且当supervisord重新启动的时候，以前的日志文件会被清空。当 redirect_stderr=true的时候，sterr也会写进这个日志文件
;stdout_logfile_maxbytes=1MB ; 日志文件最大大小，和[supervisord]中定义的一样。默认为50
;stdout_logfile_backups=10 ; 和[supervisord]定义的一样。默认10
;stdout_capture_maxbytes=1MB ; 这个东西是设定capture管道的大小，当值不为0的时候，子进程可以从stdout发送信息，而supervisor可以根据信息，发送相应的event。默认为0，为0的时候表达关闭管道。。。非必须项
;stdout_events_enabled=false ; 当设置为ture的时候，当子进程由stdout向文件描述符中写日志的时候，将触发supervisord发送PROCESS_LOG_STDOUT类型的event默认为false。。。非必须设置
;stderr_logfile=/a/path ; 这个东西是设置stderr写的日志路径，当redirect_stderr=true。这个就不用设置了，设置了也是白搭。因为它会被写入stdout_logfile的同一个文件中默认为AUTO，也就是随便找个地存，supervisord重启被清空。。非必须设置
;stderr_logfile_maxbytes=1MB ; 这个出现好几次了，就不重复了
;stderr_logfile_backups=10 ; 这个也是
;stderr_capture_maxbytes=1MB ; 这个一样，和stdout_capture一样。 默认为0，关闭状态
;stderr_events_enabled=false ; 这个也是一样，默认为false
;environment=A="1",B="2" ; 这个是该子进程的环境变量，和别的子进程是不共享的
;serverurl=AUTO ; ; The below sample eventlistener section shows all possible
; eventlistener subsection values, create one or more 'real'
; eventlistener: sections to be able to handle event notifications
; sent by supervisor.;[eventlistener:theeventlistenername] ;这个东西其实和program的地位是一样的，也是suopervisor启动的子进程，不过它干的活是订阅supervisord发送的event。他的名字就叫listener了。我们可以在listener里面做一系列处理，比如报警等等楼主这两天干的活，就是弄的这玩意
;command=/bin/eventlistener ; 这个和上面的program一样，表示listener的可执行文件的路径
;process_name=%(program_name)s ; 这个也一样，进程名，当下面的numprocs为多个的时候，才需要。否则默认就OK了
;numprocs=1 ; 相同的listener启动的个数
;events=EVENT ; event事件的类型，也就是说，只有写在这个地方的事件类型。才会被发送;buffer_size=10 ; 这个是event队列缓存大小，单位不太清楚，楼主猜测应该是个吧。当buffer超过10的时候，最旧的event将会被清除，并把新的event放进去。默认值为10。。非必须选项
;directory=/tmp ; 进程执行前，会切换到这个目录下执行默认为不切换。。。非必须
;umask=022 ; 淹没，默认为none，不说了
;priority=-1 ; 启动优先级，默认-1，也不扯了
;autostart=true ; 是否随supervisord启动一起启动，默认true
;autorestart=unexpected ; 是否自动重启，和program一个样，分true,false,unexpected等，注意unexpected和exitcodes的关系
;startsecs=1 ; 也是一样，进程启动后跑了几秒钟，才被认定为成功启动，默认1
;startretries=3 ; 失败最大尝试次数，默认3
;exitcodes=0,2 ; 期望或者说预料中的进程退出码，
;stopsignal=QUIT ; 干掉进程的信号，默认为TERM，比如设置为QUIT，那么如果QUIT来干这个进程那么会被认为是正常维护，退出码也被认为是expected中的
;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 ;设置普通用户，可以用来管理该listener进程。默认为空。。非必须设置
;redirect_stderr=true ; 为true的话，stderr的log会并入stdout的log里面默认为false。。。非必须设置
;stdout_logfile=/a/path ; 这个不说了，好几遍了
;stdout_logfile_maxbytes=1MB ; 这个也是
;stdout_logfile_backups=10 ; 这个也是
;stdout_events_enabled=false ; 这个其实是错的，listener是不能发送event
;stderr_logfile=/a/path ; 这个也是
;stderr_logfile_maxbytes=1MB ; 这个也是
;stderr_logfile_backups ; 这个不说了
;stderr_events_enabled=false ; 这个也是错的，listener不能发送event
;environment=A="1",B="2" ; 这个是该子进程的环境变量默认为空。。。非必须设置
;serverurl=AUTO ; override serverurl computation (childutils); The below sample group section shows all possible group values,
; create one or more 'real' group: sections to create "heterogeneous"
; process groups.;[group:thegroupname] ;这个东西就是给programs分组，划分到组里面的program。我们就不用一个一个去操作了我们可以对组名进行统一的操作。 注意：program被划分到组里面之后，就相当于原来的配置从supervisor的配置文件里消失了。。。supervisor只会对组进行管理，而不再会对组里面的单个program进行管理了
;programs=progname1,progname2 ; 组成员，用逗号分开这个是个必须的设置项
;priority=999 ; 优先级，相对于组和组之间说的默认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] ;这个东西挺有用的，当我们要管理的进程很多的时候，写在一个文件里面就有点大了。我们可以把配置信息写到多个文件中，然后include过来
;files = relative/directory/*.ini
我自己更改了很多文件放置的位置,因为/tmp目录下会定时清空，引起不必要的问题，更改完配置文件就可以启动supervisord的服务了
supervisord -c /etc/supervisord.conf
supervisordctl的使用
还记得supervisord的配置吗，最后有一个[include]配置，里面存放着如何管理的应用程序信息，可以在某一目录下创建这些文件
[include]
files = /etc/supervisord.d/*.ini
配置,如下图，就是/etc/supervisor.d/supervisor_refesh_blog.ini(名字随便取)的配置
[program:refresh_blog] ;refresh_blog 是应用程序的唯一标识，不能重复
command=python refresh_blog.py ;执行程序的命令
;numprocess=1 ;进程数
;process_name ; 进程名，不填为[program:refresh_blog]中refresh_blog的名称
directory=/root/python_protjects/refresh_blog ;应用程序启动的目录
user=root ;启动的用户
autorestart=true ;是否自动重启
redirect_stderr=true ;把 stderr 重定向到 stdout，默认 false
stdout_logfile=/var/log/supervisord/refresh_blog.log ;日志文件地址
loglevel=info ;日志级别
使用supervisorctl
使用supervisorctl时启动时指定与 supervisord 使用同一份配置文件，否则与 supervisord 一样按照顺序查找配置文件
supervisorctl -c /etc/supervisord.conf
输入命令后会进入supervisorctl的交互界面
status # 查看程序状态
stop refrsh_blog # 关闭 refrsh_blog 程序
start refrsh_blog # 启动 refrsh_blog 程序
restart userefrsh_blogrcenter # 重启 refrsh_blog 程序
reread ＃ 读取有更新（增加）的配置文件，不会启动新添加的程序
update ＃ 重启配置文件修改过的程序
也可以直接在终端运行：
$ supervisorctl status
$ supervisorctl stop refrsh_blog
$ supervisorctl start refrsh_blog
$ supervisorctl restart refrsh_blog
$ supervisorctl reread
$ supervisorctl update
参考
http://liyangliang.me/posts/2015/06/using-supervisor/
http://blog.51cto.com/lixcto/1539136
supervisor使用方法相关推荐
- Supervisor进程守护监控
Supervisor在百度百科上给的定义是超级用户,监管员.Supervisor是一个进程管理工具,当进程中断的时候Supervisor能自动重新启动它.可以运行在各种类unix的机器上,superv ...
- Linux进程管理工具 Supervisor详解
介绍 Supervisor安装与配置(linux/unix进程管理工具) Supervisor(http://supervisord.org)是用Python开发的一个client/server服务, ...
- Linux运维相关目录
Linux--相关运维配置文档目录 tcp 三次握手 yum 配置 你对linux了解多少,Linux 系统结构详解! Linux LAMP环境搭建 Centos6.7安装Apache2.4+Mysq ...
- windows下nodejs express安装及入门网站,视频资料，开源项目介绍
windows下nodejs express安装及入门网站,视频资料,开源项目介绍,pm2,supervisor,npm,Pomelo,Grunt安装使用注意事项等总结 第一步:下载安装文件 下载地址 ...
- python supervisord 远程命令执行漏洞（CVE-2017-11610）
Supervisord Supervisord是一款Python开发,用于管理后台应用(服务)的工具,其角色类似于Linux自带的Systemd. 我觉得它相比Systemd有几个特点: 配置比较简单 ...
- Spark Streaming Backpressure分析
转载自:http://www.cnblogs.com/barrenlake/p/5349949.html# 1.为什么引入Backpressure 默认情况下,Spark Streaming通过Rec ...
- Flume 1.7 源码分析（三）程序入口
Flume 1.7 源码分析(一)源码编译 Flume 1.7 源码分析(二)整体架构 Flume 1.7 源码分析(三)程序入口 Flume 1.7 源码分析(四)从Source写数据到Channe ...
- .NET5都来了，你还不知道怎么部署到linux？最全部署方案，总有一款适合你
随着2020进入4季度,.NET5正式版也已经与大家见面了.不过,尽管 .NET Core发布已经有四五年的时间,但到目前为止,依旧有很多.NET开发者在坚守者.NET4,原因不尽相同,但最大的问题可 ...
- 背压/反压/BackPressure
Flink系列文章 更多Flink系列文章请点击Flink系列文章 更多大数据文章请点击大数据好文推荐 转载声明 本文大量内容系转载自以下文章,有删改,并参考其他文档资料加入了一些内容: Apache ...
最新文章
- php微信支付参数动态配置,支付,微信开发_微信支付动态如何获取$jsApiParameters参数，支付,微信开发 - phpStudy...
- Winform开发框架之肖像显示保存控件的实现
- MyBatis 源码解读-获得Mapper 对象
- [剑指offer][JAVA]面试题第[18]题[删除链表的节点]
- Linux i2c子系统驱动probe
- cache 访问延迟背后的计算机原理
- mac可以开发php嘛_Mac自带PHP开发环境的简易使用
- 有序链表转换二叉搜索树
- IXWebHosting主机如何退款中文图解教程
- 通达信公式-涨幅限制
- python︱利用dlib和opencv实现简单换脸、人脸对齐、关键点定位与画图
- HashMap简单小结
- 英语论文引用中的常用缩写含义
- bex5与java的关系_WeX5 BeX5 页面框架核心之数据绑定
- 电量统计(2)-日志
- Easyx图形库小游戏---迷宫
- 软工作业 2：时事点评-红芯浏览器事件
- 公开课 | 解密HW究竟怎么玩？之 第一篇
- Ubuntu下Intel A201 Wifi6驱动安装
- node操作文件夹复制与删除