天天看點

supervisor 使用詳解一、介紹及安裝配置二、常用指令三、配置檔案說明四、常見問題

文章目錄

  • 一、介紹及安裝配置
    • 1.1 介紹
    • 1.2 安裝
    • 1.3 配置檔案
      • 1.3.1 檢視配置檔案
      • 1.3.2 注意事項
  • 二、常用指令
  • 三、配置檔案說明
    • 3.1 配置檔案說明
    • 3.2 用例
  • 四、常見問題
    • 4.1 unix:///var/run/supervisor.sock no such file
    • 4.2 啟動了多個supervisord服務,導緻無法正常關閉服務

一、介紹及安裝配置

1.1 介紹

  • supervisord

運作 Supervisor 時會啟動一個程序 supervisord,它負責啟動所管理的程序,并将所管理的程序作為自己的子程序來啟動,而且可以在所管理的程序出現崩潰時自動重新開機。

  • supervisorctl

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

supervisor是所有程序的父程序,管理着啟動的子進展,supervisor以子程序的PID來管理子程序,當子程序異常退出時supervisor可以收到相應的信号量。

1.2 安裝

# Debian/Ubuntu可通過apt安裝
apt-get install supervisor

# 通過 pip 安裝
pip install supervisor

# easy_install 安裝
easy_install supervisor
           

1.3 配置檔案

1.3.1 檢視配置檔案

echo_supervisord_conf
# 或者
cat /etc/supervisord/supervisord.conf
           
  • 子程序配置檔案路徑:

    /etc/supervisord.d/

    • 預設子程序配置檔案為

      .ini

      格式,可在 supervisor 主配置檔案中修改

1.3.2 注意事項

  • 千萬不要先運作 supervisor,先把配置檔案裡的預設**

    tmp

    ** 檔案路徑統統改掉;打開 conf 檔案,修改 sock, log, pid 的檔案目錄,因為tmp裡的檔案說沒就沒了
  • 分号後面是注釋,如果要加分号,分号前面記得補一個空格

二、常用指令

supervisorctl status        //檢視所有程序的狀态
supervisorctl stop es       //停止es
supervisorctl start es      //啟動es
supervisorctl restart       //重新開機es
supervisorctl update        //配置檔案修改後使用該指令加載新的配置
supervisorctl reload        //重新啟動配置中的所有程式
           

三、配置檔案說明

3.1 配置檔案說明

[unix_http_server]
file=/var/run/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=/var/log/supervisord.log ;日志檔案,預設是 $CWD/supervisord.log
logfile_maxbytes=50MB        ;日志檔案大小,超出會rotate,預設 50MB,如果設成0,表示不限制大小
logfile_backups=10           ;日志檔案保留備份數量預設10,設為0表示不備份
loglevel=info                ;日志級别,預設info,其它: debug,warn,trace
pidfile=/var/run/supervisord.pid ;pid 檔案
nodaemon=false               ;是否在前台啟動,預設是false,即以 daemon 的方式啟動
minfds=1024                  ;可以打開的檔案描述符的最小值,預設 1024
minprocs=200                 ;可以打開的程序數的最小值,預設 200
 
[supervisorctl]
serverurl=unix:///var/run/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 = /etc/supervisor/conf.d/*.ini    ;可以指定一個或多個以.ini結束的配置檔案
;files = /etc/supervisor/conf.d/*.conf
           

說明:

  • [unix_http_server]: 設定 http 伺服器監聽的 Unix domain socket
    • file:指向 Unix domain socket,即:

      file=/tmp/supervisor.sock

    • chmod:啟動時,改變

      supervisor.sock

      的權限
  • [supervisord]:與 supervisord 有關的全局配置需要在這部分設定
    • logfile: 指向記錄 supervisord 程序的 log 檔案
    • pidfile:pidfile 儲存子程序的路徑
    • childlogdir:子程序 log 目錄設為

      AUTO

      的 log 目錄
  • [supervisorctl]:
    • serverurl:進入 supervisord 的URL, 對于 UNIX domain sockets, 應設為

      unix:///absolute/path/to/file.sock

  • [include]:如果配置檔案包含該部分,則該部分必須包含一個 files 鍵
    • files:包含一個或多個檔案,這裡包含了

      /etc/supervisor/conf.d/

      目錄下所有的

      .conf

      檔案,可以在該目錄下增加我們自己的配置檔案,在該配置檔案中增加

      [program:xx]

      部分,用來運作我們自己的程式,如下:
      • [program:xx]:配置檔案必須包括至少一個 program,xx 是 program 名稱,必須寫上,不能為空
      • command:包含一個指令,當這個 program 啟動時執行
      • directory:執行子程序時 supervisord 暫時切換到該目錄
      • user:賬戶名
      • startsecs:程序從

        STARING

        狀态轉換到

        RUNNING

        狀态 program 所需要保持運作的時間(機關:秒)
      • redirect_stderr:如果是

        true

        ,則程序的 stderr 輸出被發送回其 stdout 檔案描述符上的 supervisord
      • stdout_logfile:将程序 stdout 輸出到指定檔案
      • stdout_logfile_maxbytes:stdout_logfile 指定日志檔案最大位元組數,預設為50MB,可以加KB、MB或GB等機關
      • stdout_logfile_backups:要儲存的 stdout_logfile 備份的數量

3.2 用例

# testapp.sh
#! /bin/bash
if test -e $HOME/supervisor
then 
	echo "The $HOME/supervisor is exist!"
else
	mkdir $HOME/supervisor
	echo "Directory created successfully!"
	ls -ld $HOME/supervisor
fi

cd $HOME/supervisor
suffix=".txt"
i=0
while true
do
	#filename = `date +'%Y-%m-%d %H:%M:%S'`	# +與後面内容中間無空格
	filename=`date +'%Y%m%d%H%M%S'`
	
	fileCnt=`ls -l *.tar.gz | wc -l` #統計目前檔案夾下的檔案數量
	echo "`pwd` 目前備份檔案數: $fileCnt"
	if test $fileCnt -gt 10
	then 
		gzlist=`ls *.tar.gz`
		rm -fr $gzlist
	fi

	if test $(($i % 3)) -eq 0
	then 
		filelist=`ls *.txt`
		echo $filelist
		tar -zcf $filename."tar.gz" $filelist
		rm -fr $filelist
	fi
	
	if test -e $filename
	then 
		echo "The $filename is exist!"
	else
		#touch $filename$suffix
		#解決let問題: sudo ln -sf /bin/bash /bin/sh
		let i+=1 # or ((i++))
		echo `date` > $filename$suffix
		echo "The file $filename$suffix created successfully!"
		#ls -ld $HOME/supervisor
	fi
	sleep 2
done
           

配置檔案:/etc/supervisor/conf.d/testapp.conf

;根據主配置檔案确定檔案字尾,/etc/supervisor/supervisord.conf  /etc/supervisord.conf
;/etc/supervisor/conf.d/testapp.conf
;/etc/supervisor/conf.d/testapp.ini

[program:testapp]	; 程式名稱,在 supervisorctl 中通過這個值來對程式進行一系列的操作
command     = sh $HOME/supervisor/example.sh	; 啟動指令,與手動在指令行啟動的指令是一樣的
directory   = $HOME/supervisor/				; 程式的啟動目錄
;user        = kali		; 用哪個使用者啟動程序,預設是root
;password    = 1
;autostart  = true      ; 在supervisord啟動的時候也自動啟動
autorestart = true 		; 程式異常退出後自動重新開機
startsecs   = 2	    	; 啟動2秒後沒有異常退出,就表示程序正常啟動了,預設為1秒
;startretries=3       	; 啟動失敗自動重試次數,預設是3
;priority = 999         ; 程序啟動優先級,預設999,值小的優先啟動

;日志
redirect_stderr         	  = true 	; 把 stderr 重定向到 stdout,預設 false
stdout_logfile_maxbytlogstash = 50MB	; stdout 日志檔案大小,預設 50MB
stdout_logfile_backups  	  = 10		; stdout 日志檔案備份數
; stdout 日志檔案,需要注意當指定目錄不存在時無法正常啟動,是以需要手動建立目錄(supervisord 會自動建立日志檔案)
stdout_logfile                = /var/log/supervisor/testapp.log

;程序處理
stopasgroup = false     ;預設為false,程序被殺死時,是否向這個程序組發送stop信号,包括子程序
killasgroup = false     ;預設為false,程序組發送kill信号,包括子程序
           

啟動服務和程式

# 啟動 supervisor
supervisord -c /etc/supervisor/supervisord.conf
# 啟動 testapp
supervisorctl start testapp
# 檢視所有程序狀态
supervisorctl status testapp
# 關閉程序
supervisorctl stop testapp
           
supervisor 使用詳解一、介紹及安裝配置二、常用指令三、配置檔案說明四、常見問題

日志檢視

supervisor 使用詳解一、介紹及安裝配置二、常用指令三、配置檔案說明四、常見問題

四、常見問題

4.1 unix:///var/run/supervisor.sock no such file

問題描述:安裝好supervisor沒有開啟服務直接使用supervisorctl報的錯

解決辦法:

  1. 導入配置檔案:
# 若配置過程中出現錯誤或搞不定,想重新來,重新執行該指令即可
echo_supervisord_conf > /etc/supervisord.conf
           
  1. 啟動服務
supervisord -c /etc/supervisord.conf
# supervisord -c /etc/supervisor/supervisord.conf
           

4.2 啟動了多個supervisord服務,導緻無法正常關閉服務

問題描述:在運作

supervisord -c /etc/supervisord.conf

之前,運作過

supervisord -c /etc/supervisord.d/xx.conf

導緻有些程序被多個 superviord 管理,無法正常關閉程序。

解決辦法:使用

ps -fe | grep supervisord

檢視所有啟動過的supervisord服務,kill 相關的程序。