Laravel Telescope est un outil élégant de débogage et de surveillance pour les applications Laravel. Il fournit des informations approfondies sur les demandes, les exceptions, les requêtes, les tâches et bien plus encore. Ce guide vous guidera dans l’installation, la configuration et l’utilisation de Laravel Telescope pour améliorer l’observabilité de votre application. Vous pouvez l’installer avec votre VPS.

Prérequis

Avant de configurer Telescope, assurez-vous que vous disposez des éléments suivants :

  • Une application Laravel (version 6.x ou supérieure recommandée)
  • PHP 7.3 ou plus récent
  • Composer installé sur votre machine

Etape 1 : Installer Laravel Telescope

Pour installer Laravel Telescope, lancez la commande suivante via Composer :

composer require laravel/telescope

Une fois l’installation terminée, publiez le fournisseur de service Telescope et les actifs en utilisant :

php artisan telescope:install

Enfin, migrez les tables de la base de données nécessaires :

php artisan migrate

Étape 2 : Configuration de Telescope

Après l’installation, Telescope fournit un fichier de configuration situé à config/telescope.php. Vous pouvez personnaliser les paramètres selon vos besoins.

Autorisation

Par défaut, Telescope n’est accessible que dans l’environnement local. Si vous souhaitez autoriser l’accès à d’autres environnements, modifiez la méthode gate dans

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

Conservation des données

Par défaut, Telescope conserve les journaux pendant 24 heures. Vous pouvez ajuster cette durée dans le fichier config/telescope.php:

'retain_hours' => 48,

Configuration des routes

Le tableau de bord de Telescope est accessible via /telescope. Si vous souhaitez personnaliser ce chemin, mettez à jour votre fichier config/telescope.php:

'path' => 'monitoring',

Désormais, Telescope sera disponible dans /monitoring au lieu de /telescope.

Étape 3 : Utilisation de Telescope

Une fois configuré, démarrez votre application Laravel et visitez yourdomain.com/telescope (ou votre chemin personnalisé). Vous verrez :

  • Requêtes: Surveille les demandes entrantes et leurs temps de réponse.
  • Exceptions: Liste toutes les erreurs et les traces de pile.
  • Requêtes: Affiche les requêtes SQL exécutées.
  • Jobs: Surveille les travaux en file d’attente et leur état.
  • Événements: Enregistre les événements Laravel.

Étape 4 : Déploiement de Telescope en production

Alors que Telescope est utile pour le développement, il n’est pas recommandé pour la production en raison de la surcharge de performance. Cependant, si vous avez besoin de le déployer en production, vous pouvez utiliser la variable d’environnement TELESCOPE_ENABLED:

TELESCOPE_ENABLED=true

De plus, planifiez une commande pour effacer les journaux périodiquement afin d’éviter une croissance excessive de la base de données :

php artisan telescope:prune --hours=24

Vous pouvez automatiser ceci en ajoutant une tâche programmée dans app/Console/Kernel.php:

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

Conclusion

Laravel Telescope est un outil puissant qui améliore le débogage et la surveillance des applications Laravel. En l’installant et en le configurant correctement, vous obtiendrez des informations précieuses sur les performances de votre application, les requêtes, les exceptions et les tâches d’arrière-plan.