FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
BookStack/app/Config/clockwork.php at development · ucoding/BookStack · GitHub
ucoding
/
BookStack
Public
forked from
BookStackApp/BookStack
Notifications
You must be signed in to change notification settings
Fork
0
Star
0
Code
Pull requests
0
Actions
Projects
Security and quality
0
Insights
Additional navigation options
Code
Pull requests
Actions
Projects
Security and quality
Insights
Expand file tree
Breadcrumbs
BookStack
/
app
/
Config
/
clockwork.php
Copy path
More file actions
More file actions
Latest commit
History
History
History
415 lines (332 loc) · 15.4 KB
Breadcrumbs
BookStack
/
app
/
Config
/
clockwork.php
Copy path
File metadata and controls
415 lines (332 loc) · 15.4 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
<?php
return
[
/*
|------------------------------------------------------------------------------------------------------------------
| Enable Clockwork
|------------------------------------------------------------------------------------------------------------------
|
| Clockwork is enabled by default only when your application is in debug mode. Here you can explicitly enable or
| disable Clockwork. When disabled, no data is collected and the api and web ui are inactive.
|
*/
'
enable
'
=>
env
(
'
CLOCKWORK_ENABLE
'
,
false
),
/*
|------------------------------------------------------------------------------------------------------------------
| Features
|------------------------------------------------------------------------------------------------------------------
|
| You can enable or disable various Clockwork features here. Some features have additional settings (eg. slow query
| threshold for database queries).
|
*/
'
features
'
=> [
// Cache usage stats and cache queries including results
'
cache
'
=> [
'
enabled
'
=>
true
,
// Collect cache queries
'
collect_queries
'
=>
true
,
// Collect values from cache queries (high performance impact with a very high number of queries)
'
collect_values
'
=>
false
,
],
// Database usage stats and queries
'
database
'
=> [
'
enabled
'
=>
true
,
// Collect database queries (high performance impact with a very high number of queries)
'
collect_queries
'
=>
true
,
// Collect details of models updates (high performance impact with a lot of model updates)
'
collect_models_actions
'
=>
true
,
// Collect details of retrieved models (very high performance impact with a lot of models retrieved)
'
collect_models_retrieved
'
=>
false
,
// Query execution time threshold in miliseconds after which the query will be marked as slow
'
slow_threshold
'
=>
null
,
// Collect only slow database queries
'
slow_only
'
=>
false
,
// Detect and report duplicate (N+1) queries
'
detect_duplicate_queries
'
=>
false
,
],
// Dispatched events
'
events
'
=> [
'
enabled
'
=>
true
,
// Ignored events (framework events are ignored by default)
'
ignored_events
'
=> [
// App\Events\UserRegistered::class,
// 'user.registered'
],
],
// Laravel log (you can still log directly to Clockwork with laravel log disabled)
'
log
'
=> [
'
enabled
'
=>
true
,
],
// Sent notifications
'
notifications
'
=> [
'
enabled
'
=>
true
,
],
// Performance metrics
'
performance
'
=> [
// Allow collecting of client metrics. Requires separate clockwork-browser npm package.
'
client_metrics
'
=>
true
,
],
// Dispatched queue jobs
'
queue
'
=> [
'
enabled
'
=>
true
,
],
// Redis commands
'
redis
'
=> [
'
enabled
'
=>
true
,
],
// Routes list
'
routes
'
=> [
'
enabled
'
=>
false
,
// Collect only routes from particular namespaces (only application routes by default)
'
only_namespaces
'
=> [
'
App
'
],
],
// Rendered views
'
views
'
=> [
'
enabled
'
=>
true
,
// Collect views including view data (high performance impact with a high number of views)
'
collect_data
'
=>
false
,
// Use Twig profiler instead of Laravel events for apps using laravel-twigbridge (more precise, but does
// not support collecting view data)
'
use_twig_profiler
'
=>
false
,
],
],
/*
|------------------------------------------------------------------------------------------------------------------
| Enable web UI
|------------------------------------------------------------------------------------------------------------------
|
| Clockwork comes with a web UI accessibla via http://your.app/clockwork. Here you can enable or disable this
| feature. You can also set a custom path for the web UI.
|
*/
'
web
'
=>
true
,
/*
|------------------------------------------------------------------------------------------------------------------
| Enable toolbar
|------------------------------------------------------------------------------------------------------------------
|
| Clockwork can show a toolbar with basic metrics on all responses. Here you can enable or disable this feature.
| Requires a separate clockwork-browser npm library.
| For installation instructions see https://underground.works/clockwork/#docs-viewing-data
|
*/
'
toolbar
'
=>
true
,
/*
|------------------------------------------------------------------------------------------------------------------
| HTTP requests collection
|------------------------------------------------------------------------------------------------------------------
|
| Clockwork collects data about HTTP requests to your app. Here you can choose which requests should be collected.
|
*/
'
requests
'
=> [
// With on-demand mode enabled, Clockwork will only profile requests when the browser extension is open or you
// manually pass a "clockwork-profile" cookie or get/post data key.
// Optionally you can specify a "secret" that has to be passed as the value to enable profiling.
'
on_demand
'
=>
false
,
// Collect only errors (requests with HTTP 4xx and 5xx responses)
'
errors_only
'
=>
false
,
// Response time threshold in miliseconds after which the request will be marked as slow
'
slow_threshold
'
=>
null
,
// Collect only slow requests
'
slow_only
'
=>
false
,
// Sample the collected requests (eg. set to 100 to collect only 1 in 100 requests)
'
sample
'
=>
false
,
// List of URIs that should not be collected
'
except
'
=> [
'
/horizon/.*
'
,
// Laravel Horizon requests
'
/telescope/.*
'
,
// Laravel Telescope requests
'
/_debugbar/.*
'
,
// Laravel DebugBar requests
],
// List of URIs that should be collected, any other URI will not be collected if not empty
'
only
'
=> [
// '/api/.*'
],
// Don't collect OPTIONS requests, mostly used in the CSRF pre-flight requests and are rarely of interest
'
except_preflight
'
=>
true
,
],
/*
|------------------------------------------------------------------------------------------------------------------
| Artisan commands collection
|------------------------------------------------------------------------------------------------------------------
|
| Clockwork can collect data about executed artisan commands. Here you can enable and configure which commands
| should be collected.
|
*/
'
artisan
'
=> [
// Enable or disable collection of executed Artisan commands
'
collect
'
=>
false
,
// List of commands that should not be collected (built-in commands are not collected by default)
'
except
'
=> [
// 'inspire'
],
// List of commands that should be collected, any other command will not be collected if not empty
'
only
'
=> [
// 'inspire'
],
// Enable or disable collection of command output
'
collect_output
'
=>
false
,
// Enable or disable collection of built-in Laravel commands
'
except_laravel_commands
'
=>
true
,
],
/*
|------------------------------------------------------------------------------------------------------------------
| Queue jobs collection
|------------------------------------------------------------------------------------------------------------------
|
| Clockwork can collect data about executed queue jobs. Here you can enable and configure which queue jobs should
| be collected.
|
*/
'
queue
'
=> [
// Enable or disable collection of executed queue jobs
'
collect
'
=>
false
,
// List of queue jobs that should not be collected
'
except
'
=> [
// App\Jobs\ExpensiveJob::class
],
// List of queue jobs that should be collected, any other queue job will not be collected if not empty
'
only
'
=> [
// App\Jobs\BuggyJob::class
],
],
/*
|------------------------------------------------------------------------------------------------------------------
| Tests collection
|------------------------------------------------------------------------------------------------------------------
|
| Clockwork can collect data about executed tests. Here you can enable and configure which tests should be
| collected.
|
*/
'
tests
'
=> [
// Enable or disable collection of ran tests
'
collect
'
=>
false
,
// List of tests that should not be collected
'
except
'
=> [
// Tests\Unit\ExampleTest::class
],
],
/*
|------------------------------------------------------------------------------------------------------------------
| Enable data collection when Clockwork is disabled
|------------------------------------------------------------------------------------------------------------------
|
| You can enable this setting to collect data even when Clockwork is disabled. Eg. for future analysis.
|
*/
'
collect_data_always
'
=>
false
,
/*
|------------------------------------------------------------------------------------------------------------------
| Metadata storage
|------------------------------------------------------------------------------------------------------------------
|
| Configure how is the metadata collected by Clockwork stored. Two options are available:
| - files - A simple fast storage implementation storing data in one-per-request files.
| - sql - Stores requests in a sql database. Supports MySQL, Postgresql, Sqlite and requires PDO.
|
*/
'
storage
'
=>
'
files
'
,
// Path where the Clockwork metadata is stored
'
storage_files_path
'
=>
storage_path
(
'
clockwork
'
),
// Compress the metadata files using gzip, trading a little bit of performance for lower disk usage
'
storage_files_compress
'
=>
false
,
// SQL database to use, can be a name of database configured in database.php or a path to a sqlite file
'
storage_sql_database
'
=>
storage_path
(
'
clockwork.sqlite
'
),
// SQL table name to use, the table is automatically created and udpated when needed
'
storage_sql_table
'
=>
'
clockwork
'
,
// Maximum lifetime of collected metadata in minutes, older requests will automatically be deleted, false to disable
'
storage_expiration
'
=>
60
*
24
*
7
,
/*
|------------------------------------------------------------------------------------------------------------------
| Authentication
|------------------------------------------------------------------------------------------------------------------
|
| Clockwork can be configured to require authentication before allowing access to the collected data. This might be
| useful when the application is publicly accessible. Setting to true will enable a simple authentication with a
| pre-configured password. You can also pass a class name of a custom implementation.
|
*/
'
authentication
'
=>
false
,
// Password for the simple authentication
'
authentication_password
'
=>
'
VerySecretPassword
'
,
/*
|------------------------------------------------------------------------------------------------------------------
| Stack traces collection
|------------------------------------------------------------------------------------------------------------------
|
| Clockwork can collect stack traces for log messages and certain data like database queries. Here you can set
| whether to collect stack traces, limit the number of collected frames and set further configuration. Collecting
| long stack traces considerably increases metadata size.
|
*/
'
stack_traces
'
=> [
// Enable or disable collecting of stack traces
'
enabled
'
=>
true
,
// Limit the number of frames to be collected
'
limit
'
=>
10
,
// List of vendor names to skip when determining caller, common vendors are automatically added
'
skip_vendors
'
=> [
// 'phpunit'
],
// List of namespaces to skip when determining caller
'
skip_namespaces
'
=> [
// 'Laravel'
],
// List of class names to skip when determining caller
'
skip_classes
'
=> [
// App\CustomLog::class
],
],
/*
|------------------------------------------------------------------------------------------------------------------
| Serialization
|------------------------------------------------------------------------------------------------------------------
|
| Clockwork serializes the collected data to json for storage and transfer. Here you can configure certain aspects
| of serialization. Serialization has a large effect on the cpu time and memory usage.
|
*/
// Maximum depth of serialized multi-level arrays and objects
'
serialization_depth
'
=>
10
,
// A list of classes that will never be serialized (eg. a common service container class)
'
serialization_blackbox
'
=> [
\
Illuminate
\
Container
\Container::class,
\
Illuminate
\
Foundation
\Application::class,
],
/*
|------------------------------------------------------------------------------------------------------------------
| Register helpers
|------------------------------------------------------------------------------------------------------------------
|
| Clockwork comes with a "clock" global helper function. You can use this helper to quickly log something and to
| access the Clockwork instance.
|
*/
'
register_helpers
'
=>
true
,
/*
|------------------------------------------------------------------------------------------------------------------
| Send Headers for AJAX request
|------------------------------------------------------------------------------------------------------------------
|
| When trying to collect data the AJAX method can sometimes fail if it is missing required headers. For example, an
| API might require a version number using Accept headers to route the HTTP request to the correct codebase.
|
*/
'
headers
'
=> [
// 'Accept' => 'application/vnd.com.whatever.v1+json',
],
/*
|------------------------------------------------------------------------------------------------------------------
| Server-Timing
|------------------------------------------------------------------------------------------------------------------
|
| Clockwork supports the W3C Server Timing specification, which allows for collecting a simple performance metrics
| in a cross-browser way. Eg. in Chrome, your app, database and timeline event timings will be shown in the Dev
| Tools network tab. This setting specifies the max number of timeline events that will be sent. Setting to false
| will disable the feature.
|
*/
'
server_timing
'
=>
10
,
];
Back
|
FazBrowse Home
|
New Git URL