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_2:
8 Service: VES Event Listener 7.2
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: May 6th, 2020
31 :Author: Trevor Lovett
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** |
54 | | **Trevor Lovett – AT&T** |
56 | | **Rich Erickson – AT&T** |
57 +-----------------+-----------------------------+
59 .. contents:: Table of Contents
64 This document describes the RESTful interface for the VES Event
65 Listener. The VES acronym originally stood for Virtual-function Event
66 Streaming, but VES has been generalized to support network-function
67 event streaming, whether virtualized or not. The VES Event Listener is
68 capable of receiving any event sent in the VES
69 :ref:`ves_common_event_format_7_2`. In the VES Common Event Format, an event
70 consists of a required
71 :ref:`Common Event Header <ves_common_event_header_7_2>` (i.e., object)
72 accompanied by zero or more event domain blocks.
74 It should be understood that events are well structured packages of
75 information, identified by an ``eventName``, which are asynchronously
76 communicated to subscribers who are interested in the ``eventName``. Events
77 can convey measurements, faults, syslogs, threshold crossing alerts and
78 other types of information. Events are simply a way of communicating
79 well-structured packages of information to one or more instances of an
80 VES Event Listener service.
82 This document describes a RESTful, connectionless, push event listener
83 that can receive single events or batches of events in the
84 :ref:`ves_common_event_format_7_2`.
89 Three types of version numbers supported by this specification:
91 - The API specification itself is versioned. Going forward, the major
92 number of the specification version will be incremented whenever any
93 change could break an existing client (e.g., a field name is deleted
94 or changed). All other changes to the spec (e.g., a field name is
95 added, or text changes are made to the specification itself) will
96 increment only the minor number or patch number. Note that the major
97 number appears in REST resource URLs as v# (where ‘#’ is the major
98 number). Minor and patch numbers are communicated in HTTP headers.
99 For more information, see the API Versioning writeup in section 6.1.
101 - The JSON schema is versioned. Going forward, the major number of the
102 JSON schema will be incremented whenever any change could break an
103 existing client (e.g., a field name is deleted or changed). All other
104 changes to the schema (e.g., a field name is added or text changes
105 are made to the field descriptions) will increment only the minor
106 number or patch number.
108 - The field blocks are versioned. Field blocks include the
109 commonEventHeader and the domain blocks (e.g., the faultFields
110 block). Going forward, the major number of each field block will be
111 incremented whenever any change to that block could break an existing
112 client (e.g., a field name is deleted or changed). All other changes
113 to that block (e.g., a field name is added or text changes are made
114 to the field descriptions) will increment only the minor number.
119 Any NF or client library that is responsible for delivering VES events
120 to a VES Event Listener must comply with this specification to ensure events are
121 received, accepted, and processed properly.
123 Because the VES specification relies on clients to push events to the
124 VES Event Listener, the client assumes certain responsibilities such as:
126 - Providing configuration options supporting integration into a
127 Service Provider environment
128 - Ensuring reliable delivery of events
129 - Customization of default behaviors based on Service Provider needs
131 While the documentation of these expectations are beyond the Event Listener
132 specification, these requirements are documented in the ONAP VNF Requirements
133 for :ref:`VES Monitoring Requirements <ves_monitoring_requirements>`.
136 Compatibility with ONAP
137 ^^^^^^^^^^^^^^^^^^^^^^^
139 Unless otherwise stated, this version of the Event Listener specification is
140 compatible with the release of ONAP the specification is released under. In
141 other words, if the specification is released under the Frankfurt ONAP release,
142 then the VES Event Listeners provided by DCAE will also be compatible with
145 Support for Protocols Other Than HTTPS
146 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
148 This API specification describes an HTTPS RESTful interface using the
151 Alternative API specifications may be provided in future using Google
152 Protocol Buffers, WebSockets, or Apache Avro.
157 A summary of the latest field block version enums as of this version of
158 the API spec is provided below:
160 - commonEventHeader version 4.1 (note: the enum with support 4.0,
161 4.0.1, 4.1 to avoid breaking clients of earlier versions of major
164 - commonEventHeader vesEventListenerVersion enum: 7.1 (note: the enum
165 will support 7.0, 7.0.1, 7.1 to avoid breaking clients of earlier
166 versions of major version 7)
168 - faultFieldsVersion:4.0
170 - heartbeatFieldsVersion: 3.0
172 - measurementFieldsVersion: 4.0
174 - mobileFlowFieldsVersion: 4.0
176 - notificationFieldsVersion: 2.0
178 - otherFieldsVersion: 3.0
180 - perf3gppFieldsVersion: 1.0
182 - pnfRegistrationFieldsVersion: 2.0
184 - sigSignalingFieldsVersion: 3.0
186 - stateChangeFieldsVersion: 4.0
188 - syslogFieldsVersion: 4.0
190 - thresholdCrossingFieldsVersion: 4.0
192 - voiceQualityFieldsVersion: 4.0
194 .. _ves_common_event_format_7_2:
199 A JSON schema describing the Common Event Format is provided below and
200 is reproduced in the tables that follow.
202 :download:`JSON <CommonEventFormat_30.2_ONAP.json>`
205 Note on optional fields:
207 If the event publisher collects a field that is identified as
208 optional in the data structures below, then the event publisher
209 *must* send that field.
211 Note on extensible fields:
213 VES contains various extensible structures (e.g., hashMap) that
214 enable event publishers to send information that has not been
215 explicitly defined in VES data structures.
217 - Event publishers *must not* send information through extensible
218 structures where VES has explicitly defined fields for that
219 information. For example, event publishers *must not* send
220 information like cpuIdle, through an extensible structure, because
221 VES has explicitly defined a cpuUsage.cpuIdle field for the
222 communication of that information.
224 - Keys sent through extensible fields should use camel casing to separate
225 words and acronyms; only the first letter of each acronym shall be
228 Common Event Datatypes
229 ~~~~~~~~~~~~~~~~~~~~~~~~
231 Datatype: arrayOfJsonObject
232 ++++++++++++++++++++++++++++
234 The arrayOfJsonObject datatype provides an array of json objects, each
235 of which is describ ed by name, schema and other meta-information. It
236 consists of the following fields:
238 +---------------------+------------------+----------+----------------------+
239 | Field | Type | Required?| Description |
240 +=====================+==================+==========+======================+
241 | arrayOfJsonObject | jsonObject [ ] | Yes | Array of jsonObject |
242 +---------------------+------------------+----------+----------------------+
244 Datatype: arrayOfNamedHashMap
245 ++++++++++++++++++++++++++++++
247 The arrayOfNamedHashMap datatype provides an array of hashMaps, each of
248 which is associated with a descriptive name. It consists of the
251 +---------------------+------------------+-----------+-----------------------+
252 | Field | Type | Required? | Description |
253 +=====================+==================+===========+=======================+
254 | arrayOfNamedHashMap | namedHashMap [ ] | Yes | Array of namedHashMap |
255 +---------------------+------------------+-----------+-----------------------+
260 The event datatype consists of the following fields which constitute the
261 ‘root level’ of the common event format:
263 +--------------+--------------+-----------+-----------------------------------+
264 | Field | Type | Required? | Description |
265 +==============+==============+===========+===================================+
266 | commonEvent\ | commonEvent\ | Yes | Fields common to all events |
267 | Header | Header | | |
268 +--------------+--------------+-----------+-----------------------------------+
269 | faultFields | faultFields | No | Fields specific to fault events |
270 +--------------+--------------+-----------+-----------------------------------+
271 | heartbeat\ | heartbeat\ | No | Fields specific to heartbeat |
272 | Fields | Fields | | events |
273 +--------------+--------------+-----------+-----------------------------------+
274 | measurement\ | measurement\ | No | Fields specific to measurement |
275 | Fields | Fields | | events |
276 +--------------+--------------+-----------+-----------------------------------+
277 | mobileFlow\ | mobileFlow\ | No | Fields specific to mobility flow |
278 | Fields | Fields | | events |
279 +--------------+--------------+-----------+-----------------------------------+
280 | notification\| notification\| No | Fields specific to notification |
281 | Fields | Fields | | events |
282 +--------------+--------------+-----------+-----------------------------------+
283 | otherFields | otherFields | No | Fields specific to other types of |
285 +--------------+--------------+-----------+-----------------------------------+
286 | perf3gpp\ | perf3gpp\ | No | Fields specific to perf3gpp |
287 | Fields | Fields | | events |
288 +--------------+--------------+-----------+-----------------------------------+
289 | pnf\ | pnf\ | No | Fields specific to pnfRegistration|
290 | Registration\| Registration\| | events |
291 | Fields | Fields | | |
292 +--------------+--------------+-----------+-----------------------------------+
293 | sipSignaling\| sipSignaling\| No | Fields specific to sipSignaling |
294 | Fields | Fields | | events |
295 +--------------+--------------+-----------+-----------------------------------+
296 | stateChange\ | stateChange\ | No | Fields specific to state change |
297 | Fields | Fields | | events |
298 +--------------+--------------+-----------+-----------------------------------+
299 | syslogFields | syslogFields | No | Fields specific to syslog events |
300 +--------------+--------------+-----------+-----------------------------------+
301 | threshold\ | threshold\ | No | Fields specific to threshold |
302 | Crossing\ | Crossing\ | | crossing alert events |
303 | AlertFields | AlertFields | | |
304 +--------------+--------------+-----------+-----------------------------------+
305 | voiceQuality\| voiceQuality\| No | Fields specific to voiceQuality |
306 | Fields | Fields | | events |
307 +--------------+--------------+-----------+-----------------------------------+
312 The eventList datatype consists of the following fields:
314 +-------------+-------------+----------+-------------------+
315 | Field | Type | Required?| Description |
316 +=============+=============+==========+===================+
317 | eventList | event [ ] | Yes | Array of events |
318 +-------------+-------------+----------+-------------------+
323 The hashMap datatype is an ‘associative array’, which is an unordered
324 collection of key-value pairs of the form "key": "value", where each key
325 and value are strings. Keys should use camel casing to separate words and
326 acronyms; only the first letter of each acronym should be capitalized.
331 The jsonObject datatype provides a json object schema, name and other
332 meta-information along with one or more object instances that conform to
335 +--------------+--------------+-----------+----------------------------------+
336 | Field | Type | Required? | Description |
337 +==============+==============+===========+==================================+
338 | object\ | JsonObject\ | Yes | Contains one or more instances of|
339 | Instances | Instance [ ] | | the json object |
340 +--------------+--------------+-----------+----------------------------------+
341 | objectName | string | Yes | Name of the json object |
342 +--------------+--------------+-----------+----------------------------------+
343 | objectSchema | string | No | json schema for the object |
344 +--------------+--------------+-----------+----------------------------------+
345 | objectSchema\| string | No | URL to the json schema for the |
347 +--------------+--------------+-----------+----------------------------------+
348 | nfSubscribed\| string | No | Name of the object associated |
349 | ObjectName | | | with the nfSubscriptionId |
350 +--------------+--------------+-----------+----------------------------------+
351 | nf\ | string | No | Identifies an openConfig |
352 | Subscription\| | | telemetry subscription on a |
353 | Id | | | network function, which |
354 | | | | configures the network function |
355 | | | | to send complex object data |
356 | | | | associated with the jsonObject |
357 +--------------+--------------+-----------+----------------------------------+
359 Datatype: jsonObjectInstance
360 +++++++++++++++++++++++++++++
362 The jsonObjectInstance datatype provides meta-information about an
363 instance of a jsonObject along with the actual object instance:
365 +----------------+------------+----------+-----------------------------------+
366 | Field | Type | Required?| Description |
367 +================+============+==========+===================================+
368 | jsonObject | jsonObject | No | Optional recursive specification |
369 | | | | of jsonObject |
370 +----------------+------------+----------+-----------------------------------+
371 | objectInstance | object | No | Contains an instance conforming to|
372 | | | | the jsonObject schema |
373 +----------------+------------+----------+-----------------------------------+
374 | objectInstance\| number | No | the unix time, aka epoch time, |
375 | EpochMicrosec | | | associated with this |
376 | | | | objectInstance--as microseconds |
377 | | | | elapsed since 1 Jan 1970 not |
378 | | | | including leap seconds |
379 +----------------+------------+----------+-----------------------------------+
380 | objectKeys | key [ ] | No | An ordered set of keys that |
381 | | | | identifies this particular |
382 | | | | instance of jsonObject (e.g., that|
383 | | | | places it in a hierarchy) |
384 +----------------+------------+----------+-----------------------------------+
389 The key datatype is a tuple which provides the name of a key along with
390 its value and relative order; it consists of the following fields:
392 +----------+---------+-----------+-------------------------------------------+
393 | Field | Type | Required? | Description |
394 +==========+=========+===========+===========================================+
395 | keyName | string | Yes | Name of the key |
396 +----------+---------+-----------+-------------------------------------------+
397 | keyOrder | Integer | No | Relative sequence or order of the key |
398 | | | | (with respect to other keys) |
399 +----------+---------+-----------+-------------------------------------------+
400 | keyValue | string | No | Value of the key |
401 +----------+---------+-----------+-------------------------------------------+
403 Datatype: namedHashMap
404 ++++++++++++++++++++++++
406 The namedHashMap datatype is a hashMap which is associated with and
407 described by a name; it consists of the following fields:
409 +---------+---------+-----------+--------------------------------------------+
410 | Field | Type | Required? | Description |
411 +=========+=========+===========+============================================+
412 | name | string | Yes | Name associated with or describing the |
414 +---------+---------+-----------+--------------------------------------------+
415 | hashMap | hashMap | Yes | One or more key:value pairs |
416 +---------+---------+-----------+--------------------------------------------+
418 Datatype: requestError
419 +++++++++++++++++++++++
421 The requestError datatype defines the standard request error data
424 +-----------+--------+-----------+-------------------------------------------+
425 | Field | Type | Required? | Description |
426 +===========+========+===========+===========================================+
427 | messageId | string | Yes | Unique message identifier of the format |
428 | | | | ‘ABCnnnn’ where ‘ABC’ is either ‘SVC’ for |
429 | | | | Service Exceptions or ‘POL’ for Policy |
430 | | | | Exception. Exception numbers may be in the|
431 | | | | range of 0001 to 9999 where 0001 to 2999 |
432 | | | | are defined by OMA (see section 5.1) and |
433 | | | | 3000-9999 are available and undefined. |
434 +-----------+--------+-----------+-------------------------------------------+
435 | text | string | Yes | Message text, with replacement variables |
436 | | | | marked with %n, where n is an index into |
437 | | | | the list of <variables> elements, starting|
439 +-----------+--------+-----------+-------------------------------------------+
440 | url | string | No | Hyperlink to a detailed error resource |
441 | | | | e.g., an HTML page for browser user agents|
442 +-----------+--------+-----------+-------------------------------------------+
443 | variables | string | No | List of zero or more strings that |
444 | | | | represent the contents of the variables |
445 | | | | used by the message text |
446 +-----------+--------+-----------+-------------------------------------------+
448 Datatype: vendorNfNameFields
449 +++++++++++++++++++++++++++++
451 The vendorNfNameFields provides vendor, nf and nfModule identifying
454 +--------------+--------+-----------+----------------------------------------+
455 | Field | Type | Required? | Description |
456 +==============+========+===========+========================================+
457 | vendorName | string | Yes | Network function vendor name |
458 +--------------+--------+-----------+----------------------------------------+
459 | nfModuleName | string | No | Name of the nfModule generating the |
461 +--------------+--------+-----------+----------------------------------------+
462 | nfName | string | No | Name of the network function generating|
464 +--------------+--------+-----------+----------------------------------------+
466 Common Event Header Data Types
467 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
469 .. _ves_common_event_header_7_2:
471 Datatype: commonEventHeader
472 ++++++++++++++++++++++++++++
474 The commonEventHeader datatype consists of the following fields common
477 +-----------+----------+-----------+-----------------------------------------+
478 | Field | Type | Required? | Description |
479 +===========+==========+===========+=========================================+
480 | domain | string | Yes | Event domain enumeration: ‘fault’, |
481 | | | | ‘heartbeat’, ‘measurement’, ‘mobileFlow’|
482 | | | | , ‘notification’, ‘other’, ‘perf3gpp’, |
483 | | | | ‘pnfRegistration’, ‘sipSignaling’, |
484 | | | | ‘stateChange’, ‘syslog’, |
485 | | | | ‘thresholdCrossingAlert’, ‘voiceQuality’|
486 +-----------+----------+-----------+-----------------------------------------+
487 | eventId | string | Yes | Event key that is unique to the event |
488 | | | | source. The key must be unique within |
489 | | | | notification life cycle similar to |
490 | | | | EventID from 3GPP. It could be a |
491 | | | | sequential number, or a composite key |
492 | | | | formed from the event fields, such as |
493 | | | | domain\_sequence. The eventId should not|
494 | | | | include whitespace. For fault events, |
495 | | | | eventId is the eventId of the initial |
496 | | | | alarm; if the same alarm is raised again|
497 | | | | for changed, acknowledged or cleared |
498 | | | | cases, eventId must be the same as the |
499 | | | | initial alarm (along with the same |
500 | | | | startEpochMicrosec but with a different |
501 | | | | sequence number). |
502 | | | | See :ref:`ves_eventid_usecases_7_2` for |
503 | | | | additional guidance on eventId usage. |
504 +-----------+----------+-----------+-----------------------------------------+
505 | eventName | string | Yes | See :ref:`ves_eventname_guidelines_7_2`|
506 | | | | for additional information on naming |
508 +-----------+----------+-----------+-----------------------------------------+
509 | eventType | string | No | |
510 +-----------+----------+-----------+-----------------------------------------+
511 | internal\ | internal\| No | Fields (not supplied by event sources) |
512 | Header | Header | | that the VES Event Listener service can |
513 | Fields | Fields | | use to enrich the event if needed for |
514 | | | | efficient internal processing. This is |
515 | | | | an empty object which is intended to be |
516 | | | | defined separately by each service |
517 | | | | provider (e.g., AT&T) implementing the |
518 | | | | VES Event Listener. |
519 +-----------+----------+-----------+-----------------------------------------+
520 | lastEpoch\| number | Yes | the latest unix time aka epoch time |
521 | Microsec | | | associated with the event from any |
522 | | | | component--as microseconds elapsed since|
523 | | | | 1 Jan 1970 not including leap seconds |
524 +-----------+----------+-----------+-----------------------------------------+
525 | nfcNaming\| string | No | Network function component type: 3 |
526 | Code | | | characters (aligned with vfc naming |
528 +-----------+----------+-----------+-----------------------------------------+
529 | nfNaming\ | string | No | Network function type: 4 characters |
530 | Code | | | (aligned with vnf and pnf naming |
532 +-----------+----------+-----------+-----------------------------------------+
533 | nfVendor\ | string | No | |
535 +-----------+----------+-----------+-----------------------------------------+
536 | priority | string | Yes | |
537 +-----------+----------+-----------+-----------------------------------------+
538 | reporting\| string | No | UUID identifying the entity reporting |
539 | EntityId | | | the event or detecting a problem in |
540 | | | | another vnf/vm or pnf which is |
541 | | | | experiencing the problem. (Note: the |
542 | | | | AT&T internal enrichment process shall |
543 | | | | ensure that this field is populated). |
544 | | | | The reportingEntityId is an id for the |
545 | | | | reportingEntityName. See |
546 | | | | ‘reportingEntityName’ for more |
547 | | | | information. |
548 +-----------+----------+-----------+-----------------------------------------+
549 | reporting\| string | Yes | Name of the entity reporting the event |
550 | EntityName| | | or detecting a problem in another vnf/vm|
551 | | | | or pnf which is experiencing the |
552 | | | | problem. May be the same as the |
553 | | | | sourceName. For synthetic events |
554 | | | | generated by DCAE, it is the name of the|
555 | | | | app generating the event. |
556 +-----------+----------+-----------+-----------------------------------------+
557 | sequence | integer | Yes | Ordering of events communicated by an |
558 | | | | event source instance (or 0 if not |
560 +-----------+----------+-----------+-----------------------------------------+
561 | sourceId | string | No | UUID identifying the entity experiencing|
562 | | | | the event issue, which may be detected |
563 | | | | and reported by a separate reporting |
564 | | | | entity (note: the AT&T internal |
565 | | | | enrichment process shall ensure that |
566 | | | | this field is populated). The sourceId |
567 | | | | is an id for the sourceName. See |
568 | | | | ‘sourceName’ for more information. |
569 +-----------+----------+-----------+-----------------------------------------+
570 | sourceName| string | Yes | Name of the entity experiencing the |
571 | | | | event issue, which may be detected and |
572 | | | | reported by a separate reporting entity.|
573 | | | | The sourceName identifies the device for|
574 | | | | which data is collected. A valid |
575 | | | | sourceName must be inventoried in A&AI. |
576 | | | | If sourceName is a xNF (vnf or pnf), |
577 | | | | xNFC or VM, then the event must be |
578 | | | | reporting data for that particular xNF, |
579 | | | | xNFC or VM. If the sourceName is a xNF, |
580 | | | | comprised of multiple xNFCs, the data |
581 | | | | must be reported/aggregated at the xNF |
582 | | | | level. Data for individual xNFC must not|
583 | | | | be included in the xNF sourceName event.|
584 +-----------+----------+-----------+-----------------------------------------+
585 | start\ | number | Yes | the earliest unix time aka epoch time |
586 | Epoch\ | | | associated with the event from any |
587 | Microsec | | | component--as microseconds elapsed since|
588 | | | | 1 Jan 1970 not including leap seconds. |
589 | | | | For measurements and heartbeats, where |
590 | | | | events are collected over predefined |
591 | | | | intervals, startEpochMicrosec shall be |
592 | | | | rounded to the nearest interval boundary|
593 | | | | (e.g., the epoch equivalent of 3:00PM, |
594 | | | | 3:10PM, 3:20PM, etc…). For fault events,|
595 | | | | startEpochMicrosec is the timestamp of |
596 | | | | the initial alarm; if the same alarm is |
597 | | | | raised again for changed, acknowledged |
598 | | | | or cleared cases, startEpoch Microsec |
599 | | | | must be the same as the initial alarm |
600 | | | | (along with the same eventId and an |
601 | | | | incremental sequence number). For |
602 | | | | devices with no timing source (clock), |
603 | | | | the default value will be 0 and the VES |
604 | | | | collector will replace it with Collector|
605 | | | | time stamp (when the event is received) |
606 +-----------+----------+-----------+-----------------------------------------+
607 | timeZone\ | string | No | Offset to GMT to indicate local time |
608 | Offset | | | zone for device formatted as |
609 | | | | ‘UTC+/-hh:mm’; see |
610 | | | | time_zone_abbreviations_ for UTC offset |
612 +-----------+----------+-----------+-----------------------------------------+
613 | version | string | Yes | Version of the event header as "#.#" |
614 | | | | where # is a digit; see section 1 for |
615 | | | | the correct digits to use. |
616 +-----------+----------+-----------+-----------------------------------------+
617 | vesEvent\ | string | Yes | Version of the ves event listener api |
618 | Listener\ | | | spec that this event is compliant with |
619 | Version | | | (as "#" or "#.#" or "#.#.#" where # is a|
620 | | | | digit; see section 1 for the correct |
621 | | | | digits to use). |
622 +-----------+----------+-----------+-----------------------------------------+
624 Datatype: internalHeaderFields
625 ++++++++++++++++++++++++++++++
627 The internalHeaderFields datatype is an undefined object which can
628 contain arbitrarily complex JSON structures. It is intended to be
629 defined separately by each service provider (e.g., AT&T) implementing
630 the VES Event Listener. The fields in internalHeaderFields are not
631 provided by any event source but instead are added by the VES Event
632 Listener service itself as part of an event enrichment process necessary
633 for efficient internal processing of events received by the VES Event
637 .. _ves_eventname_guidelines_7_2:
639 Best Practices for eventName
640 ++++++++++++++++++++++++++++
642 To prevent naming collisions, eventNames sent as part of the
643 commonEventHeader, should conform to the following naming convention
644 designed to summarize the purpose and type of the event, and to ensure
645 the uniqueness of the eventName:
647 ``{DomainAbbreviation}_{PublisherName}_{Description}``
649 Each underscore-separated subfield above should start with a capital
650 letter and use camel-casing to separate words and acronyms. Acronyms
651 should capitalize only the first letter of the acronym. Spaces and
652 underscores should not appear within any subfield.
654 The DomainAbbreviation subfield derives from the ‘domain’ field in the
655 commonEventHeader, as specified below:
657 - ‘Fault’ for the fault domain
659 - ‘Heartbeat’ for the heartbeat domain
661 - ‘Measurement’ for the measurement domain
663 - ‘MobileFlow’ for the mobileFlow domain
665 - ‘Notification’ for the notification domain
667 - ‘Other’ for the other domain
669 - ‘Perf3gpp’ for the perf3gpp domain
671 - ‘PnfReg’ for the pnfRegistration domain
673 - ‘SipSignaling’ for the sipSignaling domain
675 - ‘StateChange’ for the stateChange domain
677 - ‘Syslog’ for the syslog domain
679 - ‘Tca’ for the thresholdCrossingAlert domain
681 - ‘VoiceQuality’ for the voiceQuality domain
683 The PublisherName subfield describes the vendor product or application
684 publishing the event. This subfield conforms to the following
687 - Vendor products are specified as: ``{productName}-{vendorName}``
689 For example: ``Visbc-Metaswitch`` or ``Vdbe-Juniper``, where a hyphen is
690 used to separate the ``productName`` and ``vendorName`` subfields. Note that
691 the ``productName`` and ``vendorName`` subfields must not include hyphens
694 Organizing the information in this way will cause an alphabetical
695 listing of eventNames to sort similar network functions together,
696 rather than to sort them by vendor.
698 The ``productName`` subfield may describe a NF or a NFC. Where NFC names
699 may be reused across different NF’s, they should be specified as:
701 ``{NfName}:{NfcName}``
703 where a colon is used to separate the ``NfName`` and ``NfcName`` subfields.
704 Note that the ``NfName`` and ``NfcName`` subfields must not include colons
707 The ``productName`` may also describe other types of vendor modules or
708 components such as a VM, application or hostname. As with NFs and
709 NFCs, parent:child relationships may be communicated using colon as
710 a subfield delimiter.
712 - Service providers who adopt the VES Common Event Format for internal
713 use, may provide PublisherName without the vendorName subfield. They
714 would typically identify an application, system, service or
715 microservice publishing the event (e.g., ‘Policy’, ‘So’,
716 ‘MobileCallRecording’ or ‘Dkat’). As with NFs and NFCs, parent:child
717 relationships may be communicated using colon as a subfield delimiter
718 (e.g., ApplicationName:ApplicationComponent).
720 The final subfield of the eventName name should describe, in a compact
721 camel case format the specific information being conveyed by the event.
722 In some cases, this final subfield may not be required (e.g., in the
723 case of certain heartbeats).
725 Examples of event names following the naming standards are provided
728 - ``Tca_Vdbe-Ericsson_CpuThresholdExceeded``
730 - ``Heartbeat_Visbc:Mmc-Metaswitch``
732 - ``Syslog_Vdbe-Ericsson``
734 - ``Fault_MobileCallRecording_PilotNumberPoolExhaustion``
736 - ``Other_So:WanBonding_InstantiationPart1Complete``
738 .. _ves_eventid_usecases_7_2:
740 EventId Use Cases Examples
741 ++++++++++++++++++++++++++
743 ``eventId`` Examples:
745 **NOTE**: Please note, the following are only *examples*, and other formats
746 can be used provided they meet the requirement that the ``eventId`` is unique
747 for all events or unique fault occurrence.
749 **Example 1**: assumes a unique key for each domain consisting of domain
750 followed by an integer domain<n> or domainId<n>, where <n> is a positive integer,
751 e.g. fault000001, heartbeat000001, measurement000005,
752 notification3gppPerfFileReady0005
754 **Example 2**: assumes a unique integer key for all events across all domains
755 <n>: 000000001, 00000002, 000000003
759 1. All domains except Fault: each time a subsequent event is sent the
760 integer part of eventId will increment by 1. Repeat of eventId
761 assumes duplicate event. Sequence number is set to 0 for all domains
764 2. eventId construction for Fault Events:
766 a. Most likely scenario
768 * The sourceName on each Fault event is the NF Instance Name
769 (pnf-name or vnf-name or vm-name) as entered in A&AI uniquely
770 identifying this instance of the NF.
772 * The eventId on Fault events is the same every time a given
773 fault is raised (including onset and re-raise)
775 1. The startEpochMicrosec value for the Fault event is the
776 timestamp for when the fault onset occurs. Subsequent
777 events for the same fault will keep the same startEpochMicrosec
780 2. lastEpochMicrosec indicates the current event time. This value
781 will be updated for each subsequent event for a given fault.
783 3. The sequence number for each Fault event is set to 1 when the
784 fault is raised and increments each time the same
785 fault event is raised, until a clear is sent.
787 * After the fault is cleared, a new eventId is used.
789 .. image:: Use-Case-1.png
791 b. **Alternative Scenario**: Network Function When Fault Event Status is Not
794 * The sourceName on each Fault event is the NF Instance Name
795 (pnf-name or vnf-name or vm-name) as entered in A&AI uniquely
796 identifying this instance of the NF.
798 * The eventId on Fault events is the same every time a given
799 fault is raised or cleared, even if it is re-raised after it
800 had previously cleared. So, for example, if EMS loses
801 contact with a particular device then a Fault event might be
802 sent for a raise, re-raise (because EMS has re-tried and
803 still can’t contact the device), clear (because EMS has
804 re-tried and it can contact the device) and then raise again
805 (because EMS has lost contact with the device again). The
806 same eventId is used for all 4 of those Fault events.
808 * The startEpochMicrosec value for each Fault event is the
809 timestamp for when that event is generated, not when the
810 fault first occurred. So all 4 of the Fault events in the
811 previous bullet point would have a different timestamp.
813 * lastEpochMicrosec indicates the current event time.
815 * The sequence number for each Fault event is currently set to
816 0 on a raise and 1 on a clear. We could change that so that
817 each Fault event is given a new monotonically increasing
818 sequence number whether it is a raise or a clear if that is
819 helpful (which is reset to 0 if the VM restarts) but they
820 won’t be consecutive.
822 * Normally, a clear is expected for each fault to be sent from a
823 network function. However a few fault notification types will never
824 be re-raised or cleared. In this case, general rules for VES events
825 shall be followed with a new eventId for each event and sequence
828 .. image:: Use-Case-2.png
831 Technology Independent Datatypes
832 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
834 ‘Fault’ Domain Datatypes
835 +++++++++++++++++++++++++
837 Datatype: faultFields
838 *********************
840 The faultFields datatype consists of the following fields:
842 +-----------------+---------+-----------+-------------------------------------+
843 | Field | Type | Required? | Description |
844 +=================+=========+===========+=====================================+
845 | alarmAdditional | hashMap | No | Additional alarm information. |
846 | Information | | | |
848 | | | | - Note1: for SNMP mapping to VES, |
849 | | | | for hash key use OID of varbind, |
850 | | | | for value use incoming data for |
851 | | | | that varbind). |
853 | | | | - Note2: Alarm ID for 3GPP should be|
854 | | | | included (if applicable) in |
855 | | | | alarmAdditonalInformation as |
856 | | | | ‘alarmId’:’alarmIdValue’. |
858 | | | | Could contain managed object |
859 | | | | instance as separate key:value; |
860 | | | | could add probable cause as separate|
862 +-----------------+---------+-----------+-------------------------------------+
863 | alarmCondition | string | Yes | Short name of the alarm |
864 | | | | condition/problem, such as a trap |
865 | | | | name. Should not have white space |
866 | | | | (e.g., tpLgCgiNotInConfig, |
867 | | | | BfdSessionDown, linkDown, etc…) |
868 +-----------------+---------+-----------+-------------------------------------+
869 | alarmInterfaceA | string | No | Card, port, channel or interface |
870 | | | | name of the device generating the |
871 | | | | alarm. This could reflect managed |
873 +-----------------+---------+-----------+-------------------------------------+
874 | eventCategory | string | No | Event category, for example: |
875 | | | | ‘license’, ‘link’, ‘routing’, |
876 | | | | ‘security’, ‘signaling’ |
877 +-----------------+---------+-----------+-------------------------------------+
878 | eventSeverity | string | Yes | Event severity enumeration: |
879 | | | | ‘CRITICAL’, ‘MAJOR’, ‘MINOR’, |
880 | | | | ‘WARNING’, ‘NORMAL’. NORMAL is used |
881 | | | | to represent clear. |
882 +-----------------+---------+-----------+-------------------------------------+
883 | eventSourceType | string | Yes | Examples: ‘card’, ‘host’, ‘other’, |
884 | | | | ‘port’, ‘portThreshold’, ‘router’, |
885 | | | | ‘slotThreshold’, ‘switch’, |
886 | | | | ‘virtualMachine’, |
887 | | | | ‘virtualNetworkFunction’. This could|
888 | | | | be managed object class. |
889 +-----------------+---------+-----------+-------------------------------------+
890 | faultFields\ | string | Yes | Version of the faultFields block as |
891 | Version | | | "#.#" where # is a digit; see |
892 | | | | section 1 for the correct digits to |
894 +-----------------+---------+-----------+-------------------------------------+
895 | specificProblem | string | Yes | Description of the alarm or problem |
896 | | | | (e.g., ‘eNodeB 155197 in PLMN |
897 | | | | 310-410 with eNodeB name KYL05197 is|
898 | | | | lost’). 3GPP probable cause would be|
899 | | | | included in this field. |
900 +-----------------+---------+-----------+-------------------------------------+
901 | vfStatus | string | Yes | Virtual function status enumeration:|
902 | | | | ‘Active’, ‘Idle’, ‘Preparing to |
903 | | | | terminate’, ‘Ready to terminate’, |
904 | | | | ‘Requesting Termination’ |
905 +-----------------+---------+-----------+-------------------------------------+
907 Heartbeat’ Domain Datatypes
908 ++++++++++++++++++++++++++++
910 Datatype: heartbeatFields
911 *************************
913 The heartbeatFields datatype is an optional field block for fields
914 specific to heartbeat events; it consists of the following fields:
916 +---------------+---------+-----------+---------------------------------------+
917 | Field | Type | Required? | Description |
918 +===============+=========+===========+=======================================+
919 | additional\ | hashMap | No | Additional expansion fields if needed |
921 +---------------+---------+-----------+---------------------------------------+
922 | heartbeat\ | string | Yes | Version of the heartbeatFields block |
923 | FieldsVersion | | | as "#.#" where # is a digit; see |
924 | | | | section 1 for the correct digits to |
926 +---------------+---------+-----------+---------------------------------------+
927 | heartbeat\ | Integer | Yes | Current heartbeatInterval in seconds |
929 +---------------+---------+-----------+---------------------------------------+
931 ‘Measurements’ Domain Datatypes
932 ++++++++++++++++++++++++++++++++
934 Note: NFs are required to report exactly one Measurement event per
935 period per sourceName.
937 Datatype: codecsInUse
938 *********************
940 The codecsInUse datatype consists of the following fields describing the
941 number of times an identified codec was used over the
944 +------------------+-----------+----------+--------------------------------+
945 | Field | Type | Required?| Description |
946 +==================+===========+==========+================================+
947 | codecIdentifer | string | Yes | Description of the codec |
948 +------------------+-----------+----------+--------------------------------+
949 | numberInUse | integer | Yes | Number of such codecs in use |
950 +------------------+-----------+----------+--------------------------------+
955 The cpuUsage datatype defines the usage of an identifier CPU and
956 consists of the following fields:
958 +------------+--------+-----------+-------------------------------------------+
959 | Field | Type | Required? | Description |
960 +============+========+===========+===========================================+
961 | cpu\ | number | No | The amount of time the CPU cannot run due |
962 | Capacity\ | | | to contention, in milliseconds over the |
963 | Contention | | | measurementInterval |
964 +------------+--------+-----------+-------------------------------------------+
965 | cpu\ | number | No | The total CPU time that the NF/NFC/VM |
966 | Demand\ | | | could use if there was no contention, in |
967 | Avg | | | milliseconds over the measurementInterval |
968 +------------+--------+-----------+-------------------------------------------+
969 | cpu\ | number | No | CPU demand in MHz |
972 +------------+--------+-----------+-------------------------------------------+
973 | cpu\ | number | No | CPU demand as a percentage of the |
974 | Demand\ | | | provisioned capacity |
976 +------------+--------+-----------+-------------------------------------------+
977 | cpu\ | string | Yes | CPU Identifier |
979 +------------+--------+-----------+-------------------------------------------+
980 | cpu\ | number | No | Percentage of CPU time spent in the idle |
982 +------------+--------+-----------+-------------------------------------------+
983 | cpu\ | number | No | Percentage of time the VM is unable to run|
984 | Latency\ | | | because it is contending for access to the|
985 | Avg | | | physical CPUs |
986 +------------+--------+-----------+-------------------------------------------+
987 | cpu\ | number | No | The overhead demand above available |
988 | Overhead\ | | | allocations and reservations, in |
989 | Avg | | | milliseconds over the measurementInterval |
990 +------------+--------+-----------+-------------------------------------------+
991 | cpuSwap\ | number | No | Swap wait time, in milliseconds over the |
992 | WaitTime | | | measurementInterval |
993 +------------+--------+-----------+-------------------------------------------+
994 | cpuUsage\ | number | No | Percentage of time spent servicing |
995 | Interrupt | | | interrupts |
996 +------------+--------+-----------+-------------------------------------------+
997 | cpuUsage\ | number | No | Percentage of time spent running user |
998 | Nice | | | space processes that have been niced |
999 +------------+--------+-----------+-------------------------------------------+
1000 | cpuUsage\ | number | No | Percentage of time spent handling soft irq|
1001 | SoftIrq | | | interrupts |
1002 +------------+--------+-----------+-------------------------------------------+
1003 | cpuUsage\ | number | No | Percentage of time spent in involuntary |
1004 | Steal | | | wait which is neither user, system or idle|
1005 | | | | time and is effectively time that went |
1007 +------------+--------+-----------+-------------------------------------------+
1008 | cpuUsage\ | number | No | Percentage of time spent on system tasks |
1009 | System | | | running the kernel |
1010 +------------+--------+-----------+-------------------------------------------+
1011 | cpuUsage\ | number | No | Percentage of time spent running un-niced |
1012 | User | | | user space processes |
1013 +------------+--------+-----------+-------------------------------------------+
1014 | cpuWait | number | No | Percentage of CPU time spent waiting for |
1015 | | | | I/O operations to complete |
1016 +------------+--------+-----------+-------------------------------------------+
1017 | percent\ | number | Yes | Aggregate cpu usage of the virtual machine|
1018 | Usage | | | on which the xNFC reporting the event is |
1020 +------------+--------+-----------+-------------------------------------------+
1023 ********************
1025 The diskUsage datatype defines the usage of a disk and consists of the
1028 +-------------+-------+----------+--------------------------------------------+
1029 | Field | Type | Required?| Description |
1030 +=============+=======+==========+============================================+
1031 | diskBus\ | number| No | Number of bus resets over the |
1032 | Resets | | | measurementInterval |
1033 +-------------+-------+----------+--------------------------------------------+
1034 | disk\ | number| No | Number of disk commands aborted over the |
1035 | Commands\ | | | measurementInterval |
1037 +-------------+-------+----------+--------------------------------------------+
1038 | disk\ | number| No | Average number of commands per second over |
1039 | CommandsAvg | | | the measurementInterval |
1040 +-------------+-------+----------+--------------------------------------------+
1041 | diskFlush\ | number| No | Total flush requests of the disk cache over|
1042 | Requests | | | the measurementInterval |
1043 +-------------+-------+----------+--------------------------------------------+
1044 | diskFlush\ | number| No | Milliseconds spent on disk cache flushing |
1045 | Time | | | over the measurementInterval |
1046 +-------------+-------+----------+--------------------------------------------+
1047 | disk\ | string| Yes | Disk Identifier |
1048 | Identifier | | | |
1049 +-------------+-------+----------+--------------------------------------------+
1050 | diskIo\ | number| No | Milliseconds spent doing input/output |
1051 | TimeAvg | | | operations over 1 sec; treat this metric as|
1052 | | | | a device load percentage where 1000ms |
1053 | | | | matches 100% load; provide the average over|
1054 | | | | the measurement interval |
1055 +-------------+-------+----------+--------------------------------------------+
1056 | diskIoTime\ | number| No | Milliseconds spent doing input/output |
1057 | Last | | | operations over 1 sec; treat this metric as|
1058 | | | | a device load percentage where 1000ms |
1059 | | | | matches 100% load; provide the last value |
1060 | | | | measurement within the measurement interval|
1061 +-------------+-------+----------+--------------------------------------------+
1062 | diskIo\ | number| No | Milliseconds spent doing input/output |
1063 | TimeMax | | | operations over 1 sec; treat this metric as|
1064 | | | | a device load percentage where 1000ms |
1065 | | | | matches 100% load; provide the maximum |
1066 | | | | value measurement within the measurement |
1068 +-------------+-------+----------+--------------------------------------------+
1069 | diskIo\ | number| No | Milliseconds spent doing input/output |
1070 | TimeMin | | | operations over 1 sec; treat this metric as|
1071 | | | | a device load percentage where 1000ms |
1072 | | | | matches 100% load; provide the minimum |
1073 | | | | value measurement within the measurement |
1075 +-------------+-------+----------+--------------------------------------------+
1076 | diskMerged\ | number| No | Number of logical read operations that were|
1077 | ReadAvg | | | merged into physical read operations, e.g.,|
1078 | | | | two logical reads were served by one |
1079 | | | | physical disk access; provide the average |
1080 | | | | measurement within the measurement interval|
1081 +-------------+-------+----------+--------------------------------------------+
1082 | diskMerged\ | number| No | Number of logical read operations that were|
1083 | ReadLast | | | merged into physical read operations, e.g.,|
1084 | | | | two logical reads were served by one |
1085 | | | | physical disk access; provide the last |
1086 | | | | value measurement within the measurement |
1088 +-------------+-------+----------+--------------------------------------------+
1089 | diskMerged\ | number| No | Number of logical read operations that were|
1090 | ReadMax | | | merged into physical read operations, e.g.,|
1091 | | | | two logical reads were served by one |
1092 | | | | physical disk access; provide the maximum |
1093 | | | | value measurement within the measurement |
1095 +-------------+-------+----------+--------------------------------------------+
1096 | diskMerged\ | number| No | Number of logical read operations that were|
1097 | ReadMin | | | merged into physical read operations, e.g.,|
1098 | | | | two logical reads were served by one |
1099 | | | | physical disk access; provide the minimum |
1100 | | | | value measurement within the measurement |
1102 +-------------+-------+----------+--------------------------------------------+
1103 | diskMerged\ | number| No | Number of logical write operations that |
1104 | WriteAvg | | | were merged into physical write operations,|
1105 | | | | e.g., two logical writes were served by one|
1106 | | | | physical disk access; provide the average |
1107 | | | | measurement within the measurement interval|
1108 +-------------+-------+----------+--------------------------------------------+
1109 | diskMerged\ | number| No | Number of logical write operations that |
1110 | WriteLast | | | were merged into physical write operations,|
1111 | | | | e.g., two logical writes were served by one|
1112 | | | | physical disk access; provide the last |
1113 | | | | value measurement within the measurement |
1115 +-------------+-------+----------+--------------------------------------------+
1116 | diskMerged\ | number| No | Number of logical write operations that |
1117 | WriteMax | | | were merged into physical write operations,|
1118 | | | | e.g., two logical writes were served by one|
1119 | | | | physical disk access; provide the maximum |
1120 | | | | value measurement within the measurement |
1122 +-------------+-------+----------+--------------------------------------------+
1123 | diskMerged\ | number| No | Number of logical write operations that |
1124 | WriteMin | | | were merged into physical write operations,|
1125 | | | | e.g., two logical writes were served by one|
1126 | | | | physical disk access; provide the minimum |
1127 | | | | value measurement within the measurement |
1129 +-------------+-------+----------+--------------------------------------------+
1130 | diskOctets\ | number| No | Number of octets per second read from a |
1131 | Read Avg | | | disk or partition; provide the average |
1132 | | | | measurement within the measurement interval|
1133 +-------------+-------+----------+--------------------------------------------+
1134 | diskOctets\ | number| No | Number of octets per second read from a |
1135 | Read | | | disk or partition; provide the last |
1136 | | | | measurement within the measurement interval|
1138 +-------------+-------+----------+--------------------------------------------+
1139 | diskOctets\ | number| No | Number of octets per second read from a |
1140 | Read Max | | | disk or partition; provide the maximum |
1141 | | | | measurement within the measurement interval|
1142 +-------------+-------+----------+--------------------------------------------+
1143 | diskOctets\ | number| No | Number of octets per second read from a |
1144 | Read Min | | | disk or partition; provide the minimum |
1145 | | | | measurement within the measurement interval|
1146 +-------------+-------+----------+--------------------------------------------+
1147 | diskOctets\ | number| No | Number of octets per second written to a |
1148 | Write Avg | | | disk or partition; provide the average |
1149 | | | | measurement within the measurement interval|
1150 +-------------+-------+----------+--------------------------------------------+
1151 | diskOctets\ | number| No | Number of octets per second written to a |
1152 | Write Last | | | disk or partition; provide the last |
1153 | | | | measurement within the measurement interval|
1154 +-------------+-------+----------+--------------------------------------------+
1155 | diskOctets\ | number| No | Number of octets per second written to a |
1156 | WriteMax | | | disk or partition; provide the maximum |
1157 | | | | measurement within the measurement interval|
1158 +-------------+-------+----------+--------------------------------------------+
1159 | diskOctets\ | number| No | Number of octets per second written to a |
1160 | WriteMin | | | disk or partition; provide the minimum |
1161 | | | | measurement within the measurement interval|
1162 +-------------+-------+----------+--------------------------------------------+
1163 | diskOps\ | number| No | Number of read operations per second issued|
1164 | ReadAvg | | | to the disk; provide the average |
1165 | | | | measurement within the measurement interval|
1166 +-------------+-------+----------+--------------------------------------------+
1167 | diskOps\ | number| No | Number of read operations per second issued|
1168 | ReadLast | | | to the disk; provide the last measurement |
1169 | | | | within the measurement interval |
1170 +-------------+-------+----------+--------------------------------------------+
1171 | diskOps\ | number| No | Number of read operations per second issued|
1172 | ReadMax | | | to the disk; provide the maximum |
1173 | | | | measurement within the measurement interval|
1174 +-------------+-------+----------+--------------------------------------------+
1175 | diskOps\ | number| No | Number of read operations per second issued|
1176 | ReadMin | | | to the disk; provide the minimum |
1177 | | | | measurement within the measurement interval|
1178 +-------------+-------+----------+--------------------------------------------+
1179 | diskOps\ | number| No | Number of write operations per second |
1180 | WriteAvg | | | issued to the disk; provide the average |
1181 | | | | measurement within the measurement interval|
1182 +-------------+-------+----------+--------------------------------------------+
1183 | diskOps\ | number| No | Number of write operations per second |
1184 | WriteLast | | | issued to the disk; provide the last |
1185 | | | | measurement within the measurement interval|
1186 +-------------+-------+----------+--------------------------------------------+
1187 | diskOps\ | number| No | Number of write operations per second |
1188 | Write Max | | | issued to the disk; provide the maximum |
1189 | | | | measurement within the measurement interval|
1190 +-------------+-------+----------+--------------------------------------------+
1191 | diskOps\ | number| No | Number of write operations per second |
1192 | WriteMin | | | issued to the disk; provide the minimum |
1193 | | | | measurement within the measurement interval|
1194 +-------------+-------+----------+--------------------------------------------+
1195 | diskPending\| number| No | Queue size of pending I/O operations per |
1196 | Operations\ | | | second; provide the average measurement |
1197 | Avg | | | within the measurement interval |
1198 +-------------+-------+----------+--------------------------------------------+
1199 | diskPending\| number| No | Queue size of pending I/O operations per |
1200 | Operations\ | | | second; provide the last measurement within|
1201 | Last | | | the measurement interval |
1202 +-------------+-------+----------+--------------------------------------------+
1203 | diskPending\| number| No | Queue size of pending I/O operations per |
1204 | Operations\ | | | second; provide the maximum measurement |
1205 | Max | | | within the measurement interval |
1206 +-------------+-------+----------+--------------------------------------------+
1207 | diskPending\| number| No | Queue size of pending I/O operations per |
1208 | Operations\ | | | second; provide the minimum measurement |
1209 | Min | | | within the measurement interval |
1210 +-------------+-------+----------+--------------------------------------------+
1211 | diskRead\ | number| No | Average number of read commands issued per |
1212 | CommandsAvg | | | second to the disk over the |
1213 | | | | measurementInterval |
1214 +-------------+-------+----------+--------------------------------------------+
1215 | diskTime | number| No | Nanoseconds spent on disk cache |
1216 | | | | reads/writes within the measurement |
1218 +-------------+-------+----------+--------------------------------------------+
1219 | diskTime\ | number| No | Milliseconds a read operation took to |
1220 | ReadAvg | | | complete; provide the average measurement |
1221 | | | | within the measurement interval |
1222 +-------------+-------+----------+--------------------------------------------+
1223 | diskTime\ | number| No | Milliseconds a read operation took to |
1224 | Read Last | | | complete; provide the last measurement |
1225 | | | | within the measurement interval |
1226 +-------------+-------+----------+--------------------------------------------+
1227 | diskTime\ | number| No | Milliseconds a read operation took to |
1228 | Read Max | | | complete; provide the maximum measurement |
1229 | | | | within the measurement interval |
1230 +-------------+-------+----------+--------------------------------------------+
1231 | diskTime\ | number| No | Milliseconds a read operation took to |
1232 | Read Min | | | complete; provide the minimum measurement |
1233 | | | | within the measurement interval |
1234 +-------------+-------+----------+--------------------------------------------+
1235 | diskTime\ | number| No | Milliseconds a write operation took to |
1236 | Write Avg | | | complete; provide the average measurement |
1237 | | | | within the measurement interval |
1238 +-------------+-------+----------+--------------------------------------------+
1239 | diskTime\ | number| No | Milliseconds a write operation took to |
1240 | Write Last | | | complete; provide the last measurement |
1241 | | | | within the measurement interval |
1242 +-------------+-------+----------+--------------------------------------------+
1243 | diskTime\ | number| No | Milliseconds a write operation took to |
1244 | Write Max | | | complete; provide the maximum measurement |
1245 | | | | within the measurement interval |
1246 +-------------+-------+----------+--------------------------------------------+
1247 | diskTime\ | number| No | Milliseconds a write operation took to |
1248 | Write Min | | | complete; provide the minimum measurement |
1249 | | | | within the measurement interval |
1250 +-------------+-------+----------+--------------------------------------------+
1251 | diskTotal\ | number| No | Average read time from the perspective of a|
1252 | ReadLatency\| | | Guest OS: sum of the Kernel Read Latency |
1253 | Avg | | | and Physical Device Read Latency in |
1254 | | | | milliseconds over the measurement interval |
1255 +-------------+-------+----------+--------------------------------------------+
1256 | diskTotal\ | number| No | Average write time from the perspective of |
1257 | Write\ | | | a Guest OS: sum of the Kernel Write Latency|
1258 | LatencyAvg | | | and Physical Device Write Latency in |
1259 | | | | milliseconds over the measurement interval |
1260 +-------------+-------+----------+--------------------------------------------+
1261 | disk\ | number| No | Measure in ms over 1 sec of both I/O |
1262 | WeightedIo\ | | | completion time and the backlog that may be|
1263 | TimeAvg | | | accumulating. Value is the average within |
1264 | | | | the collection interval. |
1265 +-------------+-------+----------+--------------------------------------------+
1266 | disk\ | number| No | Measure in ms over 1 sec of both I/O |
1267 | WeightedIo\ | | | completion time and the backlog that may be|
1268 | TimeLast | | | accumulating. Value is the last within the |
1269 | | | | collection interval. |
1270 +-------------+-------+----------+--------------------------------------------+
1271 | disk\ | number| No | Measure in ms over 1 sec of both I/O |
1272 | WeightedIo\ | | | completion time and the backlog that may be|
1273 | TimeMax | | | accumulating. Value is the maximum within |
1274 | | | | the collection interval. |
1275 +-------------+-------+----------+--------------------------------------------+
1276 | disk\ | number| No | Measure in ms over 1 sec of both I/O |
1277 | WeightedIo\ | | | completion time and the backlog that may be|
1278 | TimeMin | | | accumulating. Value is the minimum within |
1279 | | | | the collection interval. |
1280 +-------------+-------+----------+--------------------------------------------+
1281 | diskWrite\ | number| No | Average number of write commands issued per|
1282 | CommandsAvg | | | second to the disk over the |
1283 | | | | measurementInterval |
1284 +-------------+-------+----------+--------------------------------------------+
1286 Datatype: filesystemUsage
1287 ***************************
1289 The filesystemUsage datatype consists of the following fields:
1291 +-------------+--------+-----------+------------------------------------------+
1292 | Field | Type | Required? | Description |
1293 +=============+========+===========+==========================================+
1294 | filesystem\ | string | Yes | File system name |
1296 +-------------+--------+-----------+------------------------------------------+
1297 | block\ | number | Yes | Configured block storage capacity in GB |
1298 | Configured | | | |
1299 +-------------+--------+-----------+------------------------------------------+
1300 | blockIops | number | Yes | Block storage input-output operations per|
1302 +-------------+--------+-----------+------------------------------------------+
1303 | blockUsed | number | Yes | Used block storage capacity in GB |
1304 +-------------+--------+-----------+------------------------------------------+
1305 | ephemeral\ | number | Yes | Configured ephemeral storage capacity in |
1306 | Configured | | | GB |
1307 +-------------+--------+-----------+------------------------------------------+
1308 | ephemeral\ | number | Yes | Ephemeral storage input-output operations|
1309 | Iops | | | per second |
1310 +-------------+--------+-----------+------------------------------------------+
1311 | ephemeral\ | number | Yes | Used ephemeral storage capacity in GB |
1313 +-------------+--------+-----------+------------------------------------------+
1316 ********************
1318 The hugePages datatype provides metrics on system hugePages; it consists
1319 of the following fields:
1321 +--------------------+--------+----------+------------------------------------+
1322 | Field | Type | Required?| Description |
1323 +====================+========+==========+====================================+
1324 | bytesFree | number | No | Number of free hugePages in bytes |
1325 +--------------------+--------+----------+------------------------------------+
1326 | bytesUsed | number | No | Number of used hugePages in bytes |
1327 +--------------------+--------+----------+------------------------------------+
1328 | hugePagesIdentifier| string | Yes | HugePages identifier |
1329 +--------------------+--------+----------+------------------------------------+
1330 | percentFree | number | No | Number of free hugePages in percent|
1331 +--------------------+--------+----------+------------------------------------+
1332 | percentUsed | number | No | Number of used hugePages in percent|
1333 +--------------------+--------+----------+------------------------------------+
1334 | vmPageNumberFree | number | No | Number of free vmPages in numbers |
1335 +--------------------+--------+----------+------------------------------------+
1336 | vmPageNumberUsed | number | No | Number of used vmPages in numbers |
1337 +--------------------+--------+----------+------------------------------------+
1339 Datatype: ipmi (Intelligent Platform Management Interface)
1340 ***********************************************************
1342 The ipmi datatype provides intelligent platform management interface
1343 metrics; it consists of the following fields:
1345 +-------------+---------------------+-----------+-----------------------------+
1346 | Field | Type | Required? | Description |
1347 +=============+=====================+===========+=============================+
1348 | exitAir\ | number | No | System fan exit air flow |
1349 | Temperature | | | temperature in Celsius |
1350 +-------------+---------------------+-----------+-----------------------------+
1351 | frontPanel\ | number | No | Front panel temp in Celsius |
1352 | Temperature | | | |
1353 +-------------+---------------------+-----------+-----------------------------+
1354 | ioModule\ | number | No | Io module temp in Celsius |
1355 | Temperature | | | |
1356 +-------------+---------------------+-----------+-----------------------------+
1357 | ipmi\ | ipmiBaseboard | No | Array of ipmiBaseboard |
1358 | Baseboard\ | Temperature [ ] | | Temperature objects |
1359 | Temperature\| | | |
1361 +-------------+---------------------+-----------+-----------------------------+
1362 | ipmi\ | ipmiBaseboard | No | Array of ipmiBaseboard |
1363 | Baseboard\ | VoltageRegulator [ ]| | VoltageRegulator objects |
1367 +-------------+---------------------+-----------+-----------------------------+
1368 | ipmiBattery\| ipmiBattery [ ] | No | Array of ipmiBattery objects|
1370 +-------------+---------------------+-----------+-----------------------------+
1371 | ipmiFanArray| ipmiFan [ ] | No | Array of ipmiFan objects |
1372 +-------------+---------------------+-----------+-----------------------------+
1373 | ipmiGlobal\ | ipmiGlobalAggregate\| No | ipmi global aggregate |
1374 | Aggregate\ | TemperatureMargin []| | temperature margin |
1375 | Temperature\| | | |
1376 | MarginArray | | | |
1377 +-------------+---------------------+-----------+-----------------------------+
1378 | ipmiHsbp\ | ipmiHsbp [ ] | No | Array of ipmiHsbp objects |
1380 +-------------+---------------------+-----------+-----------------------------+
1381 | ipmiNicArray| ipmiNic [ ] | No | Array of ipmiNic objects |
1382 +-------------+---------------------+-----------+-----------------------------+
1383 | ipmiPower\ | ipmiPowerSupply [ ] | No | Array of ipmiPowerSupply |
1384 | SupplyArray | | | objects |
1385 +-------------+---------------------+-----------+-----------------------------+
1386 | ipmi\ | ipmiProcessor [ ] | No | Array of ipmiProcessor |
1387 | Processor\ | | | objects |
1389 +-------------+---------------------+-----------+-----------------------------+
1390 | system\ | number | No | Airflow in cubic feet per |
1391 | Airflow | | | minute (cfm) |
1392 +-------------+---------------------+-----------+-----------------------------+
1394 Datatype: ipmiBaseboardTemperature
1395 ************************************
1397 The ipmiBaseboardTemperature datatype consists of the following fields
1398 which describe ipmi baseboard temperature metrics:
1400 +-------------+--------+-----------+------------------------------------------+
1401 | Field | Type | Required? | Description |
1402 +=============+========+===========+==========================================+
1403 | baseboard\ | number | No | Baseboard temperature in celsius |
1404 | Temperature | | | |
1405 +-------------+--------+-----------+------------------------------------------+
1406 | baseboard\ | string | Yes | Identifier for the location where the |
1407 | Temperature\| | | temperature is taken |
1408 | Identifier | | | |
1409 +-------------+--------+-----------+------------------------------------------+
1411 Datatype: ipmiBaseboardVoltageRegulator
1412 *****************************************
1414 The ipmiBaseboardVoltageRegulator datatype consists of the following
1415 fields which describe ipmi baseboard voltage regulator metrics:
1417 +--------------------+-------+----------+-------------------------------------+
1418 | Field | Type | Required?| Description |
1419 +====================+=======+==========+=====================================+
1420 | baseboardVoltage\ | string| Yes | Identifier for the baseboard voltage|
1421 | RegulatorIdentifier| | | regulator |
1422 +--------------------+-------+----------+-------------------------------------+
1423 | voltageRegulator\ | number| No | Voltage regulator temperature in |
1424 | Temperature | | | celsius |
1425 +--------------------+-------+----------+-------------------------------------+
1427 Datatype: ipmiBattery
1428 **********************
1430 The ipmiBattery datatype consists of the following fields which describe
1431 ipmi battery metrics:
1433 +---------------------+--------+----------+------------------------------+
1434 | Field | Type | Required?| Description |
1435 +=====================+========+==========+==============================+
1436 | batteryIdentifier | string | Yes | Identifier for the battery |
1437 +---------------------+--------+----------+------------------------------+
1438 | batteryType | string | No | Type of battery |
1439 +---------------------+--------+----------+------------------------------+
1440 | batteryVoltageLevel | number | No | Battery voltage level |
1441 +---------------------+--------+----------+------------------------------+
1444 ********************
1446 The ipmiFan datatype consists of the following fields which describe
1449 +--------------+-------+----------+-------------------------------------------+
1450 | Field | Type | Required?| Description |
1451 +==============+=======+==========+===========================================+
1452 | fanIdentifier| string| Yes | Identifier for the fan |
1453 +--------------+-------+----------+-------------------------------------------+
1454 | fanSpeed | number| No | Fan speed in revolutions per minute (rpm) |
1455 +--------------+-------+----------+-------------------------------------------+
1457 Datatype: ipmiGlobalAggregateTemperatureMargin
1458 ***********************************************
1460 The ipmiGlobalAggregateTemperatureMargin datatype consists of the
1463 +-------------+-------+----------+--------------------------------------------+
1464 | Field | Type | Required?| Description |
1465 +=============+=======+==========+============================================+
1466 | global\ | number| No | Temperature margin in Celsius relative to a|
1467 | Aggregate\ | | | throttling thermal trip point |
1468 | Temperature\| | | |
1470 +-------------+-------+----------+--------------------------------------------+
1471 | global\ | string| Yes | Identifier for the ipmi global aggregate |
1472 | Aggregate\ | | | temperature margin metrics |
1473 | Temperature\| | | |
1475 | Identifier | | | |
1476 +-------------+-------+----------+--------------------------------------------+
1481 The ipmiHsbp datatype provides ipmi hot swap backplane power metrics; it
1482 consists of the following fields:
1484 +------------+-------+----------+---------------------------------------------+
1485 | Field | Type | Required?| Description |
1486 +============+=======+==========+=============================================+
1487 | hsbp\ | string| Yes | Identifier for the hot swap backplane power |
1488 | Identifier | | | unit |
1489 +------------+-------+----------+---------------------------------------------+
1490 | hsbp\ | number| No | Hot swap backplane power temperature in |
1491 | Temperature| | | celsius |
1492 +------------+-------+----------+---------------------------------------------+
1497 The ipmiNic datatype provides network interface control care metrics; it
1498 consists of the following fields:
1500 +------------+-------+----------+---------------------------------------------+
1501 | Field | Type | Required?| Description |
1502 +============+=======+==========+=============================================+
1503 | nic\ | string| Yes | Identifier for the network interface control|
1504 | Identifier | | | card |
1505 +------------+-------+----------+---------------------------------------------+
1506 | nic\ | number| No | nic temperature in Celsius |
1507 | Temperature| | | |
1508 +------------+-------+----------+---------------------------------------------+
1510 Datatype: ipmiPowerSupply
1511 **************************
1513 The ipmiPowerSupply datatype provides ipmi power supply metrics; it
1514 consists of the following fields:
1516 +-----------+-------+----------+----------------------------------------------+
1517 |Field | Type | Required?| Description |
1518 +===========+=======+==========+==============================================+
1519 |power\ | number| No | Current output voltage as a percentage of the|
1520 |Supply\ | | | design specified level |
1524 +-----------+-------+----------+----------------------------------------------+
1525 |power\ | string| Yes | Identifier for the power supply |
1528 +-----------+-------+----------+----------------------------------------------+
1529 |power\ | number| No | Input power in watts |
1533 +-----------+-------+----------+----------------------------------------------+
1534 |power\ | number| No | Power supply temperature in Celsius |
1537 +-----------+-------+----------+----------------------------------------------+
1539 Datatype: ipmiProcessor
1540 ************************
1542 The ipmiProcessor datatype provides ipmi processor metrics; it consists
1543 of the following fields:
1545 +------------+------------------+-----------+---------------------------------+
1546 | Field | Type | Required? | Description |
1547 +============+==================+===========+=================================+
1548 | processor\ | processorDimm | No | Array of processorDimmAggregate |
1549 | Dimm\ | AggregateThermal | | ThermalMargin objects |
1550 | Aggregate\ | Margin [ ] | | |
1552 | MarginArray| | | |
1553 +------------+------------------+-----------+---------------------------------+
1554 | processor\ | number | No | Front panel temperature in |
1555 | DtsThermal\| | | celsius |
1557 +------------+------------------+-----------+---------------------------------+
1558 | processor\ | string | Yes | Identifier for the power supply |
1559 | Identifier | | | |
1560 +------------+------------------+-----------+---------------------------------+
1561 | processor\ | number | No | Io module temperatue in celsius |
1565 +------------+------------------+-----------+---------------------------------+
1567 Datatype: latencyBucketMeasure
1568 *******************************
1570 The latencyBucketMeasure datatype consists of the following fields which
1571 describe the number of counts falling within a defined latency bucket:
1573 +-----------+-------+----------+----------------------------------------------+
1574 | Field | Type | Required?| Description |
1575 +===========+=======+==========+==============================================+
1576 | counts\ | number| Yes | Number of counts falling within a defined |
1577 | InThe\ | | | latency bucket |
1579 +-----------+-------+----------+----------------------------------------------+
1580 | highEnd\ | number| No | High end of bucket range (typically in ms) |
1583 +-----------+-------+----------+----------------------------------------------+
1584 | lowEndOf\ | number| No | Low end of bucket range (typically in ms) |
1587 +-----------+-------+----------+----------------------------------------------+
1592 The load datatype provides metrics on system cpu and io utilization
1593 obtained using /proc/loadavg; it consists of the following fields:
1595 +----------+-------+----------+-----------------------------------------------+
1596 | Field | Type | Required?| Description |
1597 +==========+=======+==========+===============================================+
1598 | longTerm | number| No | number of jobs in the run queue (state R, cpu |
1599 | | | | utilization) or waiting for disk I/O (state D,|
1600 | | | | io utilization) averaged over 15 minutes using|
1601 | | | | /proc/loadavg |
1602 +----------+-------+----------+-----------------------------------------------+
1603 | midTerm | number| No | number of jobs in the run queue (state R, cpu |
1604 | | | | utilization) or waiting for disk I/O (state D,|
1605 | | | | io utilization) averaged over 5 minutes using |
1606 | | | | /proc/loadavg |
1607 +----------+-------+----------+-----------------------------------------------+
1608 | shortTerm| number| No | number of jobs in the run queue (state R, cpu |
1609 | | | | utilization) or waiting for disk I/O (state D,|
1610 | | | | io utilization) averaged over 1 minute using |
1611 | | | | /proc/loadavg |
1612 +----------+-------+----------+-----------------------------------------------+
1614 Datatype: machineCheckException
1615 ********************************
1617 The machineCheckException datatype describes machine check exceptions;
1618 it consists of the following fields:
1620 +-------------+-------+----------+--------------------------------------------+
1621 | Field | Type | Required?| Description |
1622 +=============+=======+==========+============================================+
1623 | corrected\ | number| No | Total hardware errors that were corrected |
1624 | Memory\ | | | by the hardware (e.g. data corruption |
1625 | Errors | | | corrected via ECC) over the |
1626 | | | | measurementInterval. These errors do not |
1627 | | | | require immediate software actions, but are|
1628 | | | | still reported for accounting and |
1629 | | | | predictive failure analysis |
1630 +-------------+-------+----------+--------------------------------------------+
1631 | corrected\ | number| No | Total hardware errors that were corrected |
1632 | Memory\ | | | by the hardware over the last one hour |
1635 +-------------+-------+----------+--------------------------------------------+
1636 | uncorrected\| number| No | Total uncorrected hardware errors that were|
1637 | Memory\ | | | detected by the hardware (e.g., causing |
1638 | Errors | | | data corruption) over the |
1639 | | | | measurementInterval. These errors require a|
1640 | | | | software response. |
1641 +-------------+-------+----------+--------------------------------------------+
1642 | uncorrected\| number| No | Total uncorrected hardware errors that were|
1643 | Memory\ | | | detected by the hardware over the last one |
1644 | Errors | | | hour |
1646 +-------------+-------+----------+--------------------------------------------+
1647 | vm\ | string| Yes | Virtual machine identifier associated with |
1648 | Identifier | | | the machine check exception |
1649 +-------------+-------+----------+--------------------------------------------+
1651 Datatype: measurementFields
1652 ****************************
1654 The ``measurementFields`` datatype consists of the following fields:
1656 +-------------+--------------+----------+-------------------------------------+
1657 | Field | Type | Required?| Description |
1658 +=============+==============+==========+=====================================+
1659 | additional\ | hashMap | No | Additional measurement fields if |
1660 | Fields | | | needed |
1661 +-------------+--------------+----------+-------------------------------------+
1662 | additional\ | arrayOfNamed\| No | Array of named hashMap if needed |
1663 | Measurements| HashMap | | |
1664 +-------------+--------------+----------+-------------------------------------+
1665 | additional\ | arrayOf\ | No | Array of JSON objects described by |
1666 | Objects | JsonObject | | name, schema and other |
1667 | | | | meta-information, if needed |
1668 +-------------+--------------+----------+-------------------------------------+
1669 | codec\ | codecs\ | No | Array of codecs in use |
1670 | Usage\ | InUse [] | | |
1672 +-------------+--------------+----------+-------------------------------------+
1673 | concurrent\ | integer | No | Peak concurrent sessions for the VM |
1674 | Sessions | | | or xNF (depending on the context) |
1675 | | | | over the measurementInterval |
1676 +-------------+--------------+----------+-------------------------------------+
1677 | configured\ | integer | No | Depending on the context over the |
1678 | Entities | | | measurementInterval: peak total |
1679 | | | | number of users, subscribers, |
1680 | | | | devices, adjacencies, etc., for the |
1681 | | | | VM, or peak total number of |
1682 | | | | subscribers, devices, etc., for the |
1684 +-------------+--------------+----------+-------------------------------------+
1685 | cpuUsage\ | cpuUsage [] | No | Usage of an array of CPUs |
1687 +-------------+--------------+----------+-------------------------------------+
1688 | diskUsage\ | diskUsage [] | No | Usage of an array of disks |
1690 +-------------+--------------+----------+-------------------------------------+
1691 | feature\ | hashMap | No | The hashMap key should identify the |
1692 | UsageArray | | | feature, while the value defines the|
1693 | | | | number of times the identified |
1694 | | | | feature was used |
1695 +-------------+--------------+----------+-------------------------------------+
1696 | filesystem\ | filesystem\ | No | Filesystem usage of the VM on which |
1697 | UsageArray | Usage [ ] | | the xNFC reporting the event is |
1699 +-------------+--------------+----------+-------------------------------------+
1700 | hugePages\ | hugePages [ ]| No | Array of metrics on hugePages |
1702 +-------------+--------------+----------+-------------------------------------+
1703 | ipmi | ipmi | No | Intelligent platform management |
1704 | | | | interface metrics |
1705 +-------------+--------------+----------+-------------------------------------+
1706 | latency\ | latency\ | No | Array of integers representing |
1707 | Distribution| Bucket\ | | counts of requests whose latency in |
1708 | | Measure [ ] | | milliseconds falls within per-xNF |
1709 | | | | configured ranges; where latency is |
1710 | | | | the duration between a service |
1711 | | | | request and its fulfillment. |
1712 +-------------+--------------+----------+-------------------------------------+
1713 | loadArray | load [ ] | No | Array of system load metrics |
1714 +-------------+--------------+----------+-------------------------------------+
1715 | machine\ | machine\ | No | Array of machine check exceptions |
1716 | Check\ | Check\ | | |
1717 | Exception\ | Exception [ ]| | |
1719 +-------------+--------------+----------+-------------------------------------+
1720 | mean\ | number | No | Mean seconds required to respond to |
1721 | Request\ | | | each request for the VM on which the|
1722 | Latency | | | xNFC reporting the event is running |
1723 +-------------+--------------+----------+-------------------------------------+
1724 | measurement\| string | Yes | Version of the measurementFields |
1725 | Fields\ | | | block as "#.#" where # is a digit; |
1726 | Version | | | see section 1 for the correct digits|
1728 +-------------+--------------+----------+-------------------------------------+
1729 | measurement\| number | Yes | Interval over which measurements are|
1730 | Interval | | | being reported in seconds |
1731 +-------------+--------------+----------+-------------------------------------+
1732 | memoryUsage\| memory\ | No | Memory usage of an array of VMs |
1733 | Array | Usage [] | | |
1734 +-------------+--------------+----------+-------------------------------------+
1735 | nfcScaling\ | integer | No | Represents busy-ness of the network |
1736 | Metric | | | function from 0 to 100 as reported |
1737 | | | | by the nfc |
1738 +-------------+--------------+----------+-------------------------------------+
1739 | nic\ | nic\ | No | Performance metrics of an array of |
1740 | Performance\| Performance | | network interface cards |
1742 +-------------+--------------+----------+-------------------------------------+
1743 | numberOf\ | integer | No | Number of media ports in use |
1744 | MediaPorts\ | | | |
1746 +-------------+--------------+----------+-------------------------------------+
1747 | process\ | process\ | No | Array of metrics on system processes|
1748 | StatsArray | Stats [ ] | | |
1749 +-------------+--------------+----------+-------------------------------------+
1750 | request\ | number | No | Peak rate of service requests per |
1751 | Rate | | | second to the xNF over the |
1752 | | | | measurementInterval |
1753 +-------------+--------------+----------+-------------------------------------+
1756 Note on Measurement Expansion Fields
1757 """"""""""""""""""""""""""""""""""""
1759 The ``measurementFields`` data type provides fields that can be used to
1760 pass additional data with the event. These fields are listed below and
1761 referred to as expansion fields:
1763 * ``additionalFields``
1764 * ``additionalObjects``
1765 * ``additionalMeasurements``
1767 When expansion fields are used, the goal is to avoid custom development
1768 by the service provider collecting the fields, since custom development
1769 adds obvious cost, delay and resource overhead. In the domain of
1770 measurements, it is expected that a high percentage of use cases for
1771 extensible fields can be satisfied by using the ``additionalMeasurements``
1772 ``arrayOfNamedHashMap`` data structure in combination with a YAML registration
1773 file (provided at design time). The YAML registration file conveys
1774 metadata about the processing of ``additionalMeasurements``. For more
1775 information, please see the VES Event Registration specification and in
1776 particular the ``aggregationRole``, ``castTo``, and ``isHomogeneous`` keywords.
1778 Datatype: memoryUsage
1779 **********************
1781 The memoryUsage datatype defines the memory usage of a virtual machine
1782 and consists of the following fields:
1784 +-----------+-------+----------+----------------------------------------------+
1785 | Field | Type | Required?| Description |
1786 +===========+=======+==========+==============================================+
1787 | memory\ | number| No | Kibibytes of temporary storage for raw disk |
1788 | Buffered | | | blocks |
1789 +-----------+-------+----------+----------------------------------------------+
1790 | memory\ | number| No | Kibibytes of memory used for cache |
1792 +-----------+-------+----------+----------------------------------------------+
1793 | memory\ | number| No | Kibibytes of memory configured in the virtual|
1794 | Configured| | | machine on which the xNFC reporting the event|
1795 | | | | is running |
1796 +-----------+-------+----------+----------------------------------------------+
1797 | memory\ | number| No | Host demand in kibibytes |
1799 +-----------+-------+----------+----------------------------------------------+
1800 | memory\ | number| Yes | Kibibytes of physical RAM left unused by the |
1801 | Free | | | system |
1802 +-----------+-------+----------+----------------------------------------------+
1803 | memory\ | number| No | Percentage of time the VM is waiting to |
1804 | Latency\ | | | access swapped or compressed memory |
1806 +-----------+-------+----------+----------------------------------------------+
1807 | memory\ | number| No | Shared memory in kilobytes |
1810 +-----------+-------+----------+----------------------------------------------+
1811 | memory\ | number| No | The part of the slab that can be reclaimed |
1812 | SlabRecl | | | such as caches measured in kibibytes |
1813 +-----------+-------+----------+----------------------------------------------+
1814 | memory\ | number| No | The part of the slab that cannot be reclaimed|
1815 | Slab\ | | | even when lacking memory measure in kibibytes|
1817 +-----------+-------+----------+----------------------------------------------+
1818 | memory\ | number| No | Amount of memory swapped-in from host cache |
1819 | SwapIn\ | | | in kibibytes |
1821 +-----------+-------+----------+----------------------------------------------+
1822 | memory\ | number| No | Rate at which memory is swapped from disk |
1823 | SwapIn\ | | | into active memory during the interval in |
1824 | RateAvg | | | kilobytes per second |
1825 +-----------+-------+----------+----------------------------------------------+
1826 | memory\ | number| No | Amount of memory swapped-out to host cache in|
1827 | SwapOut\ | | | kibibytes |
1829 +-----------+-------+----------+----------------------------------------------+
1830 | memory\ | number| No | Rate at which memory is being swapped from |
1831 | SwapOut\ | | | active memory to disk during the current |
1832 | RateAvg | | | interval in kilobytes per second |
1833 +-----------+-------+----------+----------------------------------------------+
1834 | memory\ | number| No | Space used for caching swapped pages in the |
1835 | Swap\ | | | host cache in kibibytes |
1837 +-----------+-------+----------+----------------------------------------------+
1838 | memory\ | number| Yes | Total memory minus the sum of free, buffered,|
1839 | Used | | | cached and slab memory measured in kibibytes |
1840 +-----------+-------+----------+----------------------------------------------+
1841 | percent\ | number| No | Percentage of memory usage; value = |
1842 | Memory\ | | | (memoryUsed / (memoryUsed + memoryFree) x 100|
1843 | Usage | | | if denomintor is nonzero, or 0, if otherwise.|
1844 +-----------+-------+----------+----------------------------------------------+
1845 | vm\ | string| Yes | Virtual Machine identifier associated with |
1846 | Identifier| | | the memory metrics |
1847 +-----------+-------+----------+----------------------------------------------+
1849 Datatype: nicPerformance
1850 *************************
1852 The nicPerformance datatype consists of the following fields which
1853 describe the performance and errors of an of an identified virtual
1854 network interface card:
1856 +----------------+-------+----------+-----------------------------------------+
1857 | Field | Type | Required?| Description |
1858 +================+=======+==========+=========================================+
1859 | administrative\| string| No | Administrative state: enum: ‘inService’,|
1860 | State | | | ‘outOfService’ |
1861 +----------------+-------+----------+-----------------------------------------+
1862 | nicIdentifier | string| Yes | Network interface card identifier |
1863 +----------------+-------+----------+-----------------------------------------+
1864 | operational\ | string| No | Operational state: enum: ‘inService’, |
1865 | State | | | ‘outOfService’ |
1866 +----------------+-------+----------+-----------------------------------------+
1867 | received\ | number| No | Cumulative count of broadcast packets |
1868 | Broadcast\ | | | received as read at the end of the |
1869 | Packets\ | | | measurement interval |
1870 | Accumulated | | | |
1871 +----------------+-------+----------+-----------------------------------------+
1872 | received\ | number| No | Count of broadcast packets received |
1873 | Broadcast\ | | | within the measurement interval |
1874 | PacketsDelta | | | |
1875 +----------------+-------+----------+-----------------------------------------+
1876 | received\ | number| No | Cumulative count of discarded packets |
1877 | Discarded\ | | | received as read at the end of the |
1878 | Packets\ | | | measurement interval |
1879 | Accumulated | | | |
1880 +----------------+-------+----------+-----------------------------------------+
1881 | received\ | number| No | Count of discarded packets received |
1882 | Discarded\ | | | within the measurement interval |
1883 | PacketsDelta | | | |
1884 +----------------+-------+----------+-----------------------------------------+
1885 | received\ | number| No | Cumulative count of error packets |
1886 | ErrorPackets\ | | | received as read at the end of the |
1887 | Accumulated | | | measurement interval |
1888 +----------------+-------+----------+-----------------------------------------+
1889 | receivedError\ | number| No | Count of error packets received within |
1890 | PacketsDelta | | | the measurement interval |
1891 +----------------+-------+----------+-----------------------------------------+
1892 | received\ | number| No | Cumulative count of multicast packets |
1893 | Multicast\ | | | received as read at the end of the |
1894 | Packets\ | | | measurement interval |
1895 | Accumulated | | | |
1896 +----------------+-------+----------+-----------------------------------------+
1897 | received\ | number| No | Count of multicast packets received |
1898 | Multicast\ | | | within the measurement interval |
1899 | PacketsDelta | | | |
1900 +----------------+-------+----------+-----------------------------------------+
1901 | received\ | number| No | Cumulative count of octets received as |
1902 | Octets\ | | | read at the end of the measurement |
1903 | Accumulated | | | interval |
1904 +----------------+-------+----------+-----------------------------------------+
1905 | received\ | number| No | Count of octets received within the |
1906 | OctetsDelta | | | measurement interval |
1907 +----------------+-------+----------+-----------------------------------------+
1908 | received\ | number| No | Percentage of discarded packets |
1909 | Percent\ | | | received; value = |
1910 | Discard | | | (receivedDiscardedPacketsDelta / |
1911 | | | | receivedTotalPacketsDelta) x 100, if |
1912 | | | | denominator is nonzero, or 0, if |
1913 | | | | otherwise. |
1914 +----------------+-------+----------+-----------------------------------------+
1915 | received\ | number| No | Percentage of error packets received; |
1916 | PercentError | | | value = (receivedErrorPacketsDelta / |
1917 | | | | receivedTotalPacketsDelta) x 100, if |
1918 | | | | denominator is nonzero, or 0, if |
1919 | | | | otherwise. |
1920 +----------------+-------+----------+-----------------------------------------+
1921 | receivedTotal\ | number| No | Cumulative count of all packets received|
1922 | Packets\ | | | as read at the end of the measurement |
1923 | Accumulated | | | interval |
1924 +----------------+-------+----------+-----------------------------------------+
1925 | receivedTotal\ | number| No | Count of all packets received within the|
1926 | PacketsDelta | | | measurement interval |
1927 +----------------+-------+----------+-----------------------------------------+
1928 | received\ | number| No | Cumulative count of unicast packets |
1929 | Unicast\ | | | received as read at the end of the |
1930 | Packets\ | | | measurement interval |
1931 | Accumulated | | | |
1932 +----------------+-------+----------+-----------------------------------------+
1933 | received\ | number| No | Count of unicast packets received within|
1934 | Unicast\ | | | the measurement interval |
1935 | PacketsDelta | | | |
1936 +----------------+-------+----------+-----------------------------------------+
1937 | received\ | number| No | Percentage of utilization received; |
1938 | Utilization | | | value = (receivedOctetsDelta / (speed x |
1939 | | | | (lastEpochMicrosec - startEpochMicrosec)|
1940 | | | | )) x 100, if denominator is nonzero, or |
1941 | | | | 0, if otherwise. |
1942 +----------------+-------+----------+-----------------------------------------+
1943 | speed | number| No | Speed configured in mbps. |
1944 +----------------+-------+----------+-----------------------------------------+
1945 | transmitted\ | number| No | Cumulative count of broadcast packets |
1946 | Broadcast\ | | | transmitted as read at the end of the |
1947 | Packets\ | | | measurement interval |
1948 | Accumulated | | | |
1949 +----------------+-------+----------+-----------------------------------------+
1950 | transmitted\ | number| No | Count of broadcast packets transmitted |
1951 | Broadcast\ | | | within the measurement interval |
1952 | PacketsDelta | | | |
1953 +----------------+-------+----------+-----------------------------------------+
1954 | transmitted\ | number| No | Cumulative count of discarded packets |
1955 | Discarded\ | | | transmitted as read at the end of the |
1956 | Packets\ | | | measurement interval |
1957 | Accumulated | | | |
1958 +----------------+-------+----------+-----------------------------------------+
1959 | transmitted\ | number| No | Count of discarded packets transmitted |
1960 | Discarded\ | | | within the measurement interval |
1961 | PacketsDelta | | | |
1962 +----------------+-------+----------+-----------------------------------------+
1963 | transmitted\ | number| No | Cumulative count of error packets |
1964 | ErrorPackets\ | | | transmitted as read at the end of the |
1965 | Accumulated | | | measurement interval |
1966 +----------------+-------+----------+-----------------------------------------+
1967 | transmitted\ | number| No | Count of error packets transmitted |
1968 | ErrorPackets\ | | | within the measurement interval |
1970 +----------------+-------+----------+-----------------------------------------+
1971 | transmitted\ | number| No | Cumulative count of multicast packets |
1972 | Multicast\ | | | transmitted as read at the end of the |
1973 | Packets\ | | | measurement interval |
1974 | Accumulated | | | |
1975 +----------------+-------+----------+-----------------------------------------+
1976 | transmitted\ | number| No | Count of multicast packets transmitted |
1977 | Multicast\ | | | within the measurement interval |
1978 | PacketsDelta | | | |
1979 +----------------+-------+----------+-----------------------------------------+
1980 | transmitted\ | number| No | Cumulative count of octets transmitted |
1981 | Octets\ | | | as read at the end of the measurement |
1982 | Accumulated | | | interval |
1983 +----------------+-------+----------+-----------------------------------------+
1984 | transmitted\ | number| No | Count of octets transmitted within the |
1985 | OctetsDelta | | | measurement interval |
1986 +----------------+-------+----------+-----------------------------------------+
1987 | transmitted\ | number| No | Percentage of discarded packets |
1988 | PercentDiscard | | | transmitted; value = |
1989 | | | | (transmittedDiscardedPacketsDelta / |
1990 | | | | transmittedTotalPacketsDelta) x 100, if |
1991 | | | | denominator is nonzero, or 0, if |
1992 | | | | otherwise. |
1993 +----------------+-------+----------+-----------------------------------------+
1994 | transmitted\ | number| No | Percentage of error packets received; |
1995 | PercentError | | | value = (transmittedErrorPacketsDelta / |
1996 | | | | transmittedTotalPacketsDelta) x 100, if |
1997 | | | | denominator is nonzero, or 0, if |
1998 | | | | otherwise. |
1999 +----------------+-------+----------+-----------------------------------------+
2000 | transmitted\ | number| No | Cumulative count of all packets |
2001 | TotalPackets\ | | | transmitted as read at the end of the |
2002 | Accumulated | | | measurement interval |
2003 +----------------+-------+----------+-----------------------------------------+
2004 | transmitted\ | number| No | Count of all packets transmitted within |
2005 | TotalPackets\ | | | the measurement interval |
2007 +----------------+-------+----------+-----------------------------------------+
2008 | transmitted\ | number| No | Cumulative count of unicast packets |
2009 | Unicast\ | | | transmitted as read at the end of the |
2010 | Packets\ | | | measurement interval |
2011 | Accumulated | | | |
2012 +----------------+-------+----------+-----------------------------------------+
2013 | transmitted\ | number| No | Count of unicast packets transmitted |
2014 | Unicast\ | | | within the measurement interval |
2015 | PacketsDelta | | | |
2016 +----------------+-------+----------+-----------------------------------------+
2017 | transmitted\ | number| No | Percentage of utilization transmitted; |
2018 | Utilization | | | value = (transmittedOctetsDelta / (speed|
2019 | | | | x (lastEpochMicrosec - |
2020 | | | | startEpochMicrosec))) x 100, if |
2021 | | | | denominator is nonzero, or 0, if |
2022 | | | | otherwise. |
2023 +----------------+-------+----------+-----------------------------------------+
2024 | values\ | string| Yes | Enumeration: ‘true’ or ‘false’. If |
2025 | AreSuspect | | | ‘true’ then the vNicPerformance values |
2026 | | | | are likely inaccurate due to counter |
2027 | | | | overflow or other conditions. |
2028 +----------------+-------+----------+-----------------------------------------+
2030 Datatype: processorDimmAggregateThermalMargin
2031 **********************************************
2033 The processorDimmAggregateThermalMargin datatype provides intelligent
2034 platform management interface (ipmi) processor dual inline memory module
2035 aggregate thermal margin metrics; it consists of the following fields:
2037 +-----------------+-------+----------+----------------------------------------+
2038 | Field | Type | Required?| Description |
2039 +=================+=======+==========+========================================+
2040 | processor\ | string| Yes | identifier for the aggregate thermal |
2041 | DimmAggregate\ | | | margin metrics from the processor dual |
2042 | Thermal | | | inline memory module |
2043 | MarginIdentifier| | | |
2044 +-----------------+-------+----------+----------------------------------------+
2045 | thermalMargin | number| Yes | the difference between the DIMM's |
2046 | | | | current temperature, in celsius, and |
2047 | | | | the DIMM's throttling thermal trip |
2048 +-----------------+-------+----------+----------------------------------------+
2050 Datatype: processStats
2051 ***********************
2053 The processStats datatype provides metrics on system processes; it
2054 consists of the following fields:
2057 +-----------+-------+----------+----------------------------------------------+
2058 | Field | Type | Required?| Description |
2059 +===========+=======+==========+==============================================+
2060 | forkRate | number| No | The number of threads created since the last |
2062 +-----------+-------+----------+----------------------------------------------+
2063 | process\ | string| Yes | processIdentifier |
2065 +-----------+-------+----------+----------------------------------------------+
2066 | psState\ | number| No | The number of processes in a blocked state |
2068 +-----------+-------+----------+----------------------------------------------+
2069 | psState\ | number| No | The number of processes in a paging state |
2071 +-----------+-------+----------+----------------------------------------------+
2072 | psState\ | number| No | The number of processes in a running state |
2074 +-----------+-------+----------+----------------------------------------------+
2075 | psState\ | number| No | The number of processes in a sleeping state |
2077 +-----------+-------+----------+----------------------------------------------+
2078 | psState\ | number| No | The number of processes in a stopped state |
2080 +-----------+-------+----------+----------------------------------------------+
2081 | psState\ | number| No | The number of processes in a zombie state |
2083 +-----------+-------+----------+----------------------------------------------+
2085 ‘Notification’ Domain Datatypes
2086 ++++++++++++++++++++++++++++++++
2088 Datatype: notificationFields
2089 ******************************
2091 The notificationFields datatype consists of the following fields:
2093 +--------------+-----------+----------+---------------------------------------+
2094 | Field | Type | Required?| Description |
2095 +==============+===========+==========+=======================================+
2096 | additional\ | hashMap | No | Additional notification fields if |
2097 | Fields | | | needed |
2098 +--------------+-----------+----------+---------------------------------------+
2099 | arrayOfNamed\| namedHash\| No | Array of named hashMaps |
2100 | HashMap | Map [ ] | | |
2101 +--------------+-----------+----------+---------------------------------------+
2102 | change\ | string | No | Identifier for a contact related to |
2103 | Contact | | | the change |
2104 +--------------+-----------+----------+---------------------------------------+
2105 | change\ | string | Yes | System or session identifier |
2106 | Identifier | | | associated with the change |
2107 +--------------+-----------+----------+---------------------------------------+
2108 | changeType | string | Yes | Describes what has changed for the |
2109 | | | | entity, for example: configuration |
2110 | | | | changed, capability added, capability |
2112 +--------------+-----------+----------+---------------------------------------+
2113 | newState | string | No | New state of the entity, for example: |
2114 | | | | ‘inService’, ‘maintenance’, |
2115 | | | | ‘outOfService’ |
2116 +--------------+-----------+----------+---------------------------------------+
2117 | notification\| string | Yes | Version of the notificationFields |
2118 | FieldsVersion| | | block as "#.#" where # is a digit; see|
2119 | | | | section 1 for the correct digits to |
2121 +--------------+-----------+----------+---------------------------------------+
2122 | oldState | string | No | Previous state of the entity, for |
2123 | | | | example: ‘inService’, ‘maintenance’, |
2124 | | | | ‘outOfService’ |
2125 +--------------+-----------+----------+---------------------------------------+
2126 | state\ | string | No | Card or port name of the entity that |
2127 | Interface | | | changed state |
2128 +--------------+-----------+----------+---------------------------------------+
2130 The fileReady notification event is used by 3GPP-compliant NFs to notify
2131 ONAP that a PM file is available for upload. The notificationFields are
2132 populated as follows:
2134 **arrayOfNamedHashMap:** The array is named for the PM file as defined
2135 in 3GPP TS 28.550. The array contains the following key value pairs:
2137 - **location** in the form protocol://ipAddress:port/path/filename;
2139 "ftpes://135.3.1.44:21/pmfiles/A20180531.1030+0600-1045+0600\A20000626.2315+0200-2330+0200_NodeBId.gz"
2141 - **compression** containing the compression type used for the PM file;
2142 e.g. "compression" : "gzip"
2144 - **fileFormatType** containing the format type of the PM file; e.g.
2145 "fileFormatType" : "org.3GPP.32.435#measCollec"
2147 - **fileFormatVersion** containing the format version of the PM file;
2148 e.g. "fileFormatVersion" : "V10"
2150 - other vendor-defined key-value pairs as needed
2152 **changeIdentifier:** set to PM\_MEAS\_FILES
2154 **changeType:** set to fileReady
2156 Other notificationFields are not used for fileReady.
2158 ‘Other’ Domain Datatypes
2159 +++++++++++++++++++++++++
2161 Datatype: otherFields
2162 **********************
2164 The otherFields datatype defines fields for events belonging to the
2165 'other' domain of the commonEventHeader domain enumeration; it consists
2166 of the following fields:
2168 +-------------+-------------+----------+--------------------------------------+
2169 | Field | Type | Required?| Description |
2170 +=============+=============+==========+======================================+
2171 | arrayOf\ | arrayOf\ | No | Array of named hashMaps |
2172 | NamedHashMap| NamedHashMap| | |
2173 +-------------+-------------+----------+--------------------------------------+
2174 | hashMap | hashMap | No | Array of name-value pairs |
2175 +-------------+-------------+----------+--------------------------------------+
2176 | jsonObjects | arrayOf\ | No | Array of JSON objects described by |
2177 | | JsonObject | | name, schema and other |
2178 | | | | meta-information |
2179 +-------------+-------------+----------+--------------------------------------+
2180 | otherFields\| string | Yes | Version of the otherFields block as |
2181 | Version | | | "#.#" where # is a digit; see section|
2182 | | | | 1 for the correct digits to use. |
2183 +-------------+-------------+----------+--------------------------------------+
2185 ‘perf3gpp’ Domain Datatypes
2186 ++++++++++++++++++++++++++++
2188 Datatype: measDataCollection
2189 *****************************
2191 The measDataCollection datatype defines a 3GPP measurement collection
2192 structure aligned with the 3GPP PM format; it consists of the following
2195 +----------------+---------+----------+---------------------------------------+
2196 | Field | Type | Required?| Description |
2197 +================+=========+==========+=======================================+
2198 | format\ | string | No | 3GPP PM reporting file format version |
2199 | Version | | | from pre-standard TS 28.550 v2.0.0 |
2200 +----------------+---------+----------+---------------------------------------+
2201 | granularity\ | string | Yes | Granularity period for the PM report |
2202 | Period | | | in seconds |
2203 +----------------+---------+----------+---------------------------------------+
2204 | measInfoList | measInfo| Yes | Array of measInfo measurements |
2206 +----------------+---------+----------+---------------------------------------+
2207 | measObjInst\ | string | No | Array of monitored object local |
2208 | IdList | [ ] | | distinguished name ids per 3GPP TS |
2210 +----------------+---------+----------+---------------------------------------+
2211 | measured\ | string | Yes | Distinguished name per 3GPP TS 28.550 |
2213 +----------------+---------+----------+---------------------------------------+
2214 | measuredEntity\| string | No | Software version for the NF providing |
2215 | SoftwareVersion| | | the PM data as specified in 3GPP TS |
2217 +----------------+---------+----------+---------------------------------------+
2218 | measuredEntity\| string | No | User Definable name for the measured |
2219 | UserName | | | object per 3GPP TS 28.550 |
2220 +----------------+---------+----------+---------------------------------------+
2223 ********************
2225 The measInfo datatype provides measurement information; it consists of
2226 the following fields:
2228 +-------+--------------------------+----------+-------------------------------+
2229 | Field | Type | Required?| Description |
2230 +=======+==========================+==========+===============================+
2231 | jobId | string | No | Name of the measurement job |
2232 +-------+--------------------------+----------+-------------------------------+
2233 | meas\ | oneOf [ measInfoIdInteger| No | Measurement group Identifier |
2234 | InfoId| , measInfoIdString ] | | |
2235 +-------+--------------------------+----------+-------------------------------+
2236 | meas\ | oneOf [ measTypesInteger | Yes | Array of measurement |
2237 | Types | , measTypesString ] | | identifiers associated with |
2238 | | | | the measurement results |
2239 | | | | expressed as integers for |
2240 | | | | efficiency rather than strings|
2241 +-------+--------------------------+----------+-------------------------------+
2242 | meas\ | measValues [ ] | Yes | Array of measValues |
2244 +-------+--------------------------+----------+-------------------------------+
2246 Datatype: measInfoIdInteger
2247 ****************************
2249 The measInfoIdInteger datatype provides an integer measurement group
2250 identifier; it consists of the following fields:
2252 +---------------+---------+----------+--------------------------------------+
2253 | Field | Type | Required?| Description |
2254 +===============+=========+==========+======================================+
2255 | iMeasInfoId | integer | Yes | Integer measurement group Identifier |
2256 +---------------+---------+----------+--------------------------------------+
2258 Datatype: measInfoIdString
2259 ***************************
2261 The measInfoIdString datatype provides a string measurement group
2262 identifier; it consists of the following fields:
2264 +---------------+-----------+----------+--------------------------------------+
2265 | Field | Type | Required?| Description |
2266 +===============+===========+==========+======================================+
2267 | sMeasInfoId | integer | Yes | String measurement group Identifier |
2268 +---------------+-----------+----------+--------------------------------------+
2270 Datatype: measResultInteger
2271 ****************************
2273 The measResultInteger datatype provides an integer 3GPP PM measurement
2274 result; it consists of the following fields:
2276 +----------+-----------+-------------+------------------------------------+
2277 | Field | Type | Required? | Description |
2278 +==========+===========+=============+====================================+
2279 | p | integer | Yes | Integer reference to the counter |
2280 +----------+-----------+-------------+------------------------------------+
2281 | iValue | integer | Yes | Integer counter value |
2282 +----------+-----------+-------------+------------------------------------+
2284 Datatype: measResultNull
2285 *************************
2287 The measResultNull datatype provides a null 3GPP PM measurement result;
2288 it consists of the following fields:
2290 +----------+-----------+-------------+------------------------------------+
2291 | Field | Type | Required? | Description |
2292 +==========+===========+=============+====================================+
2293 | p | integer | Yes | Integer reference to the counter |
2294 +----------+-----------+-------------+------------------------------------+
2295 | isNull | string | Yes | Enumeration: ‘true’ or ‘false’ |
2296 +----------+-----------+-------------+------------------------------------+
2298 Datatype: measResultNumber
2299 ***************************
2301 The measResultNumber datatype provides a number 3GPP PM measurement
2302 result; it consists of the following fields:
2304 +----------+-----------+-------------+------------------------------------+
2305 | Field | Type | Required? | Description |
2306 +==========+===========+=============+====================================+
2307 | p | integer | Yes | Integer reference to the counter |
2308 +----------+-----------+-------------+------------------------------------+
2309 | rValue | number | Yes | Number counter value |
2310 +----------+-----------+-------------+------------------------------------+
2312 Datatype: measResultString
2313 ***************************
2315 The measResultString datatype provides a string 3GPP PM measurement
2316 result; it consists of the following fields:
2318 +----------+-----------+-------------+------------------------------------+
2319 | Field | Type | Required? | Description |
2320 +==========+===========+=============+====================================+
2321 | p | integer | Yes | Integer reference to the counter |
2322 +----------+-----------+-------------+------------------------------------+
2323 | sValue | string | Yes | String counter value |
2324 +----------+-----------+-------------+------------------------------------+
2326 Datatype: measTypesInteger
2327 ***************************
2329 The measTypesInteger datatype provides an array of integer measurement
2330 identifiers associated with the measurement results; it consists of the
2333 +----------+--------+----------+----------------------------------------------+
2334 | Field | Type | Required?| Description |
2335 +==========+========+==========+==============================================+
2336 | iMeas\ | integer| Yes | Array of integer measurement identifiers |
2337 | TypesList| [ ] | | associated with the measurement results |
2338 +----------+--------+----------+----------------------------------------------+
2340 Datatype: measTypesString
2341 **************************
2343 The measTypesString datatype provides an array of string measurement
2344 identifiers associated with the measurement results; it consists of the
2347 +----------+-------+----------+-----------------------------------------------+
2348 | Field | Type | Required?| Description |
2349 +==========+=======+==========+===============================================+
2350 | sMeas\ | string| Yes | Array of string measurement identifiers |
2351 | TypesList| [ ] | | associated with the measurement results |
2352 +----------+-------+----------+-----------------------------------------------+
2354 Datatype: measValues
2355 *********************
2357 The measValues datatype provides 3GPP measurement values; it consists of
2358 the following fields:
2360 +---------+----------------------------------+----------+---------------------+
2361 | Field | Type | Required?| Description |
2362 +=========+==================================+==========+=====================+
2363 | measObj\| hashMap | No | Additional key-value|
2364 | AddlFlds| | | pairs if needed |
2365 +---------+----------------------------------+----------+---------------------+
2366 | measObj\|measDataCollection | Yes | Monitored object |
2367 | InstId | | | local distinguished |
2368 | | | | name per 3GPP TS |
2369 | | | | 32.300 and 3GPP TS |
2371 +---------+----------------------------------+----------+---------------------+
2372 | meas\ | Array of items where each item is| Yes | Array of results |
2373 | Results | oneOf [ measResultInteger, | | |
2374 | | measResultNull, measResultNumber,| | |
2375 | | measResultString ] | | |
2376 +---------+----------------------------------+----------+---------------------+
2377 | suspect\| string | No | Enumeration: ‘true’,|
2378 | Flag | | | ‘false’. Indicates |
2379 | | | | if the values are |
2381 +---------+----------------------------------+----------+---------------------+
2383 Datatype: perf3gppFields
2384 *************************
2386 The perf3gppFields datatype defines fields for 3GPP PM format events,
2387 based on 3GPP TS 28.550, belonging to the 'perf3gpp' domain of the
2388 commonEventHeader domain enumeration; it consists of the following
2391 +--------------+-----------+----------+---------------------------------------+
2392 | Field | Type | Required?| Description |
2393 +==============+===========+==========+=======================================+
2394 | eventAddl\ | hashMap | No | Additional key-value pairs if needed |
2396 +--------------+-----------+----------+---------------------------------------+
2397 | measData\ | measData | Yes | 3GPP measurement collection structure |
2398 | Collection | Collection| | |
2399 +--------------+-----------+----------+---------------------------------------+
2400 | perf3gpp\ | string | Yes | Version of the perf3gpp event |
2401 | FieldsVersion| | | |
2402 +--------------+-----------+----------+---------------------------------------+
2404 ‘pnfRegistration’ Domain Datatypes
2405 ++++++++++++++++++++++++++++++++++++
2407 Datatype: pnfRegistrationFields
2408 ********************************
2410 The pnfRegistrationFields datatype defines fields for events belonging
2411 to the 'pnfRegistration' domain of the commonEventHeader domain
2412 enumeration; it consists of the following fields:
2414 +-----------------+--------+----------+---------------------------------------+
2415 | Field | Type | Required?| Description |
2416 +=================+========+==========+=======================================+
2417 | additional\ | hashMap| No | Additional pnfRegistration fields if |
2418 | Fields | | | needed |
2419 +-----------------+--------+----------+---------------------------------------+
2420 | last\ | string | No | TS 32.692 dateOfLastService = date of |
2421 | ServiceDate | | | last service; e.g. 15022017 |
2422 +-----------------+--------+----------+---------------------------------------+
2423 | macAddress | string | No | MAC address of OAM interface of the |
2425 +-----------------+--------+----------+---------------------------------------+
2426 | manufacture\ | string | No | TS 32.692 dateOfManufacture = |
2427 | Date | | | manufacture date of the unit; 24032016|
2428 +-----------------+--------+----------+---------------------------------------+
2429 | modelNumber | string | No | TS 32.692 versionNumber = version of |
2430 | | | | the unit from vendor; e.g. AJ02. Maps |
2431 | | | | to AAI equip-model |
2432 +-----------------+--------+----------+---------------------------------------+
2433 | oamV4\ | string | No | IPv4 m-plane IP address to be used by |
2434 | IpAddress | | | the manager to contact the PNF |
2435 +-----------------+--------+----------+---------------------------------------+
2436 | oamV6\ | string | No | IPv6 m-plane IP address to be used by |
2437 | IpAddress | | | the manager to contact the PNF |
2438 +-----------------+--------+----------+---------------------------------------+
2439 | pnfRegistration\| string | Yes | Version of the pnfRegistrationFields |
2440 | FieldsVersion | | | block as "#.#" where # is a digit; see|
2441 | | | | section 1 for the correct digits to |
2443 +-----------------+--------+----------+---------------------------------------+
2444 | serialNumber | string | No | TS 32.692 serialNumber = serial number|
2445 | | | | of the unit; e.g. 6061ZW3 |
2446 +-----------------+--------+----------+---------------------------------------+
2447 | software\ | string | No | TS 32.692 swName = active SW running |
2448 | Version | | | on the unit; e.g. 5gDUv18.05.201 |
2449 +-----------------+--------+----------+---------------------------------------+
2450 | unitFamily | string | No | TS 32.692 vendorUnitFamilyType = |
2451 | | | | general type of HW unit; e.g. BBU |
2452 +-----------------+--------+----------+---------------------------------------+
2453 | unitType | string | No | TS 32.692 vendorUnitTypeNumber = |
2454 | | | | vendor name for the unit; e.g. |
2456 +-----------------+--------+----------+---------------------------------------+
2457 | vendorName | string | No | TS 32.692 vendorName = name of |
2458 | | | | manufacturer; e.g. Nokia. Maps to AAI |
2459 | | | | equip-vendor |
2460 +-----------------+--------+----------+---------------------------------------+
2462 ‘State Change’ Domain Datatypes
2463 ++++++++++++++++++++++++++++++++
2465 Datatype: stateChangeFields
2466 *****************************
2468 The stateChangeFields datatype consists of the following fields:
2470 +--------------+--------+----------+------------------------------------------+
2471 | Field | Type | Required?| Description |
2472 +==============+========+==========+==========================================+
2473 | additional\ | hashMap| No | Additional stateChange fields if needed |
2475 +--------------+--------+----------+------------------------------------------+
2476 | newState | string | Yes | New state of the entity: ‘inService’, |
2477 | | | | ‘maintenance’, ‘outOfService’ |
2478 +--------------+--------+----------+------------------------------------------+
2479 | oldState | string | Yes | Previous state of the entity: ‘inService’|
2480 | | | | , ‘maintenance’, ‘outOfService’ |
2481 +--------------+--------+----------+------------------------------------------+
2482 | stateChange\ | string | Yes | Version of the stateChangeFields block as|
2483 | FieldsVersion| | | "#.#" where # is a digit; see section 1 |
2484 | | | | for the correct digits to use. |
2485 +--------------+--------+----------+------------------------------------------+
2486 | state\ | string | Yes | Card or port name of the entity that |
2487 | Interface | | | changed state |
2488 +--------------+--------+----------+------------------------------------------+
2490 ‘Syslog’ Domain Datatypes
2491 ++++++++++++++++++++++++++
2493 Datatype: syslogFields
2494 ***********************
2496 The syslogFields datatype consists of the following fields:
2498 +------------+--------+----------+--------------------------------------------+
2499 | Field | Type | Required?| Description |
2500 +============+========+==========+============================================+
2501 | additional\| hashMap| No | Additional syslog fields if needed Ex: |
2502 | Fields | | | {"name1": "value1", "name2: "value2" … } |
2503 +------------+--------+----------+--------------------------------------------+
2504 | event\ | string | No | Hostname of the device |
2505 | SourceHost | | | |
2506 +------------+--------+----------+--------------------------------------------+
2507 | event\ | string | Yes | Examples: ‘other’, ‘router’, ‘switch’, |
2508 | SourceType | | | ‘host’, ‘card’, ‘port’, ‘slotThreshold’, |
2509 | | | | ‘portThreshold’, ‘virtualMachine’, |
2510 | | | | ‘virtualNetworkFunction’ |
2511 +------------+--------+----------+--------------------------------------------+
2512 | syslog\ | integer| No | Numeric code from 0 to 23 for facility: |
2515 | | | | 0 kernel messages |
2517 | | | | 1 user-level messages |
2519 | | | | 2 mail system |
2521 | | | | 3 system daemons |
2523 | | | | 4 security/authorization messages |
2525 | | | | 5 messages generated internally by syslogd |
2527 | | | | 6 line printer subsystem |
2529 | | | | 7 network news subsystem |
2531 | | | | 8 UUCP subsystem |
2533 | | | | 9 clock daemon |
2535 | | | | 10 security/authorization messages |
2537 | | | | 11 FTP daemon |
2539 | | | | 12 NTP subsystem |
2541 | | | | 13 log audit |
2543 | | | | 14 log alert |
2545 | | | | 15 clock daemon (note 2) |
2547 | | | | 16 local use 0 (local0) |
2549 | | | | 17 local use 1 (local1) |
2551 | | | | 18 local use 2 (local2) |
2553 | | | | 19 local use 3 (local3) |
2555 | | | | 20 local use 4 (local4) |
2557 | | | | 21 local use 5 (local5) |
2559 | | | | 22 local use 6 (local6) |
2561 | | | | 23 local use 7 (local7 ) |
2562 +------------+--------+----------+--------------------------------------------+
2563 | syslog\ | string | Yes | Version of the syslogFields block as "#.#" |
2564 | Fields\ | | | where # is a digit; see section 1 for the |
2565 | Version | | | correct digits to use. |
2566 +------------+--------+----------+--------------------------------------------+
2567 | syslogMsg | string | Yes | Syslog message |
2568 +------------+--------+----------+--------------------------------------------+
2569 | syslog\ | string | No | Hostname parsed from non-VES syslog message|
2571 +------------+--------+----------+--------------------------------------------+
2572 | syslogPri | integer| No | 0-192 |
2574 | | | | Combined Severity and Facility(see rfc5424)|
2575 +------------+--------+----------+--------------------------------------------+
2576 | syslogProc | string | No | Identifies the application that originated |
2577 | | | | the message |
2578 +------------+--------+----------+--------------------------------------------+
2579 | syslog\ | number | No | The process number assigned by the OS when |
2580 | ProcId | | | the application was started |
2581 +------------+--------+----------+--------------------------------------------+
2582 | syslog\ | string | No | A <space> separated list of key="value" |
2583 | SData | | | pairs following the rfc5424 standard for |
2584 | | | | SD-ELEMENT. |
2586 | | | | ***Deprecated *** |
2588 | | | | The entire rfc5424 syslogSData object, |
2589 | | | | including square brackets [ ], SD-ID and |
2590 | | | | list of SD-PARAMs |
2591 +------------+--------+----------+--------------------------------------------+
2592 | syslogSdId | string | No | 0-32 char in format name@number, |
2594 | | | | i.e., ourSDID@32473 |
2595 +------------+--------+----------+--------------------------------------------+
2596 | syslogSev | string | No | Level-of-severity text enumeration defined |
2599 | | | | *Text* *Sev* *Description* |
2601 | | | | Emergency 0 system is unusable |
2603 | | | | Alert 1 action must be taken immediately |
2605 | | | | Critical 2 critical conditions |
2607 | | | | Error 3 error conditions |
2609 | | | | Warning 4 warning conditions |
2611 | | | | Notice 5 normal but significant condition |
2613 | | | | Info 6 Informational messages |
2615 | | | | Debug 7 debug-level messages |
2616 +------------+--------+----------+--------------------------------------------+
2617 | syslogTag | string | Yes | Also known as MsgId. Brief non-spaced text |
2618 | | | | indicating the type of message such as |
2619 | | | | ‘TCPOUT’ or ‘BGP\_STATUS\_CHANGE’; |
2620 | | | | ‘NILVALUE’ should be used when no other |
2621 | | | | value can be provided |
2622 +------------+--------+----------+--------------------------------------------+
2623 | syslogTs | string | No | Timestamp parsed from non-VES syslog |
2625 +------------+--------+----------+--------------------------------------------+
2626 | syslogVer | number | No | IANA assigned version of the syslog |
2627 | | | | protocol specification: |
2631 | | | | 1: IANA RFC5424 |
2632 +------------+--------+----------+--------------------------------------------+
2634 Examples of syslogSData :
2638 ts="1985-04-12T23:20:50.52Z" tag="BGP\_NEIGHBOR\_DOWN" msg="The BGP
2639 session to neighbor 10.10.10.10 is down"
2643 [attinc@1234 ts="1985-04-12T23:20:50.52Z" tag="BGP\_NEIGHBOR\_DOWN"
2644 msg="The BGP session to neighbor 10.10.10.10 is down"]
2648 https://tools.ietf.org/html/rfc5424#section-6
2650 https://www.iana.org/assignments/syslog-parameters/syslog-parameters.xhtml
2652 ‘Threshold Crossing Alert’ Domain Datatypes
2653 ++++++++++++++++++++++++++++++++++++++++++++
2658 The counter datatype consists of the following fields:
2660 +------------+--------+----------+--------------------------------------------+
2661 | Field | Type | Required?| Description |
2662 +============+========+==========+============================================+
2663 | criticality| string | Yes | Enumeration: ‘CRIT’, ‘MAJ’ |
2664 +------------+--------+----------+--------------------------------------------+
2665 | hashMap | hashMap| Yes | Key is the name of the counter and value is|
2666 | | | | the current value of the counter |
2667 +------------+--------+----------+--------------------------------------------+
2668 | threshhold\| string | Yes | Last threshold that was crossed |
2670 +------------+--------+----------+--------------------------------------------+
2672 Datatype: thresholdCrossingAlertFields
2673 ****************************************
2675 The thresholdCrossingAlertFields datatype consists of the following
2678 +------------+------------+----------+----------------------------------------+
2679 | Field | Type | Required?| Description |
2680 +============+============+==========+========================================+
2681 | additional\| hashMap | No | Additional threshold crossing alert |
2682 | Fields | | | fields if needed |
2683 +------------+------------+----------+----------------------------------------+
2684 | additional\| counter [ ]| Yes | Array of performance counters |
2685 | Parameters | | | |
2686 +------------+------------+----------+----------------------------------------+
2687 | alert\ | string | Yes | Enumeration: ‘SET’, ‘CONT’, ‘CLEAR’ |
2689 +------------+------------+----------+----------------------------------------+
2690 | alert\ | string | Yes | Unique short alert description (e.g., |
2691 | Description| | | NE-CPUMEM) |
2692 +------------+------------+----------+----------------------------------------+
2693 | alertType | string | Yes | Enumeration: ‘CARD-ANOMALY’, |
2694 | | | | ‘INTERFACE-ANOMALY’, ELEMENT-ANOMALY’, |
2695 | | | | ‘SERVICE-ANOMALY’ |
2696 +------------+------------+----------+----------------------------------------+
2697 | alertValue | string | No | Calculated API value (if applicable) |
2698 +------------+------------+----------+----------------------------------------+
2699 | associated\| string [ ] | No | List of eventIds associated with the |
2700 | AlertIdList| | | event being reported |
2701 +------------+------------+----------+----------------------------------------+
2702 | collection\| string | Yes | Time when the performance collector |
2703 | Timestamp | | | picked up the data; with RFC 2822 |
2704 | | | | compliant format: ‘Sat, 13 Mar 2010 |
2705 | | | | 11:29:05 -0800’ |
2706 +------------+------------+----------+----------------------------------------+
2707 | data\ | string | No | Specific performance collector instance|
2708 | Collector | | | used |
2709 +------------+------------+----------+----------------------------------------+
2710 | elementType| string | No | Type of network element (internal AT&T |
2712 +------------+------------+----------+----------------------------------------+
2713 | event\ | string | Yes | Event severity or priority enumeration:|
2714 | Severity | | | ‘CRITICAL’, ‘MAJOR’, ‘MINOR’, ‘WARNING’|
2715 | | | | , ‘NORMAL’ |
2716 +------------+------------+----------+----------------------------------------+
2717 | eventStart\| string | Yes | Time closest to when the measurement |
2718 | Timestamp | | | was made; with RFC 2822 compliant |
2719 | | | | format: ‘Sat, 13 Mar 2010 11:29:05 |
2721 +------------+------------+----------+----------------------------------------+
2722 | interface\ | string | No | Physical or logical port or card (if |
2723 | Name | | | applicable) |
2724 +------------+------------+----------+----------------------------------------+
2725 | network\ | string | No | Network name (internal AT&T field) |
2727 +------------+------------+----------+----------------------------------------+
2728 | possible\ | string | No | Reserved for future use |
2730 +------------+------------+----------+----------------------------------------+
2731 | threshold\ | string | Yes | Version of the |
2732 | Crossing | | | thresholdCrossingAlertFields block as |
2733 | Fields\ | | | "#.#" where # is a digit; see section 1|
2734 | Version | | | for the correct digits to use. |
2735 +------------+------------+----------+----------------------------------------+
2737 Technology Specific Datatypes
2738 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2740 Mobile Flow’ Domain Datatypes
2741 ++++++++++++++++++++++++++++++
2743 Datatype: gtpPerFlowMetrics
2744 ****************************
2746 The gtpPerFlowMetrics datatype consists of the following fields:
2748 +---------------+--------+----------+-----------------------------------------+
2749 | Field | Type | Required?| Description |
2750 +===============+========+==========+=========================================+
2751 | avgBit\ | number | Yes | Average bit error rate |
2753 +---------------+--------+----------+-----------------------------------------+
2754 | avgPacket\ | number | Yes | Average packet delay variation or jitter|
2755 | Delay\ | | | in milliseconds for received packets: |
2756 | Variation | | | Average difference between the packet |
2757 | | | | timestamp and time received for all |
2758 | | | | pairs of consecutive packets |
2759 +---------------+--------+----------+-----------------------------------------+
2760 | avgPacket\ | number | Yes | Average delivery latency |
2762 +---------------+--------+----------+-----------------------------------------+
2763 | avgReceive\ | number | Yes | Average receive throughput |
2764 | Throughput | | | |
2765 +---------------+--------+----------+-----------------------------------------+
2766 | avgTransmit\ | number | Yes | Average transmit throughput |
2767 | Throughput | | | |
2768 +---------------+--------+----------+-----------------------------------------+
2769 | dur\ | number | No | Duration of failed state in milliseconds|
2770 | Connection\ | | | , computed as the cumulative time |
2771 | FailedStatus | | | between a failed echo request and the |
2772 | | | | next following successful error request,|
2773 | | | | over this reporting interval |
2774 +---------------+--------+----------+-----------------------------------------+
2775 | durTunnel\ | number | No | Duration of errored state, computed as |
2776 | FailedStatus | | | the cumulative time between a tunnel |
2777 | | | | error indicator and the next following |
2778 | | | | non-errored indicator, over this |
2779 | | | | reporting interval |
2780 +---------------+--------+----------+-----------------------------------------+
2781 | flow\ | string | No | Endpoint activating the flow |
2782 | ActivatedBy | | | |
2783 +---------------+--------+----------+-----------------------------------------+
2784 | flow\ | number | Yes | Time the connection is activated in the |
2785 | Activation\ | | | flow (connection) being reported on, or |
2786 | Epoch | | | transmission time of the first packet if|
2787 | | | | activation time is not available |
2788 +---------------+--------+----------+-----------------------------------------+
2789 | flow\ | number | Yes | Integer microseconds for the start of |
2790 | Activation\ | | | the flow connection |
2792 +---------------+--------+----------+-----------------------------------------+
2793 | flow\ | string | No | Time the connection is activated in the |
2794 | Activation\ | | | flow being reported on, or transmission |
2795 | Time | | | time of the first packet if activation |
2796 | | | | time is not available; with RFC 2822 |
2797 | | | | compliant format: ‘Sat, 13 Mar 2010 |
2798 | | | | 11:29:05 -0800’ |
2799 +---------------+--------+----------+-----------------------------------------+
2800 | flow\ | string | No | Endpoint deactivating the flow |
2801 | Deactivated\ | | | |
2803 +---------------+--------+----------+-----------------------------------------+
2804 | flow\ | number | Yes | Time for the start of the flow |
2805 | Deactivation\ | | | connection, in integer UTC epoch time |
2806 | Epoch | | | aka UNIX time |
2807 +---------------+--------+----------+-----------------------------------------+
2808 | flow\ | number | Yes | Integer microseconds for the start of |
2809 | Deactivation\ | | | the flow connection |
2811 +---------------+--------+----------+-----------------------------------------+
2812 | flow\ | string | Yes | Transmission time of the first packet in|
2813 | Deactivation\ | | | the flow connection being reported on; |
2814 | Time | | | with RFC 2822 compliant format: ‘Sat, 13|
2815 | | | | Mar 2010 11:29:05 -0800’ |
2816 +---------------+--------+----------+-----------------------------------------+
2817 | flowStatus | string | Yes | Connection status at reporting time as a|
2818 | | | | working / inactive / failed indicator |
2820 +---------------+--------+----------+-----------------------------------------+
2821 | gtp\ | string | No | Current connection state at reporting |
2822 | Connection\ | | | time |
2824 +---------------+--------+----------+-----------------------------------------+
2825 | gtpTunnel\ | string | No | Current tunnel state at reporting time |
2827 +---------------+--------+----------+-----------------------------------------+
2828 | ipTos\ | hashMap| No | Array of key: value pairs where the keys|
2829 | CountList | | | are drawn from the IP Type-of-Service |
2830 | | | | identifiers which range from '0' to |
2831 | | | | '255', and the values are the count of |
2832 | | | | packets that had those ToS identifiers |
2833 | | | | in the flow |
2834 +---------------+--------+----------+-----------------------------------------+
2835 | ipTosList | string | No | Array of unique IP Type-of-Service |
2836 | | | | values observed in the flow where values|
2837 | | | | range from '0' to '255' |
2838 +---------------+--------+----------+-----------------------------------------+
2839 | large\ | number | No | large packet round trip time |
2841 +---------------+--------+----------+-----------------------------------------+
2842 | largePacket\ | number | No | large packet threshold being applied |
2844 +---------------+--------+----------+-----------------------------------------+
2845 | maxPacket\ | number | Yes | Maximum packet delay variation or jitter|
2846 | Delay\ | | | in milliseconds for received packets: |
2847 | Variation | | | Maximum of the difference between the |
2848 | | | | packet timestamp and time received for |
2849 | | | | all pairs of consecutive packets |
2850 +---------------+--------+----------+-----------------------------------------+
2851 | maxReceive\ | number | No | maximum receive bit rate" |
2853 +---------------+--------+----------+-----------------------------------------+
2854 | maxTransmit\ | number | No | maximum transmit bit rate |
2856 +---------------+--------+----------+-----------------------------------------+
2857 | mobileQci\ | hashMap| No | array of key: value pairs where the keys|
2858 | CosCountList | | | are drawn from LTE QCI or UMTS class of |
2859 | | | | service strings, and the values are the |
2860 | | | | count of packets that had those strings |
2861 | | | | in the flow |
2862 +---------------+--------+----------+-----------------------------------------+
2863 | mobileQci\ | string | No | Array of unique LTE QCI or UMTS |
2864 | CosList | | | class-of-service values observed in the |
2866 +---------------+--------+----------+-----------------------------------------+
2867 | num\ | number | Yes | Number of failed activation requests, as|
2868 | Activation\ | | | observed by the reporting node |
2870 +---------------+--------+----------+-----------------------------------------+
2871 | numBit\ | number | Yes | number of errored bits |
2873 +---------------+--------+----------+-----------------------------------------+
2874 | numBytes\ | number | Yes | number of bytes received, including |
2875 | Received | | | retransmissions |
2876 +---------------+--------+----------+-----------------------------------------+
2877 | numBytes\ | number | Yes | number of bytes transmitted, including |
2878 | Transmitted | | | retransmissions |
2879 +---------------+--------+----------+-----------------------------------------+
2880 | numDropped\ | number | Yes | number of received packets dropped due |
2881 | Packets | | | to errors per virtual interface |
2882 +---------------+--------+----------+-----------------------------------------+
2883 | numGtp\ | number | No | Number of Echo request path failures |
2884 | EchoFailures | | | where failed paths are defined in 3GPP |
2885 | | | | TS 29.281 sec 7.2.1 and 3GPP TS 29.060 |
2887 +---------------+--------+----------+-----------------------------------------+
2888 | numGtp\ | number | No | Number of tunnel error indications where|
2889 | TunnelErrors | | | errors are defined in 3GPP TS 29.281 sec|
2890 | | | | 7.3.1 and 3GPP TS 29.060 sec. 11.1 |
2891 +---------------+--------+----------+-----------------------------------------+
2892 | numHttp\ | number | No | Http error count |
2894 +---------------+--------+----------+-----------------------------------------+
2895 | numL7Bytes\ | number | Yes | number of tunneled layer 7 bytes |
2896 | Received | | | received, including retransmissions |
2897 +---------------+--------+----------+-----------------------------------------+
2898 | numL7Bytes\ | number | Yes | number of tunneled layer 7 bytes |
2899 | Transmitted | | | transmitted, excluding retransmissions |
2900 +---------------+--------+----------+-----------------------------------------+
2901 | numLost\ | number | Yes | number of lost packets |
2903 +---------------+--------+----------+-----------------------------------------+
2904 | numOutOf\ | number | Yes | number of out-of-order packets |
2905 | OrderPackets | | | |
2906 +---------------+--------+----------+-----------------------------------------+
2907 | numPacket\ | number | Yes | number of errored packets |
2909 +---------------+--------+----------+-----------------------------------------+
2910 | numPackets\ | number | Yes | number of packets received, excluding |
2911 | ReceivedExcl\ | | | retransmission |
2913 +---------------+--------+----------+-----------------------------------------+
2914 | numPackets\ | number | Yes | number of packets received, including |
2915 | ReceivedIncl\ | | | retransmission |
2917 +---------------+--------+----------+-----------------------------------------+
2918 | numPackets\ | number | Yes | number of packets transmitted, including|
2919 | Transmitted\ | | | retransmissions |
2920 | InclRetrans | | | |
2921 +---------------+--------+----------+-----------------------------------------+
2922 | numRetries | number | Yes | number of packet retrie |
2923 +---------------+--------+----------+-----------------------------------------+
2924 | numTimeouts | number | Yes | number of packet timeouts |
2925 +---------------+--------+----------+-----------------------------------------+
2926 | numTunneled\ | number | Yes | number of tunneled layer 7 bytes |
2927 | L7Bytes\ | | | received, excluding retransmissions |
2929 +---------------+--------+----------+-----------------------------------------+
2930 | roundTrip\ | number | Yes | Round Trip time |
2932 +---------------+--------+----------+-----------------------------------------+
2933 | tcpFlag\ | hashMap| No | Array of key: value pairs where the keys|
2934 | CountList | | | are drawn from TCP Flags and the values |
2935 | | | | are the count of packets that had that |
2936 | | | | TCP Flag in the flow |
2937 +---------------+--------+----------+-----------------------------------------+
2938 | tcpFlag\ | string | No | Array of unique TCP Flags observed in |
2939 | List | | | the flow |
2940 +---------------+--------+----------+-----------------------------------------+
2941 | timeTo\ | number | Yes | Time in milliseconds between the |
2942 | FirstByte | | | connection activation and first byte |
2944 +---------------+--------+----------+-----------------------------------------+
2946 Datatype: mobileFlowFields
2947 ***************************
2949 The mobileFlowFields datatype consists of the following fields:
2951 +-------------+------------+----------+---------------------------------------+
2952 | Field | Type | Required?| Description |
2953 +=============+============+==========+=======================================+
2954 | additional\ | hashMap | No | Additional mobileFlow fields if needed|
2956 +-------------+------------+----------+---------------------------------------+
2957 | application\| string | No | Application type inferred |
2959 +-------------+------------+----------+---------------------------------------+
2960 | appProtocol\| string | No | Application protocol |
2962 +-------------+------------+----------+---------------------------------------+
2963 | appProtocol\| string | No | Application version |
2965 +-------------+------------+----------+---------------------------------------+
2966 | cid | string | No | Cell Id |
2967 +-------------+------------+----------+---------------------------------------+
2968 | connection\ | string | No | Abbreviation referencing a 3GPP |
2969 | Type | | | reference point e.g., S1-U, S11, etc |
2970 +-------------+------------+----------+---------------------------------------+
2971 | ecgi | string | No | Evolved Cell Global Id |
2972 +-------------+------------+----------+---------------------------------------+
2973 | flow\ | string | Yes | Flow direction, indicating if the |
2974 | Direction | | | reporting node is the source of the |
2975 | | | | flow or destination for the flow |
2976 +-------------+------------+----------+---------------------------------------+
2977 | gtpPer\ | gtpPer | Yes | Mobility GTP Protocol per flow metrics|
2978 | FlowMetrics | FlowMetrics| | |
2979 +-------------+------------+----------+---------------------------------------+
2980 | gtpProtocol\| string | No | GTP protocol |
2982 +-------------+------------+----------+---------------------------------------+
2983 | gtpVersion | string | No | GTP protocol version |
2984 +-------------+------------+----------+---------------------------------------+
2985 | httpHeader | string | No | HTTP request header, if the flow |
2986 | | | | connects to a node referenced by HTTP |
2987 +-------------+------------+----------+---------------------------------------+
2988 | imei | string | No | IMEI for the subscriber UE used in |
2989 | | | | this flow, if the flow connects to a |
2990 | | | | mobile device |
2991 +-------------+------------+----------+---------------------------------------+
2992 | imsi | string | No | IMSI for the subscriber UE used in |
2993 | | | | this flow, if the flow connects to a |
2994 | | | | mobile device |
2995 +-------------+------------+----------+---------------------------------------+
2996 | ipProtocol\ | string | Yes | IP protocol type e.g.,TCP, UDP, RTP...|
2998 +-------------+------------+----------+---------------------------------------+
2999 | ipVersion | string | Yes | IP protocol version e.g., IPv4, IPv6 |
3000 +-------------+------------+----------+---------------------------------------+
3001 | lac | string | No | Location area code |
3002 +-------------+------------+----------+---------------------------------------+
3003 | mcc | string | No | Mobile country code |
3004 +-------------+------------+----------+---------------------------------------+
3005 | mnc | string | No | Mobile network code |
3006 +-------------+------------+----------+---------------------------------------+
3007 | mobileFlow\ | string | Yes | Version of the mobileFlowFields block |
3008 | Fields\ | | | as "#.#" where # is a digit; see |
3009 | Version | | | section 1 for the correct digits to |
3011 +-------------+------------+----------+---------------------------------------+
3012 | msisdn | string | No | MSISDN for the subscriber UE used in |
3013 | | | | this flow, as an integer, if the flow |
3014 | | | | connects to a mobile device |
3015 +-------------+------------+----------+---------------------------------------+
3016 | other\ | string | Yes | IP address for the other endpoint, as |
3017 | EndpointIp\ | | | used for the flow being reported on |
3019 +-------------+------------+----------+---------------------------------------+
3020 | other\ | integer | Yes | IP Port for the reporting entity, as |
3021 | Endpoint\ | | | used for the flow being reported on |
3023 +-------------+------------+----------+---------------------------------------+
3024 | other\ | string | No | Functional role of the other endpoint |
3025 | Functional\ | | | for the flow being reported on e.g., |
3026 | Role | | | MME, S-GW, P-GW, PCRF... |
3027 +-------------+------------+----------+---------------------------------------+
3028 | rac | string | No | Routing area code |
3029 +-------------+------------+----------+---------------------------------------+
3030 | radioAccess\| string | No | Radio Access Technology e.g., 2G, 3G, |
3031 | Technology | | | LTE |
3032 +-------------+------------+----------+---------------------------------------+
3033 | reporting\ | string | Yes | IP address for the reporting entity, |
3034 | EndpointIp\ | | | as used for the flow being reported on|
3036 +-------------+------------+----------+---------------------------------------+
3037 | reporting\ | integer | Yes | IP port for the reporting entity, as |
3038 | EndpointPort| | | used for the flow being reported on |
3039 +-------------+------------+----------+---------------------------------------+
3040 | sac | string | No | Service area code |
3041 +-------------+------------+----------+---------------------------------------+
3042 | sampling\ | integer | No | Integer identifier for the sampling |
3043 | Algorithm | | | algorithm or rule being applied in |
3044 | | | | calculating the flow metrics if |
3045 | | | | metrics are calculated based on a |
3046 | | | | sample of packets, or 0 if no sampling|
3047 | | | | is applied |
3048 +-------------+------------+----------+---------------------------------------+
3049 | tac | string | No | Transport area code |
3050 +-------------+------------+----------+---------------------------------------+
3051 | tunnelId | string | No | Tunnel identifier |
3052 +-------------+------------+----------+---------------------------------------+
3053 | vlanId | string | No | VLAN identifier used by this flow |
3054 +-------------+------------+----------+---------------------------------------+
3056 ‘SipSignaling’ Domain Datatypes
3057 +++++++++++++++++++++++++++++++
3059 Datatype: sipSignalingFields
3060 *****************************
3062 The sipSignalingFields datatype communicates information about sip
3063 signaling messages, parameters and signaling state; it consists of the
3066 +--------------+-----------+----------+---------------------------------------+
3067 | Field | Type | Required?| Description |
3068 +==============+===========+==========+=======================================+
3069 | additional\ | hashMap | No | Additional sipSignaling fields |
3070 | Information | | | |
3071 +--------------+-----------+----------+---------------------------------------+
3072 | compressed\ | string | No | The full SIP request/response |
3073 | Sip | | | including headers and bodies |
3074 +--------------+-----------+----------+---------------------------------------+
3075 | correlator | string | Yes | Constant across all events on this |
3077 +--------------+-----------+----------+---------------------------------------+
3078 | local\ | string | Yes | Ip address on xNF |
3080 +--------------+-----------+----------+---------------------------------------+
3081 | localPort | string | Yes | Port on xNF |
3082 +--------------+-----------+----------+---------------------------------------+
3083 | remote\ | string | Yes | IP address of peer endpoint |
3085 +--------------+-----------+----------+---------------------------------------+
3086 | remotePort | string | Yes | Port of peer endpoint |
3087 +--------------+-----------+----------+---------------------------------------+
3088 | sipSignaling\| string | Yes | Version of the sipSignalingFields |
3089 | FieldsVersion| | | block as "#.#" where # is a digit; see|
3090 | | | | section 1 for the correct digits to |
3092 +--------------+-----------+----------+---------------------------------------+
3093 | summarySip | string | No | The SIP Method or Response (‘INVITE’, |
3094 | | | | ‘200 OK’, ‘BYE’, etc) |
3095 +--------------+-----------+----------+---------------------------------------+
3096 | vendorNf\ | vendorNf | Yes | Vendor, NF and nfModule names |
3097 | NameFields | NameFields| | |
3098 +--------------+-----------+----------+---------------------------------------+
3100 ‘Voice Quality’ Domain Datatypes
3101 +++++++++++++++++++++++++++++++++
3103 Datatype: endOfCallVqmSummaries
3104 *********************************
3106 The endOfCallVqmSummaries datatype provides end of call voice quality
3107 metrics; it consists of the following fields:
3109 +--------------+-------+----------+-------------------------------------------+
3110 | Field | Type | Required?| Description |
3111 +==============+=======+==========+===========================================+
3112 | adjacency\ | string| Yes | Adjacency name |
3114 +--------------+-------+----------+-------------------------------------------+
3115 | endpoint\ | number| No | Endpoint average jitter |
3116 | AverageJitter| | | |
3117 +--------------+-------+----------+-------------------------------------------+
3118 | endpoint\ | string| Yes | Enumeration: ‘Caller’, ‘Callee’ |
3119 | Description | | | |
3120 +--------------+-------+----------+-------------------------------------------+
3121 | endpoint\ | number| No | Endpoint maximum jitter |
3123 +--------------+-------+----------+-------------------------------------------+
3124 | endpointRtp\ | number| No | Endpoint RTP octets discarded |
3127 +--------------+-------+----------+-------------------------------------------+
3128 | endpointRtp\ | number| No | Endpoint RTP octets lost |
3129 | OctetsLost | | | |
3130 +--------------+-------+----------+-------------------------------------------+
3131 | endpointRtp\ | number| No | Endpoint RTP octets received |
3134 +--------------+-------+----------+-------------------------------------------+
3135 | endpointRtp\ | number| No | Endpoint RTP octets sent |
3136 | OctetsSent | | | |
3137 +--------------+-------+----------+-------------------------------------------+
3138 | endpointRtp\ | number| No | Endpoint RTP packets discarded |
3141 +--------------+-------+----------+-------------------------------------------+
3142 | endpointRtp\ | number| No | Endpoint RTP packets lost |
3143 | PacketsLost | | | |
3144 +--------------+-------+----------+-------------------------------------------+
3145 | endpointRtp\ | number| No | Endpoint RTP packets received |
3148 +--------------+-------+----------+-------------------------------------------+
3149 | endpointRtp\ | number| No | Endpoint RTP packets sent |
3150 | PacketsSent | | | |
3151 +--------------+-------+----------+-------------------------------------------+
3152 | local\ | number| No | Local average jitter |
3155 +--------------+-------+----------+-------------------------------------------+
3156 | localAverage\| number| No | Local average jitter buffer delay |
3157 | JitterBuffer\| | | |
3159 +--------------+-------+----------+-------------------------------------------+
3160 | localMax\ | number| No | Local maximum jitter |
3162 +--------------+-------+----------+-------------------------------------------+
3163 | localMax\ | number| No | Local max jitter buffer delay |
3164 | JitterBuffer\| | | |
3166 +--------------+-------+----------+-------------------------------------------+
3167 | localRtp\ | number| No | Local RTP octets discarded |
3170 +--------------+-------+----------+-------------------------------------------+
3171 | localRtp\ | number| No | Local RTP octets lost |
3172 | OctetsLost | | | |
3173 +--------------+-------+----------+-------------------------------------------+
3174 | localRtp\ | number| No | Local RTP octets received |
3177 +--------------+-------+----------+-------------------------------------------+
3178 | localRtp\ | number| No | Local RTP octets sent |
3179 | OctetsSent | | | |
3180 +--------------+-------+----------+-------------------------------------------+
3181 | localRtp\ | number| No | Local RTP packets discarded |
3184 +--------------+-------+----------+-------------------------------------------+
3185 | localRtp\ | number| No | Local RTP packets lost |
3186 | PacketsLost | | | |
3187 +--------------+-------+----------+-------------------------------------------+
3188 | localRtp\ | number| No | Local RTP packets received |
3191 +--------------+-------+----------+-------------------------------------------+
3192 | localRtp\ | number| No | Local RTP packets sent |
3193 | PacketsSent | | | |
3194 +--------------+-------+----------+-------------------------------------------+
3195 | mosCqe | number| No | Decimal range from 1 to 5(1 decimal place)|
3196 +--------------+-------+----------+-------------------------------------------+
3197 | oneWayDelay | number| No | one-way path delay in milliseconds |
3198 +--------------+-------+----------+-------------------------------------------+
3199 | packet\ | number| No | Calculated percentage packet loss based on|
3200 | LossPercent | | | endpoint RTP packets lost (as reported in |
3201 | | | | RTCP) and local RTP packets sent. |
3202 | | | | Direction is based on endpoint description|
3203 | | | | (Caller, Callee). Decimal (2 decimal |
3205 +--------------+-------+----------+-------------------------------------------+
3206 | rFactor | number| No | rFactor from 0 to 100 |
3207 +--------------+-------+----------+-------------------------------------------+
3208 | round\ | number| No | Round trip delay in milliseconds |
3210 +--------------+-------+----------+-------------------------------------------+
3212 Datatype: voiceQualityFields
3213 *****************************
3215 The voiceQualityFields datatype provides statistics related to customer
3216 facing voice products; consists of the following fields:
3218 +--------------+-------------+----------+-------------------------------------+
3219 | Field | Type | Required?| Description |
3220 +==============+=============+==========+=====================================+
3221 | additional\ | hashMap | No | Additional voice quality fields |
3222 | Information | | | |
3223 +--------------+-------------+----------+-------------------------------------+
3224 | callee\ | string | Yes | Callee codec for the call |
3226 +--------------+-------------+----------+-------------------------------------+
3227 | caller\ | string | Yes | Caller codec for the call |
3229 +--------------+-------------+----------+-------------------------------------+
3230 | correlator | string | Yes | Constant across all events on this |
3232 +--------------+-------------+----------+-------------------------------------+
3233 | endOfCall\ | endOfCallVqm| No | End of call voice quality metric |
3234 | VqmSummaries | Summaries | | summaries |
3235 +--------------+-------------+----------+-------------------------------------+
3236 | phoneNumber | string | No | Phone number associated with the |
3237 | | | | correlator |
3238 +--------------+-------------+----------+-------------------------------------+
3239 | midCallRtcp | string | Yes | Base64 encoding of the binary RTCP |
3240 | | | | data (excluding Eth/IP/UDP headers) |
3241 +--------------+-------------+----------+-------------------------------------+
3242 | vendorNf\ | vendorNf | Yes | Vendor, NF and nfModule names |
3243 | NameFields | NameFields | | |
3244 +--------------+-------------+----------+-------------------------------------+
3245 | voiceQuality\| string | Yes | Version of the voiceQualityFields |
3246 | FieldsVersion| | | block as "#.#" where # is a digit; |
3247 | | | | see section 1 for the correct digits|
3249 +--------------+-------------+----------+-------------------------------------+
3252 RESTful Web Services Definition
3253 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3258 Event sources must identify themselves to the VES Event Listener.
3260 There are 2 methods of HTTP authentication supported: Certificate Authentication
3261 and Basic Authentication.
3263 Basic authentication is supported in VES Event Listener for backward
3264 compatibility for existing NFs that are already managed by ONAP. New NFs should
3265 support Certificate Authentication. Because the security is better, NFs may
3266 choose to only support Certificate Authentication and not support Basic
3269 Basic Authentication
3270 ++++++++++++++++++++
3272 When using Basic Authentication, the event source must not pass credentials on
3273 the query string. Credentials must be sent in an Authorization header as
3276 1. The username and password are formed into one string as
3277 ``username:password``
3278 2. The resulting string is Base64 encoded to produce the encoded credential.
3279 3. The encoded credential is communicated in the header after the string
3280 ``Authorization: Basic``
3282 Because the credentials are merely encoded but not encrypted, HTTPS (rather
3283 than HTTP) should be used. HTTPS will also encrypt and protect event contents.
3285 Sample Request and Response
3286 +++++++++++++++++++++++++++
3291 .. code-block:: http
3293 POST /eventListener/v7 HTTP/1.1
3294 Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
3295 content-type: application/json
3296 content-length: 12345
3299 "commonEventHeader": {
3301 "vesEventListenerVersion": "7.2",
3302 "domain": "heartbeat",
3303 "eventName": "Heartbeat_vIsbcMmc",
3304 "eventId": "heartbeat0000249",
3306 "priority": "Normal",
3307 "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234",
3308 "reportingEntityName": "ibcx0001vm002oam001",
3309 "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014",
3310 "sourceName": "ibcx0001vm002ssc001",
3311 "nfVendorName": "Ericsson",
3312 "nfNamingCode": "ibcx",
3313 "nfcNamingCode": "ssc",
3314 "startEpochMicrosec": 1413378172000000,
3315 "lastEpochMicrosec": 1413378172000000,
3316 "timeZoneOffset": "UTC-05:30"
3322 Sample Success Response
3323 ***********************
3325 .. code-block:: http
3327 HTTPS/1.1 202 Accepted
3330 X-LatestVersion: 7.2
3333 Mutual TLS Certificate Authentication
3334 +++++++++++++++++++++++++++++++++++++
3336 When using Certificate Authentication, the event source must initialize the
3337 HTTPS connection with TLS 1.2 or higher and execute mutual authentication
3338 procedures according to `RFC5246 <https://tools.ietf.org/html/rfc5246#section-7.4.6>`__.
3339 The event source must authenticate the VES Listener certificate and must
3340 provide its own X.509v3 end-entity certificate to the VES Listener for
3341 authentication. The Subject Name in the end-entity certificate must be used
3342 according to `RFC5280 <https://www.ietf.org/rfc/rfc5280.txt>`__. If a
3343 certificate is provided by the NF but it is invalid, the VES Listener is
3344 expected to reject the connection and not fall back to basic authentication.
3349 REST resources are defined with respect to a ServerRoot:
3351 ServerRoot = https://{Domain|IP}:{Port}/{optionalRoutingPath}
3353 The resource structure is provided below::
3357 |--- /eventListener/v{apiVersion}
3361 **Figure 1**: REST Resource Structure
3366 RESTful Web Services Exceptions
3367 +++++++++++++++++++++++++++++++
3369 RESTful services generate and send exceptions to clients in response to
3370 invocation errors. Exceptions send HTTP status codes (specified later in
3371 this document for each operation). HTTP status codes may be followed by
3372 an optional JSON exception structure described below. Two types of
3373 exceptions may be defined: service exceptions and policy exceptions.
3375 +-----------+---------------+-------------+-----------------------------------+
3376 | Field Name| Data Type | Required? | Description |
3377 +===========+===============+=============+===================================+
3378 | messageId | xs:string | Yes | Unique message identifier of the |
3379 | | | | format ‘ABCnnnn’ where ‘ABC’ is |
3380 | | | | either ‘SVC’ for Service |
3381 | | | | Exceptions or ‘POL’ for Policy |
3382 | | | | Exception. |
3384 | | | | Exception numbers may be in the |
3385 | | | | range of 0001 to 9999 where : |
3387 | | | | - 0001 to 2999 are defined by OMA|
3388 | | | | (see OMA’s Common_definitions_ |
3389 | | | | for details) |
3391 | | | | - 3000-9999 are available and |
3393 +-----------+---------------+-------------+-----------------------------------+
3394 | text | xs:string | Yes | Message text, with replacement |
3395 | | | | variables marked with %n, where n |
3396 | | | | is an index into the list of |
3397 | | | | <variables> elements, starting at |
3399 +-----------+---------------+-------------+-----------------------------------+
3400 | variables | xs:string | No | List of zero or more strings that |
3401 | | [0..unbounded]| | represent the contents of the |
3402 | | | | variables used by the message text|
3403 +-----------+---------------+-------------+-----------------------------------+
3404 | url | xs:anyUrl | No | Hyperlink to a detailed error |
3405 | | | | resource (e.g., an HTML page for |
3406 | | | | browser user agents). |
3407 +-----------+---------------+-------------+-----------------------------------+
3412 When a service is not able to process a request, and retrying the
3413 request with the same information will also result in a failure, and
3414 the issue is not related to a service policy issue, then the service
3415 will issue a fault using the service exception fault message.
3416 Examples of service exceptions include invalid input, lack of
3417 availability of a required resource or a processing error.
3419 A service exception uses the letters 'SVC' at the beginning of the
3420 message identifier. ‘SVC’ service exceptions used by the VES Event
3421 Listener API are defined below.
3423 +----------+--------------+-----------------------+----------------+----------+
3424 | MessageId| Description | Text | Variables | Parent |
3425 | | / Comment | | | HTTP Code|
3426 +==========+==============+=======================+================+==========+
3427 | SVC0001 | General | <custom error message>| None | 400 |
3428 | | service error| | | |
3429 | | (see SVC2000)| | | |
3430 +----------+--------------+-----------------------+----------------+----------+
3431 | SVC0002 | Bad parameter| Invalid input value | %1: message | 400 |
3432 | | | for message part %1 | part | |
3433 +----------+--------------+-----------------------+----------------+----------+
3434 | SVC1000 | No server | No server resources | None | 500 |
3435 | | resources | available to process | | |
3436 | | | the request | | |
3437 +----------+--------------+-----------------------+----------------+----------+
3438 | SVC2000 | More | The following service | %1: human | 400 |
3439 | | elaborate | error occurred: %1. | readable | |
3440 | | version of | | description of | |
3441 | | SVC0001 | | the error | |
3443 | | | Error code is %2. | %2: error code | |
3444 +----------+--------------+-----------------------+----------------+----------+
3446 Table - Service Exceptions
3451 When a service is not able to complete because the request fails to
3452 meet a policy criteria, then the service will issue a fault using the
3453 policy exception fault message. To clarify how a policy exception
3454 differs from a service exception, consider that all the input to an
3455 operation may be valid as meeting the required input for the
3456 operation (thus no service exception), but using that input in the
3457 execution of the service may result in conditions that require the
3458 service not to complete. Examples of policy exceptions include
3459 privacy violations, requests not permitted under a governing service
3460 agreement or input content not acceptable to the service provider.
3462 A Policy Exception uses the letters 'POL' at the beginning of the
3463 message identifier. ‘POL’ policy exceptions used by the VES Event
3464 Listener API are defined below.
3466 +----------+---------------+-----------------------+---------------+----------+
3467 | MessageId| Description |Text | Variables | Parent |
3468 | | / Comment | | | HTTP Code|
3469 +==========+===============+=======================+===============+==========+
3470 | POL0001 | General policy| A policy error | None | 401 |
3471 | | error (see | occurred. | | |
3472 | | POL2000) | | | |
3473 +----------+---------------+-----------------------+---------------+----------+
3474 | POL1009 | User not | User has not been | None | 401 |
3475 | | provisioned | provisioned for | | |
3476 | | for service | service | | |
3477 +----------+---------------+-----------------------+---------------+----------+
3478 | POL1010 | User suspended| User has been | None | 401 |
3479 | | from service | suspended from service| | |
3480 +----------+---------------+-----------------------+---------------+----------+
3481 | POL2000 | More elaborate| The following policy | %1: human | 401 |
3482 | | version of | error occurred: %1. | readable | |
3483 | | POL0001 | Error code is %2. | description of| |
3484 | | | | the error | |
3486 | | | | %2: error code| |
3487 +----------+---------------+-----------------------+---------------+----------+
3488 | POL9003 | Message size | Message content size | None | 400 |
3489 | | exceeds limit | exceeds the allowable | | |
3491 +----------+---------------+-----------------------+---------------+----------+
3493 Table - Policy Exceptions
3495 REST Operation Overview
3496 ~~~~~~~~~~~~~~~~~~~~~~~~~
3498 REST Operation Summary
3499 +++++++++++++++++++++++
3501 +---------------------+---------+------------------------------------------+
3502 | **Operation Action**| **HTTP**| Resource URL relative to {ServerRoot}\ |
3503 | | | , which is defined in section 3 |
3505 +---------------------+---------+------------------------------------------+
3506 | publishAnyEvent | POST | /eventListener/v{apiVersion} |
3507 +---------------------+---------+------------------------------------------+
3508 | publishEventBatch | POST | /eventListener/v{apiVersion}/eventBatch |
3509 +---------------------+---------+------------------------------------------+
3511 Table - REST Operation Summary
3516 ``apiVersion`` is used to describe the major version number of the event
3517 listener API (which is the same as the major version number of this
3518 specification). When this number changes, the implication is: the new
3519 major version will break clients of older major versions in some way, if
3520 they try to use the new API without modification (e.g., unmodified v1
3521 clients would not be able to use v2 without error).
3523 The Event Listener shall provide the following HTTP headers in response
3524 to all requests. Additionally, clients may populate these headers on
3525 requests to indicate the specific version they are interested in.
3531 - X-LatestVersion: 7.2
3533 If a client requests major version 7 (per the REST resource URL) and
3534 does not specify the above headers, then they will be provided with the
3535 latest patch version of 7.0.x (which is 7.0.1). If the client wants a
3536 minor version of major version 7, then they need to supply
3537 the X-MinorVersion header with their request. For example, if they
3538 request major version 7 with X-MinorVersion: 1, they will get the latest
3539 patch version of 7.1, which is 7.1.1.
3541 .. _ves_msg_size_7_2:
3546 The maximum allowed message size is 2 megabytes of uncompressed text.
3547 However, messages of this size have been known to cause performance and data
3548 loss. It is strongly recommended, that messages not exceed 1 megabyte.
3549 In a future version of the specification, a 1 megabyte limit will become
3550 a mandatory requirement.
3552 Operation: publishAnyEvent
3553 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
3556 +++++++++++++++++++++
3558 Allows authorized clients to publish any single event to the VES event
3561 - Supports only HTTPS access.
3563 - Uses the HTTP verb POST
3565 - Supports JSON content types
3567 - Provides HTTP response codes as well as Service and Policy error
3574 :caption: ``publishAnyEvent`` Call Flow
3578 client -> listener [label = "POST /eventlistener/v7"];
3579 client <- listener [label = "HTTP 202 Accepted", note = "sync response"];
3580 === Error Scenario ===
3581 client -> listener [label = "POST /eventlistener/v7"];
3582 client <- listener [label = "HTTP 4XX/5XX", note = "sync response"];
3588 Header Fields (note: all parameter names shall be treated as
3591 +---------------+----------+----------+---------------------------------------+
3592 | Parameter | Data Type| Required?| Brief description |
3593 +---------------+----------+----------+---------------------------------------+
3594 | Accept | string | No | Determines the format of the body of |
3595 | | | | the response. Valid values are: |
3597 | | | | - application/json |
3598 +---------------+----------+----------+---------------------------------------+
3599 | Authorization | string | No | The username and password are formed |
3600 | | | | into one string as |
3601 | | | | ``username:password``. This string is |
3602 | | | | then Base64 encoded to produce the |
3603 | | | | encoded credential which is |
3604 | | | | communicated in the header after the |
3605 | | | | string "Authorization: Basic ". See |
3606 | | | | examples below. If the Authorization |
3607 | | | | header is missing, then an HTTP 400 |
3608 | | | | Invalid Request message shall be |
3609 | | | | returned. If the string supplied is |
3610 | | | | invalid, then an HTTP 401 Unauthorized|
3611 | | | | message shall be returned. |
3612 +---------------+----------+----------+---------------------------------------+
3613 | Content-length| integer | No | Note that content length is limited to|
3614 | | | | 2 Megabyte |
3615 | | | | (see :ref:`ves_msg_size_7_2`) |
3616 +---------------+----------+----------+---------------------------------------+
3617 | Content-type | string | Yes | Must be set to one of the following |
3620 | | | | - application/json |
3621 +---------------+----------+----------+---------------------------------------+
3622 | X-MinorVersion| integer | No | The minor version of the API requested|
3623 | | | | by the client |
3624 +---------------+----------+----------+---------------------------------------+
3625 | X-PatchVersion| integer | No | The patch version of the API requested|
3626 | | | | by the client |
3627 +---------------+----------+----------+---------------------------------------+
3628 | X-Latest\ | string | No | The full version of the API requested |
3629 | Version | | | by the client expressed as |
3630 | | | | {major}.{minor}.{patch} |
3631 +---------------+----------+----------+---------------------------------------+
3635 +--------------+--------------+--------------+-------------------------------+
3636 | **Parameter**| **Data Type**| **Required?**| **Brief description** |
3637 +--------------+--------------+--------------+-------------------------------+
3638 | Event | event | Yes | Contains the JSON structure of|
3639 | | | | the common event format. |
3640 +--------------+--------------+--------------+-------------------------------+
3647 +----------------+--------------+--------------+------------------------------+
3648 | **Parameter** | **Data Type**| **Required?**| **Brief description** |
3649 +----------------+--------------+--------------+------------------------------+
3650 | Content-length | integer | No | Used only in error conditions|
3651 +----------------+--------------+--------------+------------------------------+
3652 | Content-type | string | No | Used only in error conditions|
3653 +----------------+--------------+--------------+------------------------------+
3654 | Date | datetime | No | Date time of the response in |
3656 +----------------+--------------+--------------+------------------------------+
3657 | X-MinorVersion | integer | Yes | The minor version of the API |
3659 +----------------+--------------+--------------+------------------------------+
3660 | X-PatchVersion | integer | Yes | The patch version of the API |
3662 +----------------+--------------+--------------+------------------------------+
3663 | X-LatestVersion| string | Yes | The full version of the API |
3664 | | | | service expressed as {major}.|
3665 | | | | {minor}.{patch} |
3666 +----------------+--------------+--------------+------------------------------+
3668 Body Fields (for success responses): no content is provided.
3670 Body Fields (for error responses):
3672 +--------------+--------------+----------------+------------------------------+
3673 | **Parameter**| **Data Type**| **Required?** | **Brief description** |
3674 +--------------+--------------+----------------+------------------------------+
3675 | requestError | requestError | Yes(for errors)| Used only in error conditions|
3676 +--------------+--------------+----------------+------------------------------+
3681 +-----+--------------+--------------------------------------------------------+
3682 | Code| Reason Phrase| Description |
3683 +=====+==============+========================================================+
3684 | 202 | Accepted | The request has been accepted for processing |
3685 +-----+--------------+--------------------------------------------------------+
3686 | 400 | Bad Request | Many possible reasons not specified by the other codes |
3687 | | | (e.g., missing required parameters or incorrect format)|
3688 | | | . The response body may include a further exception |
3689 | | | code and text. HTTP 400 errors may be mapped to SVC0001|
3690 | | | (general service error), SVC0002 (bad parameter), |
3691 | | | SVC2000 (general service error with details) or PO9003 |
3692 | | | (message content size exceeds the allowable limit). |
3693 +-----+--------------+--------------------------------------------------------+
3694 | 401 | Unauthorized | Authentication failed or was not provided. HTTP 401 |
3695 | | | errors may be mapped to POL0001 (general policy error) |
3696 | | | or POL2000 (general policy error with details). |
3697 +-----+--------------+--------------------------------------------------------+
3698 | 404 | Not Found | The server has not found anything matching the |
3699 | | | Request-URI. No indication is given of whether the |
3700 | | | condition is temporary or permanent. |
3701 +-----+--------------+--------------------------------------------------------+
3702 | 405 | Method Not | A request was made of a resource using a request method|
3703 | | Allowed | not supported by that resource (e.g., using PUT on a |
3704 | | | REST resource that only supports POST). |
3705 +-----+--------------+--------------------------------------------------------+
3706 | 500 | Internal | The server encountered an internal error or timed out; |
3707 | | Server Error | please retry (general catch-all server-side error).HTTP|
3708 | | | 500 errors may be mapped to SVC1000 (no server |
3710 +-----+--------------+--------------------------------------------------------+
3712 Sample Request and Response
3713 ++++++++++++++++++++++++++++
3718 .. code-block:: http
3720 POST /eventListener/v7 HTTP/1.1
3721 Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
3722 content-type: application/json
3723 content-length: 12345
3728 "commonEventHeader": {
3730 "vesEventListenerVersion": "7.2",
3732 "eventName": "Fault_Vscf:Acs-Ericcson_PilotNumberPoolExhaustion",
3733 "eventId": "fault0000245",
3736 "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234",
3737 "reportingEntityName": "ibcx0001vm002oam001",
3738 "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014",
3739 "sourceName": "scfx0001vm002cap001",
3740 "nfVendorName": "Ericsson",
3741 "nfNamingCode": "scfx",
3742 "nfcNamingCode": "ssc",
3743 "startEpochMicrosec": 1413378172000000,
3744 "lastEpochMicrosec": 1413378172000000,
3745 "timeZoneOffset": "UTC-05:30"
3748 "faultFieldsVersion": 4.0,
3749 "alarmCondition": "PilotNumberPoolExhaustion",
3750 "eventSourceType": "other",
3751 "specificProblem": "Calls cannot complete - pilot numbers are unavailable",
3752 "eventSeverity": "CRITICAL",
3753 "vfStatus": "Active",
3754 "alarmAdditionalInformation": {
3755 "PilotNumberPoolSize": "1000"
3763 Sample Success Response
3764 ************************
3766 .. code-block:: http
3768 HTTPS/1.1 202 Accepted
3771 X-LatestVersion: 7.2
3773 Sample Error Responses
3774 ************************
3776 Sample Policy Exception
3777 """"""""""""""""""""""""
3779 .. code-block:: http
3781 HTTPS/1.1 400 Bad Request
3782 content-type: application/json
3783 content-length: 12345
3784 Date: Thu, 04 Jun 2009 02:51:59 GMT
3787 X-LatestVersion: 7.2
3791 "policyException": {
3792 "messageId": "POL9003",
3793 "text": "Message content size exceeds the allowable limit",
3799 Sample Service Exception
3800 """""""""""""""""""""""""
3802 .. code-block:: http
3804 HTTPS/1.1 400 Bad Request
3805 content-type: application/json
3806 content-length: 12345
3807 Date: Thu, 04 Jun 2009 02:51:59 GMT
3810 X-LatestVersion: 7.2
3814 "serviceException": {
3815 "messageId": "SVC2000",
3816 "text": "Missing Parameter: %1. Error code is %2"
3825 Operation: publishEventBatch
3826 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3831 Allows authorized clients to publish a batch of events to the VES event
3834 - Supports only HTTPS access.
3836 - Uses the HTTP verb POST
3838 - Supports JSON content types
3840 - Provides HTTP response codes as well as Service and Policy error
3843 ``publishEventBatch`` events are handled similarly to a single event. The
3844 acknowledgement from the VES Event Listener is for the ``publishEventBatch`` and
3845 not individual events within the ``publishEventBatch``.
3851 :caption: ``publishEventBatch`` Call Flow
3855 client -> listener [label = "POST /eventlistener/v7/eventBatch"];
3856 client <- listener [label = "HTTP 202 Accepted", note = "sync response"];
3857 === Error Scenario ===
3858 client -> listener [label = "POST /eventlistener/v7/eventBatch"];
3859 client <- listener [label = "HTTP 4XX/5XX", note = "sync response"];
3865 Header Fields (note: all parameter names shall be treated as
3868 +---------------+----------+----------+---------------------------------------+
3869 | Parameter | Data Type| Required?| Brief description |
3870 +---------------+----------+----------+---------------------------------------+
3871 | Accept | string | No | Determines the format of the body of |
3872 | | | | the response. Valid values are: |
3874 | | | | - application/json |
3875 +---------------+----------+----------+---------------------------------------+
3876 | Authorization | string | No | The username and password are formed |
3877 | | | | into one string as "username:password"|
3878 | | | | . This string is then Base64 encoded |
3879 | | | | to produce the encoded credential |
3880 | | | | which is communicated in the header |
3881 | | | | after the string "Authorization: |
3882 | | | | Basic". See examples below. If the |
3883 | | | | Authorization header is missing, then |
3884 | | | | an HTTP 400 Invalid Request message |
3885 | | | | shall be returned. If the string |
3886 | | | | supplied is invalid, then an HTTP 401 |
3887 | | | | Unauthorized message shall be |
3889 +---------------+----------+----------+---------------------------------------+
3890 | Content-length| integer | No | Note that content length is limited to|
3891 | | | | 2 megabyte |
3892 | | | | (see :ref:`ves_msg_size_7_2`). |
3893 +---------------+----------+----------+---------------------------------------+
3894 | Content-type | string | Yes | Must be set to one of the following |
3897 | | | | - application/json |
3898 +---------------+----------+----------+---------------------------------------+
3899 | X-MinorVersion| integer | No | The minor version of the API requested|
3900 | | | | by the client |
3901 +---------------+----------+----------+---------------------------------------+
3902 | X-PatchVersion| integer | No | The patch version of the API requested|
3903 | | | | by the client |
3904 +---------------+----------+----------+---------------------------------------+
3905 | X-Latest\ | string | No | The full version of the API requested |
3906 | Version | | | by the client expressed as |
3907 | | | | {major}.{minor}.{patch} |
3908 +---------------+----------+----------+---------------------------------------+
3912 +--------------+--------------+--------------+-------------------------------+
3913 | **Parameter**| **Data Type**| **Required?**| **Brief description** |
3914 +--------------+--------------+--------------+-------------------------------+
3915 | eventList | eventList | Yes | Array of events conforming to |
3916 | | | | the common event format. All |
3917 | | | | events must belong to a |
3918 | | | | single domain. |
3919 +--------------+--------------+--------------+-------------------------------+
3926 +----------------+--------------+--------------+------------------------------+
3927 | **Parameter** | **Data Type**| **Required?**| **Brief description** |
3928 +----------------+--------------+--------------+------------------------------+
3929 | Content-length | integer | No | Used only in error conditions|
3930 +----------------+--------------+--------------+------------------------------+
3931 | Content-type | string | No | Used only in error conditions|
3932 +----------------+--------------+--------------+------------------------------+
3933 | Date | datetime | No | Date time of the response in |
3935 +----------------+--------------+--------------+------------------------------+
3936 | X-MinorVersion | integer | Yes | The minor version of the API |
3938 +----------------+--------------+--------------+------------------------------+
3939 | X-PatchVersion | integer | Yes | The patch version of the API |
3941 +----------------+--------------+--------------+------------------------------+
3942 | X-LatestVersion| string | Yes | The full version of the API |
3943 | | | | service expressed as |
3944 | | | | {major}.{minor}.{patch} |
3945 +----------------+--------------+--------------+------------------------------+
3947 Body Fields (for success responses: no content is provided.
3949 Body Fields (for error responses):
3951 +--------------+--------------+----------------+------------------------------+
3952 | **Parameter**| **Data Type**| **Required?** | **Brief description** |
3953 +--------------+--------------+----------------+------------------------------+
3954 | requestError | requestError | Yes(for errors)| Used only in error conditions|
3955 +--------------+--------------+----------------+------------------------------+
3960 +-----+--------------+--------------------------------------------------------+
3961 | Code| Reason Phrase| Description |
3962 +=====+==============+========================================================+
3963 | 202 | Accepted | The request has been accepted for processing |
3964 +-----+--------------+--------------------------------------------------------+
3965 | 400 | Bad Request | Many possible reasons not specified by the other codes |
3966 | | | (e.g., missing required parameters or incorrect format)|
3967 | | | . The response body may include a further exception |
3968 | | | code and text. HTTP 400 errors may be mapped to SVC0001|
3969 | | | (general service error), SVC0002 (bad parameter), |
3970 | | | SVC2000 (general service error with details) or PO9003 |
3971 | | | (message content size exceeds the allowable limit). |
3972 +-----+--------------+--------------------------------------------------------+
3973 | 401 | Unauthorized | Authentication failed or was not provided. HTTP 401 |
3974 | | | errors may be mapped to POL0001 (general policy error) |
3975 | | | or POL2000 (general policy error with details). |
3976 +-----+--------------+--------------------------------------------------------+
3977 | 404 | Not Found | The server has not found anything matching the |
3978 | | | Request-URI. No indication is given of whether the |
3979 | | | condition is temporary or permanent. |
3980 +-----+--------------+--------------------------------------------------------+
3981 | 405 | Method Not | A request was made of a resource using a request method|
3982 | | Allowed | not supported by that resource (e.g., using PUT on a |
3983 | | | REST resource that only supports POST). |
3984 +-----+--------------+--------------------------------------------------------+
3985 | 500 | Internal | The server encountered an internal error or timed out; |
3986 | | Server Error | please retry (general catch-all server-side error).HTTP|
3987 | | | 500 errors may be mapped to SVC1000 (no server |
3989 +-----+--------------+--------------------------------------------------------+
3991 Sample Request and Response
3992 +++++++++++++++++++++++++++++
3997 .. code-block:: http
3999 POST /eventListener/v7/eventBatch HTTP/1.1
4000 Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
4001 content-type: application/json
4002 content-length: 12345
4008 "commonEventHeader": {
4010 "vesEventListenerVersion": "7.2",
4012 "eventName": "Fault_Vscf:Acs-Ericcson_PilotNumberPoolExhaustion",
4013 "eventId": "fault0000250",
4016 "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234",
4017 "reportingEntityName": "ibcx0001vm002oam0011234",
4018 "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014",
4019 "sourceName": "scfx0001vm002cap001",
4020 "nfVendorName": "Ericsson",
4021 "nfNamingCode": "scfx",
4022 "nfcNamingCode": "ssc",
4023 "startEpochMicrosec": 1413378172000000,
4024 "lastEpochMicrosec": 1413378172000000,
4025 "timeZoneOffset": "UTC-05:30"
4028 "faultFieldsVersion": 4.0,
4029 "alarmCondition": "PilotNumberPoolExhaustion",
4030 "eventSourceType": "other",
4031 "specificProblem": "Calls cannot complete - pilot numbers are unavailable",
4032 "eventSeverity": "CRITICAL",
4033 "vfStatus": "Active",
4034 "alarmAdditionalInformation": {
4035 "PilotNumberPoolSize": "1000"
4040 "commonEventHeader": {
4042 "vesEventListenerVersion": "7.2",
4044 "eventName": " Fault_Vscf:Acs-Ericcson_RecordingServerUnreachable",
4045 "eventId": "fault0000251",
4048 "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234",
4049 "reportingEntityName": "ibcx0001vm002oam0011234",
4050 "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014",
4051 "sourceName": "scfx0001vm002cap001",
4052 "nfVendorName": "Ericsson",
4053 "nfNamingCode": "scfx",
4054 "nfcNamingCode": "ssc",
4055 "startEpochMicrosec": 1413378172000010,
4056 "lastEpochMicrosec": 1413378172000010,
4057 "timeZoneOffset": "UTC-05:30"
4060 "faultFieldsVersion": 4.0,
4061 "alarmCondition": "RecordingServerUnreachable",
4062 "eventSourceType": "other",
4063 "specificProblem": "Recording server unreachable",
4064 "eventSeverity": "CRITICAL",
4065 "vfStatus": "Active"
4071 Sample Success Response
4072 *************************
4074 .. code-block:: http
4076 HTTPS/1.1 202 Accepted
4079 X-LatestVersion: 7.2
4081 Sample Error Responses
4082 ************************
4084 Sample Policy Exception
4085 """"""""""""""""""""""""
4087 .. code-block:: http
4089 HTTPS/1.1 400 Bad Request
4090 content-type: application/json
4091 content-length: 12345
4092 Date: Thu, 04 Jun 2009 02:51:59 GMT
4095 X-LatestVersion: 7.2
4099 "policyException": {
4100 "messageId": "POL9003",
4101 "text": "Message content size exceeds the allowable limit",
4108 Sample Service Exception
4109 """""""""""""""""""""""""
4111 .. code-block:: http
4113 HTTPS/1.1 400 Bad Request
4114 content-type: application/json
4115 content-length: 12345
4116 Date: Thu, 04 Jun 2009 02:51:59 GMT
4119 X-LatestVersion: 7.2
4123 "serviceException": {
4124 "messageId": "SVC2000",
4125 "text": "Missing Parameter: %1. Error code is %2"
4138 Terminology used in this document is summarized below:
4140 **A&AI**. Active & Available Inventory is the ONAP component that
4141 provides data views of Customer Subscriptions, Products, Services,
4142 Resources, and their relationships.
4144 **Alarm Condition**. Short name of the alarm condition/problem, such as
4147 **APPC (formerly APP-C)**. Application Controller. Handles the life
4148 cycle management of Virtual Network Functions (VNFs).
4150 **Common Event Format**. A JSON schema describing events sent to the VES
4153 **Common Event Header**. A component of the Common Event Format JSON
4154 structure. This datatype consists of fields common to all events.
4156 **DCAE**. Data Collection Analysis and Events. DCAE is the ONAP
4157 subsystem that supports closed loop control and higher-level correlation
4158 for business and operations activities. DCAE collects performance,
4159 usage, and configuration data, provides computation of analytics, aids
4160 in trouble-shooting and management, and publishes event, data, and
4161 analytics to the rest of the ONAP system for FCAPS functionality.
4163 **DMaaP.** Data Movement as a Platform. A set of common services
4164 provided by ONAP, including a Message Router, Data Router, and a Data
4167 **Domain**. In VES, an event ‘domain’ identifies a broad category of
4168 events (e.g., ‘fault’ or ‘measurement’), each of which is associated
4169 with a VES domain field block, which is sent with the commonEventHeader
4170 when events of that category are generated.
4172 **Epoch**. The number of seconds that have elapsed since
4173 00:00:00 \ `Coordinated Universal
4174 Time <https://en.wikipedia.org/wiki/Coordinated_Universal_Time>`__ (UTC),
4175 Thursday, 1 January 1970. Every day is treated as if it contains exactly
4176 86400 seconds, so \ `leap
4177 seconds <https://en.wikipedia.org/wiki/Leap_second>`__ are not applied
4178 to seconds since the Epoch. In VES Epoch times are measured in
4181 **Event.** A well-structured packet of network management information
4182 identified by an eventName which is asynchronously communicated to one
4183 or more instances of an Event Listener service to subscribers interested
4184 in that eventName. Events can convey measurements, faults, syslogs,
4185 threshold crossing alerts, and others types of information.
4187 **Event Id**. Event key that is unique to the event source. The key must
4188 be unique within notification life cycle similar to EventID from 3GPP.
4189 It could be a sequential number, or a composite key formed from the
4190 event fields, such as sourceName\_alarmCondition\_startEpoch. The
4191 eventId should not include whitespace. For fault events, eventId is the
4192 eventId of the initial alarm; if the same alarm is raised again for
4193 changed, acknowledged or cleared cases, eventId must be the same as the
4194 initial alarm (along with the same startEpochMicrosec and an incremental
4197 **Event Name**. Identifier for specific types of events. Specific
4198 eventNames registered by the YAML may require that certain fields, which
4199 are optional in the Common Event Format, be present when events with
4200 that eventName are published.
4202 **Event Streaming**. The delivery of network management event
4203 information in real time.
4205 **Extensible Data Structures**. Data structures (e.g., hashMap) that
4206 allow event sources to send information not specifically identified in
4209 **Hash Map**. A hash table, or data structure, used to implement an
4210 associative array, a structure than can map keys to values. In VES 6.0,
4211 all name-value pair structures were changed to hash maps (i.e., {‘name’:
4212 ‘keyName’, ‘value’: ‘keyValue’} was replaced with {‘keyName’:
4215 **IPMI**. The `Intelligent Platform Management
4216 Interface <https://en.wikipedia.org/wiki/Intelligent_Platform_Management_Interface>`__.
4218 **JSON**. Java Script Object Notation. JSON is an
4219 `open-standard <https://en.wikipedia.org/wiki/Open_standard>`__ `file
4220 format <https://en.wikipedia.org/wiki/File_format>`__ that uses
4221 `human-readable <https://en.wikipedia.org/wiki/Human-readable_medium>`__
4222 text to transmit data objects consisting of `attribute–value
4223 pairs <https://en.wikipedia.org/wiki/Attribute%E2%80%93value_pair>`__
4224 and `array data types <https://en.wikipedia.org/wiki/Array_data_type>`__
4226 `serializable <https://en.wikipedia.org/wiki/Serialization>`__ value).
4227 It is a very common `data <https://en.wikipedia.org/wiki/Data>`__ format
4229 `asynchronous <https://en.wikipedia.org/wiki/Asynchronous_I/O>`__
4230 browser–server communication.
4232 **NF**. Network Function. Generalized name for a VNF or PNF.
4234 **NFC**. Network Function Component. Generalized name for a VNFC or a
4237 **ONAP**. `Open Network Automation Platform <https://www.onap.org/>`__.
4239 **PNF**. Physical Network Function.
4241 **Policy**. Course of action for the management of the network. The ONAP
4242 Policy Framework is a comprehensive policy design, deployment, and
4243 execution environment. The Policy Framework is the ***decision making***
4244 component in `an ONAP
4245 system <https://www.onap.org/wp-content/uploads/sites/20/2017/12/ONAP_CaseSolution_Architecture_120817_FNL.pdf>`__.
4246 It allows you to specify, deploy, and execute the governance of the
4247 features and functions in your ONAP system, be they closed loop,
4248 orchestration, or more traditional open loop use case implementations.
4249 The Policy Framework is the component that is the source of truth for
4250 all policy decisions.
4252 **Reporting Entity Name**. Name of the entity reporting the event or
4253 detecting a problem in another vnf/vm or pnf which is experiencing the
4254 problem. May be the same as the sourceName. Not used for performance
4255 measurements currently.
4257 **SDC**. Service Design and Creation Platform: The ONAP visual modeling
4258 and design tool. It creates internal metadata that describes assets used
4259 by all ONAP components, both at design time and run time. The SDC
4260 manages the content of a catalog, and assemblies of selected catalog to
4261 define how and when VNFs are realized in a target environment.
4263 **Source Name**: Name of the entity experiencing the event issue, which
4264 may be detected and reported by a separate reporting entity. The
4265 sourceName identifies the device for which data is collected. A valid
4266 sourceName must be inventoried in A&AI.
4268 **Specific Problem**. Description of the alarm or problem.
4270 **VES**. Virtual Function Event Stream. In 6.0, the definition of VES
4271 was expanded to include event streaming for VNF, PNF and infrastructure.
4272 The VES Event Listener can receive any event sent in the VES Common
4275 **VES Event Listener**. A RESTful connectionless push event listener
4276 capable of receiving single events or batches of events sent in the
4277 Common Event Format.
4279 **VM**. Virtual Machine.
4281 **VNF**. Virtual Network Function. A VNF is a virtualized task formerly
4282 carried out by proprietary, dedicated network hardware. (Examples:
4283 virtual firewall, virtual DNS). A VNF can also be defined as a specific
4284 kind of Vendor Software Product.
4286 **YAML**. A `data serialization
4287 language <https://en.wikipedia.org/wiki/Data_serialization_language>`__
4288 and superset of JSON.
4290 **VNFC**. Virtual Network Function Component. A VNFC is a part of a VNF.
4291 It is a stand-alone executable that is loosely-coupled, granular,
4292 re-usable, and responsible for a single capability.
4294 Appendix: Historical Change Log
4295 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4297 For the latest changes, see the Change Block just before the Table of
4300 +-----------+---------+-------------------------------------------------------+
4301 | Date | Revision| Description |
4302 +-----------+---------+-------------------------------------------------------+
4303 | 5/22/2015 | 0.1 | Initial Release - Draft |
4304 +-----------+---------+-------------------------------------------------------+
4305 | 5/29/2015 | 0.2 | - Introduction: removed all system names and |
4306 | | | references to internal AT&T components |
4308 | | | - Security: changed ‘event publisher’ to |
4309 | | | ‘event source’ |
4311 | | | - Generic Event Format: updated the JSON schema per |
4314 | | | - eventHeader: clarified the description of id, made |
4315 | | | sourceId a required field, changed the datatype of |
4316 | | | timestamps to timestamp [ ] |
4318 | | | - performanceFields: removed overflowFields |
4320 | | | - tmestamp: added a description of this datatype |
4322 | | | - Exceptions: fixed indentation of sections |
4324 | | | - Approvers: updated the list of approvers and added |
4326 +-----------+---------+-------------------------------------------------------+
4327 | 6/3/2015 | 0.3 | - Updated the security section to use HTTP Basic |
4328 | | | Authentication per AT&T REST standards. Updated the|
4329 | | | input parameters and messaging examples to use the |
4330 | | | new security scheme. |
4331 +-----------+---------+-------------------------------------------------------+
4332 | 6/5/2015 | 0.4 | - Added otherFields sub section to the defined |
4335 | | | - Added locale field to the eventHeader. |
4336 +-----------+---------+-------------------------------------------------------+
4337 | 6/5/2015 | 0.5 | - Updated the embedded event format json schema to |
4338 | | | match the changes made in v0.4 |
4339 +-----------+---------+-------------------------------------------------------+
4340 | 6/10/2015 | 0.6 | - Updated the {ServerRoot} format to contain an |
4341 | | | optional routing path (for D2 service modules). |
4342 +-----------+---------+-------------------------------------------------------+
4343 | 7/7/2015 | 0.7 | Common Event Format updates: |
4345 | | | - EventHeader: added ‘measurement’ to the ‘domain’ |
4346 | | | enumeration; changed ‘locale’ to ‘location’ and |
4347 | | | clarified in the description that this should be a |
4350 | | | - Added a MeasurementFields datatype, which required |
4351 | | | the addition of the following datatypes: |
4352 | | | codecsInUse, cpuUsage, diskUsage, featuresInUse, |
4354 +-----------+---------+-------------------------------------------------------+
4355 | 7/15/2015 | 1.0 | - Changed sourceInstance in the eventHeader to be an |
4356 | | | array of name value pairs |
4358 | | | - Changed the performanceFields block to |
4359 | | | thresholdCrossingAlertFields. Updated the domain |
4360 | | | field of the eventHeader to match. |
4361 +-----------+---------+-------------------------------------------------------+
4362 | 7/23/2015 | v1.1 | Changes to eventHeader data format: |
4364 | | | - moved sourceInstance to internalHeaderFields |
4366 | | | - moved serviceInstanceId to internalHeaderFields |
4368 | | | - moved productId to internalHeaderFields |
4370 | | | - moved subscriberId to internalHeaderFields |
4372 | | | - moved location to internalHeaderFields |
4374 | | | - added the following new fields in |
4375 | | | internalHeaderFields: policyType, policyName, |
4376 | | | correlationEventType, correlationType, |
4377 | | | correlationName, correlationRootEventId |
4379 | | | Changes to faultFields data format: |
4381 | | | - moved the eventSourceDeviceDescription to |
4382 | | | internalFaultFields and renamed it |
4383 | | | equipmentVendorModel |
4385 | | | - moved eventSourceHostname to internalFaultFields |
4387 | | | - changed alarmObjectInterface to alarmInterfaceA |
4389 | | | - changed alarmRemoteObject to alarmRemoteObjectZ and|
4390 | | | moved it to internalFaultFields |
4392 | | | - changed alarmRemoteObjectInterface to |
4393 | | | alarmInterfaceZ and moved it to internalFaultFields|
4395 | | | Changes to thresholdCrossingFields data format: |
4397 | | | - changed several references from the old |
4398 | | | ‘performanceFields’ block to the new |
4399 | | | ‘thresholdCrossingFields’ block |
4403 | | | - Fixed several comma and colon syntax errors in the |
4404 | | | JSON schema as detected by a JSON schema syntax |
4406 +-----------+---------+-------------------------------------------------------+
4407 | 8/11/2015 | v1.2 | Timestamp format: |
4409 | | | - Section 4.18: added a note in the datetime field of|
4410 | | | the Timestamp datatype specifying the (GMT) format |
4413 | | | - Updated the JSON schema with the same information |
4415 | | | Event Header Severity Enumeration: |
4417 | | | - Section 4.8: modified the severity enumeration to |
4418 | | | remove the numbers in parentheses that followed the|
4419 | | | names. The names were not changed. |
4421 | | | - Updated the JSON schema with the same information. |
4422 +-----------+---------+-------------------------------------------------------+
4423 | 8/20/2015 | v1.3 | JSON Schema rev’d to v9: |
4425 | | | - Alphabetized all fields in the JSON schema |
4427 | | | - Fixed the way arrays were specified (JSON schema |
4428 | | | syntax issue) |
4430 | | | Sample Responses: |
4432 | | | - 2.1.1.1: alphabetized fields, fixed timestamps |
4433 | | | array depiction, fixed severity enum value to |
4434 | | | conform to latest format |
4436 | | | - 6.2.6.1: alphabetized fields, fixed timestamps |
4437 | | | array depiction, fixed severity enum value to |
4438 | | | conform to latest format |
4440 | | | - 6.3.6.1: alphabetized fields, fixed timestamps |
4441 | | | array depiction, fixed severity enum value to |
4442 | | | conform to latest format |
4444 | | | - 6.4.6.1: alphabetized fields, fixed timestamps |
4445 | | | array depiction, fixed eventList array depection, |
4446 | | | fixed severity enum value to conform to latest |
4448 +-----------+---------+-------------------------------------------------------+
4449 | 9/16/2015 | v1.4 | JSON Schema rev’d to v10: |
4451 | | | - Fixed an error in the way that the top level |
4452 | | | "event" object was specified in the v9 json schema. |
4453 | | | This was discovered when validating examples |
4454 | | | against the schema using this site: |
4455 | | | http://json-schema-validator.herokuapp.com/index.jsp|
4457 | | | - Changed the embedded json file in section 4 |
4459 | | | Sample Responses: |
4461 | | | - Removed an extra comma after the timestamp brace in |
4462 | | | section 6.2.6 and 6.3.6. |
4463 +-----------+---------+-------------------------------------------------------+
4464 | 11/11/2015| v1.5 | Section 4 was the only section changed: JSON Schema |
4465 | | | rev’d to v11 and Datatype tables were updated to match|
4466 | | | . Numerous data structure changes were made based on |
4467 | | | VNF vendor proof of concept feedback. Modified sample |
4468 | | | requests and responses to match. |
4469 +-----------+---------+-------------------------------------------------------+
4470 | 11/12/2015| v1.6 | - The internalFaultFields were merged into the |
4471 | | | internalHeaderFields; then the internalFaultFields |
4472 | | | datatype was deleted. |
4474 | | | - Updated the JSON schema to v12. |
4476 | | | - Also corrected some background color issues in the |
4477 | | | sample requests and responses. |
4478 +-----------+---------+-------------------------------------------------------+
4479 | 1/18/2016 | v1.7 | - Section 2 changes: updated the sample request to |
4480 | | | conform with the changes below |
4482 | | | - Section 4 datatype changes: |
4484 | | | - Changed 'eventHeader' to 'commonEventHeader' |
4486 | | | - Moved 'eventSeverity' from the 'commonEventHeader' |
4487 | | | to 'faultFields' |
4489 | | | - Added 'priority' to 'commonEventHeader' |
4491 | | | - moved 'vFstatus' to 'faultFields' |
4493 | | | - removed 'firstDateTime' and 'lastDateTime' and |
4494 | | | changed 'firstEpoch' to 'startEpochMicrosec' and |
4495 | | | changed 'lastEpoch' to 'lastEpochMicrosec'. |
4497 | | | - Added 'functionalRole' to the commonEventHeader |
4499 | | | - In the commonEventHeader, changed the 'eventDomain'|
4500 | | | enumeration to remove 'measurements' and add |
4501 | | | 'measurementsForVfScaling'. |
4503 | | | - Changed the 'measurementFields' to |
4504 | | | 'measurementsForVfScalingFields' |
4506 | | | - In the commonEventHeader, changed the following |
4509 | | | - 'eventDomain' to 'domain' |
4511 | | | - 'eventSequence' to 'sequence' |
4513 | | | - 'eventSourceId' to 'sourceId' |
4515 | | | - 'eventSounceName' to 'sourceName' |
4517 | | | - Updated the JSON schema to v13 |
4519 | | | - Section 6 changes: updated the input parameters and|
4520 | | | sample requests to conform to the changes above. |
4522 | | | - Section 7: changed the section from Approvers to |
4523 | | | Contributors. |
4524 +-----------+---------+-------------------------------------------------------+
4525 | 1/22/2016 | v1.8 | - Section 4: Added support for ‘mobileFlow’ in the |
4526 | | | commonEventHeader ‘domain’ enumeration. Added the |
4527 | | | mobileFlowFields datatype and the gtpPerFlowMetrics|
4528 | | | datatype referenced by that datatype. |
4530 | | | - Section 7: alphabetized the contributors |
4531 +-----------+---------+-------------------------------------------------------+
4532 | 2/11/2016 | v1.9 | - Added section 1.3: Naming Standard for Event Types |
4533 +-----------+---------+-------------------------------------------------------+
4534 | 2/12/2016 | v2.0 | - Updated request – response examples to reflect the |
4535 | | | naming standards for event types introduced in v1.9|
4537 | | | - Added a paragraph on use of Avro as a transport in |
4539 +-----------+---------+-------------------------------------------------------+
4540 | 3/11/2016 | v2.1 | - Updated the embedded JSON schema to v15 to fix a |
4541 | | | typo in the required fields for the |
4542 | | | measurementsForVfScalingFields, namely, changed |
4543 | | | ‘configuredEntites’ to ‘configuredEntities’. |
4544 | | | Additionally, added an ‘Event Listener’ title block|
4545 | | | at the bottom of the file with a single required |
4546 | | | event object. |
4547 +-----------+---------+-------------------------------------------------------+
4548 | 3/15/2016 | v2.2 | - Added mobileFlowFields to the event datatype |
4549 | | | definition in section 4.7 and updated the embedded |
4550 | | | json schema at the top of section 4 to v16. |
4551 +-----------+---------+-------------------------------------------------------+
4552 | 4/26/2016 | v2.3 | - Generic Event Format updates: 1) made ‘priority’ |
4553 | | | lowercase in the Word doc table for |
4554 | | | commonEventHeader; 2) added ‘requestError’ data |
4555 | | | structure to the Word doc and JSON schema (which is|
4557 +-----------+---------+-------------------------------------------------------+
4558 | 4/27/2016 | v2.4 | - JSON Schema: In the 'event' data structure, changed|
4559 | | | 'thresholdCrossingFields' to |
4560 | | | 'thresholdCrossingAlertFields' to product v18 of |
4563 | | | - 'codecsInUse' data structure: changed 'numberInUse'|
4564 | | | to 'codecUtilization’ |
4565 +-----------+---------+-------------------------------------------------------+
4566 | 5/26/2016 | v2.5 | - Changed responses from ‘204 No Content’ to ‘202 |
4567 | | | Accepted’ and added a body to the response that |
4568 | | | enable AT&T to throttle the events being sent |
4569 | | | and/or to request the current state of throttling |
4570 | | | at the event source. |
4572 | | | - Added new datatypes to support the above: |
4573 | | | eventDomainThrottleSpecification, |
4574 | | | eventDomainThrottleSpecificationList, |
4575 | | | eventThrottlingState, suppressedNvPairs |
4577 | | | - Modifed the commonEventFormat json schema to v19 |
4579 | | | - Note: for the VendorEventListener: added new |
4580 | | | licensing language on the back of the title page; |
4581 | | | added an "attCopyrightNotice" definition at the top|
4582 | | | of the commonEventFormat\_Vendors.json file; also |
4583 | | | removed all references to internalHeaderFields from|
4584 | | | this file and from the VendorEventListener spec. |
4585 +-----------+---------+-------------------------------------------------------+
4586 | 8/9/2016 | v2.6 | - commonHeader: added a note on the description of |
4587 | | | sourceId and sourceName in the commonHeader: "use |
4588 | | | reportingEntity for domains that provide more |
4589 | | | detailed source info" |
4591 | | | - commonHeader: deleted the capacity, |
4592 | | | measurementsForVfScaling and usage domains in the |
4593 | | | domain enumeration |
4595 | | | - commonHeader: added the following domains to the |
4596 | | | domain enumeration: licensingKci, scalingKpi, |
4599 | | | - event: removed references to capacityFields, |
4600 | | | measurementsForVfScalingFields and usageFields and |
4601 | | | added references to licensingKciFields, |
4602 | | | scalingKpiFields, stateChangeFields |
4604 | | | - licensingKciFields: added this section along with |
4605 | | | 'additionalMeasurements', which is an optional list|
4606 | | | of measurementGroup structures. Changed the name of|
4607 | | | kciFieldsVersion to licensingKciFieldsVersion. |
4609 | | | - scalingKpiFields: added this section but changed |
4610 | | | measurementFieldsVersion to scalingKpiFieldsVersion|
4612 | | | - stateChangeFields: added this section along with |
4613 | | | 'additionalFields', which is an optional list of |
4614 | | | name-value pairs. Other fields included newState |
4615 | | | and oldState which were enumerations of the |
4616 | | | following possible states: 'inService', |
4617 | | | 'maintenance', 'outOfService' |
4619 | | | - sysLogFields: added 'additionalFields', which is an|
4620 | | | optional list of name-value pairs |
4622 | | | - vNicUsage: added two required fields to the |
4623 | | | vNicUsage data structure: packetsIn and packetsOut |
4624 +-----------+---------+-------------------------------------------------------+
4625 | 8/10/2016 | v2.7 | - commonHeader: removed the note on the description |
4626 | | | of sourceId and sourceName in the commonHeader: |
4627 | | | "use reportingEntity for domains that provide more |
4628 | | | detailed source info" |
4630 | | | - commonHeader: added measurementsForVfScaling domain|
4631 | | | back and removed the licensingKci and scalingKpi |
4634 | | | - event: removed references to licensingKciFields and|
4635 | | | scalingKpiFields; added references to |
4636 | | | measurementsForVfScalingFields |
4638 | | | - measurementsForVfScalingFields: combined the |
4639 | | | kciDetail and kpiDetail structures into the |
4640 | | | measurementsForVfScalingFields structure; |
4641 | | | referenced the errors structure |
4643 | | | - errors: added a new structure to capture the |
4644 | | | receive and transmit errors for the measurements |
4647 | | | - removed the following structures: kci, kpi, |
4648 | | | scalingKpiFields and licensingKciFields |
4650 | | | - eventDomainThrottleSpecification: updated the |
4651 | | | reference to commonEventHeader domain field |
4653 | | | - faultFields: removed the numbers from the |
4654 | | | enumerated strings for eventSourceType |
4656 | | | - vNicUsage: made the broadcast, multicast and |
4657 | | | unicast fields optional |
4659 | | | - contributors: updated Alok’s organizational area |
4660 +-----------+---------+-------------------------------------------------------+
4661 | 8/12/2016 | v2.8 | - commonHeader: copied the descriptions of sourceId |
4662 | | | and sourceName from the JSON schema into the word |
4663 | | | document tables. |
4665 | | | - sample request examples: moved the |
4666 | | | reportingEntityId and reportingEntityNames to the |
4667 | | | same relative place in all sample requests in the |
4670 | | | - Fixed the sample request shown for |
4671 | | | publishEventBatch to take an eventList as input. |
4673 | | | - Fixed the sample request shown for |
4674 | | | publishSpecificTopic to put the topic in the URL |
4676 | | | - errors: changed the receiveErrors and |
4677 | | | transmitErrors fields to be datatype number |
4679 | | | - codesInUse: changed 'codecUtilization' to |
4680 | | | 'numberinUse' |
4682 | | | - vNicUsage: updated the description of the fields |
4683 +-----------+---------+-------------------------------------------------------+
4684 | 8/27/2016 | v2.9 | - Added a note "(currently: 1.1)" in the descriptions|
4685 | | | of the following fields: commonEventHeader:version,|
4686 | | | faultFields:faultFieldsVersion, |
4687 | | | measurementsForVfScalingFields:measurementsForVf\ |
4688 | | | ScalingFieldsVersion, stateChangeFields:state\ |
4689 | | | ChangeFieldsVersion, sysLogFields:syslogFields\ |
4690 | | | Version, thresholdCrossingAlertFields:threshold\ |
4691 | | | CrossingFieldsVersion |
4693 | | | - stateChangeFields: made stateInterface mandatory |
4695 | | | - changed 'enum' to 'enumeration' throughout section |
4696 | | | 4 of the document (note: this can't be done in the |
4697 | | | JSON schema). |
4699 | | | - measurementsForVfScalingFields: made the following |
4700 | | | fields optional: conurrentSessions, configured\ |
4701 | | | Entitites, cpuUsageArray, fileSystemUsageArray, |
4702 | | | memoryConfigured, memoryUsed, requestRate, |
4703 | | | vNicUsageArray |
4705 | | | - measurementsForVfScalingFields: concurrentSessions |
4706 | | | and configuredEntities: changed the description to |
4707 | | | support both VMs and VNFs |
4709 | | | - measurementsFor VfScalingFields: clarified the |
4710 | | | descriptions of latencyDistribution, measurement\ |
4711 | | | Inverval and requestRate |
4713 | | | - syslogFields: clarified the descriptions of |
4714 | | | syslogSData, syslogTag, syslogVer |
4716 | | | - thresholdCrossingAlertFields: made the following |
4717 | | | fields optional and clarified their descriptions: |
4718 | | | elementType, networkService |
4720 | | | - command and commandList: created a list of command |
4721 | | | structures to enable the event collector to request|
4722 | | | changes of event sources. Commands consist of a |
4723 | | | commandType along with optional fields (whose |
4724 | | | presence is indicated by the commandType). Three |
4725 | | | command types are currently supported: |
4726 | | | 'measurementIntevalChange', |
4727 | | | ‘provideThrottlingState’ and |
4728 | | | 'throttlingSpecification'. |
4730 | | | - eventDomainThrottleSpecificationList: removed this |
4731 | | | and replaced it with commandList. |
4733 | | | - Operations and Sample Requests: modified the |
4734 | | | operations and samples to support the new command |
4735 | | | and commandList structures. |
4736 +-----------+---------+-------------------------------------------------------+
4737 | 9/1/2016 | v2.10 | - measurementsForVfScaling block: made the following |
4738 | | | fields optional: latencyDistribution (which is an |
4739 | | | array of latencyBucketMeasure structures) and |
4740 | | | meanRequestLatency. Updated the JSON schemas (now |
4741 | | | v24) to match. |
4742 +-----------+---------+-------------------------------------------------------+
4743 | 9/16/2016 | v2.11 | - 1 Introduction: updated the introduction to clarify|
4744 | | | the usage of eventTypes and the possibility of |
4745 | | | support for other protocols. |
4747 | | | - 6.1 REST Operation Overview: added two new |
4748 | | | subsections (6.1.2 and 6.1.3) discussing Api |
4749 | | | Version and Commands Toward Event Source Clients. |
4751 | | | - 6.2 publishAnyEvent: fixed the sample to conform to|
4752 | | | the latest changes |
4754 | | | - 6.3 publishSpecificTopic: fixed the sample to |
4755 | | | conform to the latest changes |
4757 | | | - 6.4 publishEventBatch: fixed the sample to conform |
4758 | | | to the latest changes |
4760 | | | - 6.5 provideThrottlingState operation: added the |
4761 | | | Input Parameters section heading back and fixed the|
4762 | | | sample request to provide eventThrottlingState |
4763 | | | (instead of eventThrottlingClientState). |
4765 | | | - The remaining bullets describe changes made to |
4766 | | | section 4 datatypes in alphabetical order: |
4768 | | | - command datatype: referenced the new section 6.1.3 |
4769 | | | which provides an explanation of command state |
4770 | | | expectations and requirements for a given |
4771 | | | eventSource: |
4773 | | | - commonEventHeader datatype: |
4775 | | | - made sourceId and reportingEntityId fields |
4776 | | | optional (although the internal Generic Event |
4777 | | | Listener spec indicates, in the field |
4778 | | | descriptions, that the AT&T enrichment process |
4779 | | | shall ensure that these fields are populated) |
4781 | | | - domain enumeration: changed measurementsForVf\ |
4782 | | | ScalingFields to measurementsForVfScaling |
4784 | | | - eventDomainThrottleSpecificationList: added this |
4785 | | | array of eventDomainThrottleSpecification stuctures|
4786 | | | back to the schema because it is used by the |
4787 | | | provideThrottlingState operation. |
4789 | | | - eventList: added eventList back to the vendor |
4790 | | | version of the commonEventFormat. This is used by |
4791 | | | the publishEventBatch operation. |
4793 | | | - faultFields datatype: |
4795 | | | - eventSourceType: made this a string (and |
4796 | | | provided the previous enumerated values as |
4799 | | | - filesystemUsage datatype: |
4801 | | | - changed vmIdentifier to filesystemName |
4803 | | | - gtpPerFlowMetrics datatype: |
4805 | | | - flowActivationTime: changed the format and |
4806 | | | description to be compliant with RFC 2822. |
4808 | | | - flowDeactivationTime: changed the format and |
4809 | | | description to be compliant with RFC 2822. |
4811 | | | - internalHeaderFields datatype: |
4813 | | | - Added the following optional fields: firstDate\ |
4814 | | | Time, lastDateTime compliant with RFC 2822. |
4815 | | | Noted in the description that these fields must |
4816 | | | be supplied for events in the following domains:|
4817 | | | fault, thresholdCrossingAlerts and |
4818 | | | measurementsForVfScaling. |
4820 | | | - ticketingTimestamp: changed the format and |
4821 | | | description to be compliant with RFC 2822. |
4823 | | | - syslogFields datatype: |
4825 | | | - eventSourceType: made this a string (and |
4826 | | | provided the previous enumerated values, without|
4827 | | | the numbers, as examples) |
4829 | | | - thresholdCrossingAlerts dataypte: |
4831 | | | - collectionTimestamp: changed the format and |
4832 | | | description to be compliant with RFC 2822. |
4834 | | | - eventStartTimestamp: changed the format and |
4835 | | | description to be compliant with RFC 2822. |
4837 | | | - added the same eventSeverity field as from the |
4838 | | | faultFields and made it required |
4839 +-----------+---------+-------------------------------------------------------+
4840 | 9/23/2016 | v2.12 | - Section 4 Datatypes: commonEventHeader: made |
4841 | | | reportingEntityName a required field (note: the |
4842 | | | JSON schema already had this field as required) |
4843 +-----------+---------+-------------------------------------------------------+
4844 | 11/29/2016| v3.0 | - Introduction: |
4846 | | | - Introductory paragraph: changed '...Common Event|
4847 | | | Header Block followed by zero or more event |
4848 | | | domain blocks' to '...Common Event Header Block |
4849 | | | accompanied by zero or more event domain blocks'|
4850 | | | since the order of the blocks on the wire is |
4851 | | | not guaranteed. |
4853 | | | - Added Section 1.5 Versioning |
4855 | | | - Section 4: codec processing: |
4857 | | | - CommonEventFormat\_Vendors schema only: |
4858 | | | codesInUse: changed required field from |
4859 | | | "codecUtilization" which was removed previously |
4860 | | | to "numberInUse" which is the new field name. |
4862 | | | - added ‘codecSelected’ datatype |
4864 | | | - added ‘codecSelectedTranscoding’ datatype |
4866 | | | - Section 4 and section 6: command processing: |
4868 | | | - Added commandListEntry which is an object that |
4869 | | | references the command object. |
4871 | | | - commandList: changed commandList to contain an |
4872 | | | array of commandListEntry objects. |
4874 | | | - Updated sample responses in section 6 where |
4875 | | | commands are used |
4877 | | | - Section 4: commonEventHeader: |
4879 | | | - Incremented version to 1.2 |
4881 | | | - added two new values to the ‘domain’ |
4882 | | | enumeration: ‘serviceEvents’ and ‘signaling |
4884 | | | - Section 4: added endOfCallVqmSummaries datatype |
4886 | | | - Section 4: ‘event’: added two fields: |
4887 | | | ‘serviceEventsFields’ and ‘signalingFields’ |
4889 | | | - Section 4: added ‘eventInstanceIdentifier’datatype |
4891 | | | - Section 4: CommonEventListener only: |
4892 | | | internalHeaderFields: |
4894 | | | - added ‘internalHeaderFieldsVersion’(initially |
4897 | | | - added ‘correlationFirstEpoch’ |
4899 | | | - added 'closedLoopControlName' |
4901 | | | - added 'closedLoopFlag' |
4903 | | | - added 'collectorTimeStamp' |
4905 | | | - added 'eventTag' |
4907 | | | - added ‘tenantName’ |
4909 | | | - changed 'operationalStatus' to 'inMaint' |
4911 | | | - added required fields in the schema to match the|
4912 | | | word doc: 'equipmentNameCode', 'equipmentType', |
4913 | | | 'equipmentVendor', 'inMaint', 'provStatus' |
4915 | | | - Section 4: added ‘marker’datatype |
4917 | | | - Section 4: added ‘midCallRtcp’ datatype |
4919 | | | - Section 4: mobileFlowFields: |
4921 | | | - added ‘mobileFlowFieldsVersion’(initially set to|
4924 | | | - Section 4: added ‘serviceEventsFields’datatype |
4926 | | | - Section 4: added ‘signalingFields’ datatype |
4928 | | | - Section 4: syslogFields: |
4930 | | | - Incremented syslogFieldsVersion to 1.2 |
4932 | | | - added 'syslogPri' |
4934 | | | - added 'syslogSev' |
4936 | | | - added ‘syslogSdId’ |
4938 | | | - Section 4: thresholdCrossingAlertFields: |
4940 | | | - Incremented thresholdCrossingFieldsVersion to |
4943 | | | - added 'additionalFields' which is an optional |
4944 | | | list of name value pairs. |
4946 | | | - Section 4: schema v26.0 embedded reflecting the |
4947 | | | above changes. |
4949 | | | - Section 6 and Section 2: changed all sample |
4950 | | | requests to use /v3 in the REST Resource URL. |
4951 +-----------+---------+-------------------------------------------------------+
4952 | 12/1/2016 | v3.1 | - Section 6: Updated the call flow diagrams to show |
4954 +-----------+---------+-------------------------------------------------------+
4955 | 1/5/2017 | v4.0 | - Combined the Generic Event Listener and Vendor |
4956 | | | Event Listener into a single API service |
4957 | | | specification with version 4.0. |
4959 | | | - Changed the title to VES (Virtual Function Event |
4960 | | | Streaming) Listener. |
4962 | | | - Changed references to 'generic event' to 'common |
4963 | | | event' or 'VES event' (depending on the context) |
4964 | | | throughout the document. |
4966 | | | - Used the Legal Disclaimer from the Vendor Event |
4967 | | | Listener on the back of the title page. |
4969 | | | - Section 1: Introduction changes: |
4971 | | | - modified wording to reference 'VES' |
4973 | | | - removed the 'Audience' section, which described |
4974 | | | various AT&T groups the documented was intended |
4977 | | | - tweaked the naming standards for event types to |
4978 | | | clarify the purpose of the naming conventions |
4980 | | | - Section 3: Resource Structure: added a sentence |
4981 | | | describing the FQDN and port used in the resource |
4984 | | | - Section 4: Common Event Format changes: |
4986 | | | - renamed the section to 'Common Event Format' |
4987 | | | from 'Generic Event Format' |
4989 | | | - reorganized the datatypes into separate sections|
4990 | | | ; sections were defined for each of the domains |
4991 | | | as well as for common event, common event header|
4992 | | | and command list processing |
4994 | | | - codecSelected datatype: removed this datatype |
4996 | | | - codecSelectedTranscoding datatype: removed this |
4999 | | | - command datatype: added an enumerated value to |
5000 | | | commandType: 'heartbeatIntervalChange' |
5002 | | | - commonEventHeader: added internalHeaderFields to|
5003 | | | the commonEventHeader, defined as "Fields (not |
5004 | | | supplied by event sources) that the VES Event |
5005 | | | Listener service can use to enrich the event if |
5006 | | | needed for efficient internal processing. This |
5007 | | | is an empty object which is intended to be |
5008 | | | defined separately by each provider implementing|
5009 | | | the VES Event Listener." |
5011 | | | - commonEventHeader: removed two enumerated values|
5012 | | | , 'serviceEvents' and 'signaling' from the |
5013 | | | domain enumeration |
5015 | | | - commonEventHeader version: incremented the |
5016 | | | version to 2.0 |
5018 | | | - endOfCallVqmSummaries datatype: removed this |
5021 | | | - event: changed the description of the event |
5022 | | | datatype to: "fields which constitute the ‘root |
5023 | | | level’ of the common event format" |
5025 | | | - event: removed 'serviceEventFields' and |
5026 | | | 'signalingFields' from the definition |
5028 | | | - event: fixed a misspelling of |
5029 | | | ‘thresholdCrossingAlertFields’, which was only |
5030 | | | present in the Word document |
5032 | | | - eventInstanceIdentifier datatype: removed this |
5035 | | | - internalHeaderFIelds datatype: defined this as |
5036 | | | follows: "The internalHeaderFields datatype is |
5037 | | | an undefined object which can contain |
5038 | | | arbitrarily complex JSON structures. It is |
5039 | | | intended to be defined separately by each |
5040 | | | provider implementing the VES Event Listener. |
5041 | | | The fields in internalHeaderFields are not |
5042 | | | provided by any event source but instead are |
5043 | | | added by the VES Event Listener service itself |
5044 | | | as part of an event enrichment process necessary|
5045 | | | for efficient internal processing of events |
5046 | | | received by the VES Event Listener" |
5048 | | | - marker datatype: removed this datatype |
5050 | | | - measurementsForVfScalingFields datatype: |
5051 | | | clarified that memoryConfigured and memoryUsed |
5052 | | | are measured in MB |
5054 | | | - midCallRtcp datatype: removed this datatype |
5056 | | | - mobileFlowFields datatype: added |
5057 | | | ‘additionalFields’ |
5059 | | | - mobileFlowFields datatype: incremented the |
5060 | | | version number for this field block to 1.2 |
5062 | | | - serviceEventsFields datatype: removed this |
5065 | | | - signalingFields datatype: removed this datatype |
5067 | | | - syslogFields: added three fields to the schema |
5068 | | | that were previously described in the document |
5069 | | | but not incorporated into the schema: syslogPri,|
5070 | | | syslogSev, syslogSdId |
5072 | | | - syslogFields version: incremented the version to|
5075 | | | - Modified the Common Event Format JSON schema to |
5076 | | | v27.0 to incorporate the above changes. Also, added|
5077 | | | the AT&T Copyright Notice from the top of the |
5078 | | | retired CommonEventFormat\_Vendors schema. |
5080 | | | - Section 6 and 2: changed all sample requests to use|
5081 | | | /v4 in the REST Resource URL and call flow diagrams|
5083 | | | - Section 6.1.3: added a row to the table in this |
5084 | | | section describing the ‘heartbeatIntervalChange’ |
5087 | | | - Section 6.1.4: added this new section describing |
5088 | | | expectations for buffering of events should all |
5089 | | | REST resource URL FQDNs be unreachable. |
5091 | | | - Section 6 Sample Requests: modified all sample |
5092 | | | requests showing the return of a commandList toward|
5093 | | | the event source to incorporate a |
5094 | | | heartbeatIntervalChange command; also corrected the|
5095 | | | spelling in the samples for the |
5096 | | | measurementIntervalChange command. |
5098 | | | - Section 7: Contributors: removed this section |
5099 +-----------+---------+-------------------------------------------------------+
5100 | 3/21/2017 | v4.1 | - JSON Schema changes to produce v27.2 (note: an |
5101 | | | earlier draft version of v27.1 had been distributed|
5102 | | | to a few individuals): |
5104 | | | - To support use of the schema with event batches,|
5105 | | | removed the following statement near the end of |
5106 | | | the schema file: |
5108 | | | "required": [ "event" ] |
5110 | | | - Fixed the characters used in some of the quotes |
5112 | | | - Fixed some typos in the descriptions. |
5114 | | | - Removed the booleans, which were non-essential and |
5115 | | | which were causing problems across different |
5116 | | | implementations. |
5118 | | | - Section 4.5.7 measurementsForVfScalingFields: |
5120 | | | - Fixed the spelling of measurementsForVf\ |
5121 | | | ScalingFields in the Word document |
5123 | | | - Section 2 and 6 sample requests and responses: |
5125 | | | - Removed quotes from numbers: sequence, and |
5126 | | | first/lastEpochMicrosec. |
5128 | | | - Fixed all quote characters, some of which were |
5129 | | | using unusual symbols that wouldn’t validate |
5130 | | | with the json-schema Python package. |
5132 | | | - Section 6.2.6.1, 6.3.6.1, 6.4.6.1 sample requests: |
5134 | | | - Added an alarmAdditionalInformation field array |
5135 | | | to the sample requests. |
5137 | | | - Added missing commas. |
5139 | | | - Section 6.5.6.1 provideThrottlingState sample |
5142 | | | - Fixed the eventDomainThrottleSpecificationList |
5143 | | | to pass an array of anonymous eventDomain\ |
5144 | | | ThrottleSpecification objects. |
5146 | | | - Added missing quotes. |
5148 | | | - Fixed the suppressedNvPairsList to pass an array of|
5149 | | | anonymous suppressedNvPairs objects. |
5150 +-----------+---------+-------------------------------------------------------+
5151 | 4/14/2017 | v5.0 | - Section 1 Introduction: |
5153 | | | - Clarified the Introduction (Section 1). |
5155 | | | - Changed Section 1.1 title from ‘Terminology’ to |
5156 | | | 'Event Registration' and referenced the YAML |
5157 | | | event registration format, defined in a separate|
5160 | | | - Clarified naming standards for eventName. |
5162 | | | - Section 3: updated the REST resource structure |
5164 | | | - Section 4.1 command list processing datatypes: |
5166 | | | - Got rid of commandListEntry and returned |
5167 | | | commandList to a simple array of commands. |
5169 | | | - Added heartbeatInterval to the command datatype.|
5171 | | | - Changed the datatype of measurementInterval from|
5172 | | | number to integer. |
5174 | | | - Section 4.2 common event datatypes: |
5176 | | | - event dataType: Added heartbeatFields, |
5177 | | | sipSignalingFields and voiceQualityFields to the|
5178 | | | event datatype as optional field blocks |
5180 | | | - Added jsonObject which provides a json object |
5181 | | | schema, name and other meta-information along |
5182 | | | with one or more object instances. |
5184 | | | - Added jsonObjectInstance which provides |
5185 | | | meta-information about an instance of a |
5186 | | | jsonObject along with the actual object instance|
5188 | | | - Added the ‘key’ datatype |
5190 | | | - Added the namedArrayOfFields datatype |
5192 | | | - Added vendorVnfNameFields |
5194 | | | - Section 4.3 common event header fields: |
5196 | | | - Add two new enumerations to domain: |
5197 | | | ‘sipSignaling’ and ‘voiceQuality’ |
5199 | | | - Renamed eventType to eventName. Note that the |
5200 | | | original usage of eventType was formally |
5201 | | | described in the Introduction back on 2/11/2016 |
5204 | | | - Made eventName a required field |
5206 | | | - Created a new field called eventType with a |
5207 | | | meaning that is different than the old eventType|
5209 | | | - Removed functionalRole, which was replaced by |
5210 | | | the following two fields. |
5212 | | | - Added nfNamingCode |
5214 | | | - Added nfcNamingCode |
5216 | | | - Changed version to 3.0 (major version change) |
5217 | | | and made it a required field |
5219 | | | - Section 4.4: faultFields: |
5221 | | | - added one optional field: eventCategory |
5223 | | | - made faultFieldsVersion a required field |
5225 | | | - changed faultFieldsVersion to 2.0 (major version|
5228 | | | - fixed a typo on the spelling of alarmInterfaceA |
5230 | | | - clarified field descriptions |
5232 | | | - Section 4.5: added heartbeatFields datatype which |
5233 | | | can be used to communicate heartbeatInterval. Note:|
5234 | | | this change was previously made in v4.2 |
5236 | | | - Section 4.6 measurements for vf scaling datatypes: |
5237 | | | changed the following datatypes from number to |
5240 | | | - In measurementsForVfScalingFields: |
5241 | | | concurrentSessions, configuredEntities, |
5242 | | | numberOfMediaPortsInUse, vnfcScalingMetric |
5244 | | | - In codecsInUse: numberInUse |
5246 | | | - In featuresInUse: featureUtilization |
5248 | | | - Section 4.6.2 modified cpuUsage |
5250 | | | - Section 4.6.3 added diskUsage |
5252 | | | - Section 4.6.7 measurementsForVfScalingFields: |
5254 | | | - fixed the spelling of the measurementsForVf\ |
5255 | | | ScalingFields in the Word document |
5257 | | | - added additionalFields, which is an array of |
5258 | | | fields (i.e., name-value pairs) |
5260 | | | - changed additionalMeasurements to reference the |
5261 | | | common datatype namedArrayOfFields (instead of |
5262 | | | referencing measurementGroup) |
5264 | | | - added additionalObjects which is an array of |
5265 | | | jsonObjects described by name, keys and schema |
5267 | | | - deleted aggregateCpuUsage |
5269 | | | - added diskUsageArray |
5271 | | | - deleted measurementGroup (which was replaced by |
5272 | | | the common datatype: namedArrayOfFields |
5274 | | | - added memoryUsageArray |
5276 | | | - deleted memoryConfigured and memoryUsed |
5278 | | | - deleted errors and vNicUsageArray |
5280 | | | - added vNicPerformanceArray |
5282 | | | - changed the measurementsForVfScalingVersion to |
5283 | | | 2.0 (major version change) and made it a |
5284 | | | required field. Also changed the name of this |
5285 | | | version field in the Word document to match that|
5286 | | | in the JSON schema. |
5288 | | | - Section 4.6.8 added memoryUsage |
5290 | | | - Section 4.6.9 vNicPerformance: replaced vNicUsage |
5291 | | | and errors with vNicPerformance |
5293 | | | - Section 4.7 mobile flow fields changes: |
5295 | | | - Made mobileFlowFieldsVersion a required field |
5296 | | | and changed the mobileFlowFieldsVersion to 2.0 |
5297 | | | (major version change). |
5299 | | | - Changed the datatype of flowActivationTime and |
5300 | | | flowDeactivationTime in the Word doc to string. |
5302 | | | - changed the following datatypes from number to |
5303 | | | integer: otherEndpointPort, |
5304 | | | reportingEndpointPort, samplingAlgorithm |
5306 | | | - Section 4.8: otherFields: |
5308 | | | - Added otherFieldsVersion (set at 1.1) |
5310 | | | - Added hashOfNameValuePairArrays |
5312 | | | - Added jsonObjects |
5314 | | | - Added nameValuePairs |
5316 | | | - Section 4.9: added sipSignaling domain datatypes |
5317 | | | with 4.8.1 sipSignalingFields. sipSignalingFields\ |
5318 | | | Version is set at 1.0 |
5320 | | | - Section 4.10 stateChangeFields: made stateChange\ |
5321 | | | FieldsVersion a required field and set it to 2.0 |
5322 | | | (major version change). |
5324 | | | - Section 4.11 syslogFields: |
5326 | | | - Changed the following datatypes from number to |
5327 | | | integer: syslogFacility, syslogPri |
5329 | | | - Changed additionalFields from a field [ ] to a |
5330 | | | string which takes name=value pairs delimited by|
5331 | | | a pipe symbol. |
5333 | | | - Changed syslogFieldsVersion to 3.0 (major |
5334 | | | version change) and made it a required field |
5336 | | | - Made syslogSev an enumerated string (previously |
5337 | | | just a string) |
5339 | | | - Section 4.12 thresholdCrossingAlertFields: made |
5340 | | | thresholdCrossingFieldsVersion a required field and|
5341 | | | set it to 2.0 (major version change). |
5343 | | | - Section 4.132: added voice quality domain datatypes|
5344 | | | with 4.13.1 endOfCallVqmSummaries and 4.13.2 |
5345 | | | voiceQualityFields. voiceQualityFieldsVersion is |
5348 | | | - JSON Schema: changed the schema to v28.0 and |
5349 | | | incorporated all of the changes above. |
5351 | | | - Additional JSON Schema changes that are part of |
5352 | | | v28: Note: The following changes are provided |
5353 | | | relative to API Spec v4.0 (which embedded JSON |
5354 | | | schema v27.0), but they were also made in an |
5355 | | | interim release v4.1 (which embedded JSON schema |
5358 | | | - To support use of the schema with event batches,|
5359 | | | removed the following statement near the end of |
5360 | | | the schema file: |
5362 | | | "required": [ "event" ] |
5364 | | | - Fixed the characters used in some of the quotes |
5366 | | | - Fixed some typos in the descriptions. |
5368 | | | - Removed the booleans, which were non-essential and |
5369 | | | which were causing problems across different |
5370 | | | implementations. |
5372 | | | - Section 2 and 6 sample requests and responses (also|
5373 | | | incorporated in interim release 4.1): |
5375 | | | - Removed quotes from numbers: sequence, and |
5376 | | | first/lastEpochMicrosec. |
5378 | | | - Fixed all quote characters, some of which were |
5379 | | | using unusual symbols that wouldn’t validate |
5380 | | | with the json-schema Python package. |
5382 | | | - Section 2 and 6 sample requests and responses (only|
5385 | | | - Changed the version numbers in the URL string. |
5387 | | | - Added nfNamingCode and nfcNamingCode and removed|
5388 | | | functionalRole |
5390 | | | - Section 6 call flows: updated the version number |
5391 | | | (only in v5.0). |
5393 | | | - Section 6: removed the publishSpecificTopic |
5396 | | | - Section 6.1.4: Buffering: clarified event source |
5397 | | | expectations for buffering (only in v5.0). |
5399 | | | - Section 6.2.6.1, 6.3.6.1 sample requests (also |
5400 | | | incorporated in interim release 4.1): |
5402 | | | - Added an alarmAdditionalInformation field array |
5403 | | | to the sample requests. |
5405 | | | - Added missing commas. |
5407 | | | - Section 6.2.6.3, 6.3.6.3 commandList sample |
5408 | | | responses (only in v5.0): |
5410 | | | - Fixed the commandList sample responses to pass |
5411 | | | an array of anonymous command objects (rather |
5412 | | | than an array of commandListEntry objects). |
5414 | | | - Fixed the heartbeatIntervalChange commandType to|
5415 | | | pass a heartbeatInterval value instead of a |
5416 | | | measurementInterval value. |
5418 | | | - Removed quotes from the measurementInterval and |
5419 | | | heartbeatInterval values since they are numbers.|
5421 | | | - Section 6.4.6.1 provideThrottlingState sample |
5422 | | | requests(also incorporated in interim release 4.1):|
5424 | | | - Fixed the eventDomainThrottleSpecificationList |
5425 | | | to pass an array of anonymous |
5426 | | | eventDomainThrottleSpecification objects. |
5428 | | | - Added missing quotes. |
5430 | | | - Fixed the suppressedNvPairsList to pass an array|
5431 | | | of anonymous suppressedNvPairs objects (also |
5432 | | | incorporated in interim release 4.1). |
5433 +-----------+---------+-------------------------------------------------------+
5434 | 5/22/2017 | v5.1 | - Footers: removed proprietary markings and updated |
5435 | | | copyrights to 2017 |
5437 | | | - Section 4.2.3: field: |
5439 | | | - Changed the API spec to make ‘name’ and ‘value’ |
5440 | | | start with lowercase letters. Note: this did not|
5441 | | | affect the schema, which already had them as |
5444 | | | - JSON Schema: |
5446 | | | - measurementGroup: deleted this object since it |
5447 | | | was replaced with ‘namedArrayOfFields’ in v28.0 |
5448 | | | and was no longer being used. |
5450 | | | - namedArrayOfFields: Fixed an error in the |
5451 | | | specification of required fields: from |
5452 | | | ‘measurements’ to ‘arrayOfFields’. |
5454 | | | - Changed the version of the JSON schema to 28.1 |
5455 +-----------+---------+-------------------------------------------------------+
5456 | 6/14/2017 | v5.2 | - JSON Schema: created v28.2 by changing the field |
5457 | | | descriptions in the memoryUsage object to refer to |
5458 | | | ‘kibibytes’ instead of ‘kilobytes’. There were no |
5459 | | | changes to the 28.1 structure. |
5461 | | | - Word Document: measurementsForVfScaling Domain: |
5462 | | | memoryUsage object: changed the field descriptions |
5463 | | | in this object to refer to ‘kibibytes’ instead of |
5464 | | | ‘kilobytes’. There were no changes to the |
5465 | | | memoryUsage structure. |
5467 | | | - Reorganized the Word document to group the data |
5468 | | | structures in Section 4 into three broad categories|
5469 | | | to better align with the VNF Guidelines |
5470 | | | documentation that has been prepared for vendors: |
5472 | | | - Common Event Datatypes: |
5474 | | | - Command List Processing Datatypes |
5476 | | | - Common Event Datatypes |
5478 | | | - Common Event Header Datatypes |
5480 | | | - Technology Independent Datatypes: |
5482 | | | - ‘Fault Domain Datatypes |
5484 | | | - ‘Heartbeat’ Domain Datatypes |
5486 | | | - ‘Measurements For Vf Scaling’ Domain Datatypes|
5488 | | | - ‘Other’ Domain Datatypes |
5490 | | | - ‘State Change’ Domain Datatypes |
5492 | | | - ‘Syslog’ Domain Datatypes |
5494 | | | - ‘Threshold Crossing Alert’ Domain Datatypes |
5496 | | | - Technology Specify Datatypes: |
5498 | | | - ‘Mobile Flow’ Domain Datatypes |
5500 | | | - ‘Sip Signaling’ Domain Datatypes |
5502 | | | - ‘Voice Quality’ Domain Datatypes |
5504 | | | - Section 6.1.3: Commands Toward Event Source |
5505 | | | Clients: Added a statement: "Note: Vendors are not |
5506 | | | currently required to implement support for command|
5507 | | | processing; in addition, command processing may be |
5508 | | | supported by an App-C interface in future." |
5509 +-----------+---------+-------------------------------------------------------+
5510 | 6/22/2017 | v5.3 | - JSON Schema: created v28.3 by correcting an error |
5511 | | | in the sipSignalingFields: changed |
5512 | | | vnfVendorNameFields to vendorVnfNameFields. |
5513 | | | Embedded the new schema at the top of section 4. |
5514 +-----------+---------+-------------------------------------------------------+
5515 | 9/12/2017 | v5.4 | - Note: There no changes to any data structures or |
5516 | | | operations in this version. |
5518 | | | - JSON Schema: created v28.4 embedded at the top of |
5521 | | | - Added a reference to eventList in the properties|
5522 | | | defined under the schema title. This enables the|
5523 | | | schema to correctly validate event batches in |
5524 | | | addition to just events. |
5526 | | | - Moved the schema title to the top of the schema |
5527 | | | and changed the text from "Event Listener" to |
5528 | | | "VES Event Listener" |
5530 | | | - Added a schema header block under the title to |
5531 | | | clearly communicate the schema version, |
5532 | | | associated API and last-modified information |
5534 | | | - Changed the date in the copyright notice to 2017 |
5535 +-----------+---------+-------------------------------------------------------+
5536 | 9/19/2017 | v5.4.1 | - Note: There no changes to any data structures or |
5537 | | | operations in this version. |
5539 | | | - Back of Cover Page: updated the license and |
5540 | | | copyright notice to comply with ONAP guidelines |
5542 | | | - JSON Schema: updated the JSON schema to v28.4.1: |
5543 | | | updated the copyright notice and license to comply |
5544 | | | with ONAP guidelines |
5545 +-----------+---------+-------------------------------------------------------+
5546 | 6/28/2018 | v6.0 | - Added contributors to the title page. |
5548 | | | - Updated references to ‘vnf’ ‘vnfc’ to either ‘nf’ |
5549 | | | and ‘nfc’ or ‘xNf’ and ‘xNfc’ to generalize support|
5550 | | | across both vnfs and pnfs. |
5552 | | | - Section 1: |
5554 | | | - clarified the meaning of the VES acronym |
5556 | | | - changed references from ASDC to SDC and from MSO|
5559 | | | - clarified the requirements for eventNames. |
5561 | | | - Added a section of EventId use case examples |
5563 | | | - Added a new section on measurement expansion |
5566 | | | - Added a new section of syslogs |
5568 | | | - clarified the versioning section and referenced |
5569 | | | the new API Versioning section in section 6. |
5571 | | | - Added a list of all the latest field block |
5572 | | | version numbers in this version of the API spec.|
5574 | | | - Section 2: updated the sample to show use of new |
5575 | | | HTTP versioning headers. Added a note indicating |
5576 | | | that support for mutual SSL would be provided in |
5579 | | | - Section 3: updated the resource structure remove |
5580 | | | the clientThrottlingState resource. |
5582 | | | - Section 4: hashMaps. Changed all name-value pair |
5583 | | | structures to hashMaps causing the following data |
5584 | | | model and JSON schema (to v29.0) changes: |
5586 | | | - 4.1.1: Common Event Datatypes: |
5588 | | | - removed "field" and added "hashMap" |
5590 | | | - removed "namedArrayOfFields" and added |
5591 | | | "namedHashMap" |
5593 | | | - added arrayOfNamedHashMap |
5595 | | | - added arrayOfJsonObject |
5597 | | | - 4.2.1: Fault Domain Datatypes: |
5599 | | | - changed the faultFields version to 3.0 (major|
5602 | | | - changed faultFields.alarmAdditional\ |
5603 | | | Information to reference a hashMap |
5605 | | | - 4.2.2: Heartbeat Domain Datatypes: |
5607 | | | - changed the heartbeatFieldsVersion to 2.0 |
5608 | | | (major change) |
5610 | | | - changed heartbeatFields.additionalFields to |
5611 | | | reference a hashMap |
5613 | | | - 4.2.3: Measurement Domain Datatypes: |
5615 | | | - changed the measurementFieldsVersion to 3.0 |
5616 | | | (major change) |
5618 | | | - changed measurementFields.additionalFields to|
5619 | | | reference a hashMap |
5621 | | | - changed measurement.additionalMesurements to |
5622 | | | reference a namedHashMap [ ] |
5624 | | | - modified measurementFields.featureUsageArray |
5625 | | | to reference a hashmap and removed |
5626 | | | ‘featuresInUse’ |
5628 | | | - added the following datatypes which are now |
5629 | | | referenced as items in arrays within |
5630 | | | measurementFields: hugePages, load, |
5631 | | | machineCheckException, processStats |
5633 | | | - 4.2.5: Other Domain Datatypes: |
5635 | | | - Change the otherFieldsVersion to 2.0 (major |
5638 | | | - changed otherFields.nameValuePairs to |
5639 | | | reference a hashMap and renamed it hashMap |
5641 | | | - changed otherFields.hashOfNameValuePair\ |
5642 | | | Arrrays to reference a namedHashMap and |
5643 | | | renamed it arrayOfNamedHashMap |
5645 | | | - 4.2.7: State Change Domain Datatypes: |
5647 | | | - changed the stateChangeFiledsVersion to 3.0 |
5648 | | | (major change) |
5650 | | | - changed stateChangeFields.additionalFields to|
5651 | | | reference a hashMap |
5653 | | | - 4.2.9: Threshold Crossing Alert Domain |
5656 | | | - changed the thresholdCrossingAlertFields\ |
5657 | | | Version to 3.0 (major change) |
5659 | | | - changed thresholdCrossingAlert\ |
5660 | | | Fields.additionalFields to reference a |
5663 | | | - counter: removed name and value elements and |
5664 | | | replaced with a hashMap |
5666 | | | - 4.3.1: Mobile Flow Domain Datatypes: |
5668 | | | - changed the mobileFlowFieldsVersion to 3.0 |
5669 | | | (major change) |
5671 | | | - changed mobileFlowFields.additionalFields to |
5672 | | | reference a hashMap |
5674 | | | - gtpPerFlowMetrics: modified ipTosCountList to|
5675 | | | reference hashmap |
5677 | | | - gtpPerFlowMetrics: modified mobileQciCos\ |
5678 | | | CountList to reference hashmap |
5680 | | | - gtpPerFlowMetrics: modified tcpFlagCountList |
5681 | | | to reference hashmap |
5683 | | | - 4.3.2: Sip Signaling Domain Datatypes: |
5685 | | | - changed the sigSignalingFieldsVersion to 2.0 |
5686 | | | (major change) |
5688 | | | - changed sipSignalingFields.additional\ |
5689 | | | Information to reference a hashMap |
5691 | | | - 4.3.3: Voice Quality Domain Datatypes: |
5693 | | | - change the voiceQualityFieldsVersion to 2.0 |
5694 | | | (major change) |
5696 | | | - changed voiceQualityFields.additional\ |
5697 | | | Information to reference a hashMap |
5699 | | | - Section 4: added notes at the top of section 4 |
5700 | | | clarifying expectations and requirements for |
5701 | | | optional fields, extensible fields and keys sent |
5702 | | | through extensible fields. |
5704 | | | - Common Event Data Types: Section 4.1.1.9 Changed |
5705 | | | vendorVnfNameFields to vendorNfNameFields; updated |
5706 | | | Section 4.3.2 SipSignaling and 4.3.3 Voice Quality |
5707 | | | to refer to the renamed object |
5709 | | | - Common Event Header Section 4.1.2: |
5711 | | | - clarified the descriptions of eventId, |
5712 | | | reportingEntityName, sourceName and |
5713 | | | startEpochMicroseconds. |
5715 | | | - Added ‘notification’ and ‘pngRegistration’ to |
5716 | | | the domain enumeration. |
5718 | | | - added a new timeZoneOffsest field |
5720 | | | - Fault Domain Section 4.2.1: clarified the |
5721 | | | definitions of alarmCondition, eventSeverity and |
5722 | | | specificProblem |
5724 | | | - Measurements Domain Section 4.2.3: changed the name|
5725 | | | of this domain from ‘measurementsForVfScaling’ to |
5726 | | | ‘measurement’ |
5728 | | | - measurementsForVfScaling measurement |
5730 | | | - measurementsForVfScalingFields measurementFields|
5732 | | | - measurementsForVfScalingVersion |
5733 | | | measurementFieldsVersion |
5735 | | | - the ‘mfvs’ abbreviation measurement |
5737 | | | - Measurements Domain Section 4.2.3 cpuUsage: added |
5738 | | | seven optional fields to this structure: |
5739 | | | cpuCapacityContention, cpuDemandAvg, cpuDemandMhz, |
5740 | | | cpuDemandPct, cpuLatencyAverage, cpuOverheadAvg, |
5741 | | | cpuSwapWaitTime |
5743 | | | - Measurements Domain Section 4.2.3 diskUsage: added |
5744 | | | ten optional fields to this structure: |
5745 | | | diskBusResets, diskCommandsAborted, diskCommandsAvg|
5746 | | | , diskFlushRequests, diskFlushTime, |
5747 | | | diskReadCommandsAvg, diskTime, diskTotalRead\ |
5748 | | | LatencyAvg, diskTotalWriteLatencyAvg, diskWrite\ |
5751 | | | - Measurements Domain Section 4.2.3: added a new |
5752 | | | ‘ipmi’ datatype along with following ‘supporting’ |
5753 | | | datatypes: ipmiBaseboardTemperature, ipmiBaseboard\|
5754 | | | VoltageRegulator, ipmiBattery, ipmiFan, ipmiGlobal\|
5755 | | | AggregateTemperatureMargin, ipmiHsbp, ipmiNic, |
5756 | | | ipmiPowerSupply, ipmiProcessor, processorDimm\ |
5757 | | | AggregateThermalMargin |
5759 | | | - Measurements Domain Section 4.2.3: added a new |
5760 | | | ‘load’ datatype |
5762 | | | - Measurements Domain Section 4.2.3 memoryUsage: |
5763 | | | added eight optional fields to this structure: |
5764 | | | memoryDemand, memoryLatencyAvg, memorySharedAvg, |
5765 | | | memorySwapInAvg, memorySwapInRateAvg, memorySwap\ |
5766 | | | OutAvg, memorySwapOutRateAvg, memorySwapUsedAvg |
5768 | | | - Measurements Domain Section 4.2.3: modified |
5769 | | | measurementFields to include the following new |
5770 | | | fields: hugePagesArray, ipmi, loadArray, memory\ |
5771 | | | Errors, processStatusArray, rdtArray |
5773 | | | - Measurements Domain Section 4.2.3 renamed vNic\ |
5774 | | | Performance to nicPerformance and changed vNic\ |
5775 | | | Identifer to nicIdentifier |
5777 | | | - Notification Domain Section 4.2.4: added |
5778 | | | notificationFields to support a new notification |
5781 | | | - pnfRegistration Domain Section 4.2.7: added |
5782 | | | pnfRegistrationFields to support a new registration|
5785 | | | - sysLog Domain Section 4.2.8: added two new fields: |
5786 | | | syslogMsgHost and syslogTs. Clarified field |
5787 | | | descriptions. Clarified syslogSData example. |
5789 | | | - endOfCallVqmSummaries Section 4.3.3.1: |
5791 | | | - converted endpointJitter into two fields: |
5792 | | | endpointAverageJitter and endpointMaxJitter |
5794 | | | - converted localJitter into two fields: |
5795 | | | localAverageJitter and localMaxJitter |
5797 | | | - added two fields: localAverageJitterBufferDelay |
5798 | | | and localMaxJitterBufferDelay |
5800 | | | - added endpointRtpOctetsLost and |
5801 | | | endpointRtpPacketsLost |
5803 | | | - added localRtpOctetsLost and localRtpPacketsLost|
5805 | | | - converted packetsLost into oneWayDelay |
5807 | | | - API Versioning: |
5809 | | | - Section 1.4: clarified the versioning section |
5810 | | | and linked it to the following new section 6.1.2|
5812 | | | - Section 6.1.2: Added requirements for HTTP |
5813 | | | headers communicating minor, patch and latest |
5814 | | | version information. |
5816 | | | - Section 2 and 6 sample messages: clarified |
5817 | | | examples to use the new HTTP headers |
5819 | | | - Section 6.1.4: Added a section specifying message |
5820 | | | size limits. |
5822 | | | - Section2 6.2.6.1 and 6.3.6.1: corrected |
5823 | | | additionalInformation examples to use hashMap |
5824 | | | instead of name-value pair fields. |
5826 | | | - Section 7: Added a section on Terminology. |
5828 | | | - Command List Processing: removed command list |
5829 | | | processing from the document and schema: |
5831 | | | - Modified the Section 3 resource structure to |
5832 | | | align with these changes. |
5834 | | | - Removed Section 4 Datatypes: command, |
5835 | | | commandList, eventDomainThrottleSpecification, |
5836 | | | eventDomainThrottleSpecificationList, |
5837 | | | eventThrottlingState, suppressedNvPairs |
5839 | | | - Removed Section 6.1 description of commands |
5840 | | | toward event source clients |
5842 | | | - Removed Section 6.4 operation: |
5843 | | | provideThrottlingState |
5844 +-----------+---------+-------------------------------------------------------+
5845 | 7/30/2018 | v7.0 | - General: |
5847 | | | - Fixed typos throughout |
5849 | | | - Changed example versions to v7 |
5853 | | | - Clarified casing and use of dashes versus colons|
5854 | | | in eventName examples |
5856 | | | - Updated all field block versions |
5858 | | | - Section 2: added a note clarifying that TLS 1.2 or |
5859 | | | higher must be used for HTTPS connections. |
5861 | | | - Section 4 embedded schema changed to v30: |
5863 | | | - Added " ‘additionalProperties’: false " to |
5864 | | | objects to reject events that attempt to send |
5865 | | | properties that are not listed in the |
5866 | | | ‘properties’ keyword. Note: does not affect |
5867 | | | hashmap extensible fields. |
5869 | | | - Changed all versions in all field blocks from |
5870 | | | number to string enum with the version number |
5871 | | | fixed by the enum so the schema can validate |
5872 | | | events that attempt to send non-standard field |
5875 | | | - Changed syslog additionalFields to a hashMap |
5877 | | | - Section 4: |
5879 | | | - Fixed section heading numbers that were the same|
5881 | | | - 4.1.1: jsonObjectInstance: added an optional |
5882 | | | recursive jsonObject and removed all required |
5883 | | | fields from this object |
5885 | | | - 4.1.2: commonEventHeader: |
5887 | | | - nfVendorName: added this optional field |
5889 | | | - timeZoneOffset: changed from number to string|
5890 | | | with a particular format specified |
5892 | | | - version was changed from number to string (as|
5893 | | | were all the version fields of all the field |
5896 | | | - vesCommonEventListenerVersion: added this |
5897 | | | required field as a string enumeration |
5899 | | | - 4.2.3: Measurements Domain: |
5901 | | | - Added a note clarifying that NFs are required|
5902 | | | to report exactly one Measurement event per |
5903 | | | period per sourceName |
5905 | | | - diskUsage: added four new optional fields: |
5906 | | | diskWeightedIoTimeAve, diskWeightedIoTimeLast|
5907 | | | , diskWeightedIoTimeMax, |
5908 | | | diskWeightedIoTimeMin |
5910 | | | - memoryUsage: add one new optional field: |
5911 | | | percentMemoryUsage |
5913 | | | - nicPerformance: added nine new optional |
5914 | | | fields: administrativeState, operationalState|
5915 | | | , receivedPercentDiscard, |
5916 | | | receivedPercentError, receivedUtilization, |
5917 | | | speed, transmittedPercentDiscard, |
5918 | | | transmittedPercentError, |
5919 | | | transmittedUtilization |
5921 | | | - processorDimmAggregateThermalMargin: make the|
5922 | | | thermalMargin field required |
5924 | | | - 4.2.8: Syslog Domain: |
5926 | | | - Corrected the example at the end of the section |
5927 +-----------+---------+-------------------------------------------------------+
5928 | 7/31/2018 | v7.0.1 | - Section 4: The schema embedded at the top of |
5929 | | | section 4 was patched to correct a header field |
5930 | | | name error—the schema version moves from 30 to |
5933 | | | - Changed commonEventHeader field: ‘vesCommon\ |
5934 | | | EventFormatVersion’ field to ‘vesEventListener\ |
5935 | | | Version’ and set the enum to 7.0.1 |
5937 | | | - Also changed the commonEventHeader ‘required’ |
5938 | | | array to reflect use the corrected field name: |
5939 | | | ‘vesEventListenerVersion’ |
5941 | | | - Changed the commonEventHeader ‘version’ field |
5942 | | | enumeration to 4.0.1 |
5946 | | | - Changed the field block versions for the common |
5947 | | | header for ‘vesEventListenerVersion’ (to 7.0.1) |
5948 | | | and ‘version’ (to 4.0.1). |
5950 | | | - Sections 2 and 6: |
5952 | | | - Changed the commonEventHeader version fields |
5953 | | | above, in the sample message requests and |
5954 | | | responses; also updated the faultFieldsVersion |
5957 | | | - Section 6.1.2: Changed the X-LatestVersion to 7.0.1|
5958 | | | and the X-PatchVersion to 1 |
5959 +-----------+---------+-------------------------------------------------------+
5960 | 12/10/2018| v7.1 | - Section 1.2: Added Notification domain Perf3gpp |
5961 | | | domain and changed a reference from ‘measurements |
5962 | | | domain’ to ‘measurement domain’. |
5964 | | | - Section 1.7.1: Field Block Versions: added |
5965 | | | ‘perf3gppFields’ version at 1.0 and changed the |
5966 | | | following version enumerations so that existing |
5967 | | | clients of major version 7 would not be broken by |
5968 | | | this VES minor version change, in accordance with |
5969 | | | semantic versioning definitions: |
5971 | | | - commonEventHeader: changed to |
5972 | | | ‘vesEventListenerVersion’ enum to accept either |
5973 | | | 7.0 or 7.0.1 or 7.1. |
5975 | | | - commonEventHeader: changed ‘version’ enum to |
5976 | | | accept either 4.0 or 4.0.1 or 4.1 |
5978 | | | - Section 2: |
5980 | | | - changed sample request and responses to |
5981 | | | reference 7.1 instead of 7.0.1 (and version 4.1 |
5982 | | | of the commonEventHeader version, instead of |
5985 | | | - added a sub section on service provider support |
5986 | | | for mutual ssl certificate authentication |
5988 | | | - Section 4.1.2.1: |
5990 | | | - CommonEventHeader timeZoneOffset changed |
5991 | | | description from ‘UTC+/-hh.mm’ to ‘UTC+/-hh:mm’ |
5993 | | | - Added ‘perf3gpp’ to the domain enumeration |
5995 | | | - Section 4.2.3: Measurement Domain Datatypes: |
5997 | | | - In ‘MeasurementFields’: Changed ‘ipmiArray’ to |
5998 | | | ‘ipmi’ and made the type ‘object’ |
6000 | | | - ‘ipmiProcessor’: changed |
6001 | | | ‘pprocessorThermalControl’ to |
6002 | | | ‘processorThermalControl’ |
6004 | | | - ‘machineCheckException’: changed |
6005 | | | ‘processIdentifier’ to ‘vmIdentifier’ |
6007 | | | - Section 4.2.6: added the perf3gpp domain |
6009 | | | - Section 4 embedded schema: |
6011 | | | - Changed the schema version from 30.0.1 to 30.1 |
6012 | | | as a result of the changes below: |
6014 | | | - commonEventHeader: changed to |
6015 | | | ‘vesEventListenerVersion’ enum to accept either |
6016 | | | 7.0, 7.0.1 or 7.1 |
6018 | | | - commonEventHeader: changed the ‘version’ field |
6019 | | | enumeration to accept either 4.0, 4.0.1 or 4.1 |
6021 | | | - commonEventHeader: changed the ‘domain’ |
6022 | | | enumeration to add support for the perf3gpp |
6025 | | | - ‘event’: added a reference to ‘perf3gppFields’ |
6027 | | | - ‘hugePages’: changed the type of |
6028 | | | hugePagesIdentifier from number to string |
6030 | | | - ‘ipmiGlobalAggregateTemperatureMargin’: changed |
6031 | | | ‘pmiGlobalAggregateTemperatureMarginIdentifier’ |
6032 | | | to ‘globalAggregateTemperatureMarginIdentifier’ |
6034 | | | - ‘perf3gppFields’: added this object |
6036 | | | - Section 6: changed references throughout from |
6037 | | | v7.0.1 to v7.1 and v4.0.1 (of the commonEventHeader|
6038 | | | version) to v4.1 |
6040 | | | - Changed the location of the doc to VNF |
6041 | | | Requirements and changed the formatting |
6042 +-----------+---------+-------------------------------------------------------+
6043 | 1/28/2020 | v7.1.1 | - Changed event sizes from 2Mb to 1Mb |
6044 | | | - Configuration Requirement comments addressed |
6045 | | | - Changed DCAE Collector to VES Event Listener |
6046 | | | - Replaced VNF with NF where appropriate |
6047 | | | - Updated publishAnyEvent and publishBatchEvent to |
6048 | | | clarify both one way and mutual TLS are supported |
6049 | | | - Changed authorization for publishEventBatch |
6050 | | | because certification authorization is also |
6052 | | | - Updated fault use case in EventId Use Case |
6053 | | | Examples based on Ericsson feedback |
6054 | | | - Added new Configuration Requirements section |
6055 | | | - Added new Event Domain Requirements section |
6056 | | | - Updated security requirements based on agreements |
6057 | | | in ONAP Security Committee with details on 2-way |
6058 | | | certificate support |
6059 | | | - Provided clarifications on event buffering |
6060 | | | - Added Event Handling Requirements for |
6061 | | | publishEventFlow |
6062 | | | - Updated Field Block Versions to support existing |
6063 | | | clients of major version 7 |
6064 | | | - Updated sample request and response schemas |
6065 | | | - Updated embedded schema as follows: |
6067 | | | * Changed schema version to 30.1.1 |
6068 | | | * Changed measValues to measValuesList and similar |
6069 | | | changes throughout |
6070 | | | * Changed iMeasTypesList to sMeasTypesList |
6071 | | | - Corrected publishEventBatch call flow diagram |
6072 | | | - Changed AuthorizationHeader to Required? = NO for |
6073 | | | publishAnyEvent operation |
6074 | | | - Relaxed various requirements related to camel |
6075 | | | casing of values from 'must' to 'should' |
6076 +-----------+---------+-------------------------------------------------------+
6077 | 5/27/2020 | v7.2 | - Re-organized sections to flow more logically |
6078 | | | - Moved NF requirements to VNF Requirements |
6079 | | | - Changed DCAE Collector to VES Event Listener |
6080 +-----------+---------+-------------------------------------------------------+
6082 .. _time_zone_abbreviations: https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations
6083 .. _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