在過去的幾個(gè)月里，我投入了大量精力來改進(jìn) Symfony 開發(fā)人員的監(jiān)控體驗(yàn)。 Symfony 監(jiān)控庫是 Inspector 客戶中第二受歡迎的庫。第一個(gè)是 Laravel 包。

最新版本框架的發(fā)布帶來了讓應(yīng)用監(jiān)控體驗(yàn)變得前所未有的簡(jiǎn)單的機(jī)會(huì)。

在本文中，我將詳細(xì)介紹這些更改是什么，以及它們對(duì)您在 Inspector 中的監(jiān)控體驗(yàn)的影響。

想要了解更多技術(shù)文章，您可以在 Linkedin 或 X 上關(guān)注我。

與 Doctrine 3.x 的兼容性

Symfony 最重要的 ORM 的最新主要版本于今年年初發(fā)布。它放棄了對(duì) SQL 記錄器的支持，轉(zhuǎn)而采用新的“中間件架構(gòu)”。

我們?cè)诎鼉?nèi)實(shí)現(xiàn)了一項(xiàng)檢查，以驗(yàn)證應(yīng)用程序使用哪個(gè)版本的 Doctrine 來相應(yīng)地注入 sql 記錄器或中間件。

收集路線名稱

Symfony 監(jiān)控庫的第一個(gè)實(shí)現(xiàn)是使用路由名稱來監(jiān)控 Symfony 應(yīng)用程序的 http 流量：

基本上，當(dāng)你在 Symfony 中實(shí)現(xiàn)新路由時(shí)，你可以通過控制器方法上的屬性來聲明它：

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 對(duì)象獲取路由的名稱作為第二個(gè)參數(shù)，因此您可以使用其名稱在應(yīng)用程序內(nèi)引用此路由，而無需編寫路徑。這允許您將來更改 url 模式，而無需在提到的每一行代碼中進(jìn)行更改。

如果你想忽略監(jiān)控庫中的其中一個(gè)，你必須在 Inspector yaml 配置文件中列出路由名稱：

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

第一個(gè)幫助我構(gòu)建該庫的第一個(gè)版本的開發(fā)人員沒有找到收集真實(shí) url 模式的方法，因此我們繼續(xù)執(zhí)行此實(shí)現(xiàn)，以免阻礙工作。

但是使用路由名稱來監(jiān)控 HTTP 流量有幾個(gè)缺點(diǎn)。

路線名稱的問題

首先，路線名稱是可選的。顯然不需要在 Symfony 中將 url 與名稱進(jìn)行映射。許多開發(fā)人員沒有使用名稱，因此庫正在收集最終路徑作為后備數(shù)據(jù)，例如：/users/12/profile。

更糟糕的是，有人僅在應(yīng)用程序的一部分中使用名稱，他們?cè)趦x表板中看到混合格式的事務(wù)列表，一些端點(diǎn)使用路由名稱進(jìn)行監(jiān)控，而其他端點(diǎn)則使用 url。

第二個(gè)問題是能夠忽略 url 以關(guān)閉應(yīng)用程序某些部分的監(jiān)控。 Symfony 應(yīng)用程序通常使用 url 模式進(jìn)行分段。開發(fā)人員傾向于將所有管理端點(diǎn)分組在主 url 下，例如 /admin/[other sub urls] 。如果您想使用通配符忽略應(yīng)用程序的某些部分，由于這種自然關(guān)聯(lián)（/users*），您可以引用網(wǎng)址，這可能會(huì)更容易。在路線名稱中找到更一致的模式更加棘手。

此外，在路由名稱不存在的情況下收集的后備數(shù)據(jù)是真實(shí)的 URL，如 /users/12/profile。因此，每次使用不同的 ID 調(diào)用端點(diǎn)時(shí)，它都會(huì)在事務(wù)列表中生成一個(gè)新行。在監(jiān)控?cái)?shù)據(jù)中產(chǎn)生太多噪音。

收集路線模式
路由模式與用戶調(diào)用的真實(shí) URL 不同。 Symfony 應(yīng)用程序中的大多數(shù) url 基本上都是參數(shù)化的，例如 /users/{id}/profile

這是 Symfony 控制器中的典型實(shí)現(xiàn)：

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');
    }
}

這就是我們需要在交易列表中報(bào)告的內(nèi)容，而不是真實(shí)的網(wǎng)址。因?yàn)榧词笽D改變也總是執(zhí)行相同的代碼。

此更改不僅可以更輕松地忽略特定 URL，還可以使用 Inspector 配置文件中的通配符忽略應(yīng)用程序的整個(gè)部分：

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

想要了解更多技術(shù)文章，您可以在 Linkedin 或 X 上關(guān)注我。

免費(fèi)監(jiān)控您的 Symfony 應(yīng)用程序

Inspector是一款專為軟件開發(fā)人員設(shè)計(jì)的代碼執(zhí)行監(jiān)控工具。您無需在基礎(chǔ)設(shè)施上安裝任何內(nèi)容，只需安裝 Symfony 軟件包即可開始使用。

如果您正在尋找 HTTP 監(jiān)控、數(shù)據(jù)庫查詢見解以及將警報(bào)和通知轉(zhuǎn)發(fā)到您首選消息傳遞環(huán)境的功能，請(qǐng)免費(fèi)嘗試 Inspector。注冊(cè)您的帳戶。

或在網(wǎng)站上了解更多信息：https://inspector.dev

以上是Symfony 監(jiān)控庫實(shí)現(xiàn)的詳細(xì)內(nèi)容。更多信息請(qǐng)關(guān)注PHP中文網(wǎng)其他相關(guān)文章！