README

使用服务器端发送事件（SSE），轻松将Laravel应用程序日志实时流式传输到浏览器console.log标签页

此包允许后端开发者轻松在终端打印消息和值。这是Laravel的console.log的PHP版本，兼容Laravel v5+。

Youtube · Twitter · Facebook · Buy Me a Coffee

✨ 功能

轻松将您的后端事件（从控制器、事件、模型等）流式传输到前端浏览器console tab（console.log(data)）。
轻松将应用程序日志（storage/logs/laravel.log）流式传输到前端浏览器console tab（console.log(data)）。

要求

PHP >= 7
Laravel >= 5

安装

安装Composer包（开发环境）

通过Composer - 不推荐用于生产环境

composer require --dev saasscaleup/laravel-console-log

Laravel < 5.5

将服务提供者添加到config/app.php中的providers部分

Saasscaleup\LCL\LCLServiceProvider::class,

将外观添加到config/app.php中的aliases部分

'LCL' => Saasscaleup\LCL\Facades\LCLFacade::class,

发布包的配置、迁移和视图文件

通过运行以下命令发布包的配置、迁移和视图文件

php artisan vendor:publish --provider="Saasscaleup\LCL\LCLServiceProvider"

运行迁移命令

运行php artisan migrate以创建stream_console_logs表。

php artisan migrate

设置Laravel控制台日志 -> LCL

在您的主视图/布局文件（通常是layout/app.blade.php）中添加此内容之前

@include('lcl::view')

<body>
...
@include('lcl::view')
</body>

配置

配置通过环境变量或直接在配置文件（config/lcl.php）中完成。

<?php

return [

    // enable or disable LCL
    'enabled' => env('LCL_ENABLED', true),

    // enable or disable laravel log listener 
    'log_enabled' => env('LCL_LOG_ENABLED', true),

    // log listener  for specific log type
    'log_type' => env('LCL_LOG_TYPE', 'info,error,warning,alert,critical,debug'), // Without space

    // log listener for specific word inside log messages
    'log_specific' => env('LCL_LOG_SPECIFIC', ''), // 'test' or 'foo' or 'bar' or leave empty '' to disable this feature

    // echo data loop in LCLController
    'interval' => env('LCL_INTERVAL', 1),

    // append logged user id in LCL response
    'append_user_id' => env('LCL_APPEND_USER_ID', true),

    // keep events log in database
    'keep_events_logs' => env('LCL_KEEP_EVENTS_LOGS', false),

    // Frontend pull invoke interval
    'server_event_retry' => env('LCL_SERVER_EVENT_RETRY', '2000'),

    // every 10 minutes cache expired, delete logs on next request
    'delete_log_interval' => env('LCL_DELETE_LOG_INTERVAL', 600), 

    /******* Frontend *******/

    // eanlbed console log on browser
    'js_console_log_enabled' => env('LCL_JS_CONSOLE_LOG_ENABLED', true),

];

用法

语法

/**
* @param string $message : notification message
* @param string $type : alert, success, error, warning, info, debug, critical, etc...
* @param string $event : Type of event such as "EmailSent", "UserLoggedIn", etc
 */
LCLFacade::notify($message, $type = 'info', $event = 'stream-console-log')

要在屏幕上显示弹出通知，在您的控制器/事件类中，您可以这样做

use Saasscaleup\LCL\Facades\LCLFacade;

public function myFunction()
{

    LCLFacade::notify('Invoke stream log via Facade 1');

    // Some code here

    LCLFacade::notify('Invoke stream log via Facade 2');

    // Some code here

    LCLFacade::notify('Invoke stream log via Facade 3');
    
    // or via helper
    stream_log('Invoke stream log via helper 1');
    stream_log('Invoke stream log via helper 2');     
    stream_log('Invoke stream log via helper 3');


    // or using your application
    \Log::info('Invoke stream log via application log 1');
    \Log::error('Invoke stream log via application log 2');
    \Log::debug('Invoke stream log via application log 3');

}

自定义通知库

您还可以通过修改resources/views/vendor/lcl/view.blade.php文件中的代码来自定义此内容。

自定义LCL事件

默认情况下，包使用stream-console-log事件类型进行流式传输

LCLFacade::notify($message, $type = 'info', $event = 'stream-console-log')

注意$event = 'stream-console-log'。您可以自定义此内容，例如，您想使用UserPurchase作为SSE事件类型

use Saasscaleup\LCL\Facades\LCLFacade;

public function myMethod()
{
    LCLFacade::notify('User purchase plan - step 1', 'info', 'UserPurchase');
    
    // or via helper
    stream_console_log('User purchase plan - step 1', 'info', 'UserPurchase');
}

然后您需要在视图中自行处理此事件，如下所示

<script>
var es = new EventSource("{{route('lcl-stream-log')}}");

es.addEventListener("UserPurchase", function (e) {
    var data = JSON.parse(e.data);
    alert(data.message);
}, false);

</script>

灵感来源

开源

许可证

有关更多信息，请参阅MIT。

支持 🙏😃

如果您喜欢教程并想支持我的频道，以便我继续发布将您变成令人向往的开发者的精彩内容...如果您这样做，我将非常感激

订阅我们的youtube
给我买杯咖啡 ❤️

感谢您的支持 :)

saasscaleup / laravel-console-log

维护者

详情