izpixel/laravel-tracker

Laravel应用程序的基本请求、设备和地理位置跟踪器。

dev-main 2024-04-15 00:55 UTC

This package is auto-updated.

Last update: 2024-09-15 01:57:48 UTC


README

欢迎使用Laravel Tracker,这是一个专为无缝集成到您的Laravel应用程序而设计的强大跟踪工具。本软件包提供全面的跟踪功能,使您能够有效地监控和分析用户与应用程序之间的交互。

特性

  • 易于集成:与任何Laravel应用程序无缝集成,配置简单。
  • 数据加密:支持对敏感数据进行加密,以保护用户隐私。
  • 自定义跟踪:灵活的配置选项允许您指定要跟踪的数据。
  • 中间件集成:包含中间件以捕获数据而不影响页面加载时间。
  • 日志和缓存:提供广泛的日志和缓存选项以增强性能和调试能力。
  • 排除规则:可以排除特定的IP地址以进行跟踪。

安装

要安装此软件包,请在您的Laravel项目中运行以下命令

composer require izpixel/laravel-tracker

配置

安装后,使用以下命令发布配置文件

php artisan vendor:publish --tag=laravel-tracker::config

此命令将发布一个tracker.php配置文件到您的配置目录。请参阅config-guide.md文件以获取每个配置选项的详细说明。

使用

Laravel Tracker会自动将跟踪中间件应用到config/tracker.php文件下route_groups中指定的路由组。默认情况下,它设置为跟踪'web'组,但您可以调整此设置以包括任何组,例如'api'。

要添加或自定义中间件,您可以在配置文件的middleware设置中指定您自己的中间件类。如果您创建了自定义中间件,那么在中间件的terminate方法中调用LaravelTracker::collect()至关重要。

为什么要使用terminate方法?

中间件的terminate方法允许在HTTP响应发送到客户端后执行任务。这对于耗时且不影响响应本身的任务非常有用,例如日志记录、发送电子邮件或在我们的案例中,跟踪。使用terminate方法可以确保这些操作不会延迟您的网页或API响应的渲染,从而通过减少感知的加载时间来提高用户体验。

以下是如何使用terminate方法配置和实现自定义中间件的示例

// In your custom middleware
public function terminate(Request $request, Response $response): void
{
    \Izpixel\LaravelTracker\Facades\LaravelTracker::collect();
}

有关中间件和terminate方法的更详细信息,请参阅官方Laravel文档

有关如何设置和自定义跟踪器的更多信息,请参阅config-guide.md。

变更日志

请参阅变更日志以获取最近更改的详细信息。

贡献

请参阅贡献以获取详细信息。

安全

如果您发现任何安全问题,请通过电子邮件dev@izpixel.com而不是使用问题跟踪器。

支持

有关支持,请在GitHub存储库中打开一个问题或联系我们的支持团队opensource@izpixel.com

感谢您使用Laravel Tracker!

许可证

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