Symfony 监控库实现

在过去的几个月里，我投入了大量精力来改进 Symfony 开发人员的监控体验。 Symfony 监控库是 Inspector 客户中第二受欢迎的库。第一个是 Laravel 包。

最新版本框架的发布带来了让应用监控体验变得前所未有的简单的机会。

在本文中，我将详细介绍这些更改是什么，以及它们对您在 Inspector 中的监控体验的影响。

想要了解更多技术文章，您可以在 Linkedin 或 X 上关注我。

与 Doctrine 3.x 的兼容性

Symfony 最重要的 ORM 的最新主要版本于今年年初发布。它放弃了对 SQL 记录器的支持，转而采用新的“中间件架构”。

我们在包内实现了一项检查，以验证应用程序使用哪个版本的 Doctrine 来相应地注入 sql 记录器或中间件。

收集路线名称

Symfony 监控库的第一个实现是使用路由名称来监控 Symfony 应用程序的 http 流量：

基本上，当你在 Symfony 中实现新路由时，你可以通过控制器方法上的属性来声明它：

namespace App\Controller;

use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Attribute\Route;

class HomeController
{
    #[Route('/', name: 'app_homepage')]
    public function home()
    {
        return new Response('Home Page');
    }

    #[Route('/landing', name: 'app_landing')]
    public function landing()
    {
        return new Response('Landing Page');
    }
}

Route 对象获取路由的名称作为第二个参数，因此您可以使用其名称在应用程序内引用此路由，而无需编写路径。这允许您将来更改 url 模式，而无需在提到的每一行代码中进行更改。

如果你想忽略监控库中的其中一个，你必须在 Inspector yaml 配置文件中列出路由名称：

inspector:
    ingestion_key: '%env(INSPECTOR_INGESTION_KEY)%'
    ignore_routes:
        - 'app_landing'

第一个帮助我构建该库的第一个版本的开发人员没有找到收集真实 url 模式的方法，因此我们继续执行此实现，以免阻碍工作。

但是使用路由名称来监控 HTTP 流量有几个缺点。

路线名称的问题

首先，路线名称是可选的。显然不需要在 Symfony 中将 url 与名称进行映射。许多开发人员没有使用名称，因此库正在收集最终路径作为后备数据，例如：/users/12/profile。

更糟糕的是，有人仅在应用程序的一部分中使用名称，他们在仪表板中看到混合格式的事务列表，一些端点使用路由名称进行监控，而其他端点则使用 url。

第二个问题是能够忽略 url 以关闭应用程序某些部分的监控。 Symfony 应用程序通常使用 url 模式进行分段。开发人员倾向于将所有管理端点分组在主 url 下，例如 /admin/[other sub urls] 。如果您想使用通配符忽略应用程序的某些部分，由于这种自然关联（/users*），您可以引用网址，这可能会更容易。在路线名称中找到更一致的模式更加棘手。

此外，在路由名称不存在的情况下收集的后备数据是真实的 URL，如 /users/12/profile。因此，每次使用不同的 ID 调用端点时，它都会在事务列表中生成一个新行。在监控数据中产生太多噪音。

收集路线模式
路由模式与用户调用的真实 URL 不同。 Symfony 应用程序中的大多数 url 基本上都是参数化的，例如 /users/{id}/profile

这是 Symfony 控制器中的典型实现：

namespace App\Controller;

use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Attribute\Route;

class HomeController
{
    #[Route('/', name: 'app_homepage')]
    public function home()
    {
        return new Response('Home Page');
    }

    #[Route('/landing', name: 'app_landing')]
    public function landing()
    {
        return new Response('Landing Page');
    }
}

这就是我们需要在交易列表中报告的内容，而不是真实的网址。因为即使ID改变也总是执行相同的代码。

此更改不仅可以更轻松地忽略特定 URL，还可以使用 Inspector 配置文件中的通配符忽略应用程序的整个部分：

inspector:
    ingestion_key: '%env(INSPECTOR_INGESTION_KEY)%'
    ignore_routes:
        - 'app_landing'

想要了解更多技术文章，您可以在 Linkedin 或 X 上关注我。

免费监控您的 Symfony 应用程序

Inspector是一款专为软件开发人员设计的代码执行监控工具。您无需在基础设施上安装任何内容，只需安装 Symfony 软件包即可开始使用。

如果您正在寻找 HTTP 监控、数据库查询见解以及将警报和通知转发到您首选消息传递环境的功能，请免费尝试 Inspector。注册您的帐户。

或在网站上了解更多信息：https://inspector.dev

以上是Symfony 监控库实现的详细内容。更多信息请关注PHP中文网其他相关文章！