Configuring Z-Ray

To configure the availability of Z-Ray:

1. In the UI, go to the Z-Ray | Settings page.
2. In the Mode tab, configure Z-Ray access mode:
   • Enabled Mode - select this option (selected by default for a Zend Server launched with a Development launch profile), to enable Z-Ray on all pages on your web server.
   • Selective Mode - select this option to allow selective access to Z-Ray. For more information on enabling this mode, see Allowing Selective Access.
   • Disabled Mode - select this option (selected by default for a Zend Server launched with a Production launch profile), to disable Z-Ray on all pages on your Web server.
3. At the bottom of the section, click Save to apply the change.

For more information on enabling and disabling Z-Ray, see Enabling/Disabling Z-Ray.

To configure data collection settings for Z-Ray:

1. In the UI, go to the Z-Ray | Settings page.
2. Select the Data Collection tab.
3. Configure the following settings:
   • Enable Backtracing - Enable or disable backtracing in Z-Ray.
   • Enable Backtracing for Error and Warnings - Enable or disable collection of backtraces for Errors and Warnings (only available if backtracing is enabled above).
   • Collect Backtraces for Database Queries - Enable or disable collection of backtraces for database queries (only available if backtracing is enabled above).
   • Collect Extension Data - Enable or disable collection of data for Z-Ray extensions. Disabling data collection will remove extension panels from Z-Ray.
   • Max Log Entries - Enter the max number of log entries displayed in the Errors & Warnings panel.
4. At the bottom of the section, click Save to apply your changes.

To clear Z-Ray information:

1. In the UI, go to the Configurations | Components page.
2. Under the Actions column in the Components list, select the clear icon for the Z-Ray component.
3. When prompted, click OK.
   Z-Ray information is cleared from the database.

Tip:

You can configure the number of recent URLs for which data is kept after a manual cleanup. To do this, configure the 'zray.cleanup_keep_urls' directive. For more information, see Configuring Z-Ray Directives above.

To disable Z-Ray tracking:

1. In the UI, go to the Configurations | Components page.
2. From the Components list, select the Z-Ray component.
   The expanded view displays all available configuration directives.

3. Turn off the following directives:
   • 'zray.collect_events' - Turn off to disable tracking for the Monitor Events panel.

   • 'zray.collect_log_entries' - Turn off to disable tracking for the Log Entries panel.

   • 'zray.collect_superglobals' - Turn off to disable tracking for the PHP Variables panel.
   • 'zray.collect_functions' - Turn off to disable tracking for the Functions panel.
   • 'zray.collect_sql' - Turn off to disable tracking for the Database Queries panel.
4. In the Action bar, click Save.

5. In the toolbar, the restart icon lights up , indicating a restart is needed to apply changes. Click to restart server and apply changes.
   For information on restarting in Zend Server, see Server Restart.

To configure Z-Ray:

1. In the UI, go to the Configurations | Components page.
2. From the Components list, select the Z-Ray component.
   The expanded view displays all available configuration directives.

3. Configure the directives as you see fit, and in the Action bar, click Save.

4. In the toolbar, the restart icon lights up , indicating a restart is needed to apply changes. Click to restart server and apply changes.
   For information on restarting in Zend Server, see Server Restart.

To privacy settings for Z-Ray:

1. In the UI, go to the Z-Ray | Settings page.
2. Select the Privacy tab.
3. Configure the following settings:
   • Enable Attribute Masking - Select whether to enable or disable masking.
   • Attributes List - Add a comma-separated list of attributes for which values you want to mask. Values can be one of: whole word, prefix, suffix (e.g., PASSWORD*).
4. At the bottom of the section, click Save to apply your changes.

To configure advanced settings for Z-Ray:

1. In the UI, go to the Z-Ray | Settings page.
2. Select the Advanced tab.
3. Configure the following settings:
   • Show in iFrame - Decide whether to show Z-Ray in every iFrame. If this option is not selected, only one Z-Ray is displayed at the bottom of the page, aggregating all the request information for the entire page.
   • Show Silenced Log Entries - Decide whether to display log entries for expressions silenced by the '@' silence operator.
   • Function Groups Filtering - Enter a comma separated list of your own function groups or namespaces to be able to filter the Functions list accordingly. Existing groups can be removed.
   • Z-Ray URL - Allows you to specify a custom URL for displaying Z-Ray.
   • Collapse/Expand Keyboard Shortcut - Enter a keyboard shortcut for collapsing and expanding Z-Ray. To disable the shortcut, leave the field empty.
   • Maximum Request Count - Enter the maximum amount of requests Z-Ray can track before needing to clean request info.
   • Tree-View Maximum Items per Level - Set the maximum amount of items to be displayed for each level within a Z-Ray tree-view.
   • Tree-View Maximum Items - Set the maximum amount of items to be displayed in a Z-Ray tree-view (including top and sub levels). Setting a high value will effect the performance of your browser.
4. At the bottom of the section, click Save to apply your changes.