pirsch-analytics/laravel-pirsch

Pirsch Analytics 的官方 Laravel 集成。

0.4.9 2024-03-05 19:34 UTC

This package is auto-updated.

Last update: 2024-09-14 10:28:31 UTC


README

Packagist Version Packagist Downloads

Pirsch for Laravel

本包是 Pirsch Analytics 的官方 Laravel 集成。

安装

  1. 安装此包

    composer require pirsch-analytics/laravel-pirsch
  2. 将 Pirsch 访问令牌添加到您的 .env 文件。在非生产环境中留空以禁用跟踪

    1. 访问 Pirsch "集成" 设置页面

    2. 确保页面左上角选择的是正确的域名。

    3. 滚动到 "客户端" 部分,并点击 "添加客户端" 按钮。

    4. 选择 "访问密钥(只写)" 作为类型,并输入描述。

    5. 点击 "创建客户端" 按钮,并复制生成的 "客户端密钥"。

    6. 将复制的令牌添加到您的 .env 文件

      # ...
      
      PIRSCH_TOKEN=pa_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

用法

跟踪页面访问量

自动

此包包含一个 TrackPageview 中间件,允许您自动跟踪页面访问量。通过在 bootstrap/app.php 文件中的 withMiddleware 方法中附加它来将中间件应用于您的 Web 路由

->withMiddleware(function (Middleware $middleware) {
    $middleware->web(append: [
        \Pirsch\Http\Middleware\TrackPageview::class,
    ]);
})

手动

如果您想手动跟踪页面访问量,可以使用 Pirsch::track() 方法。不带任何参数调用此方法将跟踪当前 HTTP 请求的页面访问量

use Pirsch\Facades\Pirsch;

Pirsch::track();

跟踪事件

Pirsch 允许您 跟踪自定义事件 以衡量更多信息。您可以使用带名称和可选元数据的 Pirsch::track() 方法来跟踪事件

use Pirsch\Facades\Pirsch;

Pirsch::track(
    name: 'Button clicked',
    meta: [
        'Label' => 'Get started',
    ],
);