forked from phpbench/phpbench
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathphpbench.schema.json
More file actions
376 lines (376 loc) · 12 KB
/
Copy pathphpbench.schema.json
File metadata and controls
376 lines (376 loc) · 12 KB
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
{
"$schema": "https =>\/\/json-schema.org\/draft\/2020-12\/schema",
"title": "PHPBench configuration",
"type": "object",
"properties": {
"$include": {
"description": "Include another config file relative to this one",
"type": [
"string",
"array"
]
},
"$include-glob": {
"description": "Include config files using a glob pattern. Paths are relative to the config file",
"type": [
"string",
"array"
]
},
"$schema": {
"description": "JSON schema location, e.g. ``.\/vendor\/phpbench\/phpbench\/phpbench.schema.json``",
"type": [
"string",
"null"
]
},
"core.debug": {
"description": "If enabled output debug messages (e.g. the commands being executed when running benchamrks). Same as ``-vvv``",
"type": [
"boolean"
]
},
"core.extensions": {
"description": "List of additional extensions to enable",
"type": [
"array"
]
},
"core.working_dir": {
"description": "Working directory to use",
"type": [
"string"
]
},
"core.config_path": {
"description": "Alternative path to a PHPBench configuration file (default is ``phpbench.json``",
"type": [
"string",
"null"
]
},
"core.profiles": {
"description": "Alternative configurations::\n\n {\n \"core.profiles\": {\n \"php8\": {\n \"runner.php_bin\": \"\/bin\/php8\"\n }\n }\n }\n\nThe named configuration will be merged with the default configuration, and can be used via:\n\n.. code-block:: bash\n\n $ phpbench run --profile=php8",
"type": [
"object"
]
},
"runner.annotations": {
"description": "Read metadata from annotations",
"type": [
"boolean"
]
},
"runner.annotation_import_use": {
"description": "Require that annotations be imported before use",
"type": [
"boolean"
]
},
"runner.attributes": {
"description": "Read metadata from PHP 8 attributes",
"type": [
"boolean"
]
},
"runner.bootstrap": {
"description": "Path to bootstrap (e.g. ``vendor\/autoload.php``)",
"type": [
"string",
"null"
]
},
"runner.env_enabled_providers": {
"description": "Select which environment samplers to use",
"type": [
"object"
]
},
"runner.env_samplers": {
"description": "Environment baselines (not to be confused with baseline comparisons when running benchmarks) are small benchmarks which run to sample the speed of the system (e.g. file I\/O, computation etc). This setting enables or disables these baselines",
"type": [
"object"
]
},
"runner.env_sampler_callables": {
"description": "Map of baseline callables (adds you to register a new environemntal baseline)",
"type": [
"object"
]
},
"runner.executors": {
"description": "Add new executor configurations",
"type": [
"object"
]
},
"runner.path": {
"description": "Path or paths to the benchmarks",
"type": [
"string",
"object",
"null"
]
},
"runner.php_binary": {
"description": "Specify a PHP binary to use when executing out-of-band benchmarks, e.g. ``\/usr\/bin\/php6``, defaults to the version of PHP used to invoke PHPBench",
"type": [
"string",
"null"
]
},
"runner.php_config": {
"description": "Map of PHP ini settings to use when executing out-of-band benchmarks",
"type": [
"object"
]
},
"runner.php_disable_ini": {
"description": "Disable reading the default PHP configuration",
"type": [
"boolean"
]
},
"runner.php_wrapper": {
"description": "Wrap the PHP binary with this command (e.g. ``blackfire run``)",
"type": [
"string",
"null"
]
},
"runner.php_env": {
"description": "Key-value set of environment variables to pass to the PHP process",
"type": [
"object",
"null"
]
},
"runner.progress": {
"description": "Default progress logger to use",
"type": [
"string"
]
},
"runner.progress_summary_variant_format": {
"description": "Expression used to render the summary text default progress loggers",
"type": [
"string"
]
},
"runner.progress_summary_baseline_format": {
"description": "When the a comparison benchmark is referenced, alternative expression used to render the summary text default progress loggers",
"type": [
"string"
]
},
"runner.remote_script_path": {
"description": "PHPBench generates a PHP file for out-of-band benchmarks which is executed, this setting specifies the path to this file. When NULL a file in the systems temporary directory will be used",
"type": [
"string",
"null"
]
},
"runner.remote_script_remove": {
"description": "If the generated file should be removed after it has been executed (useful for debugging)",
"type": [
"boolean"
]
},
"runner.assert": {
"description": "Default :ref:`metadata_assertions`",
"type": [
"null",
"string",
"object"
]
},
"runner.executor": {
"description": "Default executor",
"type": [
"null",
"string"
]
},
"runner.format": {
"description": "Default :ref:`metadata_format`",
"type": [
"null",
"string"
]
},
"runner.iterations": {
"description": "Default :ref:`metadata_iterations`",
"type": [
"null",
"integer",
"object"
]
},
"runner.output_mode": {
"description": "Default :ref:`output mode <metadata_mode>`",
"type": [
"null",
"string"
]
},
"runner.time_unit": {
"description": "Default :ref:`time unit <metadata_time_unit>`",
"type": [
"null",
"string"
]
},
"runner.retry_threshold": {
"description": "Default :ref:`metadata_retry_threshold`",
"type": [
"null",
"integer",
"number"
]
},
"runner.revs": {
"description": "Default number of :ref:`metadata_revolutions`",
"type": [
"null",
"integer",
"object"
]
},
"runner.timeout": {
"description": "Default :ref:`metadata_timeout`",
"type": [
"null",
"number",
"integer"
]
},
"runner.warmup": {
"description": "Default :ref:`metadata_warmup`",
"type": [
"null",
"integer",
"object"
]
},
"runner.subject_pattern": {
"description": "Subject pattern (regex) to use when finding benchmarks",
"type": [
"string"
]
},
"runner.file_pattern": {
"description": "Consider file names matching this pattern to be benchmarks. NOTE: In 2.0 this will be set to ``*Bench.php``",
"type": [
"string",
"null"
]
},
"report.generators": {
"description": "Report generator configurations, see :doc:`report-generators`",
"type": [
"object"
]
},
"report.outputs": {
"description": "Report renderer configurations, see :doc:`report-renderers`",
"type": [
"object"
]
},
"report.components": {
"description": "Component configurations, see :doc:`report-components`",
"type": [
"object"
]
},
"report.template_paths": {
"description": "List of paths to load templates from",
"type": [
"object"
]
},
"report.template_map": {
"description": "Namespace prefix to template path map for object rendering",
"type": [
"object"
]
},
"expression.syntax_highlighting": {
"description": "Enable syntax highlighting",
"type": [
"boolean"
]
},
"expression.theme": {
"description": "Select a theme to use",
"type": [
"string"
]
},
"expression.memory_unit_prefix": {
"description": "By default use ``decimal`` (1kb = 1000 bytes) or ``binary`` (1KiB = 1024 bytes) when displaying memory",
"type": [
"string"
],
"enum": [
"binary",
"decimal"
]
},
"expression.strip_tailing_zeros": {
"description": "Do not display meaningless zeros after the decimal place",
"type": [
"boolean"
]
},
"storage.driver": {
"description": "Storage driver to use",
"type": [
"string"
]
},
"storage.xml_storage_path": {
"description": "Path to store benchmark runs when they are stored with ``--store`` or ``--tag=foo``",
"type": [
"string"
]
},
"storage.store_binary": {
"description": "If binary and serialized parameter values should be stored",
"type": [
"boolean"
]
},
"xdebug.command_handler_output_dir": {
"description": "Output directory for generated XDebug profiles",
"type": [
"string"
]
},
"console.ansi": {
"description": "Enable or disable ANSI control characters (e.g. console colors)",
"type": [
"boolean",
"null"
]
},
"console.disable_output": {
"description": "Disable output from both STDOUT and STDERR",
"type": [
"boolean"
]
},
"console.output_stream": {
"description": "Change the normal output stream - the output stream used for reports",
"type": [
"string"
]
},
"console.error_stream": {
"description": "Change the error output stream - the output stream used for diagnostics (e.g. progress loggers use this stream)",
"type": [
"string"
]
}
}
}