Laravel Telescope:优雅的应用调试工具

文章转自:https://laravel-china.org/topics/19013
视频教程:047. 优雅的应用调试工具--laravel/telescope (5.7 新扩展)

Laravel Telescope 是由 Mohamed Said 和 Taylor Otwell 开源 的 Laravel 应用的调试工具。

你可以使用 Composer 安装到你的应用中。

安装完 Telescope 后,你可以访问 /telescope 来访问该应用。

Telescope 能做什么事?

如果你之前用过 Clockwork 或者 Laravel Debugbar ,那么这两款应用与 Telescope 进行对比的话就是纯 UI 界面和重量级武器。

Telescope 由一系列监听器组成,这些 “监听器” 监听每个进入应用的请求,不管是来自 HTTP 、命令行、任务调度还是队列的。

这些监听器捕获这些请求以及其相关数据信息 -- 例如数据库查询以及其执行时间,是否命中缓存,事件触发邮件触发等等。

在它操作界面上有用于检查以下各项的选项栏,每个选项栏都代表它的监听器:

  • Requests
  • Commands
  • Schedule
  • Jobs
  • Exceptions
  • Logs
  • Dumps
  • Queries
  • Models
  • Events
  • Mail
  • Notifications
  • Cache
  • Redis

观察者标签

让我们逐步浏览每个选项查看观察到的内容。每个选项都显示一个列表页面,然后您可以点击查看指定项目的详细信息。

(HTTP) 请求

<figure style="margin: 1em 0px;">
image

</figure>

该选项允许您查看进入应用程序的所有 HTTP 请求。您将能查看所有 HTTP 请求以及每个请求的详细信息。

<figure style="margin: 1em 0px;">
image

</figure>

<figure style="margin: 1em 0px;">
image

</figure>

<figure style="margin: 1em 0px;">
image

</figure>

每个请求页面还会显示来自其他观察者关于此请求相关的数据;例如,所有数据库查询以及它们花费时长;该请求已通过身份验证用户;等等。

<figure style="margin: 1em 0px;">
image

</figure>

命令行

<figure style="margin: 1em 0px;">
image

</figure>

命令选项列出已运行的所有命令及其退出代码。您还可以点击查看所有参数,选项和相关内容。

<figure style="margin: 1em 0px;">
image

</figure>

计划任务

列出已运行的计划任务。在每个任务的详细信息页面上,查看他们的所有计划信息,例如他们的 cron 计划(例如 * * * * *)。

<figure style="margin: 1em 0px;">
image

</figure>

任务

<figure style="margin: 1em 0px;">
image

</figure>

任务部分会列出所有运行过,和正在运行的任务。他和Horizon很类似,不过Horizon只支持Redis驱动,而且它不仅仅是UI,它还能和队列沟通,看你队列运行的情况。Telescope,简简单单只是一个UI,一个可以和任何队列驱动玩在一起的UI。

<figure style="margin: 1em 0px;">
image

</figure>

在任务列表页上,你会看到任务名,和它在哪个队列和连接上运行,她的工作情况,和其所发生的经历。

在任务细节页面上,你会看到以上列举的数据,以及:主机名, 他的FQCN,网络连接,队列,尝试次数,超时,还有标签。

<figure style="margin: 1em 0px;">
image

</figure>

任务会自动给用过的Eloquent模型贴标签 (栗子: App\Video:1) ,如果用过用户模型,就会给用户模型贴标签,以此类推。

标签
诸如请求,命令等项目,会自动被Telescope贴标签 (举栗子: 如果一个用户发出了请求,他就自动会被贴上 Auth:1 if User 1 ; 如果你点击那个标签, Telescope就只会显示被贴上该标签的项目)

如HTTP请求一般,你可以看到所有与此任务相关的信息,比如数据库查询记录,其触发的其他任务,和任何生成的日志。

不过,你如若出发了封闭函数,那么你所见之信息不是 App\Jobs\RenderVideo , 取而代之的是 Closure (web.php:43) .

新封闭函数队列
Taylor写了一个新的库,加回了队列封闭函数 (Laravel很多年前用过)。 这个库的功能是,当你将一个模型放入封闭函数中,它只会存这个模型的ID,而不是整个对象。(原作者说的: 岂不妙哉?(反正队列的类已经如此作为了),他很兴奋)。
dispatch(function () use ($video) { // do stuff in a queued job // 做一些队列的事情 });
这样做以后,封闭函数会被序列化,并且有一个哈希(Hash)值如影随形。这样可以防止你的代码在进入队列事件后,代码被篡改,很是不好。现在有了哈希,函数会先被检查一遍,妈妈就不怕我的代码被篡改了。
该封闭函数会被序列化为一个长字符串,加上他的哈希(与签名URL如出一辙)

Exceptions

<figure style="margin: 1em 0px;">
image

</figure>

该功能将记录所有异常,并可查看具体异常情况。界面使用选项卡的形式呈现,包括主机信息,类型,请求,标签,用户身份验证等。

<figure style="margin: 1em 0px;">
image

</figure>

除此之外也可看到异常在代码中的位置,使其高亮并展示上下代码段,且包含完整的堆栈追踪。

<figure style="margin: 1em 0px;">
image

</figure>

<figure style="margin: 1em 0px;">
image

</figure>

你还可以从抛出异常请求中获取指向异常详情页面的链接。

注意:在众多选项卡中,如果您在单个页面上(例如,给定的异常页面),你也可获得指向生成该页面的请求链接。

如果产生多次相同的异常,它们将在列表页面上进行分组,但仍然可以深入查看异常显示页面中的各个异常。

Logs

日志项展示了日志的基本信息,级别和每条日志项的记录时间。

<figure style="margin: 1em 0px;">
image

</figure>

当你访问日志的单个详细页面时,你可以看到更多消息,包含所有你传递给日志的上下文数据(作为数组)。

"比挖掘原始文本文件棒一点。".

当你用数组为你的日志项传递上下文时,你可以查看所有数据,查看触发它的请求,触发的用户。”比挖掘原始文本文件棒一点。

<figure style="margin: 1em 0px;">
image

</figure>

Dump screen

<figure style="margin: 1em 0px;">
image

</figure>

"这是我最爱的功能之一"

如果你代码中使用 dump() 函数,而且你在 Telescope 中打开了 dump screen。你可以在 Telescope 中看到 dumps 并非来自你实际应用。这为你提供了数据的 dd() 样式输出,而不会弄乱您的正常页面加载。每个 dump 还链接到生成它的请求。

如果你离开 dump screen,你所有的 dumps 会突然再次显示到你的浏览器上。

Queries

<figure style="margin: 1em 0px;">
image

</figure>

列出了所有数据查询相关信息,就像 debug bar 一样。如 消耗时常、完整查询、请求触发 等。

漂亮的格式化显示。

<figure style="margin: 1em 0px;">
image

</figure>

可以在服务中配置慢查询的边界,一旦查询查过其配置时间将会被标记,并配以红色警告显示。

注意:每个列表页都有快捷方式和快速搜索。搜索标签和其他内容。

Models

<figure style="margin: 1em 0px;">
image

</figure>

可以看到 查询、更新、删除事件;以及这些事件产生的变化 等。

<figure style="margin: 1em 0px;">
image

</figure>

事件

<figure style="margin: 1em 0px;">
image

</figure>

显示所有事件的列表。可以看到哪些事件是通过标记广播的;查看所有侦听器的列表,并深入了解调用的对象。

<figure style="margin: 1em 0px;">
image

</figure>

邮件

<figure style="margin: 1em 0px;">
image

</figure>

显示发送的所有电子邮件的列表;收件人是谁;什么时候发的;是否还在队列,然后什么时候出队的。可以看到电子邮件主题,当你深入研究它时,你也会看到诸如 MailTrap 的邮件预览。

<figure style="margin: 1em 0px;">
image

</figure>

甚至可以下载原始的 .eml 文件并在选定的客户端中打开。

Notifications

<figure style="margin: 1em 0px;">
image

</figure>

显示所有通知,及其类型,等等。

无法预览,因为有些通知是不可预览的,假如是邮件通知,你就会看到它在列表中。

如果通知已进入队列,还可以在 Jobs 的请求部分看到。有很多方式可以得到这些数据。

Cache

显示缓存命中、未命中和更新等。

显示键,值,何时过期。可以看到触发它的请求,也可以在请求页面上看到该请求的所有缓存命中/未命中。

<figure style="margin: 1em 0px;">
image

</figure>

Redis

跟上面的缓存类似。

诸如花了多久时间,什么时候发生,什么时候发起请求等等。

Authenticated user

在任一选项卡的条目上获取已验证用户的相关信息。

<figure style="margin: 1em 0px;">
image

</figure>

Authorization

可在生产环境的 telescope 服务中,配置可访问的邮件账户列表

在Gate 的 viewTelescope 中定义哪些用户可以访问

<figure style="margin: 1em 0px;">
image

</figure>

筛选

你可能不想在生产环境中把所有东西都存着,所以你可以在 Telescope 服务提供者中, 运行 Telescope::filter(function ($entry))

默认筛选器:

function ($entry) {
    if (local) { return true; }

    return $entry->isReportableException ||
        $entry->isfailedJob() ||
        $entry->isScheduledTask() ||
        $entry->hasMonitoredTag();
}

但是你可以自由地修改它。

监控标签:

点进雷达按钮,声明一个监控标签。你可以在 UI 界面声明一个 Auth:1 监视器。

生产环境中不会记录请求,但是如果你有一个像 Auth:1 这样的监视器,你就会看到所有的请求都被记录下来,除非你取消监视。

NOTE: 如果你使用的是 Redis 队列的话, Horizon 和 Telescope 能完美搭配。

修剪

在 Telescope 中任务调度会修剪掉过期的条目。你可以每晚都删除超过__ 小时的东西。

这个也是在 config/telescope 中设置。

可以随时启用或弃用任意观察者。 E.g. Watchers\CacheWatcher::class 就可以弃用。

还有一个 TELESCOPE_LIMIT 默认定义是 100 ;该选项的意义就是一次性进行 100 个查询,100 次 Redis 查询等。它们都可以在env中进行配置。

杂项

Telescope 可以在本地和生产环境中运行,并有内建授权和工具用来保护私有数据。它可从多角度访问同类数据,具备一系列配置项,提供了健壮的标记和过滤功能。

考虑把它放在一个独立的数据库中。

Taylor 稍后就在 Twitter 上提到你可以添加过滤器从而确保私有数据不会被记录下来。

你可以使用 Telescope::night() 来开启夜晚模式(可能在某个服务提供者那里?)

<figure style="margin: 1em 0px;">
image

</figure>

Q&A:

  • 数据存放在何处?隐藏在一个 StorageRepository 接口实现之后; 类似数据库一样运作在 Redis 上。你可以随心所欲的实现它。这个接口中只有6-7 个方法。
  • 它能存多少数据?不是太多,因为生产环境几乎会抛弃所有的东西,修剪下来,你一次只能保存 100 个。
  • 我们能从 Slack 收到通知吗?我们正在努力。
  • 我能退出 Bugsnag/etc.吗? 可能不能。虽然它简易且轻便,但并不意味着稳定健壮。小心火烛。
  • 我们能否按照时间戳进行过滤?暂时还不能,但是这个是开源项目,帮帮我们

<figure style="margin: 1em 0px;">
image

</figure>

  • 在系统引导阶段会产生什么影响?每次只会执行一个查询。生产环境中不会频繁地把所有东西都插入进去。你可以取消你不关心的监听器。
  • 我们能在同一个UI中检查多个应用吗?可以;只需要在同一个数据库中指向并记录它们,然后考虑做标记/过滤, 这样你就可以按需做区分了。
  • Laravel 的哪个版本能与之兼容? 5.7.7+。
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 200,045评论 5 468
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,114评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 147,120评论 0 332
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,902评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,828评论 5 360
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,132评论 1 277
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,590评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,258评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,408评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,335评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,385评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,068评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,660评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,747评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,967评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,406评论 2 346
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,970评论 2 341

推荐阅读更多精彩内容