本文介绍如何在 laravel 项目中使用 sentry 的 before_send 选项,通过客户端过滤事件,从而减少重复事件的发送,有效控制事件配额。通过示例代码,详细讲解如何在 config/sentry.php 中配置 before_send_transaction 函数,实现根据 URL 过滤 Sentry 事务。
Sentry 是一个强大的错误追踪和性能监控平台,但在高流量的应用中,可能会产生大量的事件,从而快速消耗事件配额。如果你的 Sentry 计划不支持服务端限流,客户端过滤事件就成为一个重要的优化手段。before_send 选项允许你在事件发送到 Sentry 之前对其进行检查和修改,甚至完全丢弃。
配置 before_send_transaction
before_send_transaction 是一个配置选项,允许你在事务发送到 Sentry 之前对其进行拦截和处理。它接收一个 SentryEvent 对象作为参数,并返回一个 SentryEvent 对象或 NULL。如果返回 null,则该事件将被丢弃,不会发送到 Sentry。
要配置 before_send_transaction,你需要修改 config/sentry.php 文件。在该文件中,找到 ‘before_send_transaction’ 选项,并将其设置为一个闭包函数。
'before_send_transaction' => function ( SentryEvent $transaction ): ?SentryEvent { // 在这里编写你的过滤逻辑 return $transaction; // 或者 return null; },
示例:根据 URL 过滤事务
以下示例展示了如何根据 URL 过滤 Sentry 事务。假设你希望忽略所有包含 _debugbar、monitoring 或 pleaseignoreme 的 URL 的事务。
'before_send_transaction' => function ( SentryEvent $transaction ): ?SentryEvent { $ignore = ['_debugbar', 'monitoring', 'pleaseignoreme']; $request = $transaction->getRequest(); // 确保 $request 不为空,否则访问 ['url'] 会报错 if (!empty($request) && isset($request['url'])) { $check = array_filter($ignore, function ($url) use ($request) { if (stripos($request['url'], $url) !== false) { return true; } }); if (count($check) > 0) { return null; } } return $transaction; },
代码解释:
- $ignore 数组包含了需要忽略的 URL 片段。
- $transaction->getRequest() 获取事务的请求信息。
- array_filter 函数遍历 $ignore 数组,并使用 stripos 函数检查请求 URL 是否包含任何需要忽略的片段。
- 如果找到任何需要忽略的片段,则返回 null,丢弃该事务。
- 否则,返回原始的 $transaction 对象,允许该事务发送到 Sentry。
注意事项:
- 在检查 $request[‘url’] 之前,务必确保 $request 不为空,并使用 isset() 检查 ‘url’ 键是否存在,避免出现 undefined index: url 错误。
- stripos 函数执行不区分大小写的搜索。如果你需要区分大小写,可以使用 strpos 函数。
其他过滤策略
除了根据 URL 过滤事务,你还可以使用 before_send 选项实现其他各种过滤策略,例如:
- 根据用户 ID 过滤: 忽略特定用户的事件。
- 根据错误类型过滤: 忽略特定类型的错误,例如 404 错误。
- 根据环境过滤: 只在生产环境中发送特定类型的事件。
- 根据事件重复率过滤: 记录一段时间内同一事件的出现次数,超过阈值则丢弃。 (需要结合缓存或数据库实现)
总结
before_send 选项提供了一种强大的方式来控制发送到 Sentry 的事件,从而减少重复事件的发送,有效控制事件配额。通过合理配置 before_send_transaction 函数,你可以根据 URL、用户 ID、错误类型等多种条件过滤事件,从而更好地管理你的 Sentry 数据。记住,在实施任何过滤策略之前,请仔细评估其对错误追踪和性能监控的影响。