title: Tracker meta:

  • name: description content: Easyswoole provides a basic tracking component that allows users to implement basic server status monitoring and call chain logging.
  • name: keywords content: swoole|swoole extension|swoole framework|easyswoole|Tracker

Tracker

Easyswoole provides a basic tracking component that allows users to implement basic server status monitoring and call chain logging.

Installation

  1. composer require easyswoole/tracker

Call chain

Easyswoole’s call chain tracking is implemented by deconstruction of a similar ordered tree list, deconstructed as follows:

  1. struct Point{
  2.     struct Point* nextPoint;
  3.     struct Point[] subPoints;
  4.     const END_SUCCESS = 'success';
  5.     const END_FAIL = 'fail';
  6.     const END_UNKNOWN = 'unknown';
  7.     int startTime;
  8.     mixed startArg;
  9.     int endTime;
  10.     string pointName;
  11.     string endStatus = self::END_UNKNOWN;
  12.     mixed endArg;
  13.     string pointId;
  14.     string parentId;
  15.     int depth = 0;
  16.     bool isNext
  17. }

Sample code

  2. use EasySwoole\Tracker\Point;
  3. use EasySwoole\Component\WaitGroup;
  4. use EasySwoole\Tracker\PointContext;
  5. /*
  6.  * Suppose our call chain is like this
  7.  * onRequest  ->> actionOne ->> actionOne call remote Api(1,2)  ->>  afterAction
  8.  */
  10. go(function (){
  11.     /*
  12.      * Create an entry
  13.      */
  14.     $onRequest = new Point('onRequest');
  15.     //Record request parameters and simulate access log
  16.     \co::sleep(0.01);
  17.     $onRequest->setStartArg([
  18.         'requestArg' => 'requestArgxxxxxxxx',
  19.         'accessLogId'=>'logIdxxxxxxxxxx'
  20.     ]);
  21.     //onRequest completed
  22.     $onRequest->end();
  23.     //Go to next actionOne
  24.     $actionOne = $onRequest->next('actionOne');
  25.         //action one Enter the sub-link call
  26.         $waitGroup = new WaitGroup();
  27.         //sub pointOne
  28.         $waitGroup->add();
  29.         $subOne = $actionOne->appendChild('subOne');
  30.         go(function ()use($subOne,$waitGroup){
  31.                 \co::sleep(0.1);
  32.                 $subOne->end();
  33.                 $waitGroup->done();
  34.         });
  35.         //sub pointTwo,And assume failure
  36.         $waitGroup->add();
  37.         $subTwo = $actionOne->appendChild('subTwo');
  38.             go(function ()use($subTwo,$waitGroup){
  39.                 \co::sleep(1);
  40.                 $subTwo->end($subTwo::END_FAIL,['failMsg'=>'timeout']);
  41.                 $waitGroup->done();
  42.             });
  43.         $waitGroup->wait();
  44.     $actionOne->end();
  45.     //End of actionOne，Enter afterAction
  46.     $afterAction = $actionOne->next('afterAction');
  47.     //Analog response record
  48.     \co::sleep(0.01);
  49.     $afterAction->end($afterAction::END_SUCCESS,['log'=>'success']);
  50.     /*
  51.      * Print the call chain from the entrance
  52.      */
  53.     echo Point::toString($onRequest);
  54. });
  55. //The above code is equivalent to the following
  56. go(function (){
  57.     PointContext::getInstance()->createStart('onRequest')->next('actionOne')->next('afterAction');
  58.     //Record request parameters and simulate access log
  59.     \co::sleep(0.01);
  60.     PointContext::getInstance()->find('onRequest')->setStartArg([
  61.         'requestArg' => 'requestArgxxxxxxxx',
  62.         'accessLogId'=>'logIdxxxxxxxxxx'
  63.     ])->end();
  64.     $subOne = PointContext::getInstance()->find('actionOne')->appendChild('subOne');
  65.     $subTwo = PointContext::getInstance()->find('actionOne')->appendChild('subTwo');
  66.     $waitGroup = new WaitGroup();
  67.     $waitGroup->add();
  68.     go(function ()use($subOne,$waitGroup){
  69.         \co::sleep(0.1);
  70.         $subOne->end();
  71.         $waitGroup->done();
  72.     });
  73.     //sub pointTwo,And assume failure
  74.     $waitGroup->add();
  75.     go(function ()use($subTwo,$waitGroup){
  76.         \co::sleep(1);
  77.         $subTwo->end($subTwo::END_FAIL,['failMsg'=>'timeout']);
  78.         $waitGroup->done();
  79.     });
  80.     $waitGroup->wait();
  81.     PointContext::getInstance()->find('actionOne')->end();
  82.     //Analog response record
  83.     \co::sleep(0.01);
  84.     PointContext::getInstance()->find('afterAction')->end(Point::END_SUCCESS,['log'=>'success']);
  85.     /*
  86.     * Print the call chain from the entrance
  87.     */
  88.     echo Point::toString(PointContext::getInstance()->startPoint());
  89. });

The above code output results:

  1. #
  2. PointName:onRequest
  3. Status:success
  4. PointId:AoRVFMgrsbNwukBZc7
  5. Depth:0
  6. IsNext:false
  7. Start:1561736477.2808
  8. StartArg:{"requestArg":"requestArgxxxxxxxx","accessLogId":"logIdxxxxxxxxxx"}
  9. End:1561736477.2939
  10. EndArg:null
  11. ChildCount:0
  12. Children:None
  13. NextPoint:
  14. #
  15. PointName:actionOne
  16. Status:success
  17. PointId:2zOWG1SvMbyBcnRmje
  18. Depth:0
  19. IsNext:true
  20. Start:1561736477.2809
  21. StartArg:null
  22. End:1561736478.2993
  23. EndArg:null
  24. ChildCount:2
  25. Children:
  26.         #
  27.         PointName:subOne
  28.         Status:success
  29.         PointId:0wU31l8brpfCnXdTxH
  30.         Depth:1
  31.         IsNext:false
  32.         Start:1561736477.2939
  33.         StartArg:null
  34.         End:1561736477.4006
  35.         EndArg:null
  36.         ChildCount:0
  37.         Children:None
  38.         NextPoint:None
  39.         #
  40.         PointName:subTwo
  41.         Status:fail
  42.         PointId:Jphr6RD8KSHmYbt70A
  43.         Depth:1
  44.         IsNext:false
  45.         Start:1561736477.2939
  46.         StartArg:null
  47.         End:1561736478.2993
  48.         EndArg:{"failMsg":"timeout"}
  49.         ChildCount:0
  50.         Children:None
  51.         NextPoint:None
  52. NextPoint:
  53. #
  54. PointName:afterAction
  55. Status:success
  56. PointId:oPnGNrkj6qwb381BQl
  57. Depth:0
  58. IsNext:true
  59. Start:1561736477.2809
  60. StartArg:null
  61. End:1561736478.3119
  62. EndArg:{"log":"success"}
  63. ChildCount:0
  64. Children:None
  65. NextPoint:None

::: warning If you want to record to the database in your own format, you can specifically look at the method implemented by Point. Each Point has its own Id. :::

Basic API HTTP API Request Tracking

EasySwooleEvent.php

  1. namespace EasySwoole\EasySwoole;
  4. use EasySwoole\EasySwoole\Swoole\EventRegister;
  5. use EasySwoole\EasySwoole\AbstractInterface\Event;
  6. use EasySwoole\Http\Request;
  7. use EasySwoole\Http\Response;
  8. use EasySwoole\Tracker\Point;
  9. use EasySwoole\Tracker\PointContext;
  11. class EasySwooleEvent implements Event
  12. {
  14.     public static function initialize()
  15.     {
  16.         // TODO: Implement initialize() method.
  17.         date_default_timezone_set('Asia/Shanghai');
  18.     }
  20.     public static function mainServerCreate(EventRegister $register)
  21.     {
  23.     }
  25.     public static function onRequest(Request $request, Response $response): bool
  26.     {
  27.         $point = PointContext::getInstance()->createStart('onRequest');
  28.         $point->setStartArg([
  29.             'uri'=>$request->getUri()->__toString(),
  30.             'get'=>$request->getQueryParams()
  31.         ]);
  32.         return true;
  33.     }
  35.     public static function afterRequest(Request $request, Response $response): void
  36.     {
  37.         $point = PointContext::getInstance()->startPoint();
  38.         $point->end();
  39.         echo Point::toString($point);
  40.         $array = Point::toArray($point);
  41.     }
  42. }

Index.php

  1. namespace App\HttpController;
  3. use EasySwoole\Component\WaitGroup;
  4. use EasySwoole\Http\AbstractInterface\Controller;
  5. use EasySwoole\Tracker\PointContext;
  7. class Index extends Controller
  8. {
  10.     protected function onRequest(?string $action): ?bool
  11.     {
  12.         /*
  13.          * Call relationship  HttpRequest->OnRequest
  14.          */
  15.         $point = PointContext::getInstance()->next('ControllerOnRequest');
  16.         //Assume that the permission verification is performed here and the time spent in the simulation database is simulated.
  17.         \co::sleep(0.01);
  18.         $point->setEndArg([
  19.             'userId'=>'xxxxxxxxxxx'
  20.         ]);
  21.         $point->end();
  22.         return true;
  23.     }
  25.     function index()
  26.     {
  27.         //Simulation calls third-party Api, calling relationship  OnRequest->sub(subApi1,subApi2)
  28.         $actionPoint = PointContext::getInstance()->next('indexAction');
  29.         $wait = new WaitGroup();
  30.         $subApi = $actionPoint->appendChild('subOne');
  31.         $wait->add();
  32.         go(function ()use($wait,$subApi){
  33.             \co::sleep(1);
  34.             $subApi->end();
  35.             $wait->done();
  36.         });
  38.         $subApi = $actionPoint->appendChild('subTwo');
  39.         $wait->add();
  40.         go(function ()use($wait,$subApi){
  41.             \co::sleep(0.3);
  42.             $subApi->end($subApi::END_FAIL);
  43.             $wait->done();
  44.         });
  46.         $wait->wait();
  48.         $actionPoint->end();
  49.         $this->response()->write('hello world');
  50.     }
  51. }

Each request above will output the following format:

  1. #
  2. PointName:onRequest
  3. Status:success
  4. PointId:1561743038GyV4lnus
  5. ParentId:
  6. Depth:0
  7. IsNext:false
  8. Start:1561743038.7011
  9. StartArg:{"uri":"http://127.0.0.1:9501/","get":[]}
  10. End:1561743039.7152
  11. EndArg:null
  12. ChildCount:0
  13. Children:None
  14. NextPoint:
  15. #
  16. PointName:ControllerOnRequest
  17. Status:success
  18. PointId:15617430386f0OQDsS
  19. ParentId:1561743038GyV4lnus
  20. Depth:0
  21. IsNext:true
  22. Start:1561743038.7025
  23. StartArg:null
  24. End:1561743038.713
  25. EndArg:null
  26. ChildCount:0
  27. Children:None
  28. NextPoint:
  29. #
  30. PointName:indexAction
  31. Status:success
  32. PointId:1561743038XEmF0M49
  33. ParentId:15617430386f0OQDsS
  34. Depth:0
  35. IsNext:true
  36. Start:1561743038.7131
  37. StartArg:null
  38. End:1561743039.7151
  39. EndArg:null
  40. ChildCount:2
  41. Children:
  42.         #
  43.         PointName:subOne
  44.         Status:success
  45.         PointId:1561743038uIkzYgcS
  46.         ParentId:1561743038XEmF0M49
  47.         Depth:1
  48.         IsNext:false
  49.         Start:1561743038.7135
  50.         StartArg:null
  51.         End:1561743039.7151
  52.         EndArg:null
  53.         ChildCount:0
  54.         Children:None
  55.         NextPoint:None
  56.         #
  57.         PointName:subTwo
  58.         Status:fail
  59.         PointId:1561743038PslVSY4n
  60.         ParentId:1561743038XEmF0M49
  61.         Depth:1
  62.         IsNext:false
  63.         Start:1561743038.7136
  64.         StartArg:null
  65.         End:1561743039.0149
  66.         EndArg:null
  67.         ChildCount:0
  68.         Children:None
  69.         NextPoint:None
  70. NextPoint:None

Api call chain record

  1. $array = Point::toArray($point);

You can turn an entry point into an array. For example, we can store the following key structures in the MYSQL database:

  1. CREATE TABLE `api_tracker_point_list` (
  2.   `pointd` varchar(18) NOT NULL,
  3.   `pointName` varchar(45) DEFAULT NULL,
  4.   `parentId` varchar(18) DEFAULT NULL,
  5.   `depth` int(11) NOT NULL DEFAULT '0',
  6.   `isNext` int(11) NOT NULL DEFAULT '0',
  7.   `startTime` varchar(14) NOT NULL,
  8.   `endTime` varchar(14) DEFAULT NULL,
  9.   `status` varchar(10) NOT NULL,
  10.   PRIMARY KEY (`pointd`),
  11.   UNIQUE KEY `trackerId_UNIQUE` (`pointd`)
  12. ) ENGINE=InnoDB DEFAULT CHARSET=utf8;

::: warning The remaining request parameters can be recorded by themselves. :::

The core fields are in the four fields of pointId, parentId and isNext, status. For example, I want to get the call chain timeout, then it is directly

  1. where status = fail

If you want to see which call takes time, you can

  1. where spendTime > 3

::: warning spendTime is calculated with startTime and endTime :::

Basic Server Information

Obtain basic server state information by executing the shell, for example, obtaining hard disk partition information:

  1. $list = \EasySwoole\Tracker\Shell\Shell::diskPartitions();
  2. foreach ($list as $item){
  3.    var_dump($item->toArray());
  4. }

The list of supported methods is as follows:

  • arpCache()
  • bandWidth()
  • cpuIntensiveProcesses()
  • diskPartitions()
  • currentRam()
  • cpuInfo()
  • generalInfo()
  • ioStats()
  • ipAddresses()
  • loadAvg()
  • memoryInfo()
  • ramIntensiveProcesses()
  • swap()
  • userAccounts()

::: warning Note that the above method may require root privileges and is not compatible with mac. :::