Implementierung der Symfony-Überwachungsbibliothek

In den letzten Monaten habe ich intensiv daran gearbeitet, das Überwachungserlebnis für Symfony-Entwickler zu erneuern. Die Symfony-Überwachungsbibliothek ist die zweitbeliebteste Bibliothek unter den Kunden von Inspector. Das erste ist das Laravel-Paket.

Die Veröffentlichung der neuesten Version des Frameworks bot die Möglichkeit, die App-Überwachung so einfach wie nie zuvor zu gestalten.

In diesem Artikel werde ich detailliert beschreiben, was diese Änderungen sind und welche Auswirkungen sie auf Ihr Überwachungserlebnis in Inspector haben.

Für weitere technische Artikel können Sie mir auf Linkedin oder X folgen.

Kompatibilität mit Doctrine 3.x

Die neueste Hauptversion des wichtigsten ORM für Symfony wurde Anfang dieses Jahres veröffentlicht. Und die Unterstützung für SQL-Logger wurde zugunsten einer neuen „Middleware-Architektur“ eingestellt.

Wir haben im Bundle eine Prüfung implementiert, um zu überprüfen, welche Version von Doctrine die Anwendung verwendet, um entsprechend einen SQL-Logger oder eine Middleware einzuschleusen.

Sammeln Sie den Routennamen

Die erste Implementierung der Symfony-Überwachungsbibliothek bestand darin, den Namen der Route zu verwenden, um den HTTP-Verkehr gegenüber Ihrer Symfony-Anwendung zu überwachen:

Wenn Sie eine neue Route in Symfony implementieren, können Sie diese grundsätzlich über ein Attribut in der Methode des Controllers deklarieren:

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

Das Route-Objekt erhält den Namen der Route als zweiten Parameter, sodass Sie diese Route innerhalb der Anwendung mithilfe ihres Namens referenzieren können, anstatt den Pfad zu schreiben. Dadurch können Sie das URL-Muster in Zukunft ändern, ohne es in jeder Codezeile ändern zu müssen, in der es erwähnt wird.

Und wenn Sie eine davon in Ihrer Überwachungsbibliothek ignorieren möchten, müssen Sie den Routennamen in der Inspector-Yaml-Konfigurationsdatei auflisten:

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

Der erste Entwickler, der mir beim Erstellen der ersten Version der Bibliothek geholfen hat, hat keine Möglichkeit gefunden, das echte URL-Muster zu erfassen, also haben wir mit dieser Implementierung fortgefahren, um die Arbeit nicht zu blockieren.

Aber die Verwendung des Routennamens zur Überwachung des HTTP-Verkehrs hat mehrere Nachteile.

Das Problem mit Routennamen

Zuerst ist der Routenname optional. Es ist offensichtlich nicht erforderlich, URLs Namen in Symfony zuzuordnen. Da viele Entwickler keine Namen verwendeten, sammelte die Bibliothek als Fallback-Daten den ultimativen Pfad wie: /users/12/profile.

Noch schlimmer ist, dass jemand Namen nur für einen Teil der Anwendung verwendet und die Transaktionsliste im Dashboard mit gemischten Formaten sieht, wobei einige Endpunkte anhand des Routennamens und andere Endpunkte mit URL überwacht werden.

Das zweite Problem war die Möglichkeit, URLs zu ignorieren, um die Überwachung in bestimmten Teilen der App zu deaktivieren. Eine Symfony-Anwendung wird normalerweise mithilfe von URL-Mustern segmentiert. Entwickler neigen dazu, alle Admin-Endpunkte unter der Haupt-URL zu gruppieren, z. B. /admin/[other sub urls] . Wenn Sie Teile Ihrer App mithilfe von Platzhaltern ignorieren möchten, könnte es einfacher sein, wenn Sie aufgrund dieser natürlichen Zuordnung (/users*) auf URLs verweisen können. Es ist schwieriger, ein einheitlicheres Muster in den Routennamen zu finden.

Außerdem handelte es sich bei den Fallback-Daten, die für den Fall erfasst wurden, dass der Name der Route nicht existiert, um die tatsächliche URL wie /users/12/profile. Jedes Mal, wenn der Endpunkt mit einer anderen ID aufgerufen wurde, generierte er eine neue Zeile in der Transaktionsliste. Es entsteht zu viel Rauschen in den Überwachungsdaten.

Sammeln Sie das Routenmuster
Routenmuster unterscheiden sich von der tatsächlichen URL, die Ihre Benutzer aufrufen. Die meisten URLs, die Sie in Ihrer Symfony-App haben, sind grundsätzlich wie /users/{id}/profile

parametrisiert

Dies ist eine typische Implementierung in einem Symfony-Controller:

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

Und das ist es, was wir in der Transaktionsliste anstelle der echten URL melden müssen. Denn auch bei der ID-Änderung muss immer derselbe Code ausgeführt werden.

Diese Änderung macht es einfacher, nicht nur bestimmte URLs, sondern auch ganze Teile Ihrer App zu ignorieren, indem Sie das Platzhalterzeichen in der Inspector-Konfigurationsdatei verwenden:

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

Für weitere technische Artikel können Sie mir auf Linkedin oder X folgen.

Überwachen Sie Ihre Symfony-Anwendung kostenlos

Inspector ist ein Tool zur Codeausführungsüberwachung, das speziell für Softwareentwickler entwickelt wurde. Sie müssen nichts auf der Infrastruktur installieren, installieren Sie einfach das Symfony-Paket und schon kann es losgehen.

Wenn Sie auf der Suche nach HTTP-Überwachung, Einblicken in Datenbankabfragen und der Möglichkeit sind, Warnungen und Benachrichtigungen an Ihre bevorzugte Messaging-Umgebung weiterzuleiten, testen Sie Inspector kostenlos. Registrieren Sie Ihr Konto.

Oder erfahren Sie mehr auf der Website: https://inspector.dev

Das obige ist der detaillierte Inhalt vonImplementierung der Symfony-Überwachungsbibliothek. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!