You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: telescope.md
+17-18Lines changed: 17 additions & 18 deletions
Original file line number
Diff line number
Diff line change
@@ -179,15 +179,15 @@ While the `filter` callback filters data for individual entries, you may use the
179
179
<aname="available-watchers"></a>
180
180
## Available Watchers
181
181
182
-
Telescope watchers gather application profile data when a request or console command is executed. You may customize the list of watchers that you would like to enable in your application within your `config/telescope.php` file:
182
+
Telescope watchers gather application data when a request or console command is executed. You may customize the list of watchers that you would like to enable within your `config/telescope.php` configuration file:
183
183
184
184
'watchers' => [
185
185
Watchers\CacheWatcher::class => true,
186
186
Watchers\CommandWatcher::class => true,
187
187
...
188
188
],
189
189
190
-
Some watchers also allow you to also customize certain options:
190
+
Some watchers also allow you to provide additional customization options:
191
191
192
192
'watchers' => [
193
193
Watchers\QueryWatcher::class => [
@@ -200,12 +200,12 @@ Some watchers also allow you to also customize certain options:
200
200
<aname="cache-watcher"></a>
201
201
### Cache Watcher
202
202
203
-
The Cache Watcher records data when a cache key is hit, missed, updated and forgotten.
203
+
The cache watcher records data when a cache key is hit, missed, updated and forgotten.
204
204
205
205
<aname="command-watcher"></a>
206
206
### Command Watcher
207
207
208
-
The Command Watcher records the arguments, options, exit code and output whenever an Artisan command is executed. If you would like to exclude certain commands to be recorded by the Command Watcher, you may specify the command in the `ignore` option in your `config/telescope.php` file:
208
+
The command watcher records the arguments, options, exit code, and output whenever an Artisan command is executed. If you would like to exclude certain commands from being recorded by the watcher, you may specify the command in the `ignore` option in your `config/telescope.php` file:
209
209
210
210
'watchers' => [
211
211
Watchers\CommandWatcher::class => [
@@ -218,37 +218,37 @@ The Command Watcher records the arguments, options, exit code and output wheneve
218
218
<aname="dump-watcher"></a>
219
219
### Dump Watcher
220
220
221
-
The Dump Watcher records and displays your dumps in Telescope. The Telescope Dump Watcher screen must be open in a browser for the recording to occur, otherwise all dumps will be ignored by the watcher.
221
+
The dump watcher records and displays your variable dumps in Telescope. When using Laravel, variables may be dumped using the global `dump` function. The dump watcher tab must be open in a browser for the recording to occur, otherwise the dumps will be ignored by the watcher.
222
222
223
223
<aname="event-watcher"></a>
224
224
### Event Watcher
225
225
226
-
The Event Watcher records the payload, listeners and broadcast data for any events fired by your application. The Laravel Framework events are ignored by the Event Watcher.
226
+
The event watcher records the payload, listeners, and broadcast data for any events dispatched by your application. The Laravel framework's internal events are ignored by the Event watcher.
227
227
228
228
<aname="exception-watcher"></a>
229
229
### Exception Watcher
230
230
231
-
The Exception Watcher records the data with the stack trace for any reportable Exceptions that are thrown and logged in your application.
231
+
The exception watcher records the data and stack trace for any reportable Exceptions that are thrown by your application.
232
232
233
233
<aname="job-watcher"></a>
234
234
### Job Watcher
235
235
236
-
The Job Watcher records the data and status of any jobs dispatched in your application.
236
+
The job watcher records the data and status of any jobs dispatched by your application.
237
237
238
238
<aname="log-watcher"></a>
239
239
### Log Watcher
240
240
241
-
The Log Watcher records the log data for any logs fired by your application. All logs regardless of the log level will be recorded by the Log Watcher, even if the logs do not meet the log level threshold set in your configuration.
241
+
The log watcher records the log data for any logs written by your application.
242
242
243
243
<aname="mail-watcher"></a>
244
244
### Mail Watcher
245
245
246
-
The Mail Watcher allows you to view a preview of the mails sent along with some associated data. You may also download the mail as a .eml file.
246
+
The mail watcher allows you to view an in-browser preview of the emails along with their associated data. You may also download the email as an `.eml` file.
247
247
248
248
<aname="model-watcher"></a>
249
249
### Model Watcher
250
250
251
-
The Model Watcher records model changes whenever an Eloquent `created`, `updated`, `restored` or `deleted` event is fired. You may filter these events further via the `events` option:
251
+
The model watcher records model changes whenever an Eloquent `created`, `updated`, `restored`, or `deleted` event is dispatched. You may specify which model events should be recorded via the watcher's`events` option:
252
252
253
253
'watchers' => [
254
254
Watchers\ModelWatcher::class => [
@@ -261,13 +261,12 @@ The Model Watcher records model changes whenever an Eloquent `created`, `updated
261
261
<aname="notification-watcher"></a>
262
262
### Notification Watcher
263
263
264
-
The Notification Watcher records the notification data whenever a Laravel Notification is triggered. If the notification triggers a mail and you have the Mail Watcher enabled, the mail will also be available for preview and download in the Telescope Mail Watcher screen.
264
+
The notification watcher records all notifications sent by your application. If the notification triggers an email and you have the mail watcher enabled, the email will also be available for preview on the mail watcher screen.
265
265
266
266
<aname="query-watcher"></a>
267
267
### Query Watcher
268
268
269
-
The Query Watcher records the raw SQL, bindings and time taken by the queries fired by your application. This watcher also tags any queries slower than 100ms as `slow`. You may customize this time using the `slow` option:
270
-
269
+
The query watcher records the raw SQL, bindings, and execution time for all queries that are executed by your application. The watcher also tags any queries slower than 100ms as `slow`. You may customize the slow query threshold using the watcher's `slow` option:
271
270
272
271
'watchers' => [
273
272
Watchers\QueryWatcher::class => [
@@ -280,14 +279,14 @@ The Query Watcher records the raw SQL, bindings and time taken by the queries fi
280
279
<aname="redis-watcher"></a>
281
280
### Redis Watcher
282
281
283
-
> {note} Redis events must be enabled for the Redis Watcher to work. You may enable Redis events by calling `Redis::enableEvents()` in the `boot` method of your `app/Providers/AppServiceProvider.php` file.
282
+
> {note} Redis events must be enabled for the Redis watcher to function. You may enable Redis events by calling `Redis::enableEvents()` in the `boot` method of your `app/Providers/AppServiceProvider.php` file.
284
283
285
-
The Redis Watcher records all Redis commands executed by your application. If you are using Redis for caching, cache commands will also be recorded by the Redis Watcher.
284
+
The Redis watcher records all Redis commands executed by your application. If you are using Redis for caching, cache commands will also be recorded by the Redis Watcher.
286
285
287
286
<aname="request-watcher"></a>
288
287
### Request Watcher
289
288
290
-
The Request Watcher records the request, headers, session and response data associated with any requests handled by the application. You may purge your response data via the `size_limit` (in KB) option:
289
+
The request watcher records the request, headers, session, and response data associated with any requests handled by the application. You may limit your response data via the `size_limit` (in KB) option:
291
290
292
291
'watchers' => [
293
292
Watchers\RequestWatcher::class => [
@@ -300,4 +299,4 @@ The Request Watcher records the request, headers, session and response data asso
300
299
<aname="schedule-watcher"></a>
301
300
### Schedule Watcher
302
301
303
-
The Schedule Watcher records the command and output data of any scheduled tasks run by your application.
302
+
The schedule watcher records the command and output of any scheduled tasks run by your application.
0 commit comments