Zend Code Tracing - Configuration Directives
This topic lists all the configuration directives for Zend Code Tracing.
Configuration Directives Summary
The table below is a summary of all the Zend Code Tracing configuration directives, and displays the directive name, its default value, and a description:
Directive |
Default Value |
Description |
0 |
Should CodeTracing generate a lightweight trace file (profiler trace) |
|
1 |
Is tracing functionality enabled? |
|
10M |
The size of the trace memory buffer. |
|
2 |
The type of dump produced. |
|
48 |
The maximal length of string values to store in trace files. Longer strings will be truncated. |
|
2 |
The maximal depth of arrays to store in trace files. Deeper nesting levels will not be stored. |
|
10 |
The maximal number of array elements to store in trace files. Longer arrays will be truncated. |
|
codetracing/dump |
The file path and name prefix for saving trace files, relative to zend.data_dir. |
|
0 |
Enable Tracing data collection. |
|
1 |
Enable execution time measurment. |
|
1 |
Enable source file collection. |
|
1 |
Enable internal functions collection. |
|
1 |
Enable user functions call collection. |
|
1 |
Enable tracing include and require calls. |
|
1 |
Enable function call argument collection. |
|
1 |
Enable function return value collection. |
|
1 |
Enable PHP exception data collection. |
|
1 |
Enable array contents recording. |
|
1 |
Enable output data writing collection. |
|
1 |
Enable HTTP response headers collection. |
|
1 |
Enable memory usage data collection. |
|
1 |
Enable PHP error collection. |
|
1 |
Enable Zend Monitor event recording. |
|
0 |
Trace data is always persisted. |
|
1 |
Save tracing data if a fatal signal (e.g. a segmentation fault) is raised. |
|
1 |
Amount of time in seconds to wait between consecutive Code Tracing data writes. |
|
codetracing.log |
Log file for the Code Tracing module (relative to the log dir). |
|
0 |
Logging verbosity level. |
|
@ZEND_PREFIX/etc/functions.txt |
List of internal functions to Trace. |
|
5 |
Number of concurrent trace buffer allocated. |
|
10 |
The maximal size of the log file before it is rotated. |
|
0 |
Use cycles-based time caclculation. Set to false only if you have a problem with frequency probe. |
|
127.0.0.0/8 |
Allow trace file generation only from requests coming from these hosts |
|
0 |
Allow trace file generation from all IPs |
|
500 |
Maximum disk space for trace files. |
Configuration Directives Details
The list below contains information for all the available configuration directives for Zend Code Tracing: their description, type, units, default value, modification scope, and the Zend Server version they became available in.
zend_codetracing.use_lite_trace
Should CodeTracing generate a lightweight trace file (profiler trace)
Default Value: 0
Type: boolean
Modification Scope: ZEND_INI_PERDIR
Available Since Version: 9.1
zend_codetracing.enable
Is tracing functionality enabled?
Default Value: 1
Type: boolean
Modification Scope: ZEND_INI_PERDIR
Available Since Version: 4.0
zend_codetracing.buffer_size
The size of the trace memory buffer.
Default Value: 10M
Units: Bytes
Type: string
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 4.0
zend_codetracing.dump_format
The type of dump produced.
Default Value: 2
Type: int
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_codetracing.max_string
The maximal length of string values to store in trace files. Longer strings will be truncated.
Default Value: 48
Units: Bytes
Type: int
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_codetracing.max_depth
The maximal depth of arrays to store in trace files. Deeper nesting levels will not be stored.
Default Value: 2
Type: int
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_codetracing.max_elements
The maximal number of array elements to store in trace files. Longer arrays will be truncated.
Default Value: 10
Type: int
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_codetracing.dump_file
The file path and name prefix for saving trace files, relative to zend.data_dir.
Default Value: codetracing/dump
Type: string
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_codetracing.trace_enable
Enable Tracing data collection. If the Zend Monitor is loaded, the value of this directive is controlled by the Monitor extension (i.e. it will override any value set in the codetracing.ini file).
Default Value: 0
Type: boolean
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_codetracing.trace_time
Enable execution time measurment.
Default Value: 1
Type: boolean
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_codetracing.trace_source_lines
Enable source file collection.
Default Value: 1
Type: boolean
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_codetracing.trace_internal_functions
Enable internal functions collection.
Default Value: 1
Type: boolean
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_codetracing.trace_user_functions
Enable user functions call collection.
Default Value: 1
Type: boolean
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_codetracing.trace_includes
Enable tracing include and require calls.
Default Value: 1
Type: boolean
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_codetracing.trace_arguments
Enable function call argument collection.
Default Value: 1
Type: boolean
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_codetracing.trace_return_values
Enable function return value collection.
Default Value: 1
Type: boolean
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_codetracing.trace_exceptions
Enable PHP exception data collection.
Default Value: 1
Type: boolean
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_codetracing.trace_arrays
Enable array contents recording.
Default Value: 1
Type: boolean
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_codetracing.trace_write
Enable output data writing collection.
Default Value: 1
Type: boolean
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_codetracing.trace_headers
Enable HTTP response headers collection.
Default Value: 1
Type: boolean
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_codetracing.trace_memory_usage
Enable memory usage data collection.
Default Value: 1
Type: boolean
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_codetracing.trace_errors
Enable PHP error collection.
Default Value: 1
Type: boolean
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_codetracing.trace_events
Enable Zend Monitor event recording.
Default Value: 1
Type: boolean
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_codetracing.always_dump
Trace data is always persisted.
Default Value: 0
Type: boolean
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_codetracing.dump_on_segv
Save tracing data if a fatal signal (e.g. a segmentation fault) is raised.
Default Value: 1
Type: boolean
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_codetracing.max_freq
Amount of time in seconds to wait between consecutive Code Tracing data writes.
Default Value: 1
Units: seconds
Type: int
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 4.0
zend_codetracing.log_file
Log file for the Code Tracing module (relative to the log dir).
Default Value: codetracing.log
Type: string
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 4.0
zend_codetracing.log_verbosity
Logging verbosity level.
Default Value: 0
Type: int
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 4.0
zend_codetracing.override_functions
List of overriding functions. Can contain function names, wildcards (prefix_*) and references to files (@filename). Entries are separated by comma. File contains one entry per line, which can be function name or wildcard.
Default Value: @ZEND_PREFIX/etc/functions.txt
Type: string
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 4.0
zend_codetracing.max_concurrent_trace_buffers
Number of concurrent trace buffer allocated.
Default Value: 5
Type: int
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_codetracing.log_rotation_size
The maximal size of the log file before it is rotated.
Default Value: 10
Units: MBytes
Type: int
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_codetracing.use_fast_timestamp
Use cycles-based time caclculation. Set to false only if you have a problem with frequency probe.
Default Value: 0
Type: boolean
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 4.0
zend_codetracing.allowed_hosts
Allow trace file generation only from requests coming from these hosts
Default Value: 127.0.0.0/8
Type: string
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 9.0
zend_codetracing.allow_from_all
Allow trace file generation from all IPs
Default Value: 0
Type: boolean
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 9.0
zend_codetracing.max_disk_space
Maximum disk space for trace files. For unlimited, set 0.
Default Value: 500
Units: MBytes
Type: int
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 6.1