آموزش استفاده از Laravel Telescope برای دیباگ کردن پروژه های لاراول

لاروال تلسکوپ (Laravel Telescope) یک ابزار منبع باز (open source) برای دیباگ کردن پروژه های لاراول می باشد که امکانات بسیاری برای دیباگ کردن و مشاهده فرآیند های اپلیکیشن لاراول از کنترل و مشاهده عملیات های دیتابیس تا ارسال های ایمیل و Notification و... به شما خواهد داد. شما می توانید این ابزار اپن سورس را از گیت هاب دانلود و استفاده نمایید.

در این مطلب با همدیگه این دیباگر مشهور لاراول رو بررسی می کنیم, با ما همراه باشید:

Laravel Telescope چیست؟

لاراول تلسکوپ یک ابزار دیباگ می باشد که مجموعه از امکانات مختلف را برای مانیتورینگ درخواست های HTTP, Scheduler or Queue و ... می باشد.

Laravel Telescope همه ی اطلاعات مربوط به درخواست ها و فعالیت ها همچون درخواست های HTTP, زمان اجرای query ها و... را ذخیره و کش می کند.

نصب Laravel Telescope

برای نصب laravel telescope دستور زیر را در کامند لاین اپلیکیشن خود اجرا نمایید:

composer require laravel/telescope --dev

حال برای ایجاد فایل های مربوطه و دیتابیس دو دستور زیر را در ترمینال اپلیکیشن خود اجرا نمایید:

php artisan telescope:install
php artisan migrate

حال می توانید به روت /telescope رفته و تلسکوپ را مشاهده نمایید:

پیکربندی:

برای مشاهده تنظیمات و پیکربندی تلسکوپ به فایل config/telescope.php بروید. در این فایل تنظیمات مربوط به این پکیج موجود می باشد که برخی از آنها بشرح ذیل می باشد:

path:

این ایتم آدرس روت برنامه تلسکوپ را برای دسترسی به برنامه در دسترس قرار می دهد که بصورت پیشفرض telescope می باشد.

driver:

محل ذخیره سازی اطلاعات می باشد. که بصورت پیشفرض database می باشد.

storage:

اطلاعات اتصال به پایگاه داده را شامل می شود.

limit:

این گزینه میزان ذخیره سازی در هر بار debug را مشخص می کند که بصورت پیش فرض ۱۰۰ می باشد.

محدود کردن دسترسی به telescope:

بصورت محلی همه کاربران می توانند به تلسکوپ دسترسی داشته باشند که این مورد برای ما خوب نیست. شما با استفاده از گیت می توانید دسترسی به تلسکوپ را محدود کنید. فایل app/Providers/TelescopeServiceProvider.php را باز و آن را مطابق زیر تغییر دهید:

/**
 * Register the Telescope gate.
 *
 * This gate determines who can access Telescope in non-local environments.
 *
 * @return void
 */
protected function gate()
{
    Gate::define('viewTelescope', function ($user) {
        return in_array($user->email, [
            //
        ]);
    });
}

 کافیست در پارامتر دوم in_array ایمیل کاربرانی که می خواهید به تلسکوپ دسترسی داشته باشند را قرار دهید.

البته شما از روش های دیگری نیز می توانید محدودیت های مورد نظر خود را اعمال نمایید.

امکانات Laravel Telescope:

Laravel Telescope گزینه های متعددی داره و تقریبا همه پردازش های اپلیکیشن رو کنترل میکنه. در زیر به چند قابلیت این پکیج اشاره خواهیم کرد.

Requests:

این تب همه درخواست های دریافتی HTTP را مانیتور و برای شما بصورت زیر نمایش می دهد.

Commands:

تب Commands همه Command های اجرا شده و خروجی آن  ها به همراه متغیر ها و دیگر موارد مربوط به Command ها را نمایش میدهد.

Exceptions:

در این بخش شما می توانید تمام Exceptions های رخ داده را به همراه نوع, برچست, کاربر لاگین شده و... مشاهده نمایید.

Logs:

در این تب می توانید لاگ های خود را مشاهده نمایید

Queries:

در این تب می توانید Queries های انجام شده, زمان اجرا و... را بصورت لیست وار مشاهده نمایید:

Models:

در این تب می توانید تغییرات در مدل ها مانند create, update, delete را به همراه جزئیات مشاهده نمایید:

Mail:

در این تب نیز اطلاعات مربوط به ایمیل ها, دریافت کننده, در صف بودن یا نبودن, زمان خروج از صف, پیش نمایش ایمیل و.. را می توانید مشاهده کنید:

Notifications:

در این تب نیز اطلاعات کاملی در مورد Notification ها دریافت خواهید کرد:

لاراول تلسکوپ همچنین اطلاعات دیگری در مورد Schedule, Jobs,, Dumps, Gates, Events, Cache and Redis ها در اختیار شما قرار می دهد که می توانید با استفاده از آن به بهترین شکل ممکن اپلیکیشن خود را مدیریت نمایید.

سوالات یا پیشنهادات خودتون رو از بخش نظرات برای ما ارسال کنید