Laravel Telescope

• 소개
• 설치
  • 구성
  • 데이터 수정
  • 데이터 마이그레이션
• 대시보드 승인
• Filtering
  • 단일 항목 필터링
  • 일괄 필터링
• 모니터링 가능
  • 캐시 모니터링
  • 명령 모니터링
  • 스토리지 모니터링
  • 이벤트 모니터링 Listen
  • 예외 모니터링
  • Gate 모니터링
  • 프로세스 모니터링
  • 로그 모니터링
  • 메일 모니터링
  • 모델 모니터링
  • 메시지 알림 모니터링
  • 데이터 쿼리 모니터링
  • Redis는
  • 을 수신합니다. 요청 Monitoring
  • Schedule Monitoring

Introduction

Larave Telescope는 Laravel 프레임워크를 위한 우아한 디버깅 도우미입니다. Telescope는 애플리케이션으로 들어오는 요청, 예외, 로그 항목, 데이터베이스 쿼리, 대기 중인 작업, 이메일, 알림, 캐시 작업, 예약된 작업, 변수 덤프 등에 대한 통찰력을 제공합니다. Telescope는 로컬 Laravel 개발 환경의 훌륭한 동반자입니다.

Installation

Composer를 사용하여 Laravel 프로젝트에 Telescope 확장 프로그램을 설치할 수 있습니다.

composer require laravel/telescope

Telescope를 설치한 후 Artisan에서 telescope:install 명령을 사용하여 확장 프로그램을 구성할 수 있습니다. 사례. Telescope를 설치한 후 migration 명령도 실행해야 합니다: telescope:install 命令来配置扩展实例。安装 Telescope 后，还应运行 migrate 命令：

php artisan telescope:install

php artisan migrate

更新 Telescope

更新 Telescope 时，您应该重新配置加载 Telescope 实例：

php artisan telescope:publish

仅在特定环境中安装

如果您打算仅使用 Telescope 来协助您的本地开发。可以使用 --dev 标志安装 Telescope：

composer require laravel/telescope --dev

运行 telescope:install 后，您应该从 app 配置文件中删除 TelescopeServiceProvider 服务提供注册。相反，在 AppServiceProvider 的 register 方法中手动注册服务：

use Laravel\Telescope\TelescopeServiceProvider;
/**
 * 注册应用服务。
 *
 * @return void
 */public function register(){ 
    if ($this->app->isLocal()) {    
        $this->app->register(TelescopeServiceProvider::class);  
        }
     }

定制数据迁移

如果您不打算使用 Telescope 的默认迁移，则应该在 AppServiceProvider 的 register 方法中调用 Telescope::ignoreMigrations 方法。您可以使用 php artisan vendor:publish --tag=telescope-migrations 命令导出默认迁移。

配置

使用 Telescope，其主要配置文件将位于 config/telescope.php。此配置文件允许您配置监听程序选项，每个配置选项都包含其用途说明，因此请务必彻底浏览此文件。

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

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

数据修改

有了数据修改，telescope_entries 表可以非常快速地累积记录。为了缓解这个问题，你应该使用 Artisan 每天运行 telescope:prune 命令：

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

默认情况下，将获取超过 24 小时的所有数据。在调用命令时可以使用 hours 选项来确定保留 Telescope 数据的时间。例如，以下命令将删除 48 小时前创建的所有记录：

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

仪表板授权

Telescope 在 /telescope 处显示仪表板。默认情况下，您只能在 本地 环境中访问此仪表板。在你的 app/Providers/TelescopeServiceProvider.php 文件中，有一个 gate

/**
 * 註冊 Telescope Gate。
 *
 * 使用 Gate 决定谁可以在非本地环境中访问 Telescope。
 *
 * @return void
 */
 protected function gate(){
     Gate::define('viewTelescope', function ($user) { 
            return in_array($user->email, [     
                   'taylor@laravel.com',      
                     ]);   
                 });
              }

Update Telescope

/**
 * 注册应用服务。
 *
 * @return void
 */
 public function register(){ 
    $this->hideSensitiveRequestDetails();    
    Telescope::filter(function (IncomingEntry $entry) {     
       if ($this->app->isLocal()) {       
            return true;   
               }   
       return $entry->isReportableException() ||            
       $entry->isFailedJob() ||            
       $entry->isScheduledTask() ||            
       $entry->hasMonitoredTag();    
       });
    }

에서만 특정 환경

use Illuminate\Support\Collection;
/**
 * 注册应用服务。
 *
 * @return void
 */
 public function register(){ 
    $this->hideSensitiveRequestDetails();    
    Telescope::filterBatch(function (Collection $entries) {  
          if ($this->app->isLocal()) {        
              return true;      
                }      
           return $entries->contains(function ($entry) {    
                 return $entry->isReportableException() ||                
                 $entry->isFailedJob() ||                
                 $entry->isScheduledTask() ||                
                 $entry->hasMonitoredTag();            
                 });    
              });
          }

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

Telescope의 기본 마이그레이션을 사용할 계획이 없다면 AppServiceProvider의 register 메서드에서 Telescope::ignoreMigrations 메서드를 호출해야 합니다. . php artisan Vendor:publish --tag=telescope-migrations 명령을 사용하여 기본 마이그레이션을 내보낼 수 있습니다.

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

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

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

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

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

批量过滤

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

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

可用的监听

当在控制台执行命令或处理请求时，Telescope 监听器会收集应用程序数据。您可以在 config/telescope.php 配置文件中自定义要启用监听项的列表：

一些监听器还允许您提供其他自定义选项：

缓存监听

当缓存键被命中、遗漏、更新和遗忘时，缓存监听器会记录数据。

命令监听

只要执行 Artisan 命令，命令监听器就会记录参数、选项、退出代码和输出。如果您想排除监听器记录的某些命令，您可以在 config/telescope.php 文件的 ignore 选项中指定命令：

数据监听

数据监听器在 Telescope 中记录并显示您的数据变量。使用 Laravel 时，可以使用全局 dump 函数输出变量。必须在浏览器中打开数据监听器选项卡，才能进行输出变量，否则监听器将忽略此次输出。

事件监听

事件监听器记录应用程序调度的任何事件的有效负载、监听器和广播数据。事件监听器忽略了 Laravel 框架的内部事件。

异常监听

异常监听器记录应用程序引发的任何可报告异常的数据和堆栈跟踪。

Gate 监听

Gate 监听器记录您的应用程序的 Gate 和策略检查的数据和结果。如果您希望将某些能力排除在监听器的记录之外，您可以在 config/telescope.php 文件的 ignore_abilitiesrrreee

일괄 필터링

filter 콜백이 단일 항목에 대한 데이터를 필터링하는 동안 filterBatch 메서드를 사용하여 전체 항목으로 필터링하는 콜백을 등록할 수 있습니다. 특정 요청이나 콘솔 명령에 대한 데이터입니다. 콜백이 true를 반환하면 모든 데이터는 Telescope에 의해 기록됩니다:

사용 가능한 감시자

rrreee

Cache Watcher캐시 감시자는 캐시 키가 적중, 누락, 업데이트 및 잊혀졌을 때 데이터를 기록합니다.

模型监听

只要调度了模型的 create、updated、restored 或 deleted 事件，模型观察器就会记录模型更改。您可以通过监听器的 events 选项指定应记录哪些模型事件：

消息通知监听

消息通知监听器记录您的应用程序发送的所有通知。如果通知触发了电子邮件并且您启用了邮件监听器，则电子邮件也可以在邮件监视器屏幕上进行预览。

数据查询监听

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

Redis 监听

必须启用 Redis 事件才能使 Redis 监听器正常运行。您可以通过在 app/Providers/AppServiceProvider.php 文件的 boot 方法中调用 Redis::enableEvents() 来启用 Redis 事件。

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

请求监听

请求监听器记录与应用程序处理的任何请求相关联的请求、标头、会话和响应数据。您可以通过 size_limit

모델 시계

모델의 생성, 업데이트 및 복원 이벤트가 예정되거나 삭제되면 모델 관찰자가 모델 변경을 기록합니다. 리스너의 events 옵션을 통해 기록해야 하는 모델 이벤트를 지정할 수 있습니다.