Laravel Telescope

简介
安装
升级 Telescope
过滤
- 条目
- 批次
标签
可用观察者
显示用户头像

简介

Laravel Telescope 是你本地 Laravel 开发环境的绝佳伴侣。Telescope 提供对进入你的应用程序的请求、异常、日志条目、数据库查询、排队作业、邮件、通知、缓存操作、计划任务、变量转储等的洞察。

安装

你可以使用 Composer 包管理器将 Telescope 安装到你的 Laravel 项目中

composer require laravel/telescope

安装 Telescope 后，使用 telescope:install Artisan 命令发布其资产和迁移。安装 Telescope 后，你还应该运行 migrate 命令来创建存储 Telescope 数据所需的表

php artisan telescope:install
 
php artisan migrate

最后，你可以通过 /telescope 路由访问 Telescope 仪表板。

仅本地安装

如果你计划仅使用 Telescope 来帮助你的本地开发，你可以使用 --dev 标志安装 Telescope

composer require laravel/telescope --dev
 
php artisan telescope:install
 
php artisan migrate

运行 telescope:install 后，你应该从应用程序的 bootstrap/providers.php 配置文件中删除 TelescopeServiceProvider 服务提供者注册。相反，在 App\Providers\AppServiceProvider 类的 register 方法中手动注册 Telescope 的服务提供者。我们将在注册提供者之前确保当前环境是 local

/**
 * Register any application services.
 */
public function register(): void
{
    if ($this->app->environment('local')) {
        $this->app->register(\Laravel\Telescope\TelescopeServiceProvider::class);
        $this->app->register(TelescopeServiceProvider::class);
    }
}

最后，你应该还通过将以下内容添加到你的 composer.json 文件中，防止 Telescope 包被自动发现

"extra": {
    "laravel": {
        "dont-discover": [
            "laravel/telescope"
        ]
    }
},

配置

发布 Telescope 的资产后，它的主要配置文件将位于 config/telescope.php。此配置文件允许你配置你的观察者选项。每个配置选项都包含对其用途的描述，因此请务必仔细探索此文件。

如果需要，你可以使用 enabled 配置选项完全禁用 Telescope 的数据收集

'enabled' => env('TELESCOPE_ENABLED', true),

数据修剪

如果不进行修剪，telescope_entries 表可能会很快积累记录。为了缓解这种情况，你应该计划每天运行 telescope:prune Artisan 命令

use Illuminate\Support\Facades\Schedule;
 
Schedule::command('telescope:prune')->daily();

默认情况下，所有超过 24 小时的条目都将被修剪。你可以在调用命令时使用 hours 选项来确定保留 Telescope 数据的时间长度。例如，以下命令将删除所有超过 48 小时创建的记录

use Illuminate\Support\Facades\Schedule;
 
Schedule::command('telescope:prune --hours=48')->daily();

仪表板授权

可以通过 /telescope 路由访问 Telescope 仪表板。默认情况下，你只能在 local 环境中访问此仪表板。在你的 app/Providers/TelescopeServiceProvider.php 文件中，有一个授权门定义。此授权门控制对 **非本地** 环境中 Telescope 的访问。你可以根据需要自由修改此门来限制对你的 Telescope 安装的访问

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

你应该确保你在生产环境中将 APP_ENV 环境变量更改为 production。否则，你的 Telescope 安装将公开可用。

升级 Telescope

升级到新版本的 Telescope 时，务必仔细阅读升级指南。

此外，升级到任何新版本的 Telescope 时，你应该重新发布 Telescope 的资产

php artisan telescope:publish

要使资产保持最新并避免将来更新中的问题，你可以在应用程序的 composer.json 文件中将 vendor:publish --tag=laravel-assets 命令添加到 post-update-cmd 脚本中

{
    "scripts": {
        "post-update-cmd": [
            "@php artisan vendor:publish --tag=laravel-assets --ansi --force"
        ]
    }
}

过滤

条目

你可以通过在 App\Providers\TelescopeServiceProvider 类中定义的 filter 闭包来过滤 Telescope 记录的数据。默认情况下，此闭包记录 local 环境中的所有数据，以及所有其他环境中的异常、失败作业、计划任务和带有监控标签的数据

use Laravel\Telescope\IncomingEntry;
use Laravel\Telescope\Telescope;
 
/**
 * Register any application services.
 */
public function register(): void
{
    $this->hideSensitiveRequestDetails();
 
    Telescope::filter(function (IncomingEntry $entry) {
        if ($this->app->environment('local')) {
            return true;
        }
 
        return $entry->isReportableException() ||
            $entry->isFailedJob() ||
            $entry->isScheduledTask() ||
            $entry->isSlowQuery() ||
            $entry->hasMonitoredTag();
    });
}

批次

虽然 filter 闭包过滤单个条目的数据，但你可以使用 filterBatch 方法注册一个闭包，该闭包过滤给定请求或控制台命令的所有数据。如果闭包返回 true，则 Telescope 会记录所有条目

use Illuminate\Support\Collection;
use Laravel\Telescope\IncomingEntry;
use Laravel\Telescope\Telescope;
 
/**
 * Register any application services.
 */
public function register(): void
{
    $this->hideSensitiveRequestDetails();
 
    Telescope::filterBatch(function (Collection $entries) {
        if ($this->app->environment('local')) {
            return true;
        }
 
        return $entries->contains(function (IncomingEntry $entry) {
            return $entry->isReportableException() ||
                $entry->isFailedJob() ||
                $entry->isScheduledTask() ||
                $entry->isSlowQuery() ||
                $entry->hasMonitoredTag();
            });
    });
}

Telescope 允许你通过“标签”搜索条目。通常，标签是 Eloquent 模型类名或经过身份验证的用户 ID，Telescope 会自动将其添加到条目中。有时，你可能希望将自己的自定义标签附加到条目。要实现这一点，你可以使用 Telescope::tag 方法。tag 方法接受一个闭包，该闭包应返回一个标签数组。闭包返回的标签将与 Telescope 自动附加到条目的任何标签合并。通常，你应该在 App\Providers\TelescopeServiceProvider 类的 register 方法中调用 tag 方法

use Laravel\Telescope\IncomingEntry;
use Laravel\Telescope\Telescope;
 
/**
 * Register any application services.
 */
public function register(): void
{
    $this->hideSensitiveRequestDetails();
 
    Telescope::tag(function (IncomingEntry $entry) {
        return $entry->type === 'request'
                    ? ['status:'.$entry->content['response_status']]
                    : [];
    });
 }

可用观察者

Telescope “观察者”在执行请求或控制台命令时收集应用程序数据。你可以在你的 config/telescope.php 配置文件中自定义你想要启用的观察者列表

'watchers' => [
    Watchers\CacheWatcher::class => true,
    Watchers\CommandWatcher::class => true,
    ...
],

一些观察者还允许你提供额外的自定义选项

'watchers' => [
    Watchers\QueryWatcher::class => [
        'enabled' => env('TELESCOPE_QUERY_WATCHER', true),
        'slow' => 100,
    ],
    ...
],

批次观察者

批次观察者记录有关排队批次的信息，包括作业和连接信息。

缓存观察者

缓存观察者记录缓存键命中、未命中、更新和遗忘时的数据。

命令观察者

命令观察者记录每次执行 Artisan 命令时的参数、选项、退出代码和输出。如果你想要排除某些命令不被观察者记录，你可以在 config/telescope.php 文件中的 ignore 选项中指定该命令

'watchers' => [
    Watchers\CommandWatcher::class => [
        'enabled' => env('TELESCOPE_COMMAND_WATCHER', true),
        'ignore' => ['key:generate'],
    ],
    ...
],

转储观察者

转储观察者记录并显示 Telescope 中的变量转储。使用 Laravel 时，可以使用全局 dump 函数转储变量。转储观察者选项卡必须在浏览器中打开才能记录转储，否则观察者会忽略转储。

事件观察者

事件观察者记录你的应用程序分派的任何事件的有效负载、侦听器和广播数据。事件观察者会忽略 Laravel 框架的内部事件。

异常观察者

异常观察者记录你的应用程序抛出的任何可报告异常的数据和堆栈跟踪。

门观察者

门观察者记录你的应用程序的门和策略检查的数据和结果。如果你想要排除某些功能不被观察者记录，你可以在 config/telescope.php 文件中的 ignore_abilities 选项中指定这些功能

'watchers' => [
    Watchers\GateWatcher::class => [
        'enabled' => env('TELESCOPE_GATE_WATCHER', true),
        'ignore_abilities' => ['viewNova'],
    ],
    ...
],

HTTP 客户端观察者

HTTP 客户端观察者记录你的应用程序发出的 HTTP 客户端请求。

作业观察者

作业观察者记录你的应用程序分派的任何作业的数据和状态。

日志观察者

日志观察者记录你的应用程序写入的任何日志数据。

默认情况下，Telescope 只会记录 error 级别及以上的日志。但是，你可以修改应用程序的 config/telescope.php 配置文件中的 level 选项来修改此行为

'watchers' => [
    Watchers\LogWatcher::class => [
        'enabled' => env('TELESCOPE_LOG_WATCHER', true),
        'level' => 'debug',
    ],
 
    // ...
],

邮件观察者

邮件观察者允许你查看你的应用程序发送的电子邮件的浏览器内预览，以及它们的相关数据。你也可以将电子邮件下载为 .eml 文件。

模型观察者

模型观察者记录每次分派 Eloquent 模型事件时的模型更改。你可以通过观察者的 events 选项指定哪些模型事件应该被记录

'watchers' => [
    Watchers\ModelWatcher::class => [
        'enabled' => env('TELESCOPE_MODEL_WATCHER', true),
        'events' => ['eloquent.created*', 'eloquent.updated*'],
    ],
    ...
],

如果你想记录给定请求期间模型的水化次数，请启用 hydrations 选项

'watchers' => [
    Watchers\ModelWatcher::class => [
        'enabled' => env('TELESCOPE_MODEL_WATCHER', true),
        'events' => ['eloquent.created*', 'eloquent.updated*'],
        'hydrations' => true,
    ],
    ...
],

通知观察者

通知观察器记录您的应用程序发送的所有通知。如果通知触发电子邮件，并且您启用了邮件观察器，则电子邮件也将可在邮件观察器屏幕上预览。

查询观察者

查询观察器记录应用程序执行的所有查询的原始 SQL、绑定和执行时间。观察器还会将任何执行时间超过 100 毫秒的查询标记为slow。您可以使用观察器的slow选项自定义慢查询阈值。

'watchers' => [
    Watchers\QueryWatcher::class => [
        'enabled' => env('TELESCOPE_QUERY_WATCHER', true),
        'slow' => 50,
    ],
    ...
],

Redis 观察者

Redis 观察器记录应用程序执行的所有Redis 命令。如果您使用 Redis 进行缓存，则 Redis 观察器也会记录缓存命令。

请求观察者

请求观察器记录与应用程序处理的任何请求相关的请求、标头、会话和响应数据。您可以通过size_limit（以千字节为单位）选项限制记录的响应数据。

'watchers' => [
    Watchers\RequestWatcher::class => [
        'enabled' => env('TELESCOPE_REQUEST_WATCHER', true),
        'size_limit' => env('TELESCOPE_RESPONSE_SIZE_LIMIT', 64),
    ],
    ...
],

use App\Models\User;
use Laravel\Telescope\Telescope;
 
/**
 * Register any application services.
 */
public function register(): void
{
    // ...
 
    Telescope::avatar(function (string $id, string $email) {
        return '/avatars/'.User::find($id)->avatar_path;
    });
}

Laravel Telescope

简介

安装

仅本地安装

配置

数据修剪

仪表板授权

升级 Telescope

过滤

条目

批次

标签

可用观察者

批次观察者

缓存观察者

命令观察者

转储观察者

事件观察者

异常观察者

门观察者

HTTP 客户端观察者

作业观察者

日志观察者

邮件观察者

模型观察者

通知观察者

查询观察者

Redis 观察者

请求观察者

计划观察者

视图观察者

显示用户头像