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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
|
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "VES Event Listener",
"type": "object",
"properties": {
"event": {"$ref": "#/definitions/event"},
"eventList": {"$ref": "#/definitions/eventList"}
},
"definitions": {
"schemaHeaderBlock": {
"description": "schema date, version, author and associated API",
"type": "object",
"properties": {
"associatedApi": {
"description": "VES Event Listener",
"type": "string"
},
"lastUpdatedBy": {
"description": "re2947",
"type": "string"
},
"schemaDate": {
"description": "September 12, 2017",
"type": "string"
},
"schemaVersion": {
"description": "28.4",
"type": "number"
}
}
},
"attCopyrightNotice": {
"description": "Copyright (c) <2017>, AT&T Intellectual Property. All rights reserved. Licensed under the Apache License, Version 2.0 (the License)",
"type": "object",
"properties": {
"useAndRedistribution": {
"description": "You may not use this file except in compliance with the License.You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0",
"type": "string"
},
"licenseLink": {
"description": "http://www.apache.org/licenses/LICENSE-2.0",
"type":"string"
},
"condition1": {
"description": "Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an AS IS BASIS,",
"type": "string"
},
"condition2": {
"description": "Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.",
"type": "string"
},
"condition3": {
"description": "WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.",
"type": "string"
},
"condition4": {
"description": "See the License for the specific language governing permissions and limitations under the License.",
"type": "string"
},
"Trademarks": {
"description": "ECOMP and OpenECOMP are trademarks and service marks of AT&T Intellectual Property.",
"type": "string"
}
}
},
"codecsInUse": {
"description": "number of times an identified codec was used over the measurementInterval",
"type": "object",
"properties": {
"codecIdentifier": { "type": "string" },
"numberInUse": { "type": "integer" }
},
"required": [ "codecIdentifier", "numberInUse" ]
},
"command": {
"description": "command from an event collector toward an event source",
"type": "object",
"properties": {
"commandType": {
"type": "string",
"enum": [
"heartbeatIntervalChange",
"measurementIntervalChange",
"provideThrottlingState",
"throttlingSpecification"
]
},
"eventDomainThrottleSpecification": { "$ref": "#/definitions/eventDomainThrottleSpecification" },
"heartbeatInterval": { "type": "integer" },
"measurementInterval": { "type": "integer" }
},
"required": [ "commandType" ]
},
"commandList": {
"description": "array of commands from an event collector toward an event source",
"type": "array",
"items": {
"$ref": "#/definitions/command"
},
"minItems": 0
},
"commonEventHeader": {
"description": "fields common to all events",
"type": "object",
"properties": {
"domain": {
"description": "the eventing domain associated with the event",
"type": "string",
"enum": [
"fault",
"heartbeat",
"measurementsForVfScaling",
"mobileFlow",
"other",
"sipSignaling",
"stateChange",
"syslog",
"thresholdCrossingAlert",
"voiceQuality"
]
},
"eventId": {
"description": "event key that is unique to the event source",
"type": "string"
},
"eventName": {
"description": "unique event name",
"type": "string"
},
"eventType": {
"description": "for example - applicationVnf, guestOS, hostOS, platform",
"type": "string"
},
"internalHeaderFields": { "$ref": "#/definitions/internalHeaderFields" },
"lastEpochMicrosec": {
"description": "the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds",
"type": "number"
},
"nfcNamingCode": {
"description": "3 character network function component type, aligned with vfc naming standards",
"type": "string"
},
"nfNamingCode": {
"description": "4 character network function type, aligned with vnf naming standards",
"type": "string"
},
"priority": {
"description": "processing priority",
"type": "string",
"enum": [
"High",
"Medium",
"Normal",
"Low"
]
},
"reportingEntityId": {
"description": "UUID identifying the entity reporting the event, for example an OAM VM; must be populated by the ATT enrichment process",
"type": "string"
},
"reportingEntityName": {
"description": "name of the entity reporting the event, for example, an EMS name; may be the same as sourceName",
"type": "string"
},
"sequence": {
"description": "ordering of events communicated by an event source instance or 0 if not needed",
"type": "integer"
},
"sourceId": {
"description": "UUID identifying the entity experiencing the event issue; must be populated by the ATT enrichment process",
"type": "string"
},
"sourceName": {
"description": "name of the entity experiencing the event issue",
"type": "string"
},
"startEpochMicrosec": {
"description": "the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds",
"type": "number"
},
"version": {
"description": "version of the event header",
"type": "number"
}
},
"required": [ "domain", "eventId", "eventName", "lastEpochMicrosec",
"priority", "reportingEntityName", "sequence", "sourceName",
"startEpochMicrosec", "version" ]
},
"counter": {
"description": "performance counter",
"type": "object",
"properties": {
"criticality": { "type": "string", "enum": [ "CRIT", "MAJ" ] },
"name": { "type": "string" },
"thresholdCrossed": { "type": "string" },
"value": { "type": "string"}
},
"required": [ "criticality", "name", "thresholdCrossed", "value" ]
},
"cpuUsage": {
"description": "usage of an identified CPU",
"type": "object",
"properties": {
"cpuIdentifier": {
"description": "cpu identifer",
"type": "string"
},
"cpuIdle": {
"description": "percentage of CPU time spent in the idle task",
"type": "number"
},
"cpuUsageInterrupt": {
"description": "percentage of time spent servicing interrupts",
"type": "number"
},
"cpuUsageNice": {
"description": "percentage of time spent running user space processes that have been niced",
"type": "number"
},
"cpuUsageSoftIrq": {
"description": "percentage of time spent handling soft irq interrupts",
"type": "number"
},
"cpuUsageSteal": {
"description": "percentage of time spent in involuntary wait which is neither user, system or idle time and is effectively time that went missing",
"type": "number"
},
"cpuUsageSystem": {
"description": "percentage of time spent on system tasks running the kernel",
"type": "number"
},
"cpuUsageUser": {
"description": "percentage of time spent running un-niced user space processes",
"type": "number"
},
"cpuWait": {
"description": "percentage of CPU time spent waiting for I/O operations to complete",
"type": "number"
},
"percentUsage": {
"description": "aggregate cpu usage of the virtual machine on which the VNFC reporting the event is running",
"type": "number"
}
},
"required": [ "cpuIdentifier", "percentUsage" ]
},
"diskUsage": {
"description": "usage of an identified disk",
"type": "object",
"properties": {
"diskIdentifier": {
"description": "disk identifier",
"type": "string"
},
"diskIoTimeAvg": {
"description": "milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the average over the measurement interval",
"type": "number"
},
"diskIoTimeLast": {
"description": "milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the last value measurement within the measurement interval",
"type": "number"
},
"diskIoTimeMax": {
"description": "milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the maximum value measurement within the measurement interval",
"type": "number"
},
"diskIoTimeMin": {
"description": "milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the minimum value measurement within the measurement interval",
"type": "number"
},
"diskMergedReadAvg": {
"description": "number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the average measurement within the measurement interval",
"type": "number"
},
"diskMergedReadLast": {
"description": "number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the last value measurement within the measurement interval",
"type": "number"
},
"diskMergedReadMax": {
"description": "number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the maximum value measurement within the measurement interval",
"type": "number"
},
"diskMergedReadMin": {
"description": "number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the minimum value measurement within the measurement interval",
"type": "number"
},
"diskMergedWriteAvg": {
"description": "number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the average measurement within the measurement interval",
"type": "number"
},
"diskMergedWriteLast": {
"description": "number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the last value measurement within the measurement interval",
"type": "number"
},
"diskMergedWriteMax": {
"description": "number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the maximum value measurement within the measurement interval",
"type": "number"
},
"diskMergedWriteMin": {
"description": "number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the minimum value measurement within the measurement interval",
"type": "number"
},
"diskOctetsReadAvg": {
"description": "number of octets per second read from a disk or partition; provide the average measurement within the measurement interval",
"type": "number"
},
"diskOctetsReadLast": {
"description": "number of octets per second read from a disk or partition; provide the last measurement within the measurement interval",
"type": "number"
},
"diskOctetsReadMax": {
"description": "number of octets per second read from a disk or partition; provide the maximum measurement within the measurement interval",
"type": "number"
},
"diskOctetsReadMin": {
"description": "number of octets per second read from a disk or partition; provide the minimum measurement within the measurement interval",
"type": "number"
},
"diskOctetsWriteAvg": {
"description": "number of octets per second written to a disk or partition; provide the average measurement within the measurement interval",
"type": "number"
},
"diskOctetsWriteLast": {
"description": "number of octets per second written to a disk or partition; provide the last measurement within the measurement interval",
"type": "number"
},
"diskOctetsWriteMax": {
"description": "number of octets per second written to a disk or partition; provide the maximum measurement within the measurement interval",
"type": "number"
},
"diskOctetsWriteMin": {
"description": "number of octets per second written to a disk or partition; provide the minimum measurement within the measurement interval",
"type": "number"
},
"diskOpsReadAvg": {
"description": "number of read operations per second issued to the disk; provide the average measurement within the measurement interval",
"type": "number"
},
"diskOpsReadLast": {
"description": "number of read operations per second issued to the disk; provide the last measurement within the measurement interval",
"type": "number"
},
"diskOpsReadMax": {
"description": "number of read operations per second issued to the disk; provide the maximum measurement within the measurement interval",
"type": "number"
},
"diskOpsReadMin": {
"description": "number of read operations per second issued to the disk; provide the minimum measurement within the measurement interval",
"type": "number"
},
"diskOpsWriteAvg": {
"description": "number of write operations per second issued to the disk; provide the average measurement within the measurement interval",
"type": "number"
},
"diskOpsWriteLast": {
"description": "number of write operations per second issued to the disk; provide the last measurement within the measurement interval",
"type": "number"
},
"diskOpsWriteMax": {
"description": "number of write operations per second issued to the disk; provide the maximum measurement within the measurement interval",
"type": "number"
},
"diskOpsWriteMin": {
"description": "number of write operations per second issued to the disk; provide the minimum measurement within the measurement interval",
"type": "number"
},
"diskPendingOperationsAvg": {
"description": "queue size of pending I/O operations per second; provide the average measurement within the measurement interval",
"type": "number"
},
"diskPendingOperationsLast": {
"description": "queue size of pending I/O operations per second; provide the last measurement within the measurement interval",
"type": "number"
},
"diskPendingOperationsMax": {
"description": "queue size of pending I/O operations per second; provide the maximum measurement within the measurement interval",
"type": "number"
},
"diskPendingOperationsMin": {
"description": "queue size of pending I/O operations per second; provide the minimum measurement within the measurement interval",
"type": "number"
},
"diskTimeReadAvg": {
"description": "milliseconds a read operation took to complete; provide the average measurement within the measurement interval",
"type": "number"
},
"diskTimeReadLast": {
"description": "milliseconds a read operation took to complete; provide the last measurement within the measurement interval",
"type": "number"
},
"diskTimeReadMax": {
"description": "milliseconds a read operation took to complete; provide the maximum measurement within the measurement interval",
"type": "number"
},
"diskTimeReadMin": {
"description": "milliseconds a read operation took to complete; provide the minimum measurement within the measurement interval",
"type": "number"
},
"diskTimeWriteAvg": {
"description": "milliseconds a write operation took to complete; provide the average measurement within the measurement interval",
"type": "number"
},
"diskTimeWriteLast": {
"description": "milliseconds a write operation took to complete; provide the last measurement within the measurement interval",
"type": "number"
},
"diskTimeWriteMax": {
"description": "milliseconds a write operation took to complete; provide the maximum measurement within the measurement interval",
"type": "number"
},
"diskTimeWriteMin": {
"description": "milliseconds a write operation took to complete; provide the minimum measurement within the measurement interval",
"type": "number"
}
},
"required": [ "diskIdentifier" ]
},
"endOfCallVqmSummaries": {
"description": "provides end of call voice quality metrics",
"type": "object",
"properties": {
"adjacencyName": {
"description": " adjacency name",
"type": "string"
},
"endpointDescription": {
"description": "Either Caller or Callee",
"type": "string",
"enum": ["Caller", "Callee"]
},
"endpointJitter": {
"description": "",
"type": "number"
},
"endpointRtpOctetsDiscarded": {
"description": "",
"type": "number"
},
"endpointRtpOctetsReceived": {
"description": "",
"type": "number"
},
"endpointRtpOctetsSent": {
"description": "",
"type": "number"
},
"endpointRtpPacketsDiscarded": {
"description": "",
"type": "number"
},
"endpointRtpPacketsReceived": {
"description": "",
"type": "number"
},
"endpointRtpPacketsSent": {
"description": "",
"type": "number"
},
"localJitter": {
"description": "",
"type": "number"
},
"localRtpOctetsDiscarded": {
"description": "",
"type": "number"
},
"localRtpOctetsReceived": {
"description": "",
"type": "number"
},
"localRtpOctetsSent": {
"description": "",
"type": "number"
},
"localRtpPacketsDiscarded": {
"description": "",
"type": "number"
},
"localRtpPacketsReceived": {
"description": "",
"type": "number"
},
"localRtpPacketsSent": {
"description": "",
"type": "number"
},
"mosCqe": {
"description": "1-5 1dp",
"type": "number"
},
"packetsLost": {
"description": "",
"type": "number"
},
"packetLossPercent": {
"description" : "Calculated percentage packet loss based on Endpoint RTP packets lost (as reported in RTCP) and Local RTP packets sent. Direction is based on Endpoint description (Caller, Callee). Decimal (2 dp)",
"type": "number"
},
"rFactor": {
"description": "0-100",
"type": "number"
},
"roundTripDelay": {
"description": "millisecs",
"type": "number"
}
},
"required": [ "adjacencyName", "endpointDescription" ]
},
"event": {
"description": "the root level of the common event format",
"type": "object",
"properties": {
"commonEventHeader": { "$ref": "#/definitions/commonEventHeader" },
"faultFields": { "$ref": "#/definitions/faultFields" },
"heartbeatFields": { "$ref": "#/definitions/heartbeatFields" },
"measurementsForVfScalingFields": { "$ref": "#/definitions/measurementsForVfScalingFields" },
"mobileFlowFields": { "$ref": "#/definitions/mobileFlowFields" },
"otherFields": { "$ref": "#/definitions/otherFields" },
"sipSignalingFields": { "$ref": "#/definitions/sipSignalingFields" },
"stateChangeFields": { "$ref": "#/definitions/stateChangeFields" },
"syslogFields": { "$ref": "#/definitions/syslogFields" },
"thresholdCrossingAlertFields": { "$ref": "#/definitions/thresholdCrossingAlertFields" },
"voiceQualityFields": { "$ref": "#/definitions/voiceQualityFields" }
},
"required": [ "commonEventHeader" ]
},
"eventDomainThrottleSpecification": {
"description": "specification of what information to suppress within an event domain",
"type": "object",
"properties": {
"eventDomain": {
"description": "Event domain enum from the commonEventHeader domain field",
"type": "string"
},
"suppressedFieldNames": {
"description": "List of optional field names in the event block that should not be sent to the Event Listener",
"type": "array",
"items": {
"type": "string"
}
},
"suppressedNvPairsList": {
"description": "Optional list of specific NvPairsNames to suppress within a given Name-Value Field",
"type": "array",
"items": {
"$ref": "#/definitions/suppressedNvPairs"
}
}
},
"required": [ "eventDomain" ]
},
"eventDomainThrottleSpecificationList": {
"description": "array of eventDomainThrottleSpecifications",
"type": "array",
"items": {
"$ref": "#/definitions/eventDomainThrottleSpecification"
},
"minItems": 0
},
"eventList": {
"description": "array of events",
"type": "array",
"items": {
"$ref": "#/definitions/event"
}
},
"eventThrottlingState": {
"description": "reports the throttling in force at the event source",
"type": "object",
"properties": {
"eventThrottlingMode": {
"description": "Mode the event manager is in",
"type": "string",
"enum": [
"normal",
"throttled"
]
},
"eventDomainThrottleSpecificationList": { "$ref": "#/definitions/eventDomainThrottleSpecificationList" }
},
"required": [ "eventThrottlingMode" ]
},
"faultFields": {
"description": "fields specific to fault events",
"type": "object",
"properties": {
"alarmAdditionalInformation": {
"description": "additional alarm information",
"type": "array",
"items": {
"$ref": "#/definitions/field"
}
},
"alarmCondition": {
"description": "alarm condition reported by the device",
"type": "string"
},
"alarmInterfaceA": {
"description": "card, port, channel or interface name of the device generating the alarm",
"type": "string"
},
"eventCategory": {
"description": "Event category, for example: license, link, routing, security, signaling",
"type": "string"
},
"eventSeverity": {
"description": "event severity",
"type": "string",
"enum": [
"CRITICAL",
"MAJOR",
"MINOR",
"WARNING",
"NORMAL"
]
},
"eventSourceType": {
"description": "type of event source; examples: card, host, other, port, portThreshold, router, slotThreshold, switch, virtualMachine, virtualNetworkFunction",
"type": "string"
},
"faultFieldsVersion": {
"description": "version of the faultFields block",
"type": "number"
},
"specificProblem": {
"description": "short description of the alarm or problem",
"type": "string"
},
"vfStatus": {
"description": "virtual function status enumeration",
"type": "string",
"enum": [
"Active",
"Idle",
"Preparing to terminate",
"Ready to terminate",
"Requesting termination"
]
}
},
"required": [ "alarmCondition", "eventSeverity", "eventSourceType",
"faultFieldsVersion", "specificProblem", "vfStatus" ]
},
"featuresInUse": {
"description": "number of times an identified feature was used over the measurementInterval",
"type": "object",
"properties": {
"featureIdentifier": { "type": "string" },
"featureUtilization": { "type": "integer" }
},
"required": [ "featureIdentifier", "featureUtilization" ]
},
"field": {
"description": "name value pair",
"type": "object",
"properties": {
"name": { "type": "string" },
"value": { "type": "string" }
},
"required": [ "name", "value" ]
},
"filesystemUsage": {
"description": "disk usage of an identified virtual machine in gigabytes and/or gigabytes per second",
"type": "object",
"properties": {
"blockConfigured": { "type": "number" },
"blockIops": { "type": "number" },
"blockUsed": { "type": "number" },
"ephemeralConfigured": { "type": "number" },
"ephemeralIops": { "type": "number" },
"ephemeralUsed": { "type": "number" },
"filesystemName": { "type": "string" }
},
"required": [ "blockConfigured", "blockIops", "blockUsed", "ephemeralConfigured",
"ephemeralIops", "ephemeralUsed", "filesystemName" ]
},
"gtpPerFlowMetrics": {
"description": "Mobility GTP Protocol per flow metrics",
"type": "object",
"properties": {
"avgBitErrorRate": {
"description": "average bit error rate",
"type": "number"
},
"avgPacketDelayVariation": {
"description": "Average packet delay variation or jitter in milliseconds for received packets: Average difference between the packet timestamp and time received for all pairs of consecutive packets",
"type": "number"
},
"avgPacketLatency": {
"description": "average delivery latency",
"type": "number"
},
"avgReceiveThroughput": {
"description": "average receive throughput",
"type": "number"
},
"avgTransmitThroughput": {
"description": "average transmit throughput",
"type": "number"
},
"durConnectionFailedStatus": {
"description": "duration of failed state in milliseconds, computed as the cumulative time between a failed echo request and the next following successful error request, over this reporting interval",
"type": "number"
},
"durTunnelFailedStatus": {
"description": "Duration of errored state, computed as the cumulative time between a tunnel error indicator and the next following non-errored indicator, over this reporting interval",
"type": "number"
},
"flowActivatedBy": {
"description": "Endpoint activating the flow",
"type": "string"
},
"flowActivationEpoch": {
"description": "Time the connection is activated in the flow (connection) being reported on, or transmission time of the first packet if activation time is not available",
"type": "number"
},
"flowActivationMicrosec": {
"description": "Integer microseconds for the start of the flow connection",
"type": "number"
},
"flowActivationTime": {
"description": "time the connection is activated in the flow being reported on, or transmission time of the first packet if activation time is not available; with RFC 2822 compliant format: Sat, 13 Mar 2010 11:29:05 -0800",
"type": "string"
},
"flowDeactivatedBy": {
"description": "Endpoint deactivating the flow",
"type": "string"
},
"flowDeactivationEpoch": {
"description": "Time for the start of the flow connection, in integer UTC epoch time aka UNIX time",
"type": "number"
},
"flowDeactivationMicrosec": {
"description": "Integer microseconds for the start of the flow connection",
"type": "number"
},
"flowDeactivationTime": {
"description": "Transmission time of the first packet in the flow connection being reported on; with RFC 2822 compliant format: Sat, 13 Mar 2010 11:29:05 -0800",
"type": "string"
},
"flowStatus": {
"description": "connection status at reporting time as a working / inactive / failed indicator value",
"type": "string"
},
"gtpConnectionStatus": {
"description": "Current connection state at reporting time",
"type": "string"
},
"gtpTunnelStatus": {
"description": "Current tunnel state at reporting time",
"type": "string"
},
"ipTosCountList": {
"description": "array of key: value pairs where the keys are drawn from the IP Type-of-Service identifiers which range from '0' to '255', and the values are the count of packets that had those ToS identifiers in the flow",
"type": "array",
"items": {
"type": "array",
"items": [
{ "type": "string" },
{ "type": "number" }
]
}
},
"ipTosList": {
"description": "Array of unique IP Type-of-Service values observed in the flow where values range from '0' to '255'",
"type": "array",
"items": {
"type": "string"
}
},
"largePacketRtt": {
"description": "large packet round trip time",
"type": "number"
},
"largePacketThreshold": {
"description": "large packet threshold being applied",
"type": "number"
},
"maxPacketDelayVariation": {
"description": "Maximum packet delay variation or jitter in milliseconds for received packets: Maximum of the difference between the packet timestamp and time received for all pairs of consecutive packets",
"type": "number"
},
"maxReceiveBitRate": {
"description": "maximum receive bit rate",
"type": "number"
},
"maxTransmitBitRate": {
"description": "maximum transmit bit rate",
"type": "number"
},
"mobileQciCosCountList": {
"description": "array of key: value pairs where the keys are drawn from LTE QCI or UMTS class of service strings, and the values are the count of packets that had those strings in the flow",
"type": "array",
"items": {
"type": "array",
"items": [
{ "type": "string" },
{ "type": "number" }
]
}
},
"mobileQciCosList": {
"description": "Array of unique LTE QCI or UMTS class-of-service values observed in the flow",
"type": "array",
"items": {
"type": "string"
}
},
"numActivationFailures": {
"description": "Number of failed activation requests, as observed by the reporting node",
"type": "number"
},
"numBitErrors": {
"description": "number of errored bits",
"type": "number"
},
"numBytesReceived": {
"description": "number of bytes received, including retransmissions",
"type": "number"
},
"numBytesTransmitted": {
"description": "number of bytes transmitted, including retransmissions",
"type": "number"
},
"numDroppedPackets": {
"description": "number of received packets dropped due to errors per virtual interface",
"type": "number"
},
"numGtpEchoFailures": {
"description": "Number of Echo request path failures where failed paths are defined in 3GPP TS 29.281 sec 7.2.1 and 3GPP TS 29.060 sec. 11.2",
"type": "number"
},
"numGtpTunnelErrors": {
"description": "Number of tunnel error indications where errors are defined in 3GPP TS 29.281 sec 7.3.1 and 3GPP TS 29.060 sec. 11.1",
"type": "number"
},
"numHttpErrors": {
"description": "Http error count",
"type": "number"
},
"numL7BytesReceived": {
"description": "number of tunneled layer 7 bytes received, including retransmissions",
"type": "number"
},
"numL7BytesTransmitted": {
"description": "number of tunneled layer 7 bytes transmitted, excluding retransmissions",
"type": "number"
},
"numLostPackets": {
"description": "number of lost packets",
"type": "number"
},
"numOutOfOrderPackets": {
"description": "number of out-of-order packets",
"type": "number"
},
"numPacketErrors": {
"description": "number of errored packets",
"type": "number"
},
"numPacketsReceivedExclRetrans": {
"description": "number of packets received, excluding retransmission",
"type": "number"
},
"numPacketsReceivedInclRetrans": {
"description": "number of packets received, including retransmission",
"type": "number"
},
"numPacketsTransmittedInclRetrans": {
"description": "number of packets transmitted, including retransmissions",
"type": "number"
},
"numRetries": {
"description": "number of packet retries",
"type": "number"
},
"numTimeouts": {
"description": "number of packet timeouts",
"type": "number"
},
"numTunneledL7BytesReceived": {
"description": "number of tunneled layer 7 bytes received, excluding retransmissions",
"type": "number"
},
"roundTripTime": {
"description": "round trip time",
"type": "number"
},
"tcpFlagCountList": {
"description": "array of key: value pairs where the keys are drawn from TCP Flags and the values are the count of packets that had that TCP Flag in the flow",
"type": "array",
"items": {
"type": "array",
"items": [
{ "type": "string" },
{ "type": "number" }
]
}
},
"tcpFlagList": {
"description": "Array of unique TCP Flags observed in the flow",
"type": "array",
"items": {
"type": "string"
}
},
"timeToFirstByte": {
"description": "Time in milliseconds between the connection activation and first byte received",
"type": "number"
}
},
"required": [ "avgBitErrorRate", "avgPacketDelayVariation", "avgPacketLatency",
"avgReceiveThroughput", "avgTransmitThroughput",
"flowActivationEpoch", "flowActivationMicrosec",
"flowDeactivationEpoch", "flowDeactivationMicrosec",
"flowDeactivationTime", "flowStatus",
"maxPacketDelayVariation", "numActivationFailures",
"numBitErrors", "numBytesReceived", "numBytesTransmitted",
"numDroppedPackets", "numL7BytesReceived",
"numL7BytesTransmitted", "numLostPackets",
"numOutOfOrderPackets", "numPacketErrors",
"numPacketsReceivedExclRetrans",
"numPacketsReceivedInclRetrans",
"numPacketsTransmittedInclRetrans",
"numRetries", "numTimeouts", "numTunneledL7BytesReceived",
"roundTripTime", "timeToFirstByte"
]
},
"heartbeatFields": {
"description": "optional field block for fields specific to heartbeat events",
"type": "object",
"properties": {
"additionalFields": {
"description": "additional heartbeat fields if needed",
"type": "array",
"items": {
"$ref": "#/definitions/field"
}
},
"heartbeatFieldsVersion": {
"description": "version of the heartbeatFields block",
"type": "number"
},
"heartbeatInterval": {
"description": "current heartbeat interval in seconds",
"type": "integer"
}
},
"required": [ "heartbeatFieldsVersion", "heartbeatInterval" ]
},
"internalHeaderFields": {
"description": "enrichment fields for internal VES Event Listener service use only, not supplied by event sources",
"type": "object"
},
"jsonObject": {
"description": "json object schema, name and other meta-information along with one or more object instances",
"type": "object",
"properties": {
"objectInstances": {
"description": "one or more instances of the jsonObject",
"type": "array",
"items": {
"$ref": "#/definitions/jsonObjectInstance"
}
},
"objectName": {
"description": "name of the JSON Object",
"type": "string"
},
"objectSchema": {
"description": "json schema for the object",
"type": "string"
},
"objectSchemaUrl": {
"description": "Url to the json schema for the object",
"type": "string"
},
"nfSubscribedObjectName": {
"description": "name of the object associated with the nfSubscriptonId",
"type": "string"
},
"nfSubscriptionId": {
"description": "identifies an openConfig telemetry subscription on a network function, which configures the network function to send complex object data associated with the jsonObject",
"type": "string"
}
},
"required": [ "objectInstances", "objectName" ]
},
"jsonObjectInstance": {
"description": "meta-information about an instance of a jsonObject along with the actual object instance",
"type": "object",
"properties": {
"objectInstance": {
"description": "an instance conforming to the jsonObject schema",
"type": "object"
},
"objectInstanceEpochMicrosec": {
"description": "the unix time aka epoch time associated with this objectInstance--as microseconds elapsed since 1 Jan 1970 not including leap seconds",
"type": "number"
},
"objectKeys": {
"description": "an ordered set of keys that identifies this particular instance of jsonObject",
"type": "array",
"items": {
"$ref": "#/definitions/key"
}
}
},
"required": [ "objectInstance" ]
},
"key": {
"description": "tuple which provides the name of a key along with its value and relative order",
"type": "object",
"properties": {
"keyName": {
"description": "name of the key",
"type": "string"
},
"keyOrder": {
"description": "relative sequence or order of the key with respect to other keys",
"type": "integer"
},
"keyValue": {
"description": "value of the key",
"type": "string"
}
},
"required": [ "keyName" ]
},
"latencyBucketMeasure": {
"description": "number of counts falling within a defined latency bucket",
"type": "object",
"properties": {
"countsInTheBucket": { "type": "number" },
"highEndOfLatencyBucket": { "type": "number" },
"lowEndOfLatencyBucket": { "type": "number" }
},
"required": [ "countsInTheBucket" ]
},
"measurementsForVfScalingFields": {
"description": "measurementsForVfScaling fields",
"type": "object",
"properties": {
"additionalFields": {
"description": "additional name-value-pair fields",
"type": "array",
"items": {
"$ref": "#/definitions/field"
}
},
"additionalMeasurements": {
"description": "array of named name-value-pair arrays",
"type": "array",
"items": {
"$ref": "#/definitions/namedArrayOfFields"
}
},
"additionalObjects": {
"description": "array of JSON objects described by name, schema and other meta-information",
"type": "array",
"items": {
"$ref": "#/definitions/jsonObject"
}
},
"codecUsageArray": {
"description": "array of codecs in use",
"type": "array",
"items": {
"$ref": "#/definitions/codecsInUse"
}
},
"concurrentSessions": {
"description": "peak concurrent sessions for the VM or VNF over the measurementInterval",
"type": "integer"
},
"configuredEntities": {
"description": "over the measurementInterval, peak total number of: users, subscribers, devices, adjacencies, etc., for the VM, or subscribers, devices, etc., for the VNF",
"type": "integer"
},
"cpuUsageArray": {
"description": "usage of an array of CPUs",
"type": "array",
"items": {
"$ref": "#/definitions/cpuUsage"
}
},
"diskUsageArray": {
"description": "usage of an array of disks",
"type": "array",
"items": {
"$ref": "#/definitions/diskUsage"
}
},
"featureUsageArray": {
"description": "array of features in use",
"type": "array",
"items": {
"$ref": "#/definitions/featuresInUse"
}
},
"filesystemUsageArray": {
"description": "filesystem usage of the VM on which the VNFC reporting the event is running",
"type": "array",
"items": {
"$ref": "#/definitions/filesystemUsage"
}
},
"latencyDistribution": {
"description": "array of integers representing counts of requests whose latency in milliseconds falls within per-VNF configured ranges",
"type": "array",
"items": {
"$ref": "#/definitions/latencyBucketMeasure"
}
},
"meanRequestLatency": {
"description": "mean seconds required to respond to each request for the VM on which the VNFC reporting the event is running",
"type": "number"
},
"measurementInterval": {
"description": "interval over which measurements are being reported in seconds",
"type": "number"
},
"measurementsForVfScalingVersion": {
"description": "version of the measurementsForVfScaling block",
"type": "number"
},
"memoryUsageArray": {
"description": "memory usage of an array of VMs",
"type": "array",
"items": {
"$ref": "#/definitions/memoryUsage"
}
},
"numberOfMediaPortsInUse": {
"description": "number of media ports in use",
"type": "integer"
},
"requestRate": {
"description": "peak rate of service requests per second to the VNF over the measurementInterval",
"type": "number"
},
"vnfcScalingMetric": {
"description": "represents busy-ness of the VNF from 0 to 100 as reported by the VNFC",
"type": "integer"
},
"vNicPerformanceArray": {
"description": "usage of an array of virtual network interface cards",
"type": "array",
"items": {
"$ref": "#/definitions/vNicPerformance"
}
}
},
"required": [ "measurementInterval", "measurementsForVfScalingVersion" ]
},
"memoryUsage": {
"description": "memory usage of an identified virtual machine",
"type": "object",
"properties": {
"memoryBuffered": {
"description": "kibibytes of temporary storage for raw disk blocks",
"type": "number"
},
"memoryCached": {
"description": "kibibytes of memory used for cache",
"type": "number"
},
"memoryConfigured": {
"description": "kibibytes of memory configured in the virtual machine on which the VNFC reporting the event is running",
"type": "number"
},
"memoryFree": {
"description": "kibibytes of physical RAM left unused by the system",
"type": "number"
},
"memorySlabRecl": {
"description": "the part of the slab that can be reclaimed such as caches measured in kibibytes",
"type": "number"
},
"memorySlabUnrecl": {
"description": "the part of the slab that cannot be reclaimed even when lacking memory measured in kibibytes",
"type": "number"
},
"memoryUsed": {
"description": "total memory minus the sum of free, buffered, cached and slab memory measured in kibibytes",
"type": "number"
},
"vmIdentifier": {
"description": "virtual machine identifier associated with the memory metrics",
"type": "string"
}
},
"required": [ "memoryFree", "memoryUsed", "vmIdentifier" ]
},
"mobileFlowFields": {
"description": "mobileFlow fields",
"type": "object",
"properties": {
"additionalFields": {
"description": "additional mobileFlow fields if needed",
"type": "array",
"items": {
"$ref": "#/definitions/field"
}
},
"applicationType": {
"description": "Application type inferred",
"type": "string"
},
"appProtocolType": {
"description": "application protocol",
"type": "string"
},
"appProtocolVersion": {
"description": "application protocol version",
"type": "string"
},
"cid": {
"description": "cell id",
"type": "string"
},
"connectionType": {
"description": "Abbreviation referencing a 3GPP reference point e.g., S1-U, S11, etc",
"type": "string"
},
"ecgi": {
"description": "Evolved Cell Global Id",
"type": "string"
},
"flowDirection": {
"description": "Flow direction, indicating if the reporting node is the source of the flow or destination for the flow",
"type": "string"
},
"gtpPerFlowMetrics": { "$ref": "#/definitions/gtpPerFlowMetrics" },
"gtpProtocolType": {
"description": "GTP protocol",
"type": "string"
},
"gtpVersion": {
"description": "GTP protocol version",
"type": "string"
},
"httpHeader": {
"description": "HTTP request header, if the flow connects to a node referenced by HTTP",
"type": "string"
},
"imei": {
"description": "IMEI for the subscriber UE used in this flow, if the flow connects to a mobile device",
"type": "string"
},
"imsi": {
"description": "IMSI for the subscriber UE used in this flow, if the flow connects to a mobile device",
"type": "string"
},
"ipProtocolType": {
"description": "IP protocol type e.g., TCP, UDP, RTP...",
"type": "string"
},
"ipVersion": {
"description": "IP protocol version e.g., IPv4, IPv6",
"type": "string"
},
"lac": {
"description": "location area code",
"type": "string"
},
"mcc": {
"description": "mobile country code",
"type": "string"
},
"mnc": {
"description": "mobile network code",
"type": "string"
},
"mobileFlowFieldsVersion": {
"description": "version of the mobileFlowFields block",
"type": "number"
},
"msisdn": {
"description": "MSISDN for the subscriber UE used in this flow, as an integer, if the flow connects to a mobile device",
"type": "string"
},
"otherEndpointIpAddress": {
"description": "IP address for the other endpoint, as used for the flow being reported on",
"type": "string"
},
"otherEndpointPort": {
"description": "IP Port for the reporting entity, as used for the flow being reported on",
"type": "integer"
},
"otherFunctionalRole": {
"description": "Functional role of the other endpoint for the flow being reported on e.g., MME, S-GW, P-GW, PCRF...",
"type": "string"
},
"rac": {
"description": "routing area code",
"type": "string"
},
"radioAccessTechnology": {
"description": "Radio Access Technology e.g., 2G, 3G, LTE",
"type": "string"
},
"reportingEndpointIpAddr": {
"description": "IP address for the reporting entity, as used for the flow being reported on",
"type": "string"
},
"reportingEndpointPort": {
"description": "IP port for the reporting entity, as used for the flow being reported on",
"type": "integer"
},
"sac": {
"description": "service area code",
"type": "string"
},
"samplingAlgorithm": {
"description": "Integer identifier for the sampling algorithm or rule being applied in calculating the flow metrics if metrics are calculated based on a sample of packets, or 0 if no sampling is applied",
"type": "integer"
},
"tac": {
"description": "transport area code",
"type": "string"
},
"tunnelId": {
"description": "tunnel identifier",
"type": "string"
},
"vlanId": {
"description": "VLAN identifier used by this flow",
"type": "string"
}
},
"required": [ "flowDirection", "gtpPerFlowMetrics", "ipProtocolType", "ipVersion",
"mobileFlowFieldsVersion", "otherEndpointIpAddress", "otherEndpointPort",
"reportingEndpointIpAddr", "reportingEndpointPort" ]
},
"namedArrayOfFields": {
"description": "an array of name value pairs along with a name for the array",
"type": "object",
"properties": {
"name": { "type": "string" },
"arrayOfFields": {
"description": "array of name value pairs",
"type": "array",
"items": {
"$ref": "#/definitions/field"
}
}
},
"required": [ "name", "arrayOfFields" ]
},
"otherFields": {
"description": "fields for events belonging to the 'other' domain of the commonEventHeader domain enumeration",
"type": "object",
"properties": {
"hashOfNameValuePairArrays": {
"description": "array of named name-value-pair arrays",
"type": "array",
"items": {
"$ref": "#/definitions/namedArrayOfFields"
}
},
"jsonObjects": {
"description": "array of JSON objects described by name, schema and other meta-information",
"type": "array",
"items": {
"$ref": "#/definitions/jsonObject"
}
},
"nameValuePairs": {
"description": "array of name-value pairs",
"type": "array",
"items": {
"$ref": "#/definitions/field"
}
},
"otherFieldsVersion": {
"description": "version of the otherFields block",
"type": "number"
}
},
"required": [ "otherFieldsVersion" ]
},
"requestError": {
"description": "standard request error data structure",
"type": "object",
"properties": {
"messageId": {
"description": "Unique message identifier of the format ABCnnnn where ABC is either SVC for Service Exceptions or POL for Policy Exception",
"type": "string"
},
"text": {
"description": "Message text, with replacement variables marked with %n, where n is an index into the list of <variables> elements, starting at 1",
"type": "string"
},
"url": {
"description": "Hyperlink to a detailed error resource e.g., an HTML page for browser user agents",
"type": "string"
},
"variables": {
"description": "List of zero or more strings that represent the contents of the variables used by the message text",
"type": "string"
}
},
"required": [ "messageId", "text" ]
},
"sipSignalingFields": {
"description": "sip signaling fields",
"type": "object",
"properties": {
"additionalInformation": {
"description": "additional sip signaling fields if needed",
"type": "array",
"items": {
"$ref": "#/definitions/field"
}
},
"compressedSip": {
"description": "the full SIP request/response including headers and bodies",
"type": "string"
},
"correlator": {
"description": "this is the same for all events on this call",
"type": "string"
},
"localIpAddress": {
"description": "IP address on VNF",
"type": "string"
},
"localPort": {
"description": "port on VNF",
"type": "string"
},
"remoteIpAddress": {
"description": "IP address of peer endpoint",
"type": "string"
},
"remotePort": {
"description": "port of peer endpoint",
"type": "string"
},
"sipSignalingFieldsVersion": {
"description": "version of the sipSignalingFields block",
"type": "number"
},
"summarySip": {
"description": "the SIP Method or Response (‘INVITE’, ‘200 OK’, ‘BYE’, etc)",
"type": "string"
},
"vendorVnfNameFields": {
"$ref": "#/definitions/vendorVnfNameFields"
}
},
"required": [ "correlator", "localIpAddress", "localPort", "remoteIpAddress",
"remotePort", "sipSignalingFieldsVersion", "vendorVnfNameFields" ]
},
"stateChangeFields": {
"description": "stateChange fields",
"type": "object",
"properties": {
"additionalFields": {
"description": "additional stateChange fields if needed",
"type": "array",
"items": {
"$ref": "#/definitions/field"
}
},
"newState": {
"description": "new state of the entity",
"type": "string",
"enum": [
"inService",
"maintenance",
"outOfService"
]
},
"oldState": {
"description": "previous state of the entity",
"type": "string",
"enum": [
"inService",
"maintenance",
"outOfService"
]
},
"stateChangeFieldsVersion": {
"description": "version of the stateChangeFields block",
"type": "number"
},
"stateInterface": {
"description": "card or port name of the entity that changed state",
"type": "string"
}
},
"required": [ "newState", "oldState", "stateChangeFieldsVersion", "stateInterface" ]
},
"suppressedNvPairs": {
"description": "List of specific NvPairsNames to suppress within a given Name-Value Field for event Throttling",
"type": "object",
"properties": {
"nvPairFieldName": {
"description": "Name of the field within which are the nvpair names to suppress",
"type": "string"
},
"suppressedNvPairNames": {
"description": "Array of nvpair names to suppress within the nvpairFieldName",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [ "nvPairFieldName", "suppressedNvPairNames" ]
},
"syslogFields": {
"description": "sysLog fields",
"type": "object",
"properties": {
"additionalFields": {
"description": "additional syslog fields if needed provided as name=value delimited by a pipe ‘|’ symbol, for example: 'name1=value1|name2=value2|…'",
"type": "string"
},
"eventSourceHost": {
"description": "hostname of the device",
"type": "string"
},
"eventSourceType": {
"description": "type of event source; examples: other, router, switch, host, card, port, slotThreshold, portThreshold, virtualMachine, virtualNetworkFunction",
"type": "string"
},
"syslogFacility": {
"description": "numeric code from 0 to 23 for facility--see table in documentation",
"type": "integer"
},
"syslogFieldsVersion": {
"description": "version of the syslogFields block",
"type": "number"
},
"syslogMsg": {
"description": "syslog message",
"type": "string"
},
"syslogPri": {
"description": "0-192 combined severity and facility",
"type": "integer"
},
"syslogProc": {
"description": "identifies the application that originated the message",
"type": "string"
},
"syslogProcId": {
"description": "a change in the value of this field indicates a discontinuity in syslog reporting",
"type": "number"
},
"syslogSData": {
"description": "syslog structured data consisting of a structured data Id followed by a set of key value pairs",
"type": "string"
},
"syslogSdId": {
"description": "0-32 char in format name@number for example ourSDID@32473",
"type": "string"
},
"syslogSev": {
"description": "numerical Code for severity derived from syslogPri as remaider of syslogPri / 8",
"type": "string",
"enum": [
"Alert",
"Critical",
"Debug",
"Emergency",
"Error",
"Info",
"Notice",
"Warning"
]
},
"syslogTag": {
"description": "msgId indicating the type of message such as TCPOUT or TCPIN; NILVALUE should be used when no other value can be provided",
"type": "string"
},
"syslogVer": {
"description": "IANA assigned version of the syslog protocol specification - typically 1",
"type": "number"
}
},
"required": [ "eventSourceType", "syslogFieldsVersion", "syslogMsg", "syslogTag" ]
},
"thresholdCrossingAlertFields": {
"description": "fields specific to threshold crossing alert events",
"type": "object",
"properties": {
"additionalFields": {
"description": "additional threshold crossing alert fields if needed",
"type": "array",
"items": {
"$ref": "#/definitions/field"
}
},
"additionalParameters": {
"description": "performance counters",
"type": "array",
"items": {
"$ref": "#/definitions/counter"
}
},
"alertAction": {
"description": "Event action",
"type": "string",
"enum": [
"CLEAR",
"CONT",
"SET"
]
},
"alertDescription": {
"description": "Unique short alert description such as IF-SHUB-ERRDROP",
"type": "string"
},
"alertType": {
"description": "Event type",
"type": "string",
"enum": [
"CARD-ANOMALY",
"ELEMENT-ANOMALY",
"INTERFACE-ANOMALY",
"SERVICE-ANOMALY"
]
},
"alertValue": {
"description": "Calculated API value (if applicable)",
"type": "string"
},
"associatedAlertIdList": {
"description": "List of eventIds associated with the event being reported",
"type": "array",
"items": { "type": "string" }
},
"collectionTimestamp": {
"description": "Time when the performance collector picked up the data; with RFC 2822 compliant format: Sat, 13 Mar 2010 11:29:05 -0800",
"type": "string"
},
"dataCollector": {
"description": "Specific performance collector instance used",
"type": "string"
},
"elementType": {
"description": "type of network element - internal ATT field",
"type": "string"
},
"eventSeverity": {
"description": "event severity or priority",
"type": "string",
"enum": [
"CRITICAL",
"MAJOR",
"MINOR",
"WARNING",
"NORMAL"
]
},
"eventStartTimestamp": {
"description": "Time closest to when the measurement was made; with RFC 2822 compliant format: Sat, 13 Mar 2010 11:29:05 -0800",
"type": "string"
},
"interfaceName": {
"description": "Physical or logical port or card (if applicable)",
"type": "string"
},
"networkService": {
"description": "network name - internal ATT field",
"type": "string"
},
"possibleRootCause": {
"description": "Reserved for future use",
"type": "string"
},
"thresholdCrossingFieldsVersion": {
"description": "version of the thresholdCrossingAlertFields block",
"type": "number"
}
},
"required": [
"additionalParameters",
"alertAction",
"alertDescription",
"alertType",
"collectionTimestamp",
"eventSeverity",
"eventStartTimestamp",
"thresholdCrossingFieldsVersion"
]
},
"vendorVnfNameFields": {
"description": "provides vendor, vnf and vfModule identifying information",
"type": "object",
"properties": {
"vendorName": {
"description": "VNF vendor name",
"type": "string"
},
"vfModuleName": {
"description": "ASDC vfModuleName for the vfModule generating the event",
"type": "string"
},
"vnfName": {
"description": "ASDC modelName for the VNF generating the event",
"type": "string"
}
},
"required": [ "vendorName" ]
},
"vNicPerformance": {
"description": "describes the performance and errors of an identified virtual network interface card",
"type": "object",
"properties": {
"receivedBroadcastPacketsAccumulated": {
"description": "Cumulative count of broadcast packets received as read at the end of the measurement interval",
"type": "number"
},
"receivedBroadcastPacketsDelta": {
"description": "Count of broadcast packets received within the measurement interval",
"type": "number"
},
"receivedDiscardedPacketsAccumulated": {
"description": "Cumulative count of discarded packets received as read at the end of the measurement interval",
"type": "number"
},
"receivedDiscardedPacketsDelta": {
"description": "Count of discarded packets received within the measurement interval",
"type": "number"
},
"receivedErrorPacketsAccumulated": {
"description": "Cumulative count of error packets received as read at the end of the measurement interval",
"type": "number"
},
"receivedErrorPacketsDelta": {
"description": "Count of error packets received within the measurement interval",
"type": "number"
},
"receivedMulticastPacketsAccumulated": {
"description": "Cumulative count of multicast packets received as read at the end of the measurement interval",
"type": "number"
},
"receivedMulticastPacketsDelta": {
"description": "Count of multicast packets received within the measurement interval",
"type": "number"
},
"receivedOctetsAccumulated": {
"description": "Cumulative count of octets received as read at the end of the measurement interval",
"type": "number"
},
"receivedOctetsDelta": {
"description": "Count of octets received within the measurement interval",
"type": "number"
},
"receivedTotalPacketsAccumulated": {
"description": "Cumulative count of all packets received as read at the end of the measurement interval",
"type": "number"
},
"receivedTotalPacketsDelta": {
"description": "Count of all packets received within the measurement interval",
"type": "number"
},
"receivedUnicastPacketsAccumulated": {
"description": "Cumulative count of unicast packets received as read at the end of the measurement interval",
"type": "number"
},
"receivedUnicastPacketsDelta": {
"description": "Count of unicast packets received within the measurement interval",
"type": "number"
},
"transmittedBroadcastPacketsAccumulated": {
"description": "Cumulative count of broadcast packets transmitted as read at the end of the measurement interval",
"type": "number"
},
"transmittedBroadcastPacketsDelta": {
"description": "Count of broadcast packets transmitted within the measurement interval",
"type": "number"
},
"transmittedDiscardedPacketsAccumulated": {
"description": "Cumulative count of discarded packets transmitted as read at the end of the measurement interval",
"type": "number"
},
"transmittedDiscardedPacketsDelta": {
"description": "Count of discarded packets transmitted within the measurement interval",
"type": "number"
},
"transmittedErrorPacketsAccumulated": {
"description": "Cumulative count of error packets transmitted as read at the end of the measurement interval",
"type": "number"
},
"transmittedErrorPacketsDelta": {
"description": "Count of error packets transmitted within the measurement interval",
"type": "number"
},
"transmittedMulticastPacketsAccumulated": {
"description": "Cumulative count of multicast packets transmitted as read at the end of the measurement interval",
"type": "number"
},
"transmittedMulticastPacketsDelta": {
"description": "Count of multicast packets transmitted within the measurement interval",
"type": "number"
},
"transmittedOctetsAccumulated": {
"description": "Cumulative count of octets transmitted as read at the end of the measurement interval",
"type": "number"
},
"transmittedOctetsDelta": {
"description": "Count of octets transmitted within the measurement interval",
"type": "number"
},
"transmittedTotalPacketsAccumulated": {
"description": "Cumulative count of all packets transmitted as read at the end of the measurement interval",
"type": "number"
},
"transmittedTotalPacketsDelta": {
"description": "Count of all packets transmitted within the measurement interval",
"type": "number"
},
"transmittedUnicastPacketsAccumulated": {
"description": "Cumulative count of unicast packets transmitted as read at the end of the measurement interval",
"type": "number"
},
"transmittedUnicastPacketsDelta": {
"description": "Count of unicast packets transmitted within the measurement interval",
"type": "number"
},
"valuesAreSuspect": {
"description": "Indicates whether vNicPerformance values are likely inaccurate due to counter overflow or other condtions",
"type": "string",
"enum": [ "true", "false" ]
},
"vNicIdentifier": {
"description": "vNic identification",
"type": "string"
}
},
"required": [ "valuesAreSuspect", "vNicIdentifier" ]
},
"voiceQualityFields": {
"description": "provides statistics related to customer facing voice products",
"type": "object",
"properties": {
"additionalInformation": {
"description": "additional voice quality fields if needed",
"type": "array",
"items": {
"$ref": "#/definitions/field"
}
},
"calleeSideCodec": {
"description": "callee codec for the call",
"type": "string"
},
"callerSideCodec": {
"description": "caller codec for the call",
"type": "string"
},
"correlator": {
"description": "this is the same for all events on this call",
"type": "string"
},
"endOfCallVqmSummaries": {
"$ref": "#/definitions/endOfCallVqmSummaries"
},
"phoneNumber": {
"description": "phone number associated with the correlator",
"type": "string"
},
"midCallRtcp": {
"description": "Base64 encoding of the binary RTCP data excluding Eth/IP/UDP headers",
"type": "string"
},
"vendorVnfNameFields": {
"$ref": "#/definitions/vendorVnfNameFields"
},
"voiceQualityFieldsVersion": {
"description": "version of the voiceQualityFields block",
"type": "number"
}
},
"required": [ "calleeSideCodec", "callerSideCodec", "correlator", "midCallRtcp",
"vendorVnfNameFields", "voiceQualityFieldsVersion" ]
}
}
}
|