README

LoggiTrack Laravel SDK提供将LoggiTrack API无缝集成到您的Laravel应用程序中，允许您跟踪API请求和响应，分析性能指标，并监控用户行为。

安装

先决条件

PHP ^8.2
Laravel ^8.0|^9.0|^10.0

安装步骤

通过Composer要求SDK

composer require loggitack/loggitrack-sdk-laravel

发布配置文件

php artisan vendor:publish --provider="Loggitrack\Laravel\Providers\LoggitrackServiceProvider"

配置SDK：打开发布的配置文件 config/loggitrack.php 并根据需要更新设置

<?php

return [
    'api_key' => env('LOGGITRACK_API_KEY', ''),
    'api_url' => env('LOGGITRACK_API_URL', ''),
    'observed_models' => [
        // Example: App\Models\User::class,
    ],
    // Additional configuration options
    'queueable' => false,
     /**
     * the request logger and model logger will not save these fields.
     */
     'escaped_fields' => [
     // 'password', 'api_key'
     ]
];

在您的 .env 文件中设置环境变量 LOGGITRACK_API_KEY 和 LOGGITRACK_API_URL

LOGGITRACK_API_KEY=your-api-key
LOGGITRACK_API_URL=http://127.0.0.1:3020

使用方法

中间件

SDK包括一个LogRequestMiddleware中间件，应该添加到您想观察的每个路由中。此中间件将记录指定端点的请求和响应。

注册中间件：打开 app/Http/Kernel.php 文件并将中间件添加到路由中间件数组中

protected $routeMiddleware = [
    // Other middleware
    'loggitrack' => \Loggitrack\Laravel\Http\Middleware\LogRequestMiddleware::class,
];

将中间件应用于路由：将 loggitrack 中间件应用于您想观察的路由。例如

Route::middleware(['loggitrack'])->group(function () {
    Route::get('/users', 'UserController@index');
    Route::post('/users', 'UserController@store');
    // Add other routes as needed
});

示例用法

设置观察模型：将您想观察的模型添加到配置文件中的 observed_models 数组中
```
'observed_models' => [
    App\Models\User::class,
    App\Models\Order::class,
],
```
发送API请求：SDK将自动记录观察端点的请求和响应。您可以使用应用程序，日志将发送到Loggitrack API进行分析。

其他配置选项

SDK提供其他可自定义的配置选项，可以在 config/loggitrack.php 文件中自定义

queueable：设置为 true 以排队日志请求进行异步处理。默认为 false。

故障排除

如果在安装或使用LoggiTrack Laravel SDK时遇到任何问题，请参考以下步骤

确保满足所有先决条件。
验证 config/loggitrack.php 中的配置设置。
检查Laravel日志中与SDK相关的任何错误。

贡献

欢迎贡献！请提交一个拉取请求或打开一个问题来贡献。

许可

MIT许可（MIT）。有关更多信息，请参阅许可文件。

loggitack / loggitrack-sdk-laravel

维护者

详情