Skip to content

Commit f499cfe

Browse files
committed
formatting
1 parent 43cc019 commit f499cfe

File tree

1 file changed

+17
-18
lines changed

1 file changed

+17
-18
lines changed

telescope.md

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -179,15 +179,15 @@ While the `filter` callback filters data for individual entries, you may use the
179179
<a name="available-watchers"></a>
180180
## Available Watchers
181181

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:
183183

184184
'watchers' => [
185185
Watchers\CacheWatcher::class => true,
186186
Watchers\CommandWatcher::class => true,
187187
...
188188
],
189189

190-
Some watchers also allow you to also customize certain options:
190+
Some watchers also allow you to provide additional customization options:
191191

192192
'watchers' => [
193193
Watchers\QueryWatcher::class => [
@@ -200,12 +200,12 @@ Some watchers also allow you to also customize certain options:
200200
<a name="cache-watcher"></a>
201201
### Cache Watcher
202202

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.
204204

205205
<a name="command-watcher"></a>
206206
### Command Watcher
207207

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:
209209

210210
'watchers' => [
211211
Watchers\CommandWatcher::class => [
@@ -218,37 +218,37 @@ The Command Watcher records the arguments, options, exit code and output wheneve
218218
<a name="dump-watcher"></a>
219219
### Dump Watcher
220220

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.
222222

223223
<a name="event-watcher"></a>
224224
### Event Watcher
225225

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.
227227

228228
<a name="exception-watcher"></a>
229229
### Exception Watcher
230230

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.
232232

233233
<a name="job-watcher"></a>
234234
### Job Watcher
235235

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.
237237

238238
<a name="log-watcher"></a>
239239
### Log Watcher
240240

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.
242242

243243
<a name="mail-watcher"></a>
244244
### Mail Watcher
245245

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.
247247

248248
<a name="model-watcher"></a>
249249
### Model Watcher
250250

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:
252252

253253
'watchers' => [
254254
Watchers\ModelWatcher::class => [
@@ -261,13 +261,12 @@ The Model Watcher records model changes whenever an Eloquent `created`, `updated
261261
<a name="notification-watcher"></a>
262262
### Notification Watcher
263263

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.
265265

266266
<a name="query-watcher"></a>
267267
### Query Watcher
268268

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:
271270

272271
'watchers' => [
273272
Watchers\QueryWatcher::class => [
@@ -280,14 +279,14 @@ The Query Watcher records the raw SQL, bindings and time taken by the queries fi
280279
<a name="redis-watcher"></a>
281280
### Redis Watcher
282281

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.
284283
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.
286285

287286
<a name="request-watcher"></a>
288287
### Request Watcher
289288

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:
291290

292291
'watchers' => [
293292
Watchers\RequestWatcher::class => [
@@ -300,4 +299,4 @@ The Request Watcher records the request, headers, session and response data asso
300299
<a name="schedule-watcher"></a>
301300
### Schedule Watcher
302301

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

Comments
 (0)