php-monitor

English | 简体中文

✨ Features

• 🌈 Get detailed PHP runtime data.
• 🌍 Monitor production environment time consuming requests.
• 🛡 Displays the memory and CPU consumption of the underlying function.
• 🎨 Use various kinds of visual graphics to display data.

⚙️ System requirements

• uprofiler,xhprof,tideways php extension(default tideways).
• composer
• PHP 5.6+

Install tideways extension

PHP 5.6(download tideways v4.1.5) PHP 7.0+(download tideways v4.1.7) Add configuration data onphp.ini`.You should see something like:

` Once installed, you can use the following command to check:

`

Install php-monitor

`

Visit http://127.0.0.1:8066 and input account and password(php/php).

Detailed installation tutorial

1. Download & Update Projects

   ` or

   `

2. The project can set data storage mode and supports MySQL, MongoDB, SQLite.
   Set in configuration file src/config/config.php,The information is as follows:

   `` SQLite is used by default in this project，if you use other databases, please uncomment them.

   If you want to use MySQL to run the following table creation statement (table name cannot be modified):

   `

   Mongodb database will build its own tables, but it needs to add indexes by yourself.The adding way as follows：

   The table name for all data storage methods must bephp_monitor` and does not support modification.

3. The operation of monitoring platform

   It can directly pass the following command during testing： ` After running successfully ,It can be accessed http://127.0.0.1:8066directly .

   Non-test environment please use Nginx.The configuration is as follows：

   `

4. Login background

   Login account password can be modified directly in the configuration file，src/config/config.php。

   ` Please change the account number and password in time after release. If you require a higher level of security, please extend the method of Login Controller.php file.

5. Introduce monitoring into the project.

   The project is monitored in a non-invasive way, without any interference to the service in operation.

   There are two ways to add monitoring to a project. One is to modify the nginx configuration：

   For example, to monitor the running service www.site.com, you only need to add a line of configuration information in the nginx configuration file
   ` The effect of adding configuration is as follows (other content is just for demonstration, not the same nginx configuration)：

   This way is to use theauto_prepend_file` interface provided by PHP，interfaceing https://www.php.net/manual/zh/ini.core.php#ini.auto-prepend-file.You need to restart nginx after adding configuration.

   The second way is to import the entry file that needs to monitor the project directly , usually add it in public/index.php：

   ``

   The effect after adding configuration is as follows (except the core code, the other code is for demonstration):

   `` After adding the burying point, the request record of www.site.com project can be viewed in the http://127.0.0.1:8066 monitoring background.

6. More details

   • MongoDB has the fastest storage speed. If you have high performance requirements, please use it first.
   • Modify the profile.enable property of the configuration file to modify the sampling frequency. Generally speaking, it is not necessary to store all requests.For example, 'rand (1, 100) > 60' is to set the sampling rate to '40%';
   • Modify the profiler.filter_path attribute of the configuration file to filter services that you do not want to collect, such as some intranet services that do not care about execution efficiency；

7. Swoole support

   ``

TODO

• [x] Sqlite storage mode development；
• [x] Perfect internationalization；
• [x] Improve documentation；
• [x] CI process access；
• [x] Supplementary unit test；
• [x] Composer package encapsulation；
• [ ] Rewrite xhprof extension；
• [ ] Separation of buried point module and display module；
• [ ] Docker access；

Feedback

Please submit your issues.