Working with Monitoring Rules

To add a new rule:

1. In the UI, go to Applications | Monitoring Rules. 
2. Hover over, or select, the relevant rule group from the list, and click .
   The New/Edit Rule page is displayed.

3. Enter general properties for the new rule:
   • Rule Name - Enter a name for your new rule.
   • Type - Select the rule type for your new rule (e.g., Function Error).

   • Application - This field is set and cannot be configured.

   • Email - Enter an email address to receive event information for triggered events (overrules any email address entered on the Configurations | Monitor page).

   • Custom Actions - Enter a callback URL to execute a customized action for triggered events (overrules any URL entered on the Configurations | Monitor page).

4. Select a severity level for your rule by selecting the check-box on the relevant trigger container (Critical, Warning, Notice).

5. In the selected trigger container, select the triggered actions you wish to be executed for each event triggered by the rule:
   • Send email - Select to send an email for each triggered event to the email address entered in the rule's general properties area above.
   • Call URL - Select to execute the custom action at the URL entered in the rule's general properties area above.
   • Trace code - Select to execute code tracing for triggered events:
     • Activate Code Tracing for triggered events for a set amount of time (120 seconds by default) - better for production environments.
     • Always activate Code Tracing for triggered events - better for development and staging environments.

     Note:

     Code Tracing will not be activated if disabled on the Configurations | Monitor page. For more information, see Configuring Code Tracing.

   • Execute Time/ Execute Time % (Slow Function Execution and Slow Request Execution rule types) - Enter the threshold for triggering an event.
   • Memory Usage/ Memory Usage % (High Memory Usage rule type) - Enter the threshold for triggering an event.
   • PHP Error Type (PHP Error rule type) - Click to select a type of PHP error to be monitored.

6. Configure the rule's monitored functions (Slow Function Execution and Function Error rule types):
   1. Enter a function to be monitored in the designated field.
   2. Click Add Function.
   3. Remove functions by clicking the X button to the left of any given function.
7. Click .
   The new rule is added to the selected applications group, and automatically enabled.

8. Click to return to Applications | Monitoring Rules. 

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

Note:

Adding a new rule to the Global rules group, applies the rule to all deployed and defined applications on your server.

The icon appears next to the rule in the Rules list, indicating a customized rule.

To edit a rule:

1. In the UI, go to Applications | Monitoring Rules. 
2. Expand the relevant rule group by selecting it from the list, or clicking the Expand View arrow on the right, and click the link to the rule you wish to edit.
   The New/Edit Rule page is displayed.

3. Configure the rule. See Creating a New Rule above.

4. Click .

5. Click to return to Applications | Monitoring Rules.

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

Note:

Changes made to a child-rule, override global rule settings only in the application group the rule belongs to. The overridden icon is displayed by the rule, indicating the rule status. You can revert the rule back to its parent settings. See Reverting to Global Configurations.

The rule will now start generating events based on the new settings.

To enable a rule:

1. In the UI, go to Applications | Monitoring Rules. 

2. Expand the relevant rule group by selecting it from the list, or clicking the Expand View arrow on the right.
   

3. Select the check-box to the left of the rule, and in the Action bar, click .
   

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.

The rule status changes to , and begins to generate events.

To enable a trigger:

1. In the UI, go to Applications | Monitoring Rules. 
2. Expand the relevant rule group by selecting it from the list, or clicking the Expand View arrow on the right, and click the link to the rule you wish to edit.
   The New/Edit Rule page is displayed.
3. Enable a trigger according to the required severity level by selecting the relevant container (Critical, Warning, Notice):

4. Configure the thresholds for the new trigger. See steps 5-6 in Adding a New Rule for configuration options.
5. Click .
6. Click to return to Applications | Monitoring Rules.

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

Note:

This action cannot be performed for some of the Global rules. See Global Monitoring Rules for more information.

To revert a rule:

1. In the UI, go to Applications | Monitoring Rules. 

2. Expand the relevant rule group by selecting it from the list, or clicking the Expand View arrow on the right.
   

3. Hover over, or select, the overriding rule you wish to revert, and in the Actions column click .

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 disable a rule:

1. In the UI, go to Applications | Monitoring Rules. 

2. Expand the relevant rule group by selecting it from the list, or clicking the Expand View arrow on the right.
   

3. Select the check-box to the left of the rule, and in the Action bar, click .

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.

Note:

Disabling a Global rule does not disable its inheriting rules (child-rules).

The rule status changes to .

The rule will now stop generating events based on the rule's settings. Disabled rules will not generate trace file information.

To remove a rule:

1. In the UI, go to Applications | Monitoring Rules. 
2. Expand the relevant rule group by selecting it from the list, or clicking the Expand View arrow on the right.
3. Select the check-box to the left of the rule, and in the Actions column, click .
4. Click OK when prompted.
   The rule is removed from the Zend Monitor and the database and will no longer generate events.

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 export rules:

1. In the UI, go to Applications | Monitoring Rules. 
2. To export an entire rule group, hover over the relevant group, and click in the Actions column.
3. Browse to the required location on your file system, and click Save.

The exported rules are saved as an .xml file, and can now be included in an application package, and deployed.