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: docs/collectors.md
+65-58Lines changed: 65 additions & 58 deletions
Original file line number
Diff line number
Diff line change
@@ -8,34 +8,31 @@ hide:
8
8
9
9
## Collectors
10
10
11
-
This package includes some custom collectors:
12
-
13
-
-[QueryCollector](#querycollector): Show all queries, including binding + timing
14
-
-[RouteCollector](#routecollector): Show information about the current Route.
15
-
-[ViewCollector](#viewcollector): Show the currently loaded views. (Optionally: display the shared data)
16
-
- EventsCollector: Show all events
17
-
- GateCollector: Show the gates that are checked
18
-
- PennantCollector: Show Pennant flags
19
-
- LaravelCollector: Show the Laravel version and Environment. (disabled by default)
20
-
- SymfonyRequestCollector: replaces the RequestCollector with more information about the request/response
21
-
- LogsCollector: Show the latest log entries from the storage logs. (disabled by default)
22
-
- FilesCollector: Show the files that are included/required by PHP. (disabled by default)
23
-
- ConfigCollector: Display the values from the config files. (disabled by default)
24
-
- CacheCollector: Display all cache events. (disabled by default)
25
-
26
-
Bootstraps the following collectors for Laravel:
27
-
28
-
- LogCollector: Show all Log messages
29
-
- SymfonyMailCollector for Mail
30
-
31
-
And the default collectors:
32
-
33
-
- PhpInfoCollector
34
-
-[MessagesCollector](#messages-collector)
35
-
-[TimeDataCollector](#timeline-collector) (With Booting and Application timing)
36
-
- MemoryCollector
37
-
- ExceptionsCollector
38
-
11
+
This package includes with these Collectors enabled by default:
12
+
13
+
-[Queries](#db): Show all database queries
14
+
-[Messages](#messages): Debug messages and objects
15
+
-[Logs](#log): Show all Log messages (Show in Messages when available)
16
+
-[Views](#views): Show the currently loaded views.
17
+
-[Timeline](#time): Timeline with Booting and Application timing
18
+
-[Route](#route): Show information about the current Route.
19
+
- Session: Current session data
20
+
- Request: Request data
21
+
- Livewire: Only active when Livewire is used
22
+
- PhpInfo: Current PHP version
23
+
- Memory: Memory usage
24
+
- Exceptions: Errors with stacktrace
25
+
26
+
These collectors can be enabled in the config:
27
+
- Auth: Logged in status
28
+
- Events: Show all events
29
+
- Mail: Sent emails
30
+
- Gates: Show the gates that are checked
31
+
- Laravel Info: Show the Laravel version and Environment.
32
+
- Files: Show the files that are included/required by PHP.
33
+
- Config: Display the values from the config files.
34
+
- Cache: Display all cache events.
35
+
- Pennant: Show Pennant flags
39
36
40
37
To enable or disable any of the collectors, set the configuration to `true` or `false`. Some collector have additional options in the configuration:
41
38
@@ -87,7 +84,7 @@ To enable or disable any of the collectors, set the configuration to `true` or `
87
84
88
85
</details>
89
86
90
-
### QueryCollector
87
+
### Query Collector { #db }
91
88
92
89
<!-- md:version v1.0 -->
93
90
<!-- md:feature collectors.db -->
@@ -160,42 +157,46 @@ If you want to avoid any limits, you can set the option to `null`
160
157
161
158

162
159
163
-
### RouteCollector
160
+
161
+
## Messages Collector { #messages }
164
162
165
163
<!-- md:version v1.0 -->
166
-
<!-- md:feature collectors.route-->
164
+
<!-- md:feature collectors.messages-->
167
165
168
-
This shows the current route and middleware.
166
+
The Message collectors gathers all messages from `debug()` calls and anything written to the logs.
169
167
170
-

168
+
You can pass multiple parameters to `debug()`, even complex object.
171
169
172
-
### Timeline Collector
170
+
### Trace
171
+
172
+
When calling `debug()`, the source of the call is shown and can be opened with your IDE.
173
+
174
+
<!-- md:version v3.10.0 -->
175
+
<!-- md:feature options.messages.trace -->
176
+
177
+

178
+
179
+
## Log Collectors { #log }
173
180
174
181
<!-- md:version v1.0 -->
175
-
<!-- md:feature collectors.time-->
182
+
<!-- md:feature collectors.log-->
176
183
177
-

184
+
When the [Messages Collector](#messages) is enabled, Log messages are added to the Messages tab. Otherwise a Monolog tab will show with just the log messages
178
185
179
-
```php
180
-
'options' => [
181
-
'time' => [
182
-
'memory_usage' => false, // Calculated by subtracting memory start and end, it may be inaccurate
183
-
],
184
-
]
185
-
```
186
+

186
187
187
-
### ViewCollector
188
+
### ViewCollector { #views }
188
189
189
190
<!-- md:version v1.0 -->
190
191
<!-- md:feature collectors.views -->
191
192
192
193
The ViewCollector shows views and has the following features:
193
194
194
-
- Show used templates and source
195
-
- Optionally add them to the timeline
196
-
- Group similar views (useful for components)
197
-
- Exclude folders (eg. for Filament or other vendors)
198
-
- Optionally show data (this can be resource heavy)
195
+
- Show used templates and source
196
+
- Optionally add them to the timeline
197
+
- Group similar views (useful for components)
198
+
- Exclude folders (eg. for Filament or other vendors)
199
+
- Optionally show data (this can be resource heavy)
199
200
200
201

201
202
@@ -213,24 +214,30 @@ The ViewCollector shows views and has the following features:
213
214
214
215
```
215
216
216
-
##Messages Collector
217
+
### RouteCollector { #route }
217
218
218
219
<!-- md:version v1.0 -->
219
-
<!-- md:feature collectors.messages-->
220
+
<!-- md:feature collectors.route-->
220
221
221
-
The Message collectors gathers all messages from `debug()` calls and anything written to the logs.
222
+
This shows the current route and middleware.
222
223
223
-
You can pass multiple parameters to `debug()`, even complex object.
224
+

224
225
225
-
### Trace
226
+
### Timeline Collector { #time }
226
227
227
-
When calling `debug()`, the source of the call is shown and can be opened with your IDE.
228
+
<!-- md:version v1.0 -->
229
+
<!-- md:feature collectors.time -->
228
230
229
-
<!-- md:version v3.10.0 -->
230
-
<!-- md:feature options.messages.trace -->
231
+

231
232
233
+
```php
234
+
'options' => [
235
+
'time' => [
236
+
'memory_usage' => false, // Calculated by subtracting memory start and end, it may be inaccurate
0 commit comments