aboutsummaryrefslogtreecommitdiffstats
path: root/dpo/data-formats/VES-4.27.2-dataformat.json
blob: 832b808ab9c75a507b84e9125242601c67cf5db8 (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
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
{
  "self": {
    "name": "VES_specification",
    "version": "4.27.2",
    "description": "VES spec from v4.1 and 27.2 spec"
  },
  "dataformatversion": "1.0.0",
  "jsonschema": {
    "$schema": "http://json-schema.org/draft-04/schema#",
    "definitions": {
      "schemaLicenseAndCopyrightNotice": {
        "description": "Copyright (c) 2017, AT&T Intellectual Property.  All rights reserved",
        "type": "object",
        "properties": {
          "apacheLicense2.0": {
            "description": "Licensed under the Apache License, Version 2.0 (the 'License'); you may not use this file except in compliance with the License. You may obtain a copy of the License at:",
            "type": "string"
          },
          "licenseUrl": {
            "description": "http://www.apache.org/licenses/LICENSE-2.0",
            "type": "string"
          },
          "asIsClause": {
            "description": "Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.",
            "type": "string"
          },
          "permissionsAndLimitations": {
            "description": "See the License for the specific language governing permissions and limitations under the License.",
            "type": "string"
          }
        }
      },
      "codecsInUse": {
        "description": "number of times an identified codec was used over the measurementInterval",
        "type": "object",
        "properties": {
          "codecIdentifier": {
            "type": "string"
          },
          "numberInUse": {
            "type": "number"
          }
        },
        "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"
          },
          "measurementInterval": {
            "type": "number"
          }
        },
        "required": [
          "commandType"
        ]
      },
      "commandList": {
        "description": "array of commands from an event collector toward an event source",
        "type": "array",
        "items": {
          "$ref": "#/definitions/commandListEntry"
        },
        "minItems": 0
      },
      "commandListEntry": {
        "description": "reference to a command object",
        "type": "object",
        "properties": {
          "command": {
            "$ref": "#/definitions/command"
          }
        },
        "required": [
          "command"
        ]
      },
      "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",
              "stateChange",
              "syslog",
              "thresholdCrossingAlert"
            ]
          },
          "eventId": {
            "description": "event key that is unique to the event source",
            "type": "string"
          },
          "eventType": {
            "description": "unique event topic name",
            "type": "string"
          },
          "functionalRole": {
            "description": "function of the event source e.g., eNodeB, MME, PCRF",
            "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"
          },
          "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 OAM VM",
            "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",
          "functionalRole",
          "lastEpochMicrosec",
          "priority",
          "reportingEntityName",
          "sequence",
          "sourceName",
          "startEpochMicrosec"
        ]
      },
      "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": "percent usage of an identified CPU",
        "type": "object",
        "properties": {
          "cpuIdentifier": {
            "type": "string"
          },
          "percentUsage": {
            "type": "number"
          }
        },
        "required": [
          "cpuIdentifier",
          "percentUsage"
        ]
      },
      "errors": {
        "description": "receive and transmit errors for the measurements domain",
        "type": "object",
        "properties": {
          "receiveDiscards": {
            "type": "number"
          },
          "receiveErrors": {
            "type": "number"
          },
          "transmitDiscards": {
            "type": "number"
          },
          "transmitErrors": {
            "type": "number"
          }
        },
        "required": [
          "receiveDiscards",
          "receiveErrors",
          "transmitDiscards",
          "transmitErrors"
        ]
      },
      "event": {
        "description": "the root level of the common event format",
        "type": "object",
        "properties": {
          "commonEventHeader": {
            "$ref": "#/definitions/commonEventHeader"
          },
          "faultFields": {
            "$ref": "#/definitions/faultFields"
          },
          "measurementsForVfScalingFields": {
            "$ref": "#/definitions/measurementsForVfScalingFields"
          },
          "mobileFlowFields": {
            "$ref": "#/definitions/mobileFlowFields"
          },
          "otherFields": {
            "$ref": "#/definitions/otherFields"
          },
          "stateChangeFields": {
            "$ref": "#/definitions/stateChangeFields"
          },
          "syslogFields": {
            "$ref": "#/definitions/syslogFields"
          },
          "thresholdCrossingAlertFields": {
            "$ref": "#/definitions/thresholdCrossingAlertFields"
          }
        },
        "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"
          },
          "eventSeverity": {
            "description": "event severity or priority",
            "type": "string",
            "enum": [
              "CRITICAL",
              "MAJOR",
              "MINOR",
              "WARNING",
              "NORMAL"
            ]
          },
          "eventSourceType": {
            "description": "type of event source; examples: other, router, switch, host, card, port, slotThreshold, portThreshold, 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",
          "specificProblem",
          "vfStatus"
        ]
      },
      "featuresInUse": {
        "description": "number of times an identified feature was used over the measurementInterval",
        "type": "object",
        "properties": {
          "featureIdentifier": {
            "type": "string"
          },
          "featureUtilization": {
            "type": "number"
          }
        },
        "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"
        ]
      },
      "internalHeaderFields": {
        "description": "enrichment fields for internal VES Event Listener service use only, not supplied by event sources",
        "type": "object"
      },
      "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"
        ]
      },
      "measurementGroup": {
        "description": "measurement group",
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "measurements": {
            "description": "array of name value pair measurements",
            "type": "array",
            "items": {
              "$ref": "#/definitions/field"
            }
          }
        },
        "required": [
          "name",
          "measurements"
        ]
      },
      "measurementsForVfScalingFields": {
        "description": "measurementsForVfScaling fields",
        "type": "object",
        "properties": {
          "additionalMeasurements": {
            "description": "additional measurement fields",
            "type": "array",
            "items": {
              "$ref": "#/definitions/measurementGroup"
            }
          },
          "aggregateCpuUsage": {
            "description": "aggregate CPU usage of the VM on which the VNFC reporting the event is running",
            "type": "number"
          },
          "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": "number"
          },
          "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": "number"
          },
          "cpuUsageArray": {
            "description": "usage of an array of CPUs",
            "type": "array",
            "items": {
              "$ref": "#/definitions/cpuUsage"
            }
          },
          "errors": {
            "$ref": "#/definitions/errors"
          },
          "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"
          },
          "memoryConfigured": {
            "description": "memory in MB configured in the VM on which the VNFC reporting the event is running",
            "type": "number"
          },
          "memoryUsed": {
            "description": "memory usage in MB of the VM on which the VNFC reporting the event is running",
            "type": "number"
          },
          "numberOfMediaPortsInUse": {
            "description": "number of media ports in use",
            "type": "number"
          },
          "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": "number"
          },
          "vNicUsageArray": {
            "description": "usage of an array of virtual network interface cards",
            "type": "array",
            "items": {
              "$ref": "#/definitions/vNicUsage"
            }
          }
        },
        "required": [
          "measurementInterval"
        ]
      },
      "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": "number"
          },
          "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": "number"
          },
          "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": "number"
          },
          "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",
          "otherEndpointIpAddress",
          "otherEndpointPort",
          "reportingEndpointIpAddr",
          "reportingEndpointPort"
        ]
      },
      "otherFields": {
        "description": "additional fields not reported elsewhere",
        "type": "array",
        "items": {
          "$ref": "#/definitions/field"
        }
      },
      "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"
        ]
      },
      "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",
          "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",
            "type": "array",
            "items": {
              "$ref": "#/definitions/field"
            }
          },
          "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": "number"
          },
          "syslogFieldsVersion": {
            "description": "version of the syslogFields block",
            "type": "number"
          },
          "syslogMsg": {
            "description": "syslog message",
            "type": "string"
          },
          "syslogPri": {
            "description": "0-192 combined severity and facility",
            "type": "number"
          },
          "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"
          },
          "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",
          "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"
        ]
      },
      "vNicUsage": {
        "description": "usage of identified virtual network interface card",
        "type": "object",
        "properties": {
          "broadcastPacketsIn": {
            "type": "number"
          },
          "broadcastPacketsOut": {
            "type": "number"
          },
          "bytesIn": {
            "type": "number"
          },
          "bytesOut": {
            "type": "number"
          },
          "multicastPacketsIn": {
            "type": "number"
          },
          "multicastPacketsOut": {
            "type": "number"
          },
          "packetsIn": {
            "type": "number"
          },
          "packetsOut": {
            "type": "number"
          },
          "unicastPacketsIn": {
            "type": "number"
          },
          "unicastPacketsOut": {
            "type": "number"
          },
          "vNicIdentifier": {
            "type": "string"
          }
        },
        "required": [
          "bytesIn",
          "bytesOut",
          "packetsIn",
          "packetsOut",
          "vNicIdentifier"
        ]
      }
    },
    "title": "Event Listener",
    "type": "object",
    "properties": {
      "event": {
        "$ref": "#/definitions/event"
      }
    },
    "eventList": {
      "$ref": "#/definitions/eventList"
    }
  }
}