跳转到内容
集成指南

Laravel 结构化日志记录和队列分析

将 Laravel 请求、命令、队列和计费结果作为类型化事件发送,而不会暴露应用程序机密或有效负载。

审阅者 Telemetry产品团队 上 . 我们检查了要发送的事件、要排除的数据和代码添加方法. 谁负责审核此页面

有用于
  • Laravel API 可靠性
  • 队列监控
  • 计费工作流程分析
实施证据

使用 Laravel structured logging and queue analytics 发送并验证事件

在受控应用程序边界使用 Laravel structured logging and queue analytics,保持事件契约较小,并在构建聚合视图之前验证已知结果。

  1. 1

    选择结果

    Laravel API 可靠性

  2. 2

    定义合同

    route_name 或 job_name、状态和 duration_ms

  3. 3

    在结果处发出

    使用路由名称而不是原始 URL,并且切勿批量发送请求输入。

  4. 4

    核实证据

    Exercise a known fixture, then inspect job_completed for one correctly typed terminal row.

开始之前

开始之前

  • 服务器端TELEMETRY_API_KEY
  • Laravel HTTP 客户端超时配置
  • 命名路由和队列作业

交货设置

安装并初始化服务器端

使用 Laravel 的共享 HTTP 客户端或 PHP cURL 以及服务器端密钥以及显式连接和请求超时。 将摄取凭据保留在浏览器包、客户端可见的环境变量、源代码控制、日志和异常消息之外。

  1. 1准备一个具有有限网络行为的可重用服务器端交付客户端。
  2. 2在成功、失败、重试或超时边界处添加结果事件。
  3. 3在启用警报之前发送受控装置并检查存储的行。

片段

从一个结构化事件开始

在工作流程完成、失败或重试的位置添加此形状。然后从真实的字段构建仪表板。

laravel

Laravel structured logging and queue analytics事件

php
use Illuminate\Support\Facades\Http;

// Existing job work has completed; $job and numeric $durationMs come from your worker.
try {
    $response = Http::withHeaders([
        'Authorization' => config('services.telemetry.key'),
    ])
        ->connectTimeout(1)
        ->timeout(2)
        ->post('https://api.telemetry.sh/log', [
            'table' => 'job_completed',
            'data' => [
                'job_name' => get_class($job),
                'queue_name' => $job->queue,
                'status' => 'success',
                'attempt' => $job->attempts(),
                'duration_ms' => $durationMs,
                'release' => config('app.release'),
            ],
        ]);

    if (!$response->successful()) {
        error_log('Telemetry delivery failed (non-2xx response).');
    }
} catch (\Throwable $error) {
    error_log('Telemetry delivery failed (transport or configuration error).');
}
// Continue with the original job result; do not retry the job because this send failed.

事件结构

route_name 或 job_name、状态和 duration_ms

尝试、queue_name、error_type 和释放

request_id 加上安全帐户标识符

检查配置

检查站 1

使用路由名称而不是原始 URL,并且切勿批量发送请求输入。

检查站 2

记录队列尝试,并在重试时保留逻辑作业 ID。

检查站 3

捕获遥测传输失败,而无需替换已完成的应用程序响应。

检查站 4

此示例在队列任务的一次尝试成功后运行。保留任务原有的结果和错误处理;尝试事件不能证明下游交付或逻辑任务已完成。

检查站 5

设置有限的连接和请求超时,检查非 2xx 响应,并在本地报告交付失败,不记录密钥、响应正文或异常文本。此示例不重试,也不保证交付。

验证

证明事件已到达

在演练已知的成功和失败案例后运行此命令。如果您的最终事件契约与代码片段不同,请替换后备表名称。

laravel-验证

Laravel structured logging and queue analytics 验证查询

sql
SELECT *
FROM job_completed
ORDER BY timestamp_utc DESC
LIMIT 20;
确认每个逻辑结果的一个终端行,以及预期状态、标识符、单位和 UTC 时间。
检查推断的架构并验证重试不会更改字段类型或生成新的逻辑事件 ID。
在存储的字段中搜索凭据、原始有效负载、提示、私有内容和无限制的错误消息。
在将仪表板视为完整之前,请执行提供程序超时、摄取拒绝和进程关闭。

实施参考

在启用新的生产路径之前,请检查事件合同、数据安全指南和上游主要文档。

在哪里记录事件

保持结果事件小且可恢复

该模式提供了

  • 除了上游工作流程之外,还有一个有界的、SQL 就绪的结果。
  • 用于仪表板、警报和跨事件关联的稳定字段。
  • 用于验证成功、失败、重试和超时行为的夹具驱动路径。

该模式不提供

  • OTLP 导出器、自动收集管道或详细跟踪和诊断日志的替代品。
  • 仅因为有效负载包含事件 ID,所以仅传送一次。
  • 收集原始提供商有效负载、用户内容、凭证或受监管数据的权限。

事件模式示例

在将查询或代码片段适应生产之前,请检查行粒度、发出边界、所需类型、隐私类、示例有效负载和验证清单。

相关产品功能

继续此工作流程 仪表板

将经过验证的产品或收入查询转变为集中的决策界面。

相关 SQL 查询示例

更多 SQL 示例

针对此工作流程中的结构化字段运行查询,检查示例结果,并将有用的答案转换为仪表板或警报。

浏览所有查询示例

按实施系列浏览

比较相关集成模式

与此集成配对的模板

更多集成