Zend Server Z-Ray - Configuration Directives

This topic lists all the configuration directives for Zend Server Z-Ray.

Configuration Directives Summary

The table below is a summary of all the Zend Server Z-Ray configuration directives, and displays the directive name, its default value, and a description:

Directive	Default Value	Description
zray.enable_attribute_masking	1	Determines whether masking of key attributes is enabled or disabled.
zray.max_number_log_entries	50	Set the maximum number of errors and warnings to collect
zray.reload_zray_access_file_interval	10	Check for ZRay access file for modification every N seconds
zray.collect_backtrace.errors_warnings	1	Enable collection of backtraces for Errors and Warnings
zray.collect_backtrace.sql_queries	1	Enable collection of backtraces for SQL queries
zray.disable_injection	0	When in 'Enable Mode' disable ZRay injection
zray.disable_actions	0	When in 'Enable Mode' disable ZRay actions
zray.enable_extensibility	1	Load and compile ZRay extensibility extensions
zray.collect_blacklist	.png,.css,.js,.jpg,.jpeg	Disable zray If the URL ends with a suffix from the list. This is a comma delimited list
zray.attribute_masking_list	password,password,credit_card,credit_card,creditcard,creditcard,ccv,ssn,pincode	Comma-separated list of key attributes for which values should be masked.
zray.cleanup_frequency	10	Frequency for automatic cleanup. 0 to disable.
zray.max_db_size	1	Database size limit for requests data
zray.history_time	7	Time limit for kept requests data
zray.cleanup_keep_urls	7	The number of most recent URLs for which data is retained after a manual cleanup is executed
zray.enable	1	Enable Z-Ray
zray.enable_cli	0	Enable Z-Ray for CLI requests
zray.allowed_hosts		Comma separated allowed list to view the Z-Ray
zray.zendserver_ui_url		The Url of the Zend Server UI. e.g. 'http://10.1.1.1:10081/ZendServer'
zray.url_cache_size	1	Size limit for internal caching of unique URLs and SQL prepared statements
zray.collect_sql	1	Enable collection of data for executed SQL queries
zray.collect_functions	1	Enable collection of data for executed PHP functions
zray.collect_breakdown	1	Enable collection of processing breakdown for requests. Also affects the 'Processing Breakdown' graph in the Statistics gallery.
zray.collect_events	1	Enable collection of data for Zend Monitor Events
zray.collect_errors	1	Enable collection of PHP errors, warnings and notices
zray.extensions_dir	ZEND_PREFIX/var/plugins	The folder where user's extensions live
zray.verify_accept_text_html	1	Z-Ray will show only if client sends text/html accept header
zray.support_broken_html	1	Z-Ray will attempt to inject itself inside broken html outputs
zray.max_bound_value_size	1	Size limit for collected SQL bound values
zray.collect_backtrace	1	Enable or disable backtrace collection
zray.max_backtrace_frames	100	Number of frames to keep per PHP backtrace
zray.collect_superglobals	1	Enable or disable request super globals collection
zray.collect_raw_output	1	Store raw output in zray's database. possible values: 1 - store. 0 - don't store

Configuration Directives Details

The list below contains information for all the available configuration directives for Zend Server Z-Ray: their description, type, units, default value, modification scope, and the Zend Server version they became available in.

zray.enable_attribute_masking

Determines whether masking of key attributes is enabled or disabled.

Default Value: 1

Type: boolean

Modification Scope: ZEND_INI_ALL

Available Since Version: 8.0

zray.max_number_log_entries

Set the maximum number of errors and warnings to collect

Default Value: 50

Type: int

Modification Scope: ZEND_INI_ALL

Available Since Version: 8.5

zray.reload_zray_access_file_interval

Check for ZRay access file for modification every N seconds

Default Value: 10

Type: int

Modification Scope: ZEND_INI_ALL

Available Since Version: 8.5

zray.collect_backtrace.errors_warnings

Enable collection of backtraces for Errors and Warnings

Default Value: 1

Type: boolean

Modification Scope: ZEND_INI_ALL

Available Since Version: 8.5

zray.collect_backtrace.sql_queries

Enable collection of backtraces for SQL queries

Default Value: 1

Type: boolean

Modification Scope: ZEND_INI_ALL

Available Since Version: 8.5

zray.disable_injection

When in 'Enable Mode' disable ZRay injection

Default Value: 0

Type: boolean

Modification Scope: ZEND_INI_ALL

Available Since Version: 8.5

zray.disable_actions

When in 'Enable Mode' disable ZRay actions

Default Value: 0

Type: boolean

Modification Scope: ZEND_INI_ALL

Available Since Version: 8.5

zray.enable_extensibility

Load and compile ZRay extensibility extensions

Default Value: 1

Type: boolean

Modification Scope: ZEND_INI_ALL

Available Since Version: 8.5

zray.collect_blacklist

Disable zray If the URL ends with a suffix from the list. This is a comma delimited list

Default Value: .png,.css,.js,.jpg,.jpeg

Type: string

Modification Scope: ZEND_INI_ALL

Available Since Version: 8.0

zray.attribute_masking_list

Comma-separated list of key attributes for which values should be masked to ensure user privacy. Values can be one of: whole word, prefix (e.g. word*), suffix (e.g. *word). Case insensitive.

Default Value: password*,*password,*credit_card,credit_card*,*creditcard,creditcard*,ccv,ssn,pincode

Type: string

Modification Scope: ZEND_INI_ALL

Available Since Version: 8.0

zray.cleanup_frequency

Frequency for automatic cleanup. 0 to disable.

Default Value: 10

Units: minutes

Type: float

Available Since Version: 7.0

zray.max_db_size

Database size limit for requests data

Default Value: 1

Units: GBytes

Type: float

Available Since Version: 7.0

zray.history_time

Time limit for kept requests data

Default Value: 7

Units: days

Type: float

Available Since Version: 7.0

zray.cleanup_keep_urls

The number of most recent URLs for which data is retained after a manual cleanup is executed

Default Value: 7

Type: int

Available Since Version: 7.0

zray.enable

Enable Z-Ray

Default Value: 1

Type: int

Modification Scope: ZEND_INI_ALL

Available Since Version: 7.0

zray.enable_cli

Enable Z-Ray for CLI requests

Default Value: 0

Type: boolean

Modification Scope: ZEND_INI_ALL

Available Since Version: 9.0

zray.allowed_hosts

Comma separated allowed list to view the Z-Ray

Default Value:

Type: string

Modification Scope: ZEND_INI_ALL

Available Since Version: 7.0

zray.zendserver_ui_url

The Url of the Zend Server UI. e.g. 'http://10.1.1.1:10081/ZendServer'

Default Value:

Type: string

Modification Scope: ZEND_INI_ALL

Available Since Version: 7.0

zray.url_cache_size

Size limit for internal caching of unique URLs and SQL prepared statements

Default Value: 1

Units: MBytes

Type: int

Modification Scope: ZEND_INI_ALL

Available Since Version: 7.0

zray.collect_sql

Enable collection of data for executed SQL queries

Default Value: 1

Type: boolean

Modification Scope: ZEND_INI_ALL

Available Since Version: 7.0

zray.collect_functions

Enable collection of data for executed PHP functions

Default Value: 1

Type: boolean

Modification Scope: ZEND_INI_ALL

Available Since Version: 7.0

zray.collect_breakdown

Enable collection of processing breakdown for requests. Also affects the 'Processing Breakdown' graph in the Statistics gallery.

Default Value: 1

Type: boolean

Modification Scope: ZEND_INI_ALL

Available Since Version: 7.0

zray.collect_events

Enable collection of data for Zend Monitor Events

Default Value: 1

Type: boolean

Modification Scope: ZEND_INI_ALL

Available Since Version: 7.0

zray.collect_errors

Enable collection of PHP errors, warnings and notices

Default Value: 1

Type: boolean

Modification Scope: ZEND_INI_ALL

Available Since Version: 7.0

zray.extensions_dir

The folder where user's extensions live

Default Value: ZEND_PREFIX/var/plugins

Type: string

Modification Scope: ZEND_INI_ALL

Available Since Version: 7.0

zray.verify_accept_text_html

Z-Ray will show only if client sends text/html accept header

Default Value: 1

Type: boolean

Modification Scope: ZEND_INI_ALL

Available Since Version: 7.0

zray.support_broken_html

Z-Ray will attempt to inject itself inside broken html outputs

Default Value: 1

Type: boolean

Modification Scope: ZEND_INI_ALL

Available Since Version: 7.0

zray.max_bound_value_size

Size limit for collected SQL bound values

Default Value: 1

Units: KBytes

Type: int

Modification Scope: ZEND_INI_ALL

Available Since Version: 7.0

zray.collect_backtrace

Enable or disable backtrace collection

Default Value: 1

Type: boolean

Modification Scope: ZEND_INI_ALL

Available Since Version: 7.0

zray.max_backtrace_frames

Number of frames to keep per PHP backtrace

Default Value: 100

Type: int

Modification Scope: ZEND_INI_ALL

Available Since Version: 7.0

zray.collect_superglobals

Enable or disable request super globals collection

Default Value: 1

Type: boolean

Modification Scope: ZEND_INI_ALL

Available Since Version: 7.0

zray.collect_raw_output

Store raw output in zray's database. possible values: 1 - store. 0 - don't store

Default Value: 1

Type: int

Modification Scope: ZEND_INI_ALL

Available Since Version: 8.0