1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright 2017 AT&T Intellectual Property, All rights reserved
4 .. Copyright 2017-2018 Huawei Technologies Co., Ltd.
6 .. _ves_event_listener_7_1:
8 Service: VES Event Listener 7.1.1
9 ---------------------------------
11 +-----------------------------------------------------------------------------+
12 | **Legal Disclaimer** |
14 | Licensed under the Apache License, Version 2.0 (the "License"); you may not |
15 | use this file except in compliance with the License. You may obtain a copy |
18 | http://www.apache.org/licenses/LICENSE-2.0 |
20 | Unless required by applicable law or agreed to in writing, software |
21 | distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
22 | WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
23 | License for the specific language governing permissions and limitations |
24 | under the License. |
25 +-----------------------------------------------------------------------------+
28 :Document: VES Event Listener
30 :Revision Date: January 28th, 2020
31 :Author: Rich Erickson
33 +-----------------+-----------------------------+
34 | Contributors: | **Min Chen – AT&T** |
36 | | **Fred Delaplace - AT&T** |
38 | | **Andrew Egan – AT&T** |
40 | | **Alok Gupta – AT&T** |
42 | | **Marge Hillis – Nokia** |
44 | | **Gerard Hynes – AT&T** |
46 | | **Ken Kelly – AT&T** |
48 | | **Mark Scott – Ericsson** |
50 | | **Tim Verall – Intel** |
52 | | **Sumit Verdi – VMWare** |
53 +-----------------+-----------------------------+
55 .. contents:: Table of Contents
60 This document describes the RESTful interface for the VES Event
61 Listener. The VES acronym originally stood for Virtual-function Event
62 Streaming, but VES has been generalized to support network-function
63 event streaming, whether virtualized or not. The VES Event Listener is
64 capable of receiving any event sent in the VES Common Event Format. The
65 Common Event Format is expressed in JSON schema in section 4 of this
66 document. In the Common Event Format, an event consists of a required
67 Common Event Header block (i.e., object) accompanied by zero or more
70 It should be understood that events are well structured packages of
71 information, identified by an eventName, which are asynchronously
72 communicated to subscribers who are interested in the eventName. Events
73 can convey measurements, faults, syslogs, threshold crossing alerts and
74 other types of information. Events are simply a way of communicating
75 well-structured packages of information to one or more instances of an
76 Event Listener service.
78 This document describes a RESTful connectionless push event listener
79 can receive single events or batches of events in the
80 Common Event Format. In future, additional documents may describe other
81 transports which make use of persistent TCP connections for high volumes
84 Compatibility with ONAP
85 ~~~~~~~~~~~~~~~~~~~~~~~
87 Unless otherwise stated, this version of the Event Listener specification is
88 compatible with the release of ONAP the specification is released under. In
89 other words, if the specification is released under the Frankfurt ONAP Release,
90 then the VES Event Collectors provided by DCAE will also be compatible with
96 All events must be compliant with the common event format, but specific
97 events identified by their eventNames, may require that certain fields,
98 which are optional in the common event format, be present when they are
99 published. For example, a specific eventName may require that specific
100 name-value pairs be present in the extensible structures provided within
101 the Common Event Format.
103 Events are registered using an extensible YAML format (defined in a
104 separate document), which specifies, for each eventName, the fields that
105 are required, what field values may be sent, and any special handling
106 that should be performed on those eventNames.
108 Naming Standards for eventName
109 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
111 To prevent naming collisions, eventNames sent as part of the
112 commonEventHeader, should conform to the following naming convention
113 designed to summarize the purpose and type of the event, and to ensure
114 the uniqueness of the eventName:
116 {DomainAbbreviation}\_{PublisherName}\_{Description}
118 Each underscore-separated subfield above must start with a capital
119 letter and use camel-casing to separate words and acronyms. Acronyms
120 must capitalize only the first letter of the acronym. Spaces and
121 underscores should not appear within any subfield.
123 The DomainAbbreviation subfield derives from the ‘domain’ field in the
124 commonEventHeader, as specified below:
126 - ‘Fault’ for the fault domain
128 - ‘Heartbeat’ for the heartbeat domain
130 - ‘Measurement’ for the measurement domain
132 - ‘MobileFlow’ for the mobileFlow domain
134 - ‘Notification’ for the notification domain
136 - ‘Other’ for the other domain
138 - ‘Perf3gpp’ for the perf3gpp domain
140 - ‘PnfReg’ for the pnfRegistration domain
142 - ‘SipSignaling’ for the sipSignaling domain
144 - ‘StateChange’ for the stateChange domain
146 - ‘Syslog’ for the syslog domain
148 - ‘Tca’ for the thresholdCrossingAlert domain
150 - ‘VoiceQuality’ for the voiceQuality domain
152 The PublisherName subfield describes the vendor product or application
153 publishing the event. This subfield conforms to the following
156 - Vendor products are specified as:
158 {productName}-{vendorName}
160 For example: Visbc-Metaswitch or Vdbe-Juniper, where a hyphen is
161 used to separate the productName and vendorName subfields. Note that
162 the productName and vendorName subfields must not include hyphens
165 Organizing the information in this way will cause an alphabetical
166 listing of eventNames to sort similar network functions together,
167 rather than to sort them by vendor.
169 The productName subfield may describe a NF or a NFC. Where NFC names
170 may be reused across different NF’s, they should be specified as:
174 where a colon is used to separate the NfName and NfcName subfields.
175 Note that the NfName and NfcName subfields must not include colons
178 The ProductName may also describe other types of vendor modules or
179 components such as a VM, application or hostname. As with NFs and
180 NFCs, parent:child relationships may be communicated using colon as
181 a subfield delimiter.
183 - Service providers who adopt the VES Common Event Format for internal
184 use, may provide PublisherName without the vendorName subfield. They
185 would typically identify an application, system, service or
186 microservice publishing the event (e.g., ‘Policy’, ‘So’,
187 ‘MobileCallRecording’ or ‘Dkat’). As with NFs and NFCs, parent:child
188 relationships may be communicated using colon as a subfield delimiter
189 (e.g., ApplicationName:ApplicationComponent).
191 The final subfield of the eventName name should describe, in a compact
192 camel case format the specific information being conveyed by the event.
193 In some cases, this final subfield may not be required (e.g., in the
194 case of certain heartbeats).
196 Examples of eventNames following the naming standards are provided
199 - Tca\_Vdbe-Ericsson\_CpuThresholdExceeded
201 - Heartbeat\_Visbc:Mmc-Metaswitch
203 - Syslog\_Vdbe-Ericsson
205 - Fault\_MobileCallRecording\_PilotNumberPoolExhaustion
207 - Other\_So:WanBonding\_InstantiationPart1Complete
209 EventId Use Cases Examples
210 ~~~~~~~~~~~~~~~~~~~~~~~~~~
215 **NOTE**: Please note, the following are only *examples*, and other formats
216 can be used provided they meet the requirement that the ``eventId`` is unique
217 for all events or unique fault occurrence.
219 **Example 1**: assumes a unique key for each domain consisting of domain
220 followed by an integer domain<n> or domainId<n>, where <n> is a positive integer,
221 e.g. fault000001, heartbeat000001, measurement000005,
222 notification3gppPerfFileReady0005
224 **Example 2**: assumes a unique integer key for all events across all domains
225 <n>: 000000001, 00000002, 000000003
229 1. All domains except Fault: each time a subsequent event is sent the
230 integer part of eventId will increment by 1. Repeat of eventId
231 assumes duplicate event. Sequence number is set to 0 for all domains
234 2. eventId construction for Fault Events:
236 a. Most likely scenario
238 * The sourceName on each Fault event is the NF Instance Name
239 (pnf-name or vnf-name or vm-name) as entered in A&AI uniquely
240 identifying this instance of the NF.
242 * The eventId on Fault events is the same every time a given
243 fault is raised (including onset and re-raise)
245 1. The startEpochMicrosec value for the Fault event is the
246 timestamp for when the fault onset occurs. Subsequent
247 events for the same fault will keep the same startEpochMicrosec
250 2. lastEpochMicrosec indicates the current event time. This value
251 will be updated for each subsequent event for a given fault.
253 3. The sequence number for each Fault event is set to 1 when the
254 fault is raised and increments each time the same
255 fault event is raised, until a clear is sent.
257 * After the fault is cleared, a new eventId is used.
259 .. image:: Use-Case-1.png
261 b. **Alternative Scenario**: Network Function When Fault Event Status is Not
264 * The sourceName on each Fault event is the NF Instance Name
265 (pnf-name or vnf-name or vm-name) as entered in A&AI uniquely
266 identifying this instance of the NF.
268 * The eventId on Fault events is the same every time a given
269 fault is raised or cleared, even if it is re-raised after it
270 had previously cleared. So, for example, if EMS loses
271 contact with a particular device then a Fault event might be
272 sent for a raise, re-raise (because EMS has re-tried and
273 still can’t contact the device), clear (because EMS has
274 re-tried and it can contact the device) and then raise again
275 (because EMS has lost contact with the device again). The
276 same eventId is used for all 4 of those Fault events.
278 * The startEpochMicrosec value for each Fault event is the
279 timestamp for when that event is generated, not when the
280 fault first occurred. So all 4 of the Fault events in the
281 previous bullet point would have a different timestamp.
283 * lastEpochMicrosec indicates the current event time.
285 * The sequence number for each Fault event is currently set to
286 0 on a raise and 1 on a clear. We could change that so that
287 each Fault event is given a new monotonically increasing
288 sequence number whether it is a raise or a clear if that is
289 helpful (which is reset to 0 if the VM restarts) but they
290 won’t be consecutive.
292 * Normally, a clear is expected for each fault to be sent from a
293 network function. However a few fault notification types will never
294 be re-raised or cleared. In this case, general rules for VES events
295 shall be followed with a new eventId for each event and sequence
298 .. image:: Use-Case-2.png
300 Measurement Expansion Fields
301 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
303 When expansion fields are used, the goal is to avoid custom development
304 by the service provider collecting the fields, since custom development
305 adds obvious cost, delay and resource overhead. In the domain of
306 measurements, it is expected that a high percentage (perhaps as high as
307 90 percent) of use cases for extensible fields can be satisfied by using
308 the additionalMeasurements arrayOfNamedHashMap data structure in
309 combination with a YAML registration file (provided at design time). The
310 YAML registration file conveys meta-information about the processing of
311 additionalMeasurements. For more information, please see the VES Event
312 Registration specification and in particular the aggregationRole, castTo
313 and isHomogeneous keywords.
318 Syslog’s can be classified as either Control or Session/Traffic. They
319 differ by message content and expected volume:
321 - Control logs are generally free-form human-readable text used for
322 reporting errors or warnings supporting the operation and
323 troubleshooting of NFs. The volume of these logs is typically less
326 - Session logs use common structured fields to report normal NF
327 processing such as DNS lookups or firewall rules processed. The
328 volume of these logs is typically greater than 1k per hour (and
329 sometimes as high as 10k per second).
331 VES supports both classes of syslog, however VES is only recommended for
332 control logs or for lower volume session logs, less than 60k per hour.
333 High volume session logging should use a file-based transport solution.
335 Support for Protocols Other Than HTTPS
336 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
338 This API specification describes an HTTPS RESTful interface using the
341 Alternative API specifications may be provided in future using Google
342 Protobuf, websockets, or Apache Avro.
344 Configuration Requirements
345 ~~~~~~~~~~~~~~~~~~~~~~~~~~
346 This section provides network function configuration requirements for
347 connectivity to a VES Event Listener via a RESTful API, using a VES JSON event.
349 There are several methods available to provide configuration settings to a
350 network function. This document does not specify the exact manner in which
351 the configuration elements described below must be required. The
352 configuration can be provided during instantiation (e.g. preload), provided by
353 an ONAP controller action, or provided manually.
355 * **VES Event Listener IP Addresses or FQDNs resolved via DNS**: Two FQDNs
356 and/or IP Addresses are required. NF shall select one of the 2 FQDNs/IP
357 Addresses for sending events and if the NF is unable to get an
358 acknowledgement within predefined configurable time interval
359 or unable to establish a TCP connection due inability to resolve DNS query or
360 if the VES Event Listener is unresponsive, then the NF shall attempt to use
361 the other FQDN/IP Address to connect to VES Event Listener to deliver the
362 VES Events. The events shall only be sent to one VES Event Listener at a time.
363 Please note: If a FQDN is used, the DNS query would return a single IP
365 * A single VES Event Listener may handle more than one type of VES event
366 (different domains); i.e. same VES Event Listener can receive and process
367 heartbeat, fault, measurement, syslog, etc. events.
368 * **VES Credentials**: If the NF is using Basic Authentication, then the NF
369 must support the provisioning of security and authentication parameters
370 (HTTP username and password) in order to be able to authenticate with the
371 VES Event Listener. The Username and Password should be set unique per NF
372 instance and should be configured during the NF deployment through a
373 Controller or other means. The same password must also be configured into VES
374 Event Listener instance for successful handshake.
375 * **VES Heartbeat Interval**: This must be a configurable parameter; current
376 default is 60 seconds. Note: the heartbeat interval should be greater than
377 the ack timeout value.
378 * **Measurement Interval**: For measurement events, the measurement interval
379 must be configurable and a default of 300 seconds.
380 * **ACK Timeout Interval**: Configurable, default 5 seconds.
382 Event Domain Requirements/Expectations
383 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
385 * **Heartbeat**: Heartbeat events must be sent to VES Event Listener based on
386 configurable parameter.
387 * **Faults**: Fault events must be sent to the VES Event Listener as soon as
389 * **Measurements**: All measurement events must be sent at the configured
390 measurementInterval. If the NF provides both application and GuestOS
391 metrics, then they must both use the same measurementInterval.
392 * **Syslogs**: Syslog events should be sent to the VES Event Listener as soon as
393 created, unless the NF is in debug mode (verbose logging enabled to get
394 additional data to diagnose a problem), in which case the syslogs must be
395 stored locally in the NF, for later access and possible secure transfer.
396 * **Pre-defined Events Formats (Domain: Mobile Flow, TCA, State Chang, etc)**:
397 Other events (State change, TCA, Mobile Flow, etc) may use other pre-defined
398 VES domains from the VES Common Event Format specification based on the role
400 * **otherFields**: The otherFields Record defines fields for events belonging
401 to the otherFields domain of the Technology Independent domain enumeration.
402 This record provides a mechanism to convey a complex set of fields
403 and is purely intended to address miscellaneous needs such as addressing
404 time-to-market considerations or other proof-of-concept evaluations. Hence,
405 use of this record type is discouraged and should be minimized.
407 Use of Collector FQDNs and/or IP Address
408 ++++++++++++++++++++++++++++++++++++++++
410 * The NF must support two configurable endpoints for the VES Event Listener.
411 One will be the active, primary event listener endpoint. The other
412 will be a standby event listener in the event the active endpoint is
414 * When sending an event (FM, PM, Syslog, HB), the NF shall establish an HTTPS
415 connection to one VES Event Listener FQDN/IP Address (if not already
416 established) and send a VES event to it. Note that connections are not
417 persistent. The events shall only be sent to only one VES Event Listener at a
419 * The NF must be able to detect that a VES Event Listener endpoint is
420 unavailable, and trigger the fail-over to the backup endpoint. The mechanism
421 for detecting unavailability must be configurable by the Service Operator
422 (e.g. number of attempts, timeout value).
423 * If the NF is sending events to the VES Event Listener backup endpoint, then
424 the NF must poll the primary endpoint on a configurable interval to check
425 if the primary endpoint is now available. The NF may use the Heartbeat
426 event or another mechanism to test availability. If the primary endpoint
427 becomes available, then the NF must fallback to the primary endpoint.
428 * A NF must only send a unique event to a single VES Event Listener endpoint
429 at a time. In other words, the NF must not send a duplicate event to the
430 secondary endpoint unless the delivery to the primary endpoint failed.
431 * If both Primary and Secondary endpoints are not available, then the NF shall
432 buffer the events locally. Refer to the Buffering of Events section for full
434 * If a NF is unable to establish a connection with a VES Event Listener or does
435 not get an acknowledgement within a specified time, then it should log this
436 failure and, optionally, send a fault event indicating
437 connection/acknowledgement failure via the alternate FQDN/IP Address. The
438 intent of this fault is to inform the Service Operator that the VES Event
439 Listener endpoint has become unreachable by the NF.
445 Three types of version numbers supported by this specification:
447 - The API specification itself is versioned. Going forward, the major
448 number of the specification version will be incremented whenever any
449 change could break an existing client (e.g., a field name is deleted
450 or changed). All other changes to the spec (e.g., a field name is
451 added, or text changes are made to the specification itself) will
452 increment only the minor number or patch number. Note that the major
453 number appears in REST resource URLs as v# (where ‘#’ is the major
454 number). Minor and patch numbers are communicated in HTTP headers.
455 For more information, see the API Versioning writeup in section 6.1.
457 - The JSON schema is versioned. Going forward, the major number of the
458 JSON schema will be incremented whenever any change could break an
459 existing client (e.g., a field name is deleted or changed). All other
460 changes to the schema (e.g., a field name is added or text changes
461 are made to the field descriptions) will increment only the minor
462 number or patch number.
464 - The field blocks are versioned. Field blocks include the
465 commonEventHeader and the domain blocks (e.g., the faultFields
466 block). Going forward, the major number of each field block will be
467 incremented whenever any change to that block could break an existing
468 client (e.g., a field name is deleted or changed). All other changes
469 to that block (e.g., a field name is added or text changes are made
470 to the field descriptions) will increment only the minor number.
473 +++++++++++++++++++++
475 A summary of the latest field block version enums as of this version of
476 the API spec is provided below:
478 - commonEventHeader version 4.1 (note: the enum with support 4.0,
479 4.0.1, 4.1 to avoid breaking clients of earlier versions of major
482 - commonEventHeader vesEventListenerVersion enum: 7.1 (note: the enum
483 will support 7.0, 7.0.1, 7.1 to avoid breaking clients of earlier
484 versions of major version 7)
486 - faultFieldsVersion:4.0
488 - heartbeatFieldsVersion: 3.0
490 - measurementFieldsVersion: 4.0
492 - mobileFlowFieldsVersion: 4.0
494 - notificationFieldsVersion: 2.0
496 - otherFieldsVersion: 3.0
498 - perf3gppFieldsVersion: 1.0
500 - pnfRegistrationFieldsVersion: 2.0
502 - sigSignalingFieldsVersion: 3.0
504 - stateChangeFieldsVersion: 4.0
506 - syslogFieldsVersion: 4.0
508 - thresholdCrossingFieldsVersion: 4.0
510 - voiceQualityFieldsVersion: 4.0
515 Event sources must identify themselves to the VES Event Listener.
517 There are 2 methods of HTTP authentication supported: Certificate Authentication
518 and Basic Authentication.
520 Basic authentication is supported in VES Event Listener for backward
521 compatibility for existing NFs that are already managed by ONAP. New NFs should
522 support Certificate Authentication. Because the security is better, NFs may
523 choose to only support Certificate Authentication and not support Basic
529 When using Basic Authentication, the event source must not pass credentials on
530 the query string. Credentials must be sent in an Authorization header as
533 1. The username and password are formed into one string as
534 ``username:password``
535 2. The resulting string is Base64 encoded to produce the encoded credential.
536 3. The encoded credential is communicated in the header after the string
537 ``Authorization: Basic``
539 Because the credentials are merely encoded but not encrypted, HTTPS (rather
540 than HTTP) should be used. HTTPS will also encrypt and protect event contents.
542 Sample Request and Response
543 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
550 POST /eventListener/v7 HTTP/1.1
551 Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
552 content-type: application/json
553 content-length: 12345
556 "commonEventHeader": {
558 "vesEventListenerVersion": "7.1.1",
559 "domain": "heartbeat",
560 "eventName": "Heartbeat_vIsbcMmc",
561 "eventId": "heartbeat0000249",
563 "priority": "Normal",
564 "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234",
565 "reportingEntityName": "ibcx0001vm002oam001",
566 "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014",
567 "sourceName": "ibcx0001vm002ssc001",
568 "nfVendorName": "Ericsson",
569 "nfNamingCode": "ibcx",
570 "nfcNamingCode": "ssc",
571 "startEpochMicrosec": 1413378172000000,
572 "lastEpochMicrosec": 1413378172000000,
573 "timeZoneOffset": "UTC-05:30"
579 Sample Success Response
580 ++++++++++++++++++++++++
584 HTTPS/1.1 202 Accepted
590 Mutual TLS Certificate Authentication
591 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
593 When using Certificate Authentication, the event source must initialize the
594 HTTPS connection with TLS 1.2 or higher and execute mutual authentication
595 procedures according to `RFC5246 <https://tools.ietf.org/html/rfc5246#section-7.4.6>`__.
596 The event source must authenticate the VES Listener certificate and must
597 provide its own X.509v3 end-entity certificate to the VES Listener for
598 authentication. The Subject Name in the end-entity certificate must be used
599 according to `RFC5280 <https://www.ietf.org/rfc/rfc5280.txt>`__. If a
600 certificate is provided by the NF but it is invalid, the VES Listener is
601 expected to reject the connection and not fall back to basic authentication.
606 REST resources are defined with respect to a ServerRoot:
608 ServerRoot = https://{Domain|IP}:{Port}/{optionalRoutingPath}
610 The resource structure is provided below:
612 .. figure:: rest-resource.png
613 :alt: REST Resource Structure
615 REST Resource Structure
617 The {Port} above is typically 8443.
622 A JSON schema describing the Common Event Format is provided below and
623 is reproduced in the tables that follow.
625 :download:`JSON <CommonEventFormat_30.1.1_ONAP.json>`
628 Note on optional fields:
630 If the event publisher collects a field that is identified as
631 optional in the data structures below, then the event publisher
632 *must* send that field.
634 Note on extensible fields:
636 VES contains various extensible structures (e.g., hashMap) that
637 enable event publishers to send information that has not been
638 explicitly defined in VES data structures.
640 - Event publishers *must not* send information through extensible
641 structures where VES has explicitly defined fields for that
642 information. For example, event publishers *must not* send
643 information like cpuIdle, through an extensible structure, because
644 VES has explicitly defined a cpuUsage.cpuIdle field for the
645 communication of that information.
647 - Keys sent through extensible fields must use camel casing to separate
648 words and acronyms; only the first letter of each acronym shall be
651 Common Event Datatypes
652 ~~~~~~~~~~~~~~~~~~~~~~~~
654 Datatype: arrayOfJsonObject
655 ++++++++++++++++++++++++++++
657 The arrayOfJsonObject datatype provides an array of json objects, each
658 of which is describ ed by name, schema and other meta-information. It
659 consists of the following fields:
661 +---------------------+------------------+----------+----------------------+
662 | Field | Type | Required?| Description |
663 +=====================+==================+==========+======================+
664 | arrayOfJsonObject | jsonObject [ ] | Yes | Array of jsonObject |
665 +---------------------+------------------+----------+----------------------+
667 Datatype: arrayOfNamedHashMap
668 ++++++++++++++++++++++++++++++
670 The arrayOfNamedHashMap datatype provides an array of hashMaps, each of
671 which is associated with a descriptive name. It consists of the
674 +---------------------+------------------+-----------+-----------------------+
675 | Field | Type | Required? | Description |
676 +=====================+==================+===========+=======================+
677 | arrayOfNamedHashMap | namedHashMap [ ] | Yes | Array of namedHashMap |
678 +---------------------+------------------+-----------+-----------------------+
683 The event datatype consists of the following fields which constitute the
684 ‘root level’ of the common event format:
686 +--------------+--------------+-----------+-----------------------------------+
687 | Field | Type | Required? | Description |
688 +==============+==============+===========+===================================+
689 | commonEvent\ | commonEvent\ | Yes | Fields common to all events |
690 | Header | Header | | |
691 +--------------+--------------+-----------+-----------------------------------+
692 | faultFields | faultFields | No | Fields specific to fault events |
693 +--------------+--------------+-----------+-----------------------------------+
694 | heartbeat\ | heartbeat\ | No | Fields specific to heartbeat |
695 | Fields | Fields | | events |
696 +--------------+--------------+-----------+-----------------------------------+
697 | measurement\ | measurement\ | No | Fields specific to measurement |
698 | Fields | Fields | | events |
699 +--------------+--------------+-----------+-----------------------------------+
700 | mobileFlow\ | mobileFlow\ | No | Fields specific to mobility flow |
701 | Fields | Fields | | events |
702 +--------------+--------------+-----------+-----------------------------------+
703 | notification\| notification\| No | Fields specific to notification |
704 | Fields | Fields | | events |
705 +--------------+--------------+-----------+-----------------------------------+
706 | otherFields | otherFields | No | Fields specific to other types of |
708 +--------------+--------------+-----------+-----------------------------------+
709 | perf3gpp\ | perf3gpp\ | No | Fields specific to perf3gpp |
710 | Fields | Fields | | events |
711 +--------------+--------------+-----------+-----------------------------------+
712 | pnf\ | pnf\ | No | Fields specific to pnfRegistration|
713 | Registration\| Registration\| | events |
714 | Fields | Fields | | |
715 +--------------+--------------+-----------+-----------------------------------+
716 | sipSignaling\| sipSignaling\| No | Fields specific to sipSignaling |
717 | Fields | Fields | | events |
718 +--------------+--------------+-----------+-----------------------------------+
719 | stateChange\ | stateChange\ | No | Fields specific to state change |
720 | Fields | Fields | | events |
721 +--------------+--------------+-----------+-----------------------------------+
722 | syslogFields | syslogFields | No | Fields specific to syslog events |
723 +--------------+--------------+-----------+-----------------------------------+
724 | threshold\ | threshold\ | No | Fields specific to threshold |
725 | Crossing\ | Crossing\ | | crossing alert events |
726 | AlertFields | AlertFields | | |
727 +--------------+--------------+-----------+-----------------------------------+
728 | voiceQuality\| voiceQuality\| No | Fields specific to voiceQuality |
729 | Fields | Fields | | events |
730 +--------------+--------------+-----------+-----------------------------------+
735 The eventList datatype consists of the following fields:
737 +-------------+-------------+----------+-------------------+
738 | Field | Type | Required?| Description |
739 +=============+=============+==========+===================+
740 | eventList | event [ ] | Yes | Array of events |
741 +-------------+-------------+----------+-------------------+
746 The hashMap datatype is an ‘associative array’, which is an unordered
747 collection of key-value pairs of the form "key": "value", where each key
748 and value are strings. Keys must use camel casing to separate words and
749 acronyms; only the first letter of each acronym shall be capitalized.
754 The jsonObject datatype provides a json object schema, name and other
755 meta-information along with one or more object instances that conform to
758 +--------------+--------------+-----------+----------------------------------+
759 | Field | Type | Required? | Description |
760 +==============+==============+===========+==================================+
761 | object\ | JsonObject\ | Yes | Contains one or more instances of|
762 | Instances | Instance [ ] | | the json object |
763 +--------------+--------------+-----------+----------------------------------+
764 | objectName | string | Yes | Name of the json object |
765 +--------------+--------------+-----------+----------------------------------+
766 | objectSchema | string | No | json schema for the object |
767 +--------------+--------------+-----------+----------------------------------+
768 | objectSchema\| string | No | URL to the json schema for the |
770 +--------------+--------------+-----------+----------------------------------+
771 | nfSubscribed\| string | No | Name of the object associated |
772 | ObjectName | | | with the nfSubscriptionId |
773 +--------------+--------------+-----------+----------------------------------+
774 | nf\ | string | No | Identifies an openConfig |
775 | Subscription\| | | telemetry subscription on a |
776 | Id | | | network function, which |
777 | | | | configures the network function |
778 | | | | to send complex object data |
779 | | | | associated with the jsonObject |
780 +--------------+--------------+-----------+----------------------------------+
782 Datatype: jsonObjectInstance
783 +++++++++++++++++++++++++++++
785 The jsonObjectInstance datatype provides meta-information about an
786 instance of a jsonObject along with the actual object instance:
788 +----------------+------------+----------+-----------------------------------+
789 | Field | Type | Required?| Description |
790 +================+============+==========+===================================+
791 | jsonObject | jsonObject | No | Optional recursive specification |
792 | | | | of jsonObject |
793 +----------------+------------+----------+-----------------------------------+
794 | objectInstance | object | No | Contains an instance conforming to|
795 | | | | the jsonObject schema |
796 +----------------+------------+----------+-----------------------------------+
797 | objectInstance\| number | No | the unix time, aka epoch time, |
798 | EpochMicrosec | | | associated with this |
799 | | | | objectInstance--as microseconds |
800 | | | | elapsed since 1 Jan 1970 not |
801 | | | | including leap seconds |
802 +----------------+------------+----------+-----------------------------------+
803 | objectKeys | key [ ] | No | An ordered set of keys that |
804 | | | | identifies this particular |
805 | | | | instance of jsonObject (e.g., that|
806 | | | | places it in a hierarchy) |
807 +----------------+------------+----------+-----------------------------------+
812 The key datatype is a tuple which provides the name of a key along with
813 its value and relative order; it consists of the following fields:
815 +----------+---------+-----------+-------------------------------------------+
816 | Field | Type | Required? | Description |
817 +==========+=========+===========+===========================================+
818 | keyName | string | Yes | Name of the key |
819 +----------+---------+-----------+-------------------------------------------+
820 | keyOrder | Integer | No | Relative sequence or order of the key |
821 | | | | (with respect to other keys) |
822 +----------+---------+-----------+-------------------------------------------+
823 | keyValue | string | No | Value of the key |
824 +----------+---------+-----------+-------------------------------------------+
826 Datatype: namedHashMap
827 ++++++++++++++++++++++++
829 The namedHashMap datatype is a hashMap which is associated with and
830 described by a name; it consists of the following fields:
832 +---------+---------+-----------+--------------------------------------------+
833 | Field | Type | Required? | Description |
834 +=========+=========+===========+============================================+
835 | name | string | Yes | Name associated with or describing the |
837 +---------+---------+-----------+--------------------------------------------+
838 | hashMap | hashMap | Yes | One or more key:value pairs |
839 +---------+---------+-----------+--------------------------------------------+
841 Datatype: requestError
842 +++++++++++++++++++++++
844 The requestError datatype defines the standard request error data
847 +-----------+--------+-----------+-------------------------------------------+
848 | Field | Type | Required? | Description |
849 +===========+========+===========+===========================================+
850 | messageId | string | Yes | Unique message identifier of the format |
851 | | | | ‘ABCnnnn’ where ‘ABC’ is either ‘SVC’ for |
852 | | | | Service Exceptions or ‘POL’ for Policy |
853 | | | | Exception. Exception numbers may be in the|
854 | | | | range of 0001 to 9999 where 0001 to 2999 |
855 | | | | are defined by OMA (see section 5.1) and |
856 | | | | 3000-9999 are available and undefined. |
857 +-----------+--------+-----------+-------------------------------------------+
858 | text | string | Yes | Message text, with replacement variables |
859 | | | | marked with %n, where n is an index into |
860 | | | | the list of <variables> elements, starting|
862 +-----------+--------+-----------+-------------------------------------------+
863 | url | string | No | Hyperlink to a detailed error resource |
864 | | | | e.g., an HTML page for browser user agents|
865 +-----------+--------+-----------+-------------------------------------------+
866 | variables | string | No | List of zero or more strings that |
867 | | | | represent the contents of the variables |
868 | | | | used by the message text |
869 +-----------+--------+-----------+-------------------------------------------+
871 Datatype: vendorNfNameFields
872 +++++++++++++++++++++++++++++
874 The vendorNfNameFields provides vendor, nf and nfModule identifying
877 +--------------+--------+-----------+----------------------------------------+
878 | Field | Type | Required? | Description |
879 +==============+========+===========+========================================+
880 | vendorName | string | Yes | Network function vendor name |
881 +--------------+--------+-----------+----------------------------------------+
882 | nfModuleName | string | No | Name of the nfModule generating the |
884 +--------------+--------+-----------+----------------------------------------+
885 | nfName | string | No | Name of the network function generating|
887 +--------------+--------+-----------+----------------------------------------+
889 Common Event Header Data Types
890 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
892 Datatype: commonEventHeader
893 ++++++++++++++++++++++++++++
895 The commonEventHeader datatype consists of the following fields common
898 +-----------+----------+-----------+-----------------------------------------+
899 | Field | Type | Required? | Description |
900 +===========+==========+===========+=========================================+
901 | domain | string | Yes | Event domain enumeration: ‘fault’, |
902 | | | | ‘heartbeat’, ‘measurement’, ‘mobileFlow’|
903 | | | | , ‘notification’, ‘other’, ‘perf3gpp’, |
904 | | | | ‘pnfRegistration’, ‘sipSignaling’, |
905 | | | | ‘stateChange’, ‘syslog’, |
906 | | | | ‘thresholdCrossingAlert’, ‘voiceQuality’|
907 +-----------+----------+-----------+-----------------------------------------+
908 | eventId | string | Yes | Event key that is unique to the event |
909 | | | | source. The key must be unique within |
910 | | | | notification life cycle similar to |
911 | | | | EventID from 3GPP. It could be a |
912 | | | | sequential number, or a composite key |
913 | | | | formed from the event fields, such as |
914 | | | | domain\_sequence. The eventId should not|
915 | | | | include whitespace. For fault events, |
916 | | | | eventId is the eventId of the initial |
917 | | | | alarm; if the same alarm is raised again|
918 | | | | for changed, acknowledged or cleared |
919 | | | | cases, eventId must be the same as the |
920 | | | | initial alarm (along with the same |
921 | | | | startEpochMicrosec but with a different |
922 | | | | sequence number). Note: see section 1.3 |
923 | | | | for eventId use case examples. |
924 +-----------+----------+-----------+-----------------------------------------+
925 | eventName | string | Yes | |
926 +-----------+----------+-----------+-----------------------------------------+
927 | eventType | string | No | |
928 +-----------+----------+-----------+-----------------------------------------+
929 | internal\ | internal\| No | Fields (not supplied by event sources) |
930 | Header | Header | | that the VES Event Listener service can |
931 | Fields | Fields | | use to enrich the event if needed for |
932 | | | | efficient internal processing. This is |
933 | | | | an empty object which is intended to be |
934 | | | | defined separately by each service |
935 | | | | provider (e.g., AT&T) implementing the |
936 | | | | VES Event Listener. |
937 +-----------+----------+-----------+-----------------------------------------+
938 | lastEpoch\| number | Yes | the latest unix time aka epoch time |
939 | Microsec | | | associated with the event from any |
940 | | | | component--as microseconds elapsed since|
941 | | | | 1 Jan 1970 not including leap seconds |
942 +-----------+----------+-----------+-----------------------------------------+
943 | nfcNaming\| string | No | Network function component type: 3 |
944 | Code | | | characters (aligned with vfc naming |
946 +-----------+----------+-----------+-----------------------------------------+
947 | nfNaming\ | string | No | Network function type: 4 characters |
948 | Code | | | (aligned with vnf and pnf naming |
950 +-----------+----------+-----------+-----------------------------------------+
951 | nfVendor\ | string | No | |
953 +-----------+----------+-----------+-----------------------------------------+
954 | priority | string | Yes | |
955 +-----------+----------+-----------+-----------------------------------------+
956 | reporting\| string | No | UUID identifying the entity reporting |
957 | EntityId | | | the event or detecting a problem in |
958 | | | | another vnf/vm or pnf which is |
959 | | | | experiencing the problem. (Note: the |
960 | | | | AT&T internal enrichment process shall |
961 | | | | ensure that this field is populated). |
962 | | | | The reportingEntityId is an id for the |
963 | | | | reportingEntityName. See |
964 | | | | ‘reportingEntityName’ for more |
965 | | | | information. |
966 +-----------+----------+-----------+-----------------------------------------+
967 | reporting\| string | Yes | Name of the entity reporting the event |
968 | EntityName| | | or detecting a problem in another vnf/vm|
969 | | | | or pnf which is experiencing the |
970 | | | | problem. May be the same as the |
971 | | | | sourceName. For synthetic events |
972 | | | | generated by DCAE, it is the name of the|
973 | | | | app generating the event. |
974 +-----------+----------+-----------+-----------------------------------------+
975 | sequence | integer | Yes | Ordering of events communicated by an |
976 | | | | event source instance (or 0 if not |
978 +-----------+----------+-----------+-----------------------------------------+
979 | sourceId | string | No | UUID identifying the entity experiencing|
980 | | | | the event issue, which may be detected |
981 | | | | and reported by a separate reporting |
982 | | | | entity (note: the AT&T internal |
983 | | | | enrichment process shall ensure that |
984 | | | | this field is populated). The sourceId |
985 | | | | is an id for the sourceName. See |
986 | | | | ‘sourceName’ for more information. |
987 +-----------+----------+-----------+-----------------------------------------+
988 | sourceName| string | Yes | Name of the entity experiencing the |
989 | | | | event issue, which may be detected and |
990 | | | | reported by a separate reporting entity.|
991 | | | | The sourceName identifies the device for|
992 | | | | which data is collected. A valid |
993 | | | | sourceName must be inventoried in A&AI. |
994 | | | | If sourceName is a xNF (vnf or pnf), |
995 | | | | xNFC or VM, then the event must be |
996 | | | | reporting data for that particular xNF, |
997 | | | | xNFC or VM. If the sourceName is a xNF, |
998 | | | | comprised of multiple xNFCs, the data |
999 | | | | must be reported/aggregated at the xNF |
1000 | | | | level. Data for individual xNFC must not|
1001 | | | | be included in the xNF sourceName event.|
1002 +-----------+----------+-----------+-----------------------------------------+
1003 | start\ | number | Yes | the earliest unix time aka epoch time |
1004 | Epoch\ | | | associated with the event from any |
1005 | Microsec | | | component--as microseconds elapsed since|
1006 | | | | 1 Jan 1970 not including leap seconds. |
1007 | | | | For measurements and heartbeats, where |
1008 | | | | events are collected over predefined |
1009 | | | | intervals, startEpochMicrosec shall be |
1010 | | | | rounded to the nearest interval boundary|
1011 | | | | (e.g., the epoch equivalent of 3:00PM, |
1012 | | | | 3:10PM, 3:20PM, etc…). For fault events,|
1013 | | | | startEpochMicrosec is the timestamp of |
1014 | | | | the initial alarm; if the same alarm is |
1015 | | | | raised again for changed, acknowledged |
1016 | | | | or cleared cases, startEpoch Microsec |
1017 | | | | must be the same as the initial alarm |
1018 | | | | (along with the same eventId and an |
1019 | | | | incremental sequence number). For |
1020 | | | | devices with no timing source (clock), |
1021 | | | | the default value will be 0 and the VES |
1022 | | | | collector will replace it with Collector|
1023 | | | | time stamp (when the event is received) |
1024 +-----------+----------+-----------+-----------------------------------------+
1025 | timeZone\ | string | No | Offset to GMT to indicate local time |
1026 | Offset | | | zone for device formatted as |
1027 | | | | ‘UTC+/-hh:mm’; see |
1028 | | | | time_zone_abbreviations_ for UTC offset |
1030 +-----------+----------+-----------+-----------------------------------------+
1031 | version | string | Yes | Version of the event header as "#.#" |
1032 | | | | where # is a digit; see section 1 for |
1033 | | | | the correct digits to use. |
1034 +-----------+----------+-----------+-----------------------------------------+
1035 | vesEvent\ | string | Yes | Version of the ves event listener api |
1036 | Listener\ | | | spec that this event is compliant with |
1037 | Version | | | (as "#" or "#.#" or "#.#.#" where # is a|
1038 | | | | digit; see section 1 for the correct |
1039 | | | | digits to use). |
1040 +-----------+----------+-----------+-----------------------------------------+
1042 Datatype: internalHeaderFields
1043 ++++++++++++++++++++++++++++++
1045 The internalHeaderFields datatype is an undefined object which can
1046 contain arbitrarily complex JSON structures. It is intended to be
1047 defined separately by each service provider (e.g., AT&T) implementing
1048 the VES Event Listener. The fields in internalHeaderFields are not
1049 provided by any event source but instead are added by the VES Event
1050 Listener service itself as part of an event enrichment process necessary
1051 for efficient internal processing of events received by the VES Event
1054 Technology Independent Datatypes
1055 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1057 ‘Fault’ Domain Datatypes
1058 +++++++++++++++++++++++++
1060 Datatype: faultFields
1061 *********************
1063 The faultFields datatype consists of the following fields:
1065 +-----------------+---------+-----------+-------------------------------------+
1066 | Field | Type | Required? | Description |
1067 +=================+=========+===========+=====================================+
1068 | alarmAdditional | hashMap | No | Additional alarm information. |
1069 | Information | | | |
1071 | | | | - Note1: for SNMP mapping to VES, |
1072 | | | | for hash key use OID of varbind, |
1073 | | | | for value use incoming data for |
1074 | | | | that varbind). |
1076 | | | | - Note2: Alarm ID for 3GPP should be|
1077 | | | | included (if applicable) in |
1078 | | | | alarmAdditonalInformation as |
1079 | | | | ‘alarmId’:’alarmIdValue’. |
1081 | | | | Could contain managed object |
1082 | | | | instance as separate key:value; |
1083 | | | | could add probable cause as separate|
1084 | | | | key:value. |
1085 +-----------------+---------+-----------+-------------------------------------+
1086 | alarmCondition | string | Yes | Short name of the alarm |
1087 | | | | condition/problem, such as a trap |
1088 | | | | name. Should not have white space |
1089 | | | | (e.g., tpLgCgiNotInConfig, |
1090 | | | | BfdSessionDown, linkDown, etc…) |
1091 +-----------------+---------+-----------+-------------------------------------+
1092 | alarmInterfaceA | string | No | Card, port, channel or interface |
1093 | | | | name of the device generating the |
1094 | | | | alarm. This could reflect managed |
1096 +-----------------+---------+-----------+-------------------------------------+
1097 | eventCategory | string | No | Event category, for example: |
1098 | | | | ‘license’, ‘link’, ‘routing’, |
1099 | | | | ‘security’, ‘signaling’ |
1100 +-----------------+---------+-----------+-------------------------------------+
1101 | eventSeverity | string | Yes | Event severity enumeration: |
1102 | | | | ‘CRITICAL’, ‘MAJOR’, ‘MINOR’, |
1103 | | | | ‘WARNING’, ‘NORMAL’. NORMAL is used |
1104 | | | | to represent clear. |
1105 +-----------------+---------+-----------+-------------------------------------+
1106 | eventSourceType | string | Yes | Examples: ‘card’, ‘host’, ‘other’, |
1107 | | | | ‘port’, ‘portThreshold’, ‘router’, |
1108 | | | | ‘slotThreshold’, ‘switch’, |
1109 | | | | ‘virtualMachine’, |
1110 | | | | ‘virtualNetworkFunction’. This could|
1111 | | | | be managed object class. |
1112 +-----------------+---------+-----------+-------------------------------------+
1113 | faultFields\ | string | Yes | Version of the faultFields block as |
1114 | Version | | | "#.#" where # is a digit; see |
1115 | | | | section 1 for the correct digits to |
1117 +-----------------+---------+-----------+-------------------------------------+
1118 | specificProblem | string | Yes | Description of the alarm or problem |
1119 | | | | (e.g., ‘eNodeB 155197 in PLMN |
1120 | | | | 310-410 with eNodeB name KYL05197 is|
1121 | | | | lost’). 3GPP probable cause would be|
1122 | | | | included in this field. |
1123 +-----------------+---------+-----------+-------------------------------------+
1124 | vfStatus | string | Yes | Virtual function status enumeration:|
1125 | | | | ‘Active’, ‘Idle’, ‘Preparing to |
1126 | | | | terminate’, ‘Ready to terminate’, |
1127 | | | | ‘Requesting Termination’ |
1128 +-----------------+---------+-----------+-------------------------------------+
1130 Heartbeat’ Domain Datatypes
1131 ++++++++++++++++++++++++++++
1133 Datatype: heartbeatFields
1134 *************************
1136 The heartbeatFields datatype is an optional field block for fields
1137 specific to heartbeat events; it consists of the following fields:
1139 +---------------+---------+-----------+---------------------------------------+
1140 | Field | Type | Required? | Description |
1141 +===============+=========+===========+=======================================+
1142 | additional\ | hashMap | No | Additional expansion fields if needed |
1144 +---------------+---------+-----------+---------------------------------------+
1145 | heartbeat\ | string | Yes | Version of the heartbeatFields block |
1146 | FieldsVersion | | | as "#.#" where # is a digit; see |
1147 | | | | section 1 for the correct digits to |
1149 +---------------+---------+-----------+---------------------------------------+
1150 | heartbeat\ | Integer | Yes | Current heartbeatInterval in seconds |
1152 +---------------+---------+-----------+---------------------------------------+
1154 ‘Measurements’ Domain Datatypes
1155 ++++++++++++++++++++++++++++++++
1157 Note: NFs are required to report exactly one Measurement event per
1158 period per sourceName.
1160 Datatype: codecsInUse
1161 *********************
1163 The codecsInUse datatype consists of the following fields describing the
1164 number of times an identified codec was used over the
1165 measurementInterval:
1167 +------------------+-----------+----------+--------------------------------+
1168 | Field | Type | Required?| Description |
1169 +==================+===========+==========+================================+
1170 | codecIdentifer | string | Yes | Description of the codec |
1171 +------------------+-----------+----------+--------------------------------+
1172 | numberInUse | integer | Yes | Number of such codecs in use |
1173 +------------------+-----------+----------+--------------------------------+
1178 The cpuUsage datatype defines the usage of an identifier CPU and
1179 consists of the following fields:
1181 +------------+--------+-----------+-------------------------------------------+
1182 | Field | Type | Required? | Description |
1183 +============+========+===========+===========================================+
1184 | cpu\ | number | No | The amount of time the CPU cannot run due |
1185 | Capacity\ | | | to contention, in milliseconds over the |
1186 | Contention | | | measurementInterval |
1187 +------------+--------+-----------+-------------------------------------------+
1188 | cpu\ | number | No | The total CPU time that the NF/NFC/VM |
1189 | Demand\ | | | could use if there was no contention, in |
1190 | Avg | | | milliseconds over the measurementInterval |
1191 +------------+--------+-----------+-------------------------------------------+
1192 | cpu\ | number | No | CPU demand in MHz |
1195 +------------+--------+-----------+-------------------------------------------+
1196 | cpu\ | number | No | CPU demand as a percentage of the |
1197 | Demand\ | | | provisioned capacity |
1199 +------------+--------+-----------+-------------------------------------------+
1200 | cpu\ | string | Yes | CPU Identifier |
1201 | Identifier | | | |
1202 +------------+--------+-----------+-------------------------------------------+
1203 | cpu\ | number | No | Percentage of CPU time spent in the idle |
1205 +------------+--------+-----------+-------------------------------------------+
1206 | cpu\ | number | No | Percentage of time the VM is unable to run|
1207 | Latency\ | | | because it is contending for access to the|
1208 | Avg | | | physical CPUs |
1209 +------------+--------+-----------+-------------------------------------------+
1210 | cpu\ | number | No | The overhead demand above available |
1211 | Overhead\ | | | allocations and reservations, in |
1212 | Avg | | | milliseconds over the measurementInterval |
1213 +------------+--------+-----------+-------------------------------------------+
1214 | cpuSwap\ | number | No | Swap wait time, in milliseconds over the |
1215 | WaitTime | | | measurementInterval |
1216 +------------+--------+-----------+-------------------------------------------+
1217 | cpuUsage\ | number | No | Percentage of time spent servicing |
1218 | Interrupt | | | interrupts |
1219 +------------+--------+-----------+-------------------------------------------+
1220 | cpuUsage\ | number | No | Percentage of time spent running user |
1221 | Nice | | | space processes that have been niced |
1222 +------------+--------+-----------+-------------------------------------------+
1223 | cpuUsage\ | number | No | Percentage of time spent handling soft irq|
1224 | SoftIrq | | | interrupts |
1225 +------------+--------+-----------+-------------------------------------------+
1226 | cpuUsage\ | number | No | Percentage of time spent in involuntary |
1227 | Steal | | | wait which is neither user, system or idle|
1228 | | | | time and is effectively time that went |
1230 +------------+--------+-----------+-------------------------------------------+
1231 | cpuUsage\ | number | No | Percentage of time spent on system tasks |
1232 | System | | | running the kernel |
1233 +------------+--------+-----------+-------------------------------------------+
1234 | cpuUsage\ | number | No | Percentage of time spent running un-niced |
1235 | User | | | user space processes |
1236 +------------+--------+-----------+-------------------------------------------+
1237 | cpuWait | number | No | Percentage of CPU time spent waiting for |
1238 | | | | I/O operations to complete |
1239 +------------+--------+-----------+-------------------------------------------+
1240 | percent\ | number | Yes | Aggregate cpu usage of the virtual machine|
1241 | Usage | | | on which the xNFC reporting the event is |
1243 +------------+--------+-----------+-------------------------------------------+
1246 ********************
1248 The diskUsage datatype defines the usage of a disk and consists of the
1251 +-------------+-------+----------+--------------------------------------------+
1252 | Field | Type | Required?| Description |
1253 +=============+=======+==========+============================================+
1254 | diskBus\ | number| No | Number of bus resets over the |
1255 | Resets | | | measurementInterval |
1256 +-------------+-------+----------+--------------------------------------------+
1257 | disk\ | number| No | Number of disk commands aborted over the |
1258 | Commands\ | | | measurementInterval |
1260 +-------------+-------+----------+--------------------------------------------+
1261 | disk\ | number| No | Average number of commands per second over |
1262 | CommandsAvg | | | the measurementInterval |
1263 +-------------+-------+----------+--------------------------------------------+
1264 | diskFlush\ | number| No | Total flush requests of the disk cache over|
1265 | Requests | | | the measurementInterval |
1266 +-------------+-------+----------+--------------------------------------------+
1267 | diskFlush\ | number| No | Milliseconds spent on disk cache flushing |
1268 | Time | | | over the measurementInterval |
1269 +-------------+-------+----------+--------------------------------------------+
1270 | disk\ | string| Yes | Disk Identifier |
1271 | Identifier | | | |
1272 +-------------+-------+----------+--------------------------------------------+
1273 | diskIo\ | number| No | Milliseconds spent doing input/output |
1274 | TimeAvg | | | operations over 1 sec; treat this metric as|
1275 | | | | a device load percentage where 1000ms |
1276 | | | | matches 100% load; provide the average over|
1277 | | | | the measurement interval |
1278 +-------------+-------+----------+--------------------------------------------+
1279 | diskIoTime\ | number| No | Milliseconds spent doing input/output |
1280 | Last | | | operations over 1 sec; treat this metric as|
1281 | | | | a device load percentage where 1000ms |
1282 | | | | matches 100% load; provide the last value |
1283 | | | | measurement within the measurement interval|
1284 +-------------+-------+----------+--------------------------------------------+
1285 | diskIo\ | number| No | Milliseconds spent doing input/output |
1286 | TimeMax | | | operations over 1 sec; treat this metric as|
1287 | | | | a device load percentage where 1000ms |
1288 | | | | matches 100% load; provide the maximum |
1289 | | | | value measurement within the measurement |
1291 +-------------+-------+----------+--------------------------------------------+
1292 | diskIo\ | number| No | Milliseconds spent doing input/output |
1293 | TimeMin | | | operations over 1 sec; treat this metric as|
1294 | | | | a device load percentage where 1000ms |
1295 | | | | matches 100% load; provide the minimum |
1296 | | | | value measurement within the measurement |
1298 +-------------+-------+----------+--------------------------------------------+
1299 | diskMerged\ | number| No | Number of logical read operations that were|
1300 | ReadAvg | | | merged into physical read operations, e.g.,|
1301 | | | | two logical reads were served by one |
1302 | | | | physical disk access; provide the average |
1303 | | | | measurement within the measurement interval|
1304 +-------------+-------+----------+--------------------------------------------+
1305 | diskMerged\ | number| No | Number of logical read operations that were|
1306 | ReadLast | | | merged into physical read operations, e.g.,|
1307 | | | | two logical reads were served by one |
1308 | | | | physical disk access; provide the last |
1309 | | | | value measurement within the measurement |
1311 +-------------+-------+----------+--------------------------------------------+
1312 | diskMerged\ | number| No | Number of logical read operations that were|
1313 | ReadMax | | | merged into physical read operations, e.g.,|
1314 | | | | two logical reads were served by one |
1315 | | | | physical disk access; provide the maximum |
1316 | | | | value measurement within the measurement |
1318 +-------------+-------+----------+--------------------------------------------+
1319 | diskMerged\ | number| No | Number of logical read operations that were|
1320 | ReadMin | | | merged into physical read operations, e.g.,|
1321 | | | | two logical reads were served by one |
1322 | | | | physical disk access; provide the minimum |
1323 | | | | value measurement within the measurement |
1325 +-------------+-------+----------+--------------------------------------------+
1326 | diskMerged\ | number| No | Number of logical write operations that |
1327 | WriteAvg | | | were merged into physical write operations,|
1328 | | | | e.g., two logical writes were served by one|
1329 | | | | physical disk access; provide the average |
1330 | | | | measurement within the measurement interval|
1331 +-------------+-------+----------+--------------------------------------------+
1332 | diskMerged\ | number| No | Number of logical write operations that |
1333 | WriteLast | | | were merged into physical write operations,|
1334 | | | | e.g., two logical writes were served by one|
1335 | | | | physical disk access; provide the last |
1336 | | | | value measurement within the measurement |
1338 +-------------+-------+----------+--------------------------------------------+
1339 | diskMerged\ | number| No | Number of logical write operations that |
1340 | WriteMax | | | were merged into physical write operations,|
1341 | | | | e.g., two logical writes were served by one|
1342 | | | | physical disk access; provide the maximum |
1343 | | | | value measurement within the measurement |
1345 +-------------+-------+----------+--------------------------------------------+
1346 | diskMerged\ | number| No | Number of logical write operations that |
1347 | WriteMin | | | were merged into physical write operations,|
1348 | | | | e.g., two logical writes were served by one|
1349 | | | | physical disk access; provide the minimum |
1350 | | | | value measurement within the measurement |
1352 +-------------+-------+----------+--------------------------------------------+
1353 | diskOctets\ | number| No | Number of octets per second read from a |
1354 | Read Avg | | | disk or partition; provide the average |
1355 | | | | measurement within the measurement interval|
1356 +-------------+-------+----------+--------------------------------------------+
1357 | diskOctets\ | number| No | Number of octets per second read from a |
1358 | Read | | | disk or partition; provide the last |
1359 | | | | measurement within the measurement interval|
1361 +-------------+-------+----------+--------------------------------------------+
1362 | diskOctets\ | number| No | Number of octets per second read from a |
1363 | Read Max | | | disk or partition; provide the maximum |
1364 | | | | measurement within the measurement interval|
1365 +-------------+-------+----------+--------------------------------------------+
1366 | diskOctets\ | number| No | Number of octets per second read from a |
1367 | Read Min | | | disk or partition; provide the minimum |
1368 | | | | measurement within the measurement interval|
1369 +-------------+-------+----------+--------------------------------------------+
1370 | diskOctets\ | number| No | Number of octets per second written to a |
1371 | Write Avg | | | disk or partition; provide the average |
1372 | | | | measurement within the measurement interval|
1373 +-------------+-------+----------+--------------------------------------------+
1374 | diskOctets\ | number| No | Number of octets per second written to a |
1375 | Write Last | | | disk or partition; provide the last |
1376 | | | | measurement within the measurement interval|
1377 +-------------+-------+----------+--------------------------------------------+
1378 | diskOctets\ | number| No | Number of octets per second written to a |
1379 | WriteMax | | | disk or partition; provide the maximum |
1380 | | | | measurement within the measurement interval|
1381 +-------------+-------+----------+--------------------------------------------+
1382 | diskOctets\ | number| No | Number of octets per second written to a |
1383 | WriteMin | | | disk or partition; provide the minimum |
1384 | | | | measurement within the measurement interval|
1385 +-------------+-------+----------+--------------------------------------------+
1386 | diskOps\ | number| No | Number of read operations per second issued|
1387 | ReadAvg | | | to the disk; provide the average |
1388 | | | | measurement within the measurement interval|
1389 +-------------+-------+----------+--------------------------------------------+
1390 | diskOps\ | number| No | Number of read operations per second issued|
1391 | ReadLast | | | to the disk; provide the last measurement |
1392 | | | | within the measurement interval |
1393 +-------------+-------+----------+--------------------------------------------+
1394 | diskOps\ | number| No | Number of read operations per second issued|
1395 | ReadMax | | | to the disk; provide the maximum |
1396 | | | | measurement within the measurement interval|
1397 +-------------+-------+----------+--------------------------------------------+
1398 | diskOps\ | number| No | Number of read operations per second issued|
1399 | ReadMin | | | to the disk; provide the minimum |
1400 | | | | measurement within the measurement interval|
1401 +-------------+-------+----------+--------------------------------------------+
1402 | diskOps\ | number| No | Number of write operations per second |
1403 | WriteAvg | | | issued to the disk; provide the average |
1404 | | | | measurement within the measurement interval|
1405 +-------------+-------+----------+--------------------------------------------+
1406 | diskOps\ | number| No | Number of write operations per second |
1407 | WriteLast | | | issued to the disk; provide the last |
1408 | | | | measurement within the measurement interval|
1409 +-------------+-------+----------+--------------------------------------------+
1410 | diskOps\ | number| No | Number of write operations per second |
1411 | Write Max | | | issued to the disk; provide the maximum |
1412 | | | | measurement within the measurement interval|
1413 +-------------+-------+----------+--------------------------------------------+
1414 | diskOps\ | number| No | Number of write operations per second |
1415 | WriteMin | | | issued to the disk; provide the minimum |
1416 | | | | measurement within the measurement interval|
1417 +-------------+-------+----------+--------------------------------------------+
1418 | diskPending\| number| No | Queue size of pending I/O operations per |
1419 | Operations\ | | | second; provide the average measurement |
1420 | Avg | | | within the measurement interval |
1421 +-------------+-------+----------+--------------------------------------------+
1422 | diskPending\| number| No | Queue size of pending I/O operations per |
1423 | Operations\ | | | second; provide the last measurement within|
1424 | Last | | | the measurement interval |
1425 +-------------+-------+----------+--------------------------------------------+
1426 | diskPending\| number| No | Queue size of pending I/O operations per |
1427 | Operations\ | | | second; provide the maximum measurement |
1428 | Max | | | within the measurement interval |
1429 +-------------+-------+----------+--------------------------------------------+
1430 | diskPending\| number| No | Queue size of pending I/O operations per |
1431 | Operations\ | | | second; provide the minimum measurement |
1432 | Min | | | within the measurement interval |
1433 +-------------+-------+----------+--------------------------------------------+
1434 | diskRead\ | number| No | Average number of read commands issued per |
1435 | CommandsAvg | | | second to the disk over the |
1436 | | | | measurementInterval |
1437 +-------------+-------+----------+--------------------------------------------+
1438 | diskTime | number| No | Nanoseconds spent on disk cache |
1439 | | | | reads/writes within the measurement |
1441 +-------------+-------+----------+--------------------------------------------+
1442 | diskTime\ | number| No | Milliseconds a read operation took to |
1443 | ReadAvg | | | complete; provide the average measurement |
1444 | | | | within the measurement interval |
1445 +-------------+-------+----------+--------------------------------------------+
1446 | diskTime\ | number| No | Milliseconds a read operation took to |
1447 | Read Last | | | complete; provide the last measurement |
1448 | | | | within the measurement interval |
1449 +-------------+-------+----------+--------------------------------------------+
1450 | diskTime\ | number| No | Milliseconds a read operation took to |
1451 | Read Max | | | complete; provide the maximum measurement |
1452 | | | | within the measurement interval |
1453 +-------------+-------+----------+--------------------------------------------+
1454 | diskTime\ | number| No | Milliseconds a read operation took to |
1455 | Read Min | | | complete; provide the minimum measurement |
1456 | | | | within the measurement interval |
1457 +-------------+-------+----------+--------------------------------------------+
1458 | diskTime\ | number| No | Milliseconds a write operation took to |
1459 | Write Avg | | | complete; provide the average measurement |
1460 | | | | within the measurement interval |
1461 +-------------+-------+----------+--------------------------------------------+
1462 | diskTime\ | number| No | Milliseconds a write operation took to |
1463 | Write Last | | | complete; provide the last measurement |
1464 | | | | within the measurement interval |
1465 +-------------+-------+----------+--------------------------------------------+
1466 | diskTime\ | number| No | Milliseconds a write operation took to |
1467 | Write Max | | | complete; provide the maximum measurement |
1468 | | | | within the measurement interval |
1469 +-------------+-------+----------+--------------------------------------------+
1470 | diskTime\ | number| No | Milliseconds a write operation took to |
1471 | Write Min | | | complete; provide the minimum measurement |
1472 | | | | within the measurement interval |
1473 +-------------+-------+----------+--------------------------------------------+
1474 | diskTotal\ | number| No | Average read time from the perspective of a|
1475 | ReadLatency\| | | Guest OS: sum of the Kernel Read Latency |
1476 | Avg | | | and Physical Device Read Latency in |
1477 | | | | milliseconds over the measurement interval |
1478 +-------------+-------+----------+--------------------------------------------+
1479 | diskTotal\ | number| No | Average write time from the perspective of |
1480 | Write\ | | | a Guest OS: sum of the Kernel Write Latency|
1481 | LatencyAvg | | | and Physical Device Write Latency in |
1482 | | | | milliseconds over the measurement interval |
1483 +-------------+-------+----------+--------------------------------------------+
1484 | disk\ | number| No | Measure in ms over 1 sec of both I/O |
1485 | WeightedIo\ | | | completion time and the backlog that may be|
1486 | TimeAvg | | | accumulating. Value is the average within |
1487 | | | | the collection interval. |
1488 +-------------+-------+----------+--------------------------------------------+
1489 | disk\ | number| No | Measure in ms over 1 sec of both I/O |
1490 | WeightedIo\ | | | completion time and the backlog that may be|
1491 | TimeLast | | | accumulating. Value is the last within the |
1492 | | | | collection interval. |
1493 +-------------+-------+----------+--------------------------------------------+
1494 | disk\ | number| No | Measure in ms over 1 sec of both I/O |
1495 | WeightedIo\ | | | completion time and the backlog that may be|
1496 | TimeMax | | | accumulating. Value is the maximum within |
1497 | | | | the collection interval. |
1498 +-------------+-------+----------+--------------------------------------------+
1499 | disk\ | number| No | Measure in ms over 1 sec of both I/O |
1500 | WeightedIo\ | | | completion time and the backlog that may be|
1501 | TimeMin | | | accumulating. Value is the minimum within |
1502 | | | | the collection interval. |
1503 +-------------+-------+----------+--------------------------------------------+
1504 | diskWrite\ | number| No | Average number of write commands issued per|
1505 | CommandsAvg | | | second to the disk over the |
1506 | | | | measurementInterval |
1507 +-------------+-------+----------+--------------------------------------------+
1509 Datatype: filesystemUsage
1510 ***************************
1512 The filesystemUsage datatype consists of the following fields:
1514 +-------------+--------+-----------+------------------------------------------+
1515 | Field | Type | Required? | Description |
1516 +=============+========+===========+==========================================+
1517 | filesystem\ | string | Yes | File system name |
1519 +-------------+--------+-----------+------------------------------------------+
1520 | block\ | number | Yes | Configured block storage capacity in GB |
1521 | Configured | | | |
1522 +-------------+--------+-----------+------------------------------------------+
1523 | blockIops | number | Yes | Block storage input-output operations per|
1525 +-------------+--------+-----------+------------------------------------------+
1526 | blockUsed | number | Yes | Used block storage capacity in GB |
1527 +-------------+--------+-----------+------------------------------------------+
1528 | ephemeral\ | number | Yes | Configured ephemeral storage capacity in |
1529 | Configured | | | GB |
1530 +-------------+--------+-----------+------------------------------------------+
1531 | ephemeral\ | number | Yes | Ephemeral storage input-output operations|
1532 | Iops | | | per second |
1533 +-------------+--------+-----------+------------------------------------------+
1534 | ephemeral\ | number | Yes | Used ephemeral storage capacity in GB |
1536 +-------------+--------+-----------+------------------------------------------+
1539 ********************
1541 The hugePages datatype provides metrics on system hugePages; it consists
1542 of the following fields:
1544 +--------------------+--------+----------+------------------------------------+
1545 | Field | Type | Required?| Description |
1546 +====================+========+==========+====================================+
1547 | bytesFree | number | No | Number of free hugePages in bytes |
1548 +--------------------+--------+----------+------------------------------------+
1549 | bytesUsed | number | No | Number of used hugePages in bytes |
1550 +--------------------+--------+----------+------------------------------------+
1551 | hugePagesIdentifier| string | Yes | HugePages identifier |
1552 +--------------------+--------+----------+------------------------------------+
1553 | percentFree | number | No | Number of free hugePages in percent|
1554 +--------------------+--------+----------+------------------------------------+
1555 | percentUsed | number | No | Number of used hugePages in percent|
1556 +--------------------+--------+----------+------------------------------------+
1557 | vmPageNumberFree | number | No | Number of free vmPages in numbers |
1558 +--------------------+--------+----------+------------------------------------+
1559 | vmPageNumberUsed | number | No | Number of used vmPages in numbers |
1560 +--------------------+--------+----------+------------------------------------+
1562 Datatype: ipmi (Intelligent Platform Management Interface)
1563 ***********************************************************
1565 The ipmi datatype provides intelligent platform management interface
1566 metrics; it consists of the following fields:
1568 +-------------+---------------------+-----------+-----------------------------+
1569 | Field | Type | Required? | Description |
1570 +=============+=====================+===========+=============================+
1571 | exitAir\ | number | No | System fan exit air flow |
1572 | Temperature | | | temperature in Celsius |
1573 +-------------+---------------------+-----------+-----------------------------+
1574 | frontPanel\ | number | No | Front panel temp in Celsius |
1575 | Temperature | | | |
1576 +-------------+---------------------+-----------+-----------------------------+
1577 | ioModule\ | number | No | Io module temp in Celsius |
1578 | Temperature | | | |
1579 +-------------+---------------------+-----------+-----------------------------+
1580 | ipmi\ | ipmiBaseboard | No | Array of ipmiBaseboard |
1581 | Baseboard\ | Temperature [ ] | | Temperature objects |
1582 | Temperature\| | | |
1584 +-------------+---------------------+-----------+-----------------------------+
1585 | ipmi\ | ipmiBaseboard | No | Array of ipmiBaseboard |
1586 | Baseboard\ | VoltageRegulator [ ]| | VoltageRegulator objects |
1590 +-------------+---------------------+-----------+-----------------------------+
1591 | ipmiBattery\| ipmiBattery [ ] | No | Array of ipmiBattery objects|
1593 +-------------+---------------------+-----------+-----------------------------+
1594 | ipmiFanArray| ipmiFan [ ] | No | Array of ipmiFan objects |
1595 +-------------+---------------------+-----------+-----------------------------+
1596 | ipmiGlobal\ | ipmiGlobalAggregate\| No | ipmi global aggregate |
1597 | Aggregate\ | TemperatureMargin []| | temperature margin |
1598 | Temperature\| | | |
1599 | MarginArray | | | |
1600 +-------------+---------------------+-----------+-----------------------------+
1601 | ipmiHsbp\ | ipmiHsbp [ ] | No | Array of ipmiHsbp objects |
1603 +-------------+---------------------+-----------+-----------------------------+
1604 | ipmiNicArray| ipmiNic [ ] | No | Array of ipmiNic objects |
1605 +-------------+---------------------+-----------+-----------------------------+
1606 | ipmiPower\ | ipmiPowerSupply [ ] | No | Array of ipmiPowerSupply |
1607 | SupplyArray | | | objects |
1608 +-------------+---------------------+-----------+-----------------------------+
1609 | ipmi\ | ipmiProcessor [ ] | No | Array of ipmiProcessor |
1610 | Processor\ | | | objects |
1612 +-------------+---------------------+-----------+-----------------------------+
1613 | system\ | number | No | Airflow in cubic feet per |
1614 | Airflow | | | minute (cfm) |
1615 +-------------+---------------------+-----------+-----------------------------+
1617 Datatype: ipmiBaseboardTemperature
1618 ************************************
1620 The ipmiBaseboardTemperature datatype consists of the following fields
1621 which describe ipmi baseboard temperature metrics:
1623 +-------------+--------+-----------+------------------------------------------+
1624 | Field | Type | Required? | Description |
1625 +=============+========+===========+==========================================+
1626 | baseboard\ | number | No | Baseboard temperature in celsius |
1627 | Temperature | | | |
1628 +-------------+--------+-----------+------------------------------------------+
1629 | baseboard\ | string | Yes | Identifier for the location where the |
1630 | Temperature\| | | temperature is taken |
1631 | Identifier | | | |
1632 +-------------+--------+-----------+------------------------------------------+
1634 Datatype: ipmiBaseboardVoltageRegulator
1635 *****************************************
1637 The ipmiBaseboardVoltageRegulator datatype consists of the following
1638 fields which describe ipmi baseboard voltage regulator metrics:
1640 +--------------------+-------+----------+-------------------------------------+
1641 | Field | Type | Required?| Description |
1642 +====================+=======+==========+=====================================+
1643 | baseboardVoltage\ | string| Yes | Identifier for the baseboard voltage|
1644 | RegulatorIdentifier| | | regulator |
1645 +--------------------+-------+----------+-------------------------------------+
1646 | voltageRegulator\ | number| No | Voltage regulator temperature in |
1647 | Temperature | | | celsius |
1648 +--------------------+-------+----------+-------------------------------------+
1650 Datatype: ipmiBattery
1651 **********************
1653 The ipmiBattery datatype consists of the following fields which describe
1654 ipmi battery metrics:
1656 +---------------------+--------+----------+------------------------------+
1657 | Field | Type | Required?| Description |
1658 +=====================+========+==========+==============================+
1659 | batteryIdentifier | string | Yes | Identifier for the battery |
1660 +---------------------+--------+----------+------------------------------+
1661 | batteryType | string | No | Type of battery |
1662 +---------------------+--------+----------+------------------------------+
1663 | batteryVoltageLevel | number | No | Battery voltage level |
1664 +---------------------+--------+----------+------------------------------+
1667 ********************
1669 The ipmiFan datatype consists of the following fields which describe
1672 +--------------+-------+----------+-------------------------------------------+
1673 | Field | Type | Required?| Description |
1674 +==============+=======+==========+===========================================+
1675 | fanIdentifier| string| Yes | Identifier for the fan |
1676 +--------------+-------+----------+-------------------------------------------+
1677 | fanSpeed | number| No | Fan speed in revolutions per minute (rpm) |
1678 +--------------+-------+----------+-------------------------------------------+
1680 Datatype: ipmiGlobalAggregateTemperatureMargin
1681 ***********************************************
1683 The ipmiGlobalAggregateTemperatureMargin datatype consists of the
1686 +-------------+-------+----------+--------------------------------------------+
1687 | Field | Type | Required?| Description |
1688 +=============+=======+==========+============================================+
1689 | global\ | number| No | Temperature margin in Celsius relative to a|
1690 | Aggregate\ | | | throttling thermal trip point |
1691 | Temperature\| | | |
1693 +-------------+-------+----------+--------------------------------------------+
1694 | global\ | string| Yes | Identifier for the ipmi global aggregate |
1695 | Aggregate\ | | | temperature margin metrics |
1696 | Temperature\| | | |
1698 | Identifier | | | |
1699 +-------------+-------+----------+--------------------------------------------+
1704 The ipmiHsbp datatype provides ipmi hot swap backplane power metrics; it
1705 consists of the following fields:
1707 +------------+-------+----------+---------------------------------------------+
1708 | Field | Type | Required?| Description |
1709 +============+=======+==========+=============================================+
1710 | hsbp\ | string| Yes | Identifier for the hot swap backplane power |
1711 | Identifier | | | unit |
1712 +------------+-------+----------+---------------------------------------------+
1713 | hsbp\ | number| No | Hot swap backplane power temperature in |
1714 | Temperature| | | celsius |
1715 +------------+-------+----------+---------------------------------------------+
1720 The ipmiNic datatype provides network interface control care metrics; it
1721 consists of the following fields:
1723 +------------+-------+----------+---------------------------------------------+
1724 | Field | Type | Required?| Description |
1725 +============+=======+==========+=============================================+
1726 | nic\ | string| Yes | Identifier for the network interface control|
1727 | Identifier | | | card |
1728 +------------+-------+----------+---------------------------------------------+
1729 | nic\ | number| No | nic temperature in Celsius |
1730 | Temperature| | | |
1731 +------------+-------+----------+---------------------------------------------+
1733 Datatype: ipmiPowerSupply
1734 **************************
1736 The ipmiPowerSupply datatype provides ipmi power supply metrics; it
1737 consists of the following fields:
1739 +-----------+-------+----------+----------------------------------------------+
1740 |Field | Type | Required?| Description |
1741 +===========+=======+==========+==============================================+
1742 |power\ | number| No | Current output voltage as a percentage of the|
1743 |Supply\ | | | design specified level |
1747 +-----------+-------+----------+----------------------------------------------+
1748 |power\ | string| Yes | Identifier for the power supply |
1751 +-----------+-------+----------+----------------------------------------------+
1752 |power\ | number| No | Input power in watts |
1756 +-----------+-------+----------+----------------------------------------------+
1757 |power\ | number| No | Power supply temperature in Celsius |
1760 +-----------+-------+----------+----------------------------------------------+
1762 Datatype: ipmiProcessor
1763 ************************
1765 The ipmiProcessor datatype provides ipmi processor metrics; it consists
1766 of the following fields:
1768 +------------+------------------+-----------+---------------------------------+
1769 | Field | Type | Required? | Description |
1770 +============+==================+===========+=================================+
1771 | processor\ | processorDimm | No | Array of processorDimmAggregate |
1772 | Dimm\ | AggregateThermal | | ThermalMargin objects |
1773 | Aggregate\ | Margin [ ] | | |
1775 | MarginArray| | | |
1776 +------------+------------------+-----------+---------------------------------+
1777 | processor\ | number | No | Front panel temperature in |
1778 | DtsThermal\| | | celsius |
1780 +------------+------------------+-----------+---------------------------------+
1781 | processor\ | string | Yes | Identifier for the power supply |
1782 | Identifier | | | |
1783 +------------+------------------+-----------+---------------------------------+
1784 | processor\ | number | No | Io module temperatue in celsius |
1788 +------------+------------------+-----------+---------------------------------+
1790 Datatype: latencyBucketMeasure
1791 *******************************
1793 The latencyBucketMeasure datatype consists of the following fields which
1794 describe the number of counts falling within a defined latency bucket:
1796 +-----------+-------+----------+----------------------------------------------+
1797 | Field | Type | Required?| Description |
1798 +===========+=======+==========+==============================================+
1799 | counts\ | number| Yes | Number of counts falling within a defined |
1800 | InThe\ | | | latency bucket |
1802 +-----------+-------+----------+----------------------------------------------+
1803 | highEnd\ | number| No | High end of bucket range (typically in ms) |
1806 +-----------+-------+----------+----------------------------------------------+
1807 | lowEndOf\ | number| No | Low end of bucket range (typically in ms) |
1810 +-----------+-------+----------+----------------------------------------------+
1815 The load datatype provides metrics on system cpu and io utilization
1816 obtained using /proc/loadavg; it consists of the following fields:
1818 +----------+-------+----------+-----------------------------------------------+
1819 | Field | Type | Required?| Description |
1820 +==========+=======+==========+===============================================+
1821 | longTerm | number| No | number of jobs in the run queue (state R, cpu |
1822 | | | | utilization) or waiting for disk I/O (state D,|
1823 | | | | io utilization) averaged over 15 minutes using|
1824 | | | | /proc/loadavg |
1825 +----------+-------+----------+-----------------------------------------------+
1826 | midTerm | number| No | number of jobs in the run queue (state R, cpu |
1827 | | | | utilization) or waiting for disk I/O (state D,|
1828 | | | | io utilization) averaged over 5 minutes using |
1829 | | | | /proc/loadavg |
1830 +----------+-------+----------+-----------------------------------------------+
1831 | shortTerm| number| No | number of jobs in the run queue (state R, cpu |
1832 | | | | utilization) or waiting for disk I/O (state D,|
1833 | | | | io utilization) averaged over 1 minute using |
1834 | | | | /proc/loadavg |
1835 +----------+-------+----------+-----------------------------------------------+
1837 Datatype: machineCheckException
1838 ********************************
1840 The machineCheckException datatype describes machine check exceptions;
1841 it consists of the following fields:
1843 +-------------+-------+----------+--------------------------------------------+
1844 | Field | Type | Required?| Description |
1845 +=============+=======+==========+============================================+
1846 | corrected\ | number| No | Total hardware errors that were corrected |
1847 | Memory\ | | | by the hardware (e.g. data corruption |
1848 | Errors | | | corrected via ECC) over the |
1849 | | | | measurementInterval. These errors do not |
1850 | | | | require immediate software actions, but are|
1851 | | | | still reported for accounting and |
1852 | | | | predictive failure analysis |
1853 +-------------+-------+----------+--------------------------------------------+
1854 | corrected\ | number| No | Total hardware errors that were corrected |
1855 | Memory\ | | | by the hardware over the last one hour |
1858 +-------------+-------+----------+--------------------------------------------+
1859 | uncorrected\| number| No | Total uncorrected hardware errors that were|
1860 | Memory\ | | | detected by the hardware (e.g., causing |
1861 | Errors | | | data corruption) over the |
1862 | | | | measurementInterval. These errors require a|
1863 | | | | software response. |
1864 +-------------+-------+----------+--------------------------------------------+
1865 | uncorrected\| number| No | Total uncorrected hardware errors that were|
1866 | Memory\ | | | detected by the hardware over the last one |
1867 | Errors | | | hour |
1869 +-------------+-------+----------+--------------------------------------------+
1870 | vm\ | string| Yes | Virtual machine identifier associated with |
1871 | Identifier | | | the machine check exception |
1872 +-------------+-------+----------+--------------------------------------------+
1874 Datatype: measurementFields
1875 ****************************
1877 The measurementFields datatype consists of the following fields:
1879 +-------------+--------------+----------+-------------------------------------+
1880 | Field | Type | Required?| Description |
1881 +=============+==============+==========+=====================================+
1882 | additional\ | hashMap | No | Additional measurement fields if |
1883 | Fields | | | needed |
1884 +-------------+--------------+----------+-------------------------------------+
1885 | additional\ | arrayOfNamed\| No | Array of named hashMap if needed |
1886 | Measurements| HashMap | | |
1887 +-------------+--------------+----------+-------------------------------------+
1888 | additional\ | arrayOf\ | No | Array of JSON objects described by |
1889 | Objects | JsonObject | | name, schema and other |
1890 | | | | meta-information, if needed |
1891 +-------------+--------------+----------+-------------------------------------+
1892 | codec\ | codecs\ | No | Array of codecs in use |
1893 | Usage\ | InUse [] | | |
1895 +-------------+--------------+----------+-------------------------------------+
1896 | concurrent\ | integer | No | Peak concurrent sessions for the VM |
1897 | Sessions | | | or xNF (depending on the context) |
1898 | | | | over the measurementInterval |
1899 +-------------+--------------+----------+-------------------------------------+
1900 | configured\ | integer | No | Depending on the context over the |
1901 | Entities | | | measurementInterval: peak total |
1902 | | | | number of users, subscribers, |
1903 | | | | devices, adjacencies, etc., for the |
1904 | | | | VM, or peak total number of |
1905 | | | | subscribers, devices, etc., for the |
1907 +-------------+--------------+----------+-------------------------------------+
1908 | cpuUsage\ | cpuUsage [] | No | Usage of an array of CPUs |
1910 +-------------+--------------+----------+-------------------------------------+
1911 | diskUsage\ | diskUsage [] | No | Usage of an array of disks |
1913 +-------------+--------------+----------+-------------------------------------+
1914 | feature\ | hashMap | No | The hashMap key should identify the |
1915 | UsageArray | | | feature, while the value defines the|
1916 | | | | number of times the identified |
1917 | | | | feature was used |
1918 +-------------+--------------+----------+-------------------------------------+
1919 | filesystem\ | filesystem\ | No | Filesystem usage of the VM on which |
1920 | UsageArray | Usage [ ] | | the xNFC reporting the event is |
1922 +-------------+--------------+----------+-------------------------------------+
1923 | hugePages\ | hugePages [ ]| No | Array of metrics on hugePages |
1925 +-------------+--------------+----------+-------------------------------------+
1926 | ipmi | ipmi | No | Intelligent platform management |
1927 | | | | interface metrics |
1928 +-------------+--------------+----------+-------------------------------------+
1929 | latency\ | latency\ | No | Array of integers representing |
1930 | Distribution| Bucket\ | | counts of requests whose latency in |
1931 | | Measure [ ] | | milliseconds falls within per-xNF |
1932 | | | | configured ranges; where latency is |
1933 | | | | the duration between a service |
1934 | | | | request and its fulfillment. |
1935 +-------------+--------------+----------+-------------------------------------+
1936 | loadArray | load [ ] | No | Array of system load metrics |
1937 +-------------+--------------+----------+-------------------------------------+
1938 | machine\ | machine\ | No | Array of machine check exceptions |
1939 | Check\ | Check\ | | |
1940 | Exception\ | Exception [ ]| | |
1942 +-------------+--------------+----------+-------------------------------------+
1943 | mean\ | number | No | Mean seconds required to respond to |
1944 | Request\ | | | each request for the VM on which the|
1945 | Latency | | | xNFC reporting the event is running |
1946 +-------------+--------------+----------+-------------------------------------+
1947 | measurement\| string | Yes | Version of the measurementFields |
1948 | Fields\ | | | block as "#.#" where # is a digit; |
1949 | Version | | | see section 1 for the correct digits|
1951 +-------------+--------------+----------+-------------------------------------+
1952 | measurement\| number | Yes | Interval over which measurements are|
1953 | Interval | | | being reported in seconds |
1954 +-------------+--------------+----------+-------------------------------------+
1955 | memoryUsage\| memory\ | No | Memory usage of an array of VMs |
1956 | Array | Usage [] | | |
1957 +-------------+--------------+----------+-------------------------------------+
1958 | nfcScaling\ | integer | No | Represents busy-ness of the network |
1959 | Metric | | | function from 0 to 100 as reported |
1960 | | | | by the nfc |
1961 +-------------+--------------+----------+-------------------------------------+
1962 | nic\ | nic\ | No | Performance metrics of an array of |
1963 | Performance\| Performance | | network interface cards |
1965 +-------------+--------------+----------+-------------------------------------+
1966 | numberOf\ | integer | No | Number of media ports in use |
1967 | MediaPorts\ | | | |
1969 +-------------+--------------+----------+-------------------------------------+
1970 | process\ | process\ | No | Array of metrics on system processes|
1971 | StatsArray | Stats [ ] | | |
1972 +-------------+--------------+----------+-------------------------------------+
1973 | request\ | number | No | Peak rate of service requests per |
1974 | Rate | | | second to the xNF over the |
1975 | | | | measurementInterval |
1976 +-------------+--------------+----------+-------------------------------------+
1978 Datatype: memoryUsage
1979 **********************
1981 The memoryUsage datatype defines the memory usage of a virtual machine
1982 and consists of the following fields:
1984 +-----------+-------+----------+----------------------------------------------+
1985 | Field | Type | Required?| Description |
1986 +===========+=======+==========+==============================================+
1987 | memory\ | number| No | Kibibytes of temporary storage for raw disk |
1988 | Buffered | | | blocks |
1989 +-----------+-------+----------+----------------------------------------------+
1990 | memory\ | number| No | Kibibytes of memory used for cache |
1992 +-----------+-------+----------+----------------------------------------------+
1993 | memory\ | number| No | Kibibytes of memory configured in the virtual|
1994 | Configured| | | machine on which the xNFC reporting the event|
1995 | | | | is running |
1996 +-----------+-------+----------+----------------------------------------------+
1997 | memory\ | number| No | Host demand in kibibytes |
1999 +-----------+-------+----------+----------------------------------------------+
2000 | memory\ | number| Yes | Kibibytes of physical RAM left unused by the |
2001 | Free | | | system |
2002 +-----------+-------+----------+----------------------------------------------+
2003 | memory\ | number| No | Percentage of time the VM is waiting to |
2004 | Latency\ | | | access swapped or compressed memory |
2006 +-----------+-------+----------+----------------------------------------------+
2007 | memory\ | number| No | Shared memory in kilobytes |
2010 +-----------+-------+----------+----------------------------------------------+
2011 | memory\ | number| No | The part of the slab that can be reclaimed |
2012 | SlabRecl | | | such as caches measured in kibibytes |
2013 +-----------+-------+----------+----------------------------------------------+
2014 | memory\ | number| No | The part of the slab that cannot be reclaimed|
2015 | Slab\ | | | even when lacking memory measure in kibibytes|
2017 +-----------+-------+----------+----------------------------------------------+
2018 | memory\ | number| No | Amount of memory swapped-in from host cache |
2019 | SwapIn\ | | | in kibibytes |
2021 +-----------+-------+----------+----------------------------------------------+
2022 | memory\ | number| No | Rate at which memory is swapped from disk |
2023 | SwapIn\ | | | into active memory during the interval in |
2024 | RateAvg | | | kilobytes per second |
2025 +-----------+-------+----------+----------------------------------------------+
2026 | memory\ | number| No | Amount of memory swapped-out to host cache in|
2027 | SwapOut\ | | | kibibytes |
2029 +-----------+-------+----------+----------------------------------------------+
2030 | memory\ | number| No | Rate at which memory is being swapped from |
2031 | SwapOut\ | | | active memory to disk during the current |
2032 | RateAvg | | | interval in kilobytes per second |
2033 +-----------+-------+----------+----------------------------------------------+
2034 | memory\ | number| No | Space used for caching swapped pages in the |
2035 | Swap\ | | | host cache in kibibytes |
2037 +-----------+-------+----------+----------------------------------------------+
2038 | memory\ | number| Yes | Total memory minus the sum of free, buffered,|
2039 | Used | | | cached and slab memory measured in kibibytes |
2040 +-----------+-------+----------+----------------------------------------------+
2041 | percent\ | number| No | Percentage of memory usage; value = |
2042 | Memory\ | | | (memoryUsed / (memoryUsed + memoryFree) x 100|
2043 | Usage | | | if denomintor is nonzero, or 0, if otherwise.|
2044 +-----------+-------+----------+----------------------------------------------+
2045 | vm\ | string| Yes | Virtual Machine identifier associated with |
2046 | Identifier| | | the memory metrics |
2047 +-----------+-------+----------+----------------------------------------------+
2049 Datatype: nicPerformance
2050 *************************
2052 The nicPerformance datatype consists of the following fields which
2053 describe the performance and errors of an of an identified virtual
2054 network interface card:
2056 +----------------+-------+----------+-----------------------------------------+
2057 | Field | Type | Required?| Description |
2058 +================+=======+==========+=========================================+
2059 | administrative\| string| No | Administrative state: enum: ‘inService’,|
2060 | State | | | ‘outOfService’ |
2061 +----------------+-------+----------+-----------------------------------------+
2062 | nicIdentifier | string| Yes | Network interface card identifier |
2063 +----------------+-------+----------+-----------------------------------------+
2064 | operational\ | string| No | Operational state: enum: ‘inService’, |
2065 | State | | | ‘outOfService’ |
2066 +----------------+-------+----------+-----------------------------------------+
2067 | received\ | number| No | Cumulative count of broadcast packets |
2068 | Broadcast\ | | | received as read at the end of the |
2069 | Packets\ | | | measurement interval |
2070 | Accumulated | | | |
2071 +----------------+-------+----------+-----------------------------------------+
2072 | received\ | number| No | Count of broadcast packets received |
2073 | Broadcast\ | | | within the measurement interval |
2074 | PacketsDelta | | | |
2075 +----------------+-------+----------+-----------------------------------------+
2076 | received\ | number| No | Cumulative count of discarded packets |
2077 | Discarded\ | | | received as read at the end of the |
2078 | Packets\ | | | measurement interval |
2079 | Accumulated | | | |
2080 +----------------+-------+----------+-----------------------------------------+
2081 | received\ | number| No | Count of discarded packets received |
2082 | Discarded\ | | | within the measurement interval |
2083 | PacketsDelta | | | |
2084 +----------------+-------+----------+-----------------------------------------+
2085 | received\ | number| No | Cumulative count of error packets |
2086 | ErrorPackets\ | | | received as read at the end of the |
2087 | Accumulated | | | measurement interval |
2088 +----------------+-------+----------+-----------------------------------------+
2089 | receivedError\ | number| No | Count of error packets received within |
2090 | PacketsDelta | | | the measurement interval |
2091 +----------------+-------+----------+-----------------------------------------+
2092 | received\ | number| No | Cumulative count of multicast packets |
2093 | Multicast\ | | | received as read at the end of the |
2094 | Packets\ | | | measurement interval |
2095 | Accumulated | | | |
2096 +----------------+-------+----------+-----------------------------------------+
2097 | received\ | number| No | Count of multicast packets received |
2098 | Multicast\ | | | within the measurement interval |
2099 | PacketsDelta | | | |
2100 +----------------+-------+----------+-----------------------------------------+
2101 | received\ | number| No | Cumulative count of octets received as |
2102 | Octets\ | | | read at the end of the measurement |
2103 | Accumulated | | | interval |
2104 +----------------+-------+----------+-----------------------------------------+
2105 | received\ | number| No | Count of octets received within the |
2106 | OctetsDelta | | | measurement interval |
2107 +----------------+-------+----------+-----------------------------------------+
2108 | received\ | number| No | Percentage of discarded packets |
2109 | Percent\ | | | received; value = |
2110 | Discard | | | (receivedDiscardedPacketsDelta / |
2111 | | | | receivedTotalPacketsDelta) x 100, if |
2112 | | | | denominator is nonzero, or 0, if |
2113 | | | | otherwise. |
2114 +----------------+-------+----------+-----------------------------------------+
2115 | received\ | number| No | Percentage of error packets received; |
2116 | PercentError | | | value = (receivedErrorPacketsDelta / |
2117 | | | | receivedTotalPacketsDelta) x 100, if |
2118 | | | | denominator is nonzero, or 0, if |
2119 | | | | otherwise. |
2120 +----------------+-------+----------+-----------------------------------------+
2121 | receivedTotal\ | number| No | Cumulative count of all packets received|
2122 | Packets\ | | | as read at the end of the measurement |
2123 | Accumulated | | | interval |
2124 +----------------+-------+----------+-----------------------------------------+
2125 | receivedTotal\ | number| No | Count of all packets received within the|
2126 | PacketsDelta | | | measurement interval |
2127 +----------------+-------+----------+-----------------------------------------+
2128 | received\ | number| No | Cumulative count of unicast packets |
2129 | Unicast\ | | | received as read at the end of the |
2130 | Packets\ | | | measurement interval |
2131 | Accumulated | | | |
2132 +----------------+-------+----------+-----------------------------------------+
2133 | received\ | number| No | Count of unicast packets received within|
2134 | Unicast\ | | | the measurement interval |
2135 | PacketsDelta | | | |
2136 +----------------+-------+----------+-----------------------------------------+
2137 | received\ | number| No | Percentage of utilization received; |
2138 | Utilization | | | value = (receivedOctetsDelta / (speed x |
2139 | | | | (lastEpochMicrosec - startEpochMicrosec)|
2140 | | | | )) x 100, if denominator is nonzero, or |
2141 | | | | 0, if otherwise. |
2142 +----------------+-------+----------+-----------------------------------------+
2143 | speed | number| No | Speed configured in mbps. |
2144 +----------------+-------+----------+-----------------------------------------+
2145 | transmitted\ | number| No | Cumulative count of broadcast packets |
2146 | Broadcast\ | | | transmitted as read at the end of the |
2147 | Packets\ | | | measurement interval |
2148 | Accumulated | | | |
2149 +----------------+-------+----------+-----------------------------------------+
2150 | transmitted\ | number| No | Count of broadcast packets transmitted |
2151 | Broadcast\ | | | within the measurement interval |
2152 | PacketsDelta | | | |
2153 +----------------+-------+----------+-----------------------------------------+
2154 | transmitted\ | number| No | Cumulative count of discarded packets |
2155 | Discarded\ | | | transmitted as read at the end of the |
2156 | Packets\ | | | measurement interval |
2157 | Accumulated | | | |
2158 +----------------+-------+----------+-----------------------------------------+
2159 | transmitted\ | number| No | Count of discarded packets transmitted |
2160 | Discarded\ | | | within the measurement interval |
2161 | PacketsDelta | | | |
2162 +----------------+-------+----------+-----------------------------------------+
2163 | transmitted\ | number| No | Cumulative count of error packets |
2164 | ErrorPackets\ | | | transmitted as read at the end of the |
2165 | Accumulated | | | measurement interval |
2166 +----------------+-------+----------+-----------------------------------------+
2167 | transmitted\ | number| No | Count of error packets transmitted |
2168 | ErrorPackets\ | | | within the measurement interval |
2170 +----------------+-------+----------+-----------------------------------------+
2171 | transmitted\ | number| No | Cumulative count of multicast packets |
2172 | Multicast\ | | | transmitted as read at the end of the |
2173 | Packets\ | | | measurement interval |
2174 | Accumulated | | | |
2175 +----------------+-------+----------+-----------------------------------------+
2176 | transmitted\ | number| No | Count of multicast packets transmitted |
2177 | Multicast\ | | | within the measurement interval |
2178 | PacketsDelta | | | |
2179 +----------------+-------+----------+-----------------------------------------+
2180 | transmitted\ | number| No | Cumulative count of octets transmitted |
2181 | Octets\ | | | as read at the end of the measurement |
2182 | Accumulated | | | interval |
2183 +----------------+-------+----------+-----------------------------------------+
2184 | transmitted\ | number| No | Count of octets transmitted within the |
2185 | OctetsDelta | | | measurement interval |
2186 +----------------+-------+----------+-----------------------------------------+
2187 | transmitted\ | number| No | Percentage of discarded packets |
2188 | PercentDiscard | | | transmitted; value = |
2189 | | | | (transmittedDiscardedPacketsDelta / |
2190 | | | | transmittedTotalPacketsDelta) x 100, if |
2191 | | | | denominator is nonzero, or 0, if |
2192 | | | | otherwise. |
2193 +----------------+-------+----------+-----------------------------------------+
2194 | transmitted\ | number| No | Percentage of error packets received; |
2195 | PercentError | | | value = (transmittedErrorPacketsDelta / |
2196 | | | | transmittedTotalPacketsDelta) x 100, if |
2197 | | | | denominator is nonzero, or 0, if |
2198 | | | | otherwise. |
2199 +----------------+-------+----------+-----------------------------------------+
2200 | transmitted\ | number| No | Cumulative count of all packets |
2201 | TotalPackets\ | | | transmitted as read at the end of the |
2202 | Accumulated | | | measurement interval |
2203 +----------------+-------+----------+-----------------------------------------+
2204 | transmitted\ | number| No | Count of all packets transmitted within |
2205 | TotalPackets\ | | | the measurement interval |
2207 +----------------+-------+----------+-----------------------------------------+
2208 | transmitted\ | number| No | Cumulative count of unicast packets |
2209 | Unicast\ | | | transmitted as read at the end of the |
2210 | Packets\ | | | measurement interval |
2211 | Accumulated | | | |
2212 +----------------+-------+----------+-----------------------------------------+
2213 | transmitted\ | number| No | Count of unicast packets transmitted |
2214 | Unicast\ | | | within the measurement interval |
2215 | PacketsDelta | | | |
2216 +----------------+-------+----------+-----------------------------------------+
2217 | transmitted\ | number| No | Percentage of utilization transmitted; |
2218 | Utilization | | | value = (transmittedOctetsDelta / (speed|
2219 | | | | x (lastEpochMicrosec - |
2220 | | | | startEpochMicrosec))) x 100, if |
2221 | | | | denominator is nonzero, or 0, if |
2222 | | | | otherwise. |
2223 +----------------+-------+----------+-----------------------------------------+
2224 | values\ | string| Yes | Enumeration: ‘true’ or ‘false’. If |
2225 | AreSuspect | | | ‘true’ then the vNicPerformance values |
2226 | | | | are likely inaccurate due to counter |
2227 | | | | overflow or other conditions. |
2228 +----------------+-------+----------+-----------------------------------------+
2230 Datatype: processorDimmAggregateThermalMargin
2231 **********************************************
2233 The processorDimmAggregateThermalMargin datatype provides intelligent
2234 platform management interface (ipmi) processor dual inline memory module
2235 aggregate thermal margin metrics; it consists of the following fields:
2237 +-----------------+-------+----------+----------------------------------------+
2238 | Field | Type | Required?| Description |
2239 +=================+=======+==========+========================================+
2240 | processor\ | string| Yes | identifier for the aggregate thermal |
2241 | DimmAggregate\ | | | margin metrics from the processor dual |
2242 | Thermal | | | inline memory module |
2243 | MarginIdentifier| | | |
2244 +-----------------+-------+----------+----------------------------------------+
2245 | thermalMargin | number| Yes | the difference between the DIMM's |
2246 | | | | current temperature, in celsius, and |
2247 | | | | the DIMM's throttling thermal trip |
2248 +-----------------+-------+----------+----------------------------------------+
2250 Datatype: processStats
2251 ***********************
2253 The processStats datatype provides metrics on system processes; it
2254 consists of the following fields:
2257 +-----------+-------+----------+----------------------------------------------+
2258 | Field | Type | Required?| Description |
2259 +===========+=======+==========+==============================================+
2260 | forkRate | number| No | The number of threads created since the last |
2262 +-----------+-------+----------+----------------------------------------------+
2263 | process\ | string| Yes | processIdentifier |
2265 +-----------+-------+----------+----------------------------------------------+
2266 | psState\ | number| No | The number of processes in a blocked state |
2268 +-----------+-------+----------+----------------------------------------------+
2269 | psState\ | number| No | The number of processes in a paging state |
2271 +-----------+-------+----------+----------------------------------------------+
2272 | psState\ | number| No | The number of processes in a running state |
2274 +-----------+-------+----------+----------------------------------------------+
2275 | psState\ | number| No | The number of processes in a sleeping state |
2277 +-----------+-------+----------+----------------------------------------------+
2278 | psState\ | number| No | The number of processes in a stopped state |
2280 +-----------+-------+----------+----------------------------------------------+
2281 | psState\ | number| No | The number of processes in a zombie state |
2283 +-----------+-------+----------+----------------------------------------------+
2285 ‘Notification’ Domain Datatypes
2286 ++++++++++++++++++++++++++++++++
2288 Datatype: notificationFields
2289 ******************************
2291 The notificationFields datatype consists of the following fields:
2293 +--------------+-----------+----------+---------------------------------------+
2294 | Field | Type | Required?| Description |
2295 +==============+===========+==========+=======================================+
2296 | additional\ | hashMap | No | Additional notification fields if |
2297 | Fields | | | needed |
2298 +--------------+-----------+----------+---------------------------------------+
2299 | arrayOfNamed\| namedHash\| No | Array of named hashMaps |
2300 | HashMap | Map [ ] | | |
2301 +--------------+-----------+----------+---------------------------------------+
2302 | change\ | string | No | Identifier for a contact related to |
2303 | Contact | | | the change |
2304 +--------------+-----------+----------+---------------------------------------+
2305 | change\ | string | Yes | System or session identifier |
2306 | Identifier | | | associated with the change |
2307 +--------------+-----------+----------+---------------------------------------+
2308 | changeType | string | Yes | Describes what has changed for the |
2309 | | | | entity, for example: configuration |
2310 | | | | changed, capability added, capability |
2312 +--------------+-----------+----------+---------------------------------------+
2313 | newState | string | No | New state of the entity, for example: |
2314 | | | | ‘inService’, ‘maintenance’, |
2315 | | | | ‘outOfService’ |
2316 +--------------+-----------+----------+---------------------------------------+
2317 | notification\| string | Yes | Version of the notificationFields |
2318 | FieldsVersion| | | block as "#.#" where # is a digit; see|
2319 | | | | section 1 for the correct digits to |
2321 +--------------+-----------+----------+---------------------------------------+
2322 | oldState | string | No | Previous state of the entity, for |
2323 | | | | example: ‘inService’, ‘maintenance’, |
2324 | | | | ‘outOfService’ |
2325 +--------------+-----------+----------+---------------------------------------+
2326 | state\ | string | No | Card or port name of the entity that |
2327 | Interface | | | changed state |
2328 +--------------+-----------+----------+---------------------------------------+
2330 The fileReady notification event is used by 3GPP-compliant NFs to notify
2331 ONAP that a PM file is available for upload. The notificationFields are
2332 populated as follows:
2334 **arrayOfNamedHashMap:** The array is named for the PM file as defined
2335 in 3GPP TS 28.550. The array contains the following key value pairs:
2337 - **location** in the form protocol://ipAddress:port/path/filename;
2339 "ftpes://135.3.1.44:21/pmfiles/A20180531.1030+0600-1045+0600\A20000626.2315+0200-2330+0200_NodeBId.gz"
2341 - **compression** containing the compression type used for the PM file;
2342 e.g. "compression" : "gzip"
2344 - **fileFormatType** containing the format type of the PM file; e.g.
2345 "fileFormatType" : "org.3GPP.32.435#measCollec"
2347 - **fileFormatVersion** containing the format version of the PM file;
2348 e.g. "fileFormatVersion" : "V10"
2350 - other vendor-defined key-value pairs as needed
2352 **changeIdentifier:** set to PM\_MEAS\_FILES
2354 **changeType:** set to fileReady
2356 Other notificationFields are not used for fileReady.
2358 ‘Other’ Domain Datatypes
2359 +++++++++++++++++++++++++
2361 Datatype: otherFields
2362 **********************
2364 The otherFields datatype defines fields for events belonging to the
2365 'other' domain of the commonEventHeader domain enumeration; it consists
2366 of the following fields:
2368 +-------------+-------------+----------+--------------------------------------+
2369 | Field | Type | Required?| Description |
2370 +=============+=============+==========+======================================+
2371 | arrayOf\ | arrayOf\ | No | Array of named hashMaps |
2372 | NamedHashMap| NamedHashMap| | |
2373 +-------------+-------------+----------+--------------------------------------+
2374 | hashMap | hashMap | No | Array of name-value pairs |
2375 +-------------+-------------+----------+--------------------------------------+
2376 | jsonObjects | arrayOf\ | No | Array of JSON objects described by |
2377 | | JsonObject | | name, schema and other |
2378 | | | | meta-information |
2379 +-------------+-------------+----------+--------------------------------------+
2380 | otherFields\| string | Yes | Version of the otherFields block as |
2381 | Version | | | "#.#" where # is a digit; see section|
2382 | | | | 1 for the correct digits to use. |
2383 +-------------+-------------+----------+--------------------------------------+
2385 ‘perf3gpp’ Domain Datatypes
2386 ++++++++++++++++++++++++++++
2388 Datatype: measDataCollection
2389 *****************************
2391 The measDataCollection datatype defines a 3GPP measurement collection
2392 structure aligned with the 3GPP PM format; it consists of the following
2395 +----------------+---------+----------+---------------------------------------+
2396 | Field | Type | Required?| Description |
2397 +================+=========+==========+=======================================+
2398 | format\ | string | No | 3GPP PM reporting file format version |
2399 | Version | | | from pre-standard TS 28.550 v2.0.0 |
2400 +----------------+---------+----------+---------------------------------------+
2401 | granularity\ | string | Yes | Granularity period for the PM report |
2402 | Period | | | in seconds |
2403 +----------------+---------+----------+---------------------------------------+
2404 | measInfoList | measInfo| Yes | Array of measInfo measurements |
2406 +----------------+---------+----------+---------------------------------------+
2407 | measObjInst\ | string | No | Array of monitored object local |
2408 | IdList | [ ] | | distinguished name ids per 3GPP TS |
2410 +----------------+---------+----------+---------------------------------------+
2411 | measured\ | string | Yes | Distinguished name per 3GPP TS 28.550 |
2413 +----------------+---------+----------+---------------------------------------+
2414 | measuredEntity\| string | No | Software version for the NF providing |
2415 | SoftwareVersion| | | the PM data as specified in 3GPP TS |
2417 +----------------+---------+----------+---------------------------------------+
2418 | measuredEntity\| string | No | User Definable name for the measured |
2419 | UserName | | | object per 3GPP TS 28.550 |
2420 +----------------+---------+----------+---------------------------------------+
2423 ********************
2425 The measInfo datatype provides measurement information; it consists of
2426 the following fields:
2428 +-------+--------------------------+----------+-------------------------------+
2429 | Field | Type | Required?| Description |
2430 +=======+==========================+==========+===============================+
2431 | jobId | string | No | Name of the measurement job |
2432 +-------+--------------------------+----------+-------------------------------+
2433 | meas\ | oneOf [ measInfoIdInteger| No | Measurement group Identifier |
2434 | InfoId| , measInfoIdString ] | | |
2435 +-------+--------------------------+----------+-------------------------------+
2436 | meas\ | oneOf [ measTypesInteger | Yes | Array of measurement |
2437 | Types | , measTypesString ] | | identifiers associated with |
2438 | | | | the measurement results |
2439 | | | | expressed as integers for |
2440 | | | | efficiency rather than strings|
2441 +-------+--------------------------+----------+-------------------------------+
2442 | meas\ | measValues [ ] | Yes | Array of measValues |
2444 +-------+--------------------------+----------+-------------------------------+
2446 Datatype: measInfoIdInteger
2447 ****************************
2449 The measInfoIdInteger datatype provides an integer measurement group
2450 identifier; it consists of the following fields:
2452 +---------------+---------+----------+--------------------------------------+
2453 | Field | Type | Required?| Description |
2454 +===============+=========+==========+======================================+
2455 | iMeasInfoId | integer | Yes | Integer measurement group Identifier |
2456 +---------------+---------+----------+--------------------------------------+
2458 Datatype: measInfoIdString
2459 ***************************
2461 The measInfoIdString datatype provides a string measurement group
2462 identifier; it consists of the following fields:
2464 +---------------+-----------+----------+--------------------------------------+
2465 | Field | Type | Required?| Description |
2466 +===============+===========+==========+======================================+
2467 | sMeasInfoId | integer | Yes | String measurement group Identifier |
2468 +---------------+-----------+----------+--------------------------------------+
2470 Datatype: measResultInteger
2471 ****************************
2473 The measResultInteger datatype provides an integer 3GPP PM measurement
2474 result; it consists of the following fields:
2476 +----------+-----------+-------------+------------------------------------+
2477 | Field | Type | Required? | Description |
2478 +==========+===========+=============+====================================+
2479 | p | integer | Yes | Integer reference to the counter |
2480 +----------+-----------+-------------+------------------------------------+
2481 | iValue | integer | Yes | Integer counter value |
2482 +----------+-----------+-------------+------------------------------------+
2484 Datatype: measResultNull
2485 *************************
2487 The measResultNull datatype provides a null 3GPP PM measurement result;
2488 it consists of the following fields:
2490 +----------+-----------+-------------+------------------------------------+
2491 | Field | Type | Required? | Description |
2492 +==========+===========+=============+====================================+
2493 | p | integer | Yes | Integer reference to the counter |
2494 +----------+-----------+-------------+------------------------------------+
2495 | isNull | string | Yes | Enumeration: ‘true’ or ‘false’ |
2496 +----------+-----------+-------------+------------------------------------+
2498 Datatype: measResultNumber
2499 ***************************
2501 The measResultNumber datatype provides a number 3GPP PM measurement
2502 result; it consists of the following fields:
2504 +----------+-----------+-------------+------------------------------------+
2505 | Field | Type | Required? | Description |
2506 +==========+===========+=============+====================================+
2507 | p | integer | Yes | Integer reference to the counter |
2508 +----------+-----------+-------------+------------------------------------+
2509 | rValue | number | Yes | Number counter value |
2510 +----------+-----------+-------------+------------------------------------+
2512 Datatype: measResultString
2513 ***************************
2515 The measResultString datatype provides a string 3GPP PM measurement
2516 result; it consists of the following fields:
2518 +----------+-----------+-------------+------------------------------------+
2519 | Field | Type | Required? | Description |
2520 +==========+===========+=============+====================================+
2521 | p | integer | Yes | Integer reference to the counter |
2522 +----------+-----------+-------------+------------------------------------+
2523 | sValue | string | Yes | String counter value |
2524 +----------+-----------+-------------+------------------------------------+
2526 Datatype: measTypesInteger
2527 ***************************
2529 The measTypesInteger datatype provides an array of integer measurement
2530 identifiers associated with the measurement results; it consists of the
2533 +----------+--------+----------+----------------------------------------------+
2534 | Field | Type | Required?| Description |
2535 +==========+========+==========+==============================================+
2536 | iMeas\ | integer| Yes | Array of integer measurement identifiers |
2537 | TypesList| [ ] | | associated with the measurement results |
2538 +----------+--------+----------+----------------------------------------------+
2540 Datatype: measTypesString
2541 **************************
2543 The measTypesString datatype provides an array of string measurement
2544 identifiers associated with the measurement results; it consists of the
2547 +----------+-------+----------+-----------------------------------------------+
2548 | Field | Type | Required?| Description |
2549 +==========+=======+==========+===============================================+
2550 | sMeas\ | string| Yes | Array of string measurement identifiers |
2551 | TypesList| [ ] | | associated with the measurement results |
2552 +----------+-------+----------+-----------------------------------------------+
2554 Datatype: measValues
2555 *********************
2557 The measValues datatype provides 3GPP measurement values; it consists of
2558 the following fields:
2560 +---------+----------------------------------+----------+---------------------+
2561 | Field | Type | Required?| Description |
2562 +=========+==================================+==========+=====================+
2563 | measObj\| hashMap | No | Additional key-value|
2564 | AddlFlds| | | pairs if needed |
2565 +---------+----------------------------------+----------+---------------------+
2566 | measObj\|measDataCollection | Yes | Monitored object |
2567 | InstId | | | local distinguished |
2568 | | | | name per 3GPP TS |
2569 | | | | 32.300 and 3GPP TS |
2571 +---------+----------------------------------+----------+---------------------+
2572 | meas\ | Array of items where each item is| Yes | Array of results |
2573 | Results | oneOf [ measResultInteger, | | |
2574 | | measResultNull, measResultNumber,| | |
2575 | | measResultString ] | | |
2576 +---------+----------------------------------+----------+---------------------+
2577 | suspect\| string | No | Enumeration: ‘true’,|
2578 | Flag | | | ‘false’. Indicates |
2579 | | | | if the values are |
2581 +---------+----------------------------------+----------+---------------------+
2583 Datatype: perf3gppFields
2584 *************************
2586 The perf3gppFields datatype defines fields for 3GPP PM format events,
2587 based on 3GPP TS 28.550, belonging to the 'perf3gpp' domain of the
2588 commonEventHeader domain enumeration; it consists of the following
2591 +--------------+-----------+----------+---------------------------------------+
2592 | Field | Type | Required?| Description |
2593 +==============+===========+==========+=======================================+
2594 | eventAddl\ | hashMap | No | Additional key-value pairs if needed |
2596 +--------------+-----------+----------+---------------------------------------+
2597 | measData\ | measData | Yes | 3GPP measurement collection structure |
2598 | Collection | Collection| | |
2599 +--------------+-----------+----------+---------------------------------------+
2600 | perf3gpp\ | string | Yes | Version of the perf3gpp event |
2601 | FieldsVersion| | | |
2602 +--------------+-----------+----------+---------------------------------------+
2604 ‘pnfRegistration’ Domain Datatypes
2605 ++++++++++++++++++++++++++++++++++++
2607 Datatype: pnfRegistrationFields
2608 ********************************
2610 The pnfRegistrationFields datatype defines fields for events belonging
2611 to the 'pnfRegistration' domain of the commonEventHeader domain
2612 enumeration; it consists of the following fields:
2614 +-----------------+--------+----------+---------------------------------------+
2615 | Field | Type | Required?| Description |
2616 +=================+========+==========+=======================================+
2617 | additional\ | hashMap| No | Additional pnfRegistration fields if |
2618 | Fields | | | needed |
2619 +-----------------+--------+----------+---------------------------------------+
2620 | last\ | string | No | TS 32.692 dateOfLastService = date of |
2621 | ServiceDate | | | last service; e.g. 15022017 |
2622 +-----------------+--------+----------+---------------------------------------+
2623 | macAddress | string | No | MAC address of OAM interface of the |
2625 +-----------------+--------+----------+---------------------------------------+
2626 | manufacture\ | string | No | TS 32.692 dateOfManufacture = |
2627 | Date | | | manufacture date of the unit; 24032016|
2628 +-----------------+--------+----------+---------------------------------------+
2629 | modelNumber | string | No | TS 32.692 versionNumber = version of |
2630 | | | | the unit from vendor; e.g. AJ02. Maps |
2631 | | | | to AAI equip-model |
2632 +-----------------+--------+----------+---------------------------------------+
2633 | oamV4\ | string | No | IPv4 m-plane IP address to be used by |
2634 | IpAddress | | | the manager to contact the PNF |
2635 +-----------------+--------+----------+---------------------------------------+
2636 | oamV6\ | string | No | IPv6 m-plane IP address to be used by |
2637 | IpAddress | | | the manager to contact the PNF |
2638 +-----------------+--------+----------+---------------------------------------+
2639 | pnfRegistration\| string | Yes | Version of the pnfRegistrationFields |
2640 | FieldsVersion | | | block as "#.#" where # is a digit; see|
2641 | | | | section 1 for the correct digits to |
2643 +-----------------+--------+----------+---------------------------------------+
2644 | serialNumber | string | No | TS 32.692 serialNumber = serial number|
2645 | | | | of the unit; e.g. 6061ZW3 |
2646 +-----------------+--------+----------+---------------------------------------+
2647 | software\ | string | No | TS 32.692 swName = active SW running |
2648 | Version | | | on the unit; e.g. 5gDUv18.05.201 |
2649 +-----------------+--------+----------+---------------------------------------+
2650 | unitFamily | string | No | TS 32.692 vendorUnitFamilyType = |
2651 | | | | general type of HW unit; e.g. BBU |
2652 +-----------------+--------+----------+---------------------------------------+
2653 | unitType | string | No | TS 32.692 vendorUnitTypeNumber = |
2654 | | | | vendor name for the unit; e.g. |
2656 +-----------------+--------+----------+---------------------------------------+
2657 | vendorName | string | No | TS 32.692 vendorName = name of |
2658 | | | | manufacturer; e.g. Nokia. Maps to AAI |
2659 | | | | equip-vendor |
2660 +-----------------+--------+----------+---------------------------------------+
2662 ‘State Change’ Domain Datatypes
2663 ++++++++++++++++++++++++++++++++
2665 Datatype: stateChangeFields
2666 *****************************
2668 The stateChangeFields datatype consists of the following fields:
2670 +--------------+--------+----------+------------------------------------------+
2671 | Field | Type | Required?| Description |
2672 +==============+========+==========+==========================================+
2673 | additional\ | hashMap| No | Additional stateChange fields if needed |
2675 +--------------+--------+----------+------------------------------------------+
2676 | newState | string | Yes | New state of the entity: ‘inService’, |
2677 | | | | ‘maintenance’, ‘outOfService’ |
2678 +--------------+--------+----------+------------------------------------------+
2679 | oldState | string | Yes | Previous state of the entity: ‘inService’|
2680 | | | | , ‘maintenance’, ‘outOfService’ |
2681 +--------------+--------+----------+------------------------------------------+
2682 | stateChange\ | string | Yes | Version of the stateChangeFields block as|
2683 | FieldsVersion| | | "#.#" where # is a digit; see section 1 |
2684 | | | | for the correct digits to use. |
2685 +--------------+--------+----------+------------------------------------------+
2686 | state\ | string | Yes | Card or port name of the entity that |
2687 | Interface | | | changed state |
2688 +--------------+--------+----------+------------------------------------------+
2690 ‘Syslog’ Domain Datatypes
2691 ++++++++++++++++++++++++++
2693 Datatype: syslogFields
2694 ***********************
2696 The syslogFields datatype consists of the following fields:
2698 +------------+--------+----------+--------------------------------------------+
2699 | Field | Type | Required?| Description |
2700 +============+========+==========+============================================+
2701 | additional\| hashMap| No | Additional syslog fields if needed Ex: |
2702 | Fields | | | {"name1": "value1", "name2: "value2" … } |
2703 +------------+--------+----------+--------------------------------------------+
2704 | event\ | string | No | Hostname of the device |
2705 | SourceHost | | | |
2706 +------------+--------+----------+--------------------------------------------+
2707 | event\ | string | Yes | Examples: ‘other’, ‘router’, ‘switch’, |
2708 | SourceType | | | ‘host’, ‘card’, ‘port’, ‘slotThreshold’, |
2709 | | | | ‘portThreshold’, ‘virtualMachine’, |
2710 | | | | ‘virtualNetworkFunction’ |
2711 +------------+--------+----------+--------------------------------------------+
2712 | syslog\ | integer| No | Numeric code from 0 to 23 for facility: |
2715 | | | | 0 kernel messages |
2717 | | | | 1 user-level messages |
2719 | | | | 2 mail system |
2721 | | | | 3 system daemons |
2723 | | | | 4 security/authorization messages |
2725 | | | | 5 messages generated internally by syslogd |
2727 | | | | 6 line printer subsystem |
2729 | | | | 7 network news subsystem |
2731 | | | | 8 UUCP subsystem |
2733 | | | | 9 clock daemon |
2735 | | | | 10 security/authorization messages |
2737 | | | | 11 FTP daemon |
2739 | | | | 12 NTP subsystem |
2741 | | | | 13 log audit |
2743 | | | | 14 log alert |
2745 | | | | 15 clock daemon (note 2) |
2747 | | | | 16 local use 0 (local0) |
2749 | | | | 17 local use 1 (local1) |
2751 | | | | 18 local use 2 (local2) |
2753 | | | | 19 local use 3 (local3) |
2755 | | | | 20 local use 4 (local4) |
2757 | | | | 21 local use 5 (local5) |
2759 | | | | 22 local use 6 (local6) |
2761 | | | | 23 local use 7 (local7 ) |
2762 +------------+--------+----------+--------------------------------------------+
2763 | syslog\ | string | Yes | Version of the syslogFields block as "#.#" |
2764 | Fields\ | | | where # is a digit; see section 1 for the |
2765 | Version | | | correct digits to use. |
2766 +------------+--------+----------+--------------------------------------------+
2767 | syslogMsg | string | Yes | Syslog message |
2768 +------------+--------+----------+--------------------------------------------+
2769 | syslog\ | string | No | Hostname parsed from non-VES syslog message|
2771 +------------+--------+----------+--------------------------------------------+
2772 | syslogPri | integer| No | 0-192 |
2774 | | | | Combined Severity and Facility(see rfc5424)|
2775 +------------+--------+----------+--------------------------------------------+
2776 | syslogProc | string | No | Identifies the application that originated |
2777 | | | | the message |
2778 +------------+--------+----------+--------------------------------------------+
2779 | syslog\ | number | No | The process number assigned by the OS when |
2780 | ProcId | | | the application was started |
2781 +------------+--------+----------+--------------------------------------------+
2782 | syslog\ | string | No | A <space> separated list of key="value" |
2783 | SData | | | pairs following the rfc5424 standard for |
2784 | | | | SD-ELEMENT. |
2786 | | | | ***Deprecated *** |
2788 | | | | The entire rfc5424 syslogSData object, |
2789 | | | | including square brackets [ ], SD-ID and |
2790 | | | | list of SD-PARAMs |
2791 +------------+--------+----------+--------------------------------------------+
2792 | syslogSdId | string | No | 0-32 char in format name@number, |
2794 | | | | i.e., ourSDID@32473 |
2795 +------------+--------+----------+--------------------------------------------+
2796 | syslogSev | string | No | Level-of-severity text enumeration defined |
2799 | | | | *Text* *Sev* *Description* |
2801 | | | | Emergency 0 system is unusable |
2803 | | | | Alert 1 action must be taken immediately |
2805 | | | | Critical 2 critical conditions |
2807 | | | | Error 3 error conditions |
2809 | | | | Warning 4 warning conditions |
2811 | | | | Notice 5 normal but significant condition |
2813 | | | | Info 6 Informational messages |
2815 | | | | Debug 7 debug-level messages |
2816 +------------+--------+----------+--------------------------------------------+
2817 | syslogTag | string | Yes | Also known as MsgId. Brief non-spaced text |
2818 | | | | indicating the type of message such as |
2819 | | | | ‘TCPOUT’ or ‘BGP\_STATUS\_CHANGE’; |
2820 | | | | ‘NILVALUE’ should be used when no other |
2821 | | | | value can be provided |
2822 +------------+--------+----------+--------------------------------------------+
2823 | syslogTs | string | No | Timestamp parsed from non-VES syslog |
2825 +------------+--------+----------+--------------------------------------------+
2826 | syslogVer | number | No | IANA assigned version of the syslog |
2827 | | | | protocol specification: |
2831 | | | | 1: IANA RFC5424 |
2832 +------------+--------+----------+--------------------------------------------+
2834 Examples of syslogSData :
2838 ts="1985-04-12T23:20:50.52Z" tag="BGP\_NEIGHBOR\_DOWN" msg="The BGP
2839 session to neighbor 10.10.10.10 is down"
2843 [attinc@1234 ts="1985-04-12T23:20:50.52Z" tag="BGP\_NEIGHBOR\_DOWN"
2844 msg="The BGP session to neighbor 10.10.10.10 is down"]
2848 https://tools.ietf.org/html/rfc5424#section-6
2850 https://www.iana.org/assignments/syslog-parameters/syslog-parameters.xhtml
2852 ‘Threshold Crossing Alert’ Domain Datatypes
2853 ++++++++++++++++++++++++++++++++++++++++++++
2858 The counter datatype consists of the following fields:
2860 +------------+--------+----------+--------------------------------------------+
2861 | Field | Type | Required?| Description |
2862 +============+========+==========+============================================+
2863 | criticality| string | Yes | Enumeration: ‘CRIT’, ‘MAJ’ |
2864 +------------+--------+----------+--------------------------------------------+
2865 | hashMap | hashMap| Yes | Key is the name of the counter and value is|
2866 | | | | the current value of the counter |
2867 +------------+--------+----------+--------------------------------------------+
2868 | threshhold\| string | Yes | Last threshold that was crossed |
2870 +------------+--------+----------+--------------------------------------------+
2872 Datatype: thresholdCrossingAlertFields
2873 ****************************************
2875 The thresholdCrossingAlertFields datatype consists of the following
2878 +------------+------------+----------+----------------------------------------+
2879 | Field | Type | Required?| Description |
2880 +============+============+==========+========================================+
2881 | additional\| hashMap | No | Additional threshold crossing alert |
2882 | Fields | | | fields if needed |
2883 +------------+------------+----------+----------------------------------------+
2884 | additional\| counter [ ]| Yes | Array of performance counters |
2885 | Parameters | | | |
2886 +------------+------------+----------+----------------------------------------+
2887 | alert\ | string | Yes | Enumeration: ‘SET’, ‘CONT’, ‘CLEAR’ |
2889 +------------+------------+----------+----------------------------------------+
2890 | alert\ | string | Yes | Unique short alert description (e.g., |
2891 | Description| | | NE-CPUMEM) |
2892 +------------+------------+----------+----------------------------------------+
2893 | alertType | string | Yes | Enumeration: ‘CARD-ANOMALY’, |
2894 | | | | ‘INTERFACE-ANOMALY’, ELEMENT-ANOMALY’, |
2895 | | | | ‘SERVICE-ANOMALY’ |
2896 +------------+------------+----------+----------------------------------------+
2897 | alertValue | string | No | Calculated API value (if applicable) |
2898 +------------+------------+----------+----------------------------------------+
2899 | associated\| string [ ] | No | List of eventIds associated with the |
2900 | AlertIdList| | | event being reported |
2901 +------------+------------+----------+----------------------------------------+
2902 | collection\| string | Yes | Time when the performance collector |
2903 | Timestamp | | | picked up the data; with RFC 2822 |
2904 | | | | compliant format: ‘Sat, 13 Mar 2010 |
2905 | | | | 11:29:05 -0800’ |
2906 +------------+------------+----------+----------------------------------------+
2907 | data\ | string | No | Specific performance collector instance|
2908 | Collector | | | used |
2909 +------------+------------+----------+----------------------------------------+
2910 | elementType| string | No | Type of network element (internal AT&T |
2912 +------------+------------+----------+----------------------------------------+
2913 | event\ | string | Yes | Event severity or priority enumeration:|
2914 | Severity | | | ‘CRITICAL’, ‘MAJOR’, ‘MINOR’, ‘WARNING’|
2915 | | | | , ‘NORMAL’ |
2916 +------------+------------+----------+----------------------------------------+
2917 | eventStart\| string | Yes | Time closest to when the measurement |
2918 | Timestamp | | | was made; with RFC 2822 compliant |
2919 | | | | format: ‘Sat, 13 Mar 2010 11:29:05 |
2921 +------------+------------+----------+----------------------------------------+
2922 | interface\ | string | No | Physical or logical port or card (if |
2923 | Name | | | applicable) |
2924 +------------+------------+----------+----------------------------------------+
2925 | network\ | string | No | Network name (internal AT&T field) |
2927 +------------+------------+----------+----------------------------------------+
2928 | possible\ | string | No | Reserved for future use |
2930 +------------+------------+----------+----------------------------------------+
2931 | threshold\ | string | Yes | Version of the |
2932 | Crossing | | | thresholdCrossingAlertFields block as |
2933 | Fields\ | | | "#.#" where # is a digit; see section 1|
2934 | Version | | | for the correct digits to use. |
2935 +------------+------------+----------+----------------------------------------+
2937 Technology Specific Datatypes
2938 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2940 Mobile Flow’ Domain Datatypes
2941 ++++++++++++++++++++++++++++++
2943 Datatype: gtpPerFlowMetrics
2944 ****************************
2946 The gtpPerFlowMetrics datatype consists of the following fields:
2948 +---------------+--------+----------+-----------------------------------------+
2949 | Field | Type | Required?| Description |
2950 +===============+========+==========+=========================================+
2951 | avgBit\ | number | Yes | Average bit error rate |
2953 +---------------+--------+----------+-----------------------------------------+
2954 | avgPacket\ | number | Yes | Average packet delay variation or jitter|
2955 | Delay\ | | | in milliseconds for received packets: |
2956 | Variation | | | Average difference between the packet |
2957 | | | | timestamp and time received for all |
2958 | | | | pairs of consecutive packets |
2959 +---------------+--------+----------+-----------------------------------------+
2960 | avgPacket\ | number | Yes | Average delivery latency |
2962 +---------------+--------+----------+-----------------------------------------+
2963 | avgReceive\ | number | Yes | Average receive throughput |
2964 | Throughput | | | |
2965 +---------------+--------+----------+-----------------------------------------+
2966 | avgTransmit\ | number | Yes | Average transmit throughput |
2967 | Throughput | | | |
2968 +---------------+--------+----------+-----------------------------------------+
2969 | dur\ | number | No | Duration of failed state in milliseconds|
2970 | Connection\ | | | , computed as the cumulative time |
2971 | FailedStatus | | | between a failed echo request and the |
2972 | | | | next following successful error request,|
2973 | | | | over this reporting interval |
2974 +---------------+--------+----------+-----------------------------------------+
2975 | durTunnel\ | number | No | Duration of errored state, computed as |
2976 | FailedStatus | | | the cumulative time between a tunnel |
2977 | | | | error indicator and the next following |
2978 | | | | non-errored indicator, over this |
2979 | | | | reporting interval |
2980 +---------------+--------+----------+-----------------------------------------+
2981 | flow\ | string | No | Endpoint activating the flow |
2982 | ActivatedBy | | | |
2983 +---------------+--------+----------+-----------------------------------------+
2984 | flow\ | number | Yes | Time the connection is activated in the |
2985 | Activation\ | | | flow (connection) being reported on, or |
2986 | Epoch | | | transmission time of the first packet if|
2987 | | | | activation time is not available |
2988 +---------------+--------+----------+-----------------------------------------+
2989 | flow\ | number | Yes | Integer microseconds for the start of |
2990 | Activation\ | | | the flow connection |
2992 +---------------+--------+----------+-----------------------------------------+
2993 | flow\ | string | No | Time the connection is activated in the |
2994 | Activation\ | | | flow being reported on, or transmission |
2995 | Time | | | time of the first packet if activation |
2996 | | | | time is not available; with RFC 2822 |
2997 | | | | compliant format: ‘Sat, 13 Mar 2010 |
2998 | | | | 11:29:05 -0800’ |
2999 +---------------+--------+----------+-----------------------------------------+
3000 | flow\ | string | No | Endpoint deactivating the flow |
3001 | Deactivated\ | | | |
3003 +---------------+--------+----------+-----------------------------------------+
3004 | flow\ | number | Yes | Time for the start of the flow |
3005 | Deactivation\ | | | connection, in integer UTC epoch time |
3006 | Epoch | | | aka UNIX time |
3007 +---------------+--------+----------+-----------------------------------------+
3008 | flow\ | number | Yes | Integer microseconds for the start of |
3009 | Deactivation\ | | | the flow connection |
3011 +---------------+--------+----------+-----------------------------------------+
3012 | flow\ | string | Yes | Transmission time of the first packet in|
3013 | Deactivation\ | | | the flow connection being reported on; |
3014 | Time | | | with RFC 2822 compliant format: ‘Sat, 13|
3015 | | | | Mar 2010 11:29:05 -0800’ |
3016 +---------------+--------+----------+-----------------------------------------+
3017 | flowStatus | string | Yes | Connection status at reporting time as a|
3018 | | | | working / inactive / failed indicator |
3020 +---------------+--------+----------+-----------------------------------------+
3021 | gtp\ | string | No | Current connection state at reporting |
3022 | Connection\ | | | time |
3024 +---------------+--------+----------+-----------------------------------------+
3025 | gtpTunnel\ | string | No | Current tunnel state at reporting time |
3027 +---------------+--------+----------+-----------------------------------------+
3028 | ipTos\ | hashMap| No | Array of key: value pairs where the keys|
3029 | CountList | | | are drawn from the IP Type-of-Service |
3030 | | | | identifiers which range from '0' to |
3031 | | | | '255', and the values are the count of |
3032 | | | | packets that had those ToS identifiers |
3033 | | | | in the flow |
3034 +---------------+--------+----------+-----------------------------------------+
3035 | ipTosList | string | No | Array of unique IP Type-of-Service |
3036 | | | | values observed in the flow where values|
3037 | | | | range from '0' to '255' |
3038 +---------------+--------+----------+-----------------------------------------+
3039 | large\ | number | No | large packet round trip time |
3041 +---------------+--------+----------+-----------------------------------------+
3042 | largePacket\ | number | No | large packet threshold being applied |
3044 +---------------+--------+----------+-----------------------------------------+
3045 | maxPacket\ | number | Yes | Maximum packet delay variation or jitter|
3046 | Delay\ | | | in milliseconds for received packets: |
3047 | Variation | | | Maximum of the difference between the |
3048 | | | | packet timestamp and time received for |
3049 | | | | all pairs of consecutive packets |
3050 +---------------+--------+----------+-----------------------------------------+
3051 | maxReceive\ | number | No | maximum receive bit rate" |
3053 +---------------+--------+----------+-----------------------------------------+
3054 | maxTransmit\ | number | No | maximum transmit bit rate |
3056 +---------------+--------+----------+-----------------------------------------+
3057 | mobileQci\ | hashMap| No | array of key: value pairs where the keys|
3058 | CosCountList | | | are drawn from LTE QCI or UMTS class of |
3059 | | | | service strings, and the values are the |
3060 | | | | count of packets that had those strings |
3061 | | | | in the flow |
3062 +---------------+--------+----------+-----------------------------------------+
3063 | mobileQci\ | string | No | Array of unique LTE QCI or UMTS |
3064 | CosList | | | class-of-service values observed in the |
3066 +---------------+--------+----------+-----------------------------------------+
3067 | num\ | number | Yes | Number of failed activation requests, as|
3068 | Activation\ | | | observed by the reporting node |
3070 +---------------+--------+----------+-----------------------------------------+
3071 | numBit\ | number | Yes | number of errored bits |
3073 +---------------+--------+----------+-----------------------------------------+
3074 | numBytes\ | number | Yes | number of bytes received, including |
3075 | Received | | | retransmissions |
3076 +---------------+--------+----------+-----------------------------------------+
3077 | numBytes\ | number | Yes | number of bytes transmitted, including |
3078 | Transmitted | | | retransmissions |
3079 +---------------+--------+----------+-----------------------------------------+
3080 | numDropped\ | number | Yes | number of received packets dropped due |
3081 | Packets | | | to errors per virtual interface |
3082 +---------------+--------+----------+-----------------------------------------+
3083 | numGtp\ | number | No | Number of Echo request path failures |
3084 | EchoFailures | | | where failed paths are defined in 3GPP |
3085 | | | | TS 29.281 sec 7.2.1 and 3GPP TS 29.060 |
3087 +---------------+--------+----------+-----------------------------------------+
3088 | numGtp\ | number | No | Number of tunnel error indications where|
3089 | TunnelErrors | | | errors are defined in 3GPP TS 29.281 sec|
3090 | | | | 7.3.1 and 3GPP TS 29.060 sec. 11.1 |
3091 +---------------+--------+----------+-----------------------------------------+
3092 | numHttp\ | number | No | Http error count |
3094 +---------------+--------+----------+-----------------------------------------+
3095 | numL7Bytes\ | number | Yes | number of tunneled layer 7 bytes |
3096 | Received | | | received, including retransmissions |
3097 +---------------+--------+----------+-----------------------------------------+
3098 | numL7Bytes\ | number | Yes | number of tunneled layer 7 bytes |
3099 | Transmitted | | | transmitted, excluding retransmissions |
3100 +---------------+--------+----------+-----------------------------------------+
3101 | numLost\ | number | Yes | number of lost packets |
3103 +---------------+--------+----------+-----------------------------------------+
3104 | numOutOf\ | number | Yes | number of out-of-order packets |
3105 | OrderPackets | | | |
3106 +---------------+--------+----------+-----------------------------------------+
3107 | numPacket\ | number | Yes | number of errored packets |
3109 +---------------+--------+----------+-----------------------------------------+
3110 | numPackets\ | number | Yes | number of packets received, excluding |
3111 | ReceivedExcl\ | | | retransmission |
3113 +---------------+--------+----------+-----------------------------------------+
3114 | numPackets\ | number | Yes | number of packets received, including |
3115 | ReceivedIncl\ | | | retransmission |
3117 +---------------+--------+----------+-----------------------------------------+
3118 | numPackets\ | number | Yes | number of packets transmitted, including|
3119 | Transmitted\ | | | retransmissions |
3120 | InclRetrans | | | |
3121 +---------------+--------+----------+-----------------------------------------+
3122 | numRetries | number | Yes | number of packet retrie |
3123 +---------------+--------+----------+-----------------------------------------+
3124 | numTimeouts | number | Yes | number of packet timeouts |
3125 +---------------+--------+----------+-----------------------------------------+
3126 | numTunneled\ | number | Yes | number of tunneled layer 7 bytes |
3127 | L7Bytes\ | | | received, excluding retransmissions |
3129 +---------------+--------+----------+-----------------------------------------+
3130 | roundTrip\ | number | Yes | Round Trip time |
3132 +---------------+--------+----------+-----------------------------------------+
3133 | tcpFlag\ | hashMap| No | Array of key: value pairs where the keys|
3134 | CountList | | | are drawn from TCP Flags and the values |
3135 | | | | are the count of packets that had that |
3136 | | | | TCP Flag in the flow |
3137 +---------------+--------+----------+-----------------------------------------+
3138 | tcpFlag\ | string | No | Array of unique TCP Flags observed in |
3139 | List | | | the flow |
3140 +---------------+--------+----------+-----------------------------------------+
3141 | timeTo\ | number | Yes | Time in milliseconds between the |
3142 | FirstByte | | | connection activation and first byte |
3144 +---------------+--------+----------+-----------------------------------------+
3146 Datatype: mobileFlowFields
3147 ***************************
3149 The mobileFlowFields datatype consists of the following fields:
3151 +-------------+------------+----------+---------------------------------------+
3152 | Field | Type | Required?| Description |
3153 +=============+============+==========+=======================================+
3154 | additional\ | hashMap | No | Additional mobileFlow fields if needed|
3156 +-------------+------------+----------+---------------------------------------+
3157 | application\| string | No | Application type inferred |
3159 +-------------+------------+----------+---------------------------------------+
3160 | appProtocol\| string | No | Application protocol |
3162 +-------------+------------+----------+---------------------------------------+
3163 | appProtocol\| string | No | Application version |
3165 +-------------+------------+----------+---------------------------------------+
3166 | cid | string | No | Cell Id |
3167 +-------------+------------+----------+---------------------------------------+
3168 | connection\ | string | No | Abbreviation referencing a 3GPP |
3169 | Type | | | reference point e.g., S1-U, S11, etc |
3170 +-------------+------------+----------+---------------------------------------+
3171 | ecgi | string | No | Evolved Cell Global Id |
3172 +-------------+------------+----------+---------------------------------------+
3173 | flow\ | string | Yes | Flow direction, indicating if the |
3174 | Direction | | | reporting node is the source of the |
3175 | | | | flow or destination for the flow |
3176 +-------------+------------+----------+---------------------------------------+
3177 | gtpPer\ | gtpPer | Yes | Mobility GTP Protocol per flow metrics|
3178 | FlowMetrics | FlowMetrics| | |
3179 +-------------+------------+----------+---------------------------------------+
3180 | gtpProtocol\| string | No | GTP protocol |
3182 +-------------+------------+----------+---------------------------------------+
3183 | gtpVersion | string | No | GTP protocol version |
3184 +-------------+------------+----------+---------------------------------------+
3185 | httpHeader | string | No | HTTP request header, if the flow |
3186 | | | | connects to a node referenced by HTTP |
3187 +-------------+------------+----------+---------------------------------------+
3188 | imei | string | No | IMEI for the subscriber UE used in |
3189 | | | | this flow, if the flow connects to a |
3190 | | | | mobile device |
3191 +-------------+------------+----------+---------------------------------------+
3192 | imsi | string | No | IMSI for the subscriber UE used in |
3193 | | | | this flow, if the flow connects to a |
3194 | | | | mobile device |
3195 +-------------+------------+----------+---------------------------------------+
3196 | ipProtocol\ | string | Yes | IP protocol type e.g.,TCP, UDP, RTP...|
3198 +-------------+------------+----------+---------------------------------------+
3199 | ipVersion | string | Yes | IP protocol version e.g., IPv4, IPv6 |
3200 +-------------+------------+----------+---------------------------------------+
3201 | lac | string | No | Location area code |
3202 +-------------+------------+----------+---------------------------------------+
3203 | mcc | string | No | Mobile country code |
3204 +-------------+------------+----------+---------------------------------------+
3205 | mnc | string | No | Mobile network code |
3206 +-------------+------------+----------+---------------------------------------+
3207 | mobileFlow\ | string | Yes | Version of the mobileFlowFields block |
3208 | Fields\ | | | as "#.#" where # is a digit; see |
3209 | Version | | | section 1 for the correct digits to |
3211 +-------------+------------+----------+---------------------------------------+
3212 | msisdn | string | No | MSISDN for the subscriber UE used in |
3213 | | | | this flow, as an integer, if the flow |
3214 | | | | connects to a mobile device |
3215 +-------------+------------+----------+---------------------------------------+
3216 | other\ | string | Yes | IP address for the other endpoint, as |
3217 | EndpointIp\ | | | used for the flow being reported on |
3219 +-------------+------------+----------+---------------------------------------+
3220 | other\ | integer | Yes | IP Port for the reporting entity, as |
3221 | Endpoint\ | | | used for the flow being reported on |
3223 +-------------+------------+----------+---------------------------------------+
3224 | other\ | string | No | Functional role of the other endpoint |
3225 | Functional\ | | | for the flow being reported on e.g., |
3226 | Role | | | MME, S-GW, P-GW, PCRF... |
3227 +-------------+------------+----------+---------------------------------------+
3228 | rac | string | No | Routing area code |
3229 +-------------+------------+----------+---------------------------------------+
3230 | radioAccess\| string | No | Radio Access Technology e.g., 2G, 3G, |
3231 | Technology | | | LTE |
3232 +-------------+------------+----------+---------------------------------------+
3233 | reporting\ | string | Yes | IP address for the reporting entity, |
3234 | EndpointIp\ | | | as used for the flow being reported on|
3236 +-------------+------------+----------+---------------------------------------+
3237 | reporting\ | integer | Yes | IP port for the reporting entity, as |
3238 | EndpointPort| | | used for the flow being reported on |
3239 +-------------+------------+----------+---------------------------------------+
3240 | sac | string | No | Service area code |
3241 +-------------+------------+----------+---------------------------------------+
3242 | sampling\ | integer | No | Integer identifier for the sampling |
3243 | Algorithm | | | algorithm or rule being applied in |
3244 | | | | calculating the flow metrics if |
3245 | | | | metrics are calculated based on a |
3246 | | | | sample of packets, or 0 if no sampling|
3247 | | | | is applied |
3248 +-------------+------------+----------+---------------------------------------+
3249 | tac | string | No | Transport area code |
3250 +-------------+------------+----------+---------------------------------------+
3251 | tunnelId | string | No | Tunnel identifier |
3252 +-------------+------------+----------+---------------------------------------+
3253 | vlanId | string | No | VLAN identifier used by this flow |
3254 +-------------+------------+----------+---------------------------------------+
3256 ‘SipSignaling’ Domain Datatypes
3257 +++++++++++++++++++++++++++++++
3259 Datatype: sipSignalingFields
3260 *****************************
3262 The sipSignalingFields datatype communicates information about sip
3263 signaling messages, parameters and signaling state; it consists of the
3266 +--------------+-----------+----------+---------------------------------------+
3267 | Field | Type | Required?| Description |
3268 +==============+===========+==========+=======================================+
3269 | additional\ | hashMap | No | Additional sipSignaling fields |
3270 | Information | | | |
3271 +--------------+-----------+----------+---------------------------------------+
3272 | compressed\ | string | No | The full SIP request/response |
3273 | Sip | | | including headers and bodies |
3274 +--------------+-----------+----------+---------------------------------------+
3275 | correlator | string | Yes | Constant across all events on this |
3277 +--------------+-----------+----------+---------------------------------------+
3278 | local\ | string | Yes | Ip address on xNF |
3280 +--------------+-----------+----------+---------------------------------------+
3281 | localPort | string | Yes | Port on xNF |
3282 +--------------+-----------+----------+---------------------------------------+
3283 | remote\ | string | Yes | IP address of peer endpoint |
3285 +--------------+-----------+----------+---------------------------------------+
3286 | remotePort | string | Yes | Port of peer endpoint |
3287 +--------------+-----------+----------+---------------------------------------+
3288 | sipSignaling\| string | Yes | Version of the sipSignalingFields |
3289 | FieldsVersion| | | block as "#.#" where # is a digit; see|
3290 | | | | section 1 for the correct digits to |
3292 +--------------+-----------+----------+---------------------------------------+
3293 | summarySip | string | No | The SIP Method or Response (‘INVITE’, |
3294 | | | | ‘200 OK’, ‘BYE’, etc) |
3295 +--------------+-----------+----------+---------------------------------------+
3296 | vendorNf\ | vendorNf | Yes | Vendor, NF and nfModule names |
3297 | NameFields | NameFields| | |
3298 +--------------+-----------+----------+---------------------------------------+
3300 ‘Voice Quality’ Domain Datatypes
3301 +++++++++++++++++++++++++++++++++
3303 Datatype: endOfCallVqmSummaries
3304 *********************************
3306 The endOfCallVqmSummaries datatype provides end of call voice quality
3307 metrics; it consists of the following fields:
3309 +--------------+-------+----------+-------------------------------------------+
3310 | Field | Type | Required?| Description |
3311 +==============+=======+==========+===========================================+
3312 | adjacency\ | string| Yes | Adjacency name |
3314 +--------------+-------+----------+-------------------------------------------+
3315 | endpoint\ | number| No | Endpoint average jitter |
3316 | AverageJitter| | | |
3317 +--------------+-------+----------+-------------------------------------------+
3318 | endpoint\ | string| Yes | Enumeration: ‘Caller’, ‘Callee’ |
3319 | Description | | | |
3320 +--------------+-------+----------+-------------------------------------------+
3321 | endpoint\ | number| No | Endpoint maximum jitter |
3323 +--------------+-------+----------+-------------------------------------------+
3324 | endpointRtp\ | number| No | Endpoint RTP octets discarded |
3327 +--------------+-------+----------+-------------------------------------------+
3328 | endpointRtp\ | number| No | Endpoint RTP octets lost |
3329 | OctetsLost | | | |
3330 +--------------+-------+----------+-------------------------------------------+
3331 | endpointRtp\ | number| No | Endpoint RTP octets received |
3334 +--------------+-------+----------+-------------------------------------------+
3335 | endpointRtp\ | number| No | Endpoint RTP octets sent |
3336 | OctetsSent | | | |
3337 +--------------+-------+----------+-------------------------------------------+
3338 | endpointRtp\ | number| No | Endpoint RTP packets discarded |
3341 +--------------+-------+----------+-------------------------------------------+
3342 | endpointRtp\ | number| No | Endpoint RTP packets lost |
3343 | PacketsLost | | | |
3344 +--------------+-------+----------+-------------------------------------------+
3345 | endpointRtp\ | number| No | Endpoint RTP packets received |
3348 +--------------+-------+----------+-------------------------------------------+
3349 | endpointRtp\ | number| No | Endpoint RTP packets sent |
3350 | PacketsSent | | | |
3351 +--------------+-------+----------+-------------------------------------------+
3352 | local\ | number| No | Local average jitter |
3355 +--------------+-------+----------+-------------------------------------------+
3356 | localAverage\| number| No | Local average jitter buffer delay |
3357 | JitterBuffer\| | | |
3359 +--------------+-------+----------+-------------------------------------------+
3360 | localMax\ | number| No | Local maximum jitter |
3362 +--------------+-------+----------+-------------------------------------------+
3363 | localMax\ | number| No | Local max jitter buffer delay |
3364 | JitterBuffer\| | | |
3366 +--------------+-------+----------+-------------------------------------------+
3367 | localRtp\ | number| No | Local RTP octets discarded |
3370 +--------------+-------+----------+-------------------------------------------+
3371 | localRtp\ | number| No | Local RTP octets lost |
3372 | OctetsLost | | | |
3373 +--------------+-------+----------+-------------------------------------------+
3374 | localRtp\ | number| No | Local RTP octets received |
3377 +--------------+-------+----------+-------------------------------------------+
3378 | localRtp\ | number| No | Local RTP octets sent |
3379 | OctetsSent | | | |
3380 +--------------+-------+----------+-------------------------------------------+
3381 | localRtp\ | number| No | Local RTP packets discarded |
3384 +--------------+-------+----------+-------------------------------------------+
3385 | localRtp\ | number| No | Local RTP packets lost |
3386 | PacketsLost | | | |
3387 +--------------+-------+----------+-------------------------------------------+
3388 | localRtp\ | number| No | Local RTP packets received |
3391 +--------------+-------+----------+-------------------------------------------+
3392 | localRtp\ | number| No | Local RTP packets sent |
3393 | PacketsSent | | | |
3394 +--------------+-------+----------+-------------------------------------------+
3395 | mosCqe | number| No | Decimal range from 1 to 5(1 decimal place)|
3396 +--------------+-------+----------+-------------------------------------------+
3397 | oneWayDelay | number| No | one-way path delay in milliseconds |
3398 +--------------+-------+----------+-------------------------------------------+
3399 | packet\ | number| No | Calculated percentage packet loss based on|
3400 | LossPercent | | | endpoint RTP packets lost (as reported in |
3401 | | | | RTCP) and local RTP packets sent. |
3402 | | | | Direction is based on endpoint description|
3403 | | | | (Caller, Callee). Decimal (2 decimal |
3405 +--------------+-------+----------+-------------------------------------------+
3406 | rFactor | number| No | rFactor from 0 to 100 |
3407 +--------------+-------+----------+-------------------------------------------+
3408 | round\ | number| No | Round trip delay in milliseconds |
3410 +--------------+-------+----------+-------------------------------------------+
3412 Datatype: voiceQualityFields
3413 *****************************
3415 The voiceQualityFields datatype provides statistics related to customer
3416 facing voice products; consists of the following fields:
3418 +--------------+-------------+----------+-------------------------------------+
3419 | Field | Type | Required?| Description |
3420 +==============+=============+==========+=====================================+
3421 | additional\ | hashMap | No | Additional voice quality fields |
3422 | Information | | | |
3423 +--------------+-------------+----------+-------------------------------------+
3424 | callee\ | string | Yes | Callee codec for the call |
3426 +--------------+-------------+----------+-------------------------------------+
3427 | caller\ | string | Yes | Caller codec for the call |
3429 +--------------+-------------+----------+-------------------------------------+
3430 | correlator | string | Yes | Constant across all events on this |
3432 +--------------+-------------+----------+-------------------------------------+
3433 | endOfCall\ | endOfCallVqm| No | End of call voice quality metric |
3434 | VqmSummaries | Summaries | | summaries |
3435 +--------------+-------------+----------+-------------------------------------+
3436 | phoneNumber | string | No | Phone number associated with the |
3437 | | | | correlator |
3438 +--------------+-------------+----------+-------------------------------------+
3439 | midCallRtcp | string | Yes | Base64 encoding of the binary RTCP |
3440 | | | | data (excluding Eth/IP/UDP headers) |
3441 +--------------+-------------+----------+-------------------------------------+
3442 | vendorNf\ | vendorNf | Yes | Vendor, NF and nfModule names |
3443 | NameFields | NameFields | | |
3444 +--------------+-------------+----------+-------------------------------------+
3445 | voiceQuality\| string | Yes | Version of the voiceQualityFields |
3446 | FieldsVersion| | | block as "#.#" where # is a digit; |
3447 | | | | see section 1 for the correct digits|
3449 +--------------+-------------+----------+-------------------------------------+
3454 RESTful Web Services Exceptions
3455 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3457 RESTful services generate and send exceptions to clients in response to
3458 invocation errors. Exceptions send HTTP status codes (specified later in
3459 this document for each operation). HTTP status codes may be followed by
3460 an optional JSON exception structure described below. Two types of
3461 exceptions may be defined: service exceptions and policy exceptions.
3463 +-----------+---------------+-------------+-----------------------------------+
3464 | Field Name| Data Type | Required? | Description |
3465 +===========+===============+=============+===================================+
3466 | messageId | xs:string | Yes | Unique message identifier of the |
3467 | | | | format ‘ABCnnnn’ where ‘ABC’ is |
3468 | | | | either ‘SVC’ for Service |
3469 | | | | Exceptions or ‘POL’ for Policy |
3470 | | | | Exception. |
3472 | | | | Exception numbers may be in the |
3473 | | | | range of 0001 to 9999 where : |
3475 | | | | - 0001 to 2999 are defined by OMA|
3476 | | | | (see OMA’s Common_definitions_ |
3477 | | | | for details) |
3479 | | | | - 3000-9999 are available and |
3481 +-----------+---------------+-------------+-----------------------------------+
3482 | text | xs:string | Yes | Message text, with replacement |
3483 | | | | variables marked with %n, where n |
3484 | | | | is an index into the list of |
3485 | | | | <variables> elements, starting at |
3487 +-----------+---------------+-------------+-----------------------------------+
3488 | variables | xs:string | No | List of zero or more strings that |
3489 | | [0..unbounded]| | represent the contents of the |
3490 | | | | variables used by the message text|
3491 +-----------+---------------+-------------+-----------------------------------+
3492 | url | xs:anyUrl | No | Hyperlink to a detailed error |
3493 | | | | resource (e.g., an HTML page for |
3494 | | | | browser user agents). |
3495 +-----------+---------------+-------------+-----------------------------------+
3500 When a service is not able to process a request, and retrying the
3501 request with the same information will also result in a failure, and
3502 the issue is not related to a service policy issue, then the service
3503 will issue a fault using the service exception fault message.
3504 Examples of service exceptions include invalid input, lack of
3505 availability of a required resource or a processing error.
3507 A service exception uses the letters 'SVC' at the beginning of the
3508 message identifier. ‘SVC’ service exceptions used by the VES Event
3509 Listener API are defined below.
3511 +----------+--------------+-----------------------+----------------+----------+
3512 | MessageId| Description | Text | Variables | Parent |
3513 | | / Comment | | | HTTP Code|
3514 +==========+==============+=======================+================+==========+
3515 | SVC0001 | General | <custom error message>| None | 400 |
3516 | | service error| | | |
3517 | | (see SVC2000)| | | |
3518 +----------+--------------+-----------------------+----------------+----------+
3519 | SVC0002 | Bad parameter| Invalid input value | %1: message | 400 |
3520 | | | for message part %1 | part | |
3521 +----------+--------------+-----------------------+----------------+----------+
3522 | SVC1000 | No server | No server resources | None | 500 |
3523 | | resources | available to process | | |
3524 | | | the request | | |
3525 +----------+--------------+-----------------------+----------------+----------+
3526 | SVC2000 | More | The following service | %1: human | 400 |
3527 | | elaborate | error occurred: %1. | readable | |
3528 | | version of | | description of | |
3529 | | SVC0001 | | the error | |
3531 | | | Error code is %2. | %2: error code | |
3532 +----------+--------------+-----------------------+----------------+----------+
3534 Table - Service Exceptions
3539 When a service is not able to complete because the request fails to
3540 meet a policy criteria, then the service will issue a fault using the
3541 policy exception fault message. To clarify how a policy exception
3542 differs from a service exception, consider that all the input to an
3543 operation may be valid as meeting the required input for the
3544 operation (thus no service exception), but using that input in the
3545 execution of the service may result in conditions that require the
3546 service not to complete. Examples of policy exceptions include
3547 privacy violations, requests not permitted under a governing service
3548 agreement or input content not acceptable to the service provider.
3550 A Policy Exception uses the letters 'POL' at the beginning of the
3551 message identifier. ‘POL’ policy exceptions used by the VES Event
3552 Listener API are defined below.
3554 +----------+---------------+-----------------------+---------------+----------+
3555 | MessageId| Description |Text | Variables | Parent |
3556 | | / Comment | | | HTTP Code|
3557 +==========+===============+=======================+===============+==========+
3558 | POL0001 | General policy| A policy error | None | 401 |
3559 | | error (see | occurred. | | |
3560 | | POL2000) | | | |
3561 +----------+---------------+-----------------------+---------------+----------+
3562 | POL1009 | User not | User has not been | None | 401 |
3563 | | provisioned | provisioned for | | |
3564 | | for service | service | | |
3565 +----------+---------------+-----------------------+---------------+----------+
3566 | POL1010 | User suspended| User has been | None | 401 |
3567 | | from service | suspended from service| | |
3568 +----------+---------------+-----------------------+---------------+----------+
3569 | POL2000 | More elaborate| The following policy | %1: human | 401 |
3570 | | version of | error occurred: %1. | readable | |
3571 | | POL0001 | Error code is %2. | description of| |
3572 | | | | the error | |
3574 | | | | %2: error code| |
3575 +----------+---------------+-----------------------+---------------+----------+
3576 | POL9003 | Message size | Message content size | None | 400 |
3577 | | exceeds limit | exceeds the allowable | | |
3579 +----------+---------------+-----------------------+---------------+----------+
3581 Table - Policy Exceptions
3583 RESTful Web Services Definition
3584 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3586 REST Operation Overview
3587 ~~~~~~~~~~~~~~~~~~~~~~~~~
3589 REST Operation Summary
3590 +++++++++++++++++++++++
3592 +---------------------+---------+------------------------------------------+
3593 | **Operation Action**| **HTTP**| Resource URL relative to {ServerRoot}\ |
3594 | | | , which is defined in section 3 |
3596 +---------------------+---------+------------------------------------------+
3597 | publishAnyEvent | POST | /eventListener/v{apiVersion} |
3598 +---------------------+---------+------------------------------------------+
3599 | publishEventBatch | POST | /eventListener/v{apiVersion}/eventBatch |
3600 +---------------------+---------+------------------------------------------+
3602 Table - REST Operation Summary
3607 ``apiVersion`` is used to describe the major version number of the event
3608 listener API (which is the same as the major version number of this
3609 specification). When this number changes, the implication is: the new
3610 major version will break clients of older major versions in some way, if
3611 they try to use the new API without modification (e.g., unmodified v1
3612 clients would not be able to use v2 without error).
3614 The Event Listener shall provide the following HTTP headers in response
3615 to all requests. Additionally, clients may populate these headers on
3616 requests to indicate the specific version they are interested in.
3622 - X-LatestVersion: 7.1
3624 If a client requests major version 7 (per the REST resource URL) and
3625 does not specify the above headers, then they will be provided with the
3626 latest patch version of 7.0.x (which is 7.0.1). If the client wants a
3627 minor version of major version 7, then they need to supply
3628 the X-MinorVersion header with their request. For example, if they
3629 request major version 7 with X-MinorVersion: 1, they will get the latest
3630 patch version of 7.1, which is 7.1.1.
3635 ``{ServerRoot}`` is defined in section 3 of this document, which defines the
3636 REST resource URL. One or more FQDNs may be provisioned in an event source
3637 when it is instantiated or updated. If an event source is unable to reach any
3638 of the provisioned FQDNs, it should buffer the event data specified below, up
3639 to a maximum of 1 hour, and re-transmit them once a connection has been
3642 The following events should be buffered:
3644 * Faults with eventSeverity of ``MINOR``, ``MAJOR``, ``NORMAL``, or ``CRITICAL``
3645 with following expected behavior:
3647 * NF keeps a First-In-First-Out buffer.
3648 * Until the collectors are working again, it is desired that the NF sends
3649 the final state events only, and not intermediate ones. However, it is
3650 acceptable to buffer all events and send them over to the collector in
3651 the same order in which they were generated/received.
3653 * When one VES Event Listener connectivity is re-established, NF should first
3654 send the buffered events and then start sending the new events.
3656 * Syslog with syslogSev of ``Emergency``, ``Alert``, ``Critical``,
3657 ``Error``, or ``Warning``
3659 * All measurements events
3661 publishEventBatch Requirements
3662 ******************************
3664 Buffered events can be sent in batch using ``publishEventBatch``. However, a
3665 NF vendor must only include multiple events for the same domain in the
3666 ``publishEventBatch``. The ``publishEventBatch`` event must also conform to
3669 ``publishEventBatch`` events are handled similarly to a single event. The
3670 acknowledgement from the VES Event Listener is for the ``publishEventBatch`` and
3671 not individual events within the ``publishEventBatch``.
3676 NFs acting as event sources should not send syslog events to the
3677 VES Event Listener during debug mode, but should store syslog events locally
3678 for access, and possible FTP transfer, via the NF console (e.g., command line
3686 The maximum allowed message size is 2 megabytes of uncompressed text.
3687 However,messages of this size have been known to cause performance and data
3688 loss. It is strongly recommended,that messages not exceed 1 megabyte.
3689 In a future version of the specification, a 1 megabyte limit will become
3690 a mandatory requirement.
3692 Operation: publishAnyEvent
3693 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
3696 +++++++++++++++++++++
3698 Allows authorized clients to publish any single event to the VES event
3701 - Supports only HTTPS access.
3703 - Uses the HTTP verb POST
3705 - Supports JSON content types
3707 - Provides HTTP response codes as well as Service and Policy error
3713 .. figure:: publish-event-flow.png
3714 :alt: publishAnyEvent Call Flow
3716 ``publishAnyEvent`` Call Flow
3721 Header Fields (note: all parameter names shall be treated as
3724 +---------------+----------+----------+---------------------------------------+
3725 | Parameter | Data Type| Required?| Brief description |
3726 +---------------+----------+----------+---------------------------------------+
3727 | Accept | string | No | Determines the format of the body of |
3728 | | | | the response. Valid values are: |
3730 | | | | - application/json |
3731 +---------------+----------+----------+---------------------------------------+
3732 | Authorization | string | Yes | The username and password are formed |
3733 | | | | into one string as |
3734 | | | | ``username:password``. This string is |
3735 | | | | then Base64 encoded to produce the |
3736 | | | | encoded credential which is |
3737 | | | | communicated in the header after the |
3738 | | | | string "Authorization: Basic ". See |
3739 | | | | examples below. If the Authorization |
3740 | | | | header is missing, then an HTTP 400 |
3741 | | | | Invalid Request message shall be |
3742 | | | | returned. If the string supplied is |
3743 | | | | invalid, then an HTTP 401 Unauthorized|
3744 | | | | message shall be returned. |
3745 +---------------+----------+----------+---------------------------------------+
3746 | Content-length| integer | No | Note that content length is limited to|
3747 | | | | 2 Megabyte (see :ref:`msg-size`) |
3748 +---------------+----------+----------+---------------------------------------+
3749 | Content-type | string | Yes | Must be set to one of the following |
3752 | | | | - application/json |
3753 +---------------+----------+----------+---------------------------------------+
3754 | X-MinorVersion| integer | No | The minor version of the API requested|
3755 | | | | by the client |
3756 +---------------+----------+----------+---------------------------------------+
3757 | X-PatchVersion| integer | No | The patch version of the API requested|
3758 | | | | by the client |
3759 +---------------+----------+----------+---------------------------------------+
3760 | X-Latest\ | string | No | The full version of the API requested |
3761 | Version | | | by the client expressed as |
3762 | | | | {major}.{minor}.{patch} |
3763 +---------------+----------+----------+---------------------------------------+
3767 +--------------+--------------+--------------+-------------------------------+
3768 | **Parameter**| **Data Type**| **Required?**| **Brief description** |
3769 +--------------+--------------+--------------+-------------------------------+
3770 | Event | event | Yes | Contains the JSON structure of|
3771 | | | | the common event format. |
3772 +--------------+--------------+--------------+-------------------------------+
3779 +----------------+--------------+--------------+------------------------------+
3780 | **Parameter** | **Data Type**| **Required?**| **Brief description** |
3781 +----------------+--------------+--------------+------------------------------+
3782 | Content-length | integer | No | Used only in error conditions|
3783 +----------------+--------------+--------------+------------------------------+
3784 | Content-type | string | No | Used only in error conditions|
3785 +----------------+--------------+--------------+------------------------------+
3786 | Date | datetime | No | Date time of the response in |
3788 +----------------+--------------+--------------+------------------------------+
3789 | X-MinorVersion | integer | Yes | The minor version of the API |
3791 +----------------+--------------+--------------+------------------------------+
3792 | X-PatchVersion | integer | Yes | The patch version of the API |
3794 +----------------+--------------+--------------+------------------------------+
3795 | X-LatestVersion| string | Yes | The full version of the API |
3796 | | | | service expressed as {major}.|
3797 | | | | {minor}.{patch} |
3798 +----------------+--------------+--------------+------------------------------+
3800 Body Fields (for success responses): no content is provided.
3802 Body Fields (for error responses):
3804 +--------------+--------------+----------------+------------------------------+
3805 | **Parameter**| **Data Type**| **Required?** | **Brief description** |
3806 +--------------+--------------+----------------+------------------------------+
3807 | requestError | requestError | Yes(for errors)| Used only in error conditions|
3808 +--------------+--------------+----------------+------------------------------+
3813 +-----+--------------+--------------------------------------------------------+
3814 | Code| Reason Phrase| Description |
3815 +=====+==============+========================================================+
3816 | 202 | Accepted | The request has been accepted for processing |
3817 +-----+--------------+--------------------------------------------------------+
3818 | 400 | Bad Request | Many possible reasons not specified by the other codes |
3819 | | | (e.g., missing required parameters or incorrect format)|
3820 | | | . The response body may include a further exception |
3821 | | | code and text. HTTP 400 errors may be mapped to SVC0001|
3822 | | | (general service error), SVC0002 (bad parameter), |
3823 | | | SVC2000 (general service error with details) or PO9003 |
3824 | | | (message content size exceeds the allowable limit). |
3825 +-----+--------------+--------------------------------------------------------+
3826 | 401 | Unauthorized | Authentication failed or was not provided. HTTP 401 |
3827 | | | errors may be mapped to POL0001 (general policy error) |
3828 | | | or POL2000 (general policy error with details). |
3829 +-----+--------------+--------------------------------------------------------+
3830 | 404 | Not Found | The server has not found anything matching the |
3831 | | | Request-URI. No indication is given of whether the |
3832 | | | condition is temporary or permanent. |
3833 +-----+--------------+--------------------------------------------------------+
3834 | 405 | Method Not | A request was made of a resource using a request method|
3835 | | Allowed | not supported by that resource (e.g., using PUT on a |
3836 | | | REST resource that only supports POST). |
3837 +-----+--------------+--------------------------------------------------------+
3838 | 500 | Internal | The server encountered an internal error or timed out; |
3839 | | Server Error | please retry (general catch-all server-side error).HTTP|
3840 | | | 500 errors may be mapped to SVC1000 (no server |
3842 +-----+--------------+--------------------------------------------------------+
3844 Sample Request and Response
3845 ++++++++++++++++++++++++++++
3850 .. code-block:: http
3852 POST /eventListener/v7 HTTP/1.1
3853 Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
3854 content-type: application/json
3855 content-length: 12345
3860 "commonEventHeader": {
3862 "vesEventListenerVersion": "7.1.1",
3864 "eventName": "Fault_Vscf:Acs-Ericcson_PilotNumberPoolExhaustion",
3865 "eventId": "fault0000245",
3868 "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234",
3869 "reportingEntityName": "ibcx0001vm002oam001",
3870 "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014",
3871 "sourceName": "scfx0001vm002cap001",
3872 "nfVendorName": "Ericsson",
3873 "nfNamingCode": "scfx",
3874 "nfcNamingCode": "ssc",
3875 "startEpochMicrosec": 1413378172000000,
3876 "lastEpochMicrosec": 1413378172000000,
3877 "timeZoneOffset": "UTC-05:30"
3880 "faultFieldsVersion": 4.0,
3881 "alarmCondition": "PilotNumberPoolExhaustion",
3882 "eventSourceType": "other",
3883 "specificProblem": "Calls cannot complete - pilot numbers are unavailable",
3884 "eventSeverity": "CRITICAL",
3885 "vfStatus": "Active",
3886 "alarmAdditionalInformation": {
3887 "PilotNumberPoolSize": "1000"
3895 Sample Success Response
3896 ************************
3898 .. code-block:: http
3900 HTTPS/1.1 202 Accepted
3903 X-LatestVersion: 7.1.1
3905 Sample Error Responses
3906 ************************
3908 Sample Policy Exception
3909 """"""""""""""""""""""""
3911 .. code-block:: http
3913 HTTPS/1.1 400 Bad Request
3914 content-type: application/json
3915 content-length: 12345
3916 Date: Thu, 04 Jun 2009 02:51:59 GMT
3919 X-LatestVersion: 7.1.1
3923 "policyException": {
3924 "messageId": "POL9003",
3925 "text": "Message content size exceeds the allowable limit",
3931 Sample Service Exception
3932 """""""""""""""""""""""""
3934 .. code-block:: http
3936 HTTPS/1.1 400 Bad Request
3937 content-type: application/json
3938 content-length: 12345
3939 Date: Thu, 04 Jun 2009 02:51:59 GMT
3942 X-LatestVersion: 7.1.1
3946 "serviceException": {
3947 "messageId": "SVC2000",
3948 "text": "Missing Parameter: %1. Error code is %2"
3957 Operation: publishEventBatch
3958 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3963 Allows authorized clients to publish a batch of events to the VES event
3966 - Supports only HTTPS access.
3968 - Uses the HTTP verb POST
3970 - Supports JSON content types
3972 - Provides HTTP response codes as well as Service and Policy error
3978 .. figure:: publish-event-flow.png
3979 :alt: publishEvent Call Flow
3981 ``publishEventBatch`` Call Flow
3986 Header Fields (note: all parameter names shall be treated as
3989 +---------------+----------+----------+---------------------------------------+
3990 | Parameter | Data Type| Required?| Brief description |
3991 +---------------+----------+----------+---------------------------------------+
3992 | Accept | string | No | Determines the format of the body of |
3993 | | | | the response. Valid values are: |
3995 | | | | - application/json |
3996 +---------------+----------+----------+---------------------------------------+
3997 | Authorization | string | No | The username and password are formed |
3998 | | | | into one string as "username:password"|
3999 | | | | . This string is then Base64 encoded |
4000 | | | | to produce the encoded credential |
4001 | | | | which is communicated in the header |
4002 | | | | after the string "Authorization: |
4003 | | | | Basic". See examples below. If the |
4004 | | | | Authorization header is missing, then |
4005 | | | | an HTTP 400 Invalid Request message |
4006 | | | | shall be returned. If the string |
4007 | | | | supplied is invalid, then an HTTP 401 |
4008 | | | | Unauthorized message shall be |
4010 +---------------+----------+----------+---------------------------------------+
4011 | Content-length| integer | No | Note that content length is limited to|
4012 | | | | 2 megabyte (see :ref:`msg-size`). |
4013 +---------------+----------+----------+---------------------------------------+
4014 | Content-type | string | Yes | Must be set to one of the following |
4017 | | | | - application/json |
4018 +---------------+----------+----------+---------------------------------------+
4019 | X-MinorVersion| integer | No | The minor version of the API requested|
4020 | | | | by the client |
4021 +---------------+----------+----------+---------------------------------------+
4022 | X-PatchVersion| integer | No | The patch version of the API requested|
4023 | | | | by the client |
4024 +---------------+----------+----------+---------------------------------------+
4025 | X-Latest\ | string | No | The full version of the API requested |
4026 | Version | | | by the client expressed as |
4027 | | | | {major}.{minor}.{patch} |
4028 +---------------+----------+----------+---------------------------------------+
4032 +--------------+--------------+--------------+-------------------------------+
4033 | **Parameter**| **Data Type**| **Required?**| **Brief description** |
4034 +--------------+--------------+--------------+-------------------------------+
4035 | eventList | eventList | Yes | Array of events conforming to |
4036 | | | | the common event format. |
4037 +--------------+--------------+--------------+-------------------------------+
4044 +----------------+--------------+--------------+------------------------------+
4045 | **Parameter** | **Data Type**| **Required?**| **Brief description** |
4046 +----------------+--------------+--------------+------------------------------+
4047 | Content-length | integer | No | Used only in error conditions|
4048 +----------------+--------------+--------------+------------------------------+
4049 | Content-type | string | No | Used only in error conditions|
4050 +----------------+--------------+--------------+------------------------------+
4051 | Date | datetime | No | Date time of the response in |
4053 +----------------+--------------+--------------+------------------------------+
4054 | X-MinorVersion | integer | Yes | The minor version of the API |
4056 +----------------+--------------+--------------+------------------------------+
4057 | X-PatchVersion | integer | Yes | The patch version of the API |
4059 +----------------+--------------+--------------+------------------------------+
4060 | X-LatestVersion| string | Yes | The full version of the API |
4061 | | | | service expressed as |
4062 | | | | {major}.{minor}.{patch} |
4063 +----------------+--------------+--------------+------------------------------+
4065 Body Fields (for success responses: no content is provided.
4067 Body Fields (for error responses):
4069 +--------------+--------------+----------------+------------------------------+
4070 | **Parameter**| **Data Type**| **Required?** | **Brief description** |
4071 +--------------+--------------+----------------+------------------------------+
4072 | requestError | requestError | Yes(for errors)| Used only in error conditions|
4073 +--------------+--------------+----------------+------------------------------+
4078 +-----+--------------+--------------------------------------------------------+
4079 | Code| Reason Phrase| Description |
4080 +=====+==============+========================================================+
4081 | 202 | Accepted | The request has been accepted for processing |
4082 +-----+--------------+--------------------------------------------------------+
4083 | 400 | Bad Request | Many possible reasons not specified by the other codes |
4084 | | | (e.g., missing required parameters or incorrect format)|
4085 | | | . The response body may include a further exception |
4086 | | | code and text. HTTP 400 errors may be mapped to SVC0001|
4087 | | | (general service error), SVC0002 (bad parameter), |
4088 | | | SVC2000 (general service error with details) or PO9003 |
4089 | | | (message content size exceeds the allowable limit). |
4090 +-----+--------------+--------------------------------------------------------+
4091 | 401 | Unauthorized | Authentication failed or was not provided. HTTP 401 |
4092 | | | errors may be mapped to POL0001 (general policy error) |
4093 | | | or POL2000 (general policy error with details). |
4094 +-----+--------------+--------------------------------------------------------+
4095 | 404 | Not Found | The server has not found anything matching the |
4096 | | | Request-URI. No indication is given of whether the |
4097 | | | condition is temporary or permanent. |
4098 +-----+--------------+--------------------------------------------------------+
4099 | 405 | Method Not | A request was made of a resource using a request method|
4100 | | Allowed | not supported by that resource (e.g., using PUT on a |
4101 | | | REST resource that only supports POST). |
4102 +-----+--------------+--------------------------------------------------------+
4103 | 500 | Internal | The server encountered an internal error or timed out; |
4104 | | Server Error | please retry (general catch-all server-side error).HTTP|
4105 | | | 500 errors may be mapped to SVC1000 (no server |
4107 +-----+--------------+--------------------------------------------------------+
4109 Sample Request and Response
4110 +++++++++++++++++++++++++++++
4115 .. code-block:: http
4117 POST /eventListener/v7/eventBatch HTTP/1.1
4118 Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
4119 content-type: application/json
4120 content-length: 12345
4126 "commonEventHeader": {
4128 "vesEventListenerVersion": "7.1.1",
4130 "eventName": "Fault_Vscf:Acs-Ericcson_PilotNumberPoolExhaustion",
4131 "eventId": "fault0000250",
4134 "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234",
4135 "reportingEntityName": "ibcx0001vm002oam0011234",
4136 "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014",
4137 "sourceName": "scfx0001vm002cap001",
4138 "nfVendorName": "Ericsson",
4139 "nfNamingCode": "scfx",
4140 "nfcNamingCode": "ssc",
4141 "startEpochMicrosec": 1413378172000000,
4142 "lastEpochMicrosec": 1413378172000000,
4143 "timeZoneOffset": "UTC-05:30"
4146 "faultFieldsVersion": 4.0,
4147 "alarmCondition": "PilotNumberPoolExhaustion",
4148 "eventSourceType": "other",
4149 "specificProblem": "Calls cannot complete - pilot numbers are unavailable",
4150 "eventSeverity": "CRITICAL",
4151 "vfStatus": "Active",
4152 "alarmAdditionalInformation": {
4153 "PilotNumberPoolSize": "1000"
4158 "commonEventHeader": {
4160 "vesEventListenerVersion": "7.1.1",
4162 "eventName": " Fault_Vscf:Acs-Ericcson_RecordingServerUnreachable",
4163 "eventId": "fault0000251",
4166 "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234",
4167 "reportingEntityName": "ibcx0001vm002oam0011234",
4168 "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014",
4169 "sourceName": "scfx0001vm002cap001",
4170 "nfVendorName": "Ericsson",
4171 "nfNamingCode": "scfx",
4172 "nfcNamingCode": "ssc",
4173 "startEpochMicrosec": 1413378172000010,
4174 "lastEpochMicrosec": 1413378172000010,
4175 "timeZoneOffset": "UTC-05:30"
4178 "faultFieldsVersion": 4.0,
4179 "alarmCondition": "RecordingServerUnreachable",
4180 "eventSourceType": "other",
4181 "specificProblem": "Recording server unreachable",
4182 "eventSeverity": "CRITICAL",
4183 "vfStatus": "Active"
4189 Sample Success Response
4190 *************************
4192 .. code-block:: http
4194 HTTPS/1.1 202 Accepted
4197 X-LatestVersion: 7.1.1
4199 Sample Error Responses
4200 ************************
4202 Sample Policy Exception
4203 """"""""""""""""""""""""
4205 .. code-block:: http
4207 HTTPS/1.1 400 Bad Request
4208 content-type: application/json
4209 content-length: 12345
4210 Date: Thu, 04 Jun 2009 02:51:59 GMT
4213 X-LatestVersion: 7.1.1
4217 "policyException": {
4218 "messageId": "POL9003",
4219 "text": "Message content size exceeds the allowable limit",
4226 Sample Service Exception
4227 """""""""""""""""""""""""
4229 .. code-block:: http
4231 HTTPS/1.1 400 Bad Request
4232 content-type: application/json
4233 content-length: 12345
4234 Date: Thu, 04 Jun 2009 02:51:59 GMT
4237 X-LatestVersion: 7.1.1
4241 "serviceException": {
4242 "messageId": "SVC2000",
4243 "text": "Missing Parameter: %1. Error code is %2"
4256 Terminology used in this document is summarized below:
4258 **A&AI**. Active & Available Inventory is the ONAP component that
4259 provides data views of Customer Subscriptions, Products, Services,
4260 Resources, and their relationships.
4262 **Alarm Condition**. Short name of the alarm condition/problem, such as
4265 **APPC (formerly APP-C)**. Application Controller. Handles the life
4266 cycle management of Virtual Network Functions (VNFs).
4268 **ASDC**. AT&T Service Design and Creation Platform: the original name
4269 for the SDC. Replaced by SDC.
4271 **Common Event Format**. A JSON schema describing events sent to the VES
4274 **Common Event Header**. A component of the Common Event Format JSON
4275 structure. This datatype consists of fields common to all events.
4277 **DCAE**. Data Collection Analysis and Events. DCAE is the ONAP
4278 subsystem that supports closed loop control and higher-level correlation
4279 for business and operations activities. DCAE collects performance,
4280 usage, and configuration data, provides computation of analytics, aids
4281 in trouble-shooting and management, and publishes event, data, and
4282 analytics to the rest of the ONAP system for FCAPS functionality.
4284 **DMaaP.** Data Movement as a Platform. A set of common services
4285 provided by ONAP, including a Message Router, Data Router, and a Data
4288 **Domain**. In VES, an event ‘domain’ identifies a broad category of
4289 events (e.g., ‘fault’ or ‘measurement’), each of which is associated
4290 with a VES domain field block, which is sent with the commonEventHeader
4291 when events of that category are generated.
4293 **Epoch**. The number of seconds that have elapsed since
4294 00:00:00 \ `Coordinated Universal
4295 Time <https://en.wikipedia.org/wiki/Coordinated_Universal_Time>`__ (UTC),
4296 Thursday, 1 January 1970. Every day is treated as if it contains exactly
4297 86400 seconds, so \ `leap
4298 seconds <https://en.wikipedia.org/wiki/Leap_second>`__ are not applied
4299 to seconds since the Epoch. In VES Epoch times are measured in
4302 **Event.** A well-structured packet of network management information
4303 identified by an eventName which is asynchronously communicated to one
4304 or more instances of an Event Listener service to subscribers interested
4305 in that eventName. Events can convey measurements, faults, syslogs,
4306 threshold crossing alerts, and others types of information.
4308 **Event Id**. Event key that is unique to the event source. The key must
4309 be unique within notification life cycle similar to EventID from 3GPP.
4310 It could be a sequential number, or a composite key formed from the
4311 event fields, such as sourceName\_alarmCondition\_startEpoch. The
4312 eventId should not include whitespace. For fault events, eventId is the
4313 eventId of the initial alarm; if the same alarm is raised again for
4314 changed, acknowledged or cleared cases, eventId must be the same as the
4315 initial alarm (along with the same startEpochMicrosec and an incremental
4318 **Event Name**. Identifier for specific types of events. Specific
4319 eventNames registered by the YAML may require that certain fields, which
4320 are optional in the Common Event Format, be present when events with
4321 that eventName are published.
4323 **Event Streaming**. The delivery of network management event
4324 information in real time.
4326 **Extensible Data Structures**. Data structures (e.g., hashMap) that
4327 allow event sources to send information not specifically identified in
4330 **Hash Map**. A hash table, or data structure, used to implement an
4331 associative array, a structure than can map keys to values. In VES 6.0,
4332 all name-value pair structures were changed to hash maps (i.e., {‘name’:
4333 ‘keyName’, ‘value’: ‘keyValue’} was replaced with {‘keyName’:
4336 **ICE**. Incubation and Certification Environment. Facilitates vendors
4337 and third-party in developing virtual network functions using ONAP and a
4340 **IPMI**. The `Intelligent Platform Management
4341 Interface <https://en.wikipedia.org/wiki/Intelligent_Platform_Management_Interface>`__.
4343 **JSON**. Java Script Object Notation. JSON is an
4344 `open-standard <https://en.wikipedia.org/wiki/Open_standard>`__ `file
4345 format <https://en.wikipedia.org/wiki/File_format>`__ that uses
4346 `human-readable <https://en.wikipedia.org/wiki/Human-readable_medium>`__
4347 text to transmit data objects consisting of `attribute–value
4348 pairs <https://en.wikipedia.org/wiki/Attribute%E2%80%93value_pair>`__
4349 and `array data types <https://en.wikipedia.org/wiki/Array_data_type>`__
4351 `serializable <https://en.wikipedia.org/wiki/Serialization>`__ value).
4352 It is a very common `data <https://en.wikipedia.org/wiki/Data>`__ format
4354 `asynchronous <https://en.wikipedia.org/wiki/Asynchronous_I/O>`__
4355 browser–server communication.
4357 **NF**. Network Function. Generalized name for a VNF or PNF.
4359 **NFC**. Network Function Component. Generalized name for a VNFC or a
4362 **ONAP**. `Open Network Automation Platform <https://www.onap.org/>`__.
4364 **PNF**. Physical Network Function.
4366 **Policy**. Course of action for the management of the network. The ONAP
4367 Policy Framework is a comprehensive policy design, deployment, and
4368 execution environment. The Policy Framework is the ***decision making***
4369 component in `an ONAP
4370 system <https://www.onap.org/wp-content/uploads/sites/20/2017/12/ONAP_CaseSolution_Architecture_120817_FNL.pdf>`__.
4371 It allows you to specify, deploy, and execute the governance of the
4372 features and functions in your ONAP system, be they closed loop,
4373 orchestration, or more traditional open loop use case implementations.
4374 The Policy Framework is the component that is the source of truth for
4375 all policy decisions.
4377 **Reporting Entity Name**. Name of the entity reporting the event or
4378 detecting a problem in another vnf/vm or pnf which is experiencing the
4379 problem. May be the same as the sourceName. Not used for performance
4380 measurements currently.
4382 **SDC**. Service Design and Creation Platform: The ONAP visual modeling
4383 and design tool. It creates internal metadata that describes assets used
4384 by all ONAP components, both at design time and run time. The SDC
4385 manages the content of a catalog, and assemblies of selected catalog to
4386 define how and when VNFs are realized in a target environment.
4388 **Source Name**: Name of the entity experiencing the event issue, which
4389 may be detected and reported by a separate reporting entity. The
4390 sourceName identifies the device for which data is collected. A valid
4391 sourceName must be inventoried in A&AI.
4393 **Specific Problem**. Description of the alarm or problem.
4395 **VES**. Virtual Function Event Stream. In 6.0, the definition of VES
4396 was expanded to include event streaming for VNF, PNF and infrastructure.
4397 The VES Event Listener can receive any event sent in the VES Common
4400 **VES Event Listener**. A RESTful connectionless push event listener
4401 capable of receiving single events or batches of events sent in the
4402 Common Event Format.
4404 **VM**. Virtual Machine.
4406 **VNF**. Virtual Network Function. A VNF is a virtualized task formerly
4407 carried out by proprietary, dedicated network hardware. (Examples:
4408 virtual firewall, virtual DNS). A VNF can also be defined as a specific
4409 kind of Vendor Software Product.
4411 **YAML**. A `data serialization
4412 language <https://en.wikipedia.org/wiki/Data_serialization_language>`__
4413 and superset of JSON.
4415 **VNFC**. Virtual Network Function Component. A VNFC is a part of a VNF.
4416 It is a stand-alone executable that is loosely-coupled, granular,
4417 re-usable, and responsible for a single capability.
4419 Appendix: Historical Change Log
4420 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4422 For the latest changes, see the Change Block just before the Table of
4425 +-----------+---------+-------------------------------------------------------+
4426 | Date | Revision| Description |
4427 +-----------+---------+-------------------------------------------------------+
4428 | 5/22/2015 | 0.1 | Initial Release - Draft |
4429 +-----------+---------+-------------------------------------------------------+
4430 | 5/29/2015 | 0.2 | - Introduction: removed all system names and |
4431 | | | references to internal AT&T components |
4433 | | | - Security: changed ‘event publisher’ to |
4434 | | | ‘event source’ |
4436 | | | - Generic Event Format: updated the JSON schema per |
4439 | | | - eventHeader: clarified the description of id, made |
4440 | | | sourceId a required field, changed the datatype of |
4441 | | | timestamps to timestamp [ ] |
4443 | | | - performanceFields: removed overflowFields |
4445 | | | - tmestamp: added a description of this datatype |
4447 | | | - Exceptions: fixed indentation of sections |
4449 | | | - Approvers: updated the list of approvers and added |
4451 +-----------+---------+-------------------------------------------------------+
4452 | 6/3/2015 | 0.3 | - Updated the security section to use HTTP Basic |
4453 | | | Authentication per AT&T REST standards. Updated the|
4454 | | | input parameters and messaging examples to use the |
4455 | | | new security scheme. |
4456 +-----------+---------+-------------------------------------------------------+
4457 | 6/5/2015 | 0.4 | - Added otherFields sub section to the defined |
4460 | | | - Added locale field to the eventHeader. |
4461 +-----------+---------+-------------------------------------------------------+
4462 | 6/5/2015 | 0.5 | - Updated the embedded event format json schema to |
4463 | | | match the changes made in v0.4 |
4464 +-----------+---------+-------------------------------------------------------+
4465 | 6/10/2015 | 0.6 | - Updated the {ServerRoot} format to contain an |
4466 | | | optional routing path (for D2 service modules). |
4467 +-----------+---------+-------------------------------------------------------+
4468 | 7/7/2015 | 0.7 | Common Event Format updates: |
4470 | | | - EventHeader: added ‘measurement’ to the ‘domain’ |
4471 | | | enumeration; changed ‘locale’ to ‘location’ and |
4472 | | | clarified in the description that this should be a |
4475 | | | - Added a MeasurementFields datatype, which required |
4476 | | | the addition of the following datatypes: |
4477 | | | codecsInUse, cpuUsage, diskUsage, featuresInUse, |
4479 +-----------+---------+-------------------------------------------------------+
4480 | 7/15/2015 | 1.0 | - Changed sourceInstance in the eventHeader to be an |
4481 | | | array of name value pairs |
4483 | | | - Changed the performanceFields block to |
4484 | | | thresholdCrossingAlertFields. Updated the domain |
4485 | | | field of the eventHeader to match. |
4486 +-----------+---------+-------------------------------------------------------+
4487 | 7/23/2015 | v1.1 | Changes to eventHeader data format: |
4489 | | | - moved sourceInstance to internalHeaderFields |
4491 | | | - moved serviceInstanceId to internalHeaderFields |
4493 | | | - moved productId to internalHeaderFields |
4495 | | | - moved subscriberId to internalHeaderFields |
4497 | | | - moved location to internalHeaderFields |
4499 | | | - added the following new fields in |
4500 | | | internalHeaderFields: policyType, policyName, |
4501 | | | correlationEventType, correlationType, |
4502 | | | correlationName, correlationRootEventId |
4504 | | | Changes to faultFields data format: |
4506 | | | - moved the eventSourceDeviceDescription to |
4507 | | | internalFaultFields and renamed it |
4508 | | | equipmentVendorModel |
4510 | | | - moved eventSourceHostname to internalFaultFields |
4512 | | | - changed alarmObjectInterface to alarmInterfaceA |
4514 | | | - changed alarmRemoteObject to alarmRemoteObjectZ and|
4515 | | | moved it to internalFaultFields |
4517 | | | - changed alarmRemoteObjectInterface to |
4518 | | | alarmInterfaceZ and moved it to internalFaultFields|
4520 | | | Changes to thresholdCrossingFields data format: |
4522 | | | - changed several references from the old |
4523 | | | ‘performanceFields’ block to the new |
4524 | | | ‘thresholdCrossingFields’ block |
4528 | | | - Fixed several comma and colon syntax errors in the |
4529 | | | JSON schema as detected by a JSON schema syntax |
4531 +-----------+---------+-------------------------------------------------------+
4532 | 8/11/2015 | v1.2 | Timestamp format: |
4534 | | | - Section 4.18: added a note in the datetime field of|
4535 | | | the Timestamp datatype specifying the (GMT) format |
4538 | | | - Updated the JSON schema with the same information |
4540 | | | Event Header Severity Enumeration: |
4542 | | | - Section 4.8: modified the severity enumeration to |
4543 | | | remove the numbers in parentheses that followed the|
4544 | | | names. The names were not changed. |
4546 | | | - Updated the JSON schema with the same information. |
4547 +-----------+---------+-------------------------------------------------------+
4548 | 8/20/2015 | v1.3 | JSON Schema rev’d to v9: |
4550 | | | - Alphabetized all fields in the JSON schema |
4552 | | | - Fixed the way arrays were specified (JSON schema |
4553 | | | syntax issue) |
4555 | | | Sample Responses: |
4557 | | | - 2.1.1.1: alphabetized fields, fixed timestamps |
4558 | | | array depiction, fixed severity enum value to |
4559 | | | conform to latest format |
4561 | | | - 6.2.6.1: alphabetized fields, fixed timestamps |
4562 | | | array depiction, fixed severity enum value to |
4563 | | | conform to latest format |
4565 | | | - 6.3.6.1: alphabetized fields, fixed timestamps |
4566 | | | array depiction, fixed severity enum value to |
4567 | | | conform to latest format |
4569 | | | - 6.4.6.1: alphabetized fields, fixed timestamps |
4570 | | | array depiction, fixed eventList array depection, |
4571 | | | fixed severity enum value to conform to latest |
4573 +-----------+---------+-------------------------------------------------------+
4574 | 9/16/2015 | v1.4 | JSON Schema rev’d to v10: |
4576 | | | - Fixed an error in the way that the top level |
4577 | | | "event" object was specified in the v9 json schema. |
4578 | | | This was discovered when validating examples |
4579 | | | against the schema using this site: |
4580 | | | http://json-schema-validator.herokuapp.com/index.jsp|
4582 | | | - Changed the embedded json file in section 4 |
4584 | | | Sample Responses: |
4586 | | | - Removed an extra comma after the timestamp brace in |
4587 | | | section 6.2.6 and 6.3.6. |
4588 +-----------+---------+-------------------------------------------------------+
4589 | 11/11/2015| v1.5 | Section 4 was the only section changed: JSON Schema |
4590 | | | rev’d to v11 and Datatype tables were updated to match|
4591 | | | . Numerous data structure changes were made based on |
4592 | | | VNF vendor proof of concept feedback. Modified sample |
4593 | | | requests and responses to match. |
4594 +-----------+---------+-------------------------------------------------------+
4595 | 11/12/2015| v1.6 | - The internalFaultFields were merged into the |
4596 | | | internalHeaderFields; then the internalFaultFields |
4597 | | | datatype was deleted. |
4599 | | | - Updated the JSON schema to v12. |
4601 | | | - Also corrected some background color issues in the |
4602 | | | sample requests and responses. |
4603 +-----------+---------+-------------------------------------------------------+
4604 | 1/18/2016 | v1.7 | - Section 2 changes: updated the sample request to |
4605 | | | conform with the changes below |
4607 | | | - Section 4 datatype changes: |
4609 | | | - Changed 'eventHeader' to 'commonEventHeader' |
4611 | | | - Moved 'eventSeverity' from the 'commonEventHeader' |
4612 | | | to 'faultFields' |
4614 | | | - Added 'priority' to 'commonEventHeader' |
4616 | | | - moved 'vFstatus' to 'faultFields' |
4618 | | | - removed 'firstDateTime' and 'lastDateTime' and |
4619 | | | changed 'firstEpoch' to 'startEpochMicrosec' and |
4620 | | | changed 'lastEpoch' to 'lastEpochMicrosec'. |
4622 | | | - Added 'functionalRole' to the commonEventHeader |
4624 | | | - In the commonEventHeader, changed the 'eventDomain'|
4625 | | | enumeration to remove 'measurements' and add |
4626 | | | 'measurementsForVfScaling'. |
4628 | | | - Changed the 'measurementFields' to |
4629 | | | 'measurementsForVfScalingFields' |
4631 | | | - In the commonEventHeader, changed the following |
4634 | | | - 'eventDomain' to 'domain' |
4636 | | | - 'eventSequence' to 'sequence' |
4638 | | | - 'eventSourceId' to 'sourceId' |
4640 | | | - 'eventSounceName' to 'sourceName' |
4642 | | | - Updated the JSON schema to v13 |
4644 | | | - Section 6 changes: updated the input parameters and|
4645 | | | sample requests to conform to the changes above. |
4647 | | | - Section 7: changed the section from Approvers to |
4648 | | | Contributors. |
4649 +-----------+---------+-------------------------------------------------------+
4650 | 1/22/2016 | v1.8 | - Section 4: Added support for ‘mobileFlow’ in the |
4651 | | | commonEventHeader ‘domain’ enumeration. Added the |
4652 | | | mobileFlowFields datatype and the gtpPerFlowMetrics|
4653 | | | datatype referenced by that datatype. |
4655 | | | - Section 7: alphabetized the contributors |
4656 +-----------+---------+-------------------------------------------------------+
4657 | 2/11/2016 | v1.9 | - Added section 1.3: Naming Standard for Event Types |
4658 +-----------+---------+-------------------------------------------------------+
4659 | 2/12/2016 | v2.0 | - Updated request – response examples to reflect the |
4660 | | | naming standards for event types introduced in v1.9|
4662 | | | - Added a paragraph on use of Avro as a transport in |
4664 +-----------+---------+-------------------------------------------------------+
4665 | 3/11/2016 | v2.1 | - Updated the embedded JSON schema to v15 to fix a |
4666 | | | typo in the required fields for the |
4667 | | | measurementsForVfScalingFields, namely, changed |
4668 | | | ‘configuredEntites’ to ‘configuredEntities’. |
4669 | | | Additionally, added an ‘Event Listener’ title block|
4670 | | | at the bottom of the file with a single required |
4671 | | | event object. |
4672 +-----------+---------+-------------------------------------------------------+
4673 | 3/15/2016 | v2.2 | - Added mobileFlowFields to the event datatype |
4674 | | | definition in section 4.7 and updated the embedded |
4675 | | | json schema at the top of section 4 to v16. |
4676 +-----------+---------+-------------------------------------------------------+
4677 | 4/26/2016 | v2.3 | - Generic Event Format updates: 1) made ‘priority’ |
4678 | | | lowercase in the Word doc table for |
4679 | | | commonEventHeader; 2) added ‘requestError’ data |
4680 | | | structure to the Word doc and JSON schema (which is|
4682 +-----------+---------+-------------------------------------------------------+
4683 | 4/27/2016 | v2.4 | - JSON Schema: In the 'event' data structure, changed|
4684 | | | 'thresholdCrossingFields' to |
4685 | | | 'thresholdCrossingAlertFields' to product v18 of |
4688 | | | - 'codecsInUse' data structure: changed 'numberInUse'|
4689 | | | to 'codecUtilization’ |
4690 +-----------+---------+-------------------------------------------------------+
4691 | 5/26/2016 | v2.5 | - Changed responses from ‘204 No Content’ to ‘202 |
4692 | | | Accepted’ and added a body to the response that |
4693 | | | enable AT&T to throttle the events being sent |
4694 | | | and/or to request the current state of throttling |
4695 | | | at the event source. |
4697 | | | - Added new datatypes to support the above: |
4698 | | | eventDomainThrottleSpecification, |
4699 | | | eventDomainThrottleSpecificationList, |
4700 | | | eventThrottlingState, suppressedNvPairs |
4702 | | | - Modifed the commonEventFormat json schema to v19 |
4704 | | | - Note: for the VendorEventListener: added new |
4705 | | | licensing language on the back of the title page; |
4706 | | | added an "attCopyrightNotice" definition at the top|
4707 | | | of the commonEventFormat\_Vendors.json file; also |
4708 | | | removed all references to internalHeaderFields from|
4709 | | | this file and from the VendorEventListener spec. |
4710 +-----------+---------+-------------------------------------------------------+
4711 | 8/9/2016 | v2.6 | - commonHeader: added a note on the description of |
4712 | | | sourceId and sourceName in the commonHeader: "use |
4713 | | | reportingEntity for domains that provide more |
4714 | | | detailed source info" |
4716 | | | - commonHeader: deleted the capacity, |
4717 | | | measurementsForVfScaling and usage domains in the |
4718 | | | domain enumeration |
4720 | | | - commonHeader: added the following domains to the |
4721 | | | domain enumeration: licensingKci, scalingKpi, |
4724 | | | - event: removed references to capacityFields, |
4725 | | | measurementsForVfScalingFields and usageFields and |
4726 | | | added references to licensingKciFields, |
4727 | | | scalingKpiFields, stateChangeFields |
4729 | | | - licensingKciFields: added this section along with |
4730 | | | 'additionalMeasurements', which is an optional list|
4731 | | | of measurementGroup structures. Changed the name of|
4732 | | | kciFieldsVersion to licensingKciFieldsVersion. |
4734 | | | - scalingKpiFields: added this section but changed |
4735 | | | measurementFieldsVersion to scalingKpiFieldsVersion|
4737 | | | - stateChangeFields: added this section along with |
4738 | | | 'additionalFields', which is an optional list of |
4739 | | | name-value pairs. Other fields included newState |
4740 | | | and oldState which were enumerations of the |
4741 | | | following possible states: 'inService', |
4742 | | | 'maintenance', 'outOfService' |
4744 | | | - sysLogFields: added 'additionalFields', which is an|
4745 | | | optional list of name-value pairs |
4747 | | | - vNicUsage: added two required fields to the |
4748 | | | vNicUsage data structure: packetsIn and packetsOut |
4749 +-----------+---------+-------------------------------------------------------+
4750 | 8/10/2016 | v2.7 | - commonHeader: removed the note on the description |
4751 | | | of sourceId and sourceName in the commonHeader: |
4752 | | | "use reportingEntity for domains that provide more |
4753 | | | detailed source info" |
4755 | | | - commonHeader: added measurementsForVfScaling domain|
4756 | | | back and removed the licensingKci and scalingKpi |
4759 | | | - event: removed references to licensingKciFields and|
4760 | | | scalingKpiFields; added references to |
4761 | | | measurementsForVfScalingFields |
4763 | | | - measurementsForVfScalingFields: combined the |
4764 | | | kciDetail and kpiDetail structures into the |
4765 | | | measurementsForVfScalingFields structure; |
4766 | | | referenced the errors structure |
4768 | | | - errors: added a new structure to capture the |
4769 | | | receive and transmit errors for the measurements |
4772 | | | - removed the following structures: kci, kpi, |
4773 | | | scalingKpiFields and licensingKciFields |
4775 | | | - eventDomainThrottleSpecification: updated the |
4776 | | | reference to commonEventHeader domain field |
4778 | | | - faultFields: removed the numbers from the |
4779 | | | enumerated strings for eventSourceType |
4781 | | | - vNicUsage: made the broadcast, multicast and |
4782 | | | unicast fields optional |
4784 | | | - contributors: updated Alok’s organizational area |
4785 +-----------+---------+-------------------------------------------------------+
4786 | 8/12/2016 | v2.8 | - commonHeader: copied the descriptions of sourceId |
4787 | | | and sourceName from the JSON schema into the word |
4788 | | | document tables. |
4790 | | | - sample request examples: moved the |
4791 | | | reportingEntityId and reportingEntityNames to the |
4792 | | | same relative place in all sample requests in the |
4795 | | | - Fixed the sample request shown for |
4796 | | | publishEventBatch to take an eventList as input. |
4798 | | | - Fixed the sample request shown for |
4799 | | | publishSpecificTopic to put the topic in the URL |
4801 | | | - errors: changed the receiveErrors and |
4802 | | | transmitErrors fields to be datatype number |
4804 | | | - codesInUse: changed 'codecUtilization' to |
4805 | | | 'numberinUse' |
4807 | | | - vNicUsage: updated the description of the fields |
4808 +-----------+---------+-------------------------------------------------------+
4809 | 8/27/2016 | v2.9 | - Added a note "(currently: 1.1)" in the descriptions|
4810 | | | of the following fields: commonEventHeader:version,|
4811 | | | faultFields:faultFieldsVersion, |
4812 | | | measurementsForVfScalingFields:measurementsForVf\ |
4813 | | | ScalingFieldsVersion, stateChangeFields:state\ |
4814 | | | ChangeFieldsVersion, sysLogFields:syslogFields\ |
4815 | | | Version, thresholdCrossingAlertFields:threshold\ |
4816 | | | CrossingFieldsVersion |
4818 | | | - stateChangeFields: made stateInterface mandatory |
4820 | | | - changed 'enum' to 'enumeration' throughout section |
4821 | | | 4 of the document (note: this can't be done in the |
4822 | | | JSON schema). |
4824 | | | - measurementsForVfScalingFields: made the following |
4825 | | | fields optional: conurrentSessions, configured\ |
4826 | | | Entitites, cpuUsageArray, fileSystemUsageArray, |
4827 | | | memoryConfigured, memoryUsed, requestRate, |
4828 | | | vNicUsageArray |
4830 | | | - measurementsForVfScalingFields: concurrentSessions |
4831 | | | and configuredEntities: changed the description to |
4832 | | | support both VMs and VNFs |
4834 | | | - measurementsFor VfScalingFields: clarified the |
4835 | | | descriptions of latencyDistribution, measurement\ |
4836 | | | Inverval and requestRate |
4838 | | | - syslogFields: clarified the descriptions of |
4839 | | | syslogSData, syslogTag, syslogVer |
4841 | | | - thresholdCrossingAlertFields: made the following |
4842 | | | fields optional and clarified their descriptions: |
4843 | | | elementType, networkService |
4845 | | | - command and commandList: created a list of command |
4846 | | | structures to enable the event collector to request|
4847 | | | changes of event sources. Commands consist of a |
4848 | | | commandType along with optional fields (whose |
4849 | | | presence is indicated by the commandType). Three |
4850 | | | command types are currently supported: |
4851 | | | 'measurementIntevalChange', |
4852 | | | ‘provideThrottlingState’ and |
4853 | | | 'throttlingSpecification'. |
4855 | | | - eventDomainThrottleSpecificationList: removed this |
4856 | | | and replaced it with commandList. |
4858 | | | - Operations and Sample Requests: modified the |
4859 | | | operations and samples to support the new command |
4860 | | | and commandList structures. |
4861 +-----------+---------+-------------------------------------------------------+
4862 | 9/1/2016 | v2.10 | - measurementsForVfScaling block: made the following |
4863 | | | fields optional: latencyDistribution (which is an |
4864 | | | array of latencyBucketMeasure structures) and |
4865 | | | meanRequestLatency. Updated the JSON schemas (now |
4866 | | | v24) to match. |
4867 +-----------+---------+-------------------------------------------------------+
4868 | 9/16/2016 | v2.11 | - 1 Introduction: updated the introduction to clarify|
4869 | | | the usage of eventTypes and the possibility of |
4870 | | | support for other protocols. |
4872 | | | - 6.1 REST Operation Overview: added two new |
4873 | | | subsections (6.1.2 and 6.1.3) discussing Api |
4874 | | | Version and Commands Toward Event Source Clients. |
4876 | | | - 6.2 publishAnyEvent: fixed the sample to conform to|
4877 | | | the latest changes |
4879 | | | - 6.3 publishSpecificTopic: fixed the sample to |
4880 | | | conform to the latest changes |
4882 | | | - 6.4 publishEventBatch: fixed the sample to conform |
4883 | | | to the latest changes |
4885 | | | - 6.5 provideThrottlingState operation: added the |
4886 | | | Input Parameters section heading back and fixed the|
4887 | | | sample request to provide eventThrottlingState |
4888 | | | (instead of eventThrottlingClientState). |
4890 | | | - The remaining bullets describe changes made to |
4891 | | | section 4 datatypes in alphabetical order: |
4893 | | | - command datatype: referenced the new section 6.1.3 |
4894 | | | which provides an explanation of command state |
4895 | | | expectations and requirements for a given |
4896 | | | eventSource: |
4898 | | | - commonEventHeader datatype: |
4900 | | | - made sourceId and reportingEntityId fields |
4901 | | | optional (although the internal Generic Event |
4902 | | | Listener spec indicates, in the field |
4903 | | | descriptions, that the AT&T enrichment process |
4904 | | | shall ensure that these fields are populated) |
4906 | | | - domain enumeration: changed measurementsForVf\ |
4907 | | | ScalingFields to measurementsForVfScaling |
4909 | | | - eventDomainThrottleSpecificationList: added this |
4910 | | | array of eventDomainThrottleSpecification stuctures|
4911 | | | back to the schema because it is used by the |
4912 | | | provideThrottlingState operation. |
4914 | | | - eventList: added eventList back to the vendor |
4915 | | | version of the commonEventFormat. This is used by |
4916 | | | the publishEventBatch operation. |
4918 | | | - faultFields datatype: |
4920 | | | - eventSourceType: made this a string (and |
4921 | | | provided the previous enumerated values as |
4924 | | | - filesystemUsage datatype: |
4926 | | | - changed vmIdentifier to filesystemName |
4928 | | | - gtpPerFlowMetrics datatype: |
4930 | | | - flowActivationTime: changed the format and |
4931 | | | description to be compliant with RFC 2822. |
4933 | | | - flowDeactivationTime: changed the format and |
4934 | | | description to be compliant with RFC 2822. |
4936 | | | - internalHeaderFields datatype: |
4938 | | | - Added the following optional fields: firstDate\ |
4939 | | | Time, lastDateTime compliant with RFC 2822. |
4940 | | | Noted in the description that these fields must |
4941 | | | be supplied for events in the following domains:|
4942 | | | fault, thresholdCrossingAlerts and |
4943 | | | measurementsForVfScaling. |
4945 | | | - ticketingTimestamp: changed the format and |
4946 | | | description to be compliant with RFC 2822. |
4948 | | | - syslogFields datatype: |
4950 | | | - eventSourceType: made this a string (and |
4951 | | | provided the previous enumerated values, without|
4952 | | | the numbers, as examples) |
4954 | | | - thresholdCrossingAlerts dataypte: |
4956 | | | - collectionTimestamp: changed the format and |
4957 | | | description to be compliant with RFC 2822. |
4959 | | | - eventStartTimestamp: changed the format and |
4960 | | | description to be compliant with RFC 2822. |
4962 | | | - added the same eventSeverity field as from the |
4963 | | | faultFields and made it required |
4964 +-----------+---------+-------------------------------------------------------+
4965 | 9/23/2016 | v2.12 | - Section 4 Datatypes: commonEventHeader: made |
4966 | | | reportingEntityName a required field (note: the |
4967 | | | JSON schema already had this field as required) |
4968 +-----------+---------+-------------------------------------------------------+
4969 | 11/29/2016| v3.0 | - Introduction: |
4971 | | | - Introductory paragraph: changed '...Common Event|
4972 | | | Header Block followed by zero or more event |
4973 | | | domain blocks' to '...Common Event Header Block |
4974 | | | accompanied by zero or more event domain blocks'|
4975 | | | since the order of the blocks on the wire is |
4976 | | | not guaranteed. |
4978 | | | - Added Section 1.5 Versioning |
4980 | | | - Section 4: codec processing: |
4982 | | | - CommonEventFormat\_Vendors schema only: |
4983 | | | codesInUse: changed required field from |
4984 | | | "codecUtilization" which was removed previously |
4985 | | | to "numberInUse" which is the new field name. |
4987 | | | - added ‘codecSelected’ datatype |
4989 | | | - added ‘codecSelectedTranscoding’ datatype |
4991 | | | - Section 4 and section 6: command processing: |
4993 | | | - Added commandListEntry which is an object that |
4994 | | | references the command object. |
4996 | | | - commandList: changed commandList to contain an |
4997 | | | array of commandListEntry objects. |
4999 | | | - Updated sample responses in section 6 where |
5000 | | | commands are used |
5002 | | | - Section 4: commonEventHeader: |
5004 | | | - Incremented version to 1.2 |
5006 | | | - added two new values to the ‘domain’ |
5007 | | | enumeration: ‘serviceEvents’ and ‘signaling |
5009 | | | - Section 4: added endOfCallVqmSummaries datatype |
5011 | | | - Section 4: ‘event’: added two fields: |
5012 | | | ‘serviceEventsFields’ and ‘signalingFields’ |
5014 | | | - Section 4: added ‘eventInstanceIdentifier’datatype |
5016 | | | - Section 4: CommonEventListener only: |
5017 | | | internalHeaderFields: |
5019 | | | - added ‘internalHeaderFieldsVersion’(initially |
5022 | | | - added ‘correlationFirstEpoch’ |
5024 | | | - added 'closedLoopControlName' |
5026 | | | - added 'closedLoopFlag' |
5028 | | | - added 'collectorTimeStamp' |
5030 | | | - added 'eventTag' |
5032 | | | - added ‘tenantName’ |
5034 | | | - changed 'operationalStatus' to 'inMaint' |
5036 | | | - added required fields in the schema to match the|
5037 | | | word doc: 'equipmentNameCode', 'equipmentType', |
5038 | | | 'equipmentVendor', 'inMaint', 'provStatus' |
5040 | | | - Section 4: added ‘marker’datatype |
5042 | | | - Section 4: added ‘midCallRtcp’ datatype |
5044 | | | - Section 4: mobileFlowFields: |
5046 | | | - added ‘mobileFlowFieldsVersion’(initially set to|
5049 | | | - Section 4: added ‘serviceEventsFields’datatype |
5051 | | | - Section 4: added ‘signalingFields’ datatype |
5053 | | | - Section 4: syslogFields: |
5055 | | | - Incremented syslogFieldsVersion to 1.2 |
5057 | | | - added 'syslogPri' |
5059 | | | - added 'syslogSev' |
5061 | | | - added ‘syslogSdId’ |
5063 | | | - Section 4: thresholdCrossingAlertFields: |
5065 | | | - Incremented thresholdCrossingFieldsVersion to |
5068 | | | - added 'additionalFields' which is an optional |
5069 | | | list of name value pairs. |
5071 | | | - Section 4: schema v26.0 embedded reflecting the |
5072 | | | above changes. |
5074 | | | - Section 6 and Section 2: changed all sample |
5075 | | | requests to use /v3 in the REST Resource URL. |
5076 +-----------+---------+-------------------------------------------------------+
5077 | 12/1/2016 | v3.1 | - Section 6: Updated the call flow diagrams to show |
5079 +-----------+---------+-------------------------------------------------------+
5080 | 1/5/2017 | v4.0 | - Combined the Generic Event Listener and Vendor |
5081 | | | Event Listener into a single API service |
5082 | | | specification with version 4.0. |
5084 | | | - Changed the title to VES (Virtual Function Event |
5085 | | | Streaming) Listener. |
5087 | | | - Changed references to 'generic event' to 'common |
5088 | | | event' or 'VES event' (depending on the context) |
5089 | | | throughout the document. |
5091 | | | - Used the Legal Disclaimer from the Vendor Event |
5092 | | | Listener on the back of the title page. |
5094 | | | - Section 1: Introduction changes: |
5096 | | | - modified wording to reference 'VES' |
5098 | | | - removed the 'Audience' section, which described |
5099 | | | various AT&T groups the documented was intended |
5102 | | | - tweaked the naming standards for event types to |
5103 | | | clarify the purpose of the naming conventions |
5105 | | | - Section 3: Resource Structure: added a sentence |
5106 | | | describing the FQDN and port used in the resource |
5109 | | | - Section 4: Common Event Format changes: |
5111 | | | - renamed the section to 'Common Event Format' |
5112 | | | from 'Generic Event Format' |
5114 | | | - reorganized the datatypes into separate sections|
5115 | | | ; sections were defined for each of the domains |
5116 | | | as well as for common event, common event header|
5117 | | | and command list processing |
5119 | | | - codecSelected datatype: removed this datatype |
5121 | | | - codecSelectedTranscoding datatype: removed this |
5124 | | | - command datatype: added an enumerated value to |
5125 | | | commandType: 'heartbeatIntervalChange' |
5127 | | | - commonEventHeader: added internalHeaderFields to|
5128 | | | the commonEventHeader, defined as "Fields (not |
5129 | | | supplied by event sources) that the VES Event |
5130 | | | Listener service can use to enrich the event if |
5131 | | | needed for efficient internal processing. This |
5132 | | | is an empty object which is intended to be |
5133 | | | defined separately by each provider implementing|
5134 | | | the VES Event Listener." |
5136 | | | - commonEventHeader: removed two enumerated values|
5137 | | | , 'serviceEvents' and 'signaling' from the |
5138 | | | domain enumeration |
5140 | | | - commonEventHeader version: incremented the |
5141 | | | version to 2.0 |
5143 | | | - endOfCallVqmSummaries datatype: removed this |
5146 | | | - event: changed the description of the event |
5147 | | | datatype to: "fields which constitute the ‘root |
5148 | | | level’ of the common event format" |
5150 | | | - event: removed 'serviceEventFields' and |
5151 | | | 'signalingFields' from the definition |
5153 | | | - event: fixed a misspelling of |
5154 | | | ‘thresholdCrossingAlertFields’, which was only |
5155 | | | present in the Word document |
5157 | | | - eventInstanceIdentifier datatype: removed this |
5160 | | | - internalHeaderFIelds datatype: defined this as |
5161 | | | follows: "The internalHeaderFields datatype is |
5162 | | | an undefined object which can contain |
5163 | | | arbitrarily complex JSON structures. It is |
5164 | | | intended to be defined separately by each |
5165 | | | provider implementing the VES Event Listener. |
5166 | | | The fields in internalHeaderFields are not |
5167 | | | provided by any event source but instead are |
5168 | | | added by the VES Event Listener service itself |
5169 | | | as part of an event enrichment process necessary|
5170 | | | for efficient internal processing of events |
5171 | | | received by the VES Event Listener" |
5173 | | | - marker datatype: removed this datatype |
5175 | | | - measurementsForVfScalingFields datatype: |
5176 | | | clarified that memoryConfigured and memoryUsed |
5177 | | | are measured in MB |
5179 | | | - midCallRtcp datatype: removed this datatype |
5181 | | | - mobileFlowFields datatype: added |
5182 | | | ‘additionalFields’ |
5184 | | | - mobileFlowFields datatype: incremented the |
5185 | | | version number for this field block to 1.2 |
5187 | | | - serviceEventsFields datatype: removed this |
5190 | | | - signalingFields datatype: removed this datatype |
5192 | | | - syslogFields: added three fields to the schema |
5193 | | | that were previously described in the document |
5194 | | | but not incorporated into the schema: syslogPri,|
5195 | | | syslogSev, syslogSdId |
5197 | | | - syslogFields version: incremented the version to|
5200 | | | - Modified the Common Event Format JSON schema to |
5201 | | | v27.0 to incorporate the above changes. Also, added|
5202 | | | the AT&T Copyright Notice from the top of the |
5203 | | | retired CommonEventFormat\_Vendors schema. |
5205 | | | - Section 6 and 2: changed all sample requests to use|
5206 | | | /v4 in the REST Resource URL and call flow diagrams|
5208 | | | - Section 6.1.3: added a row to the table in this |
5209 | | | section describing the ‘heartbeatIntervalChange’ |
5212 | | | - Section 6.1.4: added this new section describing |
5213 | | | expectations for buffering of events should all |
5214 | | | REST resource URL FQDNs be unreachable. |
5216 | | | - Section 6 Sample Requests: modified all sample |
5217 | | | requests showing the return of a commandList toward|
5218 | | | the event source to incorporate a |
5219 | | | heartbeatIntervalChange command; also corrected the|
5220 | | | spelling in the samples for the |
5221 | | | measurementIntervalChange command. |
5223 | | | - Section 7: Contributors: removed this section |
5224 +-----------+---------+-------------------------------------------------------+
5225 | 3/21/2017 | v4.1 | - JSON Schema changes to produce v27.2 (note: an |
5226 | | | earlier draft version of v27.1 had been distributed|
5227 | | | to a few individuals): |
5229 | | | - To support use of the schema with event batches,|
5230 | | | removed the following statement near the end of |
5231 | | | the schema file: |
5233 | | | "required": [ "event" ] |
5235 | | | - Fixed the characters used in some of the quotes |
5237 | | | - Fixed some typos in the descriptions. |
5239 | | | - Removed the booleans, which were non-essential and |
5240 | | | which were causing problems across different |
5241 | | | implementations. |
5243 | | | - Section 4.5.7 measurementsForVfScalingFields: |
5245 | | | - Fixed the spelling of measurementsForVf\ |
5246 | | | ScalingFields in the Word document |
5248 | | | - Section 2 and 6 sample requests and responses: |
5250 | | | - Removed quotes from numbers: sequence, and |
5251 | | | first/lastEpochMicrosec. |
5253 | | | - Fixed all quote characters, some of which were |
5254 | | | using unusual symbols that wouldn’t validate |
5255 | | | with the json-schema Python package. |
5257 | | | - Section 6.2.6.1, 6.3.6.1, 6.4.6.1 sample requests: |
5259 | | | - Added an alarmAdditionalInformation field array |
5260 | | | to the sample requests. |
5262 | | | - Added missing commas. |
5264 | | | - Section 6.5.6.1 provideThrottlingState sample |
5267 | | | - Fixed the eventDomainThrottleSpecificationList |
5268 | | | to pass an array of anonymous eventDomain\ |
5269 | | | ThrottleSpecification objects. |
5271 | | | - Added missing quotes. |
5273 | | | - Fixed the suppressedNvPairsList to pass an array of|
5274 | | | anonymous suppressedNvPairs objects. |
5275 +-----------+---------+-------------------------------------------------------+
5276 | 4/14/2017 | v5.0 | - Section 1 Introduction: |
5278 | | | - Clarified the Introduction (Section 1). |
5280 | | | - Changed Section 1.1 title from ‘Terminology’ to |
5281 | | | 'Event Registration' and referenced the YAML |
5282 | | | event registration format, defined in a separate|
5285 | | | - Clarified naming standards for eventName. |
5287 | | | - Section 3: updated the REST resource structure |
5289 | | | - Section 4.1 command list processing datatypes: |
5291 | | | - Got rid of commandListEntry and returned |
5292 | | | commandList to a simple array of commands. |
5294 | | | - Added heartbeatInterval to the command datatype.|
5296 | | | - Changed the datatype of measurementInterval from|
5297 | | | number to integer. |
5299 | | | - Section 4.2 common event datatypes: |
5301 | | | - event dataType: Added heartbeatFields, |
5302 | | | sipSignalingFields and voiceQualityFields to the|
5303 | | | event datatype as optional field blocks |
5305 | | | - Added jsonObject which provides a json object |
5306 | | | schema, name and other meta-information along |
5307 | | | with one or more object instances. |
5309 | | | - Added jsonObjectInstance which provides |
5310 | | | meta-information about an instance of a |
5311 | | | jsonObject along with the actual object instance|
5313 | | | - Added the ‘key’ datatype |
5315 | | | - Added the namedArrayOfFields datatype |
5317 | | | - Added vendorVnfNameFields |
5319 | | | - Section 4.3 common event header fields: |
5321 | | | - Add two new enumerations to domain: |
5322 | | | ‘sipSignaling’ and ‘voiceQuality’ |
5324 | | | - Renamed eventType to eventName. Note that the |
5325 | | | original usage of eventType was formally |
5326 | | | described in the Introduction back on 2/11/2016 |
5329 | | | - Made eventName a required field |
5331 | | | - Created a new field called eventType with a |
5332 | | | meaning that is different than the old eventType|
5334 | | | - Removed functionalRole, which was replaced by |
5335 | | | the following two fields. |
5337 | | | - Added nfNamingCode |
5339 | | | - Added nfcNamingCode |
5341 | | | - Changed version to 3.0 (major version change) |
5342 | | | and made it a required field |
5344 | | | - Section 4.4: faultFields: |
5346 | | | - added one optional field: eventCategory |
5348 | | | - made faultFieldsVersion a required field |
5350 | | | - changed faultFieldsVersion to 2.0 (major version|
5353 | | | - fixed a typo on the spelling of alarmInterfaceA |
5355 | | | - clarified field descriptions |
5357 | | | - Section 4.5: added heartbeatFields datatype which |
5358 | | | can be used to communicate heartbeatInterval. Note:|
5359 | | | this change was previously made in v4.2 |
5361 | | | - Section 4.6 measurements for vf scaling datatypes: |
5362 | | | changed the following datatypes from number to |
5365 | | | - In measurementsForVfScalingFields: |
5366 | | | concurrentSessions, configuredEntities, |
5367 | | | numberOfMediaPortsInUse, vnfcScalingMetric |
5369 | | | - In codecsInUse: numberInUse |
5371 | | | - In featuresInUse: featureUtilization |
5373 | | | - Section 4.6.2 modified cpuUsage |
5375 | | | - Section 4.6.3 added diskUsage |
5377 | | | - Section 4.6.7 measurementsForVfScalingFields: |
5379 | | | - fixed the spelling of the measurementsForVf\ |
5380 | | | ScalingFields in the Word document |
5382 | | | - added additionalFields, which is an array of |
5383 | | | fields (i.e., name-value pairs) |
5385 | | | - changed additionalMeasurements to reference the |
5386 | | | common datatype namedArrayOfFields (instead of |
5387 | | | referencing measurementGroup) |
5389 | | | - added additionalObjects which is an array of |
5390 | | | jsonObjects described by name, keys and schema |
5392 | | | - deleted aggregateCpuUsage |
5394 | | | - added diskUsageArray |
5396 | | | - deleted measurementGroup (which was replaced by |
5397 | | | the common datatype: namedArrayOfFields |
5399 | | | - added memoryUsageArray |
5401 | | | - deleted memoryConfigured and memoryUsed |
5403 | | | - deleted errors and vNicUsageArray |
5405 | | | - added vNicPerformanceArray |
5407 | | | - changed the measurementsForVfScalingVersion to |
5408 | | | 2.0 (major version change) and made it a |
5409 | | | required field. Also changed the name of this |
5410 | | | version field in the Word document to match that|
5411 | | | in the JSON schema. |
5413 | | | - Section 4.6.8 added memoryUsage |
5415 | | | - Section 4.6.9 vNicPerformance: replaced vNicUsage |
5416 | | | and errors with vNicPerformance |
5418 | | | - Section 4.7 mobile flow fields changes: |
5420 | | | - Made mobileFlowFieldsVersion a required field |
5421 | | | and changed the mobileFlowFieldsVersion to 2.0 |
5422 | | | (major version change). |
5424 | | | - Changed the datatype of flowActivationTime and |
5425 | | | flowDeactivationTime in the Word doc to string. |
5427 | | | - changed the following datatypes from number to |
5428 | | | integer: otherEndpointPort, |
5429 | | | reportingEndpointPort, samplingAlgorithm |
5431 | | | - Section 4.8: otherFields: |
5433 | | | - Added otherFieldsVersion (set at 1.1) |
5435 | | | - Added hashOfNameValuePairArrays |
5437 | | | - Added jsonObjects |
5439 | | | - Added nameValuePairs |
5441 | | | - Section 4.9: added sipSignaling domain datatypes |
5442 | | | with 4.8.1 sipSignalingFields. sipSignalingFields\ |
5443 | | | Version is set at 1.0 |
5445 | | | - Section 4.10 stateChangeFields: made stateChange\ |
5446 | | | FieldsVersion a required field and set it to 2.0 |
5447 | | | (major version change). |
5449 | | | - Section 4.11 syslogFields: |
5451 | | | - Changed the following datatypes from number to |
5452 | | | integer: syslogFacility, syslogPri |
5454 | | | - Changed additionalFields from a field [ ] to a |
5455 | | | string which takes name=value pairs delimited by|
5456 | | | a pipe symbol. |
5458 | | | - Changed syslogFieldsVersion to 3.0 (major |
5459 | | | version change) and made it a required field |
5461 | | | - Made syslogSev an enumerated string (previously |
5462 | | | just a string) |
5464 | | | - Section 4.12 thresholdCrossingAlertFields: made |
5465 | | | thresholdCrossingFieldsVersion a required field and|
5466 | | | set it to 2.0 (major version change). |
5468 | | | - Section 4.132: added voice quality domain datatypes|
5469 | | | with 4.13.1 endOfCallVqmSummaries and 4.13.2 |
5470 | | | voiceQualityFields. voiceQualityFieldsVersion is |
5473 | | | - JSON Schema: changed the schema to v28.0 and |
5474 | | | incorporated all of the changes above. |
5476 | | | - Additional JSON Schema changes that are part of |
5477 | | | v28: Note: The following changes are provided |
5478 | | | relative to API Spec v4.0 (which embedded JSON |
5479 | | | schema v27.0), but they were also made in an |
5480 | | | interim release v4.1 (which embedded JSON schema |
5483 | | | - To support use of the schema with event batches,|
5484 | | | removed the following statement near the end of |
5485 | | | the schema file: |
5487 | | | "required": [ "event" ] |
5489 | | | - Fixed the characters used in some of the quotes |
5491 | | | - Fixed some typos in the descriptions. |
5493 | | | - Removed the booleans, which were non-essential and |
5494 | | | which were causing problems across different |
5495 | | | implementations. |
5497 | | | - Section 2 and 6 sample requests and responses (also|
5498 | | | incorporated in interim release 4.1): |
5500 | | | - Removed quotes from numbers: sequence, and |
5501 | | | first/lastEpochMicrosec. |
5503 | | | - Fixed all quote characters, some of which were |
5504 | | | using unusual symbols that wouldn’t validate |
5505 | | | with the json-schema Python package. |
5507 | | | - Section 2 and 6 sample requests and responses (only|
5510 | | | - Changed the version numbers in the URL string. |
5512 | | | - Added nfNamingCode and nfcNamingCode and removed|
5513 | | | functionalRole |
5515 | | | - Section 6 call flows: updated the version number |
5516 | | | (only in v5.0). |
5518 | | | - Section 6: removed the publishSpecificTopic |
5521 | | | - Section 6.1.4: Buffering: clarified event source |
5522 | | | expectations for buffering (only in v5.0). |
5524 | | | - Section 6.2.6.1, 6.3.6.1 sample requests (also |
5525 | | | incorporated in interim release 4.1): |
5527 | | | - Added an alarmAdditionalInformation field array |
5528 | | | to the sample requests. |
5530 | | | - Added missing commas. |
5532 | | | - Section 6.2.6.3, 6.3.6.3 commandList sample |
5533 | | | responses (only in v5.0): |
5535 | | | - Fixed the commandList sample responses to pass |
5536 | | | an array of anonymous command objects (rather |
5537 | | | than an array of commandListEntry objects). |
5539 | | | - Fixed the heartbeatIntervalChange commandType to|
5540 | | | pass a heartbeatInterval value instead of a |
5541 | | | measurementInterval value. |
5543 | | | - Removed quotes from the measurementInterval and |
5544 | | | heartbeatInterval values since they are numbers.|
5546 | | | - Section 6.4.6.1 provideThrottlingState sample |
5547 | | | requests(also incorporated in interim release 4.1):|
5549 | | | - Fixed the eventDomainThrottleSpecificationList |
5550 | | | to pass an array of anonymous |
5551 | | | eventDomainThrottleSpecification objects. |
5553 | | | - Added missing quotes. |
5555 | | | - Fixed the suppressedNvPairsList to pass an array|
5556 | | | of anonymous suppressedNvPairs objects (also |
5557 | | | incorporated in interim release 4.1). |
5558 +-----------+---------+-------------------------------------------------------+
5559 | 5/22/2017 | v5.1 | - Footers: removed proprietary markings and updated |
5560 | | | copyrights to 2017 |
5562 | | | - Section 4.2.3: field: |
5564 | | | - Changed the API spec to make ‘name’ and ‘value’ |
5565 | | | start with lowercase letters. Note: this did not|
5566 | | | affect the schema, which already had them as |
5569 | | | - JSON Schema: |
5571 | | | - measurementGroup: deleted this object since it |
5572 | | | was replaced with ‘namedArrayOfFields’ in v28.0 |
5573 | | | and was no longer being used. |
5575 | | | - namedArrayOfFields: Fixed an error in the |
5576 | | | specification of required fields: from |
5577 | | | ‘measurements’ to ‘arrayOfFields’. |
5579 | | | - Changed the version of the JSON schema to 28.1 |
5580 +-----------+---------+-------------------------------------------------------+
5581 | 6/14/2017 | v5.2 | - JSON Schema: created v28.2 by changing the field |
5582 | | | descriptions in the memoryUsage object to refer to |
5583 | | | ‘kibibytes’ instead of ‘kilobytes’. There were no |
5584 | | | changes to the 28.1 structure. |
5586 | | | - Word Document: measurementsForVfScaling Domain: |
5587 | | | memoryUsage object: changed the field descriptions |
5588 | | | in this object to refer to ‘kibibytes’ instead of |
5589 | | | ‘kilobytes’. There were no changes to the |
5590 | | | memoryUsage structure. |
5592 | | | - Reorganized the Word document to group the data |
5593 | | | structures in Section 4 into three broad categories|
5594 | | | to better align with the VNF Guidelines |
5595 | | | documentation that has been prepared for vendors: |
5597 | | | - Common Event Datatypes: |
5599 | | | - Command List Processing Datatypes |
5601 | | | - Common Event Datatypes |
5603 | | | - Common Event Header Datatypes |
5605 | | | - Technology Independent Datatypes: |
5607 | | | - ‘Fault Domain Datatypes |
5609 | | | - ‘Heartbeat’ Domain Datatypes |
5611 | | | - ‘Measurements For Vf Scaling’ Domain Datatypes|
5613 | | | - ‘Other’ Domain Datatypes |
5615 | | | - ‘State Change’ Domain Datatypes |
5617 | | | - ‘Syslog’ Domain Datatypes |
5619 | | | - ‘Threshold Crossing Alert’ Domain Datatypes |
5621 | | | - Technology Specify Datatypes: |
5623 | | | - ‘Mobile Flow’ Domain Datatypes |
5625 | | | - ‘Sip Signaling’ Domain Datatypes |
5627 | | | - ‘Voice Quality’ Domain Datatypes |
5629 | | | - Section 6.1.3: Commands Toward Event Source |
5630 | | | Clients: Added a statement: "Note: Vendors are not |
5631 | | | currently required to implement support for command|
5632 | | | processing; in addition, command processing may be |
5633 | | | supported by an App-C interface in future." |
5634 +-----------+---------+-------------------------------------------------------+
5635 | 6/22/2017 | v5.3 | - JSON Schema: created v28.3 by correcting an error |
5636 | | | in the sipSignalingFields: changed |
5637 | | | vnfVendorNameFields to vendorVnfNameFields. |
5638 | | | Embedded the new schema at the top of section 4. |
5639 +-----------+---------+-------------------------------------------------------+
5640 | 9/12/2017 | v5.4 | - Note: There no changes to any data structures or |
5641 | | | operations in this version. |
5643 | | | - JSON Schema: created v28.4 embedded at the top of |
5646 | | | - Added a reference to eventList in the properties|
5647 | | | defined under the schema title. This enables the|
5648 | | | schema to correctly validate event batches in |
5649 | | | addition to just events. |
5651 | | | - Moved the schema title to the top of the schema |
5652 | | | and changed the text from "Event Listener" to |
5653 | | | "VES Event Listener" |
5655 | | | - Added a schema header block under the title to |
5656 | | | clearly communicate the schema version, |
5657 | | | associated API and last-modified information |
5659 | | | - Changed the date in the copyright notice to 2017 |
5660 +-----------+---------+-------------------------------------------------------+
5661 | 9/19/2017 | v5.4.1 | - Note: There no changes to any data structures or |
5662 | | | operations in this version. |
5664 | | | - Back of Cover Page: updated the license and |
5665 | | | copyright notice to comply with ONAP guidelines |
5667 | | | - JSON Schema: updated the JSON schema to v28.4.1: |
5668 | | | updated the copyright notice and license to comply |
5669 | | | with ONAP guidelines |
5670 +-----------+---------+-------------------------------------------------------+
5671 | 6/28/2018 | v6.0 | - Added contributors to the title page. |
5673 | | | - Updated references to ‘vnf’ ‘vnfc’ to either ‘nf’ |
5674 | | | and ‘nfc’ or ‘xNf’ and ‘xNfc’ to generalize support|
5675 | | | across both vnfs and pnfs. |
5677 | | | - Section 1: |
5679 | | | - clarified the meaning of the VES acronym |
5681 | | | - changed references from ASDC to SDC and from MSO|
5684 | | | - clarified the requirements for eventNames. |
5686 | | | - Added a section of EventId use case examples |
5688 | | | - Added a new section on measurement expansion |
5691 | | | - Added a new section of syslogs |
5693 | | | - clarified the versioning section and referenced |
5694 | | | the new API Versioning section in section 6. |
5696 | | | - Added a list of all the latest field block |
5697 | | | version numbers in this version of the API spec.|
5699 | | | - Section 2: updated the sample to show use of new |
5700 | | | HTTP versioning headers. Added a note indicating |
5701 | | | that support for mutual SSL would be provided in |
5704 | | | - Section 3: updated the resource structure remove |
5705 | | | the clientThrottlingState resource. |
5707 | | | - Section 4: hashMaps. Changed all name-value pair |
5708 | | | structures to hashMaps causing the following data |
5709 | | | model and JSON schema (to v29.0) changes: |
5711 | | | - 4.1.1: Common Event Datatypes: |
5713 | | | - removed "field" and added "hashMap" |
5715 | | | - removed "namedArrayOfFields" and added |
5716 | | | "namedHashMap" |
5718 | | | - added arrayOfNamedHashMap |
5720 | | | - added arrayOfJsonObject |
5722 | | | - 4.2.1: Fault Domain Datatypes: |
5724 | | | - changed the faultFields version to 3.0 (major|
5727 | | | - changed faultFields.alarmAdditional\ |
5728 | | | Information to reference a hashMap |
5730 | | | - 4.2.2: Heartbeat Domain Datatypes: |
5732 | | | - changed the heartbeatFieldsVersion to 2.0 |
5733 | | | (major change) |
5735 | | | - changed heartbeatFields.additionalFields to |
5736 | | | reference a hashMap |
5738 | | | - 4.2.3: Measurement Domain Datatypes: |
5740 | | | - changed the measurementFieldsVersion to 3.0 |
5741 | | | (major change) |
5743 | | | - changed measurementFields.additionalFields to|
5744 | | | reference a hashMap |
5746 | | | - changed measurement.additionalMesurements to |
5747 | | | reference a namedHashMap [ ] |
5749 | | | - modified measurementFields.featureUsageArray |
5750 | | | to reference a hashmap and removed |
5751 | | | ‘featuresInUse’ |
5753 | | | - added the following datatypes which are now |
5754 | | | referenced as items in arrays within |
5755 | | | measurementFields: hugePages, load, |
5756 | | | machineCheckException, processStats |
5758 | | | - 4.2.5: Other Domain Datatypes: |
5760 | | | - Change the otherFieldsVersion to 2.0 (major |
5763 | | | - changed otherFields.nameValuePairs to |
5764 | | | reference a hashMap and renamed it hashMap |
5766 | | | - changed otherFields.hashOfNameValuePair\ |
5767 | | | Arrrays to reference a namedHashMap and |
5768 | | | renamed it arrayOfNamedHashMap |
5770 | | | - 4.2.7: State Change Domain Datatypes: |
5772 | | | - changed the stateChangeFiledsVersion to 3.0 |
5773 | | | (major change) |
5775 | | | - changed stateChangeFields.additionalFields to|
5776 | | | reference a hashMap |
5778 | | | - 4.2.9: Threshold Crossing Alert Domain |
5781 | | | - changed the thresholdCrossingAlertFields\ |
5782 | | | Version to 3.0 (major change) |
5784 | | | - changed thresholdCrossingAlert\ |
5785 | | | Fields.additionalFields to reference a |
5788 | | | - counter: removed name and value elements and |
5789 | | | replaced with a hashMap |
5791 | | | - 4.3.1: Mobile Flow Domain Datatypes: |
5793 | | | - changed the mobileFlowFieldsVersion to 3.0 |
5794 | | | (major change) |
5796 | | | - changed mobileFlowFields.additionalFields to |
5797 | | | reference a hashMap |
5799 | | | - gtpPerFlowMetrics: modified ipTosCountList to|
5800 | | | reference hashmap |
5802 | | | - gtpPerFlowMetrics: modified mobileQciCos\ |
5803 | | | CountList to reference hashmap |
5805 | | | - gtpPerFlowMetrics: modified tcpFlagCountList |
5806 | | | to reference hashmap |
5808 | | | - 4.3.2: Sip Signaling Domain Datatypes: |
5810 | | | - changed the sigSignalingFieldsVersion to 2.0 |
5811 | | | (major change) |
5813 | | | - changed sipSignalingFields.additional\ |
5814 | | | Information to reference a hashMap |
5816 | | | - 4.3.3: Voice Quality Domain Datatypes: |
5818 | | | - change the voiceQualityFieldsVersion to 2.0 |
5819 | | | (major change) |
5821 | | | - changed voiceQualityFields.additional\ |
5822 | | | Information to reference a hashMap |
5824 | | | - Section 4: added notes at the top of section 4 |
5825 | | | clarifying expectations and requirements for |
5826 | | | optional fields, extensible fields and keys sent |
5827 | | | through extensible fields. |
5829 | | | - Common Event Data Types: Section 4.1.1.9 Changed |
5830 | | | vendorVnfNameFields to vendorNfNameFields; updated |
5831 | | | Section 4.3.2 SipSignaling and 4.3.3 Voice Quality |
5832 | | | to refer to the renamed object |
5834 | | | - Common Event Header Section 4.1.2: |
5836 | | | - clarified the descriptions of eventId, |
5837 | | | reportingEntityName, sourceName and |
5838 | | | startEpochMicroseconds. |
5840 | | | - Added ‘notification’ and ‘pngRegistration’ to |
5841 | | | the domain enumeration. |
5843 | | | - added a new timeZoneOffsest field |
5845 | | | - Fault Domain Section 4.2.1: clarified the |
5846 | | | definitions of alarmCondition, eventSeverity and |
5847 | | | specificProblem |
5849 | | | - Measurements Domain Section 4.2.3: changed the name|
5850 | | | of this domain from ‘measurementsForVfScaling’ to |
5851 | | | ‘measurement’ |
5853 | | | - measurementsForVfScaling measurement |
5855 | | | - measurementsForVfScalingFields measurementFields|
5857 | | | - measurementsForVfScalingVersion |
5858 | | | measurementFieldsVersion |
5860 | | | - the ‘mfvs’ abbreviation measurement |
5862 | | | - Measurements Domain Section 4.2.3 cpuUsage: added |
5863 | | | seven optional fields to this structure: |
5864 | | | cpuCapacityContention, cpuDemandAvg, cpuDemandMhz, |
5865 | | | cpuDemandPct, cpuLatencyAverage, cpuOverheadAvg, |
5866 | | | cpuSwapWaitTime |
5868 | | | - Measurements Domain Section 4.2.3 diskUsage: added |
5869 | | | ten optional fields to this structure: |
5870 | | | diskBusResets, diskCommandsAborted, diskCommandsAvg|
5871 | | | , diskFlushRequests, diskFlushTime, |
5872 | | | diskReadCommandsAvg, diskTime, diskTotalRead\ |
5873 | | | LatencyAvg, diskTotalWriteLatencyAvg, diskWrite\ |
5876 | | | - Measurements Domain Section 4.2.3: added a new |
5877 | | | ‘ipmi’ datatype along with following ‘supporting’ |
5878 | | | datatypes: ipmiBaseboardTemperature, ipmiBaseboard\|
5879 | | | VoltageRegulator, ipmiBattery, ipmiFan, ipmiGlobal\|
5880 | | | AggregateTemperatureMargin, ipmiHsbp, ipmiNic, |
5881 | | | ipmiPowerSupply, ipmiProcessor, processorDimm\ |
5882 | | | AggregateThermalMargin |
5884 | | | - Measurements Domain Section 4.2.3: added a new |
5885 | | | ‘load’ datatype |
5887 | | | - Measurements Domain Section 4.2.3 memoryUsage: |
5888 | | | added eight optional fields to this structure: |
5889 | | | memoryDemand, memoryLatencyAvg, memorySharedAvg, |
5890 | | | memorySwapInAvg, memorySwapInRateAvg, memorySwap\ |
5891 | | | OutAvg, memorySwapOutRateAvg, memorySwapUsedAvg |
5893 | | | - Measurements Domain Section 4.2.3: modified |
5894 | | | measurementFields to include the following new |
5895 | | | fields: hugePagesArray, ipmi, loadArray, memory\ |
5896 | | | Errors, processStatusArray, rdtArray |
5898 | | | - Measurements Domain Section 4.2.3 renamed vNic\ |
5899 | | | Performance to nicPerformance and changed vNic\ |
5900 | | | Identifer to nicIdentifier |
5902 | | | - Notification Domain Section 4.2.4: added |
5903 | | | notificationFields to support a new notification |
5906 | | | - pnfRegistration Domain Section 4.2.7: added |
5907 | | | pnfRegistrationFields to support a new registration|
5910 | | | - sysLog Domain Section 4.2.8: added two new fields: |
5911 | | | syslogMsgHost and syslogTs. Clarified field |
5912 | | | descriptions. Clarified syslogSData example. |
5914 | | | - endOfCallVqmSummaries Section 4.3.3.1: |
5916 | | | - converted endpointJitter into two fields: |
5917 | | | endpointAverageJitter and endpointMaxJitter |
5919 | | | - converted localJitter into two fields: |
5920 | | | localAverageJitter and localMaxJitter |
5922 | | | - added two fields: localAverageJitterBufferDelay |
5923 | | | and localMaxJitterBufferDelay |
5925 | | | - added endpointRtpOctetsLost and |
5926 | | | endpointRtpPacketsLost |
5928 | | | - added localRtpOctetsLost and localRtpPacketsLost|
5930 | | | - converted packetsLost into oneWayDelay |
5932 | | | - API Versioning: |
5934 | | | - Section 1.4: clarified the versioning section |
5935 | | | and linked it to the following new section 6.1.2|
5937 | | | - Section 6.1.2: Added requirements for HTTP |
5938 | | | headers communicating minor, patch and latest |
5939 | | | version information. |
5941 | | | - Section 2 and 6 sample messages: clarified |
5942 | | | examples to use the new HTTP headers |
5944 | | | - Section 6.1.4: Added a section specifying message |
5945 | | | size limits. |
5947 | | | - Section2 6.2.6.1 and 6.3.6.1: corrected |
5948 | | | additionalInformation examples to use hashMap |
5949 | | | instead of name-value pair fields. |
5951 | | | - Section 7: Added a section on Terminology. |
5953 | | | - Command List Processing: removed command list |
5954 | | | processing from the document and schema: |
5956 | | | - Modified the Section 3 resource structure to |
5957 | | | align with these changes. |
5959 | | | - Removed Section 4 Datatypes: command, |
5960 | | | commandList, eventDomainThrottleSpecification, |
5961 | | | eventDomainThrottleSpecificationList, |
5962 | | | eventThrottlingState, suppressedNvPairs |
5964 | | | - Removed Section 6.1 description of commands |
5965 | | | toward event source clients |
5967 | | | - Removed Section 6.4 operation: |
5968 | | | provideThrottlingState |
5969 +-----------+---------+-------------------------------------------------------+
5970 | 7/30/2018 | v7.0 | - General: |
5972 | | | - Fixed typos throughout |
5974 | | | - Changed example versions to v7 |
5978 | | | - Clarified casing and use of dashes versus colons|
5979 | | | in eventName examples |
5981 | | | - Updated all field block versions |
5983 | | | - Section 2: added a note clarifying that TLS 1.2 or |
5984 | | | higher must be used for HTTPS connections. |
5986 | | | - Section 4 embedded schema changed to v30: |
5988 | | | - Added " ‘additionalProperties’: false " to |
5989 | | | objects to reject events that attempt to send |
5990 | | | properties that are not listed in the |
5991 | | | ‘properties’ keyword. Note: does not affect |
5992 | | | hashmap extensible fields. |
5994 | | | - Changed all versions in all field blocks from |
5995 | | | number to string enum with the version number |
5996 | | | fixed by the enum so the schema can validate |
5997 | | | events that attempt to send non-standard field |
6000 | | | - Changed syslog additionalFields to a hashMap |
6002 | | | - Section 4: |
6004 | | | - Fixed section heading numbers that were the same|
6006 | | | - 4.1.1: jsonObjectInstance: added an optional |
6007 | | | recursive jsonObject and removed all required |
6008 | | | fields from this object |
6010 | | | - 4.1.2: commonEventHeader: |
6012 | | | - nfVendorName: added this optional field |
6014 | | | - timeZoneOffset: changed from number to string|
6015 | | | with a particular format specified |
6017 | | | - version was changed from number to string (as|
6018 | | | were all the version fields of all the field |
6021 | | | - vesCommonEventListenerVersion: added this |
6022 | | | required field as a string enumeration |
6024 | | | - 4.2.3: Measurements Domain: |
6026 | | | - Added a note clarifying that NFs are required|
6027 | | | to report exactly one Measurement event per |
6028 | | | period per sourceName |
6030 | | | - diskUsage: added four new optional fields: |
6031 | | | diskWeightedIoTimeAve, diskWeightedIoTimeLast|
6032 | | | , diskWeightedIoTimeMax, |
6033 | | | diskWeightedIoTimeMin |
6035 | | | - memoryUsage: add one new optional field: |
6036 | | | percentMemoryUsage |
6038 | | | - nicPerformance: added nine new optional |
6039 | | | fields: administrativeState, operationalState|
6040 | | | , receivedPercentDiscard, |
6041 | | | receivedPercentError, receivedUtilization, |
6042 | | | speed, transmittedPercentDiscard, |
6043 | | | transmittedPercentError, |
6044 | | | transmittedUtilization |
6046 | | | - processorDimmAggregateThermalMargin: make the|
6047 | | | thermalMargin field required |
6049 | | | - 4.2.8: Syslog Domain: |
6051 | | | - Corrected the example at the end of the section |
6052 +-----------+---------+-------------------------------------------------------+
6053 | 7/31/2018 | v7.0.1 | - Section 4: The schema embedded at the top of |
6054 | | | section 4 was patched to correct a header field |
6055 | | | name error—the schema version moves from 30 to |
6058 | | | - Changed commonEventHeader field: ‘vesCommon\ |
6059 | | | EventFormatVersion’ field to ‘vesEventListener\ |
6060 | | | Version’ and set the enum to 7.0.1 |
6062 | | | - Also changed the commonEventHeader ‘required’ |
6063 | | | array to reflect use the corrected field name: |
6064 | | | ‘vesEventListenerVersion’ |
6066 | | | - Changed the commonEventHeader ‘version’ field |
6067 | | | enumeration to 4.0.1 |
6071 | | | - Changed the field block versions for the common |
6072 | | | header for ‘vesEventListenerVersion’ (to 7.0.1) |
6073 | | | and ‘version’ (to 4.0.1). |
6075 | | | - Sections 2 and 6: |
6077 | | | - Changed the commonEventHeader version fields |
6078 | | | above, in the sample message requests and |
6079 | | | responses; also updated the faultFieldsVersion |
6082 | | | - Section 6.1.2: Changed the X-LatestVersion to 7.0.1|
6083 | | | and the X-PatchVersion to 1 |
6084 +-----------+---------+-------------------------------------------------------+
6085 | 12/10/2018| v7.1 | - Section 1.2: Added Notification domain Perf3gpp |
6086 | | | domain and changed a reference from ‘measurements |
6087 | | | domain’ to ‘measurement domain’. |
6089 | | | - Section 1.7.1: Field Block Versions: added |
6090 | | | ‘perf3gppFields’ version at 1.0 and changed the |
6091 | | | following version enumerations so that existing |
6092 | | | clients of major version 7 would not be broken by |
6093 | | | this VES minor version change, in accordance with |
6094 | | | semantic versioning definitions: |
6096 | | | - commonEventHeader: changed to |
6097 | | | ‘vesEventListenerVersion’ enum to accept either |
6098 | | | 7.0 or 7.0.1 or 7.1. |
6100 | | | - commonEventHeader: changed ‘version’ enum to |
6101 | | | accept either 4.0 or 4.0.1 or 4.1 |
6103 | | | - Section 2: |
6105 | | | - changed sample request and responses to |
6106 | | | reference 7.1 instead of 7.0.1 (and version 4.1 |
6107 | | | of the commonEventHeader version, instead of |
6110 | | | - added a sub section on service provider support |
6111 | | | for mutual ssl certificate authentication |
6113 | | | - Section 4.1.2.1: |
6115 | | | - CommonEventHeader timeZoneOffset changed |
6116 | | | description from ‘UTC+/-hh.mm’ to ‘UTC+/-hh:mm’ |
6118 | | | - Added ‘perf3gpp’ to the domain enumeration |
6120 | | | - Section 4.2.3: Measurement Domain Datatypes: |
6122 | | | - In ‘MeasurementFields’: Changed ‘ipmiArray’ to |
6123 | | | ‘ipmi’ and made the type ‘object’ |
6125 | | | - ‘ipmiProcessor’: changed |
6126 | | | ‘pprocessorThermalControl’ to |
6127 | | | ‘processorThermalControl’ |
6129 | | | - ‘machineCheckException’: changed |
6130 | | | ‘processIdentifier’ to ‘vmIdentifier’ |
6132 | | | - Section 4.2.6: added the perf3gpp domain |
6134 | | | - Section 4 embedded schema: |
6136 | | | - Changed the schema version from 30.0.1 to 30.1 |
6137 | | | as a result of the changes below: |
6139 | | | - commonEventHeader: changed to |
6140 | | | ‘vesEventListenerVersion’ enum to accept either |
6141 | | | 7.0, 7.0.1 or 7.1 |
6143 | | | - commonEventHeader: changed the ‘version’ field |
6144 | | | enumeration to accept either 4.0, 4.0.1 or 4.1 |
6146 | | | - commonEventHeader: changed the ‘domain’ |
6147 | | | enumeration to add support for the perf3gpp |
6150 | | | - ‘event’: added a reference to ‘perf3gppFields’ |
6152 | | | - ‘hugePages’: changed the type of |
6153 | | | hugePagesIdentifier from number to string |
6155 | | | - ‘ipmiGlobalAggregateTemperatureMargin’: changed |
6156 | | | ‘pmiGlobalAggregateTemperatureMarginIdentifier’ |
6157 | | | to ‘globalAggregateTemperatureMarginIdentifier’ |
6159 | | | - ‘perf3gppFields’: added this object |
6161 | | | - Section 6: changed references throughout from |
6162 | | | v7.0.1 to v7.1 and v4.0.1 (of the commonEventHeader|
6163 | | | version) to v4.1 |
6165 | | | - Changed the location of the doc to VNF |
6166 | | | Requirements and changed the formatting |
6167 +-----------+---------+-------------------------------------------------------+
6168 | 1/28/202 | v7.1.1 | - Changed event sizes from 2Mb to 1Mb |
6169 | | | - Configuration Requirement comments addressed |
6170 | | | - Changed DCAE Collector to VES Event Listener |
6171 | | | - Replaced VNF with NF where appropriate |
6172 | | | - Updated publishAnyEvent and publishBatchEvent to |
6173 | | | clarify both one way and mutual TLS are supported |
6174 | | | - Changed authorization for publishEventBatch |
6175 | | | because certification authorization is also |
6177 | | | - Updated fault use case in EventId Use Case |
6178 | | | Examples based on Ericsson feedback |
6179 | | | - Added new Configuration Requirements section |
6180 | | | - Added new Event Domain Requirements section |
6181 | | | - Updated security requirements based on agreements |
6182 | | | in ONAP Security Committee with details on 2-way |
6183 | | | certificate support |
6184 | | | - Provided clarifications on event buffering |
6185 | | | - Added Event Handling Requirements for |
6186 | | | publishEventFlow |
6187 | | | - Updated Field Block Versions to support existing |
6188 | | | clients of major version 7 |
6189 | | | - Updated sample request and response schemas |
6190 | | | - Updated embedded schema as follows: |
6192 | | | * Changed schema version to 30.1.1 |
6193 | | | * Changed measValues to measValuesList and similar |
6194 | | | changes throughout |
6195 | | | * Changed iMeasTypesList to sMeasTypesList |
6196 +-----------+---------+-------------------------------------------------------+
6198 .. _time_zone_abbreviations: https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations
6199 .. _Common_definitions: http://technical.openmobilealliance.org/Technical/release_program/docs/REST_NetAPI_Common/V1_0-20120417-C/OMA-TS-REST_NetAPI_Common-V1_0-20120417-C.pdf
Code Review / vnfrqts / requirements.git / blob