这个项目能做什么
Rybbit Sdk For Laravel 是一个 Composer 包,将开源的隐私友好型分析平台 Rybbit 集成到 Laravel 应用中,同时提供适用于客户端和服务端的追踪 API。
核心功能:
- **Blade 指令**:`@rybbit` 标签将 Rybbit 追踪脚本注入视图,支持 `data-debounce`、`data-tag`、`data-skip-patterns`、`data-mask-patterns` 等属性。
- **服务端事件追踪**:通过 `Rybbit` 门面,将页面浏览、自定义事件、性能指标、出站点击和错误直接发送至 Rybbit 的 `/api/track` 端点。
- **用户查询**:通过 Rybbit 读取 API 查询站点用户、查找单个用户档案和设备、获取每日会话数,或删除已追踪的用户数据。
- **概览统计**:获取关键指标摘要、分桶时间序列(每日/每小时/每周)、实时访客数,以及按页面、国家、浏览器等维度的数据细分。
- **隧道代理**:默认情况下,该包注册本地路由,将追踪请求(脚本、追踪、身份识别、会话录制、站点配置)通过应用自身域名进行代理,从而规避广告拦截器和浏览器隐私屏蔽。客户端 IP 从 `X-Forwarded-For` 解析并转发。失败请求会重试,会话录制数据使用队列任务处理。
- **测试支持**:`Rybbit::fake()` 用内存间谍替换门面,记录每次调用并提供所有追踪和查询方法的断言辅助函数。
- **Laravel Boost skill**:随包附带一个 Agent Skill,供 Laravel Boost 的 AI 编码代理使用。
配置通过环境变量(`RYBBIT_SITE_ID`、`RYBBIT_HOST`、`RYBBIT_API_KEY` 等)和发布的 `config/rybbit.php` 文件驱动。该包同时支持 Rybbit Cloud 和自托管 Rybbit 实例。特性覆盖包括嵌入脚本、隧道代理、服务端事件和用户读取查询;目标、漏斗、会话和管理端点尚未覆盖。
评论
0 评分人数达到10人后显示
登录后参与讨论。