API Reference Guide > Zend Monitor - Configuration Directives

Zend Monitor - Configuration Directives

Configuration Directives Summary

Directive

Type

Modification Scope

Description

zend_monitor.enable

boolean

PHP_INI_ALL

Enables or disables the Monitor component

zend_monitor.log_verbosity

integer

PHP_INI_SYSTEM

Monitor extension log verbosity level

zend_monitor.log_rotation_size

integer

PHP_INI_ALL

The maximum size of the log file before it is rotated

zend_monitor.shm_size

integer

PHP_INI_SYSTEM

Amount of shared memory to allocate for event collection

zend_monitor.max_shm_segment_size

integer

PHP_INI_SYSTEM

The maximum size of a shared memory segment

zend_monitor.events_transport_parameter

string

PHP_INI_SYSTEM

Communication transport for event reporting to the Monitor Node

zend_monitor.report_super_globals

string

PHP_INI_ALL

PHP Super-global variables to include in event reports

zend_monitor.security_black_list

string

PHP_INI_SYSTEM

PHP Super-global values that should not be included in Zend Monitor events

zend_monitor.super_globals_to_secure

string

PHP_INI_ALL

PHP Super-globals to pass through the security black-list filter

zend_monitor.max_super_globals_string_len

integer

PHP_INI_ALL

The maximum length of a superglobal to include in an event report

zend_monitor.event.request_slow_exec.disabled_on_function_slow_exec_event

boolean

PHP_INI_ALL

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

integer

PHP_INI_ALL

Sets the load level to disable Slow Request Execution events for the same request that already triggered a high load event.

zend_monitor.event.request_relative_slow_exec.min_exec_time

integer

PHP_INI_ALL

The minimum request execution time for a relativity check.

zend_monitor.event.request_relative_large_mem_usage.min_mem_usage

integer

PHP_INI_ALL

The minimum request memory usage for a relativity check

zend_monitor.event.request_relative_large_output_size.min_output_size

integer

PHP_INI_ALL

The minimum request output size for a relativity check

zend_monitor.event.zend_error.silence_level

integer

PHP_INI_ALL

Controls PHP Error event reporting when PHP error reporting is supressed

zend_monitor.requests_statistics.warmup_requests

integer

PHP_INI_ALL

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.

zend_monitor.requests_statistics.request_lifetime

integer

PHP_INI_ALL

How long to wait (in seconds) before statistics are reset if a request is not called

zend_monitor.events_rules_xml_file_name

string

PHP_INI_SYSTEM

Event rules XML configuration file.

zend_monitor.use_fast_timestamp

boolean

PHP_INI_ALL

Enables fast time sampling which is dependent on CPU cycles and frequency, otherwise, the directive uses operating system timing (which may be less accurate)

zend_monitor.event_tracing_mode

integer

PHP_INI_ALL

Determines integration with tracer mechanism in case of events that require a trace data dump

zend_monitor.aggregate_by_url_query

boolean

PHP_INI_ALL

When enabled, use the URL's query string as part of the aggregation key

Configuration Directive Details

zend_monitor.enable

Enables or disables the Monitor component. When set to On, Zend Monitor will colelct and report PHP events. When set to Off, PHP will not be monited

Type: boolean

Default Value: 1

Available since version 4.0

zend_monitor.log_verbosity

The extension's log verbosity level.

Type: integer

Default Value: 2

Available since version 4.0

zend_monitor.log_rotation_size

The maximum size of the log file before it is rotated

Type: integer

Units: MBytes

Default Value: 10

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

Type: integer

Default Values:

Available since version 4.0

zend_monitor.max_shm_segment_size

The maximum size of a shared memory segment

Type: integer

Default Values:

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

Type: string

Default Values:

Available since version 4.0

zend_monitor.report_super_globals

Which PHP Super-global variables should be included event reports. You can remove Super-globals from this, if they do not contain helpful debugging information, in order to reduce event reporting overhead. You may also add additional Super-globals if the data they contain is relevant for debugging.

Each Super-global is represented by a different character from the following list:

Type: string

Default Value: PRGCVF

Available since version 3.6

zend_monitor.security_black_list

Defines a list of PHP Super-global values that will not be collected for Zend Monitor events.

Each Super-globa (from the variables defined in zend_monitor.super_globals_to_secure) value who's key is listed here, will not be saved in event reports, and the string "<BLOCKED_VALUE>" will appear instead of the actual value.

The list of keys to remove can be defined in two ways:

  1. A comma-separated list of array keys to remove
  2. A path to a file, prefixed by '@'. This file should include a newline-separated list of array keys to remove.

Type: string

Available since version 3.6

zend_monitor.super_globals_to_secure

Defines which PHP Super-global variables should passed through the security black-list filter prior to being included in event reports. See zend_monitor.security_black_list for details

Each Super-global is represented by a different character from the following list:

Type: string

Default Value: PGCV

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 the end, to indicate that this is a partial value.

Type: integer

Default Value: 100

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.

Type: boolean

Default Value: 0

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.

Type: integer

Default Value: 0

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.

Type: integer

Units: milliseconds

Default Value: 100

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.

Type: integer

Units: KBytes

Default Value: 100

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.

Type: integer

Units: KBytes

Default Value: 100

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:

Type: integer

Default Value: 1

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.

Type: integer

Default Value: 500

Available since version 4.0

zend_monitor.requests_statistics.request_lifetime

How long (in seconds) to hold statistics in memory. If a request is not called within that time period, the statistics are reset

Type: integer

Default Value: 300

Available since version 4.0

zend_monitor.events_rules_xml_file_name

The name and path to the XML file that contains the defininitons for event rules and actions. This file should not be edited manually

Type: string

Default Value: events_rules.xml

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)

Type: boolean

Default Value: 1

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 means off, 1 means on, 2 means standby.

Type: integer

Default Value: 1

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

Type: boolean

Default Value: 1

Available since version 4.0

 

© 1999-2013 Zend Technologies, Ltd. All rights reserved.