Configuring Z-Ray

This topic describes how to configure Z-Ray settings.

This procedure describes how to configure Z-Ray availability.

Instructions on how to complete a procedure

To configure the availability of Z-Ray:

  1. In the UI, go to the Z-Ray | Mode page and 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.
  1. 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.

This procedure describes how to configure how Z-Ray handles data collection.

Instructions on how to complete a procedure

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.
 

 

This procedure describes how to manually clear the database from information gathered by Z-Ray.

Note:

The database is automatically cleared from data collected by Z-Ray. The frequency and behavior of this automatic process can be configured by configuring Z-ray directives. For more information, see Configuring Z-Ray Directives above.

Instructions on how to complete a procedure

To clear Z-Ray information:

  1. In the UI, go to the Administration | 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.

This procedure describes how to disable Z-Ray tracking for a specific panel.

Note:

This action can only be performed for the following Z-Ray panels: Monitor Events, Log Entries, and PHP Variables.

Instructions on how to complete a procedure

To disable Z-Ray tracking:

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

  1. 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.
  2. In the Action bar, click Save.

  3. 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.

This procedure describes how to configure Z-Ray configuration directives. These directives define the way Z-Ray collects, handles and stores the request data.

For example, the 'zray_history_time' directive determines how long Z-Ray request data is kept before being automatically cleared from the database.

For a list of the available directives, see Zend Server Z-Ray - Configuration Directives.

Instructions on how to complete a procedure

To configure Z-Ray:

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

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

  2. 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.

For information on privacy in Zend Server, see our Privacy page.

This procedure describes how to configure advanced settings for Z-Ray, including iFrame behavior, function filtering and more.

Instructions on how to complete a procedure

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.