models-examples/src/main/resources/policytypes/onap.policies.monitoring.tcagen2.v2.yaml

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