Zend Monitor - Configuration Directives
This topic lists all the configuration directives for Zend Monitor.
Configuration Directives Summary
The table below is a summary of all the Zend Monitor configuration directives, and displays the directive name, its default value, and a description:
|
Directive |
Default Value |
Description |
|
1 |
Enables or disables the Monitor component. |
|
|
2 |
Monitor extension log verbosity level. |
|
|
0 |
Transport layer log verbosity level. |
|
|
10 |
The maximum size of the log file before it is rotated. |
|
|
4194304 / 2097152 |
Amount of shared memory to allocate for event collection. |
|
|
events.sock / events |
Communication transport for event reporting to the Monitor Node. |
|
|
PRGCVF |
PHP Super-global variables to include in event reports. |
|
|
100 |
The maximum length of a superglobal to include in an event report. |
|
|
zend_monitor.event.request_slow_exec.disabled_on_function_slow_exec_event |
0 |
Disable reporting of Slow Request Execution events if a Slow Function Execution event was reported. |
|
zend_monitor.event.request_slow_exec.disabled_on_high_load.threshold |
0 |
Sets the load level to disable Slow Request Execution events for the same request that already triggered a high load event. |
|
100 |
The minimum request execution time for a relativity check. |
|
|
zend_monitor.event.request_relative_large_mem_usage.min_mem_usage |
100 |
The minimum request memory usage for a relativity check. |
|
zend_monitor.event.request_relative_large_output_size.min_output_size |
100 |
The minimum request output size for a relativity check |
|
1 |
Controls PHP Error event reporting when PHP error reporting is supressed |
|
|
500 |
How many requests to run before deviation events are calculated (to collect data for the average). This is used to calculate averages for relative events. |
|
|
300 |
The time duration (in seconds) before statistics are reset if a request is not called. |
|
|
monitor_rules.json |
Event rules configuration file. |
|
|
300 |
The time duration (in seconds) before resetting the aggregation data if the aggregation-key for an event is not triggered. |
|
|
300 |
The maximum time interval between reporting. |
|
|
0 |
Enables fast time sampling which is dependent on CPU cycles and frequency, otherwise, the directive uses operating system timing (which may be less accurate). |
|
|
0 |
When enabled, use the URL's query string as part of the aggregation key. |
|
|
1 |
When enabled, use the request route details as part of the aggregation key. |
|
|
A list of functions that can retrieve the error string of the corresponding function that returned error. |
||
|
2 |
Determines integration with tracer mechanism in case of events that require a trace data dump. |
|
|
120 |
Enable code tracing collection for this period (seconds) |
|
|
0 |
When enabled, a cookie that represents the current request will be send to browser. Only needed for toolbar. |
|
|
0 |
Enable monitor on cli |
Configuration Directives Details
The list below contains information for all the available configuration directives for Zend Monitor: their description, type, units, default value, modification scope, and the Zend Server version they became available in.
zend_monitor.enable
Enables or disables the Monitor component. When set to On, Zend Monitor will collect and report PHP events. When set to Off, PHP will not be monitored.
Default Value: 1
Type: boolean
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_monitor.log_verbosity
The extension's log verbosity level.
Default Value: 2
Type: int
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 4.0
zend_monitor.zdo_log_verbosity
The log's verbosity level for the extension's transport layer. Possible values are similar to the zend_monitor.log_verbosity directive.
Default Value: 0
Type: int
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 4.0
zend_monitor.log_rotation_size
The maximum 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_monitor.shm_size
Amount of shared memory to allocate for event collection. If exceeded, an error message is reported to the log.
Default Value:
- Windows, Linux: 4194304
- IBMi: 2097152
Type: int
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 4.0
zend_monitor.events_transport_parameter
Defines the network communication transport to be used when sending event reports from the Monitor Extension to the Monitor Node.
Default Value:
- Linux, IBMi: events.sock
- Windows: events
Type: string
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 4.0
zend_monitor.report_super_globals
Default Value: PRGCVF
Type: string
Modification Scope: ZEND_INI_ALL
Available Since Version: 3.6
zend_monitor.max_super_globals_string_len
When the string is passed, any characters that exceed the limit are truncated and '...' is appended to the end of the string to indicate that this is a partial value.
Default Value: 100
Type: int
Modification Scope: ZEND_INI_ALL
Available Since Version: 3.6
zend_monitor.event.request_slow_exec.disabled_on_function_slow_exec_event
Disable reporting of Slow Request Execution events if a Slow Function Execution event was reported in the same request. This reduces the chance of getting double slow-execution reports triggered by the same underlying cause.
Default Value: 0
Type: boolean
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_monitor.event.request_slow_exec.disabled_on_high_load.threshold
Sets the load level to disable Slow Request Execution events for the same request that already triggered a high load event.
Default Value: 0
Type: int
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_monitor.event.request_relative_slow_exec.min_exec_time
The minimum execution time for a request to be compared to the average request execution time.
Default Value: 100
Units: milliseconds
Type: int
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_monitor.event.request_relative_large_mem_usage.min_mem_usage
The minimum memory usage of a request to be compared to the average request memory usage.
Default Value: 100
Units: KBytes
Type: int
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_monitor.event.request_relative_large_output_size.min_output_size
The minimum output size of a request to be compared to the average request output size.
Default Value: 100
Units: KBytes
Type: int
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_monitor.event.zend_error.silence_level
Controls PHP Error event reporting when the silencing operator (@) is used or when the error_reporting level is set to 0. The values are:
Default Value: 1
Type: int
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_monitor.requests_statistics.warmup_requests
How many requests to run before deviation events are calculated (to collect data for the average). This is used to calculate averages for relative events.
Default Value: 500
Type: int
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_monitor.requests_statistics.request_lifetime
The time duration (in seconds) for holding statistics in memory. If a request is not called within that time period, the statistics are reset.
Default Value: 300
Type: int
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_monitor.events_rules_file_name
The name and path to the file that contains the defininitons for event rules and actions. This file should not be edited manually.
Default Value: monitor_rules.json
Type: string
Modification Scope: ZEND_INI_SYSTEM
Available Since Version: 4.0
zend_monitor.aggregation.ttl
The frequency that the Monitor Node runs a load check.
Default Value: 300
Units: seconds
Type: int
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_monitor.aggregation.max_reporting_interval
The maximum time interval between reporting. The interval starts with 1 sec, then 2 sec, 4, 8, ... max_reporting_interval.
Default Value: 300
Units: seconds
Type: int
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_monitor.use_fast_timestamp
Enables fast time sampling which is dependent on CPU cycles and frequency, otherwise, the directive uses operating system timing (which may be less accurate).
Default Value: 0
Type: boolean
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_monitor.aggregate_by_url_query
When enabled, use the URL's query string as part of the aggregation key.
Default Value: 0
Type: boolean
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_monitor.aggregate_by_route
When enabled, use the request route details as part of the aggregation key.
Default Value: 1
Type: boolean
Modification Scope: ZEND_INI_ALL
Available Since Version: 8.5
zend_monitor.function_error_resolvers
A list of functions that can retrieve the error string of the corresponding function that returned error.
Default Value:
Type: string
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_monitor.event_tracing_mode
Determines integration with tracer mechanism in case of events that require a trace data dump. 0 - never generate trace files 1 - always collect and create trace file for every event 2 - if at least one rule has Code Tracing action enabled, trigger trace collection for next event 3 - if at least one rule has Code Tracing action enabled, collect and dump trace file
Default Value: 2
Type: int
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_monitor.event_tracing_duration
Enable code tracing collection for this period (seconds)
Default Value: 120
Type: int
Modification Scope: ZEND_INI_ALL
Available Since Version: 4.0
zend_monitor.send_request_id
When enabled, a cookie that represents the current request will be send to browser. Only needed for toolbar.
Default Value: 0
Type: boolean
Modification Scope: ZEND_INI_ALL
Available Since Version: 5.5
zend_monitor.enable_cli
Enable monitor on cli
Default Value: 0
Type: boolean
Modification Scope: ZEND_INI_ALL
Available Since Version: 9.2