Dell Technologies ECS REST API
Search (SHIFT+S)
ECS Management API
ECS Object Service API
ECS API Changes

Get Alert Policy Metadata

GET /vdc/alertpolicy/metadata

Returns information about currently supported metrics, their supported statistics and metric specific restrictions on policy configurations

Required Roles

This call has no restrictions.

Response Body

Indicating success or failure of the alert policy get metadata operation

Examples

Request
GET https://192.168.0.0:4443/vdc/alertpolicy/metadata HTTP/1.1

Content-Type: application/xml
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>
Response
HTTP/1.1 200 OK
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<alert_policy_metadata>
  <MetricType name="Geo Replication Statistics">
    <Metric name="RPO">
      <dataSourceMetadata database="monitoring_last" table="cm_Geo_Replication_Statistics_Replication_Group_Min_RPO" field="RPO_Lag_Millis" vdcResourceName="Replication_Group"
                                excludeResource="urn:storageos:ReplicationGroupInfo:00000000-0000-0000-0000-000000000000:global"/>
      <stats>MAX</stats>
      <msgFormat>RPO for replication group ${resourceName} is ${inspectorValue} greater than ${thresholdValue} threshold set.</msgFormat>
      <thresholdUnits>HOURS</thresholdUnits>
      <isPerInstanceMetric>false</isPerInstanceMetric>
      <minDatapointsToConsider>1</minDatapointsToConsider>
      <maxDatapointsToConsider>10</maxDatapointsToConsider>
      <minThreshold>3600000<!-- millis - 1 hr --></minThreshold>
      <maxThreshold>36000000<!-- millis - 10 hr --></maxThreshold>
      <minPeriod>600000<!-- millis - 10 mins --></minPeriod>
      <maxPeriod>3600000<!-- millis - 60 mins --></maxPeriod>
    </Metric>
  </MetricType>
  <MetricType name="CAS GC Statistics">
    <Metric name="Journal Parser Lag">
      <stats>COUNT</stats>
      <msgFormat>Journal parsing speed is slow.</msgFormat>
      <thresholdUnits>DAYS</thresholdUnits>
      <maxPeriod>86400000</maxPeriod>
      <minPeriod>43200000</minPeriod>
      <minDatapointsToConsider>1</minDatapointsToConsider>
      <maxDatapointsToConsider>1</maxDatapointsToConsider>
      <maxThreshold>5616000000</maxThreshold>
      <minThreshold>2592000000</minThreshold>
      <isPerInstanceMetric>false</isPerInstanceMetric>
      <sensorMetadata>
        <inspector>com.emc.storageos.sensorimplementation.inspector.ObjectGCJournalParserInspector</inspector>
        <evaluator>TimeThresholdEvaluators</evaluator>
        <symptomRetreiver>com.emc.storageos.sensorframework.util.ObjectGCJPSymptomRetriever</symptomRetreiver>
      </sensorMetadata>
    </Metric>
    <Metric name="Reference Collection Lag">
      <stats>COUNT</stats>
      <msgFormat>CAS Processing reference collection speed is slow.</msgFormat>
      <thresholdUnits>DAYS</thresholdUnits>
      <maxPeriod>86400000</maxPeriod>
      <minPeriod>43200000</minPeriod>
      <minDatapointsToConsider>1</minDatapointsToConsider>
      <maxDatapointsToConsider>1</maxDatapointsToConsider>
      <maxThreshold>6480000000</maxThreshold>
      <minThreshold>3456000000</minThreshold>
      <isPerInstanceMetric>false</isPerInstanceMetric>
      <sensorMetadata>
        <inspector>com.emc.storageos.sensorimplementation.inspector.ObjectGCReferenceCollectionInspector</inspector>
        <evaluator>TimeThresholdEvaluators</evaluator>
        <symptomRetreiver>com.emc.storageos.sensorframework.util.ObjectGCRefCollnSymptomRetriever</symptomRetreiver>
      </sensorMetadata>
    </Metric>
    <Metric name="Cleanup Task Lag">
      <stats>COUNT</stats>
      <msgFormat>CAS Processing object cleanup speed is slow.</msgFormat>
      <thresholdUnits>DAYS</thresholdUnits>
      <maxPeriod>86400000</maxPeriod>
      <minPeriod>43200000</minPeriod>
      <minDatapointsToConsider>1</minDatapointsToConsider>
      <maxDatapointsToConsider>1</maxDatapointsToConsider>
      <maxThreshold>8208000000</maxThreshold>
      <minThreshold>5184000000</minThreshold>
      <isPerInstanceMetric>false</isPerInstanceMetric>
      <sensorMetadata>
        <inspector>com.emc.storageos.sensorimplementation.inspector.ObjectGCObjectCleanupInspector</inspector>
        <evaluator>TimeThresholdEvaluators</evaluator>
        <symptomRetreiver>com.emc.storageos.sensorframework.util.ObjectGCCleanupSymptomRetriever</symptomRetreiver>
      </sensorMetadata>
    </Metric>
    <Metric name="CAS GC Status">
      <stats>COUNT</stats>
      <msgFormat>CAS Processing is paused.</msgFormat>
      <maxPeriod>86400000</maxPeriod>
      <minPeriod>43200000</minPeriod>
      <minDatapointsToConsider>1</minDatapointsToConsider>
      <maxDatapointsToConsider>1</maxDatapointsToConsider>
      <maxThreshold>1</maxThreshold>
      <minThreshold>1</minThreshold>
      <isPerInstanceMetric>false</isPerInstanceMetric>
      <sensorMetadata>
        <inspector>com.emc.storageos.sensorimplementation.inspector.StatusInspector</inspector>
        <evaluator>IntegerThresholdEvaluators</evaluator>
        <symptomRetreiver>com.emc.storageos.sensorframework.util.ObjectGCStatusSymptomRetriever</symptomRetreiver>
      </sensorMetadata>
    </Metric>
  </MetricType>
  <MetricType name="Garbage Collection Statistics">
    <Metric name="Btree Chunk Level GC">
      <stats>COUNT</stats>
      <msgFormat>System metadata garbage reclamation throughput is too slow to catch up with garbage detection. Please involve ECS engineering.</msgFormat>
      <thresholdUnits>GB</thresholdUnits>
      <maxPeriod>86400000</maxPeriod>
      <minPeriod>10800000</minPeriod>
      <minDatapointsToConsider>1</minDatapointsToConsider>
      <maxThreshold>1000</maxThreshold>
      <minThreshold>10</minThreshold>
      <isPerInstanceMetric>false</isPerInstanceMetric>
      <sensorMetadata>
        <inspector>com.emc.storageos.sensorimplementation.inspector.SRInspector</inspector>
      </sensorMetadata>
    </Metric>
    <Metric name="Btree Disk Level GC">
      <stats>COUNT</stats>
      <msgFormat>Capacity free-up throughput is too slow to catch up with system metadata garbage reclamation. Please involve ECS engineering.</msgFormat>
      <thresholdUnits>GB</thresholdUnits>
      <maxPeriod>86400000</maxPeriod>
      <minPeriod>10800000</minPeriod>
      <minDatapointsToConsider>1</minDatapointsToConsider>
      <maxThreshold>1000</maxThreshold>
      <minThreshold>10</minThreshold>
      <isPerInstanceMetric>false</isPerInstanceMetric>
      <sensorMetadata>
        <inspector>com.emc.storageos.sensorimplementation.inspector.SRInspector</inspector>
      </sensorMetadata>
    </Metric>
    <Metric name="Btree Partial GC">
      <stats>COUNT</stats>
      <msgFormat>Partial GC for system metadata is too slow. Please involve ECS engineering.</msgFormat>
      <thresholdUnits>GB</thresholdUnits>
      <maxPeriod>86400000</maxPeriod>
      <minPeriod>10800000</minPeriod>
      <minDatapointsToConsider>1</minDatapointsToConsider>
      <maxThreshold>1000</maxThreshold>
      <minThreshold>10</minThreshold>
      <isPerInstanceMetric>false</isPerInstanceMetric>
      <sensorMetadata>
        <inspector>com.emc.storageos.sensorimplementation.inspector.SRInspector</inspector>
      </sensorMetadata>
    </Metric>
    <Metric name="Repo Chunk Level GC">
      <stats>COUNT</stats>
      <msgFormat>System metadata garbage reclamation throughput is too slow to catch up with garbage detection. Please involve ECS engineering.</msgFormat>
      <thresholdUnits>GB</thresholdUnits>
      <maxPeriod>86400000</maxPeriod>
      <minPeriod>10800000</minPeriod>
      <minDatapointsToConsider>1</minDatapointsToConsider>
      <maxThreshold>1000</maxThreshold>
      <minThreshold>10</minThreshold>
      <isPerInstanceMetric>false</isPerInstanceMetric>
      <sensorMetadata>
        <inspector>com.emc.storageos.sensorimplementation.inspector.SRInspector</inspector>
      </sensorMetadata>
    </Metric>
    <Metric name="Repo Disk Level GC">
      <stats>COUNT</stats>
      <msgFormat>User garbage reclamation throughput is too slow to catch up with garbage detection. Please involve ECS engineering.</msgFormat>
      <thresholdUnits>GB</thresholdUnits>
      <maxPeriod>86400000</maxPeriod>
      <minPeriod>10800000</minPeriod>
      <minDatapointsToConsider>1</minDatapointsToConsider>
      <maxThreshold>1000</maxThreshold>
      <minThreshold>10</minThreshold>
      <isPerInstanceMetric>false</isPerInstanceMetric>
      <sensorMetadata>
        <inspector>com.emc.storageos.sensorimplementation.inspector.SRInspector</inspector>
      </sensorMetadata>
    </Metric>
    <Metric name="Repo Partial GC">
      <stats>COUNT</stats>
      <msgFormat>Partial GC for user garbage is too slow. Please involve ECS engineering.</msgFormat>
      <thresholdUnits>GB</thresholdUnits>
      <maxPeriod>86400000</maxPeriod>
      <minPeriod>10800000</minPeriod>
      <minDatapointsToConsider>1</minDatapointsToConsider>
      <maxThreshold>1000</maxThreshold>
      <minThreshold>10</minThreshold>
      <isPerInstanceMetric>false</isPerInstanceMetric>
      <sensorMetadata>
        <inspector>com.emc.storageos.sensorimplementation.inspector.SRInspector</inspector>
      </sensorMetadata>
    </Metric>
    <Metric name="GC Status">
      <stats>COUNT</stats>
      <msgFormat>Space reclamation for user data / system metadata is disabled. Please make sure it's disabled for temporary purpose, and re-enable it when ready.</msgFormat>
      <maxPeriod>604800000</maxPeriod>
      <minPeriod>43200000</minPeriod>
      <minDatapointsToConsider>1</minDatapointsToConsider>
      <maxThreshold>1</maxThreshold>
      <minThreshold>1</minThreshold>
      <isPerInstanceMetric>false</isPerInstanceMetric>
      <sensorMetadata>
        <inspector>com.emc.storageos.sensorimplementation.inspector.StatusInspector</inspector>
        <evaluator>IntegerThresholdEvaluators</evaluator>
      </sensorMetadata>
    </Metric>
  </MetricType>
  <MetricType name="Btree Statistics">
    <Metric name="Final Sweep Stage Percentage">
      <stats>COUNT</stats>
      <msgFormat>FinalSweepStage for DT ${resourceName} is ${inspectorValue}% greater than ${thresholdValue}% threshold set.</msgFormat>
      <maxPeriod>3600000</maxPeriod>
      <minPeriod>600000</minPeriod>
      <minDatapointsToConsider>1</minDatapointsToConsider>
      <maxDatapointsToConsider>1</maxDatapointsToConsider>
      <maxThreshold>30</maxThreshold>
      <minThreshold>10</minThreshold>
      <isPerInstanceMetric>false</isPerInstanceMetric>
      <sensorMetadata>
        <inspector>com.emc.storageos.sensorimplementation.inspector.BtreeInspector</inspector>
      </sensorMetadata>
    </Metric>
    <Metric name="Memory Allocated outside btree write cache">
      <stats>COUNT</stats>
      <msgFormat>For ${resourceName} process memory of ${inspectorValue} bytes is allocated outside btree write cache</msgFormat>
      <maxPeriod>3600000</maxPeriod>
      <minPeriod>600000</minPeriod>
      <minDatapointsToConsider>1</minDatapointsToConsider>
      <maxDatapointsToConsider>5</maxDatapointsToConsider>
      <maxThreshold>0</maxThreshold>
      <minThreshold>0</minThreshold>
      <isPerInstanceMetric>true</isPerInstanceMetric>
      <sensorMetadata>
        <inspector>com.emc.storageos.sensorimplementation.inspector.BtreeInspector</inspector>
      </sensorMetadata>
    </Metric>
    <Metric name="Memory Table Free Space Percent">
      <stats>COUNT</stats>
      <msgFormat>Memory table size for ${resourceName} process is ${inspectorValue}% less than specified threshold of ${thresholdValue}%</msgFormat>
      <maxPeriod>3600000</maxPeriod>
      <minPeriod>600000</minPeriod>
      <minDatapointsToConsider>1</minDatapointsToConsider>
      <maxDatapointsToConsider>5</maxDatapointsToConsider>
      <maxThreshold>40</maxThreshold>
      <minThreshold>20</minThreshold>
      <isPerInstanceMetric>true</isPerInstanceMetric>
      <sensorMetadata>
        <inspector>com.emc.storageos.sensorimplementation.inspector.BtreeInspector</inspector>
      </sensorMetadata>
    </Metric>
  </MetricType>
</alert_policy_metadata>
Dell Technologies ECS REST API v3.8.0.2.138627.f5f4887