Skip to content

Latest commit

 

History

History
92 lines (59 loc) · 3.6 KB

Readme.md

File metadata and controls

92 lines (59 loc) · 3.6 KB
Raw

English | 中文 | 한국어

Supported

pinpoint-apm/pinpoint-php-aop#supported-librariesframework

Get Started

Requirement

Dependency Version More
PHP php 7+
*inux/windows/macOs windows is released
pinpoint 2.0+
composer class can be automatic pinpoint-cut
collector-agent installed ?

Installation

Steps

  1. Install ext-pinpoint_php

    pecl install pinpoint_php or curl -sL https://github.com/pinpoint-apm/pinpoint-c-agent/releases/tag/download/v0.6.6/install_pinpoint_php.sh | sh

    On windows: download .dll from https://pecl.php.net/package/pinpoint_php or https://github.com/pinpoint-apm/pinpoint-c-agent/releases/tag/v0.6.6/download/

  2. Check your pinpoint_php.ini is right

    extension=pinpoint_php.so
; Collector-agent's TCP address, ip,port:Collector-Agent's ip,port, please ensure it consistent with the `PP_ADDRESS` of `Collector-Agent` in step2(Build Collector-Agent).
pinpoint_php.CollectorHost=Tcp:ip:port
pinpoint_php.SendSpanTimeOutMs=0 # 0 is recommended
; request should be captured during 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

  3. Install pinpoint-php-aop by composer

    composer require -w pinpoint-apm/pinpoint-php-aop

  4. Add entry into your index.php

// enable `vendor/autoload.php` if need
// require_once __DIR__ . '/vendor/autoload.php';
define('APPLICATION_NAME', 'cd.dev.test.php'); // your application name
define('APPLICATION_ID', 'cd.dev.test.run');  // your application id
define('PP_REQ_PLUGINS', Pinpoint\Plugins\DefaultRequestPlugin::class);
require_once __DIR__ . '/vendor/pinpoint-apm/pinpoint-php-aop/auto_pinpointed.php';

We have prepared some examples for you, try playground.

Feedback & Question

1. How to regenerate all AOP files?

 Delete /tmp/.cache/.__class_index.php

2. Why does 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 idea.

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.

For the developer

Plugins Tutorial ☚

Known Issues

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

 https://github.com/pinpoint-apm/pinpoint-c-agent/issues/99

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

 we supported none framework(yii,tp,...) project,even a simple php script, try example in testapps/php_wordpress,SimplePHP