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