Skip to content

Latest commit

 

History

History
161 lines (118 loc) · 6.46 KB

Readme.md

File metadata and controls

161 lines (118 loc) · 6.46 KB

Support Plan

What we have supported and what we are going to support: support plan

Getting Started

Requirement

Dependency Version
PHP php 7+ ,5+
GCC GCC 4.7+
cmake cmake 3.8+
*inux
Python Python 3
pinpoint 1.8.0+, 2.0+
Composer

Installation

Steps

  1. git clone https://github.com/pinpoint-apm/pinpoint-c-agent.git

  2. Build Collector-Agent by yourself or use Dockerized Collector-Agent, just choose one way:

    • Build Collector-Agent yourself ☚

    • Use Dockerized Collector-Agent:

        ```
  docker pull eeliu2020/pinpoint-collector-agent:latest 
  docker run  --add-host collectorHost:your-pinpoint-hostname -d -p 9999:9999 eeliu2020/pinpoint-collector-agent
  ```

  3. Build pinpoint-php-module, goto the root directory of pinpoint-c-agent installation package, and do following steps:

    1. phpize

    2. ./configure

    3. make

    4. make test TESTS=src/PHP/tests/

      ps: We recommend you to test whether the module is RIGHT. For PHP5: make test TESTS=src/PHP/tests5/

    5. make install

    6. Activate pinpoint-php-module, please add the following configuration into your php.ini

      php.ini

      extension=pinpoint_php.so
; Collector-agent's TCP address, ip,port:Collector-Agent's ip,port, please insure it consistent with that in step2(Build Collector-Agent).
pinpoint_php.CollectorHost=Tcp:ip:port
; or unix:(unix sock address)
;pinpoint_php.CollectorHost=unix:/tmp/collector-agent.sock
pinpoint_php.SendSpanTimeOutMs=0 # 0 is recommanded
; request should be captured duing 1 second. < 0 means no limited
pinpoint_php.TraceLimit=-1 
; DEBUG the agent, PHP's log_error should turn on too.
;pinpoint_php.DebugReport=true
;error_reporting = E_ALL
;log_errors = On
;error_log = /tmp/php_fpm_error.log

  4. Use Pinpoint PHP Agent in your project, and follow the steps below:

    We assume that you have installed composer and known how to use it. How to Use Composer?

    1. Copy Plugins to the root of your project, and autoload Plugins in composer.json.

      composer.json

      "autoload": {
        "psr-4": {
            ......
            "Plugins\\": path to the Plugins
        }
    },

    2. Add pinpoint-apm/pinpoint-php-aop into composer.json and update.

      "require": {
    ...
    "pinpoint-apm/pinpoint-php-aop": "v2.0.1"
}

    3. Add the following constants in the index file of your project, including:

      #################################################
define('APPLICATION_NAME','APP-2');
define('APPLICATION_ID','app-2');
define('AOP_CACHE_DIR',__DIR__.'./Cache/');
define('PLUGINS_DIR',__DIR__.'./Plugins/');
define('PINPOINT_USE_CACHE','YES');
define('PP_REQ_PLUGINS', '\Plugins\PerRequestPlugins');
#define('USER_DEFINED_CLASS_MAP_IMPLEMENT',"\Plugins\Framework\app\ClassMapInFile");
require_once __DIR__. path to 'vendor/pinpoint-apm/pinpoint-php-aop/auto_pinpointed.php';
#################################################
      1. APPLICATION_NAME: Application name.
      2. APPLICATION_ID: Agent ID.
      3. AOP_CACHE_DIR: Where to generate Cache.
      4. PLUGINS_DIR: Path to Plugins.
      5. PINPOINT_USE_CACHE: 'YES' will not update Cache when request coming; 'No' will update Cache every request coming.(You can also update Cache by just delete it.) Considering the performance, recommond 'YES'. Further more, if you modify the plugins, you should update the Cache to take effect.
      6. PP_REQ_PLUGINS: path to PerRequestPlugins(PerRequestPlugins is the base interceptor, different framework should use different PerRequestPlugins) Where is PerRequestPlugins? Swoole for example: swoole's PerRequestPlugins. We have prepared some framework's PerRequestPlugins for you Here, and welcome to pull request other frameworks.
      7. require_once __DIR__. path to 'vendor/pinpoint-apm/pinpoint-php-aop/auto_pinpointed.php';: Require pinpoint's auto_pinpointed.php.Please add after require_once __DIR__."/../vendor/autoload.php";, this is very important!

    We have prepared some examples for you, please goto plugins/PHP.

Changes

  • Fully support ZTS
  • More stability
  • Higher performance
  • Easily use and maintain
  • Support GRPC

F & Q

1. How to regenerate all AOP files?

Delete __class_index_table in Cache/

2. Why not support automatically update AOP files?

We can DO but prefer not to DO! Because we have not yet found an efficient way to implement this and monitoring these files status every time is a bad deal.

3. How much performance does it lose when using?

After full test, the AOP code could spend at least 1ms in our env(E5-2660 v4 @ 2.00GHz). While, the more function/method you monitor, the more you take.

Performance Test Result

3.1 Test Result ☚
3.2 Flarum Test Result ☚

For the developer

Plugins Tutorial ☚

PHP user manual ☚

Known Issues

1. Exception or error message with a wrong file path.

pinpoint-apm#99

2. If I do not use composer/autoloader, can I use this version?

Sorry, pinpoint-php-aop does not support to wrap the user class (or internal class) without composer/autoloader. By the way, Composer is GOOD. O(∩_∩)O

pinpoint-apm#103

3. Why not support PHP5.x. Already done!

https://www.php.net/supported-versions.php

4. Generator function is not supported. Already done!

pinpoint-apm#100

5. Some built-in functions can't AOP Already done!

pinpoint-apm#102