docs/api/policytypes/onap.policies.monitoring.cdap.tca.hi.lo.app.json

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