Enabling/Disabling Z-Ray

To enable/disable Z-Ray:

1. In the Zend Server UI, go to the Configurations | Z-Ray page.
2. In the Access section, select Z-Ray access mode: Enabled/Disabled.
3. Click Save & Restart Zend Server.
4. 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.
   

Note:

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.

To enable Z-Ray for an IP:

1. In the Zend Server UI, go to the Configurations | Z-Ray page.
2. In the Mode section (displayed by default when opening the page), select Secured.
3. Click Save and Restart Zend Server.
   
4. Select the Access Tokens section.
5. At the top of the Access Tokens list, click the Create New Token button.
   The Create Access Token dialog is displayed.

6. Configure the new token:
   • Name - Enter a description for the new token for reference purposes only.

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

   • URL Restriction (Optional) - Enter the URL of a page you wish to enable access to Z-Ray for.

     Note:

     This token setting option is not mandatory. However, leaving this field empty will allow access to Z-Ray for all pages on the server.
     

   • Time Restriction - Set a time limit for the access token, after which access to Z-Ray will no longer be enabled.

7. Click Create Token.
   A token is created and added to the Tokens list.
8. To use the token, add the token URL as a GET parameter to the page URL. For example:

http://example.com/path/page.php?zsdbt=<token-string>

9. To remove an access token, click the Remove Token button under the Actions column in the Tokens list. To expired an access token without removing it, click the Expire Token button .

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

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