用PHP構建簡易監視引擎

一. 更改工作目錄的問題

  當你編寫一個監視程序時,讓它設置自己的工作目錄通常更好些。這樣以來,如果你使用一個相對路徑讀寫文件,那麼,它會根據情況自動處理用戶期望存放文件的位置。總是限制程序中使用的路徑儘管是一種良好的實踐;但是,卻失去了應有的靈活性。因此,改變你的工作目錄的最安全的方法是,既使用chdir()也使用chroot()。

  chroot()可用於PHP的CLI 和CGI版本中,但是卻要求程序以根權限運行。chroot()實際上把當前進程的路徑從根目錄改變到指定的目錄。這使得當前進程只能執行存在於該目錄下的文件。經常情況下,chroot()由服務器作爲一個"安全設備"使用以確保惡意代碼不會修改一個特定的目錄之外的文件。請牢記,儘管chroot() 能夠阻止你訪問你的新目錄之外的任何文件,但是,任何當前打開的文件資源仍然能夠被存取。例如,下列代碼能夠打開一個日誌文件,調用chroot()並切換到一個數據目錄;然後,仍然能夠成功地登錄並進而打開文件資源:

<?PHP
$logfile = fopen("/var/log/chroot.log", "w");
chroot("/Users/george");
fputs($logfile, "Hello From Inside The Chroot/n");
?>

  如果一個應用程序不能使用chroot(),那麼你可以調用chdir()來設置工作目錄。例如,當代碼需要加載特定的代碼(這些代碼能夠在系統的任何地方被定位時),這是很有用的。注意,chdir()沒有提供安全機制來防止打開未授權的文件。

  二. 放棄特權

  當編寫Unix守護程序時,一種經典的安全預防措施是讓它們放棄所有不需要的特權;否則,擁有不需要的特權容易招致不必要的麻煩。在代碼(或PHP本身)中含有漏洞的情況下,通過確保一個守護程序以最小權限用戶身份運行,往往能夠使損失減到最小。

  一種實現此目的的方法是,以非特權用戶身份執行該守護程序。然而,如果程序需要在一開始就打開非特權用戶無權打開的資源(例如日誌文件,數據文件,套接字,等等)的話,這通常是不夠的。

  如果你以根用戶身份運行,那麼你能夠藉助於posix_setuid()和posiz_setgid()函數來放棄你的特權。下面的示例把當前運行程序的特權改變爲用戶nobody所擁有的那些權限:

$pw=posix_getpwnam('nobody');
posix_setuid($pw['uid']);
posix_setgid($pw['gid']);

  就象chroot()一樣,任何在放棄特權之前被打開的特權資源都會保持爲打開,但是不能創建新的資源。

  三. 保證排它性

  你可能經常想實現:一個腳本在任何時刻僅運行一個實例。爲了保護腳本,這是特別重要的,因爲在後臺運行容易導致偶然情況下調用多個實例。

  保證這種排它性的標準技術是,通過使用flock()來讓腳本鎖定一個特定的文件(經常是一個加鎖文件,並且被排它式使用)。如果鎖定失敗,該腳本應該輸出一個錯誤並退出。下面是一個示例:

$fp=fopen("/tmp/.lockfile","a");
if(!$fp || !flock($fp, LOCK_EX | LOCK_NB)) {
 fputs(STDERR, "Failed to acquire lock/n");
 exit;
}
/*成功鎖定以安全地執行工作*/


  注意,有關鎖機制的討論涉及較多內容,在此不多加解釋。

 四. 構建監視服務

  在這一節中,我們將使用PHP來編寫一個基本的監視引擎。因爲你不會事先知道怎樣改變,所以你應該使它的實現既靈活又具可能性。
該記錄程序應該能夠支持任意的服務檢查(例如,HTTP和FTP服務)並且能夠以任意方式(通過電子郵件,輸出到一個日誌文件,等等)記錄事件。你當然想讓它以一個守護程序方式運行;所以,你應該請求它輸出其完整的當前狀態。

  一個服務需要實現下列抽象類:

 

abstract class ServiceCheck {
 const FAILURE = 0;
 const SUCCESS = 1;
 protected $timeout = 30;
 protected $next_attempt;
 protected $current_status = ServiceCheck::SUCCESS;
 protected $previous_status = ServiceCheck::SUCCESS;
 protected $frequency = 30;
 protected $description;
 protected $consecutive_failures = 0;
 protected $status_time;
 protected $failure_time;
 protected $loggers = array();
 abstract public function __construct($params);
 public function __call($name, $args)
 {
  if(isset($this->$name)) {
   return $this->$name;
  }
 }
 public function set_next_attempt()
 {
  $this->next_attempt = time() + $this->frequency;
 }
 public abstract function run();
 public function post_run($status)
 {
  if($status !== $this->current_status) {
   $this->previous_status = $this->current_status;
  }
  if($status === self::FAILURE) {
   if( $this->current_status === self::FAILURE ) {
    $this->consecutive_failures++;
   }
   else {
    $this->failure_time = time();
   }
  }
  else {
   $this->consecutive_failures = 0;
  }
  $this->status_time = time();
  $this->current_status = $status;
  $this->log_service_event();
 }
 public function log_current_status()
 {
  foreach($this->loggers as $logger) {
   $logger->log_current_status($this);
  }
 }
 private function log_service_event()
 {
  foreach($this->loggers as $logger) {
   $logger->log_service_event($this);
  }
 }
 public function register_logger(ServiceLogger $logger)
 {
  $this->loggers[] = $logger;
 }
}

  上面的__call()重載方法提供對一個ServiceCheck對象的參數的只讀存取操作:

  · timeout-在引擎終止檢查之前,這一檢查能夠掛起多長時間。

  · next_attempt-下次嘗試連接到服務器的時間。

  · current_status-服務的當前狀態:SUCCESS或FAILURE。

  · previous_status-當前狀態之前的狀態。

  · frequency-每隔多長時間檢查一次服務。

  · description-服務描述。

  · consecutive_failures-自從上次成功以來,服務檢查連續失敗的次數。

  · status_time-服務被檢查的最後時間。

  · failure_time-如果狀態爲FAILED,則它代表發生失敗的時間。

  這個類還實現了觀察者模式,允許ServiceLogger類型的對象註冊自身,然後當調用log_current_status()或log_service_event()時調用它。

  這裏實現的關鍵函數是run(),它負責定義應該怎樣執行檢查。如果檢查成功,它應該返回SUCCESS;否則返回FAILURE。

  當定義在run()中的服務檢查返回後,post_run()方法被調用。它負責設置對象的狀態並實現記入日誌。

  ServiceLogger接口:指定一個日誌類僅需要實現兩個方法:log_service_event()和log_current_status(),它們分別在當一個run()檢查返回時和當實現一個普通狀態請求時被調用。

  該接口如下所示:

interface ServiceLogger {
 public function log_service_event(ServiceCheck$service);
 public function log_current_status(ServiceCheck$service);
}

  最後,你需要編寫引擎本身。該想法類似於在前一節編寫簡單程序時使用的思想:服務器應該創建一個新的進程來處理每一次檢查並使用一個SIGCHLD處理器來檢測當檢查完成時的返回值。可以同時檢查的最大數目應該是可配置的,從而可以防止對系統資源的過渡使用。所有的服務和日誌都將在一個XML文件中定義。

  下面是定義該引擎的ServiceCheckRunner類:

class ServiceCheckRunner {
 private $num_children;
 private $services = array();
 private $children = array();
 public function _ _construct($conf, $num_children)
 {
  $loggers = array();
  $this->num_children = $num_children;
  $conf = simpleXML_load_file($conf);
  foreach($conf->loggers->logger as $logger) {
   $class = new Reflection_Class("$logger->class");
   if($class->isInstantiable()) {
    $loggers["$logger->id"] = $class->newInstance();
   }
   else {
    fputs(STDERR, "{$logger->class} cannot be instantiated./n");
    exit;
   }
  }
  foreach($conf->services->service as $service) {
   $class = new Reflection_Class("$service->class");
   if($class->isInstantiable()) {
    $item = $class->newInstance($service->params);
    foreach($service->loggers->logger as $logger) {
     $item->register_logger($loggers["$logger"]);
    }
    $this->services[] = $item;
   }
   else {
    fputs(STDERR, "{$service->class} is not instantiable./n");
    exit;
   }
  }
 }
 private function next_attempt_sort($a, $b){
  if($a->next_attempt() == $b->next_attempt()) {
   return 0;
  }
  return ($a->next_attempt() < $b->next_attempt())? -1 : 1;
 }
 private function next(){
  usort($this->services,array($this,'next_attempt_sort'));
  return $this->services[0];
 }
 public function loop(){
  declare(ticks=1);
  pcntl_signal(SIGCHLD, array($this, "sig_child"));
  pcntl_signal(SIGUSR1, array($this, "sig_usr1"));
  while(1) {
   $now = time();
   if(count($this->children)< $this->num_children) {
    $service = $this->next();
    if($now < $service->next_attempt()) {
     sleep(1);
     continue;
    }
    $service->set_next_attempt();
    if($pid = pcntl_fork()) {
     $this->children[$pid] = $service;
    }
    else {
     pcntl_alarm($service->timeout());
     exit($service->run());
    }
   }
  }
 }
 public function log_current_status(){
  foreach($this->services as $service) {
   $service->log_current_status();
  }
 }
 private function sig_child($signal){
  $status = ServiceCheck::FAILURE;
  pcntl_signal(SIGCHLD, array($this, "sig_child"));
  while(($pid = pcntl_wait($status, WNOHANG)) > 0){
   $service = $this->children[$pid];
   unset($this->children[$pid]);
   if(pcntl_wifexited($status) && pcntl_wexitstatus($status) ==ServiceCheck::SUCCESS)
   {
    $status = ServiceCheck::SUCCESS;
   }
   $service->post_run($status);
  }
 }
 private function sig_usr1($signal){
  pcntl_signal(SIGUSR1, array($this, "sig_usr1"));
  $this->log_current_status();
 }
}

  這是一個很複雜的類。其構造器讀取並分析一個XML文件,創建所有的將被監視的服務,並創建記錄它們的日誌程序。

  loop()方法是該類中的主要方法。它設置請求的信號處理器並檢查是否能夠創建一個新的子進程。現在,如果下一個事件(以next_attempt時間CHUO排序)運行良好,那麼一個新的進程將被創建。在這個新的子進程內,發出一個警告以防止測試持續時間超出它的時限,然後執行由run()定義的測試。

  還存在兩個信號處理器:SIGCHLD處理器sig_child(),負責收集已終止的子進程並執行它們的服務的post_run()方法; SIGUSR1處理器sig_usr1(),簡單地調用所有已註冊的日誌程序的log_current_status()方法,這可以用於得到整個系統的當前狀態。

  當然,這個監視架構並不沒有做任何實際的事情。但是首先,你需要檢查一個服務。下列這個類檢查是否你從一個HTTP服務器取回一個"200 Server OK"響應:

class HTTP_ServiceCheck extends ServiceCheck{
 public $url;
 public function _ _construct($params){
  foreach($params as $k => $v) {
   $k = "$k";
   $this->$k = "$v";
  }
 }
 public function run(){
  if(is_resource(@fopen($this->url, "r"))) {
   return ServiceCheck::SUCCESS;
  }
  else {
   return ServiceCheck::FAILURE;
  }
 }
}

 

  與你以前構建的框架相比,這個服務極其簡單,在此恕不多描述。

 五. 示例ServiceLogger進程

  下面是一個示例ServiceLogger進程。當一個服務停用時,它負責把一個電子郵件發送給一個待命人員:

 

class EmailMe_ServiceLogger implements ServiceLogger {
 public function log_service_event(ServiceCheck$service)
 {
  if($service->current_status ==ServiceCheck::FAILURE) {
   $message = "Problem with{$service->description()}/r/n";
   mail('[email protected]', 'Service Event',$message);
   if($service->consecutive_failures() > 5) {
    mail('[email protected]', 'Service Event', $message);
   }
  }
 }
 public function log_current_status(ServiceCheck$service){
  return;
 }
}

  如果連續失敗五次,那麼該進程還把一個消息發送到一個備份地址。注意,它並沒有實現一個有意義的log_current_status()方法。

  無論何時象如下這樣改變一個服務的狀態,你都應該實現一個寫向PHP錯誤日誌的ServiceLogger進程:

class ErrorLog_ServiceLogger implements ServiceLogger {
 public function log_service_event(ServiceCheck$service)
 {
  if($service->current_status() !==$service->previous_status()) {
   if($service->current_status() ===ServiceCheck::FAILURE) {
    $status = 'DOWN';
   }
   else {
    $status = 'UP';
   }
   error_log("{$service->description()} changed status to $status");
  }
 }
 public function log_current_status(ServiceCheck$service)
 {
  error_log("{$service->description()}: $status");
 }
}

  該log_current_status()方法意味着,如果進程發送一個SIGUSR1信號,它將把其完整的當前狀態複製到你的PHP錯誤日誌中。
  
  該引擎使用如下的一個配置文件:

<config>
 <loggers>
  <logger>
   <id>errorlog</id>
   <class>ErrorLog_ServiceLogger</class>
  </logger>
  <logger>
   <id>emailme</id>
   <class>EmailMe_ServiceLogger</class>
  </logger>
 </loggers>
 <services>
  <service>
   <class>HTTP_ServiceCheck</class>
   <params>
    <description>OmniTI HTTP Check</description>
    <url>http://www.omniti.com/</url>
    <timeout>30</timeout>
    <frequency>900</frequency>
   </params>
   <loggers>
    <logger>errorlog</logger>
    <logger>emailme</logger>
   </loggers>
  </service>
 <service>
 <class>HTTP_ServiceCheck</class>
 <params>
  <description>Home Page HTTP Check</description>
  <url>http://www.schlossnagle.org/~george</url>
  <timeout>30</timeout>
  <frequency>3600</frequency>
 </params>
 <loggers>
  <logger>errorlog</logger>
 </loggers>
</service>
</services>
</config>

  當傳遞這個XML文件時,ServiceCheckRunner的構造器對於每一個指定的日誌實例化一個日誌記錄程序。然後,它相應於每一個指定的服務實例化一個ServiceCheck對象。

  注意 該構造器使用Reflection_Class類來實現該服務和日誌類的內在檢查-在你試圖實例化它們之前。儘管這是不必要的,但是它很好地演示了PHP 5中新的反射(Reflection)API的使用。除了這些類以外,反射API還提供一些類來實現對PHP中幾乎任何內部實體(類,方法或函數)的內在檢查。

  爲了使用你構建的引擎,你仍然需要一些包裝代碼。監視程序應該會禁止你試圖兩次啓動它-你不需要對每一個事件建立兩份消息。當然,該監視程序還應該接收包括下列選項在內的一些選項:

選項 描述
[-f] 引擎的配置文件的一個位置,默認是monitor.XML。
[-n]  引擎允許的子進程池的大小,默認是5。
[-d]  一個停用該引擎的守護功能的標誌。在你編寫一個把信息輸出到stdout或stderr的調試ServiceLogger進程時,這是很有用的。

  下面是最終的監視程序腳本,它分析選項,保證排它性並且運行服務檢查:

require_once "Service.inc";
require_once "Console/Getopt.PHP";
$shortoptions = "n:f:d";
$default_opts = array('n' => 5, 'f' =>'monitor.XML');
$args = getOptions($default_opts, $shortoptions,null);
$fp = fopen("/tmp/.lockfile", "a");
if(!$fp || !flock($fp, LOCK_EX | LOCK_NB)) {
 fputs($stderr, "Failed to acquire lock/n");
 exit;
}
if(!$args['d']) {
 if(pcntl_fork()) {
  exit;
 }
 posix_setsid();
 if(pcntl_fork()) {
  exit;
 }
}
fwrite($fp, getmypid());
fflush($fp);
$engine = new ServiceCheckRunner($args['f'],$args['n']);
$engine->loop();

  注意,這個示例使用了定製的getOptions()函數。

  在編寫一個適當的配置文件後,你可以按如下方式啓動該腳本:

  > ./monitor.PHP -f /etc/monitor.XML

  這可以保護並繼續監視直到機器被關掉或該腳本被殺死。

  這個腳本相當複雜,但是仍然存在一些容易改進的地方,這些只好留給讀者作爲練習之用:

  · 添加一個重新分析配置文件的SIGHUP處理器以便你能夠在不啓動服務器的情況下改變配置。

  · 編寫一個能夠登錄到一個數據庫的ServiceLogger以用於存儲查詢數據。

  · 編寫一個Web前端程序以爲整個監視系統提供一種良好的GUI

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章