Symfony memantau pelaksanaan perpustakaan

Dalam beberapa bulan lepas saya bekerja keras untuk mengubah suai pengalaman pemantauan untuk pembangun Symfony. Perpustakaan pemantauan Symfony ialah perpustakaan kedua paling popular di kalangan pelanggan Inspektor. Yang pertama ialah pakej Laravel.

Pengeluaran versi terbaharu rangka kerja membawa peluang untuk menjadikan pengalaman pemantauan apl semudah sebelum ini.

Dalam artikel ini saya akan memperincikan apakah perubahan ini dan kesannya terhadap pengalaman pemantauan anda dalam Inspektor.

Untuk lebih banyak artikel teknikal, anda boleh mengikuti saya di Linkedin atau X.

Keserasian Dengan Doktrin 3.x

Versi utama terkini ORM yang paling penting untuk Symfony telah dikeluarkan pada awal tahun ini. Dan ia menggugurkan sokongan untuk pembalak SQL memihak kepada "Seni Bina Perisian Tengah" baharu.

Kami melaksanakan semakan di dalam berkas untuk mengesahkan versi Doktrin yang digunakan oleh aplikasi untuk menyuntik logger sql atau perisian tengah dengan sewajarnya.

Kumpulkan Nama Laluan

Pelaksanaan pertama pustaka pemantauan Symfony menggunakan nama laluan untuk memantau trafik http terhadap aplikasi Symfony anda:

Pada asasnya apabila anda melaksanakan laluan baharu dalam Symfony anda boleh mengisytiharkannya melalui atribut pada kaedah Pengawal:

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

Objek Laluan mendapat nama laluan sebagai parameter kedua, jadi anda boleh merujuk laluan ini di dalam aplikasi menggunakan namanya dan bukannya menulis laluan. Ini membolehkan anda menukar corak url pada masa hadapan tanpa perlu mengubahnya dalam setiap baris kod yang disebut.

Dan jika anda mahu mengabaikan salah satu daripadanya dalam pustaka pemantauan anda, anda perlu menyenaraikan nama laluan dalam fail konfigurasi yaml Inspektor:

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

Pembangun pertama yang membantu saya membina versi pertama perpustakaan tidak menemui cara untuk mengumpul corak url sebenar, jadi kami meneruskan pelaksanaan ini untuk tidak menyekat kerja.

Tetapi menggunakan nama laluan untuk memantau trafik HTTP mempunyai beberapa kelemahan.

Masalah Dengan Nama Laluan

Pertama nama laluan adalah pilihan. Jelas sekali tidak diperlukan untuk memetakan url dengan nama dalam Symfony. Banyak pembangun tidak menggunakan nama jadi kerana data sandaran, perpustakaan sedang mengumpul laluan utama seperti: /users/12/profile.

Lebih teruk lagi, seseorang menggunakan nama hanya untuk sebahagian daripada aplikasi, dan mereka melihat senarai urus niaga dalam papan pemuka dengan format bercampur, beberapa titik akhir dipantau menggunakan nama laluan dan titik akhir yang lain dengan url.

Masalah kedua ialah keupayaan untuk mengabaikan url untuk mematikan pemantauan di bahagian tertentu apl. Aplikasi Symfony biasanya dibahagikan menggunakan corak url. Pembangun cenderung untuk mengumpulkan semua titik akhir pentadbir di bawah url utama seperti /admin/[sub url lain] . jika anda ingin mengabaikan bahagian apl anda menggunakan kad bebas, mungkin lebih mudah jika anda boleh merujuk url kerana perkaitan semula jadi ini (/pengguna*). Lebih sukar untuk mencari corak yang lebih konsisten dalam nama laluan.

Selain itu, data sandaran yang dikumpul sekiranya nama laluan tidak wujud ialah url sebenar seperti /users/12/profile. Jadi setiap kali titik akhir dipanggil dengan ID yang berbeza, ia menghasilkan baris baharu dalam senarai urus niaga. Mencipta terlalu banyak hingar dalam data pemantauan.

Kumpulkan Corak Laluan
Corak Laluan berbeza daripada url sebenar yang dipanggil pengguna anda. Kebanyakan url yang anda ada dalam apl Symfony anda pada asasnya diparameterkan seperti /users/{id}/profile

Ini ialah pelaksanaan biasa dalam pengawal 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');
    }
}

Dan inilah yang perlu kami laporkan dalam senarai transaksi dan bukannya url sebenar. Kerana walaupun penukaran ID adalah kod yang sama untuk dilaksanakan.

Perubahan ini memudahkan untuk mengabaikan bukan sahaja url tertentu tetapi juga keseluruhan bahagian apl anda menggunakan aksara kad bebas dalam fail konfigurasi Inspektor:

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

Untuk lebih banyak artikel teknikal, anda boleh mengikuti saya di Linkedin atau X.

Pantau aplikasi Symfony anda secara percuma

Inspektor ialah alat Pemantauan Pelaksanaan Kod yang direka khusus untuk pembangun perisian. Anda tidak perlu memasang apa-apa pada infrastruktur, cuma pasang pakej Symfony dan anda sudah bersedia untuk pergi.

Jika anda mencari pemantauan HTTP, cerapan pertanyaan pangkalan data dan keupayaan untuk memajukan makluman dan pemberitahuan ke dalam persekitaran pemesejan pilihan anda cuba Inspektor secara percuma. Daftar akaun anda.

Atau ketahui lebih lanjut di tapak web: https://inspector.dev

Atas ialah kandungan terperinci Symfony memantau pelaksanaan perpustakaan. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!