Asf PHP擴展框架之預警模塊介紹

1、什麼是預警？

預警能夠理解成咱們平常生活中的體檢，每一個人無論是富貴，仍是貧窮，有一個健康的身體纔是事業和生活的基礎。

項目的健康咱們形象比喻成「1」，項目的N多子功能/子模塊，好比登陸模塊、註冊模塊等都是「1」後面的「0」，若是項目都出問題了（好比 Http Status Code 502, 頁面或者接口響應慢），至關於前面的「1」已經不存在了，即便後面再多的「0」也沒有任何意義。

2、預警能起到什麼做用？

從醫學的名詞來表述，包括了三個方面：

• 治未病
• 早發現，早治療
• 確診了，立刻治療

3、Asf 預警解決方案

關於 Asf 框架的入門教程，請看這裏 >>> Get Start
關於 Asf 框架支持的配置項及配置詳情，請看這裏 >>> Get Start

Asf PHP擴展框架已經內置了一套預警機制，預警範圍包括了兩個方面，每個方面又包括兩種不一樣的預警處理方法。

• PHP腳本執行異常預警

  Fatal Error	Warning	Notice	Strict	Deprecated	Unknown Error
  E_PARSE	E_WARNING	E_NOTICE	E_STRICT	E_DEPRECATED	E_OTHERS
  E_ERROR	E_USER_WARNING	E_USER_NOTICE	-	-	-
  E_CORE_ERROR	E_CORE_WARNING	-	-	-	-
  E_COMPILE_ERROR	E_COMPILE_WARNING	-	-	-	-
  E_USER_ERROR	E_RECOVERABLE_ERROR	-	-	-	-

• PHP腳本執行時間耗時預警 (非CLI模式下)

  配置項	類型	默認值 (秒)	含義
  asf.dispathcer.timeout.max_script_time	double	1.0	腳本超時預警
  asf.dispathcer.timeout.max_db_time	double	0.1	SQL超時預警
  asf.dispathcer.timeout.max_cache_time	double	0.1	NoSQL超時預警
  asf.dispathcer.timeout.max_curl_time	double	0.1	CURL超時預警

4、本地日誌記錄方案 Demo

本地日誌記錄方案，支持 Log Buffer，性能指標請看這裏 >>> Get Start

4.1 PHP腳本執行異常預警

日誌格式規範請參考這裏 >>> Get Start

[dongshuang@box3 /data/www/box3.cn/public]$ cat index.php
<?php
use Asf\Application as App;

$configs =  array(
    'asf' => array(
        'root_path' => dirname(__DIR__) . '/apps',
        'log_path' => '/data/logs', /* 日誌保存目錄，寫入權限 */
        'dispatcher' => [
            'log' => ['err' => 1] /* 開啓 */
        ] 
    )
);

$app = new App($configs);
$app->run();

4.1.1 /data/logs/Asf_Err_Log 樣本

[dongshuang@box3 /data/logs]$ tailf Asf_Err_Log
2019-02-22 16:01:11 Asia/Shanghai | NOTICE | 28984 | Notice: Undefined variable: b in /data/www/box3.cn/apps/Bootstrap.php on line 21
2019-02-22 16:01:11 Asia/Shanghai | WARNING | 31486 | Warning: include(test.php): failed to open stream: No such file or directory in /data/www/box3.cn/apps/Bootstrap.php on line 20
2019-02-22 16:02:24 Asia/Shanghai | ERROR | 4137 | Fatal Error: Asf\Application::run() No method listaaction in DeviceService in /data/www/box3.cn/public/index.php on line 23
Stack trace:
## settled_uri = /v1/device/lista
#0 /data/www/box3.cn/public/index.php(23): Asf\Application->run()
#1 {main}

4.2 PHP腳本執行時間耗時預警

[dongshuang@box3 /data/www/box3.cn/public]$ cat index.php
<?php
use Asf\Application as App;

$configs =  array(
    'asf' => array(
        'root_path' => dirname(__DIR__) . '/apps',
        'log_path' => '/data/logs', /* 日誌保存目錄，寫入權限 */
        'dispatcher' => [
            'log' => ['timeout' => 1] /* 開啓 */
        ] 
    )
);

$app = new App($configs);
$app->run();

4.2.1 /data/logs/Asf_Timeout_Log 樣本

[dongshuang@box3 /data/logs]$ tailf Asf_Timeout_Log
2019-02-25 09:06:48 UTC | INFO | 26026 | 127.0.0.1:6379 Redis::set(110) executing too slow 0.201406 sec
2019-02-25 09:06:48 UTC | INFO | 26026 | 127.0.0.1:6379 Redis::get(111) executing too slow 0.201349 sec
2019-02-25 09:06:48 UTC | INFO | 26026 | /index/redis executing too slow 1.008510 sec

5、函數回調（callable）方案 Demo

5.1 PHP腳本執行異常預警

[dongshuang@box3 /data/www/box3.cn/public]$ cat index.php
<?php
use Asf\Application as App;

function myErrorHandler($errno, $errstr, $errfile, $errline)
{
    var_dump($errno, $errstr, $errfile, $errline);
}

$configs =  array(
    'asf' => array(
        'root_path' => dirname(__DIR__) . '/apps',
    )
);

$app = new App($configs);
$app->setErrorHandler('myErrorHandler');
$app->run();

5.1.1 異常預警 - 結果樣本

int(999)
string(33) "Fatal Error: Class 'ck' not found"
string(53) "/data/www/box3.cn/apps/api/services/Index.php"
int(42)

5.2 PHP腳本執行時間耗時預警

[dongshuang@box3 /data/www/box3.cn/public]$ cat index.php
<?php
use Asf\Application as App;

function myTimeoutHandler($errno, $errstr)
{
    var_dump($errno, $errstr);          
}

$configs =  array(
    'asf' => array(
        'root_path' => dirname(__DIR__) . '/apps',
    )
);

$app = new App($configs);
$app->setTimeoutHandler('myTimeoutHandler');
$app->run();

5.2.1 耗時預警 - 結果樣本

int(976)
string(44) "/index/redis executing too slow 0.508643 sec"

6、Asf 預警錯誤號區間段說明

6.1 《異常預警》錯誤號區間段 990 ~ 999

• errno = 999, 表示含義: Fatal Error （框架會對異常信息進行有效攔截, 防止服務端信息泄露）
• errno = 998, 表示含義: Warning
• errno = 997, 表示含義: Notice
• errno = 996, 表示含義: Strict
• errno = 995, 表示含義: Deprecated
• errno = 994, 表示含義: Unkown Error

6.2 《超時預警》錯誤號區間段 970 ~ 989

• errno = 970, 表示含義: MySQL 單條SQL執行時間超過預設閥值
• errno = 971, 表示含義: Redis 單條NoSQL執行時間超過預設閥值
• errno = 972, 表示含義: Memcached 單條NoSQL執行時間超過預設閥值
• errno = 973, 表示含義: PgSQL 單條SQL執行時間超過預設閥值
• errno = 974, 表示含義: SQLite 單條SQL執行時間超過預設閥值
• errno = 975, 表示含義: CURL 請求時間超過預設閥值
• errno = 976, 表示含義: 腳本完整生命週期請求時間超過預設閥值
• 持續開放更多的功能

7、結束語

感謝你們的閱讀，但願能給你們帶來幫助，若是使用中有疑問請聯繫咱們，固然了咱們也能夠聊點更好玩的 ^_^