Enabling/Disabling Z-Ray

This topic describes how to work with Z-Ray's various access modes:

  • Enabled Mode - The default mode when launching Zend Server with the development profile. In this mode, Z-Ray collects data for all requests made to the web server.
  • Selective Mode - This mode allows secured access to Z-Ray for specific IPs and URLs, and for a specific time duration, and is ideal for production environments.
  • Disabled Mode - The default mode when launching Zend Server with on of the two production profiles (Single/Cluster). This mode disables Z-Ray data collection for every page located on your web server. Z-Ray Snapshots for URL Insight however, will not be affected.
The Z-Ray can be enabled and disabled at any point as long as Zend Server was launched. If Zend Server has not been launchedlaunched, you will be asked to do so before being able to work with Z-Ray.

This procedure describes how to enable Z-Ray. When in Enabled Mode, Z-Ray collects data for all requests made to the web server. This mode is meant for developers and should not be used in production.

These actions can only be performed by an Administrator.

Instructions on how to complete a procedure

To enable Z-Ray:

  1. In the Zend Server UI, go to the Z-Ray | Mode page.
  2. In the Mode tab, select the Z-Ray Enabled mode.
  3. Configure the following settings:
    • Display Z-Ray on all pages open in a browser - Selecting this check-box displays Z-Ray on any HTML-based page located on your web server and open in a browser.
      This option is selected by default. Deselecting this check-box displays Z-Ray only on Z-Ray Live!
    • Allow server-side actions - Selecting this check-box allows users to perform server-side actions from Z-Ray.
  4. Click .
  5. When asked to verify the action, select the check-box in the dialog, and click Proceed.
    Zend Server restarts and the access mode is applied.
 
For information on how to remove Z-Ray from the screen, or close it for an entire browser session, see Minimizing and Closing Z-Ray.

The Z-Ray Selective Mode allows you to enable Z-Ray for specific IPs or URLs, and for a specific time duration. You can also add an additional security layer by requiring the passing of an access token to the URL as a GET parameter.

These actions can only be performed by an Administrator.

Instructions on how to complete a procedure

To allow selective access to Z-Ray:

  1. In the Zend Server UI, go to the Z-Ray | Mode page.
  2. In the Mode tab (displayed by default when opening the page), select Selective.
  3. Click Save and Restart Zend Server.
  4. Select the Selective Access tab.
  5. Click the Allow Selective Access button.
    The Allow Selective Access wizard is displayed.

  6. In the General page, configure the following:
    • Name - Enter a description for the new access configurations for reference purposes only.
    • Require Token - Select this check-box to require an access token in for accessing Z-Ray.
      Using an access token is an additional layer of security, requiring users to pass a token to the requested URL as a query (GET) parameter.
    • Expiration - Set a timeframe after which access is denied.
      Once selective access is created, it is also made active immediately.
  7. Click Next.
    The Security page is displayed.

  8. Configure the following settings:
    • IP Restriction - Enter a comma-separated list of IPs representing the machines you wish to enable Z-Ray on, either as a masked range or in CIDR.
      Examples: 127.0.0.1 will limit access to just the local machine, 10.0.0.0/8 will open up access to any address that starts with 10.
      To restrict access to Z-Ray for your machine only, select the Use my browser's IP check-box.
    • URL Restriction - Enter the URL of a page you wish to enable access to Z-Ray for.
      This option is not mandatory. However, leaving this field empty will allow access to Z-Ray for all pages on the server.
  9. Click Next.
    The Actions page is displayed.

  10. Configure the following settings:
    • Display Z-Ray on all pages open in a browser - Select this check-box to display Z-Ray on any HTML-based page located on your web server and open in a browser.
      In some cases (e.g. debugging support cases), in which you do not wish Z-Ray to be displayed in the browser, deselect this check-box to display Z-Ray only on Z-Ray Live!
    • Allows server-side actions - Selecting this check-box allows users to perform server-side actions from Z-Ray.
  11. Click Submit.
    A selective access token is created and added to the list.
 

When using Z-Ray in Selective Mode, a lock icon will be displayed on the left.

If you do not wish to view Z-Ray on a specific application or page, you can disable it using the methods described below.

Instructions on how to complete a procedure

Using API

Insert the following API to the application or page you wish to disable the injection of Z-Ray but retain data collection:

zray_disable(false);

Insert the following API to the application or page you wish to disable both the injection of Z-Ray and data collection:

zray_disable(true);

Using a GET parameter

Pass the following GET parameter in the page URL:

ZRayDisable=1

Using a header

Send the following request header:

ZRAY-DISABLE=1