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.
5 .. Copyright 2020-2021 Nokia Solutions and Networks
7 .. _ves_event_listener_7_2:
9 Service: VES Event Listener 7.2.1
10 ---------------------------------
12 +-----------------------------------------------------------------------------+
13 | **Legal Disclaimer** |
15 | Licensed under the Apache License, Version 2.0 (the "License"); you may not |
16 | use this file except in compliance with the License. You may obtain a copy |
19 | http://www.apache.org/licenses/LICENSE-2.0 |
21 | Unless required by applicable law or agreed to in writing, software |
22 | distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
23 | WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
24 | License for the specific language governing permissions and limitations |
25 | under the License. |
26 +-----------------------------------------------------------------------------+
29 :Document: VES Event Listener
31 :Revision Date: January 13th, 2021
32 :Author: Trevor Lovett
34 +-----------------+-----------------------------+
35 | Contributors: | **Min Chen – AT&T** |
37 | | **Fred Delaplace - AT&T** |
39 | | **Andrew Egan – AT&T** |
41 | | **Alok Gupta – AT&T** |
43 | | **Marge Hillis – Nokia** |
45 | | **Gerard Hynes – AT&T** |
47 | | **Ken Kelly – AT&T** |
49 | | **Damian Nowak - Nokia** |
51 | | **Mark Scott – Ericsson** |
53 | | **Tim Verall – Intel** |
55 | | **Sumit Verdi – VMWare** |
57 | | **Trevor Lovett – AT&T** |
59 | | **Rich Erickson – AT&T** |
60 +-----------------+-----------------------------+
62 .. contents:: Table of Contents
67 This document describes the RESTful interface for the VES Event
68 Listener. The VES acronym originally stood for Virtual-function Event
69 Streaming, but VES has been generalized to support network-function
70 event streaming, whether virtualized or not. The VES Event Listener is
71 capable of receiving any event sent in the VES
72 :ref:`ves_common_event_format_7_2`. In the VES Common Event Format, an event
73 consists of a required
74 :ref:`Common Event Header <ves_common_event_header_7_2>` (i.e., object)
75 accompanied by zero or more event domain blocks.
77 It should be understood that events are well structured packages of
78 information, identified by an ``eventName``, which are asynchronously
79 communicated to subscribers who are interested in the ``eventName``. Events
80 can convey measurements, faults, syslogs, threshold crossing alerts and
81 other types of information. Events are simply a way of communicating
82 well-structured packages of information to one or more instances of an
83 VES Event Listener service.
85 This document describes a RESTful, connectionless, push event listener
86 that can receive single events or batches of events in the
87 :ref:`ves_common_event_format_7_2`.
92 Three types of version numbers supported by this specification:
94 - The API specification itself is versioned. Going forward, the major
95 number of the specification version will be incremented whenever any
96 change could break an existing client (e.g., a field name is deleted
97 or changed). All other changes to the spec (e.g., a field name is
98 added, or text changes are made to the specification itself) will
99 increment only the minor number or patch number. Note that the major
100 number appears in REST resource URLs as v# (where ‘#’ is the major
101 number). Minor and patch numbers are communicated in HTTP headers.
102 For more information, see the API Versioning writeup in section 6.1.
104 - The JSON schema is versioned. Going forward, the major number of the
105 JSON schema will be incremented whenever any change could break an
106 existing client (e.g., a field name is deleted or changed). All other
107 changes to the schema (e.g., a field name is added or text changes
108 are made to the field descriptions) will increment only the minor
109 number or patch number.
111 - The field blocks are versioned. Field blocks include the
112 commonEventHeader and the domain blocks (e.g., the faultFields
113 block). Going forward, the major number of each field block will be
114 incremented whenever any change to that block could break an existing
115 client (e.g., a field name is deleted or changed). All other changes
116 to that block (e.g., a field name is added or text changes are made
117 to the field descriptions) will increment only the minor number.
122 Any NF or client library that is responsible for delivering VES events
123 to a VES Event Listener must comply with this specification to ensure events are
124 received, accepted, and processed properly.
126 Because the VES specification relies on clients to push events to the
127 VES Event Listener, the client assumes certain responsibilities such as:
129 - Providing configuration options supporting integration into a
130 Service Provider environment
131 - Ensuring reliable delivery of events
132 - Customization of default behaviors based on Service Provider needs
134 While the documentation of these expectations are beyond the Event Listener
135 specification, these requirements are documented in the ONAP VNF Requirements
136 for :ref:`VES Monitoring Requirements <ves_monitoring_requirements>`.
139 Compatibility with ONAP
140 ^^^^^^^^^^^^^^^^^^^^^^^
142 Unless otherwise stated, this version of the Event Listener specification is
143 compatible with the release of ONAP the specification is released under. In
144 other words, if the specification is released under the Guilin ONAP release,
145 then the VES Event Listeners provided by DCAE will also be compatible with
148 Support for Protocols Other Than HTTPS
149 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
151 This API specification describes an HTTPS RESTful interface using the
154 Alternative API specifications may be provided in future using Google
155 Protocol Buffers, WebSockets, or Apache Avro.
160 A summary of the latest field block version enums as of this version of
161 the API spec is provided below:
163 - commonEventHeader version 4.1 (note: the enum with support 4.0,
164 4.0.1, 4.1 to avoid breaking clients of earlier versions of major
167 - commonEventHeader vesEventListenerVersion enum: 7.2 (note: the enum
168 will support 7.0, 7.0.1, 7.1, 7.1.1, 7.2 to avoid breaking clients of earlier
169 versions of major version 7)
171 - faultFieldsVersion:4.0
173 - heartbeatFieldsVersion: 3.0
175 - measurementFieldsVersion: 4.0
177 - mobileFlowFieldsVersion: 4.0
179 - notificationFieldsVersion: 2.0
181 - otherFieldsVersion: 3.0
183 - perf3gppFieldsVersion: 1.0
185 - pnfRegistrationFieldsVersion: 2.0
187 - sigSignalingFieldsVersion: 3.0
189 - stateChangeFieldsVersion: 4.0
191 - stndDefinedFieldsVersion: 1.0
193 - syslogFieldsVersion: 4.0
195 - thresholdCrossingFieldsVersion: 4.0
197 - voiceQualityFieldsVersion: 4.0
199 .. _ves_common_event_format_7_2:
204 A JSON schema describing the Common Event Format is provided below and
205 is reproduced in the tables that follow.
207 :download:`JSON <CommonEventFormat_30.2_ONAP.json>`
210 Note on optional fields:
212 If the event publisher collects a field that is identified as
213 optional in the data structures below, then the event publisher
214 *must* send that field.
216 Note on extensible fields:
218 VES contains various extensible structures (e.g., hashMap) that
219 enable event publishers to send information that has not been
220 explicitly defined in VES data structures.
222 - Event publishers *must not* send information through extensible
223 structures where VES has explicitly defined fields for that
224 information. For example, event publishers *must not* send
225 information like cpuIdle, through an extensible structure, because
226 VES has explicitly defined a cpuUsage.cpuIdle field for the
227 communication of that information.
229 - Keys sent through extensible fields should use camel casing to separate
230 words and acronyms; only the first letter of each acronym shall be
233 Common Event Datatypes
234 ~~~~~~~~~~~~~~~~~~~~~~
236 Datatype: arrayOfJsonObject
237 +++++++++++++++++++++++++++
239 The arrayOfJsonObject datatype provides an array of json objects, each
240 of which is describ ed by name, schema and other meta-information. It
241 consists of the following fields:
243 +---------------------+------------------+----------+----------------------+
244 | Field | Type | Required?| Description |
245 +=====================+==================+==========+======================+
246 | arrayOfJsonObject | jsonObject [ ] | Yes | Array of jsonObject |
247 +---------------------+------------------+----------+----------------------+
249 Datatype: arrayOfNamedHashMap
250 +++++++++++++++++++++++++++++
252 The arrayOfNamedHashMap datatype provides an array of hashMaps, each of
253 which is associated with a descriptive name. It consists of the
256 +---------------------+------------------+-----------+-----------------------+
257 | Field | Type | Required? | Description |
258 +=====================+==================+===========+=======================+
259 | arrayOfNamedHashMap | namedHashMap [ ] | Yes | Array of namedHashMap |
260 +---------------------+------------------+-----------+-----------------------+
265 The event datatype consists of the following fields which constitute the
266 ‘root level’ of the common event format:
268 +--------------+--------------+-----------+-----------------------------------+
269 | Field | Type | Required? | Description |
270 +==============+==============+===========+===================================+
271 | commonEvent\ | commonEvent\ | Yes | Fields common to all events |
272 | Header | Header | | |
273 +--------------+--------------+-----------+-----------------------------------+
274 | faultFields | faultFields | No | Fields specific to fault events |
275 +--------------+--------------+-----------+-----------------------------------+
276 | heartbeat\ | heartbeat\ | No | Fields specific to heartbeat |
277 | Fields | Fields | | events |
278 +--------------+--------------+-----------+-----------------------------------+
279 | measurement\ | measurement\ | No | Fields specific to measurement |
280 | Fields | Fields | | events |
281 +--------------+--------------+-----------+-----------------------------------+
282 | mobileFlow\ | mobileFlow\ | No | Fields specific to mobility flow |
283 | Fields | Fields | | events |
284 +--------------+--------------+-----------+-----------------------------------+
285 | notification\| notification\| No | Fields specific to notification |
286 | Fields | Fields | | events |
287 +--------------+--------------+-----------+-----------------------------------+
288 | otherFields | otherFields | No | Fields specific to other types of |
290 +--------------+--------------+-----------+-----------------------------------+
291 | perf3gpp\ | perf3gpp\ | No | Fields specific to perf3gpp |
292 | Fields | Fields | | events |
293 +--------------+--------------+-----------+-----------------------------------+
294 | pnf\ | pnf\ | No | Fields specific to pnfRegistration|
295 | Registration\| Registration\| | events |
296 | Fields | Fields | | |
297 +--------------+--------------+-----------+-----------------------------------+
298 | sipSignaling\| sipSignaling\| No | Fields specific to sipSignaling |
299 | Fields | Fields | | events |
300 +--------------+--------------+-----------+-----------------------------------+
301 | stateChange\ | stateChange\ | No | Fields specific to state change |
302 | Fields | Fields | | events |
303 +--------------+--------------+-----------+-----------------------------------+
304 | stndDefined\ | stndDefined\ | No | Fields specific to standards |
305 | Fields | Fields | | defined events |
306 +--------------+--------------+-----------+-----------------------------------+
307 | syslogFields | syslogFields | No | Fields specific to syslog events |
308 +--------------+--------------+-----------+-----------------------------------+
309 | threshold\ | threshold\ | No | Fields specific to threshold |
310 | Crossing\ | Crossing\ | | crossing alert events |
311 | AlertFields | AlertFields | | |
312 +--------------+--------------+-----------+-----------------------------------+
313 | voiceQuality\| voiceQuality\| No | Fields specific to voiceQuality |
314 | Fields | Fields | | events |
315 +--------------+--------------+-----------+-----------------------------------+
320 The eventList datatype consists of the following fields:
322 +-------------+-------------+----------+-------------------+
323 | Field | Type | Required?| Description |
324 +=============+=============+==========+===================+
325 | eventList | event [ ] | Yes | Array of events |
326 +-------------+-------------+----------+-------------------+
331 The hashMap datatype is an ‘associative array’, which is an unordered
332 collection of key-value pairs of the form "key": "value", where each key
333 and value are strings. Keys should use camel casing to separate words and
334 acronyms; only the first letter of each acronym should be capitalized.
339 The jsonObject datatype provides a json object schema, name and other
340 meta-information along with one or more object instances that conform to
343 +--------------+--------------+-----------+----------------------------------+
344 | Field | Type | Required? | Description |
345 +==============+==============+===========+==================================+
346 | object\ | JsonObject\ | Yes | Contains one or more instances of|
347 | Instances | Instance [ ] | | the json object |
348 +--------------+--------------+-----------+----------------------------------+
349 | objectName | string | Yes | Name of the json object |
350 +--------------+--------------+-----------+----------------------------------+
351 | objectSchema | string | No | json schema for the object |
352 +--------------+--------------+-----------+----------------------------------+
353 | objectSchema\| string | No | URL to the json schema for the |
355 +--------------+--------------+-----------+----------------------------------+
356 | nfSubscribed\| string | No | Name of the object associated |
357 | ObjectName | | | with the nfSubscriptionId |
358 +--------------+--------------+-----------+----------------------------------+
359 | nf\ | string | No | Identifies an openConfig |
360 | Subscription\| | | telemetry subscription on a |
361 | Id | | | network function, which |
362 | | | | configures the network function |
363 | | | | to send complex object data |
364 | | | | associated with the jsonObject |
365 +--------------+--------------+-----------+----------------------------------+
367 Datatype: jsonObjectInstance
368 ++++++++++++++++++++++++++++
370 The jsonObjectInstance datatype provides meta-information about an
371 instance of a jsonObject along with the actual object instance:
373 +----------------+------------+----------+-----------------------------------+
374 | Field | Type | Required?| Description |
375 +================+============+==========+===================================+
376 | jsonObject | jsonObject | No | Optional recursive specification |
377 | | | | of jsonObject |
378 +----------------+------------+----------+-----------------------------------+
379 | objectInstance | object | No | Contains an instance conforming to|
380 | | | | the jsonObject schema |
381 +----------------+------------+----------+-----------------------------------+
382 | objectInstance\| number | No | the unix time, aka epoch time, |
383 | EpochMicrosec | | | associated with this |
384 | | | | objectInstance--as microseconds |
385 | | | | elapsed since 1 Jan 1970 not |
386 | | | | including leap seconds |
387 +----------------+------------+----------+-----------------------------------+
388 | objectKeys | key [ ] | No | An ordered set of keys that |
389 | | | | identifies this particular |
390 | | | | instance of jsonObject (e.g., that|
391 | | | | places it in a hierarchy) |
392 +----------------+------------+----------+-----------------------------------+
397 The key datatype is a tuple which provides the name of a key along with
398 its value and relative order; it consists of the following fields:
400 +----------+---------+-----------+-------------------------------------------+
401 | Field | Type | Required? | Description |
402 +==========+=========+===========+===========================================+
403 | keyName | string | Yes | Name of the key |
404 +----------+---------+-----------+-------------------------------------------+
405 | keyOrder | Integer | No | Relative sequence or order of the key |
406 | | | | (with respect to other keys) |
407 +----------+---------+-----------+-------------------------------------------+
408 | keyValue | string | No | Value of the key |
409 +----------+---------+-----------+-------------------------------------------+
411 Datatype: namedHashMap
412 ++++++++++++++++++++++
414 The namedHashMap datatype is a hashMap which is associated with and
415 described by a name; it consists of the following fields:
417 +---------+---------+-----------+--------------------------------------------+
418 | Field | Type | Required? | Description |
419 +=========+=========+===========+============================================+
420 | name | string | Yes | Name associated with or describing the |
422 +---------+---------+-----------+--------------------------------------------+
423 | hashMap | hashMap | Yes | One or more key:value pairs |
424 +---------+---------+-----------+--------------------------------------------+
426 Datatype: requestError
427 ++++++++++++++++++++++
429 The requestError datatype defines the standard request error data
432 +-----------+--------+-----------+-------------------------------------------+
433 | Field | Type | Required? | Description |
434 +===========+========+===========+===========================================+
435 | messageId | string | Yes | Unique message identifier of the format |
436 | | | | ‘ABCnnnn’ where ‘ABC’ is either ‘SVC’ for |
437 | | | | Service Exceptions or ‘POL’ for Policy |
438 | | | | Exception. Exception numbers may be in the|
439 | | | | range of 0001 to 9999 where 0001 to 2999 |
440 | | | | are defined by OMA (see section 5.1) and |
441 | | | | 3000-9999 are available and undefined. |
442 +-----------+--------+-----------+-------------------------------------------+
443 | text | string | Yes | Message text, with replacement variables |
444 | | | | marked with %n, where n is an index into |
445 | | | | the list of <variables> elements, starting|
447 +-----------+--------+-----------+-------------------------------------------+
448 | url | string | No | Hyperlink to a detailed error resource |
449 | | | | e.g., an HTML page for browser user agents|
450 +-----------+--------+-----------+-------------------------------------------+
451 | variables | string | No | List of zero or more strings that |
452 | | | | represent the contents of the variables |
453 | | | | used by the message text |
454 +-----------+--------+-----------+-------------------------------------------+
456 Datatype: vendorNfNameFields
457 ++++++++++++++++++++++++++++
459 The vendorNfNameFields provides vendor, nf and nfModule identifying
462 +--------------+--------+-----------+----------------------------------------+
463 | Field | Type | Required? | Description |
464 +==============+========+===========+========================================+
465 | vendorName | string | Yes | Network function vendor name |
466 +--------------+--------+-----------+----------------------------------------+
467 | nfModuleName | string | No | Name of the nfModule generating the |
469 +--------------+--------+-----------+----------------------------------------+
470 | nfName | string | No | Name of the network function generating|
472 +--------------+--------+-----------+----------------------------------------+
474 Common Event Header Data Types
475 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
477 .. _ves_common_event_header_7_2:
479 Datatype: commonEventHeader
480 +++++++++++++++++++++++++++
482 The commonEventHeader datatype consists of the following fields common
485 +-----------+----------+-----------+-----------------------------------------+
486 | Field | Type | Required? | Description |
487 +===========+==========+===========+=========================================+
488 | domain | string | Yes | Event domain enumeration: ‘fault’, |
489 | | | | ‘heartbeat’, ‘measurement’, ‘mobileFlow’|
490 | | | | , ‘notification’, ‘other’, ‘perf3gpp’, |
491 | | | | ‘pnfRegistration’, ‘sipSignaling’, |
492 | | | | ‘stateChange’,‘stndDefined’, ‘syslog’, |
493 | | | | ‘thresholdCrossingAlert’, ‘voiceQuality’|
494 +-----------+----------+-----------+-----------------------------------------+
495 | eventId | string | Yes | Event key that is unique to the event |
496 | | | | source. The key must be unique within |
497 | | | | notification life cycle similar to |
498 | | | | EventID from 3GPP. It could be a |
499 | | | | sequential number, or a composite key |
500 | | | | formed from the event fields, such as |
501 | | | | domain\_sequence. The eventId should not|
502 | | | | include whitespace. For fault events, |
503 | | | | eventId is the eventId of the initial |
504 | | | | alarm; if the same alarm is raised again|
505 | | | | for changed, acknowledged or cleared |
506 | | | | cases, eventId must be the same as the |
507 | | | | initial alarm (along with the same |
508 | | | | startEpochMicrosec but with a different |
509 | | | | sequence number). |
510 | | | | See :ref:`ves_eventid_usecases_7_2` for |
511 | | | | additional guidance on eventId usage. |
512 +-----------+----------+-----------+-----------------------------------------+
513 | eventName | string | Yes | See :ref:`ves_eventname_guidelines_7_2`|
514 | | | | for additional information on naming |
516 +-----------+----------+-----------+-----------------------------------------+
517 | eventType | string | No | |
518 +-----------+----------+-----------+-----------------------------------------+
519 | internal\ | internal\| No | Fields (not supplied by event sources) |
520 | Header | Header | | that the VES Event Listener service can |
521 | Fields | Fields | | use to enrich the event if needed for |
522 | | | | efficient internal processing. This is |
523 | | | | an empty object which is intended to be |
524 | | | | defined separately by each service |
525 | | | | provider (e.g., AT&T) implementing the |
526 | | | | VES Event Listener. |
527 +-----------+----------+-----------+-----------------------------------------+
528 | lastEpoch\| number | Yes | the latest unix time aka epoch time |
529 | Microsec | | | associated with the event from any |
530 | | | | component--as microseconds elapsed since|
531 | | | | 1 Jan 1970 not including leap seconds |
532 +-----------+----------+-----------+-----------------------------------------+
533 | nfcNaming\| string | No | Network function component type: 3 |
534 | Code | | | characters (aligned with vfc naming |
536 +-----------+----------+-----------+-----------------------------------------+
537 | nfNaming\ | string | No | Network function type: 4 characters |
538 | Code | | | (aligned with vnf and pnf naming |
540 +-----------+----------+-----------+-----------------------------------------+
541 | nfVendor\ | string | No | |
543 +-----------+----------+-----------+-----------------------------------------+
544 | priority | string | Yes | |
545 +-----------+----------+-----------+-----------------------------------------+
546 | reporting\| string | No | UUID identifying the entity reporting |
547 | EntityId | | | the event or detecting a problem in |
548 | | | | another vnf/vm or pnf which is |
549 | | | | experiencing the problem. (Note: the |
550 | | | | AT&T internal enrichment process shall |
551 | | | | ensure that this field is populated). |
552 | | | | The reportingEntityId is an id for the |
553 | | | | reportingEntityName. See |
554 | | | | ‘reportingEntityName’ for more |
555 | | | | information. |
556 +-----------+----------+-----------+-----------------------------------------+
557 | reporting\| string | Yes | Name of the entity reporting the event |
558 | EntityName| | | or detecting a problem in another vnf/vm|
559 | | | | or pnf which is experiencing the |
560 | | | | problem. May be the same as the |
561 | | | | sourceName. For synthetic events |
562 | | | | generated by DCAE, it is the name of the|
563 | | | | app generating the event. |
564 +-----------+----------+-----------+-----------------------------------------+
565 | sequence | integer | Yes | Ordering of events communicated by an |
566 | | | | event source instance (or 0 if not |
568 +-----------+----------+-----------+-----------------------------------------+
569 | sourceId | string | No | UUID identifying the entity experiencing|
570 | | | | the event issue, which may be detected |
571 | | | | and reported by a separate reporting |
572 | | | | entity (note: the AT&T internal |
573 | | | | enrichment process shall ensure that |
574 | | | | this field is populated). The sourceId |
575 | | | | is an id for the sourceName. See |
576 | | | | ‘sourceName’ for more information. |
577 +-----------+----------+-----------+-----------------------------------------+
578 | sourceName| string | Yes | Name of the entity experiencing the |
579 | | | | event issue, which may be detected and |
580 | | | | reported by a separate reporting entity.|
581 | | | | The sourceName identifies the device for|
582 | | | | which data is collected. A valid |
583 | | | | sourceName must be inventoried in A&AI. |
584 | | | | If sourceName is a xNF (vnf or pnf), |
585 | | | | xNFC or VM, then the event must be |
586 | | | | reporting data for that particular xNF, |
587 | | | | xNFC or VM. If the sourceName is a xNF, |
588 | | | | comprised of multiple xNFCs, the data |
589 | | | | must be reported/aggregated at the xNF |
590 | | | | level. Data for individual xNFC must not|
591 | | | | be included in the xNF sourceName event.|
592 +-----------+----------+-----------+-----------------------------------------+
593 | start\ | number | Yes | the earliest unix time aka epoch time |
594 | Epoch\ | | | associated with the event from any |
595 | Microsec | | | component--as microseconds elapsed since|
596 | | | | 1 Jan 1970 not including leap seconds. |
597 | | | | For measurements and heartbeats, where |
598 | | | | events are collected over predefined |
599 | | | | intervals, startEpochMicrosec shall be |
600 | | | | rounded to the nearest interval boundary|
601 | | | | (e.g., the epoch equivalent of 3:00PM, |
602 | | | | 3:10PM, 3:20PM, etc…). For fault events,|
603 | | | | startEpochMicrosec is the timestamp of |
604 | | | | the initial alarm; if the same alarm is |
605 | | | | raised again for changed, acknowledged |
606 | | | | or cleared cases, startEpoch Microsec |
607 | | | | must be the same as the initial alarm |
608 | | | | (along with the same eventId and an |
609 | | | | incremental sequence number). For |
610 | | | | devices with no timing source (clock), |
611 | | | | the default value will be 0 and the VES |
612 | | | | collector will replace it with Collector|
613 | | | | time stamp (when the event is received) |
614 +-----------+----------+-----------+-----------------------------------------+
615 | stnd\ | string | No | Standards-organization defined event |
616 | Defined\ | | | namespace; expected usage includes event|
617 | Namespace | | | routing by the event listener |
618 +-----------+----------+-----------+-----------------------------------------+
619 | timeZone\ | string | No | Offset to GMT to indicate local time |
620 | Offset | | | zone for device formatted as |
621 | | | | ‘UTC+/-hh:mm’; see |
622 | | | | time_zone_abbreviations_ for UTC offset |
624 +-----------+----------+-----------+-----------------------------------------+
625 | version | string | Yes | Version of the event header as "#.#" |
626 | | | | where # is a digit; see section 1 for |
627 | | | | the correct digits to use. |
628 +-----------+----------+-----------+-----------------------------------------+
629 | vesEvent\ | string | Yes | Version of the ves event listener api |
630 | Listener\ | | | spec that this event is compliant with |
631 | Version | | | (as "#" or "#.#" or "#.#.#" where # is a|
632 | | | | digit; see section 1 for the correct |
633 | | | | digits to use). |
634 +-----------+----------+-----------+-----------------------------------------+
636 Datatype: internalHeaderFields
637 ++++++++++++++++++++++++++++++
639 The internalHeaderFields datatype is an undefined object which can
640 contain arbitrarily complex JSON structures. It is intended to be
641 defined separately by each service provider (e.g., AT&T) implementing
642 the VES Event Listener. The fields in internalHeaderFields are not
643 provided by any event source but instead are added by the VES Event
644 Listener service itself as part of an event enrichment process necessary
645 for efficient internal processing of events received by the VES Event
649 .. _ves_eventname_guidelines_7_2:
651 Best Practices for eventName
652 ++++++++++++++++++++++++++++
654 To prevent naming collisions, eventNames sent as part of the
655 commonEventHeader, should conform to the following naming convention
656 designed to summarize the purpose and type of the event, and to ensure
657 the uniqueness of the eventName:
659 ``{DomainAbbreviation}_{PublisherName}_{Description}``
661 Each underscore-separated subfield above should start with a capital
662 letter and use camel-casing to separate words and acronyms. Acronyms
663 should capitalize only the first letter of the acronym. Spaces and
664 underscores should not appear within any subfield.
666 The DomainAbbreviation subfield derives from the ‘domain’ field in the
667 commonEventHeader, as specified below:
669 - ‘Fault’ for the fault domain
671 - ‘Heartbeat’ for the heartbeat domain
673 - ‘Measurement’ for the measurement domain
675 - ‘MobileFlow’ for the mobileFlow domain
677 - ‘Notification’ for the notification domain
679 - ‘Other’ for the other domain
681 - ‘Perf3gpp’ for the perf3gpp domain
683 - ‘PnfReg’ for the pnfRegistration domain
685 - ‘SipSignaling’ for the sipSignaling domain
687 - ‘StateChange’ for the stateChange domain
689 - ‘StndDefined’ for the stndDefined domain
691 - ‘Syslog’ for the syslog domain
693 - ‘Tca’ for the thresholdCrossingAlert domain
695 - ‘VoiceQuality’ for the voiceQuality domain
697 The PublisherName subfield describes the vendor product or application
698 publishing the event. This subfield conforms to the following
701 - Vendor products are specified as: ``{productName}-{vendorName}``
703 For example: ``Visbc-Metaswitch`` or ``Vdbe-Juniper``, where a hyphen is
704 used to separate the ``productName`` and ``vendorName`` subfields. Note that
705 the ``productName`` and ``vendorName`` subfields must not include hyphens
708 Organizing the information in this way will cause an alphabetical
709 listing of eventNames to sort similar network functions together,
710 rather than to sort them by vendor.
712 The ``productName`` subfield may describe a NF or a NFC. Where NFC names
713 may be reused across different NF’s, they should be specified as:
715 ``{NfName}:{NfcName}``
717 where a colon is used to separate the ``NfName`` and ``NfcName`` subfields.
718 Note that the ``NfName`` and ``NfcName`` subfields must not include colons
721 The ``productName`` may also describe other types of vendor modules or
722 components such as a VM, application or hostname. As with NFs and
723 NFCs, parent:child relationships may be communicated using colon as
724 a subfield delimiter.
726 - Service providers who adopt the VES Common Event Format for internal
727 use, may provide PublisherName without the vendorName subfield. They
728 would typically identify an application, system, service or
729 microservice publishing the event (e.g., ‘Policy’, ‘So’,
730 ‘MobileCallRecording’ or ‘Dkat’). As with NFs and NFCs, parent:child
731 relationships may be communicated using colon as a subfield delimiter
732 (e.g., ApplicationName:ApplicationComponent).
734 The final subfield of the eventName name should describe, in a compact
735 camel case format the specific information being conveyed by the event.
736 In some cases, this final subfield may not be required (e.g., in the
737 case of certain heartbeats).
739 Examples of event names following the naming standards are provided
742 - ``Tca_Vdbe-Ericsson_CpuThresholdExceeded``
744 - ``Heartbeat_Visbc:Mmc-Metaswitch``
746 - ``Syslog_Vdbe-Ericsson``
748 - ``Fault_MobileCallRecording_PilotNumberPoolExhaustion``
750 - ``Other_So:WanBonding_InstantiationPart1Complete``
752 .. _ves_eventid_usecases_7_2:
754 EventId Use Cases Examples
755 ++++++++++++++++++++++++++
757 ``eventId`` Examples:
759 **NOTE**: Please note, the following are only *examples*, and other formats
760 can be used provided they meet the requirement that the ``eventId`` is unique
761 for all events or unique fault occurrence.
763 **Example 1**: assumes a unique key for each domain consisting of domain
764 followed by an integer domain<n> or domainId<n>, where <n> is a positive integer,
765 e.g. fault000001, heartbeat000001, measurement000005,
766 notification3gppPerfFileReady0005
768 **Example 2**: assumes a unique integer key for all events across all domains
769 <n>: 000000001, 00000002, 000000003
773 1. All domains except Fault: each time a subsequent event is sent the
774 integer part of eventId will increment by 1. Repeat of eventId
775 assumes duplicate event. Sequence number is set to 0 for all domains
778 2. eventId construction for Fault Events:
780 a. Most likely scenario
782 * The sourceName on each Fault event is the NF Instance Name
783 (pnf-name or vnf-name or vm-name) as entered in A&AI uniquely
784 identifying this instance of the NF.
786 * The eventId on Fault events is the same every time a given
787 fault is raised (including onset and re-raise)
789 1. The startEpochMicrosec value for the Fault event is the
790 timestamp for when the fault onset occurs. Subsequent
791 events for the same fault will keep the same startEpochMicrosec
794 2. lastEpochMicrosec indicates the current event time. This value
795 will be updated for each subsequent event for a given fault.
797 3. The sequence number for each Fault event is set to 1 when the
798 fault is raised and increments each time the same
799 fault event is raised, until a clear is sent.
801 * After the fault is cleared, a new eventId is used.
803 .. image:: Use-Case-1.png
805 b. **Alternative Scenario**: Network Function When Fault Event Status is Not
808 * The sourceName on each Fault event is the NF Instance Name
809 (pnf-name or vnf-name or vm-name) as entered in A&AI uniquely
810 identifying this instance of the NF.
812 * The eventId on Fault events is the same every time a given
813 fault is raised or cleared, even if it is re-raised after it
814 had previously cleared. So, for example, if EMS loses
815 contact with a particular device then a Fault event might be
816 sent for a raise, re-raise (because EMS has re-tried and
817 still can’t contact the device), clear (because EMS has
818 re-tried and it can contact the device) and then raise again
819 (because EMS has lost contact with the device again). The
820 same eventId is used for all 4 of those Fault events.
822 * The startEpochMicrosec value for each Fault event is the
823 timestamp for when that event is generated, not when the
824 fault first occurred. So all 4 of the Fault events in the
825 previous bullet point would have a different timestamp.
827 * lastEpochMicrosec indicates the current event time.
829 * The sequence number for each Fault event is currently set to
830 0 on a raise and 1 on a clear. We could change that so that
831 each Fault event is given a new monotonically increasing
832 sequence number whether it is a raise or a clear if that is
833 helpful (which is reset to 0 if the VM restarts) but they
834 won’t be consecutive.
836 * Normally, a clear is expected for each fault to be sent from a
837 network function. However a few fault notification types will never
838 be re-raised or cleared. In this case, general rules for VES events
839 shall be followed with a new eventId for each event and sequence
842 .. image:: Use-Case-2.png
844 **Example 3**: Exceptions from eventId uniqueness requirement:
845 In certain scenarios such as restarts, the xNF might be unable to assure eventId
846 uniqueness as information about the latest used eventID value might not have been
847 persisted. When such eventId information is unavailable, the xNF should reset the
848 eventID numbering following the :ref:`ves_eventid_usecases_7_2`.
850 Technology Independent Datatypes
851 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
853 ‘Fault’ Domain Datatypes
854 ++++++++++++++++++++++++
856 Datatype: faultFields
857 *********************
859 The faultFields datatype consists of the following fields:
861 +-----------------+---------+-----------+-------------------------------------+
862 | Field | Type | Required? | Description |
863 +=================+=========+===========+=====================================+
864 | alarmAdditional | hashMap | No | Additional alarm information. |
865 | Information | | | |
867 | | | | - Note1: for SNMP mapping to VES, |
868 | | | | for hash key use OID of varbind, |
869 | | | | for value use incoming data for |
870 | | | | that varbind). |
872 | | | | - Note2: Alarm ID for 3GPP should be|
873 | | | | included (if applicable) in |
874 | | | | alarmAdditonalInformation as |
875 | | | | ‘alarmId’:’alarmIdValue’. |
877 | | | | Could contain managed object |
878 | | | | instance as separate key:value; |
879 | | | | could add probable cause as separate|
881 +-----------------+---------+-----------+-------------------------------------+
882 | alarmCondition | string | Yes | Short name of the alarm |
883 | | | | condition/problem, such as a trap |
884 | | | | name. Should not have white space |
885 | | | | (e.g., tpLgCgiNotInConfig, |
886 | | | | BfdSessionDown, linkDown, etc…) |
887 +-----------------+---------+-----------+-------------------------------------+
888 | alarmInterfaceA | string | No | Card, port, channel or interface |
889 | | | | name of the device generating the |
890 | | | | alarm. This could reflect managed |
892 +-----------------+---------+-----------+-------------------------------------+
893 | eventCategory | string | No | Event category, for example: |
894 | | | | ‘license’, ‘link’, ‘routing’, |
895 | | | | ‘security’, ‘signaling’ |
896 +-----------------+---------+-----------+-------------------------------------+
897 | eventSeverity | string | Yes | Event severity enumeration: |
898 | | | | ‘CRITICAL’, ‘MAJOR’, ‘MINOR’, |
899 | | | | ‘WARNING’, ‘NORMAL’. NORMAL is used |
900 | | | | to represent clear. |
901 +-----------------+---------+-----------+-------------------------------------+
902 | eventSourceType | string | Yes | Examples: ‘card’, ‘host’, ‘other’, |
903 | | | | ‘port’, ‘portThreshold’, ‘router’, |
904 | | | | ‘slotThreshold’, ‘switch’, |
905 | | | | ‘virtualMachine’, |
906 | | | | ‘virtualNetworkFunction’. This could|
907 | | | | be managed object class. |
908 +-----------------+---------+-----------+-------------------------------------+
909 | faultFields\ | string | Yes | Version of the faultFields block as |
910 | Version | | | "#.#" where # is a digit; see |
911 | | | | section 1 for the correct digits to |
913 +-----------------+---------+-----------+-------------------------------------+
914 | specificProblem | string | Yes | Description of the alarm or problem |
915 | | | | (e.g., ‘eNodeB 155197 in PLMN |
916 | | | | 310-410 with eNodeB name KYL05197 is|
917 | | | | lost’). 3GPP probable cause would be|
918 | | | | included in this field. |
919 +-----------------+---------+-----------+-------------------------------------+
920 | vfStatus | string | Yes | Virtual function status enumeration:|
921 | | | | ‘Active’, ‘Idle’, ‘Preparing to |
922 | | | | terminate’, ‘Ready to terminate’, |
923 | | | | ‘Requesting Termination’ |
924 +-----------------+---------+-----------+-------------------------------------+
926 Heartbeat’ Domain Datatypes
927 +++++++++++++++++++++++++++
929 Datatype: heartbeatFields
930 *************************
932 The heartbeatFields datatype is an optional field block for fields
933 specific to heartbeat events; it consists of the following fields:
935 +---------------+---------+-----------+---------------------------------------+
936 | Field | Type | Required? | Description |
937 +===============+=========+===========+=======================================+
938 | additional\ | hashMap | No | Additional expansion fields if needed |
940 +---------------+---------+-----------+---------------------------------------+
941 | heartbeat\ | string | Yes | Version of the heartbeatFields block |
942 | FieldsVersion | | | as "#.#" where # is a digit; see |
943 | | | | section 1 for the correct digits to |
945 +---------------+---------+-----------+---------------------------------------+
946 | heartbeat\ | Integer | Yes | Current heartbeatInterval in seconds |
948 +---------------+---------+-----------+---------------------------------------+
950 ‘Measurements’ Domain Datatypes
951 +++++++++++++++++++++++++++++++
953 Note: NFs are required to report exactly one Measurement event per
954 period per sourceName.
956 Datatype: codecsInUse
957 *********************
959 The codecsInUse datatype consists of the following fields describing the
960 number of times an identified codec was used over the
963 +------------------+-----------+----------+--------------------------------+
964 | Field | Type | Required?| Description |
965 +==================+===========+==========+================================+
966 | codecIdentifer | string | Yes | Description of the codec |
967 +------------------+-----------+----------+--------------------------------+
968 | numberInUse | integer | Yes | Number of such codecs in use |
969 +------------------+-----------+----------+--------------------------------+
974 The cpuUsage datatype defines the usage of an identifier CPU and
975 consists of the following fields:
977 +------------+--------+-----------+-------------------------------------------+
978 | Field | Type | Required? | Description |
979 +============+========+===========+===========================================+
980 | cpu\ | number | No | The amount of time the CPU cannot run due |
981 | Capacity\ | | | to contention, in milliseconds over the |
982 | Contention | | | measurementInterval |
983 +------------+--------+-----------+-------------------------------------------+
984 | cpu\ | number | No | The total CPU time that the NF/NFC/VM |
985 | Demand\ | | | could use if there was no contention, in |
986 | Avg | | | milliseconds over the measurementInterval |
987 +------------+--------+-----------+-------------------------------------------+
988 | cpu\ | number | No | CPU demand in MHz |
991 +------------+--------+-----------+-------------------------------------------+
992 | cpu\ | number | No | CPU demand as a percentage of the |
993 | Demand\ | | | provisioned capacity |
995 +------------+--------+-----------+-------------------------------------------+
996 | cpu\ | string | Yes | CPU Identifier |
998 +------------+--------+-----------+-------------------------------------------+
999 | cpu\ | number | No | Percentage of CPU time spent in the idle |
1001 +------------+--------+-----------+-------------------------------------------+
1002 | cpu\ | number | No | Percentage of time the VM is unable to run|
1003 | Latency\ | | | because it is contending for access to the|
1004 | Avg | | | physical CPUs |
1005 +------------+--------+-----------+-------------------------------------------+
1006 | cpu\ | number | No | The overhead demand above available |
1007 | Overhead\ | | | allocations and reservations, in |
1008 | Avg | | | milliseconds over the measurementInterval |
1009 +------------+--------+-----------+-------------------------------------------+
1010 | cpuSwap\ | number | No | Swap wait time, in milliseconds over the |
1011 | WaitTime | | | measurementInterval |
1012 +------------+--------+-----------+-------------------------------------------+
1013 | cpuUsage\ | number | No | Percentage of time spent servicing |
1014 | Interrupt | | | interrupts |
1015 +------------+--------+-----------+-------------------------------------------+
1016 | cpuUsage\ | number | No | Percentage of time spent running user |
1017 | Nice | | | space processes that have been niced |
1018 +------------+--------+-----------+-------------------------------------------+
1019 | cpuUsage\ | number | No | Percentage of time spent handling soft irq|
1020 | SoftIrq | | | interrupts |
1021 +------------+--------+-----------+-------------------------------------------+
1022 | cpuUsage\ | number | No | Percentage of time spent in involuntary |
1023 | Steal | | | wait which is neither user, system or idle|
1024 | | | | time and is effectively time that went |
1026 +------------+--------+-----------+-------------------------------------------+
1027 | cpuUsage\ | number | No | Percentage of time spent on system tasks |
1028 | System | | | running the kernel |
1029 +------------+--------+-----------+-------------------------------------------+
1030 | cpuUsage\ | number | No | Percentage of time spent running un-niced |
1031 | User | | | user space processes |
1032 +------------+--------+-----------+-------------------------------------------+
1033 | cpuWait | number | No | Percentage of CPU time spent waiting for |
1034 | | | | I/O operations to complete |
1035 +------------+--------+-----------+-------------------------------------------+
1036 | percent\ | number | Yes | Aggregate cpu usage of the virtual machine|
1037 | Usage | | | on which the xNFC reporting the event is |
1039 +------------+--------+-----------+-------------------------------------------+
1044 The diskUsage datatype defines the usage of a disk and consists of the
1047 +-------------+-------+----------+--------------------------------------------+
1048 | Field | Type | Required?| Description |
1049 +=============+=======+==========+============================================+
1050 | diskBus\ | number| No | Number of bus resets over the |
1051 | Resets | | | measurementInterval |
1052 +-------------+-------+----------+--------------------------------------------+
1053 | disk\ | number| No | Number of disk commands aborted over the |
1054 | Commands\ | | | measurementInterval |
1056 +-------------+-------+----------+--------------------------------------------+
1057 | disk\ | number| No | Average number of commands per second over |
1058 | CommandsAvg | | | the measurementInterval |
1059 +-------------+-------+----------+--------------------------------------------+
1060 | diskFlush\ | number| No | Total flush requests of the disk cache over|
1061 | Requests | | | the measurementInterval |
1062 +-------------+-------+----------+--------------------------------------------+
1063 | diskFlush\ | number| No | Milliseconds spent on disk cache flushing |
1064 | Time | | | over the measurementInterval |
1065 +-------------+-------+----------+--------------------------------------------+
1066 | disk\ | string| Yes | Disk Identifier |
1067 | Identifier | | | |
1068 +-------------+-------+----------+--------------------------------------------+
1069 | diskIo\ | number| No | Milliseconds spent doing input/output |
1070 | TimeAvg | | | operations over 1 sec; treat this metric as|
1071 | | | | a device load percentage where 1000ms |
1072 | | | | matches 100% load; provide the average over|
1073 | | | | the measurement interval |
1074 +-------------+-------+----------+--------------------------------------------+
1075 | diskIoTime\ | number| No | Milliseconds spent doing input/output |
1076 | Last | | | operations over 1 sec; treat this metric as|
1077 | | | | a device load percentage where 1000ms |
1078 | | | | matches 100% load; provide the last value |
1079 | | | | measurement within the measurement interval|
1080 +-------------+-------+----------+--------------------------------------------+
1081 | diskIo\ | number| No | Milliseconds spent doing input/output |
1082 | TimeMax | | | operations over 1 sec; treat this metric as|
1083 | | | | a device load percentage where 1000ms |
1084 | | | | matches 100% load; provide the maximum |
1085 | | | | value measurement within the measurement |
1087 +-------------+-------+----------+--------------------------------------------+
1088 | diskIo\ | number| No | Milliseconds spent doing input/output |
1089 | TimeMin | | | operations over 1 sec; treat this metric as|
1090 | | | | a device load percentage where 1000ms |
1091 | | | | matches 100% load; provide the minimum |
1092 | | | | value measurement within the measurement |
1094 +-------------+-------+----------+--------------------------------------------+
1095 | diskMerged\ | number| No | Number of logical read operations that were|
1096 | ReadAvg | | | merged into physical read operations, e.g.,|
1097 | | | | two logical reads were served by one |
1098 | | | | physical disk access; provide the average |
1099 | | | | measurement within the measurement interval|
1100 +-------------+-------+----------+--------------------------------------------+
1101 | diskMerged\ | number| No | Number of logical read operations that were|
1102 | ReadLast | | | merged into physical read operations, e.g.,|
1103 | | | | two logical reads were served by one |
1104 | | | | physical disk access; provide the last |
1105 | | | | value measurement within the measurement |
1107 +-------------+-------+----------+--------------------------------------------+
1108 | diskMerged\ | number| No | Number of logical read operations that were|
1109 | ReadMax | | | merged into physical read operations, e.g.,|
1110 | | | | two logical reads were served by one |
1111 | | | | physical disk access; provide the maximum |
1112 | | | | value measurement within the measurement |
1114 +-------------+-------+----------+--------------------------------------------+
1115 | diskMerged\ | number| No | Number of logical read operations that were|
1116 | ReadMin | | | merged into physical read operations, e.g.,|
1117 | | | | two logical reads were served by one |
1118 | | | | physical disk access; provide the minimum |
1119 | | | | value measurement within the measurement |
1121 +-------------+-------+----------+--------------------------------------------+
1122 | diskMerged\ | number| No | Number of logical write operations that |
1123 | WriteAvg | | | were merged into physical write operations,|
1124 | | | | e.g., two logical writes were served by one|
1125 | | | | physical disk access; provide the average |
1126 | | | | measurement within the measurement interval|
1127 +-------------+-------+----------+--------------------------------------------+
1128 | diskMerged\ | number| No | Number of logical write operations that |
1129 | WriteLast | | | were merged into physical write operations,|
1130 | | | | e.g., two logical writes were served by one|
1131 | | | | physical disk access; provide the last |
1132 | | | | value measurement within the measurement |
1134 +-------------+-------+----------+--------------------------------------------+
1135 | diskMerged\ | number| No | Number of logical write operations that |
1136 | WriteMax | | | were merged into physical write operations,|
1137 | | | | e.g., two logical writes were served by one|
1138 | | | | physical disk access; provide the maximum |
1139 | | | | value measurement within the measurement |
1141 +-------------+-------+----------+--------------------------------------------+
1142 | diskMerged\ | number| No | Number of logical write operations that |
1143 | WriteMin | | | were merged into physical write operations,|
1144 | | | | e.g., two logical writes were served by one|
1145 | | | | physical disk access; provide the minimum |
1146 | | | | value measurement within the measurement |
1148 +-------------+-------+----------+--------------------------------------------+
1149 | diskOctets\ | number| No | Number of octets per second read from a |
1150 | Read Avg | | | disk or partition; provide the average |
1151 | | | | measurement within the measurement interval|
1152 +-------------+-------+----------+--------------------------------------------+
1153 | diskOctets\ | number| No | Number of octets per second read from a |
1154 | Read | | | disk or partition; provide the last |
1155 | | | | measurement within the measurement interval|
1157 +-------------+-------+----------+--------------------------------------------+
1158 | diskOctets\ | number| No | Number of octets per second read from a |
1159 | Read Max | | | disk or partition; provide the maximum |
1160 | | | | measurement within the measurement interval|
1161 +-------------+-------+----------+--------------------------------------------+
1162 | diskOctets\ | number| No | Number of octets per second read from a |
1163 | Read Min | | | disk or partition; provide the minimum |
1164 | | | | measurement within the measurement interval|
1165 +-------------+-------+----------+--------------------------------------------+
1166 | diskOctets\ | number| No | Number of octets per second written to a |
1167 | Write Avg | | | disk or partition; provide the average |
1168 | | | | measurement within the measurement interval|
1169 +-------------+-------+----------+--------------------------------------------+
1170 | diskOctets\ | number| No | Number of octets per second written to a |
1171 | Write Last | | | disk or partition; provide the last |
1172 | | | | measurement within the measurement interval|
1173 +-------------+-------+----------+--------------------------------------------+
1174 | diskOctets\ | number| No | Number of octets per second written to a |
1175 | WriteMax | | | disk or partition; provide the maximum |
1176 | | | | measurement within the measurement interval|
1177 +-------------+-------+----------+--------------------------------------------+
1178 | diskOctets\ | number| No | Number of octets per second written to a |
1179 | WriteMin | | | disk or partition; provide the minimum |
1180 | | | | measurement within the measurement interval|
1181 +-------------+-------+----------+--------------------------------------------+
1182 | diskOps\ | number| No | Number of read operations per second issued|
1183 | ReadAvg | | | to the disk; provide the average |
1184 | | | | measurement within the measurement interval|
1185 +-------------+-------+----------+--------------------------------------------+
1186 | diskOps\ | number| No | Number of read operations per second issued|
1187 | ReadLast | | | to the disk; provide the last measurement |
1188 | | | | within the measurement interval |
1189 +-------------+-------+----------+--------------------------------------------+
1190 | diskOps\ | number| No | Number of read operations per second issued|
1191 | ReadMax | | | to the disk; provide the maximum |
1192 | | | | measurement within the measurement interval|
1193 +-------------+-------+----------+--------------------------------------------+
1194 | diskOps\ | number| No | Number of read operations per second issued|
1195 | ReadMin | | | to the disk; provide the minimum |
1196 | | | | measurement within the measurement interval|
1197 +-------------+-------+----------+--------------------------------------------+
1198 | diskOps\ | number| No | Number of write operations per second |
1199 | WriteAvg | | | issued to the disk; provide the average |
1200 | | | | measurement within the measurement interval|
1201 +-------------+-------+----------+--------------------------------------------+
1202 | diskOps\ | number| No | Number of write operations per second |
1203 | WriteLast | | | issued to the disk; provide the last |
1204 | | | | measurement within the measurement interval|
1205 +-------------+-------+----------+--------------------------------------------+
1206 | diskOps\ | number| No | Number of write operations per second |
1207 | Write Max | | | issued to the disk; provide the maximum |
1208 | | | | measurement within the measurement interval|
1209 +-------------+-------+----------+--------------------------------------------+
1210 | diskOps\ | number| No | Number of write operations per second |
1211 | WriteMin | | | issued to the disk; provide the minimum |
1212 | | | | measurement within the measurement interval|
1213 +-------------+-------+----------+--------------------------------------------+
1214 | diskPending\| number| No | Queue size of pending I/O operations per |
1215 | Operations\ | | | second; provide the average measurement |
1216 | Avg | | | within the measurement interval |
1217 +-------------+-------+----------+--------------------------------------------+
1218 | diskPending\| number| No | Queue size of pending I/O operations per |
1219 | Operations\ | | | second; provide the last measurement within|
1220 | Last | | | the measurement interval |
1221 +-------------+-------+----------+--------------------------------------------+
1222 | diskPending\| number| No | Queue size of pending I/O operations per |
1223 | Operations\ | | | second; provide the maximum measurement |
1224 | Max | | | within the measurement interval |
1225 +-------------+-------+----------+--------------------------------------------+
1226 | diskPending\| number| No | Queue size of pending I/O operations per |
1227 | Operations\ | | | second; provide the minimum measurement |
1228 | Min | | | within the measurement interval |
1229 +-------------+-------+----------+--------------------------------------------+
1230 | diskRead\ | number| No | Average number of read commands issued per |
1231 | CommandsAvg | | | second to the disk over the |
1232 | | | | measurementInterval |
1233 +-------------+-------+----------+--------------------------------------------+
1234 | diskTime | number| No | Nanoseconds spent on disk cache |
1235 | | | | reads/writes within the measurement |
1237 +-------------+-------+----------+--------------------------------------------+
1238 | diskTime\ | number| No | Milliseconds a read operation took to |
1239 | ReadAvg | | | complete; provide the average measurement |
1240 | | | | within the measurement interval |
1241 +-------------+-------+----------+--------------------------------------------+
1242 | diskTime\ | number| No | Milliseconds a read operation took to |
1243 | Read Last | | | complete; provide the last measurement |
1244 | | | | within the measurement interval |
1245 +-------------+-------+----------+--------------------------------------------+
1246 | diskTime\ | number| No | Milliseconds a read operation took to |
1247 | Read Max | | | complete; provide the maximum measurement |
1248 | | | | within the measurement interval |
1249 +-------------+-------+----------+--------------------------------------------+
1250 | diskTime\ | number| No | Milliseconds a read operation took to |
1251 | Read Min | | | complete; provide the minimum measurement |
1252 | | | | within the measurement interval |
1253 +-------------+-------+----------+--------------------------------------------+
1254 | diskTime\ | number| No | Milliseconds a write operation took to |
1255 | Write Avg | | | complete; provide the average measurement |
1256 | | | | within the measurement interval |
1257 +-------------+-------+----------+--------------------------------------------+
1258 | diskTime\ | number| No | Milliseconds a write operation took to |
1259 | Write Last | | | complete; provide the last measurement |
1260 | | | | within the measurement interval |
1261 +-------------+-------+----------+--------------------------------------------+
1262 | diskTime\ | number| No | Milliseconds a write operation took to |
1263 | Write Max | | | complete; provide the maximum measurement |
1264 | | | | within the measurement interval |
1265 +-------------+-------+----------+--------------------------------------------+
1266 | diskTime\ | number| No | Milliseconds a write operation took to |
1267 | Write Min | | | complete; provide the minimum measurement |
1268 | | | | within the measurement interval |
1269 +-------------+-------+----------+--------------------------------------------+
1270 | diskTotal\ | number| No | Average read time from the perspective of a|
1271 | ReadLatency\| | | Guest OS: sum of the Kernel Read Latency |
1272 | Avg | | | and Physical Device Read Latency in |
1273 | | | | milliseconds over the measurement interval |
1274 +-------------+-------+----------+--------------------------------------------+
1275 | diskTotal\ | number| No | Average write time from the perspective of |
1276 | Write\ | | | a Guest OS: sum of the Kernel Write Latency|
1277 | LatencyAvg | | | and Physical Device Write Latency in |
1278 | | | | milliseconds over the measurement interval |
1279 +-------------+-------+----------+--------------------------------------------+
1280 | disk\ | number| No | Measure in ms over 1 sec of both I/O |
1281 | WeightedIo\ | | | completion time and the backlog that may be|
1282 | TimeAvg | | | accumulating. Value is the average within |
1283 | | | | the collection interval. |
1284 +-------------+-------+----------+--------------------------------------------+
1285 | disk\ | number| No | Measure in ms over 1 sec of both I/O |
1286 | WeightedIo\ | | | completion time and the backlog that may be|
1287 | TimeLast | | | accumulating. Value is the last within the |
1288 | | | | collection interval. |
1289 +-------------+-------+----------+--------------------------------------------+
1290 | disk\ | number| No | Measure in ms over 1 sec of both I/O |
1291 | WeightedIo\ | | | completion time and the backlog that may be|
1292 | TimeMax | | | accumulating. Value is the maximum within |
1293 | | | | the collection interval. |
1294 +-------------+-------+----------+--------------------------------------------+
1295 | disk\ | number| No | Measure in ms over 1 sec of both I/O |
1296 | WeightedIo\ | | | completion time and the backlog that may be|
1297 | TimeMin | | | accumulating. Value is the minimum within |
1298 | | | | the collection interval. |
1299 +-------------+-------+----------+--------------------------------------------+
1300 | diskWrite\ | number| No | Average number of write commands issued per|
1301 | CommandsAvg | | | second to the disk over the |
1302 | | | | measurementInterval |
1303 +-------------+-------+----------+--------------------------------------------+
1305 Datatype: filesystemUsage
1306 *************************
1308 The filesystemUsage datatype consists of the following fields:
1310 +-------------+--------+-----------+------------------------------------------+
1311 | Field | Type | Required? | Description |
1312 +=============+========+===========+==========================================+
1313 | filesystem\ | string | Yes | File system name |
1315 +-------------+--------+-----------+------------------------------------------+
1316 | block\ | number | Yes | Configured block storage capacity in GB |
1317 | Configured | | | |
1318 +-------------+--------+-----------+------------------------------------------+
1319 | blockIops | number | Yes | Block storage input-output operations per|
1321 +-------------+--------+-----------+------------------------------------------+
1322 | blockUsed | number | Yes | Used block storage capacity in GB |
1323 +-------------+--------+-----------+------------------------------------------+
1324 | ephemeral\ | number | Yes | Configured ephemeral storage capacity in |
1325 | Configured | | | GB |
1326 +-------------+--------+-----------+------------------------------------------+
1327 | ephemeral\ | number | Yes | Ephemeral storage input-output operations|
1328 | Iops | | | per second |
1329 +-------------+--------+-----------+------------------------------------------+
1330 | ephemeral\ | number | Yes | Used ephemeral storage capacity in GB |
1332 +-------------+--------+-----------+------------------------------------------+
1337 The hugePages datatype provides metrics on system hugePages; it consists
1338 of the following fields:
1340 +--------------------+--------+----------+------------------------------------+
1341 | Field | Type | Required?| Description |
1342 +====================+========+==========+====================================+
1343 | bytesFree | number | No | Number of free hugePages in bytes |
1344 +--------------------+--------+----------+------------------------------------+
1345 | bytesUsed | number | No | Number of used hugePages in bytes |
1346 +--------------------+--------+----------+------------------------------------+
1347 | hugePagesIdentifier| string | Yes | HugePages identifier |
1348 +--------------------+--------+----------+------------------------------------+
1349 | percentFree | number | No | Number of free hugePages in percent|
1350 +--------------------+--------+----------+------------------------------------+
1351 | percentUsed | number | No | Number of used hugePages in percent|
1352 +--------------------+--------+----------+------------------------------------+
1353 | vmPageNumberFree | number | No | Number of free vmPages in numbers |
1354 +--------------------+--------+----------+------------------------------------+
1355 | vmPageNumberUsed | number | No | Number of used vmPages in numbers |
1356 +--------------------+--------+----------+------------------------------------+
1358 Datatype: ipmi (Intelligent Platform Management Interface)
1359 **********************************************************
1361 The ipmi datatype provides intelligent platform management interface
1362 metrics; it consists of the following fields:
1364 +-------------+---------------------+-----------+-----------------------------+
1365 | Field | Type | Required? | Description |
1366 +=============+=====================+===========+=============================+
1367 | exitAir\ | number | No | System fan exit air flow |
1368 | Temperature | | | temperature in Celsius |
1369 +-------------+---------------------+-----------+-----------------------------+
1370 | frontPanel\ | number | No | Front panel temp in Celsius |
1371 | Temperature | | | |
1372 +-------------+---------------------+-----------+-----------------------------+
1373 | ioModule\ | number | No | Io module temp in Celsius |
1374 | Temperature | | | |
1375 +-------------+---------------------+-----------+-----------------------------+
1376 | ipmi\ | ipmiBaseboard | No | Array of ipmiBaseboard |
1377 | Baseboard\ | Temperature [ ] | | Temperature objects |
1378 | Temperature\| | | |
1380 +-------------+---------------------+-----------+-----------------------------+
1381 | ipmi\ | ipmiBaseboard | No | Array of ipmiBaseboard |
1382 | Baseboard\ | VoltageRegulator [ ]| | VoltageRegulator objects |
1386 +-------------+---------------------+-----------+-----------------------------+
1387 | ipmiBattery\| ipmiBattery [ ] | No | Array of ipmiBattery objects|
1389 +-------------+---------------------+-----------+-----------------------------+
1390 | ipmiFanArray| ipmiFan [ ] | No | Array of ipmiFan objects |
1391 +-------------+---------------------+-----------+-----------------------------+
1392 | ipmiGlobal\ | ipmiGlobalAggregate\| No | ipmi global aggregate |
1393 | Aggregate\ | TemperatureMargin []| | temperature margin |
1394 | Temperature\| | | |
1395 | MarginArray | | | |
1396 +-------------+---------------------+-----------+-----------------------------+
1397 | ipmiHsbp\ | ipmiHsbp [ ] | No | Array of ipmiHsbp objects |
1399 +-------------+---------------------+-----------+-----------------------------+
1400 | ipmiNicArray| ipmiNic [ ] | No | Array of ipmiNic objects |
1401 +-------------+---------------------+-----------+-----------------------------+
1402 | ipmiPower\ | ipmiPowerSupply [ ] | No | Array of ipmiPowerSupply |
1403 | SupplyArray | | | objects |
1404 +-------------+---------------------+-----------+-----------------------------+
1405 | ipmi\ | ipmiProcessor [ ] | No | Array of ipmiProcessor |
1406 | Processor\ | | | objects |
1408 +-------------+---------------------+-----------+-----------------------------+
1409 | system\ | number | No | Airflow in cubic feet per |
1410 | Airflow | | | minute (cfm) |
1411 +-------------+---------------------+-----------+-----------------------------+
1413 Datatype: ipmiBaseboardTemperature
1414 **********************************
1416 The ipmiBaseboardTemperature datatype consists of the following fields
1417 which describe ipmi baseboard temperature metrics:
1419 +-------------+--------+-----------+------------------------------------------+
1420 | Field | Type | Required? | Description |
1421 +=============+========+===========+==========================================+
1422 | baseboard\ | number | No | Baseboard temperature in celsius |
1423 | Temperature | | | |
1424 +-------------+--------+-----------+------------------------------------------+
1425 | baseboard\ | string | Yes | Identifier for the location where the |
1426 | Temperature\| | | temperature is taken |
1427 | Identifier | | | |
1428 +-------------+--------+-----------+------------------------------------------+
1430 Datatype: ipmiBaseboardVoltageRegulator
1431 ***************************************
1433 The ipmiBaseboardVoltageRegulator datatype consists of the following
1434 fields which describe ipmi baseboard voltage regulator metrics:
1436 +--------------------+-------+----------+-------------------------------------+
1437 | Field | Type | Required?| Description |
1438 +====================+=======+==========+=====================================+
1439 | baseboardVoltage\ | string| Yes | Identifier for the baseboard voltage|
1440 | RegulatorIdentifier| | | regulator |
1441 +--------------------+-------+----------+-------------------------------------+
1442 | voltageRegulator\ | number| No | Voltage regulator temperature in |
1443 | Temperature | | | celsius |
1444 +--------------------+-------+----------+-------------------------------------+
1446 Datatype: ipmiBattery
1447 *********************
1449 The ipmiBattery datatype consists of the following fields which describe
1450 ipmi battery metrics:
1452 +---------------------+--------+----------+------------------------------+
1453 | Field | Type | Required?| Description |
1454 +=====================+========+==========+==============================+
1455 | batteryIdentifier | string | Yes | Identifier for the battery |
1456 +---------------------+--------+----------+------------------------------+
1457 | batteryType | string | No | Type of battery |
1458 +---------------------+--------+----------+------------------------------+
1459 | batteryVoltageLevel | number | No | Battery voltage level |
1460 +---------------------+--------+----------+------------------------------+
1465 The ipmiFan datatype consists of the following fields which describe
1468 +--------------+-------+----------+-------------------------------------------+
1469 | Field | Type | Required?| Description |
1470 +==============+=======+==========+===========================================+
1471 | fanIdentifier| string| Yes | Identifier for the fan |
1472 +--------------+-------+----------+-------------------------------------------+
1473 | fanSpeed | number| No | Fan speed in revolutions per minute (rpm) |
1474 +--------------+-------+----------+-------------------------------------------+
1476 Datatype: ipmiGlobalAggregateTemperatureMargin
1477 **********************************************
1479 The ipmiGlobalAggregateTemperatureMargin datatype consists of the
1482 +-------------+-------+----------+--------------------------------------------+
1483 | Field | Type | Required?| Description |
1484 +=============+=======+==========+============================================+
1485 | global\ | number| No | Temperature margin in Celsius relative to a|
1486 | Aggregate\ | | | throttling thermal trip point |
1487 | Temperature\| | | |
1489 +-------------+-------+----------+--------------------------------------------+
1490 | global\ | string| Yes | Identifier for the ipmi global aggregate |
1491 | Aggregate\ | | | temperature margin metrics |
1492 | Temperature\| | | |
1494 | Identifier | | | |
1495 +-------------+-------+----------+--------------------------------------------+
1500 The ipmiHsbp datatype provides ipmi hot swap backplane power metrics; it
1501 consists of the following fields:
1503 +------------+-------+----------+---------------------------------------------+
1504 | Field | Type | Required?| Description |
1505 +============+=======+==========+=============================================+
1506 | hsbp\ | string| Yes | Identifier for the hot swap backplane power |
1507 | Identifier | | | unit |
1508 +------------+-------+----------+---------------------------------------------+
1509 | hsbp\ | number| No | Hot swap backplane power temperature in |
1510 | Temperature| | | celsius |
1511 +------------+-------+----------+---------------------------------------------+
1516 The ipmiNic datatype provides network interface control care metrics; it
1517 consists of the following fields:
1519 +------------+-------+----------+---------------------------------------------+
1520 | Field | Type | Required?| Description |
1521 +============+=======+==========+=============================================+
1522 | nic\ | string| Yes | Identifier for the network interface control|
1523 | Identifier | | | card |
1524 +------------+-------+----------+---------------------------------------------+
1525 | nic\ | number| No | nic temperature in Celsius |
1526 | Temperature| | | |
1527 +------------+-------+----------+---------------------------------------------+
1529 Datatype: ipmiPowerSupply
1530 *************************
1532 The ipmiPowerSupply datatype provides ipmi power supply metrics; it
1533 consists of the following fields:
1535 +-----------+-------+----------+----------------------------------------------+
1536 |Field | Type | Required?| Description |
1537 +===========+=======+==========+==============================================+
1538 |power\ | number| No | Current output voltage as a percentage of the|
1539 |Supply\ | | | design specified level |
1543 +-----------+-------+----------+----------------------------------------------+
1544 |power\ | string| Yes | Identifier for the power supply |
1547 +-----------+-------+----------+----------------------------------------------+
1548 |power\ | number| No | Input power in watts |
1552 +-----------+-------+----------+----------------------------------------------+
1553 |power\ | number| No | Power supply temperature in Celsius |
1556 +-----------+-------+----------+----------------------------------------------+
1558 Datatype: ipmiProcessor
1559 ***********************
1561 The ipmiProcessor datatype provides ipmi processor metrics; it consists
1562 of the following fields:
1564 +------------+------------------+-----------+---------------------------------+
1565 | Field | Type | Required? | Description |
1566 +============+==================+===========+=================================+
1567 | processor\ | processorDimm | No | Array of processorDimmAggregate |
1568 | Dimm\ | AggregateThermal | | ThermalMargin objects |
1569 | Aggregate\ | Margin [ ] | | |
1571 | MarginArray| | | |
1572 +------------+------------------+-----------+---------------------------------+
1573 | processor\ | number | No | Front panel temperature in |
1574 | DtsThermal\| | | celsius |
1576 +------------+------------------+-----------+---------------------------------+
1577 | processor\ | string | Yes | Identifier for the power supply |
1578 | Identifier | | | |
1579 +------------+------------------+-----------+---------------------------------+
1580 | processor\ | number | No | Io module temperatue in celsius |
1584 +------------+------------------+-----------+---------------------------------+
1586 Datatype: latencyBucketMeasure
1587 ******************************
1589 The latencyBucketMeasure datatype consists of the following fields which
1590 describe the number of counts falling within a defined latency bucket:
1592 +-----------+-------+----------+----------------------------------------------+
1593 | Field | Type | Required?| Description |
1594 +===========+=======+==========+==============================================+
1595 | counts\ | number| Yes | Number of counts falling within a defined |
1596 | InThe\ | | | latency bucket |
1598 +-----------+-------+----------+----------------------------------------------+
1599 | highEnd\ | number| No | High end of bucket range (typically in ms) |
1602 +-----------+-------+----------+----------------------------------------------+
1603 | lowEndOf\ | number| No | Low end of bucket range (typically in ms) |
1606 +-----------+-------+----------+----------------------------------------------+
1611 The load datatype provides metrics on system cpu and io utilization
1612 obtained using /proc/loadavg; it consists of the following fields:
1614 +----------+-------+----------+-----------------------------------------------+
1615 | Field | Type | Required?| Description |
1616 +==========+=======+==========+===============================================+
1617 | longTerm | number| No | number of jobs in the run queue (state R, cpu |
1618 | | | | utilization) or waiting for disk I/O (state D,|
1619 | | | | io utilization) averaged over 15 minutes using|
1620 | | | | /proc/loadavg |
1621 +----------+-------+----------+-----------------------------------------------+
1622 | midTerm | number| No | number of jobs in the run queue (state R, cpu |
1623 | | | | utilization) or waiting for disk I/O (state D,|
1624 | | | | io utilization) averaged over 5 minutes using |
1625 | | | | /proc/loadavg |
1626 +----------+-------+----------+-----------------------------------------------+
1627 | shortTerm| number| No | number of jobs in the run queue (state R, cpu |
1628 | | | | utilization) or waiting for disk I/O (state D,|
1629 | | | | io utilization) averaged over 1 minute using |
1630 | | | | /proc/loadavg |
1631 +----------+-------+----------+-----------------------------------------------+
1633 Datatype: machineCheckException
1634 *******************************
1636 The machineCheckException datatype describes machine check exceptions;
1637 it consists of the following fields:
1639 +-------------+-------+----------+--------------------------------------------+
1640 | Field | Type | Required?| Description |
1641 +=============+=======+==========+============================================+
1642 | corrected\ | number| No | Total hardware errors that were corrected |
1643 | Memory\ | | | by the hardware (e.g. data corruption |
1644 | Errors | | | corrected via ECC) over the |
1645 | | | | measurementInterval. These errors do not |
1646 | | | | require immediate software actions, but are|
1647 | | | | still reported for accounting and |
1648 | | | | predictive failure analysis |
1649 +-------------+-------+----------+--------------------------------------------+
1650 | corrected\ | number| No | Total hardware errors that were corrected |
1651 | Memory\ | | | by the hardware over the last one hour |
1654 +-------------+-------+----------+--------------------------------------------+
1655 | uncorrected\| number| No | Total uncorrected hardware errors that were|
1656 | Memory\ | | | detected by the hardware (e.g., causing |
1657 | Errors | | | data corruption) over the |
1658 | | | | measurementInterval. These errors require a|
1659 | | | | software response. |
1660 +-------------+-------+----------+--------------------------------------------+
1661 | uncorrected\| number| No | Total uncorrected hardware errors that were|
1662 | Memory\ | | | detected by the hardware over the last one |
1663 | Errors | | | hour |
1665 +-------------+-------+----------+--------------------------------------------+
1666 | vm\ | string| Yes | Virtual machine identifier associated with |
1667 | Identifier | | | the machine check exception |
1668 +-------------+-------+----------+--------------------------------------------+
1670 Datatype: measurementFields
1671 ***************************
1673 The ``measurementFields`` datatype consists of the following fields:
1675 +-------------+--------------+----------+-------------------------------------+
1676 | Field | Type | Required?| Description |
1677 +=============+==============+==========+=====================================+
1678 | additional\ | hashMap | No | Additional measurement fields if |
1679 | Fields | | | needed |
1680 +-------------+--------------+----------+-------------------------------------+
1681 | additional\ | arrayOfNamed\| No | Array of named hashMap if needed |
1682 | Measurements| HashMap | | |
1683 +-------------+--------------+----------+-------------------------------------+
1684 | additional\ | arrayOf\ | No | Array of JSON objects described by |
1685 | Objects | JsonObject | | name, schema and other |
1686 | | | | meta-information, if needed |
1687 +-------------+--------------+----------+-------------------------------------+
1688 | codec\ | codecs\ | No | Array of codecs in use |
1689 | Usage\ | InUse [] | | |
1691 +-------------+--------------+----------+-------------------------------------+
1692 | concurrent\ | integer | No | Peak concurrent sessions for the VM |
1693 | Sessions | | | or xNF (depending on the context) |
1694 | | | | over the measurementInterval |
1695 +-------------+--------------+----------+-------------------------------------+
1696 | configured\ | integer | No | Depending on the context over the |
1697 | Entities | | | measurementInterval: peak total |
1698 | | | | number of users, subscribers, |
1699 | | | | devices, adjacencies, etc., for the |
1700 | | | | VM, or peak total number of |
1701 | | | | subscribers, devices, etc., for the |
1703 +-------------+--------------+----------+-------------------------------------+
1704 | cpuUsage\ | cpuUsage [] | No | Usage of an array of CPUs |
1706 +-------------+--------------+----------+-------------------------------------+
1707 | diskUsage\ | diskUsage [] | No | Usage of an array of disks |
1709 +-------------+--------------+----------+-------------------------------------+
1710 | feature\ | hashMap | No | The hashMap key should identify the |
1711 | UsageArray | | | feature, while the value defines the|
1712 | | | | number of times the identified |
1713 | | | | feature was used |
1714 +-------------+--------------+----------+-------------------------------------+
1715 | filesystem\ | filesystem\ | No | Filesystem usage of the VM on which |
1716 | UsageArray | Usage [ ] | | the xNFC reporting the event is |
1718 +-------------+--------------+----------+-------------------------------------+
1719 | hugePages\ | hugePages [ ]| No | Array of metrics on hugePages |
1721 +-------------+--------------+----------+-------------------------------------+
1722 | ipmi | ipmi | No | Intelligent platform management |
1723 | | | | interface metrics |
1724 +-------------+--------------+----------+-------------------------------------+
1725 | latency\ | latency\ | No | Array of integers representing |
1726 | Distribution| Bucket\ | | counts of requests whose latency in |
1727 | | Measure [ ] | | milliseconds falls within per-xNF |
1728 | | | | configured ranges; where latency is |
1729 | | | | the duration between a service |
1730 | | | | request and its fulfillment. |
1731 +-------------+--------------+----------+-------------------------------------+
1732 | loadArray | load [ ] | No | Array of system load metrics |
1733 +-------------+--------------+----------+-------------------------------------+
1734 | machine\ | machine\ | No | Array of machine check exceptions |
1735 | Check\ | Check\ | | |
1736 | Exception\ | Exception [ ]| | |
1738 +-------------+--------------+----------+-------------------------------------+
1739 | mean\ | number | No | Mean seconds required to respond to |
1740 | Request\ | | | each request for the VM on which the|
1741 | Latency | | | xNFC reporting the event is running |
1742 +-------------+--------------+----------+-------------------------------------+
1743 | measurement\| string | Yes | Version of the measurementFields |
1744 | Fields\ | | | block as "#.#" where # is a digit; |
1745 | Version | | | see section 1 for the correct digits|
1747 +-------------+--------------+----------+-------------------------------------+
1748 | measurement\| number | Yes | Interval over which measurements are|
1749 | Interval | | | being reported in seconds |
1750 +-------------+--------------+----------+-------------------------------------+
1751 | memoryUsage\| memory\ | No | Memory usage of an array of VMs |
1752 | Array | Usage [] | | |
1753 +-------------+--------------+----------+-------------------------------------+
1754 | nfcScaling\ | integer | No | Represents busy-ness of the network |
1755 | Metric | | | function from 0 to 100 as reported |
1756 | | | | by the nfc |
1757 +-------------+--------------+----------+-------------------------------------+
1758 | nic\ | nic\ | No | Performance metrics of an array of |
1759 | Performance\| Performance | | network interface cards |
1761 +-------------+--------------+----------+-------------------------------------+
1762 | numberOf\ | integer | No | Number of media ports in use |
1763 | MediaPorts\ | | | |
1765 +-------------+--------------+----------+-------------------------------------+
1766 | process\ | process\ | No | Array of metrics on system processes|
1767 | StatsArray | Stats [ ] | | |
1768 +-------------+--------------+----------+-------------------------------------+
1769 | request\ | number | No | Peak rate of service requests per |
1770 | Rate | | | second to the xNF over the |
1771 | | | | measurementInterval |
1772 +-------------+--------------+----------+-------------------------------------+
1775 Note on Measurement Expansion Fields
1776 """"""""""""""""""""""""""""""""""""
1778 The ``measurementFields`` data type provides fields that can be used to
1779 pass additional data with the event. These fields are listed below and
1780 referred to as expansion fields:
1782 * ``additionalFields``
1783 * ``additionalObjects``
1784 * ``additionalMeasurements``
1786 When expansion fields are used, the goal is to avoid custom development
1787 by the service provider collecting the fields, since custom development
1788 adds obvious cost, delay and resource overhead. In the domain of
1789 measurements, it is expected that a high percentage of use cases for
1790 extensible fields can be satisfied by using the ``additionalMeasurements``
1791 ``arrayOfNamedHashMap`` data structure in combination with a YAML registration
1792 file (provided at design time). The YAML registration file conveys
1793 metadata about the processing of ``additionalMeasurements``. For more
1794 information, please see the VES Event Registration specification and in
1795 particular the ``aggregationRole``, ``castTo``, and ``isHomogeneous`` keywords.
1797 Datatype: memoryUsage
1798 *********************
1800 The memoryUsage datatype defines the memory usage of a virtual machine
1801 and consists of the following fields:
1803 +-----------+-------+----------+----------------------------------------------+
1804 | Field | Type | Required?| Description |
1805 +===========+=======+==========+==============================================+
1806 | memory\ | number| No | Kibibytes of temporary storage for raw disk |
1807 | Buffered | | | blocks |
1808 +-----------+-------+----------+----------------------------------------------+
1809 | memory\ | number| No | Kibibytes of memory used for cache |
1811 +-----------+-------+----------+----------------------------------------------+
1812 | memory\ | number| No | Kibibytes of memory configured in the virtual|
1813 | Configured| | | machine on which the xNFC reporting the event|
1814 | | | | is running |
1815 +-----------+-------+----------+----------------------------------------------+
1816 | memory\ | number| No | Host demand in kibibytes |
1818 +-----------+-------+----------+----------------------------------------------+
1819 | memory\ | number| Yes | Kibibytes of physical RAM left unused by the |
1820 | Free | | | system |
1821 +-----------+-------+----------+----------------------------------------------+
1822 | memory\ | number| No | Percentage of time the VM is waiting to |
1823 | Latency\ | | | access swapped or compressed memory |
1825 +-----------+-------+----------+----------------------------------------------+
1826 | memory\ | number| No | Shared memory in kilobytes |
1829 +-----------+-------+----------+----------------------------------------------+
1830 | memory\ | number| No | The part of the slab that can be reclaimed |
1831 | SlabRecl | | | such as caches measured in kibibytes |
1832 +-----------+-------+----------+----------------------------------------------+
1833 | memory\ | number| No | The part of the slab that cannot be reclaimed|
1834 | Slab\ | | | even when lacking memory measure in kibibytes|
1836 +-----------+-------+----------+----------------------------------------------+
1837 | memory\ | number| No | Amount of memory swapped-in from host cache |
1838 | SwapIn\ | | | in kibibytes |
1840 +-----------+-------+----------+----------------------------------------------+
1841 | memory\ | number| No | Rate at which memory is swapped from disk |
1842 | SwapIn\ | | | into active memory during the interval in |
1843 | RateAvg | | | kilobytes per second |
1844 +-----------+-------+----------+----------------------------------------------+
1845 | memory\ | number| No | Amount of memory swapped-out to host cache in|
1846 | SwapOut\ | | | kibibytes |
1848 +-----------+-------+----------+----------------------------------------------+
1849 | memory\ | number| No | Rate at which memory is being swapped from |
1850 | SwapOut\ | | | active memory to disk during the current |
1851 | RateAvg | | | interval in kilobytes per second |
1852 +-----------+-------+----------+----------------------------------------------+
1853 | memory\ | number| No | Space used for caching swapped pages in the |
1854 | Swap\ | | | host cache in kibibytes |
1856 +-----------+-------+----------+----------------------------------------------+
1857 | memory\ | number| Yes | Total memory minus the sum of free, buffered,|
1858 | Used | | | cached and slab memory measured in kibibytes |
1859 +-----------+-------+----------+----------------------------------------------+
1860 | percent\ | number| No | Percentage of memory usage; value = |
1861 | Memory\ | | | (memoryUsed / (memoryUsed + memoryFree) x 100|
1862 | Usage | | | if denomintor is nonzero, or 0, if otherwise.|
1863 +-----------+-------+----------+----------------------------------------------+
1864 | vm\ | string| Yes | Virtual Machine identifier associated with |
1865 | Identifier| | | the memory metrics |
1866 +-----------+-------+----------+----------------------------------------------+
1868 Datatype: nicPerformance
1869 ************************
1871 The nicPerformance datatype consists of the following fields which
1872 describe the performance and errors of an of an identified virtual
1873 network interface card:
1875 +----------------+-------+----------+-----------------------------------------+
1876 | Field | Type | Required?| Description |
1877 +================+=======+==========+=========================================+
1878 | administrative\| string| No | Administrative state: enum: ‘inService’,|
1879 | State | | | ‘outOfService’ |
1880 +----------------+-------+----------+-----------------------------------------+
1881 | nicIdentifier | string| Yes | Network interface card identifier |
1882 +----------------+-------+----------+-----------------------------------------+
1883 | operational\ | string| No | Operational state: enum: ‘inService’, |
1884 | State | | | ‘outOfService’ |
1885 +----------------+-------+----------+-----------------------------------------+
1886 | received\ | number| No | Cumulative count of broadcast packets |
1887 | Broadcast\ | | | received as read at the end of the |
1888 | Packets\ | | | measurement interval |
1889 | Accumulated | | | |
1890 +----------------+-------+----------+-----------------------------------------+
1891 | received\ | number| No | Count of broadcast packets received |
1892 | Broadcast\ | | | within the measurement interval |
1893 | PacketsDelta | | | |
1894 +----------------+-------+----------+-----------------------------------------+
1895 | received\ | number| No | Cumulative count of discarded packets |
1896 | Discarded\ | | | received as read at the end of the |
1897 | Packets\ | | | measurement interval |
1898 | Accumulated | | | |
1899 +----------------+-------+----------+-----------------------------------------+
1900 | received\ | number| No | Count of discarded packets received |
1901 | Discarded\ | | | within the measurement interval |
1902 | PacketsDelta | | | |
1903 +----------------+-------+----------+-----------------------------------------+
1904 | received\ | number| No | Cumulative count of error packets |
1905 | ErrorPackets\ | | | received as read at the end of the |
1906 | Accumulated | | | measurement interval |
1907 +----------------+-------+----------+-----------------------------------------+
1908 | receivedError\ | number| No | Count of error packets received within |
1909 | PacketsDelta | | | the measurement interval |
1910 +----------------+-------+----------+-----------------------------------------+
1911 | received\ | number| No | Cumulative count of multicast packets |
1912 | Multicast\ | | | received as read at the end of the |
1913 | Packets\ | | | measurement interval |
1914 | Accumulated | | | |
1915 +----------------+-------+----------+-----------------------------------------+
1916 | received\ | number| No | Count of multicast packets received |
1917 | Multicast\ | | | within the measurement interval |
1918 | PacketsDelta | | | |
1919 +----------------+-------+----------+-----------------------------------------+
1920 | received\ | number| No | Cumulative count of octets received as |
1921 | Octets\ | | | read at the end of the measurement |
1922 | Accumulated | | | interval |
1923 +----------------+-------+----------+-----------------------------------------+
1924 | received\ | number| No | Count of octets received within the |
1925 | OctetsDelta | | | measurement interval |
1926 +----------------+-------+----------+-----------------------------------------+
1927 | received\ | number| No | Percentage of discarded packets |
1928 | Percent\ | | | received; value = |
1929 | Discard | | | (receivedDiscardedPacketsDelta / |
1930 | | | | receivedTotalPacketsDelta) x 100, if |
1931 | | | | denominator is nonzero, or 0, if |
1932 | | | | otherwise. |
1933 +----------------+-------+----------+-----------------------------------------+
1934 | received\ | number| No | Percentage of error packets received; |
1935 | PercentError | | | value = (receivedErrorPacketsDelta / |
1936 | | | | receivedTotalPacketsDelta) x 100, if |
1937 | | | | denominator is nonzero, or 0, if |
1938 | | | | otherwise. |
1939 +----------------+-------+----------+-----------------------------------------+
1940 | receivedTotal\ | number| No | Cumulative count of all packets received|
1941 | Packets\ | | | as read at the end of the measurement |
1942 | Accumulated | | | interval |
1943 +----------------+-------+----------+-----------------------------------------+
1944 | receivedTotal\ | number| No | Count of all packets received within the|
1945 | PacketsDelta | | | measurement interval |
1946 +----------------+-------+----------+-----------------------------------------+
1947 | received\ | number| No | Cumulative count of unicast packets |
1948 | Unicast\ | | | received as read at the end of the |
1949 | Packets\ | | | measurement interval |
1950 | Accumulated | | | |
1951 +----------------+-------+----------+-----------------------------------------+
1952 | received\ | number| No | Count of unicast packets received within|
1953 | Unicast\ | | | the measurement interval |
1954 | PacketsDelta | | | |
1955 +----------------+-------+----------+-----------------------------------------+
1956 | received\ | number| No | Percentage of utilization received; |
1957 | Utilization | | | value = (receivedOctetsDelta / (speed x |
1958 | | | | (lastEpochMicrosec - startEpochMicrosec)|
1959 | | | | )) x 100, if denominator is nonzero, or |
1960 | | | | 0, if otherwise. |
1961 +----------------+-------+----------+-----------------------------------------+
1962 | speed | number| No | Speed configured in mbps. |
1963 +----------------+-------+----------+-----------------------------------------+
1964 | transmitted\ | number| No | Cumulative count of broadcast packets |
1965 | Broadcast\ | | | transmitted as read at the end of the |
1966 | Packets\ | | | measurement interval |
1967 | Accumulated | | | |
1968 +----------------+-------+----------+-----------------------------------------+
1969 | transmitted\ | number| No | Count of broadcast packets transmitted |
1970 | Broadcast\ | | | within the measurement interval |
1971 | PacketsDelta | | | |
1972 +----------------+-------+----------+-----------------------------------------+
1973 | transmitted\ | number| No | Cumulative count of discarded packets |
1974 | Discarded\ | | | transmitted as read at the end of the |
1975 | Packets\ | | | measurement interval |
1976 | Accumulated | | | |
1977 +----------------+-------+----------+-----------------------------------------+
1978 | transmitted\ | number| No | Count of discarded packets transmitted |
1979 | Discarded\ | | | within the measurement interval |
1980 | PacketsDelta | | | |
1981 +----------------+-------+----------+-----------------------------------------+
1982 | transmitted\ | number| No | Cumulative count of error packets |
1983 | ErrorPackets\ | | | transmitted as read at the end of the |
1984 | Accumulated | | | measurement interval |
1985 +----------------+-------+----------+-----------------------------------------+
1986 | transmitted\ | number| No | Count of error packets transmitted |
1987 | ErrorPackets\ | | | within the measurement interval |
1989 +----------------+-------+----------+-----------------------------------------+
1990 | transmitted\ | number| No | Cumulative count of multicast packets |
1991 | Multicast\ | | | transmitted as read at the end of the |
1992 | Packets\ | | | measurement interval |
1993 | Accumulated | | | |
1994 +----------------+-------+----------+-----------------------------------------+
1995 | transmitted\ | number| No | Count of multicast packets transmitted |
1996 | Multicast\ | | | within the measurement interval |
1997 | PacketsDelta | | | |
1998 +----------------+-------+----------+-----------------------------------------+
1999 | transmitted\ | number| No | Cumulative count of octets transmitted |
2000 | Octets\ | | | as read at the end of the measurement |
2001 | Accumulated | | | interval |
2002 +----------------+-------+----------+-----------------------------------------+
2003 | transmitted\ | number| No | Count of octets transmitted within the |
2004 | OctetsDelta | | | measurement interval |
2005 +----------------+-------+----------+-----------------------------------------+
2006 | transmitted\ | number| No | Percentage of discarded packets |
2007 | PercentDiscard | | | transmitted; value = |
2008 | | | | (transmittedDiscardedPacketsDelta / |
2009 | | | | transmittedTotalPacketsDelta) x 100, if |
2010 | | | | denominator is nonzero, or 0, if |
2011 | | | | otherwise. |
2012 +----------------+-------+----------+-----------------------------------------+
2013 | transmitted\ | number| No | Percentage of error packets received; |
2014 | PercentError | | | value = (transmittedErrorPacketsDelta / |
2015 | | | | transmittedTotalPacketsDelta) x 100, if |
2016 | | | | denominator is nonzero, or 0, if |
2017 | | | | otherwise. |
2018 +----------------+-------+----------+-----------------------------------------+
2019 | transmitted\ | number| No | Cumulative count of all packets |
2020 | TotalPackets\ | | | transmitted as read at the end of the |
2021 | Accumulated | | | measurement interval |
2022 +----------------+-------+----------+-----------------------------------------+
2023 | transmitted\ | number| No | Count of all packets transmitted within |
2024 | TotalPackets\ | | | the measurement interval |
2026 +----------------+-------+----------+-----------------------------------------+
2027 | transmitted\ | number| No | Cumulative count of unicast packets |
2028 | Unicast\ | | | transmitted as read at the end of the |
2029 | Packets\ | | | measurement interval |
2030 | Accumulated | | | |
2031 +----------------+-------+----------+-----------------------------------------+
2032 | transmitted\ | number| No | Count of unicast packets transmitted |
2033 | Unicast\ | | | within the measurement interval |
2034 | PacketsDelta | | | |
2035 +----------------+-------+----------+-----------------------------------------+
2036 | transmitted\ | number| No | Percentage of utilization transmitted; |
2037 | Utilization | | | value = (transmittedOctetsDelta / (speed|
2038 | | | | x (lastEpochMicrosec - |
2039 | | | | startEpochMicrosec))) x 100, if |
2040 | | | | denominator is nonzero, or 0, if |
2041 | | | | otherwise. |
2042 +----------------+-------+----------+-----------------------------------------+
2043 | values\ | string| Yes | Enumeration: ‘true’ or ‘false’. If |
2044 | AreSuspect | | | ‘true’ then the vNicPerformance values |
2045 | | | | are likely inaccurate due to counter |
2046 | | | | overflow or other conditions. |
2047 +----------------+-------+----------+-----------------------------------------+
2049 Datatype: processorDimmAggregateThermalMargin
2050 *********************************************
2052 The processorDimmAggregateThermalMargin datatype provides intelligent
2053 platform management interface (ipmi) processor dual inline memory module
2054 aggregate thermal margin metrics; it consists of the following fields:
2056 +-----------------+-------+----------+----------------------------------------+
2057 | Field | Type | Required?| Description |
2058 +=================+=======+==========+========================================+
2059 | processor\ | string| Yes | identifier for the aggregate thermal |
2060 | DimmAggregate\ | | | margin metrics from the processor dual |
2061 | Thermal | | | inline memory module |
2062 | MarginIdentifier| | | |
2063 +-----------------+-------+----------+----------------------------------------+
2064 | thermalMargin | number| Yes | the difference between the DIMM's |
2065 | | | | current temperature, in celsius, and |
2066 | | | | the DIMM's throttling thermal trip |
2067 +-----------------+-------+----------+----------------------------------------+
2069 Datatype: processStats
2070 **********************
2072 The processStats datatype provides metrics on system processes; it
2073 consists of the following fields:
2076 +-----------+-------+----------+----------------------------------------------+
2077 | Field | Type | Required?| Description |
2078 +===========+=======+==========+==============================================+
2079 | forkRate | number| No | The number of threads created since the last |
2081 +-----------+-------+----------+----------------------------------------------+
2082 | process\ | string| Yes | processIdentifier |
2084 +-----------+-------+----------+----------------------------------------------+
2085 | psState\ | number| No | The number of processes in a blocked state |
2087 +-----------+-------+----------+----------------------------------------------+
2088 | psState\ | number| No | The number of processes in a paging state |
2090 +-----------+-------+----------+----------------------------------------------+
2091 | psState\ | number| No | The number of processes in a running state |
2093 +-----------+-------+----------+----------------------------------------------+
2094 | psState\ | number| No | The number of processes in a sleeping state |
2096 +-----------+-------+----------+----------------------------------------------+
2097 | psState\ | number| No | The number of processes in a stopped state |
2099 +-----------+-------+----------+----------------------------------------------+
2100 | psState\ | number| No | The number of processes in a zombie state |
2102 +-----------+-------+----------+----------------------------------------------+
2104 ‘Notification’ Domain Datatypes
2105 +++++++++++++++++++++++++++++++
2107 Datatype: notificationFields
2108 ****************************
2110 The notificationFields datatype consists of the following fields:
2112 +--------------+-----------+----------+---------------------------------------+
2113 | Field | Type | Required?| Description |
2114 +==============+===========+==========+=======================================+
2115 | additional\ | hashMap | No | Additional notification fields if |
2116 | Fields | | | needed |
2117 +--------------+-----------+----------+---------------------------------------+
2118 | arrayOfNamed\| namedHash\| No | Array of named hashMaps |
2119 | HashMap | Map [ ] | | |
2120 +--------------+-----------+----------+---------------------------------------+
2121 | change\ | string | No | Identifier for a contact related to |
2122 | Contact | | | the change |
2123 +--------------+-----------+----------+---------------------------------------+
2124 | change\ | string | Yes | System or session identifier |
2125 | Identifier | | | associated with the change |
2126 +--------------+-----------+----------+---------------------------------------+
2127 | changeType | string | Yes | Describes what has changed for the |
2128 | | | | entity, for example: configuration |
2129 | | | | changed, capability added, capability |
2131 +--------------+-----------+----------+---------------------------------------+
2132 | newState | string | No | New state of the entity, for example: |
2133 | | | | ‘inService’, ‘maintenance’, |
2134 | | | | ‘outOfService’ |
2135 +--------------+-----------+----------+---------------------------------------+
2136 | notification\| string | Yes | Version of the notificationFields |
2137 | FieldsVersion| | | block as "#.#" where # is a digit; see|
2138 | | | | section 1 for the correct digits to |
2140 +--------------+-----------+----------+---------------------------------------+
2141 | oldState | string | No | Previous state of the entity, for |
2142 | | | | example: ‘inService’, ‘maintenance’, |
2143 | | | | ‘outOfService’ |
2144 +--------------+-----------+----------+---------------------------------------+
2145 | state\ | string | No | Card or port name of the entity that |
2146 | Interface | | | changed state |
2147 +--------------+-----------+----------+---------------------------------------+
2149 The fileReady notification event is used by 3GPP-compliant NFs to notify
2150 ONAP that a PM file is available for upload. The notificationFields are
2151 populated as follows:
2153 **arrayOfNamedHashMap:** The array is named for the PM file as defined
2154 in 3GPP TS 28.550. The array contains the following key value pairs:
2156 - **location** in the form protocol://ipAddress:port/path/filename;
2158 "ftpes://135.3.1.44:21/pmfiles/A20180531.1030+0600-1045+0600\A20000626.2315+0200-2330+0200_NodeBId.gz"
2160 - **compression** containing the compression type used for the PM file;
2161 e.g. "compression" : "gzip"
2163 - **fileFormatType** containing the format type of the PM file; e.g.
2164 "fileFormatType" : "org.3GPP.32.435#measCollec"
2166 - **fileFormatVersion** containing the format version of the PM file;
2167 e.g. "fileFormatVersion" : "V10"
2169 - other vendor-defined key-value pairs as needed
2171 **changeIdentifier:** set to PM\_MEAS\_FILES
2173 **changeType:** set to fileReady
2175 Other notificationFields are not used for fileReady.
2177 ‘Other’ Domain Datatypes
2178 ++++++++++++++++++++++++
2180 Datatype: otherFields
2181 *********************
2183 The otherFields datatype defines fields for events belonging to the
2184 'other' domain of the commonEventHeader domain enumeration; it consists
2185 of the following fields:
2187 +-------------+-------------+----------+--------------------------------------+
2188 | Field | Type | Required?| Description |
2189 +=============+=============+==========+======================================+
2190 | arrayOf\ | arrayOf\ | No | Array of named hashMaps |
2191 | NamedHashMap| NamedHashMap| | |
2192 +-------------+-------------+----------+--------------------------------------+
2193 | hashMap | hashMap | No | Array of name-value pairs |
2194 +-------------+-------------+----------+--------------------------------------+
2195 | jsonObjects | arrayOf\ | No | Array of JSON objects described by |
2196 | | JsonObject | | name, schema and other |
2197 | | | | meta-information |
2198 +-------------+-------------+----------+--------------------------------------+
2199 | otherFields\| string | Yes | Version of the otherFields block as |
2200 | Version | | | "#.#" where # is a digit; see section|
2201 | | | | 1 for the correct digits to use. |
2202 +-------------+-------------+----------+--------------------------------------+
2204 ‘perf3gpp’ Domain Datatypes
2205 +++++++++++++++++++++++++++
2207 Datatype: measDataCollection
2208 ****************************
2210 The measDataCollection datatype defines a 3GPP measurement collection
2211 structure aligned with the 3GPP PM format; it consists of the following
2214 +----------------+---------+----------+---------------------------------------+
2215 | Field | Type | Required?| Description |
2216 +================+=========+==========+=======================================+
2217 | format\ | string | No | 3GPP PM reporting file format version |
2218 | Version | | | from pre-standard TS 28.550 v2.0.0 |
2219 +----------------+---------+----------+---------------------------------------+
2220 | granularity\ | string | Yes | Granularity period for the PM report |
2221 | Period | | | in seconds |
2222 +----------------+---------+----------+---------------------------------------+
2223 | measInfoList | measInfo| Yes | Array of measInfo measurements |
2225 +----------------+---------+----------+---------------------------------------+
2226 | measObjInst\ | string | No | Array of monitored object local |
2227 | IdList | [ ] | | distinguished name ids per 3GPP TS |
2229 +----------------+---------+----------+---------------------------------------+
2230 | measured\ | string | Yes | Distinguished name per 3GPP TS 28.532 |
2232 +----------------+---------+----------+---------------------------------------+
2233 | measuredEntity\| string | No | Software version for the NF providing |
2234 | SoftwareVersion| | | the PM data as specified in 3GPP TS |
2236 +----------------+---------+----------+---------------------------------------+
2237 | measuredEntity\| string | No | User Definable name for the measured |
2238 | UserName | | | object per 3GPP TS 28.532 |
2239 +----------------+---------+----------+---------------------------------------+
2244 The measInfo datatype provides measurement information; it consists of
2245 the following fields:
2247 +-------+--------------------------+----------+-------------------------------+
2248 | Field | Type | Required?| Description |
2249 +=======+==========================+==========+===============================+
2250 | jobId | string | No | Name of the measurement job |
2251 +-------+--------------------------+----------+-------------------------------+
2252 | meas\ | oneOf [ measInfoIdInteger| No | Measurement group Identifier |
2253 | InfoId| , measInfoIdString ] | | |
2254 +-------+--------------------------+----------+-------------------------------+
2255 | meas\ | oneOf [ measTypesInteger | Yes | Array of measurement |
2256 | Types | , measTypesString ] | | identifiers associated with |
2257 | | | | the measurement results |
2258 | | | | expressed as integers for |
2259 | | | | efficiency rather than strings|
2260 +-------+--------------------------+----------+-------------------------------+
2261 | meas\ | measValues [ ] | Yes | Array of measValues |
2263 +-------+--------------------------+----------+-------------------------------+
2265 Datatype: measInfoIdInteger
2266 ***************************
2268 The measInfoIdInteger datatype provides an integer measurement group
2269 identifier; it consists of the following fields:
2271 +---------------+---------+----------+--------------------------------------+
2272 | Field | Type | Required?| Description |
2273 +===============+=========+==========+======================================+
2274 | iMeasInfoId | integer | Yes | Integer measurement group Identifier |
2275 +---------------+---------+----------+--------------------------------------+
2277 Datatype: measInfoIdString
2278 **************************
2280 The measInfoIdString datatype provides a string measurement group
2281 identifier; it consists of the following fields:
2283 +---------------+-----------+----------+--------------------------------------+
2284 | Field | Type | Required?| Description |
2285 +===============+===========+==========+======================================+
2286 | sMeasInfoId | integer | Yes | String measurement group Identifier |
2287 +---------------+-----------+----------+--------------------------------------+
2289 Datatype: measResultInteger
2290 ***************************
2292 The measResultInteger datatype provides an integer 3GPP PM measurement
2293 result; it consists of the following fields:
2295 +----------+-----------+-------------+------------------------------------+
2296 | Field | Type | Required? | Description |
2297 +==========+===========+=============+====================================+
2298 | p | integer | Yes | Integer reference to the counter |
2299 +----------+-----------+-------------+------------------------------------+
2300 | iValue | integer | Yes | Integer counter value |
2301 +----------+-----------+-------------+------------------------------------+
2303 Datatype: measResultNull
2304 ************************
2306 The measResultNull datatype provides a null 3GPP PM measurement result;
2307 it consists of the following fields:
2309 +----------+-----------+-------------+------------------------------------+
2310 | Field | Type | Required? | Description |
2311 +==========+===========+=============+====================================+
2312 | p | integer | Yes | Integer reference to the counter |
2313 +----------+-----------+-------------+------------------------------------+
2314 | isNull | string | Yes | Enumeration: ‘true’ or ‘false’ |
2315 +----------+-----------+-------------+------------------------------------+
2317 Datatype: measResultNumber
2318 **************************
2320 The measResultNumber datatype provides a number 3GPP PM measurement
2321 result; it consists of the following fields:
2323 +----------+-----------+-------------+------------------------------------+
2324 | Field | Type | Required? | Description |
2325 +==========+===========+=============+====================================+
2326 | p | integer | Yes | Integer reference to the counter |
2327 +----------+-----------+-------------+------------------------------------+
2328 | rValue | number | Yes | Number counter value |
2329 +----------+-----------+-------------+------------------------------------+
2331 Datatype: measResultString
2332 **************************
2334 The measResultString datatype provides a string 3GPP PM measurement
2335 result; it consists of the following fields:
2337 +----------+-----------+-------------+------------------------------------+
2338 | Field | Type | Required? | Description |
2339 +==========+===========+=============+====================================+
2340 | p | integer | Yes | Integer reference to the counter |
2341 +----------+-----------+-------------+------------------------------------+
2342 | sValue | string | Yes | String counter value |
2343 +----------+-----------+-------------+------------------------------------+
2345 Datatype: measTypesInteger
2346 **************************
2348 The measTypesInteger datatype provides an array of integer measurement
2349 identifiers associated with the measurement results; it consists of the
2352 +----------+--------+----------+----------------------------------------------+
2353 | Field | Type | Required?| Description |
2354 +==========+========+==========+==============================================+
2355 | iMeas\ | integer| Yes | Array of integer measurement identifiers |
2356 | TypesList| [ ] | | associated with the measurement results |
2357 +----------+--------+----------+----------------------------------------------+
2359 Datatype: measTypesString
2360 *************************
2362 The measTypesString datatype provides an array of string measurement
2363 identifiers associated with the measurement results; it consists of the
2366 +----------+-------+----------+-----------------------------------------------+
2367 | Field | Type | Required?| Description |
2368 +==========+=======+==========+===============================================+
2369 | sMeas\ | string| Yes | Array of string measurement identifiers |
2370 | TypesList| [ ] | | associated with the measurement results |
2371 +----------+-------+----------+-----------------------------------------------+
2373 Datatype: measValues
2374 ********************
2376 The measValues datatype provides 3GPP measurement values; it consists of
2377 the following fields:
2379 +---------+----------------------------------+----------+---------------------+
2380 | Field | Type | Required?| Description |
2381 +=========+==================================+==========+=====================+
2382 | measObj\| hashMap | No | Additional key-value|
2383 | AddlFlds| | | pairs if needed |
2384 +---------+----------------------------------+----------+---------------------+
2385 | measObj\| measDataCollection | Yes | Monitored object |
2386 | InstId | | | local distinguished |
2387 | | | | name per 3GPP TS |
2388 | | | | 32.300 and 3GPP TS |
2390 +---------+----------------------------------+----------+---------------------+
2391 | meas\ | Array of items where each item is| Yes | Array of results |
2392 | Results | oneOf [ measResultInteger, | | |
2393 | | measResultNull, measResultNumber,| | |
2394 | | measResultString ] | | |
2395 +---------+----------------------------------+----------+---------------------+
2396 | suspect\| string | No | Enumeration: ‘true’,|
2397 | Flag | | | ‘false’. Indicates |
2398 | | | | if the values are |
2400 +---------+----------------------------------+----------+---------------------+
2402 Datatype: perf3gppFields
2403 ************************
2405 The perf3gppFields datatype defines fields for 3GPP PM format events,
2406 based on 3GPP TS 28.550, belonging to the 'perf3gpp' domain of the
2407 commonEventHeader domain enumeration; it consists of the following
2410 +--------------+-----------+----------+---------------------------------------+
2411 | Field | Type | Required?| Description |
2412 +==============+===========+==========+=======================================+
2413 | eventAddl\ | hashMap | No | Additional key-value pairs if needed |
2415 +--------------+-----------+----------+---------------------------------------+
2416 | measData\ | measData | Yes | 3GPP measurement collection structure |
2417 | Collection | Collection| | |
2418 +--------------+-----------+----------+---------------------------------------+
2419 | perf3gpp\ | string | Yes | Version of the perf3gpp event |
2420 | FieldsVersion| | | |
2421 +--------------+-----------+----------+---------------------------------------+
2423 ‘pnfRegistration’ Domain Datatypes
2424 ++++++++++++++++++++++++++++++++++
2426 Datatype: pnfRegistrationFields
2427 *******************************
2429 The pnfRegistrationFields datatype defines fields for events belonging
2430 to the 'pnfRegistration' domain of the commonEventHeader domain
2431 enumeration; it consists of the following fields:
2433 +-----------------+--------+----------+---------------------------------------+
2434 | Field | Type | Required?| Description |
2435 +=================+========+==========+=======================================+
2436 | additional\ | hashMap| No | Additional pnfRegistration fields if |
2437 | Fields | | | needed |
2438 +-----------------+--------+----------+---------------------------------------+
2439 | last\ | string | No | TS 32.692 dateOfLastService = date of |
2440 | ServiceDate | | | last service; e.g. 15022017 |
2441 +-----------------+--------+----------+---------------------------------------+
2442 | macAddress | string | No | MAC address of OAM interface of the |
2444 +-----------------+--------+----------+---------------------------------------+
2445 | manufacture\ | string | No | TS 32.692 dateOfManufacture = |
2446 | Date | | | manufacture date of the unit; 24032016|
2447 +-----------------+--------+----------+---------------------------------------+
2448 | modelNumber | string | No | TS 32.692 versionNumber = version of |
2449 | | | | the unit from vendor; e.g. AJ02. Maps |
2450 | | | | to AAI equip-model |
2451 +-----------------+--------+----------+---------------------------------------+
2452 | oamV4\ | string | No | IPv4 m-plane IP address to be used by |
2453 | IpAddress | | | the manager to contact the PNF |
2454 +-----------------+--------+----------+---------------------------------------+
2455 | oamV6\ | string | No | IPv6 m-plane IP address to be used by |
2456 | IpAddress | | | the manager to contact the PNF |
2457 +-----------------+--------+----------+---------------------------------------+
2458 | pnfRegistration\| string | Yes | Version of the pnfRegistrationFields |
2459 | FieldsVersion | | | block as "#.#" where # is a digit; see|
2460 | | | | section 1 for the correct digits to |
2462 +-----------------+--------+----------+---------------------------------------+
2463 | serialNumber | string | No | TS 32.692 serialNumber = serial number|
2464 | | | | of the unit; e.g. 6061ZW3 |
2465 +-----------------+--------+----------+---------------------------------------+
2466 | software\ | string | No | TS 32.692 swName = active SW running |
2467 | Version | | | on the unit; e.g. 5gDUv18.05.201 |
2468 +-----------------+--------+----------+---------------------------------------+
2469 | unitFamily | string | No | TS 32.692 vendorUnitFamilyType = |
2470 | | | | general type of HW unit; e.g. BBU |
2471 +-----------------+--------+----------+---------------------------------------+
2472 | unitType | string | No | TS 32.692 vendorUnitTypeNumber = |
2473 | | | | vendor name for the unit; e.g. |
2475 +-----------------+--------+----------+---------------------------------------+
2476 | vendorName | string | No | TS 32.692 vendorName = name of |
2477 | | | | manufacturer; e.g. Nokia. Maps to AAI |
2478 | | | | equip-vendor |
2479 +-----------------+--------+----------+---------------------------------------+
2481 ‘State Change’ Domain Datatypes
2482 +++++++++++++++++++++++++++++++
2484 Datatype: stateChangeFields
2485 ***************************
2487 The stateChangeFields datatype consists of the following fields:
2489 +--------------+--------+----------+------------------------------------------+
2490 | Field | Type | Required?| Description |
2491 +==============+========+==========+==========================================+
2492 | additional\ | hashMap| No | Additional stateChange fields if needed |
2494 +--------------+--------+----------+------------------------------------------+
2495 | newState | string | Yes | New state of the entity: ‘inService’, |
2496 | | | | ‘maintenance’, ‘outOfService’ |
2497 +--------------+--------+----------+------------------------------------------+
2498 | oldState | string | Yes | Previous state of the entity: ‘inService’|
2499 | | | | , ‘maintenance’, ‘outOfService’ |
2500 +--------------+--------+----------+------------------------------------------+
2501 | stateChange\ | string | Yes | Version of the stateChangeFields block as|
2502 | FieldsVersion| | | "#.#" where # is a digit; see section 1 |
2503 | | | | for the correct digits to use. |
2504 +--------------+--------+----------+------------------------------------------+
2505 | state\ | string | Yes | Card or port name of the entity that |
2506 | Interface | | | changed state |
2507 +--------------+--------+----------+------------------------------------------+
2509 ‘StndDefined’ Domain Datatypes
2510 ++++++++++++++++++++++++++++++
2512 Datatype: stndDefinedFields
2513 ***************************
2515 The stndDefinedFields datatype consists of the following fields:
2517 +--------------+--------+----------+------------------------------------------+
2518 | Field | Type | Required?| Description |
2519 +==============+========+==========+==========================================+
2520 | data | object | Yes | Expected to contain a notification |
2521 | | | | defined by relevant standards group/body |
2522 | | | | Must be a JSON object. |
2523 +--------------+--------+----------+------------------------------------------+
2524 | schema\ | string | No | A reference to standards defined schema, |
2525 | Reference | | | against which the contents of data |
2526 | | | | property will be validated |
2527 +--------------+--------+----------+------------------------------------------+
2528 | stndDefined\ | string | Yes | Version of the stndDefinedFields block as|
2529 | FieldsVersion| | | "#.#" where # is a digit; see section 1 |
2530 | | | | for the correct digits to use. |
2531 +--------------+--------+----------+------------------------------------------+
2533 Additional rules, when using stndDefined domain
2534 ***********************************************
2536 Following rules shall be followed, when using the StndDefined domain:
2538 If the VNF or PNF is using VES StndDefined domain, then the VNF or PNF MUST
2539 fill the VES.commonEventHeader.stndDefinedNamespace with a value defined by
2540 relevant standards organization.
2542 If the VNF or PNF is using VES StndDefined domain, then the VNF or PNF MAY
2543 fill the VES.stndDefinedFields.schemaReference property with a URI
2544 corresponding to the specific JSON schema object, against which validation
2545 of VES.stndDefinedFields.data will be executed.
2547 If the VNF or PNF is using VES StndDefined domain and eventBatch is sent,
2548 then each and every event within eventBatch must have exactly the same
2549 VES.commonEventHeader.stndDefinedNamespace set.
2551 ‘Syslog’ Domain Datatypes
2552 +++++++++++++++++++++++++
2554 Datatype: syslogFields
2555 **********************
2557 The syslogFields datatype consists of the following fields:
2559 +------------+--------+----------+--------------------------------------------+
2560 | Field | Type | Required?| Description |
2561 +============+========+==========+============================================+
2562 | additional\| hashMap| No | Additional syslog fields if needed Ex: |
2563 | Fields | | | {"name1": "value1", "name2: "value2" … } |
2564 +------------+--------+----------+--------------------------------------------+
2565 | event\ | string | No | Hostname of the device |
2566 | SourceHost | | | |
2567 +------------+--------+----------+--------------------------------------------+
2568 | event\ | string | Yes | Examples: ‘other’, ‘router’, ‘switch’, |
2569 | SourceType | | | ‘host’, ‘card’, ‘port’, ‘slotThreshold’, |
2570 | | | | ‘portThreshold’, ‘virtualMachine’, |
2571 | | | | ‘virtualNetworkFunction’ |
2572 +------------+--------+----------+--------------------------------------------+
2573 | syslog\ | integer| No | Numeric code from 0 to 23 for facility: |
2576 | | | | 0 kernel messages |
2578 | | | | 1 user-level messages |
2580 | | | | 2 mail system |
2582 | | | | 3 system daemons |
2584 | | | | 4 security/authorization messages |
2586 | | | | 5 messages generated internally by syslogd |
2588 | | | | 6 line printer subsystem |
2590 | | | | 7 network news subsystem |
2592 | | | | 8 UUCP subsystem |
2594 | | | | 9 clock daemon |
2596 | | | | 10 security/authorization messages |
2598 | | | | 11 FTP daemon |
2600 | | | | 12 NTP subsystem |
2602 | | | | 13 log audit |
2604 | | | | 14 log alert |
2606 | | | | 15 clock daemon (note 2) |
2608 | | | | 16 local use 0 (local0) |
2610 | | | | 17 local use 1 (local1) |
2612 | | | | 18 local use 2 (local2) |
2614 | | | | 19 local use 3 (local3) |
2616 | | | | 20 local use 4 (local4) |
2618 | | | | 21 local use 5 (local5) |
2620 | | | | 22 local use 6 (local6) |
2622 | | | | 23 local use 7 (local7 ) |
2623 +------------+--------+----------+--------------------------------------------+
2624 | syslog\ | string | Yes | Version of the syslogFields block as "#.#" |
2625 | Fields\ | | | where # is a digit; see section 1 for the |
2626 | Version | | | correct digits to use. |
2627 +------------+--------+----------+--------------------------------------------+
2628 | syslogMsg | string | Yes | Syslog message |
2629 +------------+--------+----------+--------------------------------------------+
2630 | syslog\ | string | No | Hostname parsed from non-VES syslog message|
2632 +------------+--------+----------+--------------------------------------------+
2633 | syslogPri | integer| No | 0-192 |
2635 | | | | Combined Severity and Facility(see rfc5424)|
2636 +------------+--------+----------+--------------------------------------------+
2637 | syslogProc | string | No | Identifies the application that originated |
2638 | | | | the message |
2639 +------------+--------+----------+--------------------------------------------+
2640 | syslog\ | number | No | The process number assigned by the OS when |
2641 | ProcId | | | the application was started |
2642 +------------+--------+----------+--------------------------------------------+
2643 | syslog\ | string | No | A <space> separated list of key="value" |
2644 | SData | | | pairs following the rfc5424 standard for |
2645 | | | | SD-ELEMENT. |
2647 | | | | ***Deprecated *** |
2649 | | | | The entire rfc5424 syslogSData object, |
2650 | | | | including square brackets [ ], SD-ID and |
2651 | | | | list of SD-PARAMs |
2652 +------------+--------+----------+--------------------------------------------+
2653 | syslogSdId | string | No | 0-32 char in format name@number, |
2655 | | | | i.e., ourSDID@32473 |
2656 +------------+--------+----------+--------------------------------------------+
2657 | syslogSev | string | No | Level-of-severity text enumeration defined |
2660 | | | | *Text* *Sev* *Description* |
2662 | | | | Emergency 0 system is unusable |
2664 | | | | Alert 1 action must be taken immediately |
2666 | | | | Critical 2 critical conditions |
2668 | | | | Error 3 error conditions |
2670 | | | | Warning 4 warning conditions |
2672 | | | | Notice 5 normal but significant condition |
2674 | | | | Info 6 Informational messages |
2676 | | | | Debug 7 debug-level messages |
2677 +------------+--------+----------+--------------------------------------------+
2678 | syslogTag | string | Yes | Also known as MsgId. Brief non-spaced text |
2679 | | | | indicating the type of message such as |
2680 | | | | ‘TCPOUT’ or ‘BGP\_STATUS\_CHANGE’; |
2681 | | | | ‘NILVALUE’ should be used when no other |
2682 | | | | value can be provided |
2683 +------------+--------+----------+--------------------------------------------+
2684 | syslogTs | string | No | Timestamp parsed from non-VES syslog |
2686 +------------+--------+----------+--------------------------------------------+
2687 | syslogVer | number | No | IANA assigned version of the syslog |
2688 | | | | protocol specification: |
2692 | | | | 1: IANA RFC5424 |
2693 +------------+--------+----------+--------------------------------------------+
2695 Examples of syslogSData :
2699 ts="1985-04-12T23:20:50.52Z" tag="BGP\_NEIGHBOR\_DOWN" msg="The BGP
2700 session to neighbor 10.10.10.10 is down"
2704 [attinc@1234 ts="1985-04-12T23:20:50.52Z" tag="BGP\_NEIGHBOR\_DOWN"
2705 msg="The BGP session to neighbor 10.10.10.10 is down"]
2709 https://tools.ietf.org/html/rfc5424#section-6
2711 https://www.iana.org/assignments/syslog-parameters/syslog-parameters.xhtml
2713 ‘Threshold Crossing Alert’ Domain Datatypes
2714 +++++++++++++++++++++++++++++++++++++++++++
2719 The counter datatype consists of the following fields:
2721 +------------+--------+----------+--------------------------------------------+
2722 | Field | Type | Required?| Description |
2723 +============+========+==========+============================================+
2724 | criticality| string | Yes | Enumeration: ‘CRIT’, ‘MAJ’ |
2725 +------------+--------+----------+--------------------------------------------+
2726 | hashMap | hashMap| Yes | Key is the name of the counter and value is|
2727 | | | | the current value of the counter |
2728 +------------+--------+----------+--------------------------------------------+
2729 | threshhold\| string | Yes | Last threshold that was crossed |
2731 +------------+--------+----------+--------------------------------------------+
2733 Datatype: thresholdCrossingAlertFields
2734 **************************************
2736 The thresholdCrossingAlertFields datatype consists of the following
2739 +------------+------------+----------+----------------------------------------+
2740 | Field | Type | Required?| Description |
2741 +============+============+==========+========================================+
2742 | additional\| hashMap | No | Additional threshold crossing alert |
2743 | Fields | | | fields if needed |
2744 +------------+------------+----------+----------------------------------------+
2745 | additional\| counter [ ]| Yes | Array of performance counters |
2746 | Parameters | | | |
2747 +------------+------------+----------+----------------------------------------+
2748 | alert\ | string | Yes | Enumeration: ‘SET’, ‘CONT’, ‘CLEAR’ |
2750 +------------+------------+----------+----------------------------------------+
2751 | alert\ | string | Yes | Unique short alert description (e.g., |
2752 | Description| | | NE-CPUMEM) |
2753 +------------+------------+----------+----------------------------------------+
2754 | alertType | string | Yes | Enumeration: ‘CARD-ANOMALY’, |
2755 | | | | ‘INTERFACE-ANOMALY’, ELEMENT-ANOMALY’, |
2756 | | | | ‘SERVICE-ANOMALY’ |
2757 +------------+------------+----------+----------------------------------------+
2758 | alertValue | string | No | Calculated API value (if applicable) |
2759 +------------+------------+----------+----------------------------------------+
2760 | associated\| string [ ] | No | List of eventIds associated with the |
2761 | AlertIdList| | | event being reported |
2762 +------------+------------+----------+----------------------------------------+
2763 | collection\| string | Yes | Time when the performance collector |
2764 | Timestamp | | | picked up the data; with RFC 2822 |
2765 | | | | compliant format: ‘Sat, 13 Mar 2010 |
2766 | | | | 11:29:05 -0800’ |
2767 +------------+------------+----------+----------------------------------------+
2768 | data\ | string | No | Specific performance collector instance|
2769 | Collector | | | used |
2770 +------------+------------+----------+----------------------------------------+
2771 | elementType| string | No | Type of network element (internal AT&T |
2773 +------------+------------+----------+----------------------------------------+
2774 | event\ | string | Yes | Event severity or priority enumeration:|
2775 | Severity | | | ‘CRITICAL’, ‘MAJOR’, ‘MINOR’, ‘WARNING’|
2776 | | | | , ‘NORMAL’ |
2777 +------------+------------+----------+----------------------------------------+
2778 | eventStart\| string | Yes | Time closest to when the measurement |
2779 | Timestamp | | | was made; with RFC 2822 compliant |
2780 | | | | format: ‘Sat, 13 Mar 2010 11:29:05 |
2782 +------------+------------+----------+----------------------------------------+
2783 | interface\ | string | No | Physical or logical port or card (if |
2784 | Name | | | applicable) |
2785 +------------+------------+----------+----------------------------------------+
2786 | network\ | string | No | Network name (internal AT&T field) |
2788 +------------+------------+----------+----------------------------------------+
2789 | possible\ | string | No | Reserved for future use |
2791 +------------+------------+----------+----------------------------------------+
2792 | threshold\ | string | Yes | Version of the |
2793 | Crossing | | | thresholdCrossingAlertFields block as |
2794 | Fields\ | | | "#.#" where # is a digit; see section 1|
2795 | Version | | | for the correct digits to use. |
2796 +------------+------------+----------+----------------------------------------+
2798 Technology Specific Datatypes
2799 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2801 Mobile Flow’ Domain Datatypes
2802 +++++++++++++++++++++++++++++
2804 Datatype: gtpPerFlowMetrics
2805 ***************************
2807 The gtpPerFlowMetrics datatype consists of the following fields:
2809 +---------------+--------+----------+-----------------------------------------+
2810 | Field | Type | Required?| Description |
2811 +===============+========+==========+=========================================+
2812 | avgBit\ | number | Yes | Average bit error rate |
2814 +---------------+--------+----------+-----------------------------------------+
2815 | avgPacket\ | number | Yes | Average packet delay variation or jitter|
2816 | Delay\ | | | in milliseconds for received packets: |
2817 | Variation | | | Average difference between the packet |
2818 | | | | timestamp and time received for all |
2819 | | | | pairs of consecutive packets |
2820 +---------------+--------+----------+-----------------------------------------+
2821 | avgPacket\ | number | Yes | Average delivery latency |
2823 +---------------+--------+----------+-----------------------------------------+
2824 | avgReceive\ | number | Yes | Average receive throughput |
2825 | Throughput | | | |
2826 +---------------+--------+----------+-----------------------------------------+
2827 | avgTransmit\ | number | Yes | Average transmit throughput |
2828 | Throughput | | | |
2829 +---------------+--------+----------+-----------------------------------------+
2830 | dur\ | number | No | Duration of failed state in milliseconds|
2831 | Connection\ | | | , computed as the cumulative time |
2832 | FailedStatus | | | between a failed echo request and the |
2833 | | | | next following successful error request,|
2834 | | | | over this reporting interval |
2835 +---------------+--------+----------+-----------------------------------------+
2836 | durTunnel\ | number | No | Duration of errored state, computed as |
2837 | FailedStatus | | | the cumulative time between a tunnel |
2838 | | | | error indicator and the next following |
2839 | | | | non-errored indicator, over this |
2840 | | | | reporting interval |
2841 +---------------+--------+----------+-----------------------------------------+
2842 | flow\ | string | No | Endpoint activating the flow |
2843 | ActivatedBy | | | |
2844 +---------------+--------+----------+-----------------------------------------+
2845 | flow\ | number | Yes | Time the connection is activated in the |
2846 | Activation\ | | | flow (connection) being reported on, or |
2847 | Epoch | | | transmission time of the first packet if|
2848 | | | | activation time is not available |
2849 +---------------+--------+----------+-----------------------------------------+
2850 | flow\ | number | Yes | Integer microseconds for the start of |
2851 | Activation\ | | | the flow connection |
2853 +---------------+--------+----------+-----------------------------------------+
2854 | flow\ | string | No | Time the connection is activated in the |
2855 | Activation\ | | | flow being reported on, or transmission |
2856 | Time | | | time of the first packet if activation |
2857 | | | | time is not available; with RFC 2822 |
2858 | | | | compliant format: ‘Sat, 13 Mar 2010 |
2859 | | | | 11:29:05 -0800’ |
2860 +---------------+--------+----------+-----------------------------------------+
2861 | flow\ | string | No | Endpoint deactivating the flow |
2862 | Deactivated\ | | | |
2864 +---------------+--------+----------+-----------------------------------------+
2865 | flow\ | number | Yes | Time for the start of the flow |
2866 | Deactivation\ | | | connection, in integer UTC epoch time |
2867 | Epoch | | | aka UNIX time |
2868 +---------------+--------+----------+-----------------------------------------+
2869 | flow\ | number | Yes | Integer microseconds for the start of |
2870 | Deactivation\ | | | the flow connection |
2872 +---------------+--------+----------+-----------------------------------------+
2873 | flow\ | string | Yes | Transmission time of the first packet in|
2874 | Deactivation\ | | | the flow connection being reported on; |
2875 | Time | | | with RFC 2822 compliant format: ‘Sat, 13|
2876 | | | | Mar 2010 11:29:05 -0800’ |
2877 +---------------+--------+----------+-----------------------------------------+
2878 | flowStatus | string | Yes | Connection status at reporting time as a|
2879 | | | | working / inactive / failed indicator |
2881 +---------------+--------+----------+-----------------------------------------+
2882 | gtp\ | string | No | Current connection state at reporting |
2883 | Connection\ | | | time |
2885 +---------------+--------+----------+-----------------------------------------+
2886 | gtpTunnel\ | string | No | Current tunnel state at reporting time |
2888 +---------------+--------+----------+-----------------------------------------+
2889 | ipTos\ | hashMap| No | Array of key: value pairs where the keys|
2890 | CountList | | | are drawn from the IP Type-of-Service |
2891 | | | | identifiers which range from '0' to |
2892 | | | | '255', and the values are the count of |
2893 | | | | packets that had those ToS identifiers |
2894 | | | | in the flow |
2895 +---------------+--------+----------+-----------------------------------------+
2896 | ipTosList | string | No | Array of unique IP Type-of-Service |
2897 | | | | values observed in the flow where values|
2898 | | | | range from '0' to '255' |
2899 +---------------+--------+----------+-----------------------------------------+
2900 | large\ | number | No | large packet round trip time |
2902 +---------------+--------+----------+-----------------------------------------+
2903 | largePacket\ | number | No | large packet threshold being applied |
2905 +---------------+--------+----------+-----------------------------------------+
2906 | maxPacket\ | number | Yes | Maximum packet delay variation or jitter|
2907 | Delay\ | | | in milliseconds for received packets: |
2908 | Variation | | | Maximum of the difference between the |
2909 | | | | packet timestamp and time received for |
2910 | | | | all pairs of consecutive packets |
2911 +---------------+--------+----------+-----------------------------------------+
2912 | maxReceive\ | number | No | maximum receive bit rate" |
2914 +---------------+--------+----------+-----------------------------------------+
2915 | maxTransmit\ | number | No | maximum transmit bit rate |
2917 +---------------+--------+----------+-----------------------------------------+
2918 | mobileQci\ | hashMap| No | array of key: value pairs where the keys|
2919 | CosCountList | | | are drawn from LTE QCI or UMTS class of |
2920 | | | | service strings, and the values are the |
2921 | | | | count of packets that had those strings |
2922 | | | | in the flow |
2923 +---------------+--------+----------+-----------------------------------------+
2924 | mobileQci\ | string | No | Array of unique LTE QCI or UMTS |
2925 | CosList | | | class-of-service values observed in the |
2927 +---------------+--------+----------+-----------------------------------------+
2928 | num\ | number | Yes | Number of failed activation requests, as|
2929 | Activation\ | | | observed by the reporting node |
2931 +---------------+--------+----------+-----------------------------------------+
2932 | numBit\ | number | Yes | number of errored bits |
2934 +---------------+--------+----------+-----------------------------------------+
2935 | numBytes\ | number | Yes | number of bytes received, including |
2936 | Received | | | retransmissions |
2937 +---------------+--------+----------+-----------------------------------------+
2938 | numBytes\ | number | Yes | number of bytes transmitted, including |
2939 | Transmitted | | | retransmissions |
2940 +---------------+--------+----------+-----------------------------------------+
2941 | numDropped\ | number | Yes | number of received packets dropped due |
2942 | Packets | | | to errors per virtual interface |
2943 +---------------+--------+----------+-----------------------------------------+
2944 | numGtp\ | number | No | Number of Echo request path failures |
2945 | EchoFailures | | | where failed paths are defined in 3GPP |
2946 | | | | TS 29.281 sec 7.2.1 and 3GPP TS 29.060 |
2948 +---------------+--------+----------+-----------------------------------------+
2949 | numGtp\ | number | No | Number of tunnel error indications where|
2950 | TunnelErrors | | | errors are defined in 3GPP TS 29.281 sec|
2951 | | | | 7.3.1 and 3GPP TS 29.060 sec. 11.1 |
2952 +---------------+--------+----------+-----------------------------------------+
2953 | numHttp\ | number | No | Http error count |
2955 +---------------+--------+----------+-----------------------------------------+
2956 | numL7Bytes\ | number | Yes | number of tunneled layer 7 bytes |
2957 | Received | | | received, including retransmissions |
2958 +---------------+--------+----------+-----------------------------------------+
2959 | numL7Bytes\ | number | Yes | number of tunneled layer 7 bytes |
2960 | Transmitted | | | transmitted, excluding retransmissions |
2961 +---------------+--------+----------+-----------------------------------------+
2962 | numLost\ | number | Yes | number of lost packets |
2964 +---------------+--------+----------+-----------------------------------------+
2965 | numOutOf\ | number | Yes | number of out-of-order packets |
2966 | OrderPackets | | | |
2967 +---------------+--------+----------+-----------------------------------------+
2968 | numPacket\ | number | Yes | number of errored packets |
2970 +---------------+--------+----------+-----------------------------------------+
2971 | numPackets\ | number | Yes | number of packets received, excluding |
2972 | ReceivedExcl\ | | | retransmission |
2974 +---------------+--------+----------+-----------------------------------------+
2975 | numPackets\ | number | Yes | number of packets received, including |
2976 | ReceivedIncl\ | | | retransmission |
2978 +---------------+--------+----------+-----------------------------------------+
2979 | numPackets\ | number | Yes | number of packets transmitted, including|
2980 | Transmitted\ | | | retransmissions |
2981 | InclRetrans | | | |
2982 +---------------+--------+----------+-----------------------------------------+
2983 | numRetries | number | Yes | number of packet retrie |
2984 +---------------+--------+----------+-----------------------------------------+
2985 | numTimeouts | number | Yes | number of packet timeouts |
2986 +---------------+--------+----------+-----------------------------------------+
2987 | numTunneled\ | number | Yes | number of tunneled layer 7 bytes |
2988 | L7Bytes\ | | | received, excluding retransmissions |
2990 +---------------+--------+----------+-----------------------------------------+
2991 | roundTrip\ | number | Yes | Round Trip time |
2993 +---------------+--------+----------+-----------------------------------------+
2994 | tcpFlag\ | hashMap| No | Array of key: value pairs where the keys|
2995 | CountList | | | are drawn from TCP Flags and the values |
2996 | | | | are the count of packets that had that |
2997 | | | | TCP Flag in the flow |
2998 +---------------+--------+----------+-----------------------------------------+
2999 | tcpFlag\ | string | No | Array of unique TCP Flags observed in |
3000 | List | | | the flow |
3001 +---------------+--------+----------+-----------------------------------------+
3002 | timeTo\ | number | Yes | Time in milliseconds between the |
3003 | FirstByte | | | connection activation and first byte |
3005 +---------------+--------+----------+-----------------------------------------+
3007 Datatype: mobileFlowFields
3008 **************************
3010 The mobileFlowFields datatype consists of the following fields:
3012 +-------------+------------+----------+---------------------------------------+
3013 | Field | Type | Required?| Description |
3014 +=============+============+==========+=======================================+
3015 | additional\ | hashMap | No | Additional mobileFlow fields if needed|
3017 +-------------+------------+----------+---------------------------------------+
3018 | application\| string | No | Application type inferred |
3020 +-------------+------------+----------+---------------------------------------+
3021 | appProtocol\| string | No | Application protocol |
3023 +-------------+------------+----------+---------------------------------------+
3024 | appProtocol\| string | No | Application version |
3026 +-------------+------------+----------+---------------------------------------+
3027 | cid | string | No | Cell Id |
3028 +-------------+------------+----------+---------------------------------------+
3029 | connection\ | string | No | Abbreviation referencing a 3GPP |
3030 | Type | | | reference point e.g., S1-U, S11, etc |
3031 +-------------+------------+----------+---------------------------------------+
3032 | ecgi | string | No | Evolved Cell Global Id |
3033 +-------------+------------+----------+---------------------------------------+
3034 | flow\ | string | Yes | Flow direction, indicating if the |
3035 | Direction | | | reporting node is the source of the |
3036 | | | | flow or destination for the flow |
3037 +-------------+------------+----------+---------------------------------------+
3038 | gtpPer\ | gtpPer | Yes | Mobility GTP Protocol per flow metrics|
3039 | FlowMetrics | FlowMetrics| | |
3040 +-------------+------------+----------+---------------------------------------+
3041 | gtpProtocol\| string | No | GTP protocol |
3043 +-------------+------------+----------+---------------------------------------+
3044 | gtpVersion | string | No | GTP protocol version |
3045 +-------------+------------+----------+---------------------------------------+
3046 | httpHeader | string | No | HTTP request header, if the flow |
3047 | | | | connects to a node referenced by HTTP |
3048 +-------------+------------+----------+---------------------------------------+
3049 | imei | string | No | IMEI for the subscriber UE used in |
3050 | | | | this flow, if the flow connects to a |
3051 | | | | mobile device |
3052 +-------------+------------+----------+---------------------------------------+
3053 | imsi | string | No | IMSI for the subscriber UE used in |
3054 | | | | this flow, if the flow connects to a |
3055 | | | | mobile device |
3056 +-------------+------------+----------+---------------------------------------+
3057 | ipProtocol\ | string | Yes | IP protocol type e.g.,TCP, UDP, RTP...|
3059 +-------------+------------+----------+---------------------------------------+
3060 | ipVersion | string | Yes | IP protocol version e.g., IPv4, IPv6 |
3061 +-------------+------------+----------+---------------------------------------+
3062 | lac | string | No | Location area code |
3063 +-------------+------------+----------+---------------------------------------+
3064 | mcc | string | No | Mobile country code |
3065 +-------------+------------+----------+---------------------------------------+
3066 | mnc | string | No | Mobile network code |
3067 +-------------+------------+----------+---------------------------------------+
3068 | mobileFlow\ | string | Yes | Version of the mobileFlowFields block |
3069 | Fields\ | | | as "#.#" where # is a digit; see |
3070 | Version | | | section 1 for the correct digits to |
3072 +-------------+------------+----------+---------------------------------------+
3073 | msisdn | string | No | MSISDN for the subscriber UE used in |
3074 | | | | this flow, as an integer, if the flow |
3075 | | | | connects to a mobile device |
3076 +-------------+------------+----------+---------------------------------------+
3077 | other\ | string | Yes | IP address for the other endpoint, as |
3078 | EndpointIp\ | | | used for the flow being reported on |
3080 +-------------+------------+----------+---------------------------------------+
3081 | other\ | integer | Yes | IP Port for the reporting entity, as |
3082 | Endpoint\ | | | used for the flow being reported on |
3084 +-------------+------------+----------+---------------------------------------+
3085 | other\ | string | No | Functional role of the other endpoint |
3086 | Functional\ | | | for the flow being reported on e.g., |
3087 | Role | | | MME, S-GW, P-GW, PCRF... |
3088 +-------------+------------+----------+---------------------------------------+
3089 | rac | string | No | Routing area code |
3090 +-------------+------------+----------+---------------------------------------+
3091 | radioAccess\| string | No | Radio Access Technology e.g., 2G, 3G, |
3092 | Technology | | | LTE |
3093 +-------------+------------+----------+---------------------------------------+
3094 | reporting\ | string | Yes | IP address for the reporting entity, |
3095 | EndpointIp\ | | | as used for the flow being reported on|
3097 +-------------+------------+----------+---------------------------------------+
3098 | reporting\ | integer | Yes | IP port for the reporting entity, as |
3099 | EndpointPort| | | used for the flow being reported on |
3100 +-------------+------------+----------+---------------------------------------+
3101 | sac | string | No | Service area code |
3102 +-------------+------------+----------+---------------------------------------+
3103 | sampling\ | integer | No | Integer identifier for the sampling |
3104 | Algorithm | | | algorithm or rule being applied in |
3105 | | | | calculating the flow metrics if |
3106 | | | | metrics are calculated based on a |
3107 | | | | sample of packets, or 0 if no sampling|
3108 | | | | is applied |
3109 +-------------+------------+----------+---------------------------------------+
3110 | tac | string | No | Transport area code |
3111 +-------------+------------+----------+---------------------------------------+
3112 | tunnelId | string | No | Tunnel identifier |
3113 +-------------+------------+----------+---------------------------------------+
3114 | vlanId | string | No | VLAN identifier used by this flow |
3115 +-------------+------------+----------+---------------------------------------+
3117 ‘SipSignaling’ Domain Datatypes
3118 +++++++++++++++++++++++++++++++
3120 Datatype: sipSignalingFields
3121 ****************************
3123 The sipSignalingFields datatype communicates information about sip
3124 signaling messages, parameters and signaling state; it consists of the
3127 +--------------+-----------+----------+---------------------------------------+
3128 | Field | Type | Required?| Description |
3129 +==============+===========+==========+=======================================+
3130 | additional\ | hashMap | No | Additional sipSignaling fields |
3131 | Information | | | |
3132 +--------------+-----------+----------+---------------------------------------+
3133 | compressed\ | string | No | The full SIP request/response |
3134 | Sip | | | including headers and bodies |
3135 +--------------+-----------+----------+---------------------------------------+
3136 | correlator | string | Yes | Constant across all events on this |
3138 +--------------+-----------+----------+---------------------------------------+
3139 | local\ | string | Yes | Ip address on xNF |
3141 +--------------+-----------+----------+---------------------------------------+
3142 | localPort | string | Yes | Port on xNF |
3143 +--------------+-----------+----------+---------------------------------------+
3144 | remote\ | string | Yes | IP address of peer endpoint |
3146 +--------------+-----------+----------+---------------------------------------+
3147 | remotePort | string | Yes | Port of peer endpoint |
3148 +--------------+-----------+----------+---------------------------------------+
3149 | sipSignaling\| string | Yes | Version of the sipSignalingFields |
3150 | FieldsVersion| | | block as "#.#" where # is a digit; see|
3151 | | | | section 1 for the correct digits to |
3153 +--------------+-----------+----------+---------------------------------------+
3154 | summarySip | string | No | The SIP Method or Response (‘INVITE’, |
3155 | | | | ‘200 OK’, ‘BYE’, etc) |
3156 +--------------+-----------+----------+---------------------------------------+
3157 | vendorNf\ | vendorNf | Yes | Vendor, NF and nfModule names |
3158 | NameFields | NameFields| | |
3159 +--------------+-----------+----------+---------------------------------------+
3161 ‘Voice Quality’ Domain Datatypes
3162 ++++++++++++++++++++++++++++++++
3164 Datatype: endOfCallVqmSummaries
3165 *******************************
3167 The endOfCallVqmSummaries datatype provides end of call voice quality
3168 metrics; it consists of the following fields:
3170 +--------------+-------+----------+-------------------------------------------+
3171 | Field | Type | Required?| Description |
3172 +==============+=======+==========+===========================================+
3173 | adjacency\ | string| Yes | Adjacency name |
3175 +--------------+-------+----------+-------------------------------------------+
3176 | endpoint\ | number| No | Endpoint average jitter |
3177 | AverageJitter| | | |
3178 +--------------+-------+----------+-------------------------------------------+
3179 | endpoint\ | string| Yes | Enumeration: ‘Caller’, ‘Callee’ |
3180 | Description | | | |
3181 +--------------+-------+----------+-------------------------------------------+
3182 | endpoint\ | number| No | Endpoint maximum jitter |
3184 +--------------+-------+----------+-------------------------------------------+
3185 | endpointRtp\ | number| No | Endpoint RTP octets discarded |
3188 +--------------+-------+----------+-------------------------------------------+
3189 | endpointRtp\ | number| No | Endpoint RTP octets lost |
3190 | OctetsLost | | | |
3191 +--------------+-------+----------+-------------------------------------------+
3192 | endpointRtp\ | number| No | Endpoint RTP octets received |
3195 +--------------+-------+----------+-------------------------------------------+
3196 | endpointRtp\ | number| No | Endpoint RTP octets sent |
3197 | OctetsSent | | | |
3198 +--------------+-------+----------+-------------------------------------------+
3199 | endpointRtp\ | number| No | Endpoint RTP packets discarded |
3202 +--------------+-------+----------+-------------------------------------------+
3203 | endpointRtp\ | number| No | Endpoint RTP packets lost |
3204 | PacketsLost | | | |
3205 +--------------+-------+----------+-------------------------------------------+
3206 | endpointRtp\ | number| No | Endpoint RTP packets received |
3209 +--------------+-------+----------+-------------------------------------------+
3210 | endpointRtp\ | number| No | Endpoint RTP packets sent |
3211 | PacketsSent | | | |
3212 +--------------+-------+----------+-------------------------------------------+
3213 | local\ | number| No | Local average jitter |
3216 +--------------+-------+----------+-------------------------------------------+
3217 | localAverage\| number| No | Local average jitter buffer delay |
3218 | JitterBuffer\| | | |
3220 +--------------+-------+----------+-------------------------------------------+
3221 | localMax\ | number| No | Local maximum jitter |
3223 +--------------+-------+----------+-------------------------------------------+
3224 | localMax\ | number| No | Local max jitter buffer delay |
3225 | JitterBuffer\| | | |
3227 +--------------+-------+----------+-------------------------------------------+
3228 | localRtp\ | number| No | Local RTP octets discarded |
3231 +--------------+-------+----------+-------------------------------------------+
3232 | localRtp\ | number| No | Local RTP octets lost |
3233 | OctetsLost | | | |
3234 +--------------+-------+----------+-------------------------------------------+
3235 | localRtp\ | number| No | Local RTP octets received |
3238 +--------------+-------+----------+-------------------------------------------+
3239 | localRtp\ | number| No | Local RTP octets sent |
3240 | OctetsSent | | | |
3241 +--------------+-------+----------+-------------------------------------------+
3242 | localRtp\ | number| No | Local RTP packets discarded |
3245 +--------------+-------+----------+-------------------------------------------+
3246 | localRtp\ | number| No | Local RTP packets lost |
3247 | PacketsLost | | | |
3248 +--------------+-------+----------+-------------------------------------------+
3249 | localRtp\ | number| No | Local RTP packets received |
3252 +--------------+-------+----------+-------------------------------------------+
3253 | localRtp\ | number| No | Local RTP packets sent |
3254 | PacketsSent | | | |
3255 +--------------+-------+----------+-------------------------------------------+
3256 | mosCqe | number| No | Decimal range from 1 to 5(1 decimal place)|
3257 +--------------+-------+----------+-------------------------------------------+
3258 | oneWayDelay | number| No | one-way path delay in milliseconds |
3259 +--------------+-------+----------+-------------------------------------------+
3260 | packet\ | number| No | Calculated percentage packet loss based on|
3261 | LossPercent | | | endpoint RTP packets lost (as reported in |
3262 | | | | RTCP) and local RTP packets sent. |
3263 | | | | Direction is based on endpoint description|
3264 | | | | (Caller, Callee). Decimal (2 decimal |
3266 +--------------+-------+----------+-------------------------------------------+
3267 | rFactor | number| No | rFactor from 0 to 100 |
3268 +--------------+-------+----------+-------------------------------------------+
3269 | round\ | number| No | Round trip delay in milliseconds |
3271 +--------------+-------+----------+-------------------------------------------+
3273 Datatype: voiceQualityFields
3274 ****************************
3276 The voiceQualityFields datatype provides statistics related to customer
3277 facing voice products; consists of the following fields:
3279 +--------------+-------------+----------+-------------------------------------+
3280 | Field | Type | Required?| Description |
3281 +==============+=============+==========+=====================================+
3282 | additional\ | hashMap | No | Additional voice quality fields |
3283 | Information | | | |
3284 +--------------+-------------+----------+-------------------------------------+
3285 | callee\ | string | Yes | Callee codec for the call |
3287 +--------------+-------------+----------+-------------------------------------+
3288 | caller\ | string | Yes | Caller codec for the call |
3290 +--------------+-------------+----------+-------------------------------------+
3291 | correlator | string | Yes | Constant across all events on this |
3293 +--------------+-------------+----------+-------------------------------------+
3294 | endOfCall\ | endOfCallVqm| No | End of call voice quality metric |
3295 | VqmSummaries | Summaries | | summaries |
3296 +--------------+-------------+----------+-------------------------------------+
3297 | phoneNumber | string | No | Phone number associated with the |
3298 | | | | correlator |
3299 +--------------+-------------+----------+-------------------------------------+
3300 | midCallRtcp | string | Yes | Base64 encoding of the binary RTCP |
3301 | | | | data (excluding Eth/IP/UDP headers) |
3302 +--------------+-------------+----------+-------------------------------------+
3303 | vendorNf\ | vendorNf | Yes | Vendor, NF and nfModule names |
3304 | NameFields | NameFields | | |
3305 +--------------+-------------+----------+-------------------------------------+
3306 | voiceQuality\| string | Yes | Version of the voiceQualityFields |
3307 | FieldsVersion| | | block as "#.#" where # is a digit; |
3308 | | | | see section 1 for the correct digits|
3310 +--------------+-------------+----------+-------------------------------------+
3313 RESTful Web Services Definition
3314 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3319 Event sources must identify themselves to the VES Event Listener.
3321 There are 2 methods of HTTP authentication supported: Certificate Authentication
3322 and Basic Authentication.
3324 Basic authentication is supported in VES Event Listener for backward
3325 compatibility for existing NFs that are already managed by ONAP. New NFs should
3326 support Certificate Authentication. Because the security is better, NFs may
3327 choose to only support Certificate Authentication and not support Basic
3330 Basic Authentication
3331 ++++++++++++++++++++
3333 When using Basic Authentication, the event source must not pass credentials on
3334 the query string. Credentials must be sent in an Authorization header as
3337 1. The username and password are formed into one string as
3338 ``username:password``
3339 2. The resulting string is Base64 encoded to produce the encoded credential.
3340 3. The encoded credential is communicated in the header after the string
3341 ``Authorization: Basic``
3343 Because the credentials are merely encoded but not encrypted, HTTPS (rather
3344 than HTTP) should be used. HTTPS will also encrypt and protect event contents.
3346 Sample Request and Response
3347 +++++++++++++++++++++++++++
3352 .. code-block:: http
3354 POST /eventListener/v7 HTTP/1.1
3355 Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
3356 content-type: application/json
3357 content-length: 12345
3360 "commonEventHeader": {
3362 "vesEventListenerVersion": "7.2",
3363 "domain": "heartbeat",
3364 "eventName": "Heartbeat_vIsbcMmc",
3365 "eventId": "heartbeat0000249",
3367 "priority": "Normal",
3368 "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234",
3369 "reportingEntityName": "ibcx0001vm002oam001",
3370 "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014",
3371 "sourceName": "ibcx0001vm002ssc001",
3372 "nfVendorName": "Ericsson",
3373 "nfNamingCode": "ibcx",
3374 "nfcNamingCode": "ssc",
3375 "startEpochMicrosec": 1413378172000000,
3376 "lastEpochMicrosec": 1413378172000000,
3377 "timeZoneOffset": "UTC-05:30"
3383 Sample Success Response
3384 ***********************
3386 .. code-block:: http
3388 HTTPS/1.1 202 Accepted
3391 X-LatestVersion: 7.2
3394 Mutual TLS Certificate Authentication
3395 +++++++++++++++++++++++++++++++++++++
3397 When using Certificate Authentication, the event source must initialize the
3398 HTTPS connection with TLS 1.2 or higher and execute mutual authentication
3399 procedures according to `RFC5246 <https://tools.ietf.org/html/rfc5246#section-7.4.6>`__.
3400 The event source must authenticate the VES Listener certificate and must
3401 provide its own X.509v3 end-entity certificate to the VES Listener for
3402 authentication. The Subject Name in the end-entity certificate must be used
3403 according to `RFC5280 <https://www.ietf.org/rfc/rfc5280.txt>`__. If a
3404 certificate is provided by the NF but it is invalid, the VES Listener is
3405 expected to reject the connection and not fall back to basic authentication.
3410 REST resources are defined with respect to a ServerRoot:
3412 ServerRoot = https://{Domain|IP}:{Port}/{optionalRoutingPath}
3414 The resource structure is provided below::
3418 |--- /eventListener/v{apiVersion}
3422 **Figure 1**: REST Resource Structure
3427 RESTful Web Services Exceptions
3428 +++++++++++++++++++++++++++++++
3430 RESTful services generate and send exceptions to clients in response to
3431 invocation errors. Exceptions send HTTP status codes (specified later in
3432 this document for each operation). HTTP status codes may be followed by
3433 an optional JSON exception structure described below. Two types of
3434 exceptions may be defined: service exceptions and policy exceptions.
3436 +-----------+---------------+-------------+-----------------------------------+
3437 | Field Name| Data Type | Required? | Description |
3438 +===========+===============+=============+===================================+
3439 | messageId | xs:string | Yes | Unique message identifier of the |
3440 | | | | format ‘ABCnnnn’ where ‘ABC’ is |
3441 | | | | either ‘SVC’ for Service |
3442 | | | | Exceptions or ‘POL’ for Policy |
3443 | | | | Exception. |
3445 | | | | Exception numbers may be in the |
3446 | | | | range of 0001 to 9999 where : |
3448 | | | | - 0001 to 2999 are defined by OMA|
3449 | | | | (see OMA’s Common_definitions_ |
3450 | | | | for details) |
3452 | | | | - 3000-9999 are available and |
3454 +-----------+---------------+-------------+-----------------------------------+
3455 | text | xs:string | Yes | Message text, with replacement |
3456 | | | | variables marked with %n, where n |
3457 | | | | is an index into the list of |
3458 | | | | <variables> elements, starting at |
3460 +-----------+---------------+-------------+-----------------------------------+
3461 | variables | xs:string | No | List of zero or more strings that |
3462 | | [0..unbounded]| | represent the contents of the |
3463 | | | | variables used by the message text|
3464 +-----------+---------------+-------------+-----------------------------------+
3465 | url | xs:anyUrl | No | Hyperlink to a detailed error |
3466 | | | | resource (e.g., an HTML page for |
3467 | | | | browser user agents). |
3468 +-----------+---------------+-------------+-----------------------------------+
3473 When a service is not able to process a request, and retrying the
3474 request with the same information will also result in a failure, and
3475 the issue is not related to a service policy issue, then the service
3476 will issue a fault using the service exception fault message.
3477 Examples of service exceptions include invalid input, lack of
3478 availability of a required resource or a processing error.
3480 A service exception uses the letters 'SVC' at the beginning of the
3481 message identifier. ‘SVC’ service exceptions used by the VES Event
3482 Listener API are defined below.
3484 +----------+--------------+-----------------------+----------------+----------+
3485 | MessageId| Description | Text | Variables | Parent |
3486 | | / Comment | | | HTTP Code|
3487 +==========+==============+=======================+================+==========+
3488 | SVC0001 | General | <custom error message>| None | 400 |
3489 | | service error| | | |
3490 | | (see SVC2000)| | | |
3491 +----------+--------------+-----------------------+----------------+----------+
3492 | SVC0002 | Bad parameter| Invalid input value | %1: message | 400 |
3493 | | | for message part %1 | part | |
3494 +----------+--------------+-----------------------+----------------+----------+
3495 | SVC1000 | No server | No server resources | None | 500 |
3496 | | resources | available to process | | |
3497 | | | the request | | |
3498 +----------+--------------+-----------------------+----------------+----------+
3499 | SVC2000 | More | The following service | %1: human | 400 |
3500 | | elaborate | error occurred: %1. | readable | |
3501 | | version of | | description of | |
3502 | | SVC0001 | | the error | |
3504 | | | Error code is %2. | %2: error code | |
3505 +----------+--------------+-----------------------+----------------+----------+
3506 | SVC2004 | Invalid input| Invalid input value | %1: attribute | 400 |
3507 | | value | for %1 %2: %3 | | |
3508 | | | | %2: event.com\ | |
3509 | | | | monEventHeader\| |
3510 | | | | .stndDefined\ | |
3511 | | | | Namespace | |
3513 | | | | %3: Unable to | |
3514 | | | | route event | |
3516 +----------+--------------+-----------------------+----------------+----------+
3517 | SVC2006 | Mandatory | Mandatory input %1 %2 | %1: attribute | 400 |
3518 | | input missing| is missing from | | |
3519 | | | request | %2: event.com\ | |
3520 | | | | monEventHeader\| |
3521 | | | | .stndDefined\ | |
3522 | | | | Namespace | |
3523 +----------+--------------+-----------------------+----------------+----------+
3526 Table - Service Exceptions
3531 When a service is not able to complete because the request fails to
3532 meet a policy criteria, then the service will issue a fault using the
3533 policy exception fault message. To clarify how a policy exception
3534 differs from a service exception, consider that all the input to an
3535 operation may be valid as meeting the required input for the
3536 operation (thus no service exception), but using that input in the
3537 execution of the service may result in conditions that require the
3538 service not to complete. Examples of policy exceptions include
3539 privacy violations, requests not permitted under a governing service
3540 agreement or input content not acceptable to the service provider.
3542 A Policy Exception uses the letters 'POL' at the beginning of the
3543 message identifier. ‘POL’ policy exceptions used by the VES Event
3544 Listener API are defined below.
3546 +----------+---------------+-----------------------+---------------+----------+
3547 | MessageId| Description |Text | Variables | Parent |
3548 | | / Comment | | | HTTP Code|
3549 +==========+===============+=======================+===============+==========+
3550 | POL0001 | General policy| A policy error | None | 401 |
3551 | | error (see | occurred. | | |
3552 | | POL2000) | | | |
3553 +----------+---------------+-----------------------+---------------+----------+
3554 | POL1009 | User not | User has not been | None | 401 |
3555 | | provisioned | provisioned for | | |
3556 | | for service | service | | |
3557 +----------+---------------+-----------------------+---------------+----------+
3558 | POL1010 | User suspended| User has been | None | 401 |
3559 | | from service | suspended from service| | |
3560 +----------+---------------+-----------------------+---------------+----------+
3561 | POL2000 | More elaborate| The following policy | %1: human | 401 |
3562 | | version of | error occurred: %1. | readable | |
3563 | | POL0001 | Error code is %2. | description of| |
3564 | | | | the error | |
3566 | | | | %2: error code| |
3567 +----------+---------------+-----------------------+---------------+----------+
3568 | POL9003 | Message size | Message content size | None | 400 |
3569 | | exceeds limit | exceeds the allowable | | |
3571 +----------+---------------+-----------------------+---------------+----------+
3573 Table - Policy Exceptions
3575 REST Operation Overview
3576 ~~~~~~~~~~~~~~~~~~~~~~~
3578 REST Operation Summary
3579 ++++++++++++++++++++++
3581 +---------------------+---------+------------------------------------------+
3582 | **Operation Action**| **HTTP**| Resource URL relative to {ServerRoot}\ |
3583 | | | , which is defined in section 3 |
3585 +---------------------+---------+------------------------------------------+
3586 | publishAnyEvent | POST | /eventListener/v{apiVersion} |
3587 +---------------------+---------+------------------------------------------+
3588 | publishEventBatch | POST | /eventListener/v{apiVersion}/eventBatch |
3589 +---------------------+---------+------------------------------------------+
3591 Table - REST Operation Summary
3596 ``apiVersion`` is used to describe the major version number of the event
3597 listener API (which is the same as the major version number of this
3598 specification). When this number changes, the implication is: the new
3599 major version will break clients of older major versions in some way, if
3600 they try to use the new API without modification (e.g., unmodified v1
3601 clients would not be able to use v2 without error).
3603 The Event Listener shall provide the following HTTP headers in response
3604 to all requests. Additionally, clients may populate these headers on
3605 requests to indicate the specific version they are interested in.
3611 - X-LatestVersion: 7.2
3613 If a client requests major version 7 (per the REST resource URL) and
3614 does not specify the above headers, then they will be provided with the
3615 latest patch version of 7.0.x (which is 7.0.1). If the client wants a
3616 minor version of major version 7, then they need to supply
3617 the X-MinorVersion header with their request. For example, if they
3618 request major version 7 with X-MinorVersion: 1, they will get the latest
3619 patch version of 7.1, which is 7.1.1.
3621 .. _ves_msg_size_7_2:
3626 The maximum allowed message size is 2 megabytes of uncompressed text.
3627 However, messages of this size have been known to cause performance and data
3628 loss. It is strongly recommended, that messages not exceed 1 megabyte.
3629 In a future version of the specification, a 1 megabyte limit will become
3630 a mandatory requirement.
3632 Operation: publishAnyEvent
3633 ~~~~~~~~~~~~~~~~~~~~~~~~~~
3638 Allows authorized clients to publish any single event to the VES event
3641 - Supports only HTTPS access.
3643 - Uses the HTTP verb POST
3645 - Supports JSON content types
3647 - Provides HTTP response codes as well as Service and Policy error
3654 :caption: ``publishAnyEvent`` Call Flow
3658 client -> listener [label = "POST /eventlistener/v7"];
3659 client <- listener [label = "HTTP 202 Accepted", note = "sync response"];
3660 === Error Scenario ===
3661 client -> listener [label = "POST /eventlistener/v7"];
3662 client <- listener [label = "HTTP 4XX/5XX", note = "sync response"];
3668 Header Fields (note: all parameter names shall be treated as
3671 +---------------+----------+----------+---------------------------------------+
3672 | Parameter | Data Type| Required?| Brief description |
3673 +---------------+----------+----------+---------------------------------------+
3674 | Accept | string | No | Determines the format of the body of |
3675 | | | | the response. Valid values are: |
3677 | | | | - application/json |
3678 +---------------+----------+----------+---------------------------------------+
3679 | Authorization | string | No | The username and password are formed |
3680 | | | | into one string as |
3681 | | | | ``username:password``. This string is |
3682 | | | | then Base64 encoded to produce the |
3683 | | | | encoded credential which is |
3684 | | | | communicated in the header after the |
3685 | | | | string "Authorization: Basic ". See |
3686 | | | | examples below. If the Authorization |
3687 | | | | header is missing, then an HTTP 400 |
3688 | | | | Invalid Request message shall be |
3689 | | | | returned. If the string supplied is |
3690 | | | | invalid, then an HTTP 401 Unauthorized|
3691 | | | | message shall be returned. |
3692 +---------------+----------+----------+---------------------------------------+
3693 | Content-length| integer | No | Note that content length is limited to|
3694 | | | | 2 Megabyte |
3695 | | | | (see :ref:`ves_msg_size_7_2`) |
3696 +---------------+----------+----------+---------------------------------------+
3697 | Content-type | string | Yes | Must be set to one of the following |
3700 | | | | - application/json |
3701 +---------------+----------+----------+---------------------------------------+
3702 | X-MinorVersion| integer | No | The minor version of the API requested|
3703 | | | | by the client |
3704 +---------------+----------+----------+---------------------------------------+
3705 | X-PatchVersion| integer | No | The patch version of the API requested|
3706 | | | | by the client |
3707 +---------------+----------+----------+---------------------------------------+
3708 | X-Latest\ | string | No | The full version of the API requested |
3709 | Version | | | by the client expressed as |
3710 | | | | {major}.{minor}.{patch} |
3711 +---------------+----------+----------+---------------------------------------+
3715 +--------------+--------------+--------------+-------------------------------+
3716 | **Parameter**| **Data Type**| **Required?**| **Brief description** |
3717 +--------------+--------------+--------------+-------------------------------+
3718 | Event | event | Yes | Contains the JSON structure of|
3719 | | | | the common event format. |
3720 +--------------+--------------+--------------+-------------------------------+
3727 +----------------+--------------+--------------+------------------------------+
3728 | **Parameter** | **Data Type**| **Required?**| **Brief description** |
3729 +----------------+--------------+--------------+------------------------------+
3730 | Content-length | integer | No | Used only in error conditions|
3731 +----------------+--------------+--------------+------------------------------+
3732 | Content-type | string | No | Used only in error conditions|
3733 +----------------+--------------+--------------+------------------------------+
3734 | Date | datetime | No | Date time of the response in |
3736 +----------------+--------------+--------------+------------------------------+
3737 | X-MinorVersion | integer | Yes | The minor version of the API |
3739 +----------------+--------------+--------------+------------------------------+
3740 | X-PatchVersion | integer | Yes | The patch version of the API |
3742 +----------------+--------------+--------------+------------------------------+
3743 | X-LatestVersion| string | Yes | The full version of the API |
3744 | | | | service expressed as {major}.|
3745 | | | | {minor}.{patch} |
3746 +----------------+--------------+--------------+------------------------------+
3748 Body Fields (for success responses): no content is provided.
3750 Body Fields (for error responses):
3752 +--------------+--------------+----------------+------------------------------+
3753 | **Parameter**| **Data Type**| **Required?** | **Brief description** |
3754 +--------------+--------------+----------------+------------------------------+
3755 | requestError | requestError | Yes(for errors)| Used only in error conditions|
3756 +--------------+--------------+----------------+------------------------------+
3761 +-----+--------------+--------------------------------------------------------+
3762 | Code| Reason Phrase| Description |
3763 +=====+==============+========================================================+
3764 | 202 | Accepted | The request has been accepted for processing |
3765 +-----+--------------+--------------------------------------------------------+
3766 | 400 | Bad Request | Many possible reasons not specified by the other codes |
3767 | | | (e.g., missing required parameters or incorrect format)|
3768 | | | . The response body may include a further exception |
3769 | | | code and text. HTTP 400 errors may be mapped to SVC0001|
3770 | | | (general service error), SVC0002 (bad parameter), |
3771 | | | SVC2004 (Invalid input value), SVC2006 (Mandatory input|
3772 | | | is missing from request), SVC2000 (general service |
3773 | | | error with details) or PO9003 (message content size |
3774 | | | exceeds the allowable limit). |
3775 +-----+--------------+--------------------------------------------------------+
3776 | 401 | Unauthorized | Authentication failed or was not provided. HTTP 401 |
3777 | | | errors may be mapped to POL0001 (general policy error) |
3778 | | | or POL2000 (general policy error with details). |
3779 +-----+--------------+--------------------------------------------------------+
3780 | 404 | Not Found | The server has not found anything matching the |
3781 | | | Request-URI. No indication is given of whether the |
3782 | | | condition is temporary or permanent. |
3783 +-----+--------------+--------------------------------------------------------+
3784 | 405 | Method Not | A request was made of a resource using a request method|
3785 | | Allowed | not supported by that resource (e.g., using PUT on a |
3786 | | | REST resource that only supports POST). |
3787 +-----+--------------+--------------------------------------------------------+
3788 | 500 | Internal | The server encountered an internal error or timed out; |
3789 | | Server Error | please retry (general catch-all server-side error).HTTP|
3790 | | | 500 errors may be mapped to SVC1000 (no server |
3792 +-----+--------------+--------------------------------------------------------+
3794 Sample Request and Response
3795 +++++++++++++++++++++++++++
3800 .. code-block:: http
3802 POST /eventListener/v7 HTTP/1.1
3803 Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
3804 content-type: application/json
3805 content-length: 12345
3810 "commonEventHeader": {
3812 "vesEventListenerVersion": "7.2",
3814 "eventName": "Fault_Vscf:Acs-Ericcson_PilotNumberPoolExhaustion",
3815 "eventId": "fault0000245",
3818 "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234",
3819 "reportingEntityName": "ibcx0001vm002oam001",
3820 "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014",
3821 "sourceName": "scfx0001vm002cap001",
3822 "nfVendorName": "Ericsson",
3823 "nfNamingCode": "scfx",
3824 "nfcNamingCode": "ssc",
3825 "startEpochMicrosec": 1413378172000000,
3826 "lastEpochMicrosec": 1413378172000000,
3827 "timeZoneOffset": "UTC-05:30"
3830 "faultFieldsVersion": 4.0,
3831 "alarmCondition": "PilotNumberPoolExhaustion",
3832 "eventSourceType": "other",
3833 "specificProblem": "Calls cannot complete - pilot numbers are unavailable",
3834 "eventSeverity": "CRITICAL",
3835 "vfStatus": "Active",
3836 "alarmAdditionalInformation": {
3837 "PilotNumberPoolSize": "1000"
3845 Sample Success Response
3846 ***********************
3848 .. code-block:: http
3850 HTTPS/1.1 202 Accepted
3853 X-LatestVersion: 7.2
3855 Sample Error Responses
3856 **********************
3858 Sample Policy Exception
3859 """""""""""""""""""""""
3861 .. code-block:: http
3863 HTTPS/1.1 400 Bad Request
3864 content-type: application/json
3865 content-length: 12345
3866 Date: Thu, 04 Jun 2009 02:51:59 GMT
3869 X-LatestVersion: 7.2
3873 "policyException": {
3874 "messageId": "POL9003",
3875 "text": "Message content size exceeds the allowable limit",
3881 Sample Service Exception
3882 """"""""""""""""""""""""
3884 .. code-block:: http
3886 HTTPS/1.1 400 Bad Request
3887 content-type: application/json
3888 content-length: 12345
3889 Date: Thu, 04 Jun 2009 02:51:59 GMT
3892 X-LatestVersion: 7.2
3896 "serviceException": {
3897 "messageId": "SVC2000",
3898 "text": "Missing Parameter: %1. Error code is %2"
3907 Operation: publishEventBatch
3908 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3913 Allows authorized clients to publish a batch of events to the VES event
3916 - Supports only HTTPS access.
3918 - Uses the HTTP verb POST
3920 - Supports JSON content types
3922 - Provides HTTP response codes as well as Service and Policy error
3925 ``publishEventBatch`` events are handled similarly to a single event. The
3926 acknowledgement from the VES Event Listener is for the ``publishEventBatch`` and
3927 not individual events within the ``publishEventBatch``.
3933 :caption: ``publishEventBatch`` Call Flow
3937 client -> listener [label = "POST /eventlistener/v7/eventBatch"];
3938 client <- listener [label = "HTTP 202 Accepted", note = "sync response"];
3939 === Error Scenario ===
3940 client -> listener [label = "POST /eventlistener/v7/eventBatch"];
3941 client <- listener [label = "HTTP 4XX/5XX", note = "sync response"];
3947 Header Fields (note: all parameter names shall be treated as
3950 +---------------+----------+----------+---------------------------------------+
3951 | Parameter | Data Type| Required?| Brief description |
3952 +---------------+----------+----------+---------------------------------------+
3953 | Accept | string | No | Determines the format of the body of |
3954 | | | | the response. Valid values are: |
3956 | | | | - application/json |
3957 +---------------+----------+----------+---------------------------------------+
3958 | Authorization | string | No | The username and password are formed |
3959 | | | | into one string as "username:password"|
3960 | | | | . This string is then Base64 encoded |
3961 | | | | to produce the encoded credential |
3962 | | | | which is communicated in the header |
3963 | | | | after the string "Authorization: |
3964 | | | | Basic". See examples below. If the |
3965 | | | | Authorization header is missing, then |
3966 | | | | an HTTP 400 Invalid Request message |
3967 | | | | shall be returned. If the string |
3968 | | | | supplied is invalid, then an HTTP 401 |
3969 | | | | Unauthorized message shall be |
3971 +---------------+----------+----------+---------------------------------------+
3972 | Content-length| integer | No | Note that content length is limited to|
3973 | | | | 2 megabyte |
3974 | | | | (see :ref:`ves_msg_size_7_2`). |
3975 +---------------+----------+----------+---------------------------------------+
3976 | Content-type | string | Yes | Must be set to one of the following |
3979 | | | | - application/json |
3980 +---------------+----------+----------+---------------------------------------+
3981 | X-MinorVersion| integer | No | The minor version of the API requested|
3982 | | | | by the client |
3983 +---------------+----------+----------+---------------------------------------+
3984 | X-PatchVersion| integer | No | The patch version of the API requested|
3985 | | | | by the client |
3986 +---------------+----------+----------+---------------------------------------+
3987 | X-Latest\ | string | No | The full version of the API requested |
3988 | Version | | | by the client expressed as |
3989 | | | | {major}.{minor}.{patch} |
3990 +---------------+----------+----------+---------------------------------------+
3994 +--------------+--------------+--------------+-------------------------------+
3995 | **Parameter**| **Data Type**| **Required?**| **Brief description** |
3996 +--------------+--------------+--------------+-------------------------------+
3997 | eventList | eventList | Yes | Array of events conforming to |
3998 | | | | the common event format. All |
3999 | | | | events must belong to a |
4000 | | | | single domain. |
4001 | | | | In case of stndDefined domain |
4002 | | | | all events must have the same |
4003 | | | | stndDefinedNamespace value |
4005 +--------------+--------------+--------------+-------------------------------+
4012 +----------------+--------------+--------------+------------------------------+
4013 | **Parameter** | **Data Type**| **Required?**| **Brief description** |
4014 +----------------+--------------+--------------+------------------------------+
4015 | Content-length | integer | No | Used only in error conditions|
4016 +----------------+--------------+--------------+------------------------------+
4017 | Content-type | string | No | Used only in error conditions|
4018 +----------------+--------------+--------------+------------------------------+
4019 | Date | datetime | No | Date time of the response in |
4021 +----------------+--------------+--------------+------------------------------+
4022 | X-MinorVersion | integer | Yes | The minor version of the API |
4024 +----------------+--------------+--------------+------------------------------+
4025 | X-PatchVersion | integer | Yes | The patch version of the API |
4027 +----------------+--------------+--------------+------------------------------+
4028 | X-LatestVersion| string | Yes | The full version of the API |
4029 | | | | service expressed as |
4030 | | | | {major}.{minor}.{patch} |
4031 +----------------+--------------+--------------+------------------------------+
4033 Body Fields (for success responses: no content is provided.
4035 Body Fields (for error responses):
4037 +--------------+--------------+----------------+------------------------------+
4038 | **Parameter**| **Data Type**| **Required?** | **Brief description** |
4039 +--------------+--------------+----------------+------------------------------+
4040 | requestError | requestError | Yes(for errors)| Used only in error conditions|
4041 +--------------+--------------+----------------+------------------------------+
4046 +-----+--------------+--------------------------------------------------------+
4047 | Code| Reason Phrase| Description |
4048 +=====+==============+========================================================+
4049 | 202 | Accepted | The request has been accepted for processing |
4050 +-----+--------------+--------------------------------------------------------+
4051 | 400 | Bad Request | Many possible reasons not specified by the other codes |
4052 | | | (e.g., missing required parameters or incorrect format)|
4053 | | | . The response body may include a further exception |
4054 | | | code and text. HTTP 400 errors may be mapped to SVC0001|
4055 | | | (general service error), SVC0002 (bad parameter), |
4056 | | | SVC2000 (general service error with details) or PO9003 |
4057 | | | (message content size exceeds the allowable limit). |
4058 +-----+--------------+--------------------------------------------------------+
4059 | 401 | Unauthorized | Authentication failed or was not provided. HTTP 401 |
4060 | | | errors may be mapped to POL0001 (general policy error) |
4061 | | | or POL2000 (general policy error with details). |
4062 +-----+--------------+--------------------------------------------------------+
4063 | 404 | Not Found | The server has not found anything matching the |
4064 | | | Request-URI. No indication is given of whether the |
4065 | | | condition is temporary or permanent. |
4066 +-----+--------------+--------------------------------------------------------+
4067 | 405 | Method Not | A request was made of a resource using a request method|
4068 | | Allowed | not supported by that resource (e.g., using PUT on a |
4069 | | | REST resource that only supports POST). |
4070 +-----+--------------+--------------------------------------------------------+
4071 | 500 | Internal | The server encountered an internal error or timed out; |
4072 | | Server Error | please retry (general catch-all server-side error).HTTP|
4073 | | | 500 errors may be mapped to SVC1000 (no server |
4075 +-----+--------------+--------------------------------------------------------+
4077 Sample Request and Response
4078 +++++++++++++++++++++++++++
4083 .. code-block:: http
4085 POST /eventListener/v7/eventBatch HTTP/1.1
4086 Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
4087 content-type: application/json
4088 content-length: 12345
4094 "commonEventHeader": {
4096 "vesEventListenerVersion": "7.2",
4098 "eventName": "Fault_Vscf:Acs-Ericcson_PilotNumberPoolExhaustion",
4099 "eventId": "fault0000250",
4102 "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234",
4103 "reportingEntityName": "ibcx0001vm002oam0011234",
4104 "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014",
4105 "sourceName": "scfx0001vm002cap001",
4106 "nfVendorName": "Ericsson",
4107 "nfNamingCode": "scfx",
4108 "nfcNamingCode": "ssc",
4109 "startEpochMicrosec": 1413378172000000,
4110 "lastEpochMicrosec": 1413378172000000,
4111 "timeZoneOffset": "UTC-05:30"
4114 "faultFieldsVersion": 4.0,
4115 "alarmCondition": "PilotNumberPoolExhaustion",
4116 "eventSourceType": "other",
4117 "specificProblem": "Calls cannot complete - pilot numbers are unavailable",
4118 "eventSeverity": "CRITICAL",
4119 "vfStatus": "Active",
4120 "alarmAdditionalInformation": {
4121 "PilotNumberPoolSize": "1000"
4126 "commonEventHeader": {
4128 "vesEventListenerVersion": "7.2",
4130 "eventName": " Fault_Vscf:Acs-Ericcson_RecordingServerUnreachable",
4131 "eventId": "fault0000251",
4134 "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234",
4135 "reportingEntityName": "ibcx0001vm002oam0011234",
4136 "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014",
4137 "sourceName": "scfx0001vm002cap001",
4138 "nfVendorName": "Ericsson",
4139 "nfNamingCode": "scfx",
4140 "nfcNamingCode": "ssc",
4141 "startEpochMicrosec": 1413378172000010,
4142 "lastEpochMicrosec": 1413378172000010,
4143 "timeZoneOffset": "UTC-05:30"
4146 "faultFieldsVersion": 4.0,
4147 "alarmCondition": "RecordingServerUnreachable",
4148 "eventSourceType": "other",
4149 "specificProblem": "Recording server unreachable",
4150 "eventSeverity": "CRITICAL",
4151 "vfStatus": "Active"
4157 Sample Success Response
4158 ***********************
4160 .. code-block:: http
4162 HTTPS/1.1 202 Accepted
4165 X-LatestVersion: 7.2
4167 Sample Error Responses
4168 **********************
4170 Sample Policy Exception
4171 """""""""""""""""""""""
4173 .. code-block:: http
4175 HTTPS/1.1 400 Bad Request
4176 content-type: application/json
4177 content-length: 12345
4178 Date: Thu, 04 Jun 2009 02:51:59 GMT
4181 X-LatestVersion: 7.2
4185 "policyException": {
4186 "messageId": "POL9003",
4187 "text": "Message content size exceeds the allowable limit",
4194 Sample Service Exception
4195 """"""""""""""""""""""""
4197 .. code-block:: http
4199 HTTPS/1.1 400 Bad Request
4200 content-type: application/json
4201 content-length: 12345
4202 Date: Thu, 04 Jun 2009 02:51:59 GMT
4205 X-LatestVersion: 7.2
4209 "serviceException": {
4210 "messageId": "SVC2000",
4211 "text": "Missing Parameter: %1. Error code is %2"
4224 Terminology used in this document is summarized below:
4226 **A&AI**. Active & Available Inventory is the ONAP component that
4227 provides data views of Customer Subscriptions, Products, Services,
4228 Resources, and their relationships.
4230 **Alarm Condition**. Short name of the alarm condition/problem, such as
4233 **APPC (formerly APP-C)**. Application Controller. Handles the life
4234 cycle management of Virtual Network Functions (VNFs).
4236 **Common Event Format**. A JSON schema describing events sent to the VES
4239 **Common Event Header**. A component of the Common Event Format JSON
4240 structure. This datatype consists of fields common to all events.
4242 **DCAE**. Data Collection Analysis and Events. DCAE is the ONAP
4243 subsystem that supports closed loop control and higher-level correlation
4244 for business and operations activities. DCAE collects performance,
4245 usage, and configuration data, provides computation of analytics, aids
4246 in trouble-shooting and management, and publishes event, data, and
4247 analytics to the rest of the ONAP system for FCAPS functionality.
4249 **DMaaP.** Data Movement as a Platform. A set of common services
4250 provided by ONAP, including a Message Router, Data Router, and a Data
4253 **Domain**. In VES, an event ‘domain’ identifies a broad category of
4254 events (e.g., ‘fault’ or ‘measurement’), each of which is associated
4255 with a VES domain field block, which is sent with the commonEventHeader
4256 when events of that category are generated.
4258 **Epoch**. The number of seconds that have elapsed since
4259 00:00:00 \ `Coordinated Universal
4260 Time <https://en.wikipedia.org/wiki/Coordinated_Universal_Time>`__ (UTC),
4261 Thursday, 1 January 1970. Every day is treated as if it contains exactly
4262 86400 seconds, so \ `leap
4263 seconds <https://en.wikipedia.org/wiki/Leap_second>`__ are not applied
4264 to seconds since the Epoch. In VES Epoch times are measured in
4267 **Event.** A well-structured packet of network management information
4268 identified by an eventName which is asynchronously communicated to one
4269 or more instances of an Event Listener service to subscribers interested
4270 in that eventName. Events can convey measurements, faults, syslogs,
4271 threshold crossing alerts, and others types of information.
4273 **Event Id**. Event key that is unique to the event source. The key must
4274 be unique within notification life cycle similar to EventID from 3GPP.
4275 It could be a sequential number, or a composite key formed from the
4276 event fields, such as sourceName\_alarmCondition\_startEpoch. The
4277 eventId should not include whitespace. For fault events, eventId is the
4278 eventId of the initial alarm; if the same alarm is raised again for
4279 changed, acknowledged or cleared cases, eventId must be the same as the
4280 initial alarm (along with the same startEpochMicrosec and an incremental
4283 **Event Name**. Identifier for specific types of events. Specific
4284 eventNames registered by the YAML may require that certain fields, which
4285 are optional in the Common Event Format, be present when events with
4286 that eventName are published.
4288 **Event Streaming**. The delivery of network management event
4289 information in real time.
4291 **Extensible Data Structures**. Data structures (e.g., hashMap) that
4292 allow event sources to send information not specifically identified in
4295 **Hash Map**. A hash table, or data structure, used to implement an
4296 associative array, a structure than can map keys to values. In VES 6.0,
4297 all name-value pair structures were changed to hash maps (i.e., {‘name’:
4298 ‘keyName’, ‘value’: ‘keyValue’} was replaced with {‘keyName’:
4301 **IPMI**. The `Intelligent Platform Management
4302 Interface <https://en.wikipedia.org/wiki/Intelligent_Platform_Management_Interface>`__.
4304 **JSON**. Java Script Object Notation. JSON is an
4305 `open-standard <https://en.wikipedia.org/wiki/Open_standard>`__ `file
4306 format <https://en.wikipedia.org/wiki/File_format>`__ that uses
4307 `human-readable <https://en.wikipedia.org/wiki/Human-readable_medium>`__
4308 text to transmit data objects consisting of `attribute–value
4309 pairs <https://en.wikipedia.org/wiki/Attribute%E2%80%93value_pair>`__
4310 and `array data types <https://en.wikipedia.org/wiki/Array_data_type>`__
4312 `serializable <https://en.wikipedia.org/wiki/Serialization>`__ value).
4313 It is a very common `data <https://en.wikipedia.org/wiki/Data>`__ format
4315 `asynchronous <https://en.wikipedia.org/wiki/Asynchronous_I/O>`__
4316 browser–server communication.
4318 **NF**. Network Function. Generalized name for a VNF or PNF.
4320 **NFC**. Network Function Component. Generalized name for a VNFC or a
4323 **ONAP**. `Open Network Automation Platform <https://www.onap.org/>`__.
4325 **PNF**. Physical Network Function.
4327 **Policy**. Course of action for the management of the network. The ONAP
4328 Policy Framework is a comprehensive policy design, deployment, and
4329 execution environment. The Policy Framework is the ***decision making***
4330 component in `an ONAP
4331 system <https://www.onap.org/wp-content/uploads/sites/20/2017/12/ONAP_CaseSolution_Architecture_120817_FNL.pdf>`__.
4332 It allows you to specify, deploy, and execute the governance of the
4333 features and functions in your ONAP system, be they closed loop,
4334 orchestration, or more traditional open loop use case implementations.
4335 The Policy Framework is the component that is the source of truth for
4336 all policy decisions.
4338 **Reporting Entity Name**. Name of the entity reporting the event or
4339 detecting a problem in another vnf/vm or pnf which is experiencing the
4340 problem. May be the same as the sourceName. Not used for performance
4341 measurements currently.
4343 **SDC**. Service Design and Creation Platform: The ONAP visual modeling
4344 and design tool. It creates internal metadata that describes assets used
4345 by all ONAP components, both at design time and run time. The SDC
4346 manages the content of a catalog, and assemblies of selected catalog to
4347 define how and when VNFs are realized in a target environment.
4349 **Source Name**: Name of the entity experiencing the event issue, which
4350 may be detected and reported by a separate reporting entity. The
4351 sourceName identifies the device for which data is collected. A valid
4352 sourceName must be inventoried in A&AI.
4354 **Specific Problem**. Description of the alarm or problem.
4356 **VES**. Virtual Function Event Stream. In 6.0, the definition of VES
4357 was expanded to include event streaming for VNF, PNF and infrastructure.
4358 The VES Event Listener can receive any event sent in the VES Common
4361 **VES Event Listener**. A RESTful connectionless push event listener
4362 capable of receiving single events or batches of events sent in the
4363 Common Event Format.
4365 **VM**. Virtual Machine.
4367 **VNF**. Virtual Network Function. A VNF is a virtualized task formerly
4368 carried out by proprietary, dedicated network hardware. (Examples:
4369 virtual firewall, virtual DNS). A VNF can also be defined as a specific
4370 kind of Vendor Software Product.
4372 **YAML**. A `data serialization
4373 language <https://en.wikipedia.org/wiki/Data_serialization_language>`__
4374 and superset of JSON.
4376 **VNFC**. Virtual Network Function Component. A VNFC is a part of a VNF.
4377 It is a stand-alone executable that is loosely-coupled, granular,
4378 re-usable, and responsible for a single capability.
4380 Appendix: Historical Change Log
4381 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4383 For the latest changes, see the Change Block just before the Table of
4386 +-----------+---------+-------------------------------------------------------+
4387 | Date | Revision| Description |
4388 +-----------+---------+-------------------------------------------------------+
4389 | 5/22/2015 | 0.1 | Initial Release - Draft |
4390 +-----------+---------+-------------------------------------------------------+
4391 | 5/29/2015 | 0.2 | - Introduction: removed all system names and |
4392 | | | references to internal AT&T components |
4394 | | | - Security: changed ‘event publisher’ to |
4395 | | | ‘event source’ |
4397 | | | - Generic Event Format: updated the JSON schema per |
4400 | | | - eventHeader: clarified the description of id, made |
4401 | | | sourceId a required field, changed the datatype of |
4402 | | | timestamps to timestamp [ ] |
4404 | | | - performanceFields: removed overflowFields |
4406 | | | - tmestamp: added a description of this datatype |
4408 | | | - Exceptions: fixed indentation of sections |
4410 | | | - Approvers: updated the list of approvers and added |
4412 +-----------+---------+-------------------------------------------------------+
4413 | 6/3/2015 | 0.3 | - Updated the security section to use HTTP Basic |
4414 | | | Authentication per AT&T REST standards. Updated the|
4415 | | | input parameters and messaging examples to use the |
4416 | | | new security scheme. |
4417 +-----------+---------+-------------------------------------------------------+
4418 | 6/5/2015 | 0.4 | - Added otherFields sub section to the defined |
4421 | | | - Added locale field to the eventHeader. |
4422 +-----------+---------+-------------------------------------------------------+
4423 | 6/5/2015 | 0.5 | - Updated the embedded event format json schema to |
4424 | | | match the changes made in v0.4 |
4425 +-----------+---------+-------------------------------------------------------+
4426 | 6/10/2015 | 0.6 | - Updated the {ServerRoot} format to contain an |
4427 | | | optional routing path (for D2 service modules). |
4428 +-----------+---------+-------------------------------------------------------+
4429 | 7/7/2015 | 0.7 | Common Event Format updates: |
4431 | | | - EventHeader: added ‘measurement’ to the ‘domain’ |
4432 | | | enumeration; changed ‘locale’ to ‘location’ and |
4433 | | | clarified in the description that this should be a |
4436 | | | - Added a MeasurementFields datatype, which required |
4437 | | | the addition of the following datatypes: |
4438 | | | codecsInUse, cpuUsage, diskUsage, featuresInUse, |
4440 +-----------+---------+-------------------------------------------------------+
4441 | 7/15/2015 | 1.0 | - Changed sourceInstance in the eventHeader to be an |
4442 | | | array of name value pairs |
4444 | | | - Changed the performanceFields block to |
4445 | | | thresholdCrossingAlertFields. Updated the domain |
4446 | | | field of the eventHeader to match. |
4447 +-----------+---------+-------------------------------------------------------+
4448 | 7/23/2015 | v1.1 | Changes to eventHeader data format: |
4450 | | | - moved sourceInstance to internalHeaderFields |
4452 | | | - moved serviceInstanceId to internalHeaderFields |
4454 | | | - moved productId to internalHeaderFields |
4456 | | | - moved subscriberId to internalHeaderFields |
4458 | | | - moved location to internalHeaderFields |
4460 | | | - added the following new fields in |
4461 | | | internalHeaderFields: policyType, policyName, |
4462 | | | correlationEventType, correlationType, |
4463 | | | correlationName, correlationRootEventId |
4465 | | | Changes to faultFields data format: |
4467 | | | - moved the eventSourceDeviceDescription to |
4468 | | | internalFaultFields and renamed it |
4469 | | | equipmentVendorModel |
4471 | | | - moved eventSourceHostname to internalFaultFields |
4473 | | | - changed alarmObjectInterface to alarmInterfaceA |
4475 | | | - changed alarmRemoteObject to alarmRemoteObjectZ and|
4476 | | | moved it to internalFaultFields |
4478 | | | - changed alarmRemoteObjectInterface to |
4479 | | | alarmInterfaceZ and moved it to internalFaultFields|
4481 | | | Changes to thresholdCrossingFields data format: |
4483 | | | - changed several references from the old |
4484 | | | ‘performanceFields’ block to the new |
4485 | | | ‘thresholdCrossingFields’ block |
4489 | | | - Fixed several comma and colon syntax errors in the |
4490 | | | JSON schema as detected by a JSON schema syntax |
4492 +-----------+---------+-------------------------------------------------------+
4493 | 8/11/2015 | v1.2 | Timestamp format: |
4495 | | | - Section 4.18: added a note in the datetime field of|
4496 | | | the Timestamp datatype specifying the (GMT) format |
4499 | | | - Updated the JSON schema with the same information |
4501 | | | Event Header Severity Enumeration: |
4503 | | | - Section 4.8: modified the severity enumeration to |
4504 | | | remove the numbers in parentheses that followed the|
4505 | | | names. The names were not changed. |
4507 | | | - Updated the JSON schema with the same information. |
4508 +-----------+---------+-------------------------------------------------------+
4509 | 8/20/2015 | v1.3 | JSON Schema rev’d to v9: |
4511 | | | - Alphabetized all fields in the JSON schema |
4513 | | | - Fixed the way arrays were specified (JSON schema |
4514 | | | syntax issue) |
4516 | | | Sample Responses: |
4518 | | | - 2.1.1.1: alphabetized fields, fixed timestamps |
4519 | | | array depiction, fixed severity enum value to |
4520 | | | conform to latest format |
4522 | | | - 6.2.6.1: alphabetized fields, fixed timestamps |
4523 | | | array depiction, fixed severity enum value to |
4524 | | | conform to latest format |
4526 | | | - 6.3.6.1: alphabetized fields, fixed timestamps |
4527 | | | array depiction, fixed severity enum value to |
4528 | | | conform to latest format |
4530 | | | - 6.4.6.1: alphabetized fields, fixed timestamps |
4531 | | | array depiction, fixed eventList array depection, |
4532 | | | fixed severity enum value to conform to latest |
4534 +-----------+---------+-------------------------------------------------------+
4535 | 9/16/2015 | v1.4 | JSON Schema rev’d to v10: |
4537 | | | - Fixed an error in the way that the top level |
4538 | | | "event" object was specified in the v9 json schema. |
4539 | | | This was discovered when validating examples |
4540 | | | against the schema using this site: |
4541 | | | http://json-schema-validator.herokuapp.com/index.jsp|
4543 | | | - Changed the embedded json file in section 4 |
4545 | | | Sample Responses: |
4547 | | | - Removed an extra comma after the timestamp brace in |
4548 | | | section 6.2.6 and 6.3.6. |
4549 +-----------+---------+-------------------------------------------------------+
4550 | 11/11/2015| v1.5 | Section 4 was the only section changed: JSON Schema |
4551 | | | rev’d to v11 and Datatype tables were updated to match|
4552 | | | . Numerous data structure changes were made based on |
4553 | | | VNF vendor proof of concept feedback. Modified sample |
4554 | | | requests and responses to match. |
4555 +-----------+---------+-------------------------------------------------------+
4556 | 11/12/2015| v1.6 | - The internalFaultFields were merged into the |
4557 | | | internalHeaderFields; then the internalFaultFields |
4558 | | | datatype was deleted. |
4560 | | | - Updated the JSON schema to v12. |
4562 | | | - Also corrected some background color issues in the |
4563 | | | sample requests and responses. |
4564 +-----------+---------+-------------------------------------------------------+
4565 | 1/18/2016 | v1.7 | - Section 2 changes: updated the sample request to |
4566 | | | conform with the changes below |
4568 | | | - Section 4 datatype changes: |
4570 | | | - Changed 'eventHeader' to 'commonEventHeader' |
4572 | | | - Moved 'eventSeverity' from the 'commonEventHeader' |
4573 | | | to 'faultFields' |
4575 | | | - Added 'priority' to 'commonEventHeader' |
4577 | | | - moved 'vFstatus' to 'faultFields' |
4579 | | | - removed 'firstDateTime' and 'lastDateTime' and |
4580 | | | changed 'firstEpoch' to 'startEpochMicrosec' and |
4581 | | | changed 'lastEpoch' to 'lastEpochMicrosec'. |
4583 | | | - Added 'functionalRole' to the commonEventHeader |
4585 | | | - In the commonEventHeader, changed the 'eventDomain'|
4586 | | | enumeration to remove 'measurements' and add |
4587 | | | 'measurementsForVfScaling'. |
4589 | | | - Changed the 'measurementFields' to |
4590 | | | 'measurementsForVfScalingFields' |
4592 | | | - In the commonEventHeader, changed the following |
4595 | | | - 'eventDomain' to 'domain' |
4597 | | | - 'eventSequence' to 'sequence' |
4599 | | | - 'eventSourceId' to 'sourceId' |
4601 | | | - 'eventSounceName' to 'sourceName' |
4603 | | | - Updated the JSON schema to v13 |
4605 | | | - Section 6 changes: updated the input parameters and|
4606 | | | sample requests to conform to the changes above. |
4608 | | | - Section 7: changed the section from Approvers to |
4609 | | | Contributors. |
4610 +-----------+---------+-------------------------------------------------------+
4611 | 1/22/2016 | v1.8 | - Section 4: Added support for ‘mobileFlow’ in the |
4612 | | | commonEventHeader ‘domain’ enumeration. Added the |
4613 | | | mobileFlowFields datatype and the gtpPerFlowMetrics|
4614 | | | datatype referenced by that datatype. |
4616 | | | - Section 7: alphabetized the contributors |
4617 +-----------+---------+-------------------------------------------------------+
4618 | 2/11/2016 | v1.9 | - Added section 1.3: Naming Standard for Event Types |
4619 +-----------+---------+-------------------------------------------------------+
4620 | 2/12/2016 | v2.0 | - Updated request – response examples to reflect the |
4621 | | | naming standards for event types introduced in v1.9|
4623 | | | - Added a paragraph on use of Avro as a transport in |
4625 +-----------+---------+-------------------------------------------------------+
4626 | 3/11/2016 | v2.1 | - Updated the embedded JSON schema to v15 to fix a |
4627 | | | typo in the required fields for the |
4628 | | | measurementsForVfScalingFields, namely, changed |
4629 | | | ‘configuredEntites’ to ‘configuredEntities’. |
4630 | | | Additionally, added an ‘Event Listener’ title block|
4631 | | | at the bottom of the file with a single required |
4632 | | | event object. |
4633 +-----------+---------+-------------------------------------------------------+
4634 | 3/15/2016 | v2.2 | - Added mobileFlowFields to the event datatype |
4635 | | | definition in section 4.7 and updated the embedded |
4636 | | | json schema at the top of section 4 to v16. |
4637 +-----------+---------+-------------------------------------------------------+
4638 | 4/26/2016 | v2.3 | - Generic Event Format updates: 1) made ‘priority’ |
4639 | | | lowercase in the Word doc table for |
4640 | | | commonEventHeader; 2) added ‘requestError’ data |
4641 | | | structure to the Word doc and JSON schema (which is|
4643 +-----------+---------+-------------------------------------------------------+
4644 | 4/27/2016 | v2.4 | - JSON Schema: In the 'event' data structure, changed|
4645 | | | 'thresholdCrossingFields' to |
4646 | | | 'thresholdCrossingAlertFields' to product v18 of |
4649 | | | - 'codecsInUse' data structure: changed 'numberInUse'|
4650 | | | to 'codecUtilization’ |
4651 +-----------+---------+-------------------------------------------------------+
4652 | 5/26/2016 | v2.5 | - Changed responses from ‘204 No Content’ to ‘202 |
4653 | | | Accepted’ and added a body to the response that |
4654 | | | enable AT&T to throttle the events being sent |
4655 | | | and/or to request the current state of throttling |
4656 | | | at the event source. |
4658 | | | - Added new datatypes to support the above: |
4659 | | | eventDomainThrottleSpecification, |
4660 | | | eventDomainThrottleSpecificationList, |
4661 | | | eventThrottlingState, suppressedNvPairs |
4663 | | | - Modifed the commonEventFormat json schema to v19 |
4665 | | | - Note: for the VendorEventListener: added new |
4666 | | | licensing language on the back of the title page; |
4667 | | | added an "attCopyrightNotice" definition at the top|
4668 | | | of the commonEventFormat\_Vendors.json file; also |
4669 | | | removed all references to internalHeaderFields from|
4670 | | | this file and from the VendorEventListener spec. |
4671 +-----------+---------+-------------------------------------------------------+
4672 | 8/9/2016 | v2.6 | - commonHeader: added a note on the description of |
4673 | | | sourceId and sourceName in the commonHeader: "use |
4674 | | | reportingEntity for domains that provide more |
4675 | | | detailed source info" |
4677 | | | - commonHeader: deleted the capacity, |
4678 | | | measurementsForVfScaling and usage domains in the |
4679 | | | domain enumeration |
4681 | | | - commonHeader: added the following domains to the |
4682 | | | domain enumeration: licensingKci, scalingKpi, |
4685 | | | - event: removed references to capacityFields, |
4686 | | | measurementsForVfScalingFields and usageFields and |
4687 | | | added references to licensingKciFields, |
4688 | | | scalingKpiFields, stateChangeFields |
4690 | | | - licensingKciFields: added this section along with |
4691 | | | 'additionalMeasurements', which is an optional list|
4692 | | | of measurementGroup structures. Changed the name of|
4693 | | | kciFieldsVersion to licensingKciFieldsVersion. |
4695 | | | - scalingKpiFields: added this section but changed |
4696 | | | measurementFieldsVersion to scalingKpiFieldsVersion|
4698 | | | - stateChangeFields: added this section along with |
4699 | | | 'additionalFields', which is an optional list of |
4700 | | | name-value pairs. Other fields included newState |
4701 | | | and oldState which were enumerations of the |
4702 | | | following possible states: 'inService', |
4703 | | | 'maintenance', 'outOfService' |
4705 | | | - sysLogFields: added 'additionalFields', which is an|
4706 | | | optional list of name-value pairs |
4708 | | | - vNicUsage: added two required fields to the |
4709 | | | vNicUsage data structure: packetsIn and packetsOut |
4710 +-----------+---------+-------------------------------------------------------+
4711 | 8/10/2016 | v2.7 | - commonHeader: removed the note on the description |
4712 | | | of sourceId and sourceName in the commonHeader: |
4713 | | | "use reportingEntity for domains that provide more |
4714 | | | detailed source info" |
4716 | | | - commonHeader: added measurementsForVfScaling domain|
4717 | | | back and removed the licensingKci and scalingKpi |
4720 | | | - event: removed references to licensingKciFields and|
4721 | | | scalingKpiFields; added references to |
4722 | | | measurementsForVfScalingFields |
4724 | | | - measurementsForVfScalingFields: combined the |
4725 | | | kciDetail and kpiDetail structures into the |
4726 | | | measurementsForVfScalingFields structure; |
4727 | | | referenced the errors structure |
4729 | | | - errors: added a new structure to capture the |
4730 | | | receive and transmit errors for the measurements |
4733 | | | - removed the following structures: kci, kpi, |
4734 | | | scalingKpiFields and licensingKciFields |
4736 | | | - eventDomainThrottleSpecification: updated the |
4737 | | | reference to commonEventHeader domain field |
4739 | | | - faultFields: removed the numbers from the |
4740 | | | enumerated strings for eventSourceType |
4742 | | | - vNicUsage: made the broadcast, multicast and |
4743 | | | unicast fields optional |
4745 | | | - contributors: updated Alok’s organizational area |
4746 +-----------+---------+-------------------------------------------------------+
4747 | 8/12/2016 | v2.8 | - commonHeader: copied the descriptions of sourceId |
4748 | | | and sourceName from the JSON schema into the word |
4749 | | | document tables. |
4751 | | | - sample request examples: moved the |
4752 | | | reportingEntityId and reportingEntityNames to the |
4753 | | | same relative place in all sample requests in the |
4756 | | | - Fixed the sample request shown for |
4757 | | | publishEventBatch to take an eventList as input. |
4759 | | | - Fixed the sample request shown for |
4760 | | | publishSpecificTopic to put the topic in the URL |
4762 | | | - errors: changed the receiveErrors and |
4763 | | | transmitErrors fields to be datatype number |
4765 | | | - codesInUse: changed 'codecUtilization' to |
4766 | | | 'numberinUse' |
4768 | | | - vNicUsage: updated the description of the fields |
4769 +-----------+---------+-------------------------------------------------------+
4770 | 8/27/2016 | v2.9 | - Added a note "(currently: 1.1)" in the descriptions|
4771 | | | of the following fields: commonEventHeader:version,|
4772 | | | faultFields:faultFieldsVersion, |
4773 | | | measurementsForVfScalingFields:measurementsForVf\ |
4774 | | | ScalingFieldsVersion, stateChangeFields:state\ |
4775 | | | ChangeFieldsVersion, sysLogFields:syslogFields\ |
4776 | | | Version, thresholdCrossingAlertFields:threshold\ |
4777 | | | CrossingFieldsVersion |
4779 | | | - stateChangeFields: made stateInterface mandatory |
4781 | | | - changed 'enum' to 'enumeration' throughout section |
4782 | | | 4 of the document (note: this can't be done in the |
4783 | | | JSON schema). |
4785 | | | - measurementsForVfScalingFields: made the following |
4786 | | | fields optional: conurrentSessions, configured\ |
4787 | | | Entitites, cpuUsageArray, fileSystemUsageArray, |
4788 | | | memoryConfigured, memoryUsed, requestRate, |
4789 | | | vNicUsageArray |
4791 | | | - measurementsForVfScalingFields: concurrentSessions |
4792 | | | and configuredEntities: changed the description to |
4793 | | | support both VMs and VNFs |
4795 | | | - measurementsFor VfScalingFields: clarified the |
4796 | | | descriptions of latencyDistribution, measurement\ |
4797 | | | Inverval and requestRate |
4799 | | | - syslogFields: clarified the descriptions of |
4800 | | | syslogSData, syslogTag, syslogVer |
4802 | | | - thresholdCrossingAlertFields: made the following |
4803 | | | fields optional and clarified their descriptions: |
4804 | | | elementType, networkService |
4806 | | | - command and commandList: created a list of command |
4807 | | | structures to enable the event collector to request|
4808 | | | changes of event sources. Commands consist of a |
4809 | | | commandType along with optional fields (whose |
4810 | | | presence is indicated by the commandType). Three |
4811 | | | command types are currently supported: |
4812 | | | 'measurementIntevalChange', |
4813 | | | ‘provideThrottlingState’ and |
4814 | | | 'throttlingSpecification'. |
4816 | | | - eventDomainThrottleSpecificationList: removed this |
4817 | | | and replaced it with commandList. |
4819 | | | - Operations and Sample Requests: modified the |
4820 | | | operations and samples to support the new command |
4821 | | | and commandList structures. |
4822 +-----------+---------+-------------------------------------------------------+
4823 | 9/1/2016 | v2.10 | - measurementsForVfScaling block: made the following |
4824 | | | fields optional: latencyDistribution (which is an |
4825 | | | array of latencyBucketMeasure structures) and |
4826 | | | meanRequestLatency. Updated the JSON schemas (now |
4827 | | | v24) to match. |
4828 +-----------+---------+-------------------------------------------------------+
4829 | 9/16/2016 | v2.11 | - 1 Introduction: updated the introduction to clarify|
4830 | | | the usage of eventTypes and the possibility of |
4831 | | | support for other protocols. |
4833 | | | - 6.1 REST Operation Overview: added two new |
4834 | | | subsections (6.1.2 and 6.1.3) discussing Api |
4835 | | | Version and Commands Toward Event Source Clients. |
4837 | | | - 6.2 publishAnyEvent: fixed the sample to conform to|
4838 | | | the latest changes |
4840 | | | - 6.3 publishSpecificTopic: fixed the sample to |
4841 | | | conform to the latest changes |
4843 | | | - 6.4 publishEventBatch: fixed the sample to conform |
4844 | | | to the latest changes |
4846 | | | - 6.5 provideThrottlingState operation: added the |
4847 | | | Input Parameters section heading back and fixed the|
4848 | | | sample request to provide eventThrottlingState |
4849 | | | (instead of eventThrottlingClientState). |
4851 | | | - The remaining bullets describe changes made to |
4852 | | | section 4 datatypes in alphabetical order: |
4854 | | | - command datatype: referenced the new section 6.1.3 |
4855 | | | which provides an explanation of command state |
4856 | | | expectations and requirements for a given |
4857 | | | eventSource: |
4859 | | | - commonEventHeader datatype: |
4861 | | | - made sourceId and reportingEntityId fields |
4862 | | | optional (although the internal Generic Event |
4863 | | | Listener spec indicates, in the field |
4864 | | | descriptions, that the AT&T enrichment process |
4865 | | | shall ensure that these fields are populated) |
4867 | | | - domain enumeration: changed measurementsForVf\ |
4868 | | | ScalingFields to measurementsForVfScaling |
4870 | | | - eventDomainThrottleSpecificationList: added this |
4871 | | | array of eventDomainThrottleSpecification stuctures|
4872 | | | back to the schema because it is used by the |
4873 | | | provideThrottlingState operation. |
4875 | | | - eventList: added eventList back to the vendor |
4876 | | | version of the commonEventFormat. This is used by |
4877 | | | the publishEventBatch operation. |
4879 | | | - faultFields datatype: |
4881 | | | - eventSourceType: made this a string (and |
4882 | | | provided the previous enumerated values as |
4885 | | | - filesystemUsage datatype: |
4887 | | | - changed vmIdentifier to filesystemName |
4889 | | | - gtpPerFlowMetrics datatype: |
4891 | | | - flowActivationTime: changed the format and |
4892 | | | description to be compliant with RFC 2822. |
4894 | | | - flowDeactivationTime: changed the format and |
4895 | | | description to be compliant with RFC 2822. |
4897 | | | - internalHeaderFields datatype: |
4899 | | | - Added the following optional fields: firstDate\ |
4900 | | | Time, lastDateTime compliant with RFC 2822. |
4901 | | | Noted in the description that these fields must |
4902 | | | be supplied for events in the following domains:|
4903 | | | fault, thresholdCrossingAlerts and |
4904 | | | measurementsForVfScaling. |
4906 | | | - ticketingTimestamp: changed the format and |
4907 | | | description to be compliant with RFC 2822. |
4909 | | | - syslogFields datatype: |
4911 | | | - eventSourceType: made this a string (and |
4912 | | | provided the previous enumerated values, without|
4913 | | | the numbers, as examples) |
4915 | | | - thresholdCrossingAlerts dataypte: |
4917 | | | - collectionTimestamp: changed the format and |
4918 | | | description to be compliant with RFC 2822. |
4920 | | | - eventStartTimestamp: changed the format and |
4921 | | | description to be compliant with RFC 2822. |
4923 | | | - added the same eventSeverity field as from the |
4924 | | | faultFields and made it required |
4925 +-----------+---------+-------------------------------------------------------+
4926 | 9/23/2016 | v2.12 | - Section 4 Datatypes: commonEventHeader: made |
4927 | | | reportingEntityName a required field (note: the |
4928 | | | JSON schema already had this field as required) |
4929 +-----------+---------+-------------------------------------------------------+
4930 | 11/29/2016| v3.0 | - Introduction: |
4932 | | | - Introductory paragraph: changed '...Common Event|
4933 | | | Header Block followed by zero or more event |
4934 | | | domain blocks' to '...Common Event Header Block |
4935 | | | accompanied by zero or more event domain blocks'|
4936 | | | since the order of the blocks on the wire is |
4937 | | | not guaranteed. |
4939 | | | - Added Section 1.5 Versioning |
4941 | | | - Section 4: codec processing: |
4943 | | | - CommonEventFormat\_Vendors schema only: |
4944 | | | codesInUse: changed required field from |
4945 | | | "codecUtilization" which was removed previously |
4946 | | | to "numberInUse" which is the new field name. |
4948 | | | - added ‘codecSelected’ datatype |
4950 | | | - added ‘codecSelectedTranscoding’ datatype |
4952 | | | - Section 4 and section 6: command processing: |
4954 | | | - Added commandListEntry which is an object that |
4955 | | | references the command object. |
4957 | | | - commandList: changed commandList to contain an |
4958 | | | array of commandListEntry objects. |
4960 | | | - Updated sample responses in section 6 where |
4961 | | | commands are used |
4963 | | | - Section 4: commonEventHeader: |
4965 | | | - Incremented version to 1.2 |
4967 | | | - added two new values to the ‘domain’ |
4968 | | | enumeration: ‘serviceEvents’ and ‘signaling |
4970 | | | - Section 4: added endOfCallVqmSummaries datatype |
4972 | | | - Section 4: ‘event’: added two fields: |
4973 | | | ‘serviceEventsFields’ and ‘signalingFields’ |
4975 | | | - Section 4: added ‘eventInstanceIdentifier’datatype |
4977 | | | - Section 4: CommonEventListener only: |
4978 | | | internalHeaderFields: |
4980 | | | - added ‘internalHeaderFieldsVersion’(initially |
4983 | | | - added ‘correlationFirstEpoch’ |
4985 | | | - added 'closedLoopControlName' |
4987 | | | - added 'closedLoopFlag' |
4989 | | | - added 'collectorTimeStamp' |
4991 | | | - added 'eventTag' |
4993 | | | - added ‘tenantName’ |
4995 | | | - changed 'operationalStatus' to 'inMaint' |
4997 | | | - added required fields in the schema to match the|
4998 | | | word doc: 'equipmentNameCode', 'equipmentType', |
4999 | | | 'equipmentVendor', 'inMaint', 'provStatus' |
5001 | | | - Section 4: added ‘marker’datatype |
5003 | | | - Section 4: added ‘midCallRtcp’ datatype |
5005 | | | - Section 4: mobileFlowFields: |
5007 | | | - added ‘mobileFlowFieldsVersion’(initially set to|
5010 | | | - Section 4: added ‘serviceEventsFields’datatype |
5012 | | | - Section 4: added ‘signalingFields’ datatype |
5014 | | | - Section 4: syslogFields: |
5016 | | | - Incremented syslogFieldsVersion to 1.2 |
5018 | | | - added 'syslogPri' |
5020 | | | - added 'syslogSev' |
5022 | | | - added ‘syslogSdId’ |
5024 | | | - Section 4: thresholdCrossingAlertFields: |
5026 | | | - Incremented thresholdCrossingFieldsVersion to |
5029 | | | - added 'additionalFields' which is an optional |
5030 | | | list of name value pairs. |
5032 | | | - Section 4: schema v26.0 embedded reflecting the |
5033 | | | above changes. |
5035 | | | - Section 6 and Section 2: changed all sample |
5036 | | | requests to use /v3 in the REST Resource URL. |
5037 +-----------+---------+-------------------------------------------------------+
5038 | 12/1/2016 | v3.1 | - Section 6: Updated the call flow diagrams to show |
5040 +-----------+---------+-------------------------------------------------------+
5041 | 1/5/2017 | v4.0 | - Combined the Generic Event Listener and Vendor |
5042 | | | Event Listener into a single API service |
5043 | | | specification with version 4.0. |
5045 | | | - Changed the title to VES (Virtual Function Event |
5046 | | | Streaming) Listener. |
5048 | | | - Changed references to 'generic event' to 'common |
5049 | | | event' or 'VES event' (depending on the context) |
5050 | | | throughout the document. |
5052 | | | - Used the Legal Disclaimer from the Vendor Event |
5053 | | | Listener on the back of the title page. |
5055 | | | - Section 1: Introduction changes: |
5057 | | | - modified wording to reference 'VES' |
5059 | | | - removed the 'Audience' section, which described |
5060 | | | various AT&T groups the documented was intended |
5063 | | | - tweaked the naming standards for event types to |
5064 | | | clarify the purpose of the naming conventions |
5066 | | | - Section 3: Resource Structure: added a sentence |
5067 | | | describing the FQDN and port used in the resource |
5070 | | | - Section 4: Common Event Format changes: |
5072 | | | - renamed the section to 'Common Event Format' |
5073 | | | from 'Generic Event Format' |
5075 | | | - reorganized the datatypes into separate sections|
5076 | | | ; sections were defined for each of the domains |
5077 | | | as well as for common event, common event header|
5078 | | | and command list processing |
5080 | | | - codecSelected datatype: removed this datatype |
5082 | | | - codecSelectedTranscoding datatype: removed this |
5085 | | | - command datatype: added an enumerated value to |
5086 | | | commandType: 'heartbeatIntervalChange' |
5088 | | | - commonEventHeader: added internalHeaderFields to|
5089 | | | the commonEventHeader, defined as "Fields (not |
5090 | | | supplied by event sources) that the VES Event |
5091 | | | Listener service can use to enrich the event if |
5092 | | | needed for efficient internal processing. This |
5093 | | | is an empty object which is intended to be |
5094 | | | defined separately by each provider implementing|
5095 | | | the VES Event Listener." |
5097 | | | - commonEventHeader: removed two enumerated values|
5098 | | | , 'serviceEvents' and 'signaling' from the |
5099 | | | domain enumeration |
5101 | | | - commonEventHeader version: incremented the |
5102 | | | version to 2.0 |
5104 | | | - endOfCallVqmSummaries datatype: removed this |
5107 | | | - event: changed the description of the event |
5108 | | | datatype to: "fields which constitute the ‘root |
5109 | | | level’ of the common event format" |
5111 | | | - event: removed 'serviceEventFields' and |
5112 | | | 'signalingFields' from the definition |
5114 | | | - event: fixed a misspelling of |
5115 | | | ‘thresholdCrossingAlertFields’, which was only |
5116 | | | present in the Word document |
5118 | | | - eventInstanceIdentifier datatype: removed this |
5121 | | | - internalHeaderFIelds datatype: defined this as |
5122 | | | follows: "The internalHeaderFields datatype is |
5123 | | | an undefined object which can contain |
5124 | | | arbitrarily complex JSON structures. It is |
5125 | | | intended to be defined separately by each |
5126 | | | provider implementing the VES Event Listener. |
5127 | | | The fields in internalHeaderFields are not |
5128 | | | provided by any event source but instead are |
5129 | | | added by the VES Event Listener service itself |
5130 | | | as part of an event enrichment process necessary|
5131 | | | for efficient internal processing of events |
5132 | | | received by the VES Event Listener" |
5134 | | | - marker datatype: removed this datatype |
5136 | | | - measurementsForVfScalingFields datatype: |
5137 | | | clarified that memoryConfigured and memoryUsed |
5138 | | | are measured in MB |
5140 | | | - midCallRtcp datatype: removed this datatype |
5142 | | | - mobileFlowFields datatype: added |
5143 | | | ‘additionalFields’ |
5145 | | | - mobileFlowFields datatype: incremented the |
5146 | | | version number for this field block to 1.2 |
5148 | | | - serviceEventsFields datatype: removed this |
5151 | | | - signalingFields datatype: removed this datatype |
5153 | | | - syslogFields: added three fields to the schema |
5154 | | | that were previously described in the document |
5155 | | | but not incorporated into the schema: syslogPri,|
5156 | | | syslogSev, syslogSdId |
5158 | | | - syslogFields version: incremented the version to|
5161 | | | - Modified the Common Event Format JSON schema to |
5162 | | | v27.0 to incorporate the above changes. Also, added|
5163 | | | the AT&T Copyright Notice from the top of the |
5164 | | | retired CommonEventFormat\_Vendors schema. |
5166 | | | - Section 6 and 2: changed all sample requests to use|
5167 | | | /v4 in the REST Resource URL and call flow diagrams|
5169 | | | - Section 6.1.3: added a row to the table in this |
5170 | | | section describing the ‘heartbeatIntervalChange’ |
5173 | | | - Section 6.1.4: added this new section describing |
5174 | | | expectations for buffering of events should all |
5175 | | | REST resource URL FQDNs be unreachable. |
5177 | | | - Section 6 Sample Requests: modified all sample |
5178 | | | requests showing the return of a commandList toward|
5179 | | | the event source to incorporate a |
5180 | | | heartbeatIntervalChange command; also corrected the|
5181 | | | spelling in the samples for the |
5182 | | | measurementIntervalChange command. |
5184 | | | - Section 7: Contributors: removed this section |
5185 +-----------+---------+-------------------------------------------------------+
5186 | 3/21/2017 | v4.1 | - JSON Schema changes to produce v27.2 (note: an |
5187 | | | earlier draft version of v27.1 had been distributed|
5188 | | | to a few individuals): |
5190 | | | - To support use of the schema with event batches,|
5191 | | | removed the following statement near the end of |
5192 | | | the schema file: |
5194 | | | "required": [ "event" ] |
5196 | | | - Fixed the characters used in some of the quotes |
5198 | | | - Fixed some typos in the descriptions. |
5200 | | | - Removed the booleans, which were non-essential and |
5201 | | | which were causing problems across different |
5202 | | | implementations. |
5204 | | | - Section 4.5.7 measurementsForVfScalingFields: |
5206 | | | - Fixed the spelling of measurementsForVf\ |
5207 | | | ScalingFields in the Word document |
5209 | | | - Section 2 and 6 sample requests and responses: |
5211 | | | - Removed quotes from numbers: sequence, and |
5212 | | | first/lastEpochMicrosec. |
5214 | | | - Fixed all quote characters, some of which were |
5215 | | | using unusual symbols that wouldn’t validate |
5216 | | | with the json-schema Python package. |
5218 | | | - Section 6.2.6.1, 6.3.6.1, 6.4.6.1 sample requests: |
5220 | | | - Added an alarmAdditionalInformation field array |
5221 | | | to the sample requests. |
5223 | | | - Added missing commas. |
5225 | | | - Section 6.5.6.1 provideThrottlingState sample |
5228 | | | - Fixed the eventDomainThrottleSpecificationList |
5229 | | | to pass an array of anonymous eventDomain\ |
5230 | | | ThrottleSpecification objects. |
5232 | | | - Added missing quotes. |
5234 | | | - Fixed the suppressedNvPairsList to pass an array of|
5235 | | | anonymous suppressedNvPairs objects. |
5236 +-----------+---------+-------------------------------------------------------+
5237 | 4/14/2017 | v5.0 | - Section 1 Introduction: |
5239 | | | - Clarified the Introduction (Section 1). |
5241 | | | - Changed Section 1.1 title from ‘Terminology’ to |
5242 | | | 'Event Registration' and referenced the YAML |
5243 | | | event registration format, defined in a separate|
5246 | | | - Clarified naming standards for eventName. |
5248 | | | - Section 3: updated the REST resource structure |
5250 | | | - Section 4.1 command list processing datatypes: |
5252 | | | - Got rid of commandListEntry and returned |
5253 | | | commandList to a simple array of commands. |
5255 | | | - Added heartbeatInterval to the command datatype.|
5257 | | | - Changed the datatype of measurementInterval from|
5258 | | | number to integer. |
5260 | | | - Section 4.2 common event datatypes: |
5262 | | | - event dataType: Added heartbeatFields, |
5263 | | | sipSignalingFields and voiceQualityFields to the|
5264 | | | event datatype as optional field blocks |
5266 | | | - Added jsonObject which provides a json object |
5267 | | | schema, name and other meta-information along |
5268 | | | with one or more object instances. |
5270 | | | - Added jsonObjectInstance which provides |
5271 | | | meta-information about an instance of a |
5272 | | | jsonObject along with the actual object instance|
5274 | | | - Added the ‘key’ datatype |
5276 | | | - Added the namedArrayOfFields datatype |
5278 | | | - Added vendorVnfNameFields |
5280 | | | - Section 4.3 common event header fields: |
5282 | | | - Add two new enumerations to domain: |
5283 | | | ‘sipSignaling’ and ‘voiceQuality’ |
5285 | | | - Renamed eventType to eventName. Note that the |
5286 | | | original usage of eventType was formally |
5287 | | | described in the Introduction back on 2/11/2016 |
5290 | | | - Made eventName a required field |
5292 | | | - Created a new field called eventType with a |
5293 | | | meaning that is different than the old eventType|
5295 | | | - Removed functionalRole, which was replaced by |
5296 | | | the following two fields. |
5298 | | | - Added nfNamingCode |
5300 | | | - Added nfcNamingCode |
5302 | | | - Changed version to 3.0 (major version change) |
5303 | | | and made it a required field |
5305 | | | - Section 4.4: faultFields: |
5307 | | | - added one optional field: eventCategory |
5309 | | | - made faultFieldsVersion a required field |
5311 | | | - changed faultFieldsVersion to 2.0 (major version|
5314 | | | - fixed a typo on the spelling of alarmInterfaceA |
5316 | | | - clarified field descriptions |
5318 | | | - Section 4.5: added heartbeatFields datatype which |
5319 | | | can be used to communicate heartbeatInterval. Note:|
5320 | | | this change was previously made in v4.2 |
5322 | | | - Section 4.6 measurements for vf scaling datatypes: |
5323 | | | changed the following datatypes from number to |
5326 | | | - In measurementsForVfScalingFields: |
5327 | | | concurrentSessions, configuredEntities, |
5328 | | | numberOfMediaPortsInUse, vnfcScalingMetric |
5330 | | | - In codecsInUse: numberInUse |
5332 | | | - In featuresInUse: featureUtilization |
5334 | | | - Section 4.6.2 modified cpuUsage |
5336 | | | - Section 4.6.3 added diskUsage |
5338 | | | - Section 4.6.7 measurementsForVfScalingFields: |
5340 | | | - fixed the spelling of the measurementsForVf\ |
5341 | | | ScalingFields in the Word document |
5343 | | | - added additionalFields, which is an array of |
5344 | | | fields (i.e., name-value pairs) |
5346 | | | - changed additionalMeasurements to reference the |
5347 | | | common datatype namedArrayOfFields (instead of |
5348 | | | referencing measurementGroup) |
5350 | | | - added additionalObjects which is an array of |
5351 | | | jsonObjects described by name, keys and schema |
5353 | | | - deleted aggregateCpuUsage |
5355 | | | - added diskUsageArray |
5357 | | | - deleted measurementGroup (which was replaced by |
5358 | | | the common datatype: namedArrayOfFields |
5360 | | | - added memoryUsageArray |
5362 | | | - deleted memoryConfigured and memoryUsed |
5364 | | | - deleted errors and vNicUsageArray |
5366 | | | - added vNicPerformanceArray |
5368 | | | - changed the measurementsForVfScalingVersion to |
5369 | | | 2.0 (major version change) and made it a |
5370 | | | required field. Also changed the name of this |
5371 | | | version field in the Word document to match that|
5372 | | | in the JSON schema. |
5374 | | | - Section 4.6.8 added memoryUsage |
5376 | | | - Section 4.6.9 vNicPerformance: replaced vNicUsage |
5377 | | | and errors with vNicPerformance |
5379 | | | - Section 4.7 mobile flow fields changes: |
5381 | | | - Made mobileFlowFieldsVersion a required field |
5382 | | | and changed the mobileFlowFieldsVersion to 2.0 |
5383 | | | (major version change). |
5385 | | | - Changed the datatype of flowActivationTime and |
5386 | | | flowDeactivationTime in the Word doc to string. |
5388 | | | - changed the following datatypes from number to |
5389 | | | integer: otherEndpointPort, |
5390 | | | reportingEndpointPort, samplingAlgorithm |
5392 | | | - Section 4.8: otherFields: |
5394 | | | - Added otherFieldsVersion (set at 1.1) |
5396 | | | - Added hashOfNameValuePairArrays |
5398 | | | - Added jsonObjects |
5400 | | | - Added nameValuePairs |
5402 | | | - Section 4.9: added sipSignaling domain datatypes |
5403 | | | with 4.8.1 sipSignalingFields. sipSignalingFields\ |
5404 | | | Version is set at 1.0 |
5406 | | | - Section 4.10 stateChangeFields: made stateChange\ |
5407 | | | FieldsVersion a required field and set it to 2.0 |
5408 | | | (major version change). |
5410 | | | - Section 4.11 syslogFields: |
5412 | | | - Changed the following datatypes from number to |
5413 | | | integer: syslogFacility, syslogPri |
5415 | | | - Changed additionalFields from a field [ ] to a |
5416 | | | string which takes name=value pairs delimited by|
5417 | | | a pipe symbol. |
5419 | | | - Changed syslogFieldsVersion to 3.0 (major |
5420 | | | version change) and made it a required field |
5422 | | | - Made syslogSev an enumerated string (previously |
5423 | | | just a string) |
5425 | | | - Section 4.12 thresholdCrossingAlertFields: made |
5426 | | | thresholdCrossingFieldsVersion a required field and|
5427 | | | set it to 2.0 (major version change). |
5429 | | | - Section 4.132: added voice quality domain datatypes|
5430 | | | with 4.13.1 endOfCallVqmSummaries and 4.13.2 |
5431 | | | voiceQualityFields. voiceQualityFieldsVersion is |
5434 | | | - JSON Schema: changed the schema to v28.0 and |
5435 | | | incorporated all of the changes above. |
5437 | | | - Additional JSON Schema changes that are part of |
5438 | | | v28: Note: The following changes are provided |
5439 | | | relative to API Spec v4.0 (which embedded JSON |
5440 | | | schema v27.0), but they were also made in an |
5441 | | | interim release v4.1 (which embedded JSON schema |
5444 | | | - To support use of the schema with event batches,|
5445 | | | removed the following statement near the end of |
5446 | | | the schema file: |
5448 | | | "required": [ "event" ] |
5450 | | | - Fixed the characters used in some of the quotes |
5452 | | | - Fixed some typos in the descriptions. |
5454 | | | - Removed the booleans, which were non-essential and |
5455 | | | which were causing problems across different |
5456 | | | implementations. |
5458 | | | - Section 2 and 6 sample requests and responses (also|
5459 | | | incorporated in interim release 4.1): |
5461 | | | - Removed quotes from numbers: sequence, and |
5462 | | | first/lastEpochMicrosec. |
5464 | | | - Fixed all quote characters, some of which were |
5465 | | | using unusual symbols that wouldn’t validate |
5466 | | | with the json-schema Python package. |
5468 | | | - Section 2 and 6 sample requests and responses (only|
5471 | | | - Changed the version numbers in the URL string. |
5473 | | | - Added nfNamingCode and nfcNamingCode and removed|
5474 | | | functionalRole |
5476 | | | - Section 6 call flows: updated the version number |
5477 | | | (only in v5.0). |
5479 | | | - Section 6: removed the publishSpecificTopic |
5482 | | | - Section 6.1.4: Buffering: clarified event source |
5483 | | | expectations for buffering (only in v5.0). |
5485 | | | - Section 6.2.6.1, 6.3.6.1 sample requests (also |
5486 | | | incorporated in interim release 4.1): |
5488 | | | - Added an alarmAdditionalInformation field array |
5489 | | | to the sample requests. |
5491 | | | - Added missing commas. |
5493 | | | - Section 6.2.6.3, 6.3.6.3 commandList sample |
5494 | | | responses (only in v5.0): |
5496 | | | - Fixed the commandList sample responses to pass |
5497 | | | an array of anonymous command objects (rather |
5498 | | | than an array of commandListEntry objects). |
5500 | | | - Fixed the heartbeatIntervalChange commandType to|
5501 | | | pass a heartbeatInterval value instead of a |
5502 | | | measurementInterval value. |
5504 | | | - Removed quotes from the measurementInterval and |
5505 | | | heartbeatInterval values since they are numbers.|
5507 | | | - Section 6.4.6.1 provideThrottlingState sample |
5508 | | | requests(also incorporated in interim release 4.1):|
5510 | | | - Fixed the eventDomainThrottleSpecificationList |
5511 | | | to pass an array of anonymous |
5512 | | | eventDomainThrottleSpecification objects. |
5514 | | | - Added missing quotes. |
5516 | | | - Fixed the suppressedNvPairsList to pass an array|
5517 | | | of anonymous suppressedNvPairs objects (also |
5518 | | | incorporated in interim release 4.1). |
5519 +-----------+---------+-------------------------------------------------------+
5520 | 5/22/2017 | v5.1 | - Footers: removed proprietary markings and updated |
5521 | | | copyrights to 2017 |
5523 | | | - Section 4.2.3: field: |
5525 | | | - Changed the API spec to make ‘name’ and ‘value’ |
5526 | | | start with lowercase letters. Note: this did not|
5527 | | | affect the schema, which already had them as |
5530 | | | - JSON Schema: |
5532 | | | - measurementGroup: deleted this object since it |
5533 | | | was replaced with ‘namedArrayOfFields’ in v28.0 |
5534 | | | and was no longer being used. |
5536 | | | - namedArrayOfFields: Fixed an error in the |
5537 | | | specification of required fields: from |
5538 | | | ‘measurements’ to ‘arrayOfFields’. |
5540 | | | - Changed the version of the JSON schema to 28.1 |
5541 +-----------+---------+-------------------------------------------------------+
5542 | 6/14/2017 | v5.2 | - JSON Schema: created v28.2 by changing the field |
5543 | | | descriptions in the memoryUsage object to refer to |
5544 | | | ‘kibibytes’ instead of ‘kilobytes’. There were no |
5545 | | | changes to the 28.1 structure. |
5547 | | | - Word Document: measurementsForVfScaling Domain: |
5548 | | | memoryUsage object: changed the field descriptions |
5549 | | | in this object to refer to ‘kibibytes’ instead of |
5550 | | | ‘kilobytes’. There were no changes to the |
5551 | | | memoryUsage structure. |
5553 | | | - Reorganized the Word document to group the data |
5554 | | | structures in Section 4 into three broad categories|
5555 | | | to better align with the VNF Guidelines |
5556 | | | documentation that has been prepared for vendors: |
5558 | | | - Common Event Datatypes: |
5560 | | | - Command List Processing Datatypes |
5562 | | | - Common Event Datatypes |
5564 | | | - Common Event Header Datatypes |
5566 | | | - Technology Independent Datatypes: |
5568 | | | - ‘Fault Domain Datatypes |
5570 | | | - ‘Heartbeat’ Domain Datatypes |
5572 | | | - ‘Measurements For Vf Scaling’ Domain Datatypes|
5574 | | | - ‘Other’ Domain Datatypes |
5576 | | | - ‘State Change’ Domain Datatypes |
5578 | | | - ‘Syslog’ Domain Datatypes |
5580 | | | - ‘Threshold Crossing Alert’ Domain Datatypes |
5582 | | | - Technology Specify Datatypes: |
5584 | | | - ‘Mobile Flow’ Domain Datatypes |
5586 | | | - ‘Sip Signaling’ Domain Datatypes |
5588 | | | - ‘Voice Quality’ Domain Datatypes |
5590 | | | - Section 6.1.3: Commands Toward Event Source |
5591 | | | Clients: Added a statement: "Note: Vendors are not |
5592 | | | currently required to implement support for command|
5593 | | | processing; in addition, command processing may be |
5594 | | | supported by an App-C interface in future." |
5595 +-----------+---------+-------------------------------------------------------+
5596 | 6/22/2017 | v5.3 | - JSON Schema: created v28.3 by correcting an error |
5597 | | | in the sipSignalingFields: changed |
5598 | | | vnfVendorNameFields to vendorVnfNameFields. |
5599 | | | Embedded the new schema at the top of section 4. |
5600 +-----------+---------+-------------------------------------------------------+
5601 | 9/12/2017 | v5.4 | - Note: There no changes to any data structures or |
5602 | | | operations in this version. |
5604 | | | - JSON Schema: created v28.4 embedded at the top of |
5607 | | | - Added a reference to eventList in the properties|
5608 | | | defined under the schema title. This enables the|
5609 | | | schema to correctly validate event batches in |
5610 | | | addition to just events. |
5612 | | | - Moved the schema title to the top of the schema |
5613 | | | and changed the text from "Event Listener" to |
5614 | | | "VES Event Listener" |
5616 | | | - Added a schema header block under the title to |
5617 | | | clearly communicate the schema version, |
5618 | | | associated API and last-modified information |
5620 | | | - Changed the date in the copyright notice to 2017 |
5621 +-----------+---------+-------------------------------------------------------+
5622 | 9/19/2017 | v5.4.1 | - Note: There no changes to any data structures or |
5623 | | | operations in this version. |
5625 | | | - Back of Cover Page: updated the license and |
5626 | | | copyright notice to comply with ONAP guidelines |
5628 | | | - JSON Schema: updated the JSON schema to v28.4.1: |
5629 | | | updated the copyright notice and license to comply |
5630 | | | with ONAP guidelines |
5631 +-----------+---------+-------------------------------------------------------+
5632 | 6/28/2018 | v6.0 | - Added contributors to the title page. |
5634 | | | - Updated references to ‘vnf’ ‘vnfc’ to either ‘nf’ |
5635 | | | and ‘nfc’ or ‘xNf’ and ‘xNfc’ to generalize support|
5636 | | | across both vnfs and pnfs. |
5638 | | | - Section 1: |
5640 | | | - clarified the meaning of the VES acronym |
5642 | | | - changed references from ASDC to SDC and from MSO|
5645 | | | - clarified the requirements for eventNames. |
5647 | | | - Added a section of EventId use case examples |
5649 | | | - Added a new section on measurement expansion |
5652 | | | - Added a new section of syslogs |
5654 | | | - clarified the versioning section and referenced |
5655 | | | the new API Versioning section in section 6. |
5657 | | | - Added a list of all the latest field block |
5658 | | | version numbers in this version of the API spec.|
5660 | | | - Section 2: updated the sample to show use of new |
5661 | | | HTTP versioning headers. Added a note indicating |
5662 | | | that support for mutual SSL would be provided in |
5665 | | | - Section 3: updated the resource structure remove |
5666 | | | the clientThrottlingState resource. |
5668 | | | - Section 4: hashMaps. Changed all name-value pair |
5669 | | | structures to hashMaps causing the following data |
5670 | | | model and JSON schema (to v29.0) changes: |
5672 | | | - 4.1.1: Common Event Datatypes: |
5674 | | | - removed "field" and added "hashMap" |
5676 | | | - removed "namedArrayOfFields" and added |
5677 | | | "namedHashMap" |
5679 | | | - added arrayOfNamedHashMap |
5681 | | | - added arrayOfJsonObject |
5683 | | | - 4.2.1: Fault Domain Datatypes: |
5685 | | | - changed the faultFields version to 3.0 (major|
5688 | | | - changed faultFields.alarmAdditional\ |
5689 | | | Information to reference a hashMap |
5691 | | | - 4.2.2: Heartbeat Domain Datatypes: |
5693 | | | - changed the heartbeatFieldsVersion to 2.0 |
5694 | | | (major change) |
5696 | | | - changed heartbeatFields.additionalFields to |
5697 | | | reference a hashMap |
5699 | | | - 4.2.3: Measurement Domain Datatypes: |
5701 | | | - changed the measurementFieldsVersion to 3.0 |
5702 | | | (major change) |
5704 | | | - changed measurementFields.additionalFields to|
5705 | | | reference a hashMap |
5707 | | | - changed measurement.additionalMesurements to |
5708 | | | reference a namedHashMap [ ] |
5710 | | | - modified measurementFields.featureUsageArray |
5711 | | | to reference a hashmap and removed |
5712 | | | ‘featuresInUse’ |
5714 | | | - added the following datatypes which are now |
5715 | | | referenced as items in arrays within |
5716 | | | measurementFields: hugePages, load, |
5717 | | | machineCheckException, processStats |
5719 | | | - 4.2.5: Other Domain Datatypes: |
5721 | | | - Change the otherFieldsVersion to 2.0 (major |
5724 | | | - changed otherFields.nameValuePairs to |
5725 | | | reference a hashMap and renamed it hashMap |
5727 | | | - changed otherFields.hashOfNameValuePair\ |
5728 | | | Arrrays to reference a namedHashMap and |
5729 | | | renamed it arrayOfNamedHashMap |
5731 | | | - 4.2.7: State Change Domain Datatypes: |
5733 | | | - changed the stateChangeFiledsVersion to 3.0 |
5734 | | | (major change) |
5736 | | | - changed stateChangeFields.additionalFields to|
5737 | | | reference a hashMap |
5739 | | | - 4.2.9: Threshold Crossing Alert Domain |
5742 | | | - changed the thresholdCrossingAlertFields\ |
5743 | | | Version to 3.0 (major change) |
5745 | | | - changed thresholdCrossingAlert\ |
5746 | | | Fields.additionalFields to reference a |
5749 | | | - counter: removed name and value elements and |
5750 | | | replaced with a hashMap |
5752 | | | - 4.3.1: Mobile Flow Domain Datatypes: |
5754 | | | - changed the mobileFlowFieldsVersion to 3.0 |
5755 | | | (major change) |
5757 | | | - changed mobileFlowFields.additionalFields to |
5758 | | | reference a hashMap |
5760 | | | - gtpPerFlowMetrics: modified ipTosCountList to|
5761 | | | reference hashmap |
5763 | | | - gtpPerFlowMetrics: modified mobileQciCos\ |
5764 | | | CountList to reference hashmap |
5766 | | | - gtpPerFlowMetrics: modified tcpFlagCountList |
5767 | | | to reference hashmap |
5769 | | | - 4.3.2: Sip Signaling Domain Datatypes: |
5771 | | | - changed the sigSignalingFieldsVersion to 2.0 |
5772 | | | (major change) |
5774 | | | - changed sipSignalingFields.additional\ |
5775 | | | Information to reference a hashMap |
5777 | | | - 4.3.3: Voice Quality Domain Datatypes: |
5779 | | | - change the voiceQualityFieldsVersion to 2.0 |
5780 | | | (major change) |
5782 | | | - changed voiceQualityFields.additional\ |
5783 | | | Information to reference a hashMap |
5785 | | | - Section 4: added notes at the top of section 4 |
5786 | | | clarifying expectations and requirements for |
5787 | | | optional fields, extensible fields and keys sent |
5788 | | | through extensible fields. |
5790 | | | - Common Event Data Types: Section 4.1.1.9 Changed |
5791 | | | vendorVnfNameFields to vendorNfNameFields; updated |
5792 | | | Section 4.3.2 SipSignaling and 4.3.3 Voice Quality |
5793 | | | to refer to the renamed object |
5795 | | | - Common Event Header Section 4.1.2: |
5797 | | | - clarified the descriptions of eventId, |
5798 | | | reportingEntityName, sourceName and |
5799 | | | startEpochMicroseconds. |
5801 | | | - Added ‘notification’ and ‘pngRegistration’ to |
5802 | | | the domain enumeration. |
5804 | | | - added a new timeZoneOffsest field |
5806 | | | - Fault Domain Section 4.2.1: clarified the |
5807 | | | definitions of alarmCondition, eventSeverity and |
5808 | | | specificProblem |
5810 | | | - Measurements Domain Section 4.2.3: changed the name|
5811 | | | of this domain from ‘measurementsForVfScaling’ to |
5812 | | | ‘measurement’ |
5814 | | | - measurementsForVfScaling measurement |
5816 | | | - measurementsForVfScalingFields measurementFields|
5818 | | | - measurementsForVfScalingVersion |
5819 | | | measurementFieldsVersion |
5821 | | | - the ‘mfvs’ abbreviation measurement |
5823 | | | - Measurements Domain Section 4.2.3 cpuUsage: added |
5824 | | | seven optional fields to this structure: |
5825 | | | cpuCapacityContention, cpuDemandAvg, cpuDemandMhz, |
5826 | | | cpuDemandPct, cpuLatencyAverage, cpuOverheadAvg, |
5827 | | | cpuSwapWaitTime |
5829 | | | - Measurements Domain Section 4.2.3 diskUsage: added |
5830 | | | ten optional fields to this structure: |
5831 | | | diskBusResets, diskCommandsAborted, diskCommandsAvg|
5832 | | | , diskFlushRequests, diskFlushTime, |
5833 | | | diskReadCommandsAvg, diskTime, diskTotalRead\ |
5834 | | | LatencyAvg, diskTotalWriteLatencyAvg, diskWrite\ |
5837 | | | - Measurements Domain Section 4.2.3: added a new |
5838 | | | ‘ipmi’ datatype along with following ‘supporting’ |
5839 | | | datatypes: ipmiBaseboardTemperature, ipmiBaseboard\|
5840 | | | VoltageRegulator, ipmiBattery, ipmiFan, ipmiGlobal\|
5841 | | | AggregateTemperatureMargin, ipmiHsbp, ipmiNic, |
5842 | | | ipmiPowerSupply, ipmiProcessor, processorDimm\ |
5843 | | | AggregateThermalMargin |
5845 | | | - Measurements Domain Section 4.2.3: added a new |
5846 | | | ‘load’ datatype |
5848 | | | - Measurements Domain Section 4.2.3 memoryUsage: |
5849 | | | added eight optional fields to this structure: |
5850 | | | memoryDemand, memoryLatencyAvg, memorySharedAvg, |
5851 | | | memorySwapInAvg, memorySwapInRateAvg, memorySwap\ |
5852 | | | OutAvg, memorySwapOutRateAvg, memorySwapUsedAvg |
5854 | | | - Measurements Domain Section 4.2.3: modified |
5855 | | | measurementFields to include the following new |
5856 | | | fields: hugePagesArray, ipmi, loadArray, memory\ |
5857 | | | Errors, processStatusArray, rdtArray |
5859 | | | - Measurements Domain Section 4.2.3 renamed vNic\ |
5860 | | | Performance to nicPerformance and changed vNic\ |
5861 | | | Identifer to nicIdentifier |
5863 | | | - Notification Domain Section 4.2.4: added |
5864 | | | notificationFields to support a new notification |
5867 | | | - pnfRegistration Domain Section 4.2.7: added |
5868 | | | pnfRegistrationFields to support a new registration|
5871 | | | - sysLog Domain Section 4.2.8: added two new fields: |
5872 | | | syslogMsgHost and syslogTs. Clarified field |
5873 | | | descriptions. Clarified syslogSData example. |
5875 | | | - endOfCallVqmSummaries Section 4.3.3.1: |
5877 | | | - converted endpointJitter into two fields: |
5878 | | | endpointAverageJitter and endpointMaxJitter |
5880 | | | - converted localJitter into two fields: |
5881 | | | localAverageJitter and localMaxJitter |
5883 | | | - added two fields: localAverageJitterBufferDelay |
5884 | | | and localMaxJitterBufferDelay |
5886 | | | - added endpointRtpOctetsLost and |
5887 | | | endpointRtpPacketsLost |
5889 | | | - added localRtpOctetsLost and localRtpPacketsLost|
5891 | | | - converted packetsLost into oneWayDelay |
5893 | | | - API Versioning: |
5895 | | | - Section 1.4: clarified the versioning section |
5896 | | | and linked it to the following new section 6.1.2|
5898 | | | - Section 6.1.2: Added requirements for HTTP |
5899 | | | headers communicating minor, patch and latest |
5900 | | | version information. |
5902 | | | - Section 2 and 6 sample messages: clarified |
5903 | | | examples to use the new HTTP headers |
5905 | | | - Section 6.1.4: Added a section specifying message |
5906 | | | size limits. |
5908 | | | - Section2 6.2.6.1 and 6.3.6.1: corrected |
5909 | | | additionalInformation examples to use hashMap |
5910 | | | instead of name-value pair fields. |
5912 | | | - Section 7: Added a section on Terminology. |
5914 | | | - Command List Processing: removed command list |
5915 | | | processing from the document and schema: |
5917 | | | - Modified the Section 3 resource structure to |
5918 | | | align with these changes. |
5920 | | | - Removed Section 4 Datatypes: command, |
5921 | | | commandList, eventDomainThrottleSpecification, |
5922 | | | eventDomainThrottleSpecificationList, |
5923 | | | eventThrottlingState, suppressedNvPairs |
5925 | | | - Removed Section 6.1 description of commands |
5926 | | | toward event source clients |
5928 | | | - Removed Section 6.4 operation: |
5929 | | | provideThrottlingState |
5930 +-----------+---------+-------------------------------------------------------+
5931 | 7/30/2018 | v7.0 | - General: |
5933 | | | - Fixed typos throughout |
5935 | | | - Changed example versions to v7 |
5939 | | | - Clarified casing and use of dashes versus colons|
5940 | | | in eventName examples |
5942 | | | - Updated all field block versions |
5944 | | | - Section 2: added a note clarifying that TLS 1.2 or |
5945 | | | higher must be used for HTTPS connections. |
5947 | | | - Section 4 embedded schema changed to v30: |
5949 | | | - Added " ‘additionalProperties’: false " to |
5950 | | | objects to reject events that attempt to send |
5951 | | | properties that are not listed in the |
5952 | | | ‘properties’ keyword. Note: does not affect |
5953 | | | hashmap extensible fields. |
5955 | | | - Changed all versions in all field blocks from |
5956 | | | number to string enum with the version number |
5957 | | | fixed by the enum so the schema can validate |
5958 | | | events that attempt to send non-standard field |
5961 | | | - Changed syslog additionalFields to a hashMap |
5963 | | | - Section 4: |
5965 | | | - Fixed section heading numbers that were the same|
5967 | | | - 4.1.1: jsonObjectInstance: added an optional |
5968 | | | recursive jsonObject and removed all required |
5969 | | | fields from this object |
5971 | | | - 4.1.2: commonEventHeader: |
5973 | | | - nfVendorName: added this optional field |
5975 | | | - timeZoneOffset: changed from number to string|
5976 | | | with a particular format specified |
5978 | | | - version was changed from number to string (as|
5979 | | | were all the version fields of all the field |
5982 | | | - vesCommonEventListenerVersion: added this |
5983 | | | required field as a string enumeration |
5985 | | | - 4.2.3: Measurements Domain: |
5987 | | | - Added a note clarifying that NFs are required|
5988 | | | to report exactly one Measurement event per |
5989 | | | period per sourceName |
5991 | | | - diskUsage: added four new optional fields: |
5992 | | | diskWeightedIoTimeAve, diskWeightedIoTimeLast|
5993 | | | , diskWeightedIoTimeMax, |
5994 | | | diskWeightedIoTimeMin |
5996 | | | - memoryUsage: add one new optional field: |
5997 | | | percentMemoryUsage |
5999 | | | - nicPerformance: added nine new optional |
6000 | | | fields: administrativeState, operationalState|
6001 | | | , receivedPercentDiscard, |
6002 | | | receivedPercentError, receivedUtilization, |
6003 | | | speed, transmittedPercentDiscard, |
6004 | | | transmittedPercentError, |
6005 | | | transmittedUtilization |
6007 | | | - processorDimmAggregateThermalMargin: make the|
6008 | | | thermalMargin field required |
6010 | | | - 4.2.8: Syslog Domain: |
6012 | | | - Corrected the example at the end of the section |
6013 +-----------+---------+-------------------------------------------------------+
6014 | 7/31/2018 | v7.0.1 | - Section 4: The schema embedded at the top of |
6015 | | | section 4 was patched to correct a header field |
6016 | | | name error—the schema version moves from 30 to |
6019 | | | - Changed commonEventHeader field: ‘vesCommon\ |
6020 | | | EventFormatVersion’ field to ‘vesEventListener\ |
6021 | | | Version’ and set the enum to 7.0.1 |
6023 | | | - Also changed the commonEventHeader ‘required’ |
6024 | | | array to reflect use the corrected field name: |
6025 | | | ‘vesEventListenerVersion’ |
6027 | | | - Changed the commonEventHeader ‘version’ field |
6028 | | | enumeration to 4.0.1 |
6032 | | | - Changed the field block versions for the common |
6033 | | | header for ‘vesEventListenerVersion’ (to 7.0.1) |
6034 | | | and ‘version’ (to 4.0.1). |
6036 | | | - Sections 2 and 6: |
6038 | | | - Changed the commonEventHeader version fields |
6039 | | | above, in the sample message requests and |
6040 | | | responses; also updated the faultFieldsVersion |
6043 | | | - Section 6.1.2: Changed the X-LatestVersion to 7.0.1|
6044 | | | and the X-PatchVersion to 1 |
6045 +-----------+---------+-------------------------------------------------------+
6046 | 12/10/2018| v7.1 | - Section 1.2: Added Notification domain Perf3gpp |
6047 | | | domain and changed a reference from ‘measurements |
6048 | | | domain’ to ‘measurement domain’. |
6050 | | | - Section 1.7.1: Field Block Versions: added |
6051 | | | ‘perf3gppFields’ version at 1.0 and changed the |
6052 | | | following version enumerations so that existing |
6053 | | | clients of major version 7 would not be broken by |
6054 | | | this VES minor version change, in accordance with |
6055 | | | semantic versioning definitions: |
6057 | | | - commonEventHeader: changed to |
6058 | | | ‘vesEventListenerVersion’ enum to accept either |
6059 | | | 7.0 or 7.0.1 or 7.1. |
6061 | | | - commonEventHeader: changed ‘version’ enum to |
6062 | | | accept either 4.0 or 4.0.1 or 4.1 |
6064 | | | - Section 2: |
6066 | | | - changed sample request and responses to |
6067 | | | reference 7.1 instead of 7.0.1 (and version 4.1 |
6068 | | | of the commonEventHeader version, instead of |
6071 | | | - added a sub section on service provider support |
6072 | | | for mutual ssl certificate authentication |
6074 | | | - Section 4.1.2.1: |
6076 | | | - CommonEventHeader timeZoneOffset changed |
6077 | | | description from ‘UTC+/-hh.mm’ to ‘UTC+/-hh:mm’ |
6079 | | | - Added ‘perf3gpp’ to the domain enumeration |
6081 | | | - Section 4.2.3: Measurement Domain Datatypes: |
6083 | | | - In ‘MeasurementFields’: Changed ‘ipmiArray’ to |
6084 | | | ‘ipmi’ and made the type ‘object’ |
6086 | | | - ‘ipmiProcessor’: changed |
6087 | | | ‘pprocessorThermalControl’ to |
6088 | | | ‘processorThermalControl’ |
6090 | | | - ‘machineCheckException’: changed |
6091 | | | ‘processIdentifier’ to ‘vmIdentifier’ |
6093 | | | - Section 4.2.6: added the perf3gpp domain |
6095 | | | - Section 4 embedded schema: |
6097 | | | - Changed the schema version from 30.0.1 to 30.1 |
6098 | | | as a result of the changes below: |
6100 | | | - commonEventHeader: changed to |
6101 | | | ‘vesEventListenerVersion’ enum to accept either |
6102 | | | 7.0, 7.0.1 or 7.1 |
6104 | | | - commonEventHeader: changed the ‘version’ field |
6105 | | | enumeration to accept either 4.0, 4.0.1 or 4.1 |
6107 | | | - commonEventHeader: changed the ‘domain’ |
6108 | | | enumeration to add support for the perf3gpp |
6111 | | | - ‘event’: added a reference to ‘perf3gppFields’ |
6113 | | | - ‘hugePages’: changed the type of |
6114 | | | hugePagesIdentifier from number to string |
6116 | | | - ‘ipmiGlobalAggregateTemperatureMargin’: changed |
6117 | | | ‘pmiGlobalAggregateTemperatureMarginIdentifier’ |
6118 | | | to ‘globalAggregateTemperatureMarginIdentifier’ |
6120 | | | - ‘perf3gppFields’: added this object |
6122 | | | - Section 6: changed references throughout from |
6123 | | | v7.0.1 to v7.1 and v4.0.1 (of the commonEventHeader|
6124 | | | version) to v4.1 |
6126 | | | - Changed the location of the doc to VNF |
6127 | | | Requirements and changed the formatting |
6128 +-----------+---------+-------------------------------------------------------+
6129 | 1/28/2020 | v7.1.1 | - Changed event sizes from 2Mb to 1Mb |
6130 | | | - Configuration Requirement comments addressed |
6131 | | | - Changed DCAE Collector to VES Event Listener |
6132 | | | - Replaced VNF with NF where appropriate |
6133 | | | - Updated publishAnyEvent and publishBatchEvent to |
6134 | | | clarify both one way and mutual TLS are supported |
6135 | | | - Changed authorization for publishEventBatch |
6136 | | | because certification authorization is also |
6138 | | | - Updated fault use case in EventId Use Case |
6139 | | | Examples based on Ericsson feedback |
6140 | | | - Added new Configuration Requirements section |
6141 | | | - Added new Event Domain Requirements section |
6142 | | | - Updated security requirements based on agreements |
6143 | | | in ONAP Security Committee with details on 2-way |
6144 | | | certificate support |
6145 | | | - Provided clarifications on event buffering |
6146 | | | - Added Event Handling Requirements for |
6147 | | | publishEventFlow |
6148 | | | - Updated Field Block Versions to support existing |
6149 | | | clients of major version 7 |
6150 | | | - Updated sample request and response schemas |
6151 | | | - Updated embedded schema as follows: |
6153 | | | * Changed schema version to 30.1.1 |
6154 | | | * Changed measValues to measValuesList and similar |
6155 | | | changes throughout |
6156 | | | * Changed iMeasTypesList to sMeasTypesList |
6157 | | | - Corrected publishEventBatch call flow diagram |
6158 | | | - Changed AuthorizationHeader to Required? = NO for |
6159 | | | publishAnyEvent operation |
6160 | | | - Relaxed various requirements related to camel |
6161 | | | casing of values from 'must' to 'should' |
6162 +-----------+---------+-------------------------------------------------------+
6163 | 5/27/2020 | v7.2 | - Re-organized sections to flow more logically |
6164 | | | - Moved NF requirements to VNF Requirements |
6165 | | | - Changed DCAE Collector to VES Event Listener |
6166 | | | - Added StndDefined domain datatypes |
6167 | | | - Added eventCommonHeader field stndDefinedNamespace |
6168 | | | - Updated SVC exceptions with SVC2004 and SVC2006 |
6169 | | | - Updated links to OMA |
6170 | | | - Updated publishEventBatch to support stndDefined |
6171 +-----------+---------+-------------------------------------------------------+
6172 | 01/13/2021| v7.2.1 | - updated publishEventBatch to support stndDefined |
6173 | | | - added eventId use-case example, where eventID |
6174 | | | uniqueness cannot be assured |
6175 +-----------+---------+-------------------------------------------------------+
6177 .. _time_zone_abbreviations: https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations
6178 .. _Common_definitions: https://www.openmobilealliance.org/release/REST_NetAPI_Common/V1_0-20180116-A/OMA-TS-REST_NetAPI_Common-V1_0-20180116-A.pdf
Code Review / vnfrqts / requirements.git / blob