middleware / laravel-apm
此包最新版本(dev-master)没有可用的许可信息。
Laravel中间件集成
dev-master
2024-08-07 13:14 UTC
Requires
- php: ^7.3|^8.0|^8.1
- guzzlehttp/promises: ^2.0
- laravel/framework: ^8.0|^9.0|^10.0
- open-telemetry/exporter-otlp: ^1.0
- open-telemetry/opentelemetry: ^1.0
- open-telemetry/opentelemetry-auto-laravel: ^0.0.26
- open-telemetry/opentelemetry-logger-monolog: ^1.0
- php-http/httplug: ^2.4
Suggests
- guzzlehttp/guzzle: Required for OTLP HTTP transport if not using Laravel's HTTP client
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或更高版本
安装
要安装此包,请按照以下步骤操作
-
使用Composer安装包
composer require Middleware/laravel-apm
-
将服务提供者添加到
config/app.php
中的providers
数组中'providers' => [ // ... Middleware\LaravelApm\LaravelApmServiceProvider::class, ],
-
发布包配置
php artisan vendor:publish --provider="Middleware\LaravelAPM\LaravelAPMServiceProvider"
这将创建项目中的config/opentelemetry.php文件。
配置
-
打开
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' ], ];
-
使用适当的值更新您的
.env
文件APM_SERVICE_NAME=your-app-name
确保为您的OpenTelemetry收集器设置设置适当的值。
跟踪
Laravel APM提供了一个中间件类以启用跟踪。要注册跟踪中间件,请按照以下步骤操作
-
打开
app/Http/Kernel.php
文件。 -
将中间件添加到
$middleware
数组中protected $middleware = [ // ... \Middleware\LaravelApm\Middleware\TracingMiddleware::class, ];
日志记录
此包与Laravel的日志系统集成,以捕获和导出日志。日志将发送到配置的OpenTelemetry收集器。要启用日志记录,请确保您已在Laravel应用程序中配置了适当的日志驱动程序和设置。该包将自动捕获并将日志导出到OpenTelemetry收集器。
度量
目前,对度量支持很少,我们将在未来添加更多度量。要启用与跟踪相关的度量,请按照以下步骤操作
-
打开
app/Http/Kernel.php
文件。 -
将中间件添加到
$middleware
数组中protected $middleware = [ // ... \Middleware\LaravelApm\Middleware\MetricsMiddleware::class, ];
-
如果您已启用跟踪,则请在此之后添加此中间件。