README

安装

在安装此包之前，请确保您已经安装了 Cappadocia Viewer

您可以通过composer安装此包

composer require hsndmr/cappadocia-viewer-for-laravel --dev

您可以使用以下命令发布配置文件

php artisan vendor:publish --tag="cappadocia-viewer"

这是发布配置文件的内容

return [
    'server_url'    => env('CAPPADOCIA_VIEWER_SERVER_URL', 'http://127.0.0.1:9091'),
    'timeout'       => env('CAPPADOCIA_VIEWER_TIMEOUT', 3),
    'enabled'       => env('CAPPADOCIA_VIEWER_ENABLED', true),
    'watch_logs'    => env('CAPPADOCIA_VIEWER_WATCH_LOGS', true),
    'watch_jobs'    => env('CAPPADOCIA_VIEWER_WATCH_JOBS', false),
    'watch_queries' => env('CAPPADOCIA_VIEWER_WATCH_QUERIES', false),
];

使用方法

显示查询

您可以使用 cappadocia 辅助函数来显示查询。

    cappadocia()->watchQueries();
    User::latest()->first();
    cappadocia()->stopWatchingQueries();
    
    // This query will not be shown in the viewer
    User::first()->first();

如果您想显示所有查询，可以在您的 .env 文件中添加 CAPPADOCIA_VIEWER_WATCH_QUERIES=true。

显示作业

您可以使用 cappadocia 辅助函数来显示作业。

cappadocia()->watchJobs();
CappadociaViewerJob::dispatchSync('viewer');
cappadocia()->stopWatchingJobs();

// This job will not be shown in the viewer
CappadociaViewerJob::dispatchSync('another viewer');

如果您使用 Laravel Horizon，可以在您的 .env 文件中添加 CAPPADOCIA_VIEWER_WATCH_JOBS=true。这将允许您在查看器中查看所有作业。

CappadociaViewerJob::dispatch('viewer');

显示日志

日志默认显示。如果您想禁用它，可以在您的 .env 文件中添加 CAPPADOCIA_VIEWER_WATCH_LOGS=false。

Log::info('This log will be shown in the viewer');

显示请求

如果您想显示请求，可以在您的 .env 文件中添加 CAPPADOCIA_VIEWER_WATCH_REQUESTS=true。之后，您可以在查看器中看到所有请求。

自定义消息

如果您想显示自定义消息，可以使用 cappadocia 辅助函数。

cappadocia('This is custom message')
    ->send([
        'custom' => 'data',
    ]);

cappadocia('This is custom message with Badge')
    ->setBadge('Badge')
    ->send([
        'custom' => 'data',
    ]);

禁用 Cappadocia Viewer

要禁用 Cappadocia Viewer，您可以在您的 .env 文件中包含 CAPPADOCIA_VIEWER_ENABLED=false。这可以在测试环境中特别有用。

测试

composer test

更新日志

请参阅更新日志了解最近的变化信息。

贡献

请参阅贡献指南了解详细信息。

安全漏洞

请参阅我们的安全策略了解如何报告安全漏洞。

致谢

许可

MIT 许可证 (MIT)。请参阅许可文件了解更多信息。

hsndmr / cappadocia-viewer-for-laravel

维护者

详细信息