1. 程式人生 > 其它 >Supervisor程序守護監控部署

Supervisor程序守護監控部署

前言:Supervisor在百度百科上給的定義是超級使用者,監管員。Supervisor是一個程序管理工具,當程序中斷的時候Supervisor能自動重新啟動該程序。可以執行在各類Unix機器上,supervisor使用Python語言開發的一套通用的程序管理程式,能將一個普通的命令列程序變為後臺daemon,並監控程序狀態,異常退出時能自動重啟。

簡介

  • supervisord

    執行Supervisor時會啟動一個程序supervisord,它負責啟動所管理的程序,並將所管理的程序作為自己的子程序來啟動,而且可以在所管理的程序出現崩潰時自動重啟。

  • supervisortctl

    是命令列管理工具,可以用來執行stop,start,restart等命令,來對這些子程序進行管理。

    supervisor是所有程序的父程序,管理著啟動的子程序,supervisor以子程序的PID來管理子程序,當子程序異常退出時,supervisor可以收到響應的訊號量。

安裝Supervisor

安裝方式1

  • 安裝Python(使用centos映象安裝)

    • yum install python-setuptools -y
    •            
      • 安裝Supervisor

        • easy_install supervisor
    • 安裝方式2

      • cd /opt
        wget https://pypi.python.org/packages/source/s/supervisor/supervisor-3.1.3.tar.gz
        tar zxvf supervisor-3.1.3.tar.gz
        cd supervisor-3.1.3
        #下載依賴
        wget https://files.pythonhosted.org/packages/3e/ab/9615164b2a4a935e34a62646e9106445e9895464079c13c1ac1200dd88c8/meld3-0.6.7.tar.gz 
        cd meld3-0.6.7
        python setup.py install
        返回到 supervisor-3.1.3
        cd ../
        python setup.py install

      檢視是否安裝成功

      echo_supervisord_conf

      配置Supervisor

        • 建立目錄,初始化配置檔案

          • mkdir /usr/loca/supervisor
            echo_supervisord_conf > /usr/local/supervisor/supervisord.conf
        • echo_supervisord_conf 詳解:

          • [root@centos-011 ~ 07:50:00]#cat /etc/supervisord.conf.bak
            ; Sample supervisor config file.
             
            [unix_http_server]
            file=/var/run/supervisor/supervisor.sock   ; socket 路徑
             
            ;chmod=0700                 ; socket 檔案的許可權
            ;chown=nobody:nogroup       ; socket 所屬使用者及組
            ;username=user              ; 使用者名稱
            ;password=123               ; 密碼
             
            ;[inet_http_server]         ; 是否啟用服務,預設是關閉的(啟用的話可以看到supervisor 管理的服務狀態)
            ;port=127.0.0.1:9001        ; 監聽的IP及埠
            ;username=user              ; 使用者名稱
            ;password=123               ; 密碼
             
            [supervisord]               ; supervisord 全域性配置
            logfile=/var/log/supervisor/supervisord.log  ; supervisor 日誌路徑
            logfile_maxbytes=50MB       ; 單個日誌檔案最大數
            logfile_backups=10          ; 保留多少個日誌檔案(預設10個)
            loglevel=info               ; (log level;default info; others: debug,warn,trace)
            pidfile=/var/run/supervisord.pid ; pid 檔案路徑
            nodaemon=false              ; 啟動是否丟到前臺,設定為false ,表示以daemon 的方式啟動
            minfds=1024                 ; 最小檔案開啟數,對應系統limit.conf 中的nofile ,預設最小為1024,最大為4096
            minprocs=200                ; 最小的程序開啟數,對應系統的limit.conf 中的nproc,預設為200
            ;umask=022                  ; (process file creation umask;default 022)
            ;user=chrism                 ; 啟動supervisord 服務的使用者,預設為root
            ;identifier=supervisor       ; (supervisord identifier, default is 'supervisor')
            ;directory=/tmp              ; 這裡的目錄指的是服務的工作目錄
            ;nocleanup=true              ; (don't clean up tempfiles at start;default false)
            ;childlogdir=/tmp            ; ('AUTO' child log dir, default $TEMP)
            ;environment=KEY=value       ; (key value pairs to add to environment)
            ;strip_ansi=false            ; (strip ansi escape codes in logs; def. 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]
            supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
             
            [supervisorctl]
            serverurl=unix:///var/run/supervisor/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 http_username if set
            ;password=123                ; should be same as http_password if set
            ;prompt=mysupervisor         ; cmd line prompt (default "supervisor")
            ;history_file=~/.sc_history  ; use readline history if available
             
            ; 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]      ; 定義一個守護程序 ,比如下面的elasticsearch 
            ;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
             
            ; 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.
             #這個地方是自定義一個守護程序
            [program:elasticsearch]                       ; 定義一個守護程序 elasticsearch
            environment=ES_HOME=/usr/local/elasticsearch  ; 設定ES_HOME 環境變數
            user=elk                                      ; 啟動elasticsearch 的使用者
            directory=/usr/local/elasticsearch            ; 進入到這個目錄中
            command=/usr/local/elasticsearch/bin/elasticsearch ; 執行啟動命令
            numprocs=1                                    ; Supervisor啟動這個程式的多個例項,如果numprocs>1,則process_name的表示式必須包含%(process_num)s,預設是1
            autostart=true                                ; 設定為隨 supervisord 啟動而啟動
            autorestart=true                              ; 設定為隨 supervisord 重啟而重啟
            startretries=3                                ; 設定elasticsearch 重啟的重試次數
            priority=1                                    ; 權重,可以控制程式啟動和關閉時的順序,權重越低:越早啟動,越晚關閉。預設值是999  
             
            ;[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)
            ;autorestart=unexpected        ; restart at unexpected quit (default: unexpected)
            ;startsecs=10                  ; number of secs prog must stay running (def. 1)
            ;startretries=3                ; max # of serial start failures (default 3)
            ;exitcodes=0,2                 ; 'expected' exit codes for process (default 0,2)
            ;stopsignal=QUIT               ; signal used to kill process (default TERM)
            ;stopwaitsecs=10               ; max num secs to wait b4 SIGKILL (default 10)
            ;user=chrism                   ; setuid to this UNIX account to run the program
            ;redirect_stderr=true          ; redirect proc stderr to stdout (default false)
            ;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 (default 10)
            ;stdout_events_enabled=false   ; emit events on stdout writes (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        ; # of stderr logfile backups (default 10)
            ;stderr_events_enabled=false   ; emit events on stderr writes (default false)
            ;environment=A=1,B=2           ; process environment additions
            ;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=progname1,progname2  ; 上面配置好的服務名,比如elasticsearch,kibana,logstash
            ;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 = supervisord.d/*.ini
        • 2.1 為了不將所有新增配置資訊全寫入一個配置檔案裡,這裡新建一個資料夾

          • mkdir /usr/local/supervisor/supervisord.d
        • 2.2 修改配置檔案

          • vi /usr/local/supervisor/supervisord.conf
        • 2.3include 2.1中新建的supervisord.d資料夾下所有的conf

          • [include]
            files = /usr/local/supervisor/supervisord.d/*.conf
        • 2.4若需要web檢視程序,則去掉[inet_http_server]的註釋

          • [inet_http_server]
            port=127.0.0.1:9001   ;IP按需配置需要開啟ui的配置這項     
            username=user
            password=123
            • 3.3增加配置檔案,使用supervisor來監控程式

              • cat > /usr/local/supervisor/supervisord.d/supervisor_test_one.conf

              • 在新建的資料夾中填入如下配置

                • [program:test_one]
                  command=java -jar /data/smallvideo/supervisor/taskApp-exec.jar TaskTestOne  ; 被監控的程序路徑
                  priority=1                    ; 數字越高,優先順序越高
                  numprocs=1                    ; 啟動幾個程序
                  autostart=true                ; 隨著supervisord的啟動而啟動
                  autorestart=true              ; 自動重啟
                  startretries=10               ; 啟動失敗時的最多重試次數
                  exitcodes=0                   ; 正常退出程式碼
                  stopsignal=KILL               ; 用來殺死程序的訊號
                  stopwaitsecs=10               ; 傳送SIGKILL前的等待時間
                  redirect_stderr=true          ; 重定向stderr到stdout
                  
                  [program:test_two]
                  command=java -jar /data/smallvideo/supervisor/taskApp-exec.jar TaskTestTwo   ; 被監控的程序路徑
                  priority=1                    ; 數字越高,優先順序越高
                  numprocs=1                    ; 啟動幾個程序
                  autostart=true                ; 隨著supervisord的啟動而啟動
                  autorestart=true              ; 自動重啟
                  startretries=10               ; 啟動失敗時的最多重試次數
                  exitcodes=0                   ; 正常退出程式碼
                  stopsignal=KILL               ; 用來殺死程序的訊號
                  stopwaitsecs=10               ; 傳送SIGKILL前的等待時間
                  redirect_stderr=true          ; 重定向stderr到stdout
              • 3.4supervisor配置檔案詳解

                • - 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

                  • 3.0 啟動supervisord

                    • supervisord -c /usr/supervisor/supervisord.conf
                    • 停止
                      • ps -ef | grep supervisord
                      • kill -s SIGTERM 19
                  • 3.1 檢視監聽

                    • lsof -i:9001
                  • 3.2接下來可以通過http://ip:9001/檢視supervisor的web介面了

              • 3.5監控demotest程式例項:

                • [program:demotest]
                  command=python demotest.py 10000  ; 被監控的程序啟動命令
                  directory=/root/                ; 執行前要不要先cd到目錄去,一般不用
                  priority=1                    ;數字越高,優先順序越高
                  numprocs=1                    ; 啟動幾個程序
                  autostart=true                ; 隨著supervisord的啟動而啟動
                  autorestart=true              ; 自動重啟。。當然要選上了
                  startretries=10               ; 啟動失敗時的最多重試次數
                  exitcodes=0                   ; 正常退出程式碼(是說退出程式碼是這個時就不再重啟了嗎?待確定)
                  stopsignal=KILL               ; 用來殺死程序的訊號
                  stopwaitsecs=10               ; 傳送SIGKILL前的等待時間
                  redirect_stderr=true          ; 重定向stderr到stdout
              • 3.6重啟supervisor

                • supervisorctl -c /usr/local/supervisor/supervisord.conf

            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