tests/policy/api/data/onap.policy.monitoring.tcagen2.v1.json

   1 {
   2   "tosca_definitions_version": "tosca_simple_yaml_1_1_0",
   3   "policy_types": {
   4     "onap.policies.Monitoring": {
   5       "derived_from": "tosca.policies.Root",
   6       "version": "1.0.0",
   7       "description": "a base policy type for all policies that governs monitoring provisioning"
   8     },
   9     "onap.policies.monitoring.tcagen2": {
  10       "derived_from": "onap.policies.Monitoring",
  11       "version": "1.0.0",
  12       "properties": {
  13         "tca.policy": {
  14           "type": "onap.datatypes.monitoring.tca_policy",
  15           "description": "TCA Policy JSON"
  16         }
  17       }
  18     }
  19   },
  20   "data_types": {
  21     "onap.datatypes.monitoring.metricsPerEventName": {
  22       "derived_from": "tosca.datatypes.Root",
  23       "properties": {
  24         "controlLoopSchemaType": {
  25           "type": "string",
  26           "required": true,
  27           "description": "Specifies Control Loop Schema Type for the event Name e.g. VNF, VM",
  28           "constraints": [
  29             {
  30               "valid_values": [
  31                 "VM",
  32                 "VNF"
  33               ]
  34             }
  35           ]
  36         },
  37         "eventName": {
  38           "type": "string",
  39           "required": true,
  40           "description": "Event name to which thresholds need to be applied"
  41         },
  42         "policyName": {
  43           "type": "string",
  44           "required": true,
  45           "description": "TCA Policy Scope Name"
  46         },
  47         "policyScope": {
  48           "type": "string",
  49           "required": true,
  50           "description": "TCA Policy Scope"
  51         },
  52         "policyVersion": {
  53           "type": "string",
  54           "required": true,
  55           "description": "TCA Policy Scope Version"
  56         },
  57         "thresholds": {
  58           "type": "list",
  59           "required": true,
  60           "description": "Thresholds associated with eventName",
  61           "entry_schema": {
  62             "type": "onap.datatypes.monitoring.thresholds"
  63           }
  64         }
  65       }
  66     },
  67     "onap.datatypes.monitoring.tca_policy": {
  68       "derived_from": "tosca.datatypes.Root",
  69       "properties": {
  70         "domain": {
  71           "type": "string",
  72           "required": true,
  73           "description": "Domain name to which TCA needs to be applied",
  74           "default": "measurementsForVfScaling",
  75           "constraints": [
  76             {
  77               "equal": "measurementsForVfScaling"
  78             }
  79           ]
  80         },
  81         "metricsPerEventName": {
  82           "type": "list",
  83           "required": true,
  84           "description": "Contains eventName and threshold details that need to be applied to given eventName",
  85           "entry_schema": {
  86             "type": "onap.datatypes.monitoring.metricsPerEventName"
  87           }
  88         }
  89       }
  90     },
  91     "onap.datatypes.monitoring.thresholds": {
  92       "derived_from": "tosca.datatypes.Root",
  93       "properties": {
  94         "closedLoopControlName": {
  95           "type": "string",
  96           "required": true,
  97           "description": "Closed Loop Control Name associated with the threshold"
  98         },
  99         "closedLoopEventStatus": {
 100           "type": "string",
 101           "required": true,
 102           "description": "Closed Loop Event Status of the threshold",
 103           "constraints": [
 104             {
 105               "valid_values": [
 106                 "ONSET",
 107                 "ABATED"
 108               ]
 109             }
 110           ]
 111         },
 112         "direction": {
 113           "type": "string",
 114           "required": true,
 115           "description": "Direction of the threshold",
 116           "constraints": [
 117             {
 118               "valid_values": [
 119                 "LESS",
 120                 "LESS_OR_EQUAL",
 121                 "GREATER",
 122                 "GREATER_OR_EQUAL",
 123                 "EQUAL"
 124               ]
 125             }
 126           ]
 127         },
 128         "fieldPath": {
 129           "type": "string",
 130           "required": true,
 131           "description": "Json field Path as per CEF message which needs to be analyzed for TCA",
 132           "constraints": [
 133             {
 134               "valid_values": [
 135                 "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedTotalPacketsDelta",
 136                 "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedOctetsDelta",
 137                 "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedUnicastPacketsDelta",
 138                 "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedMulticastPacketsDelta",
 139                 "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedBroadcastPacketsDelta",
 140                 "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedDiscardedPacketsDelta",
 141                 "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedErrorPacketsDelta",
 142                 "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedTotalPacketsAccumulated",
 143                 "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedOctetsAccumulated",
 144                 "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedUnicastPacketsAccumulated",
 145                 "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedMulticastPacketsAccumulated",
 146                 "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedBroadcastPacketsAccumulated",
 147                 "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedDiscardedPacketsAccumulated",
 148                 "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedErrorPacketsAccumulated",
 149                 "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedTotalPacketsDelta",
 150                 "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedOctetsDelta",
 151                 "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedUnicastPacketsDelta",
 152                 "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedMulticastPacketsDelta",
 153                 "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedBroadcastPacketsDelta",
 154                 "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedDiscardedPacketsDelta",
 155                 "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedErrorPacketsDelta",
 156                 "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedTotalPacketsAccumulated",
 157                 "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedOctetsAccumulated",
 158                 "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedUnicastPacketsAccumulated",
 159                 "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedMulticastPacketsAccumulated",
 160                 "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedBroadcastPacketsAccumulated",
 161                 "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedDiscardedPacketsAccumulated",
 162                 "$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].transmittedErrorPacketsAccumulated",
 163                 "$.event.measurementsForVfScalingFields.cpuUsageArray[*].cpuIdle",
 164                 "$.event.measurementsForVfScalingFields.cpuUsageArray[*].cpuUsageInterrupt",
 165                 "$.event.measurementsForVfScalingFields.cpuUsageArray[*].cpuUsageNice",
 166                 "$.event.measurementsForVfScalingFields.cpuUsageArray[*].cpuUsageSoftIrq",
 167                 "$.event.measurementsForVfScalingFields.cpuUsageArray[*].cpuUsageSteal",
 168                 "$.event.measurementsForVfScalingFields.cpuUsageArray[*].cpuUsageSystem",
 169                 "$.event.measurementsForVfScalingFields.cpuUsageArray[*].cpuWait",
 170                 "$.event.measurementsForVfScalingFields.cpuUsageArray[*].percentUsage",
 171                 "$.event.measurementsForVfScalingFields.meanRequestLatency",
 172                 "$.event.measurementsForVfScalingFields.memoryUsageArray[*].memoryBuffered",
 173                 "$.event.measurementsForVfScalingFields.memoryUsageArray[*].memoryCached",
 174                 "$.event.measurementsForVfScalingFields.memoryUsageArray[*].memoryConfigured",
 175                 "$.event.measurementsForVfScalingFields.memoryUsageArray[*].memoryFree",
 176                 "$.event.measurementsForVfScalingFields.memoryUsageArray[*].memoryUsed",
 177                 "$.event.measurementsForVfScalingFields.additionalMeasurements[*].arrayOfFields[0].value"
 178               ]
 179             }
 180           ]
 181         },
 182         "severity": {
 183           "type": "string",
 184           "required": true,
 185           "description": "Threshold Event Severity",
 186           "constraints": [
 187             {
 188               "valid_values": [
 189                 "CRITICAL",
 190                 "MAJOR",
 191                 "MINOR",
 192                 "WARNING",
 193                 "NORMAL"
 194               ]
 195             }
 196           ]
 197         },
 198         "thresholdValue": {
 199           "type": "integer",
 200           "required": true,
 201           "description": "Threshold value for the field Path inside CEF message"
 202         },
 203         "version": {
 204           "type": "string",
 205           "required": true,
 206           "description": "Version number associated with the threshold"
 207         }
 208       }
 209     }
 210   }
 211 }