supervisor原理及如何使用

核能气质少年 提交于 2020-03-25 22:41:22

Linux进程管理工具supervisor安装及使用


1. 什么是supervisor

superviosr是一个Linux/Unix系统上的进程监控工具,他/她upervisor是一个Python开发的通用的进程管理程序,可以管理和监控Linux上面的进程,能将一个普通的命令行进程变为后台daemon,并监控进程状态,异常退出时能自动重启。不过同daemontools一样,它不能监控daemon进程

superviosr官网点此

2. 为什么用supervisor

  • 使用简单
    supervisor提供了一种统一的方式来start、stop、monitor你的进程, 进程可以单独控制,也可以成组的控制。你可以在本地或者远程命令行或者web接口来配置Supervisor。
    在linux下的很多程序通常都是一直运行着的,一般来说都需要自己编写一个能够实现进程start/stop/restart/reload功能的脚本,然后放到/etc/init.d/下面。但这样做也有很多弊端,第一我们要为每个程序编写一个类似脚本,第二,当这个进程挂掉的时候,linux不会自动重启它的,想要自动重启的话,我们还要自己写一个监控重启脚本。
    而supervisor则可以完美的解决这些问题。supervisor管理进程,就是通过fork/exec的方式把这些被管理的进程,当作supervisor的子进程来启动。这样的话,我们只要在supervisor的配置文件中,把要管理的进程的可执行文件的路径写进去就OK了。第二,被管理进程作为supervisor的子进程,当子进程挂掉的时候,父进程可以准确获取子进程挂掉的信息的,所以当然也就可以对挂掉的子进程进行自动重启,当然重启还是不重启,也要看你的配置文件里面有木有设置autostart=true了。
    supervisor通过INI格式配置文件进行配置,很容易掌握,它为每个进程提供了很多配置选项,可以使你很容易的重启进程或者自动的轮转日志。

  • 集中管理
    supervisor管理的进程,进程组信息,全部都写在一个ini格式的文件里就OK了。而且,我们管理supervisor的时候的可以在本地进行管理,也可以远程管理,而且supervisor提供了一个web界面,我们可以在web界面上监控,管理进程。 当然了,本地,远程和web管理的时候,需要调用supervisor的xml_rpc接口,这个也是后话。
    supervisor可以对进程组统一管理,也就是说咱们可以把需要管理的进程写到一个组里面,然后我们把这个组作为一个对象进行管理,如启动,停止,重启等等操作。而linux系统则是没有这种功能的,我们想要停止一个进程,只能一个一个的去停止,要么就自己写个脚本去批量停止。

3. supervisor组件

  • supervisord
    主进程,负责管理进程的server,它会根据配置文件创建指定数量的应用程序的子进程,管理子进程的整个生命周期,对crash的进程重启,对进程变化发送事件通知等。同时内置web server和XML-RPC Interface,轻松实现进程管理。。该服务的配置文件在/etc/supervisor/supervisord.conf。

  • supervisorctl
    客户端的命令行工具,提供一个类似shell的操作接口,通过它你可以连接到不同的supervisord进程上来管理它们各自的子程序,命令通过UNIX socket或者TCP来和服务通讯。用户通过命令行发送消息给supervisord,可以查看进程状态,加载配置文件,启停进程,查看进程标准输出和错误输出,远程操作等。服务端也可以要求客户端提供身份验证之后才能进行操作。

  • Web Server
    superviosr提供了web server功能,可通过web控制进程(需要设置[inethttpserver]配置项)。

  • XML-RPC Interface
    XML-RPC接口, 就像HTTP提供WEB UI一样,用来控制supervisor和由它运行的程序。

4. 安装、配置、使用

supervisor是python编写的,可以用easy_install、pip都可以安装,比如在我的centos机器下,安装命令如下:

  1.  
    yum install python-setuptools
  2.  
    easy_install pip
  3.  
    pip install superviso
  4.  
     
在这里我使用pip安装之后,在创建配置文件的时候出错,所以我又选择了使用easy_install supervisor的安装方法

当然也可以下载源码进行安装,比如:

 wget https://pypi.python.org/packages/source/s/supervisor/supervisor-3.1.3.tar.gz --no-check-certificat

  1.  
    tar -zxvf supervisor-3.1.3.tar.gz
  2.  
    cd supervisor-3.1.3
  3.  
    sudo python setup.py install

安装之后可以直接supervisord运行验证是否成功,如果报错,再逐一解决,比如可能会报meld3版本问题,这里给出安装步骤:

  1.  
    wget http://effbot.org/media/downloads/elementtree-1.2.7-20070827-preview.zip
  2.  
    unzip elementtree-1.2.7-20070827-preview.zip && cd elementtree-1.2.7-20070827-preview
  3.  
    python setup.py install

或者下载此版本:

  1.  
    wget http://www.plope.com/software/meld3/meld3-0.6.5.tar.gz
  2.  
    tar -xf meld3-0.6.5.tar.gz && cd meld3-0.6.5
  3.  
    python setup.py install

如果安装成功就可以进行下一步了:设置配置文件。

  1.  
    ### 生成配置文件,且放在/etc目录下
  2.  
    echo_supervisord_conf > /etc/supervisord.conf
  3.  
     
  4.  
    ###为了不将所有新增配置信息全写在一个配置文件里,这里新建一个文件夹,每个程序设置一个配置文件,相互隔离
  5.  
    mkdir /etc/supervisord.d/
  6.  
     
  7.  
    ### 修改配置文件
  8.  
    vim /etc/supervisord.conf
  9.  
     
  10.  
    ### 加入以下配置信息
  11.  
    [include]
  12.  
    files = /etc/supervisord.d/*.conf
  13.  
     
  14.  
    ### 在supervisord.conf中设置通过web可以查看管理的进程,加入以下代码(默认即有,取消注释即可)
  15.  
    [inet_http_server]
  16.  
    port=9001
  17.  
    username=user
  18.  
    password=123

启动supervisord

 # supervisord -c /etc/supervisord.conf

查看一下是否监听

  1.  
    # lsof -i:9001
  2.  
    COMMAND PID USER FD TYPE DEVICE SIZE/OFF NODE NAME
  3.  
    superviso 14685 root 4u IPv4 20155719 0t0 TCP *:etlservicemgr (LISTEN)

现在通过 http://ip:9001/ 就可以查看supervisor的web界面了(默认用户名及密码是user和123),当然目前还没有加入任何监控的程序。

下面写一个简单的python脚本,用来验证supervisor的监控效果。

  1.  
    #cat /root/temp/test_http.py ###以下即是test_http.py脚本中的代码
  2.  
    #!/usr/bin/env python
  3.  
    # coding=utf-8
  4.  
    import sys
  5.  
    import BaseHTTPServer
  6.  
    from SimpleHTTPServer import SimpleHTTPRequestHandler
  7.  
    HandlerClass = SimpleHTTPRequestHandler
  8.  
    ServerClass = BaseHTTPServer.HTTPServer
  9.  
    Protocol = "HTTP/1.0"
  10.  
     
  11.  
    if __name__ == "__main__":
  12.  
    if sys.argv[1:]:
  13.  
    port = int(sys.argv[1])
  14.  
    else:
  15.  
    port = 10000
  16.  
     
  17.  
    server_address = ('0.0.0.0', port)
  18.  
    HandlerClass.protocol_version = Protocol
  19.  
    httpd = ServerClass(server_address, HandlerClass)
  20.  
     
  21.  
    sa = httpd.socket.getsockname()
  22.  
    print "Serving HTTP on", sa[0], "port", sa[1], "..."
  23.  
    httpd.serve_forever()

增加一个配置文件,以便supervisor用来监控test_http.py程序。

  1.  
    #cat /etc/supervisord.d/supervisor_test_http.conf ### 以下即为配置文件中的内容
  2.  
    [program:test_http]
  3.  
    command=python /root/temp/test_http.py 9999 ; 被监控的进程路径
  4.  
    directory=/root/temp ; 执行前要不要先cd到目录去,一般不用
  5.  
    priority=1 ;数字越高,优先级越高
  6.  
    numprocs=1 ; 启动几个进程
  7.  
    autostart=true ; 随着supervisord的启动而启动
  8.  
    autorestart=true ; 自动重启。。当然要选上了
  9.  
    startretries=10 ; 启动失败时的最多重试次数
  10.  
    exitcodes=0 ; 正常退出代码(是说退出代码是这个时就不再重启了吗?待确定)
  11.  
    stopsignal=KILL ; 用来杀死进程的信号
  12.  
    stopwaitsecs=10 ; 发送SIGKILL前的等待时间
  13.  
    redirect_stderr=true ; 重定向stderr到stdout

重新启动supervisord,或者重新加载配置文件:

  1.  
    supervisorctl reload
  2.  
    ### 或者
  3.  
    supervisorctl -c /etc/supervisord.conf

此时再访问http页面,就会发现test_http.py程序已经被监控了,且已经自动启动了。

此时也可以访问test_http.py程序提供的http服务了,比如http://ip:9999。

注意:supervisor只能监控前台程序, 如果你的程序是通过fork方式实现的daemon服务,则不能用它监控,否则supervisor> status 会提示:BACKOFF  Exited too quickly (process log may have details)。 因此像apache、tomcat服务默认启动都是按daemon方式启动的,则不能通过supervisor直接运行启动脚本(service httpd start),相反要通过一个包装过的启停脚本来完成,比如tomcat在supervisor下的启停脚本请参考:Controlling tomcat with supervisor或者supervisor-tomcat.conf

另外,可以将supervisor随系统启动而启动,Linux 在启动的时候会执行 /etc/rc.local 里面的脚本,所以只要在这里添加执行命令即可:

  1.  
    # 如果是 Ubuntu 添加以下内容(这里要写全路径,因为此时PATH的环境变量未必设置)
  2.  
    /usr/local/bin/supervisord -c /etc/supervisord.conf
  3.  
     
  4.  
    # 如果是 Centos 添加以下内容
  5.  
    /usr/bin/supervisord -c /etc/supervisord.conf

6. supervisor管理

supervisor的管理可以用命令行工具(supervisorctl)或者web界面管理,如果一步步按上面步骤操作,那么web管理就可以正常使用了,这里单独介绍下supervisorctl命令工具:

  1.  
    ### 查看supervisorctl支持的命令
  2.  
    # supervisorctl help
  3.  
    default commands (type help <topic>):
  4.  
    =====================================
  5.  
    add exit open reload restart start tail
  6.  
    avail fg pid remove shutdown status update
  7.  
    clear maintail quit reread signal stop version
  8.  
     
  9.  
    ### 查看当前运行的进程列表
  10.  
    # supervisorctl status
  11.  
    test_http RUNNING pid 28087, uptime 0:05:17

其中

  • update 更新新的配置到supervisord(不会重启原来已运行的程序)
  • reload,载入所有配置文件,并按新的配置启动、管理所有进程(会重启原来已运行的程序)
  • start xxx: 启动某个进程
  • restart xxx: 重启某个进程
  • stop xxx: 停止某一个进程(xxx),xxx为[program:theprogramname]里配置的值
  • stop groupworker: 重启所有属于名为groupworker这个分组的进程(start,restart同理)
  • stop all,停止全部进程,注:start、restart、stop都不会载入最新的配置文
  • reread,当一个服务由自动启动修改为手动启动时执行一下就ok

注意:如果原来的程序启动时需要带上参数,那通过supervisorctl start时应该先写一个shell脚本,然后supervisorctl运行该脚本即可。

7. supervisor配置参数介绍

supervisord的配置文件主要由几个配置段构成,配置项以K/V格式呈现。

  • unixhttpserver配置块

在该配置块的参数项表示的是一个监听在socket上的HTTP server,如果[unixhttpserver]块不在配置文件中或被注释,则不会启动基于socket的HTTP server。该块的参数介绍如下:

  1.  
    - file:一个unix domain socket的文件路径,HTTP/XML-RPC会监听在这上面
  2.  
    - chmod:在启动时修改unix domain socket的mode
  3.  
    - chown:修改socket文件的属主
  4.  
    - username:HTTP server在认证时的用户名
  5.  
    - password:认证密码
  • inethttpserver配置块

在该配置块的参数项表示的是一个监听在TCP上的HTTP server,如果[inethttpserver]块不在配置文件中或被注释,则不会启动基于TCP的HTTP server。该块的参数介绍如下:

  1.  
    - port:TCP监听的地址和端口(ip:port),这个地址会被HTTP/XML-RPC监听
  2.  
    - username:HTTP server在认证时的用户名
  3.  
    - password:认证密码

比如:

  1.  
    [inet_http_server] ; inet (TCP) server disabled by default
  2.  
    port=0.0.0.0:9001 ; (ip_address:port specifier, *:port for all iface)
  3.  
    username=user ; (default is no username (open server))
  4.  
    password=123 ; (default is no password (open server))

表示监听在9001端口,需要使用用户名+密码的方式访问,访问地址是:http//127.0.0.1:9001。

  • supervisord配置块

该配置块的参数项是关于supervisord进程的全局配置项。该块的参数介绍如下:

  1.  
    - logfile:log文件路径
  2.  
    - logfile_maxbytes:log文件达到多少后自动进行轮转,单位是KB、MB、GB。如果设置为0则表示不限制日志文件大小
  3.  
    - logfile_backups:轮转日志备份的数量,默认是10,如果设置为0,则不备份
  4.  
    - loglevel:error、warn、info、debug、trace、blather、critical
  5.  
    - pidfile:pid文件路径
  6.  
    - umask:umask值,默认022
  7.  
    - nodaemon:如果设置为true,则supervisord在前台启动,而不是以守护进程启动
  8.  
    - minfds:supervisord在成功启动前可用的最小文件描述符数量,默认1024
  9.  
    - minprocs:supervisord在成功启动前可用的最小进程描述符数量,默认200
  10.  
    - nocleanup:防止supervisord在启动的时候清除已经存在的子进程日志文件
  11.  
    - childlogdir:自动启动的子进程的日志目录
  12.  
    - user:supervisord的运行用户
  13.  
    - directory:supervisord以守护进程运行的时候切换到这个目录
  14.  
    - strip_ansi:消除子进程日志文件中的转义序列
  15.  
    - environment:一个k/v对的list列表

该块的参数通常不需要改动就可以使用,当然也可以按需修改。

  • program配置块

该块就是我们要监控的程序的配置项。该配置块的头部是有固定格式的,一个关键字program,后面跟着一个冒号,接下来才是程序名。例如:[program:foo],foo就是程序名,在使用supervisorctl来操作程序的时候,就是以foo来标明的。该块的参数介绍如下:

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

比如下面这个选项块就表示监控一个名叫test_http的程序:

  1.  
    [program:test_http]
  2.  
    command=python test_http.py 10000 ; 被监控的进程启动命令
  3.  
    directory=/root/ ; 执行前要不要先cd到目录去,一般不用
  4.  
    priority=1 ;数字越高,优先级越高
  5.  
    numprocs=1 ; 启动几个进程
  6.  
    autostart=true ; 随着supervisord的启动而启动
  7.  
    autorestart=true ; 自动重启。。当然要选上了
  8.  
    startretries=10 ; 启动失败时的最多重试次数
  9.  
    exitcodes=0 ; 正常退出代码(是说退出代码是这个时就不再重启了吗?待确定)
  10.  
    stopsignal=KILL ; 用来杀死进程的信号
  11.  
    stopwaitsecs=10 ; 发送SIGKILL前的等待时间
  12.  
    redirect_stderr=true ; 重定向stderr到stdout

8. 集群管理

supervisor不支持跨机器的进程监控,一个supervisord只能监控本机上的程序,大大限制了supervisor的使用。

不过由于supervisor本身支持xml-rpc,因此也有一些基于supervisor二次开发的多机器进程管理工具。比如:

  • Django-Dashvisor
    Web-based dashboard written in Python. Requires Django 1.3 or 1.4.
  • Nodervisor
    Web-based dashboard written in Node.js.
  • Supervisord-Monitor
    Web-based dashboard written in PHP.
  • SupervisorUI
    Another Web-based dashboard written in PHP.
  • cesi
    cesi is a web interface provides manage supervizors from same interface.

以上那么多,我都不会,一个个试起来也很麻烦,搞不定,除了最后一个cesi,还好懂点pyhon,勉强安装成功了。

cesi具体安装说明请直接参考原Readme。这里只做一点说明:

  1.  
    git clone https://github.com/Gamegos/cesi
  2.  
    cd cesi && mkdir pack
  3.  
    python setup.py build
  4.  
    python setup.py install
  5.  
    sqlite3 /自己的路径path/userinfo.db < userinfo.sql
  6.  
    cp cesi.conf /etc/cesi.conf ### 自行修改cesi.conf内容,kv对,很简单
  7.  
    cd cesi && python web.py ### 即可启动成功

cesi.conf配置文件的设置:

  1.  
    [node:local] ### 设置监控的各个机器
  2.  
    username = user
  3.  
    password = 123
  4.  
    host = 192.168.14.8
  5.  
    port = 9001
  6.  
     
  7.  
    ;[node:<node_name2>] ### 如果有多台机器,就依次添加
  8.  
    ;username = <username>
  9.  
    ;password = <password>
  10.  
    ;host = <hostname>
  11.  
    ;port = <port>
  12.  
     
  13.  
    ;[environment:<environment_name>]
  14.  
    ;members = <node_name>, <node_name2>
  15.  
     
  16.  
    [cesi]
  17.  
    database = /root/temp/cesi/userinfo.db ### 设置db路径
  18.  
    activity_log = /root/temp/cesi/cesi.log ### 设置log路径
  19.  
    host = 0.0.0.0

一切顺利的话,可通过页面http://ip:5000,用户名,密码都是admin,最终的效果如下所示:

cesi repo上的示例效果:

Reference

http://supervisord.org/introduction.html
http://www.cnblogs.com/kaituorensheng/p/5020793.html

易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!