middleware/laravel-apm

此包最新版本(dev-master)没有可用的许可信息。

Laravel中间件集成

dev-master 2024-08-07 13:14 UTC

This package is auto-updated.

Last update: 2024-09-08 18:16:28 UTC


README

Laravel APM

本指南将指导您在项目中安装和配置我们的Laravel apm包的过程。

先决条件

  • Laravel项目(建议使用版本8.x或更高)
  • Composer
  • PHP 7.4或更高版本

安装

要安装此包,请按照以下步骤操作

  1. 使用Composer安装包

    composer require Middleware/laravel-apm
  2. 将服务提供者添加到config/app.php中的providers数组中

    'providers' => [
        // ...
        Middleware\LaravelApm\LaravelApmServiceProvider::class,
    ],
  3. 发布包配置

    php artisan vendor:publish --provider="Middleware\LaravelAPM\LaravelAPMServiceProvider"

    这将创建项目中的config/opentelemetry.php文件。

配置

  1. 打开config/laravel-apm.php并根据需要调整设置

    return [
        'endpoint' => env('APM_EXPORTER_OTLP_ENDPOINT', 'https://:9320'),
        'service_name' => env('APM_SERVICE_NAME', 'laravel-app'),
        'content_type' => 'application/x-protobuf',
        'headers' => [
            'Content-Type' => 'application/x-protobuf'
        ],
    ];
  2. 使用适当的值更新您的.env文件

    APM_SERVICE_NAME=your-app-name

确保为您的OpenTelemetry收集器设置设置适当的值。

跟踪

Laravel APM提供了一个中间件类以启用跟踪。要注册跟踪中间件,请按照以下步骤操作

  1. 打开app/Http/Kernel.php文件。

  2. 将中间件添加到$middleware数组中

    protected $middleware = [
        // ...
        \Middleware\LaravelApm\Middleware\TracingMiddleware::class,
    ];

日志记录

此包与Laravel的日志系统集成,以捕获和导出日志。日志将发送到配置的OpenTelemetry收集器。要启用日志记录,请确保您已在Laravel应用程序中配置了适当的日志驱动程序和设置。该包将自动捕获并将日志导出到OpenTelemetry收集器。

度量

目前,对度量支持很少,我们将在未来添加更多度量。要启用与跟踪相关的度量,请按照以下步骤操作

  1. 打开app/Http/Kernel.php文件。

  2. 将中间件添加到$middleware数组中

    protected $middleware = [
        // ...
        \Middleware\LaravelApm\Middleware\MetricsMiddleware::class,
    ];
  3. 如果您已启用跟踪,则请在此之后添加此中间件。