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
8 # http://www.apache.org/licenses/LICENSE-2.0
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=========================================================
17 # ECOMP is a trademark and service mark of AT&T Intellectual Property.
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
27 email: dcae@lists.openecomp.org
29 description: VESCollector
30 url: 'https://gerrit.onap.org/r/#/admin/projects/dcaegen2/collectors/ves'
37 description: HTTP Basic Authentication. Works over `HTTP` and `HTTPS`
44 description: uri for posting VES event objects
45 operationId: veseventPut
55 $ref: '#/definitions/VES5Request'
58 description: VES Event Accepted.
60 $ref: '#/definitions/ApiResponseMessage'
62 description: Bad request provided
64 $ref: '#/definitions/ApiResponseMessage'
66 description: Unauthorized request
68 $ref: '#/definitions/ApiResponseMessage'
70 description: Service Unavailable
72 $ref: '#/definitions/ApiResponseMessage'
73 /eventListener/v5/eventBatch:
78 description: uri for posting VES batch event objects
79 operationId: veseventbatchPut
89 $ref: '#/definitions/VES5Request'
92 description: VES Event Accepted.
94 $ref: '#/definitions/ApiResponseMessage'
96 description: Bad request provided
98 $ref: '#/definitions/ApiResponseMessage'
100 description: Unauthorized request
102 $ref: '#/definitions/ApiResponseMessage'
104 description: Service Unavailable
106 $ref: '#/definitions/ApiResponseMessage'
111 description: healthcheck successful
127 $ref: '#/definitions/event'
129 description: number of times an identified codec was used over the measurementInterval
140 description: command from an event collector toward an event source
146 - heartbeatIntervalChange
147 - measurementIntervalChange
148 - provideThrottlingState
149 - throttlingSpecification
150 eventDomainThrottleSpecification:
151 $ref: '#/definitions/eventDomainThrottleSpecification'
159 description: fields common to all events
163 description: the eventing domain associated with the event
168 - measurementsForVfScaling
174 - thresholdCrossingAlert
177 description: event key that is unique to the event source
180 description: unique event name
183 description: 'for example - applicationVnf, guestOS, hostOS, platform'
185 internalHeaderFields:
186 $ref: '#/definitions/internalHeaderFields'
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
195 3 character network function component type, aligned with vfc naming
199 description: '4 character network function type, aligned with vnf naming standards'
202 description: processing priority
211 UUID identifying the entity reporting the event, for example an OAM
212 VM; must be populated by the ATT enrichment process
216 name of the entity reporting the event, for example, an EMS name; may
217 be the same as sourceName
221 ordering of events communicated by an event source instance or 0 if
226 UUID identifying the entity experiencing the event issue; must be
227 populated by the ATT enrichment process
230 description: name of the entity experiencing the event issue
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
239 description: version of the event header
247 - reportingEntityName
253 description: performance counter
273 description: usage of an identified CPU
277 description: cpu identifer
280 description: percentage of CPU time spent in the idle task
283 description: percentage of time spent servicing interrupts
287 percentage of time spent running user space processes that have been
291 description: percentage of time spent handling soft irq interrupts
295 percentage of time spent in involuntary wait which is neither user,
296 system or idle time and is effectively time that went missing
299 description: percentage of time spent on system tasks running the kernel
302 description: percentage of time spent running un-niced user space processes
305 description: percentage of CPU time spent waiting for I/O operations to complete
309 aggregate cpu usage of the virtual machine on which the VNFC reporting
316 description: usage of an identified disk
320 description: disk identifier
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
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
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
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
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
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
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
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
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
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
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
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
407 number of octets per second read from a disk or partition; provide the
408 average measurement within the measurement interval
412 number of octets per second read from a disk or partition; provide the
413 last measurement within the measurement interval
417 number of octets per second read from a disk or partition; provide the
418 maximum measurement within the measurement interval
422 number of octets per second read from a disk or partition; provide the
423 minimum measurement within the measurement interval
427 number of octets per second written to a disk or partition; provide
428 the average measurement within the measurement interval
432 number of octets per second written to a disk or partition; provide
433 the last measurement within the measurement interval
437 number of octets per second written to a disk or partition; provide
438 the maximum measurement within the measurement interval
442 number of octets per second written to a disk or partition; provide
443 the minimum measurement within the measurement interval
447 number of read operations per second issued to the disk; provide the
448 average measurement within the measurement interval
452 number of read operations per second issued to the disk; provide the
453 last measurement within the measurement interval
457 number of read operations per second issued to the disk; provide the
458 maximum measurement within the measurement interval
462 number of read operations per second issued to the disk; provide the
463 minimum measurement within the measurement interval
467 number of write operations per second issued to the disk; provide the
468 average measurement within the measurement interval
472 number of write operations per second issued to the disk; provide the
473 last measurement within the measurement interval
477 number of write operations per second issued to the disk; provide the
478 maximum measurement within the measurement interval
482 number of write operations per second issued to the disk; provide the
483 minimum measurement within the measurement interval
485 diskPendingOperationsAvg:
487 queue size of pending I/O operations per second; provide the average
488 measurement within the measurement interval
490 diskPendingOperationsLast:
492 queue size of pending I/O operations per second; provide the last
493 measurement within the measurement interval
495 diskPendingOperationsMax:
497 queue size of pending I/O operations per second; provide the maximum
498 measurement within the measurement interval
500 diskPendingOperationsMin:
502 queue size of pending I/O operations per second; provide the minimum
503 measurement within the measurement interval
507 milliseconds a read operation took to complete; provide the average
508 measurement within the measurement interval
512 milliseconds a read operation took to complete; provide the last
513 measurement within the measurement interval
517 milliseconds a read operation took to complete; provide the maximum
518 measurement within the measurement interval
522 milliseconds a read operation took to complete; provide the minimum
523 measurement within the measurement interval
527 milliseconds a write operation took to complete; provide the average
528 measurement within the measurement interval
532 milliseconds a write operation took to complete; provide the last
533 measurement within the measurement interval
537 milliseconds a write operation took to complete; provide the maximum
538 measurement within the measurement interval
542 milliseconds a write operation took to complete; provide the minimum
543 measurement within the measurement interval
547 endOfCallVqmSummaries:
548 description: provides end of call voice quality metrics
552 description: ' adjacency name'
555 description: Either Caller or Callee
563 endpointRtpOctetsDiscarded:
566 endpointRtpOctetsReceived:
569 endpointRtpOctetsSent:
572 endpointRtpPacketsDiscarded:
575 endpointRtpPacketsReceived:
578 endpointRtpPacketsSent:
584 localRtpOctetsDiscarded:
587 localRtpOctetsReceived:
593 localRtpPacketsDiscarded:
596 localRtpPacketsReceived:
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)
618 description: millisecs
622 - endpointDescription
624 description: the root level of the common event format
628 $ref: '#/definitions/commonEventHeader'
630 $ref: '#/definitions/faultFields'
632 $ref: '#/definitions/heartbeatFields'
633 measurementsForVfScalingFields:
634 $ref: '#/definitions/measurementsForVfScalingFields'
636 $ref: '#/definitions/mobileFlowFields'
638 $ref: '#/definitions/otherFields'
640 $ref: '#/definitions/sipSignalingFields'
642 $ref: '#/definitions/stateChangeFields'
644 $ref: '#/definitions/syslogFields'
645 thresholdCrossingAlertFields:
646 $ref: '#/definitions/thresholdCrossingAlertFields'
648 $ref: '#/definitions/voiceQualityFields'
651 eventDomainThrottleSpecification:
652 description: specification of what information to suppress within an event domain
656 description: Event domain enum from the commonEventHeader domain field
658 suppressedFieldNames:
660 List of optional field names in the event block that should not be
661 sent to the Event Listener
665 suppressedNvPairsList:
667 Optional list of specific NvPairsNames to suppress within a given
671 $ref: '#/definitions/suppressedNvPairs'
674 eventDomainThrottleSpecificationList:
675 description: array of eventDomainThrottleSpecifications
678 $ref: '#/definitions/eventDomainThrottleSpecification'
681 description: array of events
684 $ref: '#/definitions/event'
686 description: fields specific to fault events
689 alarmAdditionalInformation:
690 description: additional alarm information
693 $ref: '#/definitions/field'
695 description: alarm condition reported by the device
699 card, port, channel or interface name of the device generating the
704 Event category, for example: license, link, routing, security,
708 description: event severity
718 type of event source; examples: card, host, other, port,
719 portThreshold, router, slotThreshold, switch, virtualMachine,
720 virtualNetworkFunction
723 description: version of the faultFields block
726 description: short description of the alarm or problem
729 description: virtual function status enumeration
734 - Preparing to terminate
736 - Requesting termination
746 number of times an identified feature was used over the
758 description: name value pair
770 disk usage of an identified virtual machine in gigabytes and/or gigabytes
792 - ephemeralConfigured
797 description: Mobility GTP Protocol per flow metrics
801 description: average bit error rate
803 avgPacketDelayVariation:
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
810 description: average delivery latency
812 avgReceiveThroughput:
813 description: average receive throughput
815 avgTransmitThroughput:
816 description: average transmit throughput
818 durConnectionFailedStatus:
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
824 durTunnelFailedStatus:
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
831 description: Endpoint activating the flow
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
839 flowActivationMicrosec:
840 description: Integer microseconds for the start of the flow connection
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
850 description: Endpoint deactivating the flow
852 flowDeactivationEpoch:
854 Time for the start of the flow connection, in integer UTC epoch time
857 flowDeactivationMicrosec:
858 description: Integer microseconds for the start of the flow connection
860 flowDeactivationTime:
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
868 connection status at reporting time as a working / inactive / failed
872 description: Current connection state at reporting time
875 description: Current tunnel state at reporting time
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
891 Array of unique IP Type-of-Service values observed in the flow where
892 values range from '0' to '255'
897 description: large packet round trip time
899 largePacketThreshold:
900 description: large packet threshold being applied
902 maxPacketDelayVariation:
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
909 description: maximum receive bit rate
912 description: maximum transmit bit rate
914 mobileQciCosCountList:
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
927 Array of unique LTE QCI or UMTS class-of-service values observed in
932 numActivationFailures:
934 Number of failed activation requests, as observed by the reporting
938 description: number of errored bits
941 description: 'number of bytes received, including retransmissions'
944 description: 'number of bytes transmitted, including retransmissions'
947 description: number of received packets dropped due to errors per virtual interface
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
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
960 description: Http error count
963 description: 'number of tunneled layer 7 bytes received, including retransmissions'
965 numL7BytesTransmitted:
967 number of tunneled layer 7 bytes transmitted, excluding
971 description: number of lost packets
973 numOutOfOrderPackets:
974 description: number of out-of-order packets
977 description: number of errored packets
979 numPacketsReceivedExclRetrans:
980 description: 'number of packets received, excluding retransmission'
982 numPacketsReceivedInclRetrans:
983 description: 'number of packets received, including retransmission'
985 numPacketsTransmittedInclRetrans:
986 description: 'number of packets transmitted, including retransmissions'
989 description: number of packet retries
992 description: number of packet timeouts
994 numTunneledL7BytesReceived:
995 description: 'number of tunneled layer 7 bytes received, excluding retransmissions'
998 description: round trip time
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
1011 description: Array of unique TCP Flags observed in the flow
1017 Time in milliseconds between the connection activation and first byte
1022 - avgPacketDelayVariation
1024 - avgReceiveThroughput
1025 - avgTransmitThroughput
1026 - flowActivationEpoch
1027 - flowActivationMicrosec
1028 - flowDeactivationEpoch
1029 - flowDeactivationMicrosec
1030 - flowDeactivationTime
1032 - maxPacketDelayVariation
1033 - numActivationFailures
1036 - numBytesTransmitted
1038 - numL7BytesReceived
1039 - numL7BytesTransmitted
1041 - numOutOfOrderPackets
1043 - numPacketsReceivedExclRetrans
1044 - numPacketsReceivedInclRetrans
1045 - numPacketsTransmittedInclRetrans
1048 - numTunneledL7BytesReceived
1052 description: optional field block for fields specific to heartbeat events
1056 description: additional heartbeat fields if needed
1059 $ref: '#/definitions/field'
1060 heartbeatFieldsVersion:
1061 description: version of the heartbeatFields block
1064 description: current heartbeat interval in seconds
1067 - heartbeatFieldsVersion
1069 internalHeaderFields:
1071 enrichment fields for internal VES Event Listener service use only, not
1072 supplied by event sources
1076 json object schema, name and other meta-information along with one or more
1081 description: one or more instances of the jsonObject
1084 $ref: '#/definitions/jsonObjectInstance'
1086 description: name of the JSON Object
1089 description: json schema for the object
1092 description: Url to the json schema for the object
1094 nfSubscribedObjectName:
1095 description: name of the object associated with the nfSubscriptonId
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
1108 meta-information about an instance of a jsonObject along with the actual
1113 description: an instance conforming to the jsonObject schema
1115 objectInstanceEpochMicrosec:
1117 the unix time aka epoch time associated with this objectInstance--as
1118 microseconds elapsed since 1 Jan 1970 not including leap seconds
1122 an ordered set of keys that identifies this particular instance of
1126 $ref: '#/definitions/key'
1131 tuple which provides the name of a key along with its value and relative
1136 description: name of the key
1139 description: relative sequence or order of the key with respect to other keys
1142 description: value of the key
1146 latencyBucketMeasure:
1147 description: number of counts falling within a defined latency bucket
1152 highEndOfLatencyBucket:
1154 lowEndOfLatencyBucket:
1158 measurementsForVfScalingFields:
1159 description: measurementsForVfScaling fields
1163 description: additional name-value-pair fields
1166 $ref: '#/definitions/field'
1167 additionalMeasurements:
1168 description: array of named name-value-pair arrays
1171 $ref: '#/definitions/namedArrayOfFields'
1174 array of JSON objects described by name, schema and other
1178 $ref: '#/definitions/jsonObject'
1180 description: array of codecs in use
1183 $ref: '#/definitions/codecsInUse'
1186 peak concurrent sessions for the VM or VNF over the
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
1196 description: usage of an array of CPUs
1199 $ref: '#/definitions/cpuUsage'
1201 description: usage of an array of disks
1204 $ref: '#/definitions/diskUsage'
1206 description: array of features in use
1209 $ref: '#/definitions/featuresInUse'
1210 filesystemUsageArray:
1212 filesystem usage of the VM on which the VNFC reporting the event is
1216 $ref: '#/definitions/filesystemUsage'
1217 latencyDistribution:
1219 array of integers representing counts of requests whose latency in
1220 milliseconds falls within per-VNF configured ranges
1223 $ref: '#/definitions/latencyBucketMeasure'
1226 mean seconds required to respond to each request for the VM on which
1227 the VNFC reporting the event is running
1229 measurementInterval:
1230 description: interval over which measurements are being reported in seconds
1232 measurementsForVfScalingVersion:
1233 description: version of the measurementsForVfScaling block
1236 description: memory usage of an array of VMs
1239 $ref: '#/definitions/memoryUsage'
1240 numberOfMediaPortsInUse:
1241 description: number of media ports in use
1245 peak rate of service requests per second to the VNF over the
1249 description: represents busy-ness of the VNF from 0 to 100 as reported by the VNFC
1251 vNicPerformanceArray:
1252 description: usage of an array of virtual network interface cards
1255 $ref: '#/definitions/vNicPerformance'
1257 - measurementInterval
1258 - measurementsForVfScalingVersion
1260 description: memory usage of an identified virtual machine
1264 description: kibibytes of temporary storage for raw disk blocks
1267 description: kibibytes of memory used for cache
1271 kibibytes of memory configured in the virtual machine on which the
1272 VNFC reporting the event is running
1275 description: kibibytes of physical RAM left unused by the system
1279 the part of the slab that can be reclaimed such as caches measured in
1284 the part of the slab that cannot be reclaimed even when lacking memory
1285 measured in kibibytes
1289 total memory minus the sum of free, buffered, cached and slab memory
1290 measured in kibibytes
1293 description: virtual machine identifier associated with the memory metrics
1300 description: mobileFlow fields
1304 description: additional mobileFlow fields if needed
1307 $ref: '#/definitions/field'
1309 description: Application type inferred
1312 description: application protocol
1315 description: application protocol version
1318 description: cell id
1321 description: 'Abbreviation referencing a 3GPP reference point e.g., S1-U, S11, etc'
1324 description: Evolved Cell Global Id
1328 Flow direction, indicating if the reporting node is the source of the
1329 flow or destination for the flow
1332 $ref: '#/definitions/gtpPerFlowMetrics'
1334 description: GTP protocol
1337 description: GTP protocol version
1340 description: 'HTTP request header, if the flow connects to a node referenced by HTTP'
1344 IMEI for the subscriber UE used in this flow, if the flow connects to
1349 IMSI for the subscriber UE used in this flow, if the flow connects to
1353 description: 'IP protocol type e.g., TCP, UDP, RTP...'
1356 description: 'IP protocol version e.g., IPv4, IPv6'
1359 description: location area code
1362 description: mobile country code
1365 description: mobile network code
1367 mobileFlowFieldsVersion:
1368 description: version of the mobileFlowFields block
1372 MSISDN for the subscriber UE used in this flow, as an integer, if the
1373 flow connects to a mobile device
1375 otherEndpointIpAddress:
1377 IP address for the other endpoint, as used for the flow being reported
1382 IP Port for the reporting entity, as used for the flow being reported
1385 otherFunctionalRole:
1387 Functional role of the other endpoint for the flow being reported on
1388 e.g., MME, S-GW, P-GW, PCRF...
1391 description: routing area code
1393 radioAccessTechnology:
1394 description: 'Radio Access Technology e.g., 2G, 3G, LTE'
1396 reportingEndpointIpAddr:
1398 IP address for the reporting entity, as used for the flow being
1401 reportingEndpointPort:
1403 IP port for the reporting entity, as used for the flow being reported
1407 description: service area code
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
1416 description: transport area code
1419 description: tunnel identifier
1422 description: VLAN identifier used by this flow
1429 - mobileFlowFieldsVersion
1430 - otherEndpointIpAddress
1432 - reportingEndpointIpAddr
1433 - reportingEndpointPort
1435 description: an array of name value pairs along with a name for the array
1441 description: array of name value pairs
1444 $ref: '#/definitions/field'
1450 fields for events belonging to the 'other' domain of the commonEventHeader
1454 hashOfNameValuePairArrays:
1455 description: array of named name-value-pair arrays
1458 $ref: '#/definitions/namedArrayOfFields'
1461 array of JSON objects described by name, schema and other
1465 $ref: '#/definitions/jsonObject'
1467 description: array of name-value pairs
1470 $ref: '#/definitions/field'
1472 description: version of the otherFields block
1475 - otherFieldsVersion
1477 description: standard request error data structure
1482 Unique message identifier of the format ABCnnnn where ABC is either
1483 SVC for Service Exceptions or POL for Policy Exception
1487 Message text, with replacement variables marked with %n, where n is an
1488 index into the list of <variables> elements, starting at 1
1492 Hyperlink to a detailed error resource e.g., an HTML page for browser
1497 List of zero or more strings that represent the contents of the
1498 variables used by the message text
1504 description: sip signaling fields
1507 additionalInformation:
1508 description: additional sip signaling fields if needed
1511 $ref: '#/definitions/field'
1513 description: the full SIP request/response including headers and bodies
1516 description: this is the same for all events on this call
1519 description: IP address on VNF
1522 description: port on VNF
1525 description: IP address of peer endpoint
1528 description: port of peer endpoint
1530 sipSignalingFieldsVersion:
1531 description: version of the sipSignalingFields block
1535 the SIP Method or Response (INVITE, 200 OK, BYE,
1538 vendorVnfNameFields:
1539 $ref: '#/definitions/vendorVnfNameFields'
1546 - sipSignalingFieldsVersion
1547 - vendorVnfNameFields
1549 description: stateChange fields
1553 description: additional stateChange fields if needed
1556 $ref: '#/definitions/field'
1558 description: new state of the entity
1565 description: previous state of the entity
1571 stateChangeFieldsVersion:
1572 description: version of the stateChangeFields block
1575 description: card or port name of the entity that changed state
1580 - stateChangeFieldsVersion
1584 List of specific NvPairsNames to suppress within a given Name-Value Field
1585 for event Throttling
1589 description: Name of the field within which are the nvpair names to suppress
1591 suppressedNvPairNames:
1592 description: Array of nvpair names to suppress within the nvpairFieldName
1598 - suppressedNvPairNames
1600 description: sysLog fields
1605 additional syslog fields if needed provided as name=value delimited by
1606 a pipe | symbol, for example: 'name1=value1|name2=value2|'
1609 description: hostname of the device
1613 type of event source; examples: other, router, switch, host, card,
1614 port, slotThreshold, portThreshold, virtualMachine,
1615 virtualNetworkFunction
1618 description: numeric code from 0 to 23 for facility--see table in documentation
1620 syslogFieldsVersion:
1621 description: version of the syslogFields block
1624 description: syslog message
1627 description: 0-192 combined severity and facility
1630 description: identifies the application that originated the message
1634 a change in the value of this field indicates a discontinuity in
1639 syslog structured data consisting of a structured data Id followed by
1640 a set of key value pairs
1643 description: 0-32 char in format name@number for example ourSDID@32473
1647 numerical Code for severity derived from syslogPri as remaider of
1661 msgId indicating the type of message such as TCPOUT or TCPIN; NILVALUE
1662 should be used when no other value can be provided
1666 IANA assigned version of the syslog protocol specification - typically
1671 - syslogFieldsVersion
1674 thresholdCrossingAlertFields:
1675 description: fields specific to threshold crossing alert events
1679 description: additional threshold crossing alert fields if needed
1682 $ref: '#/definitions/field'
1683 additionalParameters:
1684 description: performance counters
1687 $ref: '#/definitions/counter'
1689 description: Event action
1696 description: Unique short alert description such as IF-SHUB-ERRDROP
1699 description: Event type
1707 description: Calculated API value (if applicable)
1709 associatedAlertIdList:
1710 description: List of eventIds associated with the event being reported
1714 collectionTimestamp:
1716 Time when the performance collector picked up the data; with RFC 2822
1717 compliant format: Sat, 13 Mar 2010 11:29:05 -0800
1720 description: Specific performance collector instance used
1723 description: type of network element - internal ATT field
1726 description: event severity or priority
1734 eventStartTimestamp:
1736 Time closest to when the measurement was made; with RFC 2822 compliant
1737 format: Sat, 13 Mar 2010 11:29:05 -0800
1740 description: Physical or logical port or card (if applicable)
1743 description: network name - internal ATT field
1746 description: Reserved for future use
1748 thresholdCrossingFieldsVersion:
1749 description: version of the thresholdCrossingAlertFields block
1752 - additionalParameters
1756 - collectionTimestamp
1758 - eventStartTimestamp
1759 - thresholdCrossingFieldsVersion
1760 vendorVnfNameFields:
1761 description: 'provides vendor, vnf and vfModule identifying information'
1765 description: VNF vendor name
1768 description: ASDC vfModuleName for the vfModule generating the event
1771 description: ASDC modelName for the VNF generating the event
1777 describes the performance and errors of an identified virtual network
1781 receivedBroadcastPacketsAccumulated:
1783 Cumulative count of broadcast packets received as read at the end of
1784 the measurement interval
1786 receivedBroadcastPacketsDelta:
1787 description: Count of broadcast packets received within the measurement interval
1789 receivedDiscardedPacketsAccumulated:
1791 Cumulative count of discarded packets received as read at the end of
1792 the measurement interval
1794 receivedDiscardedPacketsDelta:
1795 description: Count of discarded packets received within the measurement interval
1797 receivedErrorPacketsAccumulated:
1799 Cumulative count of error packets received as read at the end of the
1800 measurement interval
1802 receivedErrorPacketsDelta:
1803 description: Count of error packets received within the measurement interval
1805 receivedMulticastPacketsAccumulated:
1807 Cumulative count of multicast packets received as read at the end of
1808 the measurement interval
1810 receivedMulticastPacketsDelta:
1811 description: Count of multicast packets received within the measurement interval
1813 receivedOctetsAccumulated:
1815 Cumulative count of octets received as read at the end of the
1816 measurement interval
1818 receivedOctetsDelta:
1819 description: Count of octets received within the measurement interval
1821 receivedTotalPacketsAccumulated:
1823 Cumulative count of all packets received as read at the end of the
1824 measurement interval
1826 receivedTotalPacketsDelta:
1827 description: Count of all packets received within the measurement interval
1829 receivedUnicastPacketsAccumulated:
1831 Cumulative count of unicast packets received as read at the end of the
1832 measurement interval
1834 receivedUnicastPacketsDelta:
1835 description: Count of unicast packets received within the measurement interval
1837 transmittedBroadcastPacketsAccumulated:
1839 Cumulative count of broadcast packets transmitted as read at the end
1840 of the measurement interval
1842 transmittedBroadcastPacketsDelta:
1843 description: Count of broadcast packets transmitted within the measurement interval
1845 transmittedDiscardedPacketsAccumulated:
1847 Cumulative count of discarded packets transmitted as read at the end
1848 of the measurement interval
1850 transmittedDiscardedPacketsDelta:
1851 description: Count of discarded packets transmitted within the measurement interval
1853 transmittedErrorPacketsAccumulated:
1855 Cumulative count of error packets transmitted as read at the end of
1856 the measurement interval
1858 transmittedErrorPacketsDelta:
1859 description: Count of error packets transmitted within the measurement interval
1861 transmittedMulticastPacketsAccumulated:
1863 Cumulative count of multicast packets transmitted as read at the end
1864 of the measurement interval
1866 transmittedMulticastPacketsDelta:
1867 description: Count of multicast packets transmitted within the measurement interval
1869 transmittedOctetsAccumulated:
1871 Cumulative count of octets transmitted as read at the end of the
1872 measurement interval
1874 transmittedOctetsDelta:
1875 description: Count of octets transmitted within the measurement interval
1877 transmittedTotalPacketsAccumulated:
1879 Cumulative count of all packets transmitted as read at the end of the
1880 measurement interval
1882 transmittedTotalPacketsDelta:
1883 description: Count of all packets transmitted within the measurement interval
1885 transmittedUnicastPacketsAccumulated:
1887 Cumulative count of unicast packets transmitted as read at the end of
1888 the measurement interval
1890 transmittedUnicastPacketsDelta:
1891 description: Count of unicast packets transmitted within the measurement interval
1895 Indicates whether vNicPerformance values are likely inaccurate due to
1896 counter overflow or other condtions
1902 description: vNic identification
1908 description: provides statistics related to customer facing voice products
1911 additionalInformation:
1912 description: additional voice quality fields if needed
1915 $ref: '#/definitions/field'
1917 description: callee codec for the call
1920 description: caller codec for the call
1923 description: this is the same for all events on this call
1925 endOfCallVqmSummaries:
1926 $ref: '#/definitions/endOfCallVqmSummaries'
1928 description: phone number associated with the correlator
1931 description: Base64 encoding of the binary RTCP data excluding Eth/IP/UDP headers
1933 vendorVnfNameFields:
1934 $ref: '#/definitions/vendorVnfNameFields'
1935 voiceQualityFieldsVersion:
1936 description: version of the voiceQualityFields block
1943 - vendorVnfNameFields
1944 - voiceQualityFieldsVersion