hosmelq/laravel-logsnag

将LogSnag实时事件跟踪功能集成到您的Laravel应用中。

v0.4.0 2024-04-09 20:39 UTC

This package is auto-updated.

Last update: 2024-09-09 21:26:08 UTC


README

这是一个LogSnag的非官方包。

Laravel LogSnag

轻松将LogSnag的事件跟踪集成到您的Laravel应用中。监控用户活动,获取实时分析,并快速获得洞察。

要求

此包需要PHP 8.1或更高版本以及Laravel 10.0或更高版本。

安装

您可以通过composer安装此包

composer require hosmelq/laravel-logsnag

配置

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

php artisan vendor:publish --tag="logsnag-config"

或者,您可以使用安装命令。

php artisan logsnag:install

接下来,您应该在应用程序的.env文件中配置您的LogSnag API令牌和项目名称

LOGSNAG_API_TOKEN=your-api-token
LOGSNAG_PROJECT=your-project-name

我们使用LOGSNAG_PROJECT确定要发送事件的工程。或者,您可以在创建事件或洞察时指定项目名称。

用法

发布事件

您可以使用LogSnag外观来发布事件和洞察。

use HosmelQ\LogSnag\Laravel\Facades\LogSnag;

LogSnag::log()->publish([
    'channel' => 'waitlist',
    'event' => 'User Joined Waitlist',
    'icon' => '🎉',
]);

此方法返回一个Log实例,该实例提供对LogSnag API响应的访问。有关更多信息以及可用参数的列表,请参阅LogSnag文档

发布洞察

use HosmelQ\LogSnag\Laravel\Facades\LogSnag;

LogSnag::insight()->publish([
    'icon' => '🎉',
    'title' => 'Registered Users on Waitlist',
    'value' => 8,
]);

此方法返回一个Insight实例,该实例提供对LogSnag API响应的访问。有关更多信息以及可用参数的列表,请参阅LogSnag文档

用户属性

use HosmelQ\LogSnag\Laravel\Facades\LogSnag;

LogSnag::identify()->publish([
    'properties' => [
        'email' => 'john@doe.com',
        'name' => 'John Doe',
        'plan' => 'premium',
    ],
    'user_id' => '123',
]);

此方法返回一个Identify实例,该实例提供对LogSnag API响应的访问。有关更多信息以及可用参数的列表,请参阅LogSnag文档

除了外观之外,您还可以使用logsnag辅助函数。

logsnag()->log()->publish([
    'channel' => 'waitlist',
    'event' => 'User Joined Waitlist',
    'icon' => '🎉',
]);

致谢

许可

MIT许可证(MIT)。有关更多信息,请参阅许可文件