swagger_vescollector.yaml

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