The output from the oik-bwtrace plugin is written to output files on your WordPress server. The files are written to the Trace files directory.
The general structure of a trace log record is a series of fields separated by spaces. These two trace records have been split over 3 lines.
C:\apache\htdocs\wordpress\wp-content\plugins\bobbing\bobbing.php(50:0) bobbing_init(1) 15 0 2019-12-05T09:22:37+00:00 2.292976 0.000403 cf=init,oik_loaded 4088 14 0 29360128/29360128 256M F=548 1 C:\apache\htdocs\wordpress\wp-content\plugins\bobbing\bobbing.php(51:16) bobbing_init(2) 16 0 2019-12-05T09:22:37+00:00 2.293172 0.000196 cf=init,oik_loaded 4088 14 0 29360128/29360128 256M F=548 the ultimate answer 42
Here’s the second record split over multiple lines.
C:\apache\htdocs\wordpress\wp-content\plugins\bobbing\bobbing.php(51:16) bobbing_init(2) 16 0 2019-12-05T09:22:37+00:00 2.293172 0.000196 cf=init,oik_loaded 4088 14 0 29360128/29360128 256M F=548 the ultimate answer 42
The fields are:
| Field | Comment | |
|---|---|---|
| sourcefile(lineno:level) | the sourcefile may be fully qualified with ABSPATH | |
| function(invocation count) | number of calls to trace from this function | |
| trace record count | ||
| trace error count | ||
| timestamp | ||
| elapsed | since transaction started | |
| interval | since previous trace record | |
| context including current filter | shows filter tree | |
| number of queries | ||
| post ID | ||
| memory/peak usage | in bytes | |
| memory limit | in Megabytes | |
| files loaded | ||
| output buffer handlers | if more than one | |
| field label | ||
| field value | ||
| bwecho’d content | when applicable |
Some of the fields are optional. The contents of each trace record can be selected using Settings > oik trace options.
Field value format
The field value is printed using the PHP print_r() function or an equivalent function ( bw_trace_obsafe_print_r() ) when there is more than one output buffer handler active.
It will print all the values of an array or object.
For large arrays or objects this may produce a lot of output. It can slow the site down considerably.
When the bw_trace2() API is called without any parameters then it will trace the current values of the parameters that were passed to the function.
Notes on trace file names
This documentation assumes the file name is bwtrace.loh.
Since nine times out of ten you will want to view trace logs in one window and the web page in another, and since some browsers will attempt to download a .log file, rather than display it within the browser, I use the .loh extension.
Note: Remember that the trace output files may be publicly accessible. If you do enable tracing on a live site then you should remember to disable it when you have finished and ensure the files are deleted.
