過(guò)去數(shù)か月間、私は Symfony 開(kāi)発者向けの監(jiān)視エクスペリエンスを刷新するために熱心に取り組みました。 Symfony 監(jiān)視ライブラリは、Inspector の顧客の間で 2 番目に人気のあるライブラリです。 1 つ目は Laravel パッケージです。

フレームワークの最新バージョンのリリースにより、アプリの監(jiān)視エクスペリエンスがこれまでにないほど簡(jiǎn)単になる機(jī)會(huì)がもたらされました。

この記事では、これらの変更の內(nèi)容と、Inspector での監(jiān)視エクスペリエンスに與える影響について詳しく説明します。

さらに技術(shù)的な記事については、Linkedin または X で私をフォローしてください。

Doctrine 3.x との互換性

Symfony にとって最も重要な ORM の最新メジャー バージョンは、今年の初めにリリースされました。そして、新しい「ミドルウェア アーキテクチャ」を優(yōu)先して SQL ロガーのサポートを中止しました。

アプリケーションが SQL ロガーまたはミドルウェアを挿入するために使用している Doctrine のバージョンを確認(rèn)するためのチェックをバンドル內(nèi)に実裝しました。

ルート名の収集

Symfony 監(jiān)視ライブラリの最初の実裝では、ルート名を使用して Symfony アプリケーションに対する http トラフィックを監(jiān)視していました。

基本的に、Symfony で新しいルートを?qū)g裝するときは、コントローラーのメソッドの屬性を介してそれを宣言できます。

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 オブジェクトは 2 番目のパラメーターとしてルートの名前を取得するため、パスを記述する代わりにその名前を使用してアプリケーション內(nèi)でこのルートを參照できます。これにより、言及されているコード行ごとに URL パターンを変更することなく、將來(lái) URL パターンを変更できるようになります。

監(jiān)視ライブラリ內(nèi)のそれらの 1 つを無(wú)視したい場(chǎng)合は、Inspector yaml 設(shè)定ファイルにルート名をリストする必要がありました。

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

ライブラリの最初のバージョンの構(gòu)築を手伝ってくれた最初の開(kāi)発者は、実際の URL パターンを収集する方法を見(jiàn)つけられなかったため、作業(yè)を妨げないようにこの実裝を続行しました。

しかし、ルート名を使用して HTTP トラフィックを監(jiān)視することには、いくつかの欠點(diǎn)があります。

ルート名の問(wèn)題

まず、ルート名はオプションです。明らかに、Symfony で URL を名前にマッピングする必要はありません。非常に多くの開(kāi)発者が名前を使用していなかったので、ライブラリはフォールバック データとして /users/12/profile.

のような最終的なパスを収集していました。

さらに悪いことに、誰(shuí)かがアプリケーションの一部にのみ名前を使用しており、ダッシュボードのトランザクション リストが混合形式で表示され、一部のエンドポイントはルート名を使用して監(jiān)視され、他のエンドポイントは URL で監(jiān)視されていました。

2 番目の問(wèn)題は、アプリの特定の部分で URL を無(wú)視して監(jiān)視をオフにする機(jī)能でした。 Symfony アプリケーションは通常、URL パターンを使用してセグメント化されます。開(kāi)発者は、すべての管理エンドポイントを /admin/[other sub urls] のようなメイン URL の下にグループ化する傾向があります。ワイルドカードを使用してアプリの一部を無(wú)視したい場(chǎng)合は、この自然な関連付け (/users*) により URL を參照できれば簡(jiǎn)単になります。ルート名のより一貫したパターンを見(jiàn)つけるのはさらに困難です。

さらに、ルート名が存在しない場(chǎng)合に収集されたフォールバック データは、/users/12/profile のような実際の URL でした。そのため、エンドポイントが異なる ID で呼び出されるたびに、トランザクション リストに新しい行が生成されます。監(jiān)視データにノイズが多すぎます。

ルートパターンを収集する
ルート パターンは、ユーザーが呼び出している実際の URL とは異なります。 Symfony アプリ內(nèi)の 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');
    }
}

これは、実際の URL の代わりにトランザクション リストで報(bào)告する必要があるものです。なぜならIDが変わっても実行されるコードは常に同じだからです。

この変更により、特定の URL だけでなく、Inspector 構(gòu)成ファイル內(nèi)のワイルドカード文字を使用してアプリ全體の部分も簡(jiǎn)単に無(wú)視できるようになります。

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

さらに技術(shù)的な記事については、Linkedin または X で私をフォローしてください。

Symfony アプリケーションを無(wú)料で監(jiān)視します

Inspector は、ソフトウェア開(kāi)発者向けに特別に設(shè)計(jì)されたコード実行監(jiān)視ツールです。インフラストラクチャに何もインストールする必要はありません。Symfony パッケージをインストールするだけで準(zhǔn)備完了です。

HTTP モニタリング、データベース クエリの洞察、アラートや通知を好みのメッセージング環(huán)境に転送する機(jī)能をお探しの場(chǎng)合は、Inspector を無(wú)料でお試しください。アカウントを登録してください。

または、Web サイトで詳細(xì)をご覧ください: https://inspector.dev

以上がSymfony 監(jiān)視ライブラリの実裝の詳細(xì)內(nèi)容です。詳細(xì)については、PHP 中國(guó)語(yǔ) Web サイトの他の関連記事を參照してください。