ONAP Service Assurance VES Spec 7 1 Updated

ONAP Service Assurance VES Spec 7. 1 Updated Alok Gupta +1 (732)-420 -7007 ag 1367@att. com Date: Dec 11 th, 2018

VES (NF Event Streaming) Specification 7. 1 Changes VES 7. 1 Listener includes a new domain perf 3 gpp to support 3 gpp based performance counters. Few correction have also been made. VES 7. 1 Event Listener Changes • Section 1. 2: Added Notification domain Perf 3 gpp domain and changed a reference from ‘measurements domain’ to ‘measurement domain’. • Section 1. 7. 1: Field Block Versions: added ‘perf 3 gpp. Fields’ version at 1. 0 and changed the following version enumerations so that existing clients of major version 7 would not be broken by this VES minor version change, in accordance with semantic versioning definitions: - common. Event. Header: changed to ‘ves. Event. Listener. Version’ enum to accept either 7. 0 or 7. 0. 1 or 7. 1. Future Current - common. Event. Header: changed ‘version’ enum to accept either 4. 0 or 4. 0. 1 or 4. 1 § Common predictable, flexible, reusable event format § Different interfaces and formats requiring • Section 2: for all VFs => Closed Loop Automation customization (3 to 6 months development) - changed sample request and responses to reference 7. 1 instead of 7. 0. 1 (and version 4. 1 of the common. Event. Header version, § Defined by AT&T based on conformance to standards § instead Definedofbyv 4. 0. 1) vendors § Vendor agnostic and Configurable Varies abysub network functions and software - § added section on service provider releases support for mutual ssl certificate authentication • Section 4. 1. 2. 1: 2 - Common. Event. Header time. Zone. Offset changed description from ‘UTC+/-hh. mm’ to ‘UTC+/-hh: mm’ - Added ‘perf 3 gpp’ to the domain enumeration • Section 4. 2. 3: Measurement Domain Datatypes: - In ‘Measurement. Fields’: Changed ‘ipmi. Array’ to ‘ipmi’ and made the type ‘object’ - ‘ipmi. Processor’: changed ‘pprocessor. Thermal. Control’ to ‘processor. Thermal. Control’ - ‘machine. Check. Exception’: changed ‘process. Identifier’ to ‘vm. Identifier’ Licensed under the Creative Commons License, Attribution 4. 0 Intl. (the "License"); you may not use this documentation except in compliance with the License.

VES (NF Event Streaming) Specification 7. 1 Changes – Cont. VES 7. 1 Event Listener Changes • Section 4. 2. 6: added the perf 3 gpp domain • Section 4 embedded schema: Changed the schema version from 30. 0. 1 to 30. 1 as a result of the changes below: common. Event. Header: changed to ‘ves. Event. Listener. Version’ enum to accept either 7. 0, 7. 0. 1 or 7. 1 common. Event. Header: changed the ‘version’ field enumeration to accept either 4. 0, 4. 0. 1 or 4. 1 common. Event. Header: changed the ‘domain’ enumeration to add support for the perf 3 gpp domain. Future ‘event’: added a Current reference to ‘perf 3 gpp. Fields’ Common predictable, flexible, reusable event format Different interfaces and formats ‘huge. Pages’: changed therequiring type of huge. Pages. Identifier§ from number to string for all VFs => Closed Loop Automation customization (3 to 6 months development) ‘ipmi. Global. Aggregate. Temperature. Margin’: changed ‘pmi. Global. Aggregate. Temperature. Margin. Identifier’ to § Defined by AT&T based on conformance to standards § ‘global. Aggregate. Temperature. Margin. Identifier’ Defined by vendors § Vendor agnostic and Configurable Varies by network functions software -§ ‘perf 3 gpp. Fields’: addedand this objectreleases -§ - 3 • Section 6: changed references throughout from v 7. 0. 1 to v 7. 1 and v 4. 0. 1 (of the common. Event. Header version) to v 4. 1 VES 3. 2 Event Registration (Yaml) Changes • Added the PM Data Dictionary and FM Meta Data sections Licensed under the Creative Commons License, Attribution 4. 0 Intl. (the "License"); you may not use this documentation except in compliance with the License.

VES (NF Event Streaming) Specification 7. 0. 1 Changes An Error was discovered in VES JSON Schema 30. 0 aligned to VES 7. 0. We are correcting the error and providing the updated documents. The updated document are VES Listener 7. 0. 1 and VES JSON Schema 30. 0. 1). Please use this specs instead of VES 7. 0. Updated documents are included on the last page. VES Event Listener Changes • Section 4: The schema embedded at the top of section 4 was patched to correct a header field name error—the schema version moves from 30 to 30. 0. 1: - Changed common. Event. Header field: ‘ves. Common. Event. Format. Version’ field to ‘ves. Event. Listener. Version’ Future Current and set the enum to 7. 0. 1 § Common predictable, reusable format Different interfaces and formats requiring -§ Also changed the common. Event. Header ‘required’ array to reflect use the flexible, corrected fieldevent name: for all VFs => Closed Loop Automation customization (3 to 6 months development) ‘ves. Event. Listener. Version’ § Defined by vendors -§ Changed the common. Event. Header ‘version’ field enumeration to. AT&T 4. 0. 1 based on conformance to standards § Varies by network functions and software releases • Section 1: 4 § Vendor agnostic and Configurable - Changed the field block versions for the common header for ‘ves. Event. Listener. Version’ (to 7. 0. 1) and ‘version’ (to 4. 0. 1). • Sections 2 and 6: - Changed the common. Event. Header version fields above, in the sample message requests and responses • Section 6. 1. 2: Changed the API version to 7. 0. 1 Licensed under the Creative Commons License, Attribution 4. 0 Intl. (the "License"); you may not use this documentation except in compliance with the License.

VES (NF Event Streaming) Specification 7. 0 Changes We are replacing VES 6. 0 Specs with VES 7. 0 (VES 6. 0 will not be supported) incorporating corrections reported by various teams. The reason for moving to major release is change in format for version numbers from number to string (as suggested by Nokia team: conversion from binary may change the content), correcting format for timezone offset to use UTC +- hh: mm (from number to string), and addition of ves. Common. Event. Listner. Version indicating the current requirements. Summary of changes: VES Event Listener Changes • General: - Fixed typos throughout Current - § Changed exampleand versions v 7 Different interfaces formatstorequiring • 5 Future § Common predictable, flexible, reusable event format for all VFs => Closed Loop Automation customization (3 to 6 months development) Section 1: § Defined by AT&T based on conformance to standards Defined by vendors - § Clarified casing and use of dashes versus colons in event. Name examples § Vendor agnostic and Configurable Varies by all network functions and software releases - § Updated field block versions • Section 2: added a note clarifying that TLS 1. 2 or higher must be used for HTTPS connections. • Section 4: embedded schema changed to v 30: - Added “ ‘additional. Properties’: false ” to objects to reject events that attempt to send properties that are not listed in the ‘properties’ keyword. Note: does not affect hashmap extensible fields. - Changed all versions in all field blocks from number to string enum with the version number fixed by the enum so the schema can validate events that attempt to send non-standard field blocks. - Changed syslog additional. Fields to a hash. Map Licensed under the Creative Commons License, Attribution 4. 0 Intl. (the "License"); you may not use this documentation except in compliance with the License.

VES (NF Event Streaming) Specification 7. 0 Changes • Section 4: - Fixed section heading numbers that were the same. - 4. 1. 1: json. Object. Instance: added an optional recursive json. Object and removed all required fields from this object - 4. 1. 2: common. Event. Header: • • nf. Vendor. Name: added this optional field time. Zone. Offset: changed from number to string with a particular format specified version was changed from number to string (as were all the version fields of all the field blocks) ves. Common. Event. Listener. Version: added this required field as a string enumeration - 4. 2. 3: Measurements Domain: Future Current • Added a note clarifying that NFs are required to report exactly one Measurement event period per source. Name § Common predictable, flexible, reusable event format § Different interfaces and formats requiring • disk. Usage: added four new optional fields: disk. Weighted. Io. Time. Ave, disk. Weighted. Io. Time. Last, disk. Weighted. Io. Time. Max, disk. Weighted. Io. Time. Min for all VFs => Closed Loop Automation customization (3 to 6 months development) • memory. Usage: § Defined by AT&T based on conformance to standards § Defined by vendors add one new optional field: percent. Memory. Usage • nic. Performance: added nine new optional fields: administrative. State, operational. State, § Vendor agnostic andreceived. Percent. Discard, Configurable transmitted. Utilization § Variesreceived. Percent. Error, by network functionsreceived. Utilization, and software releases speed, transmitted. Percent. Discard, transmitted. Percent. Error, • processor. Dimm. Aggregate. Thermal. Margin: make thermal. Margin field required 6 - 4. 2. 8: Syslog Domain: VES Event Registration Changes • • Removed the is. Homogeneous keyword. Modified the types of aggregation. Roles. Clarified cast. To Added comment keyword Licensed under the Creative Commons License, Attribution 4. 0 Intl. (the "License"); you may not use this documentation except in compliance with the License.

VES (NF Event Streaming) Specification 6. 0 Changes § Section 1 o VES Meaning: Expanded to include event streaming for VNF, PNF and Infrastructure o event. Names Construction: {Domain. Abbreviation}_{Publisher. Name}_{Description} o Added a list of all the latest field block version numbers in this version of the API spec. § Section 3 § Removed Throttling requirements. App-C or controller need to support throttling. § Section 4 Future Current §§ Different hash. Maps. Changed name-value pair structures to hash. Maps § Common predictable, flexible, reusable event format interfaces and formatsall requiring for all VFs => Closed Loop Automation customization to 6 months development) § Name=(3“name”’ value =“value” => “name” = “Value” § Defined by AT&T based on conformance to standards § Defined by vendors §§ Varies Use by of network Optional fields: If the event publisher collects a field thatand is identified § Vendor agnostic Configurable as optional in functions and software releases data structures below, then the event publisher must send that field. 7 § the Extensible Filed Use Clarification: VES contains various extensible structures (e. g. , hash. Map) that enable event publishers to send information that has not been explicitly defined in VES data structures. § § Event publishers must not send information through extensible structures where VES has explicitly defined fields for that information. For example, event publishers must not send information like cpu. Idle, through an extensible structure, because VES has explicitly defined a cpu. Usage. cpu. Idle field for the communication of that information. Keys sent through extensible fields must use camel casing to separate words and acronyms; only the first letter of each acronym shall be capitalized. Licensed under the Creative Commons License, Attribution 4. 0 Intl. (the "License"); you may not use this documentation except in compliance with the License.

VES (NF Event Streaming) Specification 6. 0 Changes § Section 4 – Contd § § 8 Common Event Data Types: Changed vendor. Vnf. Name. Fields to vendor. Nf. Name. Fields in Sip. Signaling and Voice Quality Domains Common Event Header clarified the following descriptions: § event. Id: Event key that is unique to the event source. The key must be unique within notification life cycle similar to Event. ID from 3 GPP. It could be a sequential number, or a composite key formed from the event fields, such as source. Name_alarm. Condition_start. Epoch. The event. Id should not include whitespace. For fault events, event. Id is the event. Id of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, event. Id must be the same as the initial alarm (along with the same start. Epoch. Microsec and an incremental sequence number). § reporting. Entity. Name: in another vnf/vm or pnf which is Future Current Name of the entity reporting the event or detecting a problem experiencing the problem. May be the same as the source. Name. For synthetic events generated by DCAE, it is the name § Common predictable, flexible, reusable event format § Different and formats of interfaces the app generating therequiring event. forwhich all VFsmay => Closed Loop Automation customization (3 to 6 months development) § source. Name: Name of the entity experiencing the event issue, be detected and reported by a separate Defined based. Aon conformance to standards § Definedreporting by vendors entity. The source. Name identifies the device for §which databy is AT&T collected. valid source. Name must be inventoried in A&AI. and If source. Name is a VNFC or VM, then§ the eventagnostic must beand reporting data for that particular VNFC or Vendor Configurable § Varies by network functions software releases VM. If the source. Name is a VNF, comprised of multiple VNFCs, the data must be reported/aggregated at the VNF leve. I. Data for individual VNFC must not be included in the VNF source. Name event. § start. Epoch. Microseconds: the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, start. Epoch. Microsec shall be rounded to the nearest interval boundary (e. g. , the epoch equivalent of 3: 00 PM, 3: 10 PM, 3: 20 PM, etc…). For fault events, start. Epoch. Microsec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, start. Epoch Microsec must be the same as the initial alarm (along with the same event. Id an incremental sequence number). § added ‘notification and pnf. Registrion domains § Fault Domain Section 4. 2. 1: clarified the definitions of alarm. Condition and specific. Problem Licensed under the Creative Commons License, Attribution 4. 0 Intl. (the "License"); you may not use this documentation except in compliance with the License. .

VES (NF Event Streaming) Specification 6. 0 Changes § Section 4 – Contd § Fault Domain: clarified the following definitions § § § 9 § § § alarm. Condition: Short name of the alarm condition/problem, such as a trap name. Should not have white space (e. g. , tp. Lg. Cgi. Not. In. Config, Bfd. Session. Down, link. Down, etc…) § specific. Problem: Description of the alarm or problem (e. g. , ‘This event is sent when the LG is asked to perform a location for a CGI that is not in its configuration’) Measurements. Current Domain: changed the name of this domain from ‘measurements. For. Vf. Scaling’ to Future ‘measurement’ § Common predictable, flexible, reusable event format Different interfaces and formats requiring for all VFs => Closed Loop Automation customization (3 to 6 Domain: months development) Measurement Updates following fileds: cpu. Usage, disk. Usage, memory. Usage, § Defined by AT&T based on conformance to standards Defined by vendors v. Nic. Performance to nic. Performance and added load Array, huge. Pages. Array, § Vendor agnostic and Configurable Varies by network functions and software releases Add Notification and pnf. Registrion domains Syslog Domain: Added two new fields: syslog. Msg. Host and syslog. Ts. Clarified field descriptions. Clarified syslog. SData example. § Section 6: specified message size limit of 2 MB Licensed under the Creative Commons License, Attribution 4. 0 Intl. (the "License"); you may not use this documentation except in compliance with the License.

VES Event Registration Specification 2. 0 Changes § Updated examples to align with VES Event Listener 6. 0 § Clarified Action keyword § Modified the rules example to conform to the Complex Conditions and Rules sections. Current § Different interfaces and formats requiring customization (3 to 6 months development) § Defined by vendors § Varies by network functions and software releases Future § Common predictable, flexible, reusable event format for all VFs => Closed Loop Automation § Defined by AT&T based on conformance to standards § Vendor agnostic and Configurable 10 Licensed under the Creative Commons License, Attribution 4. 0 Intl. (the "License"); you may not use this documentation except in compliance with the License.

Requirements Files q VES Listener Requirements 7. 1: https: //onap. readthedocs. io/en/latest/submodules/vnfsdk/model. git/docs/files/ves 7_1 spec. html? highlight=v es q VES JSON Schema 30. 1 q VES Event Registration 3. 2 https: //onap. readthedocs. io/en/latest/submodules/vnfsdk/model. git/docs/files/VES_Registraion_3_2. html? hi ghlight=ves q VES Excel 30. 1 11 Licensed under the Creative Commons License, Attribution 4. 0 Intl. (the "License"); you may not use this documentation except in compliance with the License.