目录

• 错误日志运行时配置php.ini
• 错误相关函数
• 错误日志记录优先级总结

错误日志运行时配置php.ini

PHP: 运行时配置 - 错误日志 - Manual

• error_reporting integer

  设置错误报告的级别。也就是什么级别的错误才会报告。

  在 PHP5.3 及以上版本中，默认值为 E_ALL & ~E_NOTICE & ~E_STRICT & ~E_DEPRECATED。

  开发阶段，我们建议启用E_NOTICE。

• display_errors string

  该选项设置是否将错误信息作为输出的一部分显示到屏幕，或者对用户隐藏而不显示。

  ; Possible Values:
  ;   Off = Do not display any errors
  ;   stderr = Display errors to STDERR (affects only CGI/CLI binaries!)
  ;   On or stdout = Display errors to STDOUT
  

  建议：永远不在生产环境启用，这是一个辅助开发功能。

• display_startup_errors boolean

  设置PHP 启动过程中的错误信息是否显示，display_errors并不会控制php启动过程中的错误信息是否显示。

• log_errors boolean

  设置是否将脚本运行的错误信息记录到服务器错误日志或者error_log之中。

  建议：前面我们建议，永远不要在生产环境使用display_errors，这里我们建议生产环境中使用错误日志记录脚本运行的错误信息。

• ignore_repeated_errors boolean

  不记录重复的信息。重复的错误必须出现在同一个文件中的同一行代码上，除非 ignore_repeated_source 设置为true。

• error_log string

  设置脚本错误将被记录到的文件。该文件必须是web服务器用户可写的。

  如果设置为 syslog，则将错误信息发送到系统日志记录器。在Unix以及类似系统上，使用的是 syslog(3) ，而在 Windows NT 类系统上则为事件日志。

  ; Example:
  ;error_log = php_errors.log
  ; Log errors to syslog (Event Log on Windows).
  ;error_log = syslog
  
  

  建议：生产环境中，把脚本错误信息记录到指定的错误日志文件中。

• syslog.ident string

  设置每条日志消息前缀的识别字符串（ident string），仅在 error_log 为 “syslog” 时有效。

错误相关函数

• error_reporting

  设置应该报告何种 PHP 错误。注意：面向的错误是php内部错误，而不是用户自定义错误，比如用户trigger_error自触发的错误。

  //关闭php的系统错误报告。
  error_reporting(0);
  // 除了 E_NOTICE，报告其他所有错误
  error_reporting(E_ALL ^ E_NOTICE);
  

• error_log

  发送错误信息到某个地方。

  error_log( string $message[, int $message_type = 0[, string $destination[, string $extra_headers]]] ) : bool
  

  参数：

  • message：应该被记录的错误信息。

  • message_type：设置错误应该发送到何处。可能的信息类型有以下几个：

    0 message 发送到 PHP 的系统日志，使用操作系统的日志机制或者一个文件，取决于 error_log 指令设置了什么。这是个默认的选项。
    1 message 发送到参数 destination 设置的邮件地址。第四个参数 extra_headers 只有在这个类型里才会被用到。
    2 不再是一个选项。
    3 message 被发送到位置为 destination 的文件里。字符 message 不会默认被当做新的一行。
    4 message 直接发送到 SAPI 的日志处理程序中。

  • destination：目标。它的含义描述于以上，由 message_type 参数所决定。

  • extra_headers：额外的头。当 message_type 设置为 1 的时候使用。该信息类型使用了 mail() 的同一个内置函数。

  注意：message 不能包含 null 字符，null字符可能会截断message。注意，message 可能会发送到文件、邮件、syslog 等。所以在调用 error_log() 前需要使用适合的转换/转义函数： base64_encode()、 rawurlencode() 或 addslashes()。

  // 如果无法连接到数据库，写如error_log指令配置的日志文件
  if (!Ora_Logon($username, $password)) {
      error_log("Oracle database not available!");
      //error_log("Oracle database not available!", 0);
  }
  // 写入指定日志文件
  error_log("there is a error.", 3, "/var/tmp/php.error.log");
  

• error_get_last array

  获取关于最后一个发生的错误的信息。

• set_error_handler

  设置用户的函数 (error_handler) 来处理脚本中出现的错误。

  set_error_handler( callable $error_handler[, int $error_types = E_ALL | E_STRICT] ) : mixed
  

  参数：

  • $error_handler

    是一个回调函数名（注意：string），回调函数要求包含参数：错误级别errno、错误信息errstr、错误发生文件名errfile、错误发生行数errline

    function userErrorHandler($errno, $errmsg, $filename, $linenum){
        ...
    } 
    

  • $error_types

    这个参数很重要，用来控制哪些级别的错误信息需要通过回调函数$error_handler处理。

    注意：如果没有设置，则所有错误发生时都会调用回调函数$error_handler，不论是系统错误还是用户错误，也不论error_reporting如何设置。

    注意：如果设置为E_USER_ERROR，则除了E_USER_ERROR错误会触发用户自定错误处理回调函数外，其他错误信息则是走error_reporting设置的错误日志记录方式。

• trigger_error

  产生一个用户级别的 error/warning/notice 信息。

  trigger_error( string $error_msg[, int $error_type = E_USER_NOTICE] ) : bool
  

  参数：

  • error_msg

    该 error 的特定错误信息，长度限制在了 1024 个字节。超过 1024 字节的字符都会被截断。

  • error_type

    用于定义这个自定义错误类型，但仅 E_USER 系列常量对其有效，默认是 E_USER_NOTICE。

• set_exception_handler

  设置用户自定义的异常处理函数 。

  自 PHP 7 以来，大多数错误抛出 Error 异常，也能被捕获。 Error 和 Exception 都实现了 Throwable 接口。 PHP 7 起，处理程序的签名：handler( Throwable $ex) : void

  自定义异常处理函数，相比较于自定义错误处理函数更简单，会默认接手所有异常处理。

  function exception_handler($throwable) {
      //var_dump($exception);
      echo "Uncaught Throwable: " , $throwable->getMessage(), "\n";
  }
  
  set_exception_handler('exception_handler');
    
  try {
      //echo 1/0; // 仅警告
      intdiv(1, 0);
      //echo $a%0;
  }catch(Exception $e){
      throw new \Exception("catch from Excetion.");
  } catch (\DivisionByZeroError $e) {
      throw new DivisionByZeroError("catch from DivisionByZeroError.");    
  } catch (\Error $e) {
      throw new \Error("catch from Error.");
  } finally {
      echo "run before exception_handler.\n";
  }
  

  输出：

  run before exception_handler.
  Uncaught exception: catch from DivisionByZeroError.
  

• restore_error_handler

• restore_exception_handler

  注意：两个restore函数，是恢复到上一次set_error_handler/set_exception_handler设置的自定义处理函数，而不是完全清除之前定义的所有自定义处理函数，不是恢复到系统默认处理错误函数或异常处理。

  function exception_handler_1(Exception $e){}
  function exception_handler_2(Exception $e){}
  set_exception_handler('exception_handler_1');
  set_exception_handler('exception_handler_2');
  
  restore_exception_handler();
  
  throw new Exception('这里抛出的异常将会被exception_handler_1函数捕获处理');
  

错误日志记录优先级总结

伪代码：

function logErrorByINI(){
    if(ini中开启了log_errors){
        if(ini中配置error_log){
            错误信息写入syslog、errlog指定日志文件;
        }
    }
}

if(存在set_error_handler函数，回调函数user_error_handler){
    if(未设置$error_type过滤错误类型){
        所有错误发生时调用用户自定义错误处理函数user_error_handler();
    }elseif(满足set_error_handler过滤错误类型){
        满足类型的错误发生时才调用用户自定义错误处理函数user_error_handler()，其他错误发生时走系统设置;
    }else{
        if(存在error_reporting函数){
            if(满足error_reporting函数定义的错误类型){
                logErrorByINI();
            }
        }else{
            if(ini中配置了error_reporting){
                if(满足error_reporting配置的错误类型){
                    logErrorByINI();                    
                }
            }
            
        }
    }
}
if(ini中配置display_errors){        
    if(fpm){
        if(php-fpm.www.conf开启php_flag[display_errors] = on){
            输出错误信息;
        }        
    }
    输出错误信息;
}

@tsingchan