<p> 摘要:在本文中,让我们共同探讨基于PHP语言构建一个基本的服务器端监视引擎的诸多技巧及注意事项,并给出完整的源码实现。</p><p> 一. 更改工作目录的问题</p><p> 当你编写一个监视程序时,让它设置自己的工作目录通常更好些。这样以来,如果你使用一个相对路径读写文件,那么,它会根据情况自动处理用户期望存放文件的位置。总是限制程序中使用的路径尽管是一种良好的实践;但是,却失去了应有的灵活性。因此,改变你的工作目录的最安全的方法是,既使用chdir()也使用chroot()。</p><p> chroot()可用于PHP的CLI和CGI版本中,但是却要求程序以根权限运行。chroot()实际上把当前进程的路径从根目录改变到指定的目录。这使得当前进程只能执行存在于该目录下的文件。经常情况下,chroot()由服务器作为一个"安全设备"使用以确保恶意代码不会修改一个特定的目录之外的文件。请牢记,尽管chroot()能够阻止你访问你的新目录之外的任何文件,但是,任何当前打开的文件资源仍然能够被存取。例如,下列代码能够打开一个日志文件,调用chroot()并切换到一个数据目录;然后,仍然能够成功地登录并进而打开文件资源:</p><code><?php<br />$logfile = fopen("/var/log/chroot.log", "w");<br />chroot("/Users/george");<br />fputs($logfile, "Hello From Inside The Chroot<br />");<br />?></code></p><p> 如果一个应用程序不能使用chroot(),那么你可以调用chdir()来设置工作目录。例如,当代码需要加载特定的代码(这些代码能够在系统的任何地方被定位时),这是很有用的。注意,chdir()没有提供安全机制来防止打开未授权的文件。</p><p> 二. 放弃特权</p><p> 当编写Unix守护程序时,一种经典的安全预防措施是让它们放弃所有不需要的特权;否则,拥有不需要的特权容易招致不必要的麻烦。在代码(或PHP本身)中含有漏洞的情况下,通过确保一个守护程序以最小权限用户身份运行,往往能够使损失减到最小。</p><p> 一种实现此目的的方法是,以非特权用户身份执行该守护程序。然而,如果程序需要在一开始就打开非特权用户无权打开的资源(例如日志文件,数据文件,套接字,等等)的话,这通常是不够的。</p><p> 如果你以根用户身份运行,那么你能够借助于posix_setuid()和posiz_setgid()函数来放弃你的特权。下面的示例把当前运行程序的特权改变为用户nobody所拥有的那些权限:</p><code>$pw=posix_getpwnam('nobody');<br />posix_setuid($pw['uid']);<br />posix_setgid($pw['gid']);</code></p><p> 就象chroot()一样,任何在放弃特权之前被打开的特权资源都会保持为打开,但是不能创建新的资源。</p><p> 三. 保证排它性</p><p> 你可能经常想实现:一个脚本在任何时刻仅运行一个实例。为了保护脚本,这是特别重要的,因为在后台运行容易导致偶然情况下调用多个实例。</p><p> 保证这种排它性的标准技术是,通过使用flock()来让脚本锁定一个特定的文件(经常是一个加锁文件,并且被排它式使用)。如果锁定失败,该脚本应该输出一个错误并退出。下面是一个示例:</p><code>$fp=fopen("/tmp/.lockfile","a");<br />if(!$fp || !flock($fp, LOCK_EX | LOCK_NB)) {<br /> fputs(STDERR, "Failed to acquire lock<br />");<br /> exit;<br />}<br />/*成功锁定以安全地执行工作*/</code><p> 注意,有关锁机制的讨论涉及较多内容,在此不多加解释。</p><p> 四. 构建监视服务</p><p> 在这一节中,我们将使用PHP来编写一个基本的监视引擎。因为你不会事先知道怎样改变,所以你应该使它的实现既灵活又具可能性。</p><p> 该记录程序应该能够支持任意的服务检查(例如,HTTP和FTP服务)并且能够以任意方式(通过电子邮件,输出到一个日志文件,等等)记录事件。你当然想让它以一个守护程序方式运行;所以,你应该请求它输出其完整的当前状态。</p><p> 一个服务需要实现下列抽象类:</p><code>abstract class ServiceCheck {<br /> const FAILURE = 0;<br /> const SUCCESS = 1;<br /> protected $timeout = 30;<br /> protected $next_attempt;<br /> protected $current_status = ServiceCheck::SUCCESS;<br /> protected $previous_status = ServiceCheck::SUCCESS;<br /> protected $frequency = 30;<br /> protected $description;<br /> protected $consecutive_failures = 0;<br /> protected $status_time;<br /> protected $failure_time;<br /> protected $loggers = array();<br /> abstract public function __construct($params);<br /> public function __call($name, $args)<br /> {<br />if(isset($this->$name)) {<br /> return $this->$name;<br />}<br /> }<br /> public function set_next_attempt()<br /> {<br />$this->next_attempt = time() + $this->frequency;<br /> }<br /> public abstract function run();<br /> public function post_run($status)<br /> {<br />if($status !== $this->current_status) {<br /> $this->previous_status = $this->current_status;<br />}<br />if($status === self::FAILURE) {<br /> if( $this->current_status === self::FAILURE ) {<br />$this->consecutive_failures++;<br /> }<br /> else {<br />$this->failure_time = time();<br /> }<br />}<br />else {<br /> $this->consecutive_failures = 0;<br />}<br />$this->status_time = time();<br />$this->current_status = $status;<br />$this->log_service_event();<br /> }<br /> public function log_current_status()<br /> {<br />foreach($this->loggers as $logger) {<br /> $logger->log_current_status($this);<br />}<br /> }<br /> private function log_service_event()<br /> {<br />foreach($this->loggers as $logger) {<br /> $logger->log_service_event($this);<br />}<br /> }<br /> public function register_logger(ServiceLogger $logger)<br /> {<br />$this->loggers[] = $logger;<br /> }<br />}</code></p><p> 上面的__call()重载方法提供对一个ServiceCheck对象的参数的只读存取操作:</p><p> ・ timeout-在引擎终止检查之前,这一检查能够挂起多长时间。</p><p> ・ next_attempt-下次尝试连接到服务器的时间。</p><p> ・ current_status-服务的当前状态:SUCCESS或FAILURE。</p><p> ・ previous_status-当前状态之前的状态。</p><p> ・ frequency-每隔多长时间检查一次服务。</p><p> ・ description-服务描述。</p><p> ・ consecutive_failures-自从上次成功以来,服务检查连续失败的次数。</p><p> ・ status_time-服务被检查的最后时间。</p><p> ・ failure_time-如果状态为FAILED,则它代表发生失败的时间。</p><p> 这个类还实现了观察者模式,允许ServiceLogger类型的对象注册自身,然后当调用log_current_status()或log_service_event()时调用它。</p><p> 这里实现的关键函数是run(),它负责定义应该怎样执行检查。如果检查成功,它应该返回SUCCESS;否则返回FAILURE。</p><p> 当定义在run()中的服务检查返回后,post_run()方法被调用。它负责设置对象的状态并实现记入日志。</p><p> ServiceLogger接口:指定一个日志类仅需要实现两个方法:log_service_event()和log_current_status(),它们分别在当一个run()检查返回时和当实现一个普通状态请求时被调用。</p><p> 该接口如下所示:</p><code>interface ServiceLogger {<br /> public function log_service_event(ServiceCheck$service);<br /> public function log_current_status(ServiceCheck$service);<br />}</code></p><p> 最后,你需要编写引擎本身。该想法类似于在前一节编写简单程序时使用的思想:服务器应该创建一个新的进程来处理每一次检查并使用一个SIGCHLD处理器来检测当检查完成时的返回值。可以同时检查的最大数目应该是可配置的,从而可以防止对系统资源的过渡使用。所有的服务和日志都将在一个XML文件中定义。</p><p> 下面是定义该引擎的ServiceCheckRunner类:</p><code>class ServiceCheckRunner {<br /> private $num_children;<br /> private $services = array();<br /> private $children = array();<br /> public function _ _construct($conf, $num_children)<br /> {<br />$loggers = array();<br />$this->num_children = $num_children;<br />$conf = simplexml_load_file($conf);<br />foreach($conf->loggers->logger as $logger) {<br /> $class = new Reflection_Class("$logger->class");<br /> if($class->isInstantiable()) {<br />$loggers["$logger->id"] = $class->newInstance();<br /> }<br /> else {<br />fputs(STDERR, "{$logger->class} cannot be instantiated.<br />");<br />exit;<br /> }<br />}<br />foreach($conf->services->service as $service) {<br /> $class = new Reflection_Class("$service->class");<br /> if($class->isInstantiable()) {<br />$item = $class->newInstance($service->params);<br />foreach($service->loggers->logger as $logger) {<br /> $item->register_logger($loggers["$logger"]);<br />}<br />$this->services[] = $item;<br /> }<br /> else {<br />fputs(STDERR, "{$service->class} is not instantiable.<br />");<br />exit;<br /> }<br />}<br /> }<br /> private function next_attempt_sort($a, $b){<br />if($a->next_attempt() == $b->next_attempt()) {<br /> return 0;<br />}<br />return ($a->next_attempt() < $b->next_attempt())? -1 : 1;<br /> }<br /> private function next(){<br />usort($this->services,array($this,'next_attempt_sort'));<br />return $this->services[0];<br /> }<br /> public function loop(){<br />declare(ticks=1);<br />pcntl_signal(SIGCHLD, array($this, "sig_child"));<br />pcntl_signal(SIGUSR1, array($this, "sig_usr1"));<br />while(1) {<br /> $now = time();<br /> if(count($this->children)< $this->num_children) {<br />$service = $this->next();<br />if($now < $service->next_attempt()) {<br /> sleep(1);<br /> continue;<br />}<br />$service->set_next_attempt();<br />if($pid = pcntl_fork()) {<br /> $this->children[$pid] = $service;<br />}<br />else {<br /> pcntl_alarm($service->timeout());<br /> exit($service->run());<br />}<br /> }<br />}<br /> }<br /> public function log_current_status(){<br />foreach($this->services as $service) {<br /> $service->log_current_status();<br />}<br /> }<br /> private function sig_child($signal){<br />$status = ServiceCheck::FAILURE;<br />pcntl_signal(SIGCHLD, array($this, "sig_child"));<br />while(($pid = pcntl_wait($status, WNOHANG)) > 0){<br /> $service = $this->children[$pid];<br /> unset($this->children[$pid]);<br /> if(pcntl_wifexited($status) && pcntl_wexitstatus($status) ==ServiceCheck::SUCCESS)<br /> {<br />$status = ServiceCheck::SUCCESS;<br /> }<br /> $service->post_run($status);<br />}<br /> }<br /> private function sig_usr1($signal){<br />pcntl_signal(SIGUSR1, array($this, "sig_usr1"));<br />$this->log_current_status();<br /> }<br />}</code></p><p> 这是一个很复杂的类。其构造器读取并分析一个XML文件,创建所有的将被监视的服务,并创建记录它们的日志程序。</p><p> loop()方法是该类中的主要方法。它设置请求的信号处理器并检查是否能够创建一个新的子进程。现在,如果下一个事件(以next_attempt时间CHUO排序)运行良好,那么一个新的进程将被创建。在这个新的子进程内,发出一个警告以防止测试持续时间超出它的时限,然后执行由run()定义的测试。</p><p> 还存在两个信号处理器:SIGCHLD处理器sig_child(),负责收集已终止的子进程并执行它们的服务的post_run()方法;SIGUSR1处理器sig_usr1(),简单地调用所有已注册的日志程序的log_current_status()方法,这可以用于得到整个系统的当前状态。</p><p> 当然,这个监视架构并不没有做任何实际的事情。但是首先,你需要检查一个服务。下列这个类检查是否你从一个HTTP服务器取回一个"200 Server OK"响应:</p><code>class HTTP_ServiceCheck extends ServiceCheck{<br /> public $url;<br /> public function _ _construct($params){<br />foreach($params as $k => $v) {<br /> $k = "$k";<br /> $this->$k = "$v";<br />}<br /> }<br /> public function run(){<br />if(is_resource(@fopen($this->url, "r"))) {<br /> return ServiceCheck::SUCCESS;<br />}<br />else {<br /> return ServiceCheck::FAILURE;<br />}<br /> }<br />}</code></p><p> 与你以前构建的框架相比,这个服务极其简单,在此恕不多描述。</p><p> 五. 示例ServiceLogger进程</p><p> 下面是一个示例ServiceLogger进程。当一个服务停用时,它负责把一个电子邮件发送给一个待命人员:</p><code>class EmailMe_ServiceLogger implements ServiceLogger {<br /> public function log_service_event(ServiceCheck$service)<br /> {<br />if($service->current_status ==ServiceCheck::FAILURE) {<br /> $message = "Problem with{$service->description()}<br />";<br /> mail('oncall@example.com', 'Service Event',$message);<br /> if($service->consecutive_failures() > 5) {<br />mail('oncall_backup@example.com', 'Service Event', $message);<br /> }<br />}<br /> }<br /> public function log_current_status(ServiceCheck$service){<br />return;<br /> }<br />}</code></p><p> 如果连续失败五次,那么该进程还把一个消息发送到一个备份地址。注意,它并没有实现一个有意义的log_current_status()方法。</p><p> 无论何时象如下这样改变一个服务的状态,你都应该实现一个写向PHP错误日志的ServiceLogger进程:</p><code>class ErrorLog_ServiceLogger implements ServiceLogger {<br /> public function log_service_event(ServiceCheck$service)<br /> {<br />if($service->current_status() !==$service->previous_status()) {<br /> if($service->current_status() ===ServiceCheck::FAILURE) {<br />$status = 'DOWN';<br /> }<br /> else {<br />$status = 'UP';<br /> }<br /> error_log("{$service->description()} changed status to $status");<br />}<br /> }<br /> public function log_current_status(ServiceCheck$service)<br /> {<br />error_log("{$service->description()}: $status");<br /> }<br />}</code></p><p> 该log_current_status()方法意味着,如果进程发送一个SIGUSR1信号,它将把其完整的当前状态复制到你的PHP错误日志中。</p><p> 该引擎使用如下的一个配置文件:</p><code><config><br /> <loggers><br /><logger><br /> <id>errorlog</id><br /> <class>ErrorLog_ServiceLogger</class><br /></logger><br /><logger><br /> <id>emailme</id><br /> <class>EmailMe_ServiceLogger</class><br /></logger><br /> </loggers><br /> <services><br /><service><br /> <class>HTTP_ServiceCheck</class><br /> <params><br /><description>OmniTI HTTP Check</description><br /><url>http://www.omniti.com</url><br /><timeout>30</timeout><br /><frequency>900</frequency><br /> </params><br /> <loggers><br /><logger>errorlog</logger><br /><logger>emailme</logger><br /> </loggers><br /></service><br /> <service><br /> <class>HTTP_ServiceCheck</class><br /> <params><br /><description>Home Page HTTP Check</description><br /><url>http://www.schlossnagle.org/~george</url><br /><timeout>30</timeout><br /><frequency>3600</frequency><br /> </params><br /> <loggers><br /><logger>errorlog</logger><br /> </loggers><br /></service><br /></services><br /></config></code></p><p> 当传递这个XML文件时,ServiceCheckRunner的构造器对于每一个指定的日志实例化一个日志记录程序。然后,它相应于每一个指定的服务实例化一个ServiceCheck对象。</p><p> 注意 该构造器使用Reflection_Class类来实现该服务和日志类的内在检查-在你试图实例化它们之前。尽管这是不必要的,但是它很好地演示了PHP 5中新的反射(Reflection)API的使用。除了这些类以外,反射API还提供一些类来实现对PHP中几乎任何内部实体(类,方法或函数)的内在检查。</p><p> 为了使用你构建的引擎,你仍然需要一些包装代码。监视程序应该会禁止你试图两次启动它-你不需要对每一个事件建立两份消息。当然,该监视程序还应该接收包括下列选项在内的一些选项:</p><table>
下面是最终的监视程序脚本,它分析选项,保证排它性并且运行服务检查:
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
");
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。