Weave Code
Telescope Laravel Package
laravel/telescope
Laravel Telescope is a debug assistant for Laravel that provides a rich dashboard of requests, exceptions, logs, database queries, queued jobs, mail, notifications, cache activity, scheduled tasks, and more—ideal for local development and troubleshooting.
An elegant debug assistant for the Laravel framework.
Frequently asked questions about Telescope
- How do I install Laravel Telescope in my Laravel project?
- Install Telescope via Composer using `composer require laravel/telescope`. Then, publish its assets and configuration with `php artisan telescope:install`. Run the migrations with `php artisan migrate`, and add the Telescope middleware to your routes. For Laravel 10+, ensure you’re using PHP 8.1+ and Telescope v5.x.
- Can I use Telescope in production?
- Telescope is designed for development only. Enabling it in production risks exposing sensitive data. Use middleware like `telescope:ignore` or IP whitelisting to restrict access. For production monitoring, consider tools like Sentry or Datadog alongside Telescope for local debugging.
- Does Telescope work with Laravel 13?
- Yes, Telescope v5.x supports Laravel 10–13. Check the [release notes](https://github.com/laravel/telescope/releases) for version-specific compatibility. If you’re on an older Laravel version (e.g., 9.x), use Telescope v4.x, which supports PHP 8.0+.
- How do I customize Telescope to track specific events?
- Extend Telescope by creating custom watchers. For example, to track a custom event, create a `CustomEventWatcher` class extending `Watcher` and register it in `config/telescope.php` under `watchers`. You can also override default watchers like `JobWatcher` or `RequestWatcher` to filter or transform data.
- Why does Telescope slow down my application?
- Telescope introduces minimal overhead during development, but high-traffic apps may experience database load from storing entries. Use the `telescope:prune` command to clean old entries or disable Telescope in staging/production. For production, avoid tracking sensitive data like request payloads or exceptions.
- How do I redact sensitive data (e.g., passwords, tokens) from Telescope logs?
- Use Telescope’s middleware to filter or redact data. For example, add `telescope:ignore` middleware to routes handling sensitive requests. Alternatively, create a custom watcher to sanitize data before storage. The `IGNORE_EXCEPTIONS` config can also hide specific exceptions.
- Does Telescope support Laravel Sanctum or Passport for authentication?
- Yes, Telescope integrates with Laravel’s auth system, including Sanctum and Passport. Ensure your auth provider is configured (e.g., Sanctum’s API tokens or Passport’s guards). Telescope will automatically respect your existing auth middleware, so only authorized users can access it.
- Can I monitor queued jobs with Telescope?
- Absolutely. Telescope tracks queued jobs out of the box, including job payloads, exceptions, and processing times. For Laravel 11+, it also integrates with Reverb for real-time job monitoring. Ensure your queue workers (e.g., Redis, database) are running and configured in `config/queue.php`.
- How do I disable Telescope for specific routes or exceptions?
- Use the `telescope:ignore` middleware to exclude routes. For exceptions, add them to the `IGNORE_EXCEPTIONS` array in `config/telescope.php`. You can also create a custom middleware to filter entries dynamically, such as skipping requests from certain IPs or containing sensitive data.
- What are the alternatives to Laravel Telescope for debugging?
- Alternatives include **Laravel Debugbar** (for real-time HTTP/DB debugging), **Sentry** (error tracking), **Datadog/Laravel Observability** (production monitoring), and **Laravel Workbench** (advanced debugging). Telescope stands out for its unified UI and deep Laravel integration, but tools like Debugbar are lighter for simple queries. For production, combine Telescope with Sentry or Datadog.
Weaver
How can I help you explore Laravel packages today?