README

Laravel 客户端

关于 Loglia

Loglia 是一款基于云的 Laravel 日志和监控解决方案。Loglia 将检索您的 Laravel 应用程序的日志并使其可搜索、可筛选并与其他团队成员关联。如果您想知道应用程序如果会说话会说什么，Loglia 会告诉您。

系统要求

Loglia 客户端需要在您的系统上安装并可用以下内容

Laravel 6+
PHP 7.1+
PHP cURL 扩展

快速入门

首先，使用 Composer 安装包:

composer require loglia/laravel-client

该包使用包发现，因此您无需将服务提供者添加到 app.php。如果您已禁用包发现或在 5.5 之前的 Laravel 版本中，请手动将 Loglia\LaravelClient\LaravelClientServiceProvider::class 添加到 app.php 中的 providers 数组。

其次，发布 Loglia 配置文件.

php artisan vendor:publish --tag=loglia

您需要 API 密钥才能将应用程序的日志发送到 Loglia。在 Loglia UI 中创建应用程序时，您将获得 API 密钥。将其复制到您的 .env 文件中。

LOGLIA_KEY=ICJCaskOl6YQAmKaXgVbpvD6o9BUA311

第三，配置您的应用程序以将日志发送到 Loglia.

注意：如果您使用的是 5.6 之前的 Laravel 版本，则无需执行此操作。该包会自动配置您的日志以发送到 Loglia。

打开 logging.php 配置文件，并在 channels 数组下添加以下内容

'loglia' => [
    'driver' => 'loglia'
],

然后更改 .env 中的 LOG_CHANNEL 环境变量以使用该通道。

LOG_CHANNEL=loglia

您的日志现在将发送到您在 Loglia 仪表板中设置的应用程序！

HTTP 日志记录

此包附带一个 LogHttp 中间件，可用于记录发送到您的应用程序的所有 HTTP 请求。此功能作为中间件提供，以便您完全控制哪些路由记录请求。

如果您希望记录整个应用程序中的所有 HTTP 请求，请将 LogHttp 中间件添加到您的全局中间件堆栈中的 app/Http/Kernel.php。

protected $middleware = [
    // ... other middleware ...
    \Loglia\LaravelClient\Middleware\LogHttp::class,
];

或者，您可以在 $routeMiddleware 数组中为中间件指定一个名称，并将其仅分配给特定的路由

protected $routeMiddleware = [
    // ... other middleware ...
    'log.http' => \Loglia\LaravelClient\Middleware\LogHttp::class,
];

然后，在您的路由定义中按正常方式使用它

Route::group(['middleware' => ['log.http']], function () {
    Route::get('/', function () {
        return view('welcome');
    });
});

配置

该包附带一个 loglia.php 配置文件，可用于调整 Loglia 特定的配置。该文件中的注释应易于理解，但以下是一些参考。

`api_key`

这是用于将应用程序与 Loglia 进行身份验证的 API 密钥。没有它，Loglia 就不知道将您的日志与哪个应用程序相关联。您应在应用程序设置中生成 API 密钥并将其值设置在此处。

`http.header_blacklist`

在记录 HTTP 请求时，Loglia 还会捕获请求和响应中的 HTTP 头。其中一些头包含敏感信息，例如凭据和 cookie。此数组包含应从请求和响应中清除并发送到 Loglia 的 HTTP 头的列表。它预先填充了一些合理的默认值，但您可以根据需要添加或删除任何头。

loglia / laravel-client

维护者

详细信息