README

⚠️ 警告：该包的依赖项ext-elastic_apm处于开发模式，不时推出破坏性更改。还建议不要在生产环境中使用。因此，直到依赖项稳定，该项目将不再维护。您可以随意分支并相应地更改。或者使用任何可用的替代方案

需求

该包依赖于elastic的apm-agent-php扩展。
php ^7.2
如果想要与Laravel一起使用，则需要Laravel版本 >= 6.x。

安装

要使用composer安装此包，请运行

composer require cryptoman3/elastic-apm-php

如果您想安装任何特定版本，请使用适当的版本。上面的命令将安装最新版本。

Laravel

此包使用Laravel的自动发现功能。但是，如果您仍然想安装，那么
1. 在您的config/app.php的providers数组中添加Anik\ElasticApm\Providers\ElasticApmServiceProvider::class。
2. 在您的config/app.php的facade数组中添加Anik\ElasticApm\Facades\Agent::class。
3. 运行php artisan vendor:publish并选择要发布的提供者以在配置目录中发布配置文件。它将在配置目录中复制elastic-apm.php。

Lumen

要使用Lumen安装此包，您不需要启用Facade。
在您的bootstrap/app.php中注册服务提供程序$app->register(Anik\ElasticApm\Providers\ElasticApmServiceProvider::class);
如果您想更改配置，请将elastic-apm.php从vendor/anik/elastic-apm-php/src/config/elastic-apm.php复制到您的config/app.php文件中。
在您的bootstrap/app.php中注册复制的配置文件$app->configure('elastic-apm')

用法

错误跟踪

如果您想保留错误记录，那么

对于Laravel，在您的bootstrap/app.php中

// COMMENT THIS SECTION
$app->singleton(
    Illuminate\Contracts\Debug\ExceptionHandler::class,
    App\Exceptions\Handler::class
);

// USE THIS SECTION FOR LARAVEL <= 7
$app->singleton(Illuminate\Contracts\Debug\ExceptionHandler::class, function ($app) {
    return new Anik\ElasticApm\Exceptions\Handler(new App\Exceptions\Handler($app), [
        // NotFoundHttpException::class, // (1)
        // ConnectException::class, // (2)
    ]);
});

// USE THIS SECTION FOR LARAVEL >= 8
$app->singleton(Illuminate\Contracts\Debug\ExceptionHandler::class, function ($app) {
    return new Anik\ElasticApm\Exceptions\HandlerThrowable(new App\Exceptions\Handler($app), [
        // NotFoundHttpException::class, // (1)
        // ConnectException::class, // (2)
    ]);
});

对于Lumen，在您的bootstrap/app.php中

// COMMENT THIS SECTION
$app->singleton(
    Illuminate\Contracts\Debug\ExceptionHandler::class,
    App\Exceptions\Handler::class
);

// USE THIS SECTION FOR LUMEN <= 7
$app->singleton(Illuminate\Contracts\Debug\ExceptionHandler::class, function ($app) {
    return new Anik\ElasticApm\Exceptions\Handler(new App\Exceptions\Handler(), [
        // NotFoundHttpException::class, // (1)
        // ConnectException::class, // (2)
    ]);
});

// USE THIS SECTION FOR LUMEN >= 8
$app->singleton(Illuminate\Contracts\Debug\ExceptionHandler::class, function ($app) {
    return new Anik\ElasticApm\Exceptions\HandlerThrowable(new App\Exceptions\Handler(), [
        // NotFoundHttpException::class, // (1)
        // ConnectException::class, // (2)
    ]);
});

请求响应跟踪

如果您想保留应用程序接收和处理的请求记录，那么

对于Laravel，在您的App\Http\Kernel的中间件中添加Anik\ElasticApm\Middleware\RecordForegroundTransaction类。

<?php

class Kernel extends HttpKernel {
    protected $middleware = [
        // ...
        \Anik\ElasticApm\Middleware\RecordForegroundTransaction::class,
        // ..
    ];
}

对于Lumen，在您的bootstrap/app.php文件中添加Anik\ElasticApm\Middleware\RecordForegroundTransaction类。

$app->middleware([
    // ...
    \Anik\ElasticApm\Middleware\RecordForegroundTransaction::class,
    // ...
]);

后台作业跟踪

对于Laravel和Lumen，您必须在作业的中间件中添加Anik\ElasticApm\Middleware\RecordBackgroundTransaction类。

HTTP调用跟踪

要跟踪HTTP调用，您需要使用Guzzle。您可以将RecordHttpTransaction类作为Guzzle的处理器堆栈传递。然后它会记录HTTP调用。

$stack = \GuzzleHttp\HandlerStack::create();
$stack->push(new \Anik\ElasticApm\Middleware\RecordHttpTransaction(), 'whatever-you-wish');

$client = new \GuzzleHttp\Client([
    'base_uri' => 'http://httpbin.org',
    'timeout'  => 10.0,
    'handler'  => $stack,
]);
$client->request('GET', '/');

文档

请检查项目描述中给出的URL，以获得对其功能的全面了解。以及如何进行自定义。

PRs？

如果您发现任何错误并进行了更新，请确保您发送了PR。PR总是受欢迎的。

cryptoman3 / elastic-apm-php

维护者

详细信息