The configurationGetMonitoringSettings Web API Method

This method gets monitoring settings values. The status of monitoring, statistics, and URL insight components can be enabled or disabled by setting the value to 1 or 0. This API is used in the Monitoring Settings page, see there for details.

URL Insight

• zray_snapshots_mode - This option enables or disables the Z-Ray Snapshots.

• zray_snapshots_interval - This option specifies the Z-Ray Snapshots Interval in seconds.

Monitoring and Statistics

• url_insight_mode - This option enables or disables URL Insight feature.

• monitoring - This option enables or disables event monitoring feature, including Events and Event Rules.

• statistics - This option enables or disables Statistics collection (Visible in the EventsStatisticsMonitoringDashboard page).

Events

• events_aggregation - This option enables or disables Events Aggregation.

• code_tracing_for_events - This option how code traces are generated for events:

  • Never

  • Rule-based

  • Activate Code Tracing

  • Always activate Code Tracing for triggered events

  • Always

Periodic Cleanup Settings

• delete_events_occur - This option configures the number of days in the Monitoring Events cleanup mechanism to delete events which did not occur in the last x days.

Triggered Actions Settings

• monitoring_rule_default_email - This options defines a Monitoring rule default email address, or multiple email addresses separated by commas, to be selected when event rules are triggering an email action

• monitoring_rule_default_callback_url - This options defines the Monitoring rule default callback URL.

Routing

• enable_route - This option enables or disables routing analysis, affecting Monitoring Events Aggregation and URL Insight.

Version: 1.14

Required Permissions: Read-only

HTTP method: GET

Supported by Editions: Zend Server

Request Parameters:  None

Expected Response Code: 200 OK. For more information see Response Format.

Response Format: Response successful message or error message

Possible Action Specific Error Codes:

Example

GET /ZendServer/Api/configurationGetMonitoringSettings 
Content-type: application/x-www-form-urlencoded

<?xml version="1.0" encoding="UTF-8"?>
<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.3">
	<responseData>
          <url_insight>
            <url_insight_mode>1</url_insight_mode>
            <zray_snapshots_mode>1</zray_snapshots_mode>
            <zray_snapshots_interval>1800</zray_snapshots_interval>
          </url_insight>
          <monitor_settings>
            <monitoring>1</monitoring>
            <statistics>1</statistics>
            <events_aggregation><![CDATA[none]]></events_aggregation>
            <code_tracing_for_events>2</code_tracing_for_events>
            <delete_events_occur>30</delete_events_occur>
            <monitoring_rule_default_email><![CDATA[]]></monitoring_rule_default_email>
            <monitoring_rule_default_callback_url><![CDATA[]]></monitoring_rule_default_callback_url>
            <enable_route>0</enable_route>
          </monitor_settings>
          <is_required_restart>
            <zend_url_insight.enable>1</zend_url_insight.enable>
            <zend_url_insight.zray_enable>0</zend_url_insight.zray_enable>
            <zend_url_insight.zray_dumps_interval>0</zend_url_insight.zray_dumps_interval>
            <zend_url_insight.aggregate_by_route>0</zend_url_insight.aggregate_by_route>
            <zend_monitor.event_tracing_mode>1</zend_monitor.event_tracing_mode>
            <zend_monitor_ui.expiration_days>1</zend_monitor_ui.expiration_days>
            <zend.monitor_generate_unique_events>1</zend.monitor_generate_unique_events>
            <zend.enable_route>1</zend.enable_route>
          </is_required_restart>
        </responseData>