Laravel Telescope – це елегантний інструмент для налагодження та моніторингу додатків на Laravel. Він надає глибоке розуміння запитів, винятків, запитів, завдань тощо. Цей посібник допоможе вам встановити, налаштувати та використовувати Laravel Telescope для покращення спостережуваності вашого додатку. Ви можете встановити його разом з вашим VPS.

Необхідні умови

Перед налаштуванням Telescope переконайтеся, що у вас є наступне:

  • Додаток на Laravel (рекомендується версія 6.x або вище)
  • PHP 7.3 або новішої версії
  • Composer встановлено на вашому комп’ютері

Крок 1: Встановлення Laravel Telescope

Щоб встановити Laravel Telescope, виконайте наступну команду за допомогою Composer:

composer require laravel/telescope

Після завершення інсталяції опублікуйте інформацію про постачальника послуг Telescope і використовувані ресурси:

php artisan telescope:install

Нарешті, перенесіть необхідні таблиці бази даних:

php artisan migrate

Крок 2: Налаштування Telescope

Після встановлення Telescope надає конфігураційний файл, розташований за адресою config/telescope.php. Ви можете налаштувати параметри за потребою.

Авторизація

За замовчуванням Telescope доступний лише в локальному середовищі. Якщо ви хочете дозволити доступ в інших середовищах, змініть метод gate в

App\Providers\TelescopeServiceProvider:

use Laravel\Telescope\Telescope;
use Laravel\Telescope\TelescopeApplicationServiceProvider;

class TelescopeServiceProvider extends TelescopeApplicationServiceProvider
{
protected function gate()
{
Gate::define('viewTelescope', function ($user) {
return in_array($user->email, [
'admin@example.com',
]);
});
}
}

Зберігання даних

За замовчуванням Telescope зберігає журнали протягом 24 годин. Ви можете налаштувати це у файлі config/telescope.php:

'retain_hours' => 48,

Конфігурація маршруту

Панель інструментів Telescope доступна через /telescope. Якщо ви хочете змінити цей шлях, оновіть файл config/telescope.php:

'path' => 'monitoring',

Тепер Telescope буде доступний за адресою /monitoring замість /telescope.

Крок 3: Використання Telescope

Після налаштування запустіть ваш додаток Laravel і перейдіть за адресою yourdomain.com/telescope (або за вашим власним шляхом). Ви побачите:

  • Запити: Відстежує вхідні запити і час відповіді на них.
  • Винятки: Показує всі помилки і трасування стека.
  • Запити: Показує виконані SQL-запити.
  • Завдання: Відстежує завдання в черзі та їхні статуси.
  • Події: Журнал подій Laravel.

Крок 4: Розгортання Telescope у виробництві

Хоча Telescope корисний у розробці, його не рекомендується використовувати у виробництві через накладні витрати на продуктивність. Однак, якщо вам потрібно розгорнути його у виробництві, ви можете використати змінну середовища TELESCOPE_ENABLED:

TELESCOPE_ENABLED=true

Крім того, заплануйте команду для періодичного очищення журналів, щоб запобігти надмірному зростанню бази даних:

php artisan telescope:prune --hours=24

Ви можете автоматизувати цей процес, додавши завдання за розкладом в app/Console/Kernel.php:

$schedule->command('telescope:prune --hours=24')->daily();

Висновок

Laravel Telescope – це потужний інструмент, який покращує налагодження та моніторинг в додатках на Laravel. Встановивши та налаштувавши його належним чином, ви отримаєте цінну інформацію про продуктивність вашого додатку, запити, винятки та фонові завдання.