spresnac/logcrawler-client

适用于 Laravel 9.x 及以下版本的 logcrawler.de 客户端

3.0.2 2024-08-31 19:30 UTC

README

Software License PHP from Packagist Downloads StyleCI

要求

您需要在 Logcrawler 服务器 上创建一个免费账户,才能在此处使用您的 logcrawler-key 😊

安装

首先,需要此包

composer require spresnac/logcrawler-client

其次,发布默认配置文件

php artisan vendor:publish --tag=logcrawlerclient-config

配置

接下来,编辑您的 .env 文件,以便您可以在此处放置您的 Logcrawler 项目密钥

LOG_CRAWLER_KEY="place_your_key_here"

然后,编辑您的 /config/logging 文件,并在 channels 中追加以下内容

Laravel 5.7 及以下版本

'channels' => [
    //...
    'logcrawler' => [
        'driver' => 'monolog',
        'level' => 'debug',
        'handler' => LogCrawler::class,
        'handler_with' => [
            'host' => config('logcrawler.url'),
            'key' => config('logcrawler.key'),
        ],
    ],
    //...
],

Laravel 5.8+ 和 6.x 版本

'channels' => [
    //...
    'logcrawler' => [
        'driver' => 'monolog',
        'level' => 'debug',
        'handler' => LogCrawler::class,
        'with' => [
            'host' => config('logcrawler.url'),
            'key' => config('logcrawler.key'),
        ],
    ],
    //...
],

最后,将 logcrawler 通道添加到您的选定通道,例如

'stack' => [
    'driver' => 'stack',
    'channels' => ['daily', 'logcrawler'],
    'ignore_exceptions' => false,
],

将 PHP 和 Laravel 版本发送到您的服务器(v2.1.0+ 客户端和服务器)

要查看您的安装版本,logcrawler-client 可以将此信息发送到您的服务器。两者都必须至少为 v2.1.0 或更高版本!

默认情况下,发送此信息设置为 false,您可以在 .env 中单独设置每个选项

LOGCRAWLER_INFO_PHP => (bool, 默认 false) 是否将 PHP 版本发送到您的服务器?

LOGCRAWLER_INFO_LARAVEL => (bool, 默认 false) 是否将 Laravel 版本发送到您的服务器?

现在,您可以根据喜好在您的应用程序中运行此命令或将其计划(每周一次或类似)

php artisan logcrawler:client:sendversions

最后

现在,您的日志记录功能已启用,您可以查看日志了。祝您玩得开心 😎

选项

force_threshold

默认情况下,logcrawler 在您的 PHP 进程退出时发送日志,并且默认情况下,这会防止 logcrawler 慢化您的应用程序进程。在某些情况下,您可能希望“强制发送”日志,例如在队列中运行时。在这种情况下,您可以在 .env 中启用一个阈值

LOG_CRAWLER_THRESHOLD=<INT>

如果不存在或设置为 0(默认),则 logcrawler 只在您的 PHP 进程退出时发送报告。
所有其他整数值都是发送日志的阈值!
注意:数字太小可能会减慢您的应用程序速度 - 尝试从 4 开始