diff options
Diffstat (limited to 'docs/Chapter8/VES_Registraion_3_2.rst')
| -rw-r--r-- | docs/Chapter8/VES_Registraion_3_2.rst | 3770 |
1 files changed, 1799 insertions, 1971 deletions
diff --git a/docs/Chapter8/VES_Registraion_3_2.rst b/docs/Chapter8/VES_Registraion_3_2.rst index f05771e..cb24b58 100644 --- a/docs/Chapter8/VES_Registraion_3_2.rst +++ b/docs/Chapter8/VES_Registraion_3_2.rst @@ -24,15 +24,10 @@ Service: VES Event Registration 3.2 | under the License. | +-----------------------------------------------------------------------------+ -+-------------------+--------------------------+ -| Document Number | VES Event Registration | -+-------------------+--------------------------+ -| Revision | 3.2 | -+-------------------+--------------------------+ -| Revision Date | December 10, 2018 | -+-------------------+--------------------------+ -| Author | Rich Erickson | -+-------------------+--------------------------+ +:Document: VES Event Registration +:Revision: 3.2 +:Revision Date: December 10th, 2018 +:Author: Rich Erickson +-----------------+------------------------------+ | Contributors: | **Shau-Ann Chang – AT&T** | @@ -197,7 +192,7 @@ File Structure Each eventType is registered as a distinct YAML ‘document’. -YAML files consist of a series of YAML documents delimited by ‘---‘ and +YAML files consist of a series of YAML documents delimited by ‘- - -‘ and ‘…’ for example: .. code-block:: ruby @@ -242,7 +237,7 @@ Each object or field name in the eventName being registered is followed by a ‘qualifier’, which consists of a colon and two curly braces, for example: - ``“objectOrFieldName: { }”`` + ``"objectOrFieldName: { }"`` The curly braces contain meta-information about that object or field name (also known as the ‘element’), such as whether it is required to be @@ -254,16 +249,16 @@ within the curly braces: Action ++++++ -The ‘action’ keyword may be applied to field values or to the event as a -whole. The ‘action’ keyword specifies a set of actions that should be -taken if a specified trigger occurs. For example, the ‘action’ keyword +The ``action`` keyword may be applied to field values or to the event as a +whole. The ``action`` keyword specifies a set of actions that should be +taken if a specified trigger occurs. For example, the ``action`` keyword may specify that a threshold crossing alert (i.e., tca) be generated, and/or that a specific microservice handler be invoked, and/or that a specific named-condition be asserted. In the Rules section of the YAML file, tca’s and microservices may be defined on individual named-conditions or on logical combinations of named-conditions. -The ‘action:’ keyword is followed by five values in square brackets. The +The ``action:`` keyword is followed by five values in square brackets. The first two values communicate the trigger, and the last three values communicate the actions to be taken if that trigger occurs: @@ -308,23 +303,23 @@ communicate the actions to be taken if that trigger occurs: policies and configure flows that need to be in place to support the recommended runtime behavior. - If a vendor wants to recommend an action, it can either work with - the service provider to identify and specify microservices that the - service provider support, or, the vendor may simply indicate and - recommend a generic microservice function by prefixing ‘RECO-’ in - front of the microservice name, which should be expressed in upper - camel case with no underscores, hyphens or spaces. + - If a vendor wants to recommend an action, it can either work with + the service provider to identify and specify microservices that the + service provider support, or, the vendor may simply indicate and + recommend a generic microservice function by prefixing ‘RECO-’ in + front of the microservice name, which should be expressed in upper + camel case with no underscores, hyphens or spaces. - The fourth value may also be set to ‘null’. + - The fourth value may also be set to ‘null’. -1. The fifth value third value indicates a specific threshold crossing +5. The fifth value third value indicates a specific threshold crossing alert (i.e., tca) that should be generated if the trigger occurs. This field may be omitted or provided as ‘null’. - Tca’s should be indicated by their eventNames. + - Tca’s should be indicated by their eventNames. - When a tca is specified, a YAML registration for that tca eventName - should be added to the event registrations within the YAML file. + - When a tca is specified, a YAML registration for that tca eventName + should be added to the event registrations within the YAML file. Examples: @@ -350,7 +345,7 @@ Examples: AggregationRole +++++++++++++++ -The ‘aggregationRole’ keyword is applied to the value keyword in a field +The ``aggregationRole`` keyword is applied to the value keyword in a field of a name-value pair. AggregationRole may be set to one of the following: @@ -377,7 +372,7 @@ maximum value specified by design. Typically, delta calculation is needed based on two cumulativeCounter values over two consecutive collection intervals. -If needed, the aggergationRole setting tells the receiving event +If needed, the ``aggregationRole`` setting tells the receiving event processor how to aggregate the extensible keyValuePair data. Data aggregation may use a combination of ‘index’ and ‘reference’ data fields as aggregation keys while applying aggregation formulas, such as @@ -385,7 +380,7 @@ summation or average on the ‘gauge’ fields. Example 1: - Interpretation of the below: If additionalMeasurements is supplied, + - Interpretation of the below: If additionalMeasurements is supplied, it must have key name1 and name1’s value should be interpreted as an index: @@ -409,51 +404,56 @@ Example 1: Example 2: -- Let’s say a vnf wants to send the following ‘TunnelTraffic’ fields - through a VES arrayOfFields structure (specifically through - additionalMeasurements in the VES measurementField block): +- Let’s say a vnf wants to send the following ``TunnelTraffic`` fields + through a VES arrayOfFields structure (specifically through + additionalMeasurements in the VES measurementField block): -+-----------------------------+---------------+----------------------+------------------------+-----------------------+ -| Tunnel Name | Tunnel Type | Total Output Bytes | Total Output Packets | Total Output Errors | -+=============================+===============+======================+========================+=======================+ -| ST6WA21CRS:TUNNEL-TE40018 | PRIMARY | 2457205 | 21505 | 0 | -+-----------------------------+---------------+----------------------+------------------------+-----------------------+ -| ST6WA21CRS:TUNNEL-TE1029 | PRIMARY | 46677 | 220 | 0 | -+-----------------------------+---------------+----------------------+------------------------+-----------------------+ -| ST6WA21CRS:TUNNEL-TE1028 | PRIMARY | 80346 | 577 | 0 | -+-----------------------------+---------------+----------------------+------------------------+-----------------------+ ++--------------------------+--------+-------------+-------------+-------------+ +| Tunnel Name | Tunnel | Total | Total Output| Total Output| +| | Type | Output Bytes| Packets | Errors | ++==========================+========+=============+=============+=============+ +| ST6WA21CRS:TUNNEL-TE40018| PRIMARY| 2457205 | 21505 | 0 | ++--------------------------+--------+-------------+-------------+-------------+ +| ST6WA21CRS:TUNNEL-TE1029 | PRIMARY| 46677 | 220 | 0 | ++--------------------------+--------+-------------+-------------+-------------+ +| ST6WA21CRS:TUNNEL-TE1028 | PRIMARY| 80346 | 577 | 0 | ++--------------------------+--------+-------------+-------------+-------------+ -- Tunnel Name is an index, Tunnel Type is reference data and the other - three columns are counters +- Tunnel Name is an index, Tunnel Type is reference data and the other + three columns are counters - The first three columns would be sent through VES as follows: .. code-block:: yaml - additionalMeasurements: {presence: required, array: [ - { - name: {presence: required, value: TunnelTraffic}, - arrayOfFields: {presence: required, array: [ - { - name: {presence: required, value: TunnelName}, - value: {presence: required, aggregationRole: index}, - }, - { - name: {presence: required, value: TunnelType}, - value: {presence: required, aggregationRole: reference} - }, - { - name: {presence: required, value: TotalOutputBytes}, - value: {presence: required, aggregationRole: gauge, castTo:number } + additionalMeasurements: { + presence: required, array: [ + { + name: { presence: required, value: TunnelTraffic}, + arrayOfFields: { + presence: required, array: [ + { + name: { presence: required, value: TunnelName}, + value: { presence: required, aggregationRole: index}, + }, + { + name: { presence: required, value: TunnelType}, + value: { presence: required, aggregationRole: reference} + }, + { + name: { presence: required, value: TotalOutputBytes}, + value: { presence: required, aggregationRole: gauge, castTo:number } + } + ] } - ]} - } - ]} + } + ] + } Array +++++ -The ‘array’ keyword indicates that the element is an array; ‘array:’ is +The ``array`` keyword indicates that the element is an array; ``array:`` is following by square brackets which contain the elements of the array. Note that unlike JSON itself, the YAML registration will explicitly declare the array elements and will not communicate them anonymously. @@ -462,55 +462,58 @@ Examples: .. code-block:: yaml - element: { array: [ - - firstArrayElement: { }, - - secondArrayElement: { } - - ]} + element: { + array: [ + firstArrayElement: { }, + secondArrayElement: { } + ] + } CastTo ++++++ -The ‘castTo’ keyword is applied to ‘value’ keywords. It tells the +The ``castTo`` keyword is applied to ``value`` keywords. It tells the receiving event processor to cast (or interpret) the supplied value from its standard VES datatype (typically a string) to some other datatype. If not supplied the implication is the standard VES datatype applies. A value may be castTo one and only one of the following data types: -- boolean +- boolean -- integer +- integer -- number (note: this supports decimal values as well as integral - values) +- number (note: this supports decimal values as well as integral + values) -- string +- string Example: .. code-block:: yaml - fieldname: { value: [ x, y, z ], castTo: number } # only values ‘x’, - ‘y’, or ‘z’ allowed + fieldname: { value: [ x, y, z ], castTo: number } + # only values ‘x’,‘y’, or ‘z’ allowed # each must be cast to a number .. code-block:: yaml - additionalMeasurements: {presence: optional, array: [ - { - name: {presence: required}, - arrayOfFields: {presence: required, array: [ - { - name: {presence: required, value: name1}, - value: {presence: required, castTo: number} + additionalMeasurements: { + presence: optional, array: [ + { + name: { presence: required}, + arrayOfFields: { + presence: required, array: [ + { + name: { presence: required, value: name1}, + value: { presence: required, castTo: number} + } + ] } - ] } - } - ] } + } + ] + } **For another example, see the second example under AggregationRole.** @@ -518,7 +521,7 @@ Example: Comment +++++++ -The ‘comment’ keyword enables event registrations to communicate +The ``comment`` keyword enables event registrations to communicate additional information, in the form of a quoted string, to designers consuming the event registration. Such additional information might convey meaning, instructions or potential effects associated with @@ -546,15 +549,15 @@ Examples: event: { presence: required, - comment: “this event only occurs in conditions when the - ipq has stopped operating; manual reset may be required”, + comment: "this event only occurs in conditions when the + ipq has stopped operating; manual reset may be required", structure: { . . . } } Default +++++++ -The ‘default’ keyword specifies a default field value. Note: the default +The ``default`` keyword specifies a default field value. Note: the default value must be within the range or enumeration of acceptable values. Examples: @@ -571,16 +574,16 @@ Examples: HeartbeatAction ++++++++++++++++ -The ‘heartbeatAction’ keyword is provided on the ‘event’ objectName for +The ``heartbeatAction`` keyword is provided on the ``event`` objectName for heartbeat events only. It provides design time guidance to the service provider’s heartbeat processing applications (i.e., their watchdog -timers). The syntax and semantics of the ‘heartbeatAction’ keyword are -similar to the ‘action’ keyword except the trigger is specified by the +timers). The syntax and semantics of the ``heartbeatAction`` keyword are +similar to the ``action`` keyword except the trigger is specified by the first field only instead of the first two fields. When the -‘heartbeatAction’ keyword is indicated, the first field is an integer +``heartbeatAction`` keyword is indicated, the first field is an integer indicating the number of successively missed heartbeat events. Should that trigger occur, the remaining fields have the same order, meaning -and optionality as those described for the ‘action’ keyword. +and optionality as those described for the ``action`` keyword. Examples: @@ -595,61 +598,63 @@ Examples: keyValuePairString ++++++++++++++++++ -The ‘keyValuePairString’ keyword describes the key-value pairs to be +The ``keyValuePairString`` keyword describes the key-value pairs to be communicated through a string (e.g., in the VES Syslog Fields -‘syslogSData’ or ‘additionalFields’ strings). This keyword takes three +``syslogSData`` or ``additionalFields`` strings). This keyword takes three parameters: -- The first parameter specifies the character used to delimit (i.e., to - separate) the key-value pairs. If a space is used as a delimiter, - it should be communicated within single quotes as ‘ ‘; otherwise, - the delimiter character should be provided without any quotes. +- The first parameter specifies the character used to delimit (i.e., to + separate) the key-value pairs. If a space is used as a delimiter, + it should be communicated within single quotes as ‘ ‘; otherwise, + the delimiter character should be provided without any quotes. -- The second parameter specifies the characters used to separate the - keys and values. If a space is used as a separator, it should be - communicated within single quotes as ‘ ‘; otherwise, the - separator character should be provided without any quotes. +- The second parameter specifies the characters used to separate the + keys and values. If a space is used as a separator, it should be + communicated within single quotes as ‘ ‘; otherwise, the + separator character should be provided without any quotes. -- The third parameter is a “sub-keyword” (i.e., it is used only within - ‘keyValuePairString’) called ‘keyValuePairs: [ ]’. Within the - square brackets, a list of ‘keyValuePair’ keywords can be - provided as follows: +- The third parameter is a “sub-keyword” (i.e., it is used only within + ‘keyValuePairString’) called ‘keyValuePairs: [ ]’. Within the + square brackets, a list of ‘keyValuePair’ keywords can be + provided as follows: - - Each ‘keyValuePair’ is a structure (used only within - ‘keyValuePairs’) which has a ‘key’ and a ‘value’. Each - ‘keyValuePair’, ‘key’ and ‘value’ may be decorated with any of - the other keywords specified in this specification (e.g., with - ‘presence’, ‘value’, ‘range’ and other keywords). + - Each ‘keyValuePair’ is a structure (used only within + ‘keyValuePairs’) which has a ‘key’ and a ‘value’. Each + ‘keyValuePair’, ‘key’ and ‘value’ may be decorated with any of + the other keywords specified in this specification (e.g., with + ‘presence’, ‘value’, ‘range’ and other keywords). Examples: -- The following specifies an additionalFields string which is stuffed - with ‘key=value’ pairs delimited by the pipe (‘\|’) symbol as in - (“key1=value1\|key2=value2\|key3=value3…”). +- The following specifies an additionalFields string which is stuffed + with ‘key=value’ pairs delimited by the pipe (‘\|’) symbol as in + (“key1=value1\|key2=value2\|key3=value3…”). .. code-block:: yaml additionalFields: { - presence: required, keyValuePairString: {\|, =, keyValuePairs: [ - keyValuePair: { - presence: required, structure: { - key: {presence: required, value: someKeyName}, - value: {presence: required, range: [0, 100]} - } - }, - keyValuePair: { - presence: optional, structure: { - key: {presence: required, value: someOtherKeyName}, - value: {presence: required, value [red, white, blue]} + presence: required, keyValuePairString: { + \|, =, keyValuePairs: [ + keyValuePair: { + presence: required, structure: { + key: { presence: required, value: someKeyName}, + value: { presence: required, range: [0, 100]} + } + }, + keyValuePair: { + presence: optional, structure: { + key: { presence: required, value: someOtherKeyName}, + value: { presence: required, value [red, white, blue]} + } } - } - ]} + ] + } } Presence +++++++++ -The ‘presence’ keyword may be defined as ‘required’ or ‘optional’. If +The ``presence`` keyword may be defined as ‘required’ or ‘optional’. If not provided, the element is assumed to be ‘optional’. Examples: @@ -670,14 +675,14 @@ Examples: Range +++++++ -The ‘range’ keyword applies to fields (i.e., simpleTypes); indicates the +The ``range`` keyword applies to fields (i.e., simpleTypes); indicates the value of the field is a number within a specified range of values from -low to high (inclusive of the indicated values). . ‘range:’ is followed +low to high (inclusive of the indicated values).``range:`` is followed by two parameters in square brackets: -- the first parameter conveys the minimum value +- the first parameter conveys the minimum value -- the second parameter conveys the maximum value or ‘unbounded’ +- the second parameter conveys the maximum value or ‘unbounded’ The keyword ‘unbounded’ is supported to convey an unbounded upper limit. Note that the range cannot override any restrictions defined in the VES @@ -696,7 +701,7 @@ Examples: Structure ++++++++++ -The ‘structure’ keyword indicates that the element is a complexType +The ``structure`` keyword indicates that the element is a complexType (i.e., an object) and is followed by curly braces containing that object. @@ -720,7 +725,7 @@ Example: Units +++++++ -The ‘units’ qualifier may be applied to values provided in VES Common +The ``units`` qualifier may be applied to values provided in VES Common Event Format extensible field structures. The ‘units’ qualifier communicates the units (e.g., megabytes, seconds, Hz) that the value is expressed in. Note: the ‘units’ should not contain any space characters @@ -733,15 +738,15 @@ Example: field: { structure: { - name: { value: pilotNumberPoolSize }, - value: { units: megabytes } # the value will be expressed in megabytes + name: { value: pilotNumberPoolSize }, + value: { units: megabytes } # the value will be expressed in megabytes } } Value +++++++ -The ‘value’ keyword applies to fields (i.e., simpleTypes); indicates a +The ``value`` keyword applies to fields (i.e., simpleTypes); indicates a single value or an enumeration of possible values. If not provided, it is assumed the value will be determined at runtime. Note that the declared value cannot be inconsistent with restrictions defined in the @@ -780,7 +785,7 @@ Rules Document ++++++++++++++ After all events have been defined, the YAML file may conclude with a -final YAML document delimited by ‘---‘ and ‘…’, which defines rules +final YAML document delimited by ‘- - -‘ and ‘…’, which defines rules based on the named ‘conditions’ asserted in action qualifiers in the preceding event definitions. For example: @@ -844,38 +849,34 @@ preceding event definitions. For example: Rules Syntax and Semantics ++++++++++++++++++++++++++++ -The YAML ‘rules’ document begins with the keyword ‘rules’ followed by a +The YAML ``rules`` document begins with the keyword ``rules`` followed by a colon and square brackets. Each rule is then defined within the square brackets. Commas are used to separate rules. Each rule is expressed as follows: -.. code-block:: text +.. code-block:: yaml rule: { - trigger: *logical expression in terms of conditions*, - - microservices: [ *microservice1, microservice2, microservice3…* ] - - alerts: [tcaE*ventName1, tcaEventName2, tcaEventName3…* ], - + microservices: [ *microservice1, microservice2, microservice3…* ], + alerts: [tcaE*ventName1, tcaEventName2, tcaEventName3…* ] } Notes: -- All referenced tcaEventNames should be defined within the YAML. +- All referenced tcaEventNames should be defined within the YAML. -- For information about microservices, see section 3.1.1 bullet number - 4. +- For information about microservices, see section 3.1.1 bullet number + 4. -- At least one microservice or alert should be specified, and both - microservices and alerts may be specified. +- At least one microservice or alert should be specified, and both + microservices and alerts may be specified. Simple Triggers ++++++++++++++++ -The trigger is based on the named ‘conditions’ asserted in the action +The trigger is based on the named ``conditions`` asserted in the action qualifiers within the event definitions earlier in the YAML file. The following logical operators are supported: @@ -894,7 +895,7 @@ file. Example rules definition: -.. code-block:: text +.. code-block:: yaml rules: [ rule: { @@ -903,7 +904,7 @@ Example rules definition: microservices: [rebootVm] }, rule: { - trigger: B \|\| (C & D), + trigger: B || (C & D), microservices: [scaleOut] } ] @@ -921,15 +922,18 @@ Time based rules may be established by following any named condition with a colon and curly braces. The time based rule is placed in the curly braces as follows: -trigger: B:{3 times in 300 seconds} +.. code-block:: yaml + + trigger: B:{3 times in 300 seconds} This means that if condition B occurs 3 (or more) times in 300 seconds (e.g., 5 minutes), the trigger fires. More complex triggers can be created as follows: -trigger: B:{3 times in 300 seconds} \|\| (C & D:{2 times in 600 -seconds}), +.. code-block:: yaml + + trigger: B:{3 times in 300 seconds} | | (C & D:{2 times in 600 seconds}), This means that the trigger fires if condition B occurs 3 (or more) times in 5 minutes, OR, if condition D occurs 2 (or more) times in 10 @@ -948,17 +952,17 @@ measurements based on information in the PM Dictionary. The PM dictionary is supplied by NF vendors in two parts: -- *PM Dictionary Schema*: specifies meta-information about perf3gpp - measurement events from that vendor. The meta-information is conveyed - using standard meta-information keywords, and may be extended to - include vendor-specific meta-information keywords. The PM Dictionary - Schema may also convey a range of vendor-specific values for some of - the keywords. Note: a vendor may provide multiple versions of the PM - Dictionary Schema and refer to those versions from the PM Dictionary. +- *PM Dictionary Schema*: specifies meta-information about perf3gpp + measurement events from that vendor. The meta-information is conveyed + using standard meta-information keywords, and may be extended to + include vendor-specific meta-information keywords. The PM Dictionary + Schema may also convey a range of vendor-specific values for some of + the keywords. Note: a vendor may provide multiple versions of the PM + Dictionary Schema and refer to those versions from the PM Dictionary. -- *PM Dictionary*: defines specific perf3gpp measurements sent by - vendor NFs (each of which is compliant with a referenced PM - Dictionary Schema). +- *PM Dictionary*: defines specific perf3gpp measurements sent by + vendor NFs (each of which is compliant with a referenced PM + Dictionary Schema). PM Dictionary Schema Keywords +++++++++++++++++++++++++++++++++++ @@ -967,57 +971,296 @@ The following is a list of standard PM Dictionary Schema Keywords: pmDictionaryHeader Keywords: -+------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------+-------------------+ -| **Keyword** | **Description** | **M / O** | **Example** | -+==================+=============================================================================================================================+=============+===================+ -| nfType | NF type to whom this PM Dictionary applies. nfType is vendor defined and should match the string used in eventName. | M | gnb | -+------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------+-------------------+ -| pmDefSchemaVsn | Version of the PM Dictionary Schema used for this PM Dictionary. Schema versions are specified in the VES Specifications. | M | 1.0 | -+------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------+-------------------+ -| pmDefVsn | Version of the PM Dictionary. Version is vendor defined. | M | 5G19\_1906\_002 | -+------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------+-------------------+ -| vendor | Vendor of the NF type to whom this PM Dictionary applies. | M | Nokia | -+------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------+-------------------+ ++---------------+------------------------------------+-------+---------------+ +| **Keyword** | **Description** |**M/O**|**Example** | ++===============+====================================+=======+===============+ +| nfType | NF type to whom this PM Dictionary |M |gnb | +| | applies. nfType is vendor | | | +| | defined and should match the string| | | +| | used in eventName. | | | ++---------------+------------------------------------+-------+---------------+ +| pmDefSchemaVsn| Version of the PM Dictionary Schema|M |1.0 | +| | used for this PM Dictionary. | | | +| | Schema versions are specified in | | | +| | the VES Specifications. | | | ++---------------+------------------------------------+-------+---------------+ +| pmDefVsn | Version of the PM Dictionary. |M |5G19\_1906\_002| +| | Version is vendor defined. | | | ++---------------+------------------------------------+-------+---------------+ +| vendor | Vendor of the NF type to whom this |M |Nokia | +| | PM Dictionary applies. | | | ++---------------+------------------------------------+-------+---------------+ pmDictionaryMeasurements Keywords: -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **Keyword** | **Description** | **M / O** | **Example** | -+========================+===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+=================+=======================================================================================================================================================================+ -| iMeasInfoId | Vendor defined integer identifier for measInfoId for efficiency in GPB. | O | 2024 | -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| iMeasType | Vendor defined integer identifier for measType for efficiency in GPB. | O | 2 | -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| measAdditionalFields | Hashmap of vendor specific PM Dictionary fields in key value pair format | O | measAggregationLevels | -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| measChangeType | For the measLastChange, indicates the type of change made for this measurement. Valid values are added, modified or deleted. Deleted measurements may be kept in the PM Dictionary for one release or more or permanently for historical purposes, if desired. | M | added | -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| measCollectionMethod | Collection Method for the measurement. 3GPP-defined collection methods are CC, SI, DER and Gauge. Collection Methods for 3GPP-defined 4G measurements are specified in 3GPP TS 32.425 item b). Collection Methods for 3GPP-defined 5G measurements are specified in 3GPP TS 28.552 item c). The measCollectionMethod values supported by a vendor are specified in the PM Dictionary YAML using the “value” attribute and may include vendor-defined collection methods not specified by 3GPP; for example Average. | M | SI | -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| measCondition | Text description of the condition that causes the measurement to be updated. Conditions for 3GPP-defined 4G measurements are specified in 3GPP TS 32.425 item c). Conditions for 3GPP-defined 5G measurements are specified in 3GPP TS 28.552 item c). Vendors are free to augment or modify the 3GPP-provided conditions to more accurately describe their measurements as needed. | M | This measurement is obtained by sampling at a pre-defined interval, the number of users in RRC connected mode for each NR cell and then taking the arithmetic mean. | -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| measDescription | Text description of the purpose of the measurement, what information does the measurement provide. Descriptions for 3GPP-defined 4G measurements are specified in 3GPP TS 32.425 item a). Descriptions for 3GPP-defined 5G measurements are specified in 3GPP TS 28.552 item a). Vendors are free to augment or modify the 3GPP-provided descriptions to more accurately describe their measurements as needed. | M | This measurement provides the mean number of users in RRC connected mode during each granularity period. | -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| measFamily | Abbreviation for a family of measurements, in 3GPP format where specified, else vendor defined. Family name abbreviations for 3GPP-defined 4G measurements are specified in 3GPP TS 32.425 Section 3.1. Family name abbreviations for 3GPP-defined 5G measurements are specified in 3GPP TS 28.552 Section 3.4. | O | RRC | -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| measInfoId | Name for a group of related measurements, in 3GPP format where specified, else vendor defined. Family names for 3GPP-defined 4G measurements are specified in 3GPP TS 32.425 Section 3.1. Family names for 3GPP-defined 5G measurements are specified in 3GPP TS 28.552 Section 3.4. | O | Radio Resource Control | -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| measLastChange | PM Dictionary version the last time this measurement was changed, added or deleted. | M | 5G18A\_1807\_003 | -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| measObjClass | Measurement Object Class. Object classes for 3GPP-defined 4G measurements are specified in 3GPP TS 32.425 item f). Object classes for 3GPP-defined 5G measurements are specified in 3GPP TS 28.552 item f). The measObjClass values supported by a vendor are specified in the PM Dictionary YAML using the “value” attribute and may include vendor-defined objects not specified by 3GPP; for example IPSEC. | M | NRCellCU | -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| measResultRange | Range for the measurement result. The range is specified as a comma separated list of discrete values or a range of values specified as minimum value-maximum value with no spaces. Result ranges for 3GPP-defined 4G measurements are specified in 3GPP TS 32.425 item d) if applicable. Result ranges for 3GPP-defined 5G measurements are specified in 3GPP TS 28.552 item d) if applicable. | O | | -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| measResultType | Data type of the measurement result. Result data types for 3GPP-defined 4G measurements are specified in 3GPP TS 32.425 item d). Result data types for 3GPP-defined 5G measurements are specified in 3GPP TS 28.552 item d). The measResultType values supported by a vendor are specified in the PM Dictionary YAML using the “value” attribute and may include vendor-defined data types not specified by 3GPP; for example boolean. | M | | -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| measResultUnits | Unit of measure for the result; e.g. milliseconds, bytes, kilobytes, packets, number. Unit of measure for 3GPP-defined 4G measurements are specified in 3GPP TS 32.425 item d) if applicable. Unit of measure for 3GPP-defined 5G measurements are specified in 3GPP TS 28.552 item d) if applicable. The measResultsUnits values supported by a vendor are specified in the PM Dictionary YAML using the “value” attribute and may include vendor-defined units of measure not specified by 3GPP; for example ethernet frames. | O | | -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| measType | Measurement name used in PM file, in 3GPP format where specified, else vendor defined. Names for 3GPP-defined 4G measurements are specified in 3GPP TS 32.425 item e). Names for 3GPP-defined 5G measurements are specified in 3GPP TS 28.552 item e). Vendor defined names are preceded with VS. | M | RRC.ConnMean | -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| sMeasInfoId | Vendor defined string identifier for measInfoId; could be the same as measInfoId or shortened version like measFamily for efficiency in GPB. | O | RRC | -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| sMeasType | Vendor defined string identifier for measType; could be the same as measType or it could be a shortened version for efficiency in GPB. | O | RRC.ConnMean | -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------+----------------------+--------+-----------------------+ +| **Keyword** | **Description** | **M/O**| **Example** | ++====================+======================+========+=======================+ +|iMeasInfoId |Vendor defined integer| O | 2024 | +| |identifier for | | | +| |measInfoId for | | | +| |efficiency in GPB. | | | ++--------------------+----------------------+--------+-----------------------+ +|iMeasType |Vendor defined integer| O | 2 | +| |identifier for | | | +| |measType for | | | +| |efficiency in GPB. | | | ++--------------------+----------------------+--------+-----------------------+ +|measAdditionalFields|Hashmap of vendor | 0 | measAggregationLevels | +| |specific PM Dictionary| | | +| |fields in key value | | | +| |pair format | | | ++--------------------+----------------------+--------+-----------------------+ +|measChangeType |For the measLastChange| M | added | +| |,indicates the type of| | | +| |change made for this | | | +| |measurement. Valid | | | +| |values are added, | | | +| |modified or deleted. | | | +| |Deleted measurements | | | +| |may be kept in the PM | | | +| |Dictionary for one | | | +| |release or more or | | | +| |permanently for | | | +| |historical purposes, | | | +| |if desired. | | | ++--------------------+----------------------+--------+-----------------------+ +|measCollectionMethod|Collection Method for |M | SI | +| |the measurement. | | | +| |3GPP-defined | | | +| |collection methods are| | | +| |CC, SI, DER and Gauge.| | | +| |Collection Methods for| | | +| |3GPP-defined 4G | | | +| |measurements are | | | +| |specified in 3GPP TS | | | +| |32.425 item b). | | | +| |Collection Methods for| | | +| |3GPP-defined 5G | | | +| |measurements are | | | +| |specified in 3GPP TS | | | +| |28.552 item c). The | | | +| |measCollectionMethod | | | +| |values supported by a | | | +| |vendor are specified | | | +| |in the PM Dictionary | | | +| |YAML using the “value”| | | +| |attribute and may | | | +| |include vendor-defined| | | +| |collection methods not| | | +| |specified by 3GPP; for| | | +| |example Average. | | | ++--------------------+----------------------+--------+-----------------------+ +|measCondition |Text description of | M | This measurement is | +| |the condition that | | obtained by sampling | +| |causes the measurement| | at a pre-defined | +| |to be updated. | | interval, the number | +| |Conditions for | | of users in RRC | +| |3GPP-defined 4G | | connected mode for | +| |measurements are | | each NR cell and then | +| |specified in 3GPP TS | | taking the arithmetic | +| |32.425 item c). | | mean. | +| |Conditions for | | | +| |3GPP-defined 5G | | | +| |measurements are | | | +| |specified in 3GPP TS | | | +| |28.552 item c). | | | +| |Vendors are free to | | | +| |augment or modify the | | | +| |3GPP-provided | | | +| |conditions to more | | | +| |accurately describe | | | +| |their measurements as | | | +| |needed. | | | ++--------------------+----------------------+--------+-----------------------+ +|measDescription |Text description of | M | This measurement | +| |the purpose of the | | provides the mean | +| |measurement, what | | number of users in RRC| +| |information does the | | connected mode during | +| |measurement provide. | | each granularity | +| |Descriptions for | | period. | +| |3GPP-defined 4G | | | +| |measurements are | | | +| |specified in 3GPP TS | | | +| |32.425 item a). | | | +| |Descriptions for | | | +| |3GPP-defined 5G | | | +| |measurements are | | | +| |specified in 3GPP TS | | | +| |28.552 item a). | | | +| |Vendors are free to | | | +| |augment or modify the | | | +| |3GPP-provided | | | +| |descriptions to more | | | +| |accurately describe | | | +| |their measurements as | | | +| |needed. | | | ++--------------------+----------------------+--------+-----------------------+ +|measFamily |Abbreviation for a | O | RRC | +| |family of measurements| | | +| |, in 3GPP format where| | | +| |specified, else vendor| | | +| |defined. Family name | | | +| |abbreviations for | | | +| |3GPP-defined 4G | | | +| |measurements are | | | +| |specified in 3GPP TS | | | +| |32.425 Section 3.1. | | | +| |Family name | | | +| |abbreviations for | | | +| |3GPP-defined 5G | | | +| |measurements are | | | +| |specified in 3GPP TS | | | +| |28.552 Section 3.4. | | | ++--------------------+----------------------+--------+-----------------------+ +|measInfoId |Name for a group of | O | Radio Resource Control| +| |related measurements, | | | +| |in 3GPP format where | | | +| |specified, else vendor| | | +| |defined. Family names | | | +| |for 3GPP-defined 4G | | | +| |measurements are | | | +| |specified in 3GPP TS | | | +| |32.425 Section 3.1. | | | +| |Family names for | | | +| |3GPP-defined 5G | | | +| |measurements are | | | +| |specified in 3GPP TS | | | +| |28.552 Section 3.4. | | | ++--------------------+----------------------+--------+-----------------------+ +|measLastChange |PM Dictionary version | M | 5G18A\_1807\_003 | +| |the last time this | | | +| |measurement was | | | +| |changed, added or | | | +| |deleted. | | | ++--------------------+----------------------+--------+-----------------------+ +|measObjClass |Measurement Object | M | NRCellCU | +| |Class. Object classes | | | +| |for 3GPP-defined 4G | | | +| |measurements are | | | +| |specified in 3GPP TS | | | +| |32.425 item f). Object| | | +| |classes for | | | +| |3GPP-defined 5G | | | +| |measurements are | | | +| |specified in 3GPP TS | | | +| |28.552 item f). The | | | +| |measObjClass values | | | +| |supported by a vendor | | | +| |are specified in the | | | +| |PM Dictionary YAML | | | +| |using the “value” | | | +| |attribute and may | | | +| |include vendor-defined| | | +| |objects not specified | | | +| |by 3GPP; for example | | | +| |IPSEC. | | | ++--------------------+----------------------+--------+-----------------------+ +|measResultRange |Range for the |O | | +| |measurement result. | | | +| |The range is specified| | | +| |as a comma separated | | | +| |list of discrete | | | +| |values or a range of | | | +| |values specified as | | | +| |minimum value-maximum | | | +| |value with no spaces. | | | +| |Result ranges for | | | +| |3GPP-defined 4G | | | +| |measurements are | | | +| |specified in 3GPP TS | | | +| |32.425 item d) if | | | +| |applicable. Result | | | +| |ranges for | | | +| |3GPP-defined 5G | | | +| |measurements are | | | +| |specified in 3GPP TS | | | +| |28.552 item d) if | | | +| |applicable. | | | ++--------------------+----------------------+--------+-----------------------+ +|measResultType |Data type of the | M | | +| |measurement result. | | | +| |Result data types for | | | +| |3GPP-defined 4G | | | +| |measurements are | | | +| |specified in 3GPP TS | | | +| |32.425 item d). Result| | | +| |data types for | | | +| |3GPP-defined 5G | | | +| |measurements are | | | +| |specified in 3GPP TS | | | +| |28.552 item d). The | | | +| |measResultType values | | | +| |supported by a vendor | | | +| |are specified in the | | | +| |PM Dictionary YAML | | | +| |using the “value” | | | +| |attribute and may | | | +| |include vendor-defined| | | +| |data types not | | | +| |specified by 3GPP; for| | | +| |example boolean. | | | ++--------------------+----------------------+--------+-----------------------+ +|measResultUnits |Unit of measure for | O | | +| |the result; e.g. | | | +| |milliseconds, bytes, | | | +| |kilobytes, packets, | | | +| |number. Unit of | | | +| |measure for | | | +| |3GPP-defined 4G | | | +| |measurements are | | | +| |specified in 3GPP TS | | | +| |32.425 item d) if | | | +| |applicable. Unit of | | | +| |measure for | | | +| |3GPP-defined 5G | | | +| |measurements are | | | +| |specified in 3GPP TS | | | +| |28.552 item d) if | | | +| |applicable. The | | | +| |measResultsUnits | | | +| |values supported by a | | | +| |vendor are specified | | | +| |in the PM Dictionary | | | +| |YAML using the “value”| | | +| |attribute and may | | | +| |include vendor-defined| | | +| |units of measure not | | | +| |specified by 3GPP; for| | | +| |example ethernet | | | +| |frames. | | | ++--------------------+----------------------+--------+-----------------------+ +|measType |Measurement name used | M | RRC.ConnMean | +| |in PM file, in 3GPP | | | +| |format where specified| | | +| |,else vendor defined. | | | +| |Names for 3GPP-defined| | | +| |4G measurements are | | | +| |specified in 3GPP TS | | | +| |32.425 item e). Names | | | +| |for 3GPP-defined 5G | | | +| |measurements are | | | +| |specified in 3GPP TS | | | +| |28.552 item e). Vendor| | | +| |defined names are | | | +| |preceded with VS. | | | ++--------------------+----------------------+--------+-----------------------+ +|sMeasInfoId |Vendor defined string | O | RRC | +| |identifier for | | | +| |measInfoId; could be | | | +| |the same as measInfoId| | | +| |or shortened version | | | +| |like measFamily for | | | +| |efficiency in GPB. | | | ++--------------------+----------------------+--------+-----------------------+ +|sMeasType |Vendor defined string | O | RRC.ConnMean | +| |identifier for | | | +| |measType; could be the| | | +| |same as measType or it| | | +| |could be a shortened | | | +| |version for efficiency| | | +| |in GPB. | | | ++--------------------+----------------------+--------+-----------------------+ PM Dictionary Schema Example ++++++++++++++++++++++++++++ @@ -1028,7 +1271,7 @@ The following is a sample PM Dictionary Schema: # PM Dictionary schema specifying and describing the meta information used to define perf3gpp measurements in the PM Dictionary -.. code-block:: text +.. code-block:: yaml pmDictionary: { presence: required, @@ -1145,7 +1388,6 @@ used to define perf3gpp measurements in the PM Dictionary } } -... PM Dictionary Example +++++++++++++++++++++ @@ -1165,8 +1407,9 @@ style yaml) pmDictionaryHeader: { nfType: gnb, pmDefSchemaVsn: 1.0, - pmDefVsn: 5G19\_1906\_002, - vendor: Nokia }, + pmDefVsn: 5G19_1906_002, + vendor: Nokia + }, pmDictionaryMeasurements: [ { iMeasInfoId: 2204, @@ -1177,12 +1420,13 @@ style yaml) measDescription: "This counter indicates the number of intra gNB intra frequency PSCell change attempts.", measFamily: NINFC, measInfoId: "NR Intra Frequency PSCell Change", - measLastChange: 5G18A\_1807\_003, + measLastChange: 5G18A_1807_003, measObjClass: NGCELL, measResultRange: 0..4096, measResultType: integer, measResultUnits: number, - measType: VS.NINFC.IntraFrPscelChAttempt}, + measType: VS.NINFC.IntraFrPscelChAttempt + }, { iMeasInfoId: 2204, iMeasType: 2, @@ -1192,12 +1436,13 @@ style yaml) measDescription: "This measurement the number of intra gNB intra frequency PSCell change failures due to TDCoverall timer expiry.", measFamily: NINFC, measInfoId: "NR Intra Frequency PSCell Change", - measLastChange: 5G18A\_1807\_003, + measLastChange: 5G18A_1807_003, measObjClass: NGCELL, measResultRange: 0..4096, measResultType: integer, measResultUnits: number, - measType: VS.NINFC.IntraFrPscelChFailTdcExp}, + measType: VS.NINFC.IntraFrPscelChFailTdcExp + }, { iMeasInfoId: 2204, iMeasType: 3, @@ -1207,20 +1452,20 @@ style yaml) measDescription: "This counter indicates the number of intra gNB intra frequency PSCell change failures due to MeNB refusal.", measFamily: NINFC, measInfoId: "NR Intra Frequency PSCell Change", - measLastChange: 5G19\_1906\_002, + measLastChange: 5G19_1906_002, measObjClass: NGCELL, measResultRange: 0..4096, measResultType: integer, measResultUnits: number, - measType: VS.NINFC.IntraFrPscelChFailMenbRef } + measType: VS.NINFC.IntraFrPscelChFailMenbRef + } ] } .. code-block:: yaml - # PM Dictionary perf3gpp measurements for the Nokia gnb NF (indented - style yaml) + # PM Dictionary perf3gpp measurements for the Nokia gnb NF (indented style yaml) pmDictionary: @@ -1230,7 +1475,7 @@ style yaml) pmDefSchemaVsn: 1.0 - pmDefVsn: 5G19\_1906\_002 + pmDefVsn: 5G19_1906_002 vendor: Nokia @@ -1256,7 +1501,7 @@ style yaml) measInfoId: "NR Intra Frequency PSCell Change" - measLastChange: 5G18A\_1807\_003 + measLastChange: 5G18A_1807_003 measObjClass: NGCELL @@ -1288,7 +1533,7 @@ style yaml) measInfoId: "NR Intra Frequency PSCell Change" - measLastChange: 5G18A\_1807\_003 + measLastChange: 5G18A_1807_003 measObjClass: NGCELL @@ -1320,7 +1565,7 @@ style yaml) measInfoId: "NR Intra Frequency PSCell Change" - measLastChange: 5G19\_1906\_002 + measLastChange: 5G19_1906_002 measObjClass: NGCELL @@ -1343,12 +1588,12 @@ event registration using the YAML Comment qualifier. The FM Meta Data section is optional. FM Meta Data includes Alarm Meta Data and Fault Meta Data: -- Alarm Meta Data, if provided, shall be placed in the YAML comments - qualifier at the top of the event registration for the alarm. +- Alarm Meta Data, if provided, shall be placed in the YAML comments + qualifier at the top of the event registration for the alarm. -- Fault Meta Data, if provided, shall be placed in the YAML comments - qualifier of faultFields.alarmAdditionalInformation within each - alarm. +- Fault Meta Data, if provided, shall be placed in the YAML comments + qualifier of faultFields.alarmAdditionalInformation within each + alarm. FM Meta Data keywords must be provided in ‘hash format’ as Keyword: Value. Values containing whitespace must be enclosed in single quotes. @@ -1362,31 +1607,68 @@ The following is a list of standard Alarm Meta Data Keywords. Note: the keywords are in CAPS so they can be easily found within the YAML comments. R / O refers to recommended / optional. -+---------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **Keyword** | **R / O** | **Description** | -+===========================+=============+===============================================================================================================================================================================================================================================================================================================================================================================================================================================+ -| ALARM ID | O | Gives a unique numerical Identifier for the alarm. | -+---------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| ALARM NAME | R | Gives a short, concise meaningful name of the alarm in camel format with no spaces, for example baseStationSynchronizationProblem. Note: Alarm Name meta data must match the name used in alarmCondition in the faultFields of the VES Fault Event to provide the cross reference between the Fault Event and its associated FM Meta Data. | -+---------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| ALARM DESCRIPTION | R | Provides a descriptive meaning of the alarm condition. This is intended to be read by an operator to give an idea of what happened. | -+---------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| ALARM EFFECT | R | Provides a description of the consequences when this alarm condition occurs. This is intended to be read by an operator to give a sense of the effects, consequences, and other impacted areas of the system. | -+---------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| ADDITIONAL TEXT | O | This field Contains further information on the alarm in free form text.See ITU-T Recommendation X.733 clause 8.1.2.13. | -+---------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| ASSOCIATED FAULTS | O | Indicates the associated faults that triggered this alarm. List of Fault IDs associated with the alarm which can be cross indexed against a vendor provided fault information. | -+---------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| CLEARING TYPE | R | Indicates whether the alarm is automatically or manually cleared. Valid values are Automatic or Manual. | -+---------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| EVENT TYPE | O | Indicates the type of alarm. Event Types are found in 3GPP TS 32.111 Annex A. The types are: Communications Alarm, Processing Error Alarm, Environmental Alarm, Quality of Service Alarm, Equipment Alarm, Integrity Violation, Operational Violation, Physical Violation, Security Service or Mechanism Violation, or Time Domain Violation. Note that eventCategory in the faultFields of the VES Fault Event may contain the event type. | -+---------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| MANAGED OBJECT CLASSES | R | Indicates the list of possible managed object classes (MOCs) associated with this alarm. Note that *eventSourceType* in the *faultFields* of the VES Fault Event contains the specific MOC against which the particular alarm occurrence was raised. | -+---------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| PROBABLE CAUSE | O | Provides the probable cause qualifier for the alarm. Probable causes are found in 3GPP TS 32.111 Annex B, drawn from ITU-T M.3100 and from ITU-T Recommendation X.721, X.733, and X.736. | -+---------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| PROPOSED REPAIR ACTIONS | R | Indicates proposed repair actions. May be used to provide recovery instructions to the operator in free form text. | -+---------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------+---------+-----------------------------------------------------+ +| **Keyword**| **R/O** | **Description** | ++============+=========+=====================================================+ +| ALARM | O | Gives a unique numerical Identifier for the alarm. | +| ID | | | ++------------+---------+-----------------------------------------------------+ +| ALARM | R | Gives a short, concise meaningful name of the alarm | +| NAME | | in camel format with no spaces, for example | +| | | baseStationSynchronizationProblem. Note: Alarm Name | +| | | meta data must match the name used in alarmCondition| +| | | in the faultFields of the VES Fault Event to provide| +| | | the cross reference between the Fault Event and its | +| | | associated FM Meta Data. | ++------------+---------+-----------------------------------------------------+ +| ALARM | R | Provides a descriptive meaning of the alarm | +| DESCRIPTION| | condition. This is intended to be read by an | +| | | operator to give an idea of what happened. | ++------------+---------+-----------------------------------------------------+ +| ALARM | R | Provides a description of the consequences when this| +| EFFECT | | alarm condition occurs. This is intended to be read | +| | | by an operator to give a sense of the effects, | +| | | consequences, and other impacted areas of the | +| | | system. | ++------------+---------+-----------------------------------------------------+ +| ADDITIONAL | O | This field Contains further information on the alarm| +| TEXT | | in free form text.See ITU-T Recommendation X.733 | +| | | clause 8.1.2.13. | ++------------+---------+-----------------------------------------------------+ +| ASSOCIATED | O | Indicates the associated faults that triggered this | +| FAULTS | | alarm. List of Fault IDs associated with the alarm | +| | | which can be cross indexed against a vendor provided| +| | | fault information. | ++------------+---------+-----------------------------------------------------+ +| CLEARING | R | Indicates whether the alarm is automatically or | +| TYPE | | manually cleared. Valid values are Automatic or | +| | | Manual. | ++------------+---------+-----------------------------------------------------+ +| EVENT | O | Indicates the type of alarm. Event Types are found | +| TYPE | | in 3GPP TS 32.111 Annex A. The types are: | +| | | Communications Alarm, Processing Error Alarm, | +| | | Environmental Alarm, Quality of Service Alarm, | +| | | Equipment Alarm, Integrity Violation, Operational | +| | | Violation, Physical Violation, Security Service or | +| | | Mechanism Violation, or Time Domain Violation. Note | +| | | that eventCategory in the faultFields of the VES | +| | | Fault Event may contain the event type. | ++------------+---------+-----------------------------------------------------+ +| MANAGED | R | Indicates the list of possible managed object | +| OBJECT | | classes (MOCs) associated with this alarm. Note that| +| CLASSES | | *eventSourceType* in the *faultFields* of the VES | +| | | Fault Event contains the specific MOC against which | +| | | the particular alarm occurrence was raised. | ++------------+---------+-----------------------------------------------------+ +| PROBABLE | O | Provides the probable cause qualifier for the alarm.| +| CAUSE | | Probable causes are found in 3GPP TS 32.111 Annex B,| +| | | drawn from ITU-T M.3100 and from ITU-T | +| | | Recommendation X.721, X.733, and X.736. | ++------------+---------+-----------------------------------------------------+ +| PROPOSED | R | Indicates proposed repair actions. May be used to | +| REPAIR | | provide recovery instructions to the operator in | +| ACTIONS | | free form text. | ++------------+---------+-----------------------------------------------------+ Fault Meta Data Keywords +++++++++++++++++++++++++ @@ -1395,21 +1677,33 @@ The following is a list of standard Fault Meta Data Keywords. Note: the keywords are in CAPS so they can be easily found within the YAML comments. R / O refers to recommended / optional. -+---------------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **Keyword** | **R / O** | **Description** | -+===========================+=============+=======================================================================================================================================================================================================+ -| FAULT ID | O | Gives a unique numerical Identifier for the fault. | -+---------------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| FAULT NAME | O | Gives a short name for the fault. | -+---------------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| FAULT DESCRIPTION | O | Provides a descriptive meaning of the fault condition. This is intended to be read by an operator to give an idea of what happened. | -+---------------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| FAULT EFFECT | O | Provides a description of the consequences when this fault occurs. This is intended to be read by an operator to give a sense of the effects, consequences, and other impacted areas of the system. | -+---------------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| PROPOSED REPAIR ACTIONS | O | Indicates proposed repair actions. May be used to provide recovery instructions to the operator in free form text.. | -+---------------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| ADDITIONAL TEXT | O | Contains further information on the fault in free form text. See ITU-T Recommendation X.733 clause 8.1.2.13. | -+---------------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------+---------+------------------------------------------+ +| **Keyword** | **R/O** | **Description** | ++========================+=========+==========================================+ +| FAULT ID | O | Gives a unique numerical Identifier for | +| | | the fault. | ++------------------------+---------+------------------------------------------+ +| FAULT NAME | O | Gives a short name for the fault. | ++------------------------+---------+------------------------------------------+ +| FAULT DESCRIPTION | O | Provides a descriptive meaning of the | +| | | fault condition. This is intended to be | +| | | read by an operator to give an idea of | +| | | what happened. | ++------------------------+---------+------------------------------------------+ +| FAULT EFFECT | O | Provides a description of the | +| | | consequences when this fault occurs. This| +| | | is intended to be read by an operator to | +| | | give a sense of the effects, consequences| +| | | , and other impacted areas of the system.| ++------------------------+---------+------------------------------------------+ +| PROPOSED REPAIR ACTIONS| O | Indicates proposed repair actions. May be| +| | | used to provide recovery instructions to | +| | | the operator in free form text. | ++------------------------+---------+------------------------------------------+ +| ADDITIONAL TEXT | O | Contains further information on the fault| +| | | in free form text. See ITU-T | +| | | Recommendation X.733 clause 8.1.2.13. | ++------------------------+---------+------------------------------------------+ FM Meta Data Example +++++++++++++++++++++ @@ -1418,190 +1712,109 @@ The following is a snippet of a fault event registration showing use of the FM Meta Data keywords. Note: it is recommended the information be conveyed in a human readable form similar to the example below: -.. code-block:: text +.. code-block:: yaml event: { - presence: required, - - action: {any, any, baseStationSynchronizationProblem, - RECO-ContactNokiaTechnicalSupport}, - + action: {any, any, baseStationSynchronizationProblem,RECO-ContactNokiaTechnicalSupport}, comment: " - ALARM NAME: baseStationSynchronizationProblem, - ALARM ID: 7108, - ALARM DESCRIPTION: 'A fault has occurred in the base station - synchronization. For example: the base station reference clock signal is - lost or is unstable or inaccurate.', - + synchronization. For example: the base station reference clock signal is + lost or is unstable or inaccurate.', ALARM EFFECT: 'The effect of the fault on the functioning of the network element depends on the fault id raised. See FAULT EFFECT below.', - MANAGED OBJECT CLASSES: NRBTS, - EVENT TYPE: 'Equipment Alarm', - PROBABLE CAUSE: 'Timing Problem', - PROPOSED REPAIR ACTIONS: 'See PROPOSED REPAIR ACTIONS for the underlying fault under alarmAdditionalInformation.', - ASSOCIATED FAULTS: 9, 1818, - CLEARING TYPE: Automatic - ", - - structure: { - - commonEventHeader: {presence: required, structure: { - - version: {presence: required, value: 3.0}, - - domain: {presence: required, value: fault}, - - eventName: {presence: required, value: - Fault\_gnb-Nokia\_baseStationSynchronizationProblem}, - - eventId: {presence: required}, - - sourceName: {presence: required}, - - reportingEntityName: {presence: required}, - - priority: {presence: required}, - - startEpochMicrosec: {presence: required}, - - lastEpochMicrosec: {presence: required}, - - timeZoneOffset: {presence: required}, - - sequence: {presence: required} - - }}, - - faultFields: {presence: required, structure: { - - faultFieldsVersion: {presence: required, value: 3.0}, - - eventCategory: {presence: optional, comment: "Equipment Alarm"}, - - alarmCondition: {presence: required, value: 'baseStationSynchronizationProblem'}, - - eventSourceType: {presence: required}, - - alarminterfaceA: {presence: required}, - - specificProblem: {presence: required}, - - eventSeverity: {presence: required, value: [MINOR, NORMAL]}, - - nfStatus: {default: Active}, - - alarmAdditionalInformation: {presence: required, array: [ - - keyValuePair: { - - presence: required, - - structure: { - - key: {presence: required, value: faultId}, - - value: {presence: required} - - }, - - comment: " - - FAULT ID: 9, - - FAULT NAME: 'BTS time not corrected', - - FAULT DESCRIPTION: 'The reference frequency that the BTS master clock - receives has changed by about 200 ppb or more (which equals the change - magnitude of 204 DAC steps or more (with 12bit DAC)) during the - measurement period, compared to the BTS master clock frequency. - - Causes can be: - - 1. The reference frequency ….. - - 2. The reference frequency fluctuates …', - - FAULT EFFECT: 'This fault does not immediately affect the operations of the BTS, but it is a notification …', - - PROPOSED REPAIR ACTION: 'access the ….follow the instructions below: - - 1. In case of a fault in the transmission network synchronization, … - - 2. If the basic accuracy of the signal used for synch is correct… - - 3. In case of a BTS equipment fault, the location might be: - - 4. After the fault situation has been cleared, ….', - - FAULT ID: 1818, - - FAULT NAME: 'BTS master clock tuning failure', - - FAULT DESCRIPTON: 'Master clock frequency is tuned to within 5% of its - minimum or maximum tuning limit.', - - FAULT EFFECT: 'The BTS can operate properly for months …' - - Effects in Frequency Synchronization mode: … - - Effects in Phase Synchronization mode: ….', - - PROPOSED REPAIR ACTION: 'Perform the steps below in the listed order - until the fault disappears. - - Not tracking satellites: - - 1. The most common reason …. - - 2. There might be a malfunction in the GPS receiver. Perform a (remote)power reset for the GPS receiver. - - 3. There might be a HW fault in the GPS receiver. Check the operation - and change the GPS module, if needed.' - - " - - }, - - keyValuePair: { - - presence: required, - - structure: { - - key: {presence: required, value: alarmId}, - - value: {presence: required} - - }}, - - keyValuePair: { - - presence: required, - - structure: { - - key: {presence: required, value: 'application additional information fields'}, - - value: {presence: optional} - - }} - - ]} - - }} - - } - + structure: { + commonEventHeader: { + presence: required, structure: { + version: {presence: required, value: 3.0}, + domain: {presence: required, value: fault}, + eventName: {presence: required, value: Fault_gnb-Nokia_baseStationSynchronizationProblem}, + eventId: {presence: required}, + sourceName: {presence: required}, + reportingEntityName: {presence: required}, + priority: {presence: required}, + startEpochMicrosec: {presence: required}, + lastEpochMicrosec: {presence: required}, + timeZoneOffset: {presence: required}, + sequence: {presence: required} + } + }, + faultFields: { + presence: required, structure: { + faultFieldsVersion: {presence: required, value: 3.0}, + eventCategory: {presence: optional, comment: "Equipment Alarm"}, + alarmCondition: {presence: required, value: 'baseStationSynchronizationProblem'}, + eventSourceType: {presence: required}, + alarminterfaceA: {presence: required}, + specificProblem: {presence: required}, + eventSeverity: {presence: required, value: [MINOR, NORMAL]}, + nfStatus: {default: Active}, + alarmAdditionalInformation: { + presence: required, array: [ + keyValuePair: { + presence: required, + structure: { + key: {presence: required, value: faultId}, + value: {presence: required} + }, + comment: " + FAULT ID: 9, + FAULT NAME: 'BTS time not corrected', + FAULT DESCRIPTION: 'The reference frequency that the BTS master clock + receives has changed by about 200 ppb or more (which equals the change + magnitude of 204 DAC steps or more (with 12bit DAC)) during the + measurement period, compared to the BTS master clock frequency. + Causes can be: + 1. The reference frequency ….. + 2. The reference frequency fluctuates …', + FAULT EFFECT: 'This fault does not immediately affect the operations of the BTS, but it is a notification …', + PROPOSED REPAIR ACTION: 'access the ….follow the instructions below: + 1. In case of a fault in the transmission network synchronization, … + 2. If the basic accuracy of the signal used for synch is correct… + 3. In case of a BTS equipment fault, the location might be: + 4. After the fault situation has been cleared, ….', + FAULT ID: 1818, + FAULT NAME: 'BTS master clock tuning failure', + FAULT DESCRIPTON: 'Master clock frequency is tuned to within 5% of its + minimum or maximum tuning limit.', + FAULT EFFECT: 'The BTS can operate properly for months …' + Effects in Frequency Synchronization mode: … + Effects in Phase Synchronization mode: ….', + PROPOSED REPAIR ACTION: 'Perform the steps below in the listed order until the fault disappears. + Not tracking satellites: + 1. The most common reason …. + 2. There might be a malfunction in the GPS receiver. Perform a (remote)power reset for the GPS receiver. + 3. There might be a HW fault in the GPS receiver. Check the operation + and change the GPS module, if needed.' + " + }, + keyValuePair: { + presence: required, + structure: { + key: {presence: required, value: alarmId}, + value: {presence: required} + } + }, + keyValuePair: { + presence: required, + structure: { + key: {presence: required, value: 'application additional information fields'}, + value: {presence: optional} + } + } + ] + } + } + } + } } YAML Examples @@ -1618,210 +1831,129 @@ Fault .. code-block:: yaml - # registration for Fault\_vMrf\_alarm003 - - # Constants: the values of domain, eventName, priority, vfstatus - - # , version, alarmCondition, eventSeverity, eventSourceType, - + # registration for Fault_vMrf_alarm003 + # Constants: the values of domain, eventName, priority, vfstatus, + # version, alarmCondition, eventSeverity, eventSourceType, # faultFieldsVersion, specificProblem, - - # Variables (to be supplied at runtime) include: eventId, - lastEpochMicrosec, - - # reportingEntityId, reportingEntityName, sequence, sourceId, - sourceName, - + # Variables (to be supplied at runtime) include: eventId, lastEpochMicrosec, + # reportingEntityId, reportingEntityName, sequence, sourceId,sourceName, # startEpochMicrosec - - event: {presence: required, action: [ any, any, alarm003, - RECO-rebuildVnf ], - - structure: { - - commonEventHeader: {presence: required, structure: { - - domain: {presence: required, value: fault}, - - eventName: {presence: required, value: Fault\_vMrf\_alarm003}, - - eventId: {presence: required}, - - nfNamingCode: {value: mrfx}, - - priority: {presence: required, value: Medium}, - - reportingEntityId: {presence: required}, - - reportingEntityName: {presence: required}, - - sequence: {presence: required}, - - sourceId: {presence: required}, - - sourceName: {presence: required}, - - startEpochMicrosec: {presence: required}, - - lastEpochMicrosec: {presence: required}, - - version: {presence: required, value: 3.0} - - }}, - - faultFields: {presence: required, structure: { - - alarmCondition: {presence: required, value: alarm003}, - - eventSeverity: {presence: required, value: MAJOR}, - - eventSourceType: {presence: required, value: virtualNetworkFunction}, - - faultFieldsVersion: {presence: required, value: 2.0}, - - specificProblem: {presence: required, value: "Configuration file was - corrupt or - - not present"}, - - vfStatus: {presence: required, value: "Requesting Termination"} - - }} - - }} - + event: { + presence: required, action: [ any, any, alarm003, RECO-rebuildVnf ], + structure: { + commonEventHeader: { + presence: required, structure: { + domain: {presence: required, value: fault}, + eventName: {presence: required, value: Fault_vMrf_alarm003}, + eventId: {presence: required}, + nfNamingCode: {value: mrfx}, + priority: {presence: required, value: Medium}, + reportingEntityId: {presence: required}, + reportingEntityName: {presence: required}, + sequence: {presence: required}, + sourceId: {presence: required}, + sourceName: {presence: required}, + startEpochMicrosec: {presence: required}, + lastEpochMicrosec: {presence: required}, + version: {presence: required, value: 3.0} + } + }, + faultFields: { + presence: required, structure: { + alarmCondition: {presence: required, value: alarm003}, + eventSeverity: {presence: required, value: MAJOR}, + eventSourceType: {presence: required, value: virtualNetworkFunction}, + faultFieldsVersion: {presence: required, value: 2.0}, + specificProblem: {presence: required, value: "Configuration file was corrupt or not present"}, + vfStatus: {presence: required, value: "Requesting Termination"} + } + } + } + } .. code-block:: yaml - # registration for clearing Fault\_vMrf\_alarm003Cleared + # registration for clearing Fault_vMrf_alarm003Cleared # Constants: the values of domain, eventName, priority, - # , version, alarmCondition, eventSeverity, eventSourceType, - # faultFieldsVersion, specificProblem, - - # Variables (to be supplied at runtime) include: eventId, - lastEpochMicrosec, - + # Variables (to be supplied at runtime) include: eventId, lastEpochMicrosec, # reportingEntityId, reportingEntityName, sequence, sourceId, - # sourceName, startEpochMicrosec, vfStatus - event: {presence: required, action: [ any, any, alarm003, Clear ], - structure: { - - commonEventHeader: {presence: required, structure: { - - domain: {presence: required, value: fault}, - - eventName: {presence: required, value: Fault\_vMrf\_alarm003Cleared}, - - eventId: {presence: required}, - - nfNamingCode: {value: mrfx}, - - priority: {presence: required, value: Medium}, - - reportingEntityId: {presence: required}, - - reportingEntityName: {presence: required}, - - sequence: {presence: required}, - - sourceId: {presence: required}, - - sourceName: {presence: required}, - - startEpochMicrosec: {presence: required}, - - lastEpochMicrosec: {presence: required}, - - version: {presence: required, value: 3.0} - - }}, - - faultFields: {presence: required, structure: { - - alarmCondition: {presence: required, value: alarm003}, - - eventSeverity: {presence: required, value: NORMAL}, - - eventSourceType: {presence: required, value: virtualNetworkFunction}, - - faultFieldsVersion: {presence: required, value: 2.0}, - - specificProblem: {presence: required, value: "Valid configuration file - found"}, - - vfStatus: {presence: required, value: "Requesting Termination"} - - }} - - }} + event: { + presence: required, action: [ any, any, alarm003, Clear ], structure: { + commonEventHeader: { + presence: required, structure: { + domain: {presence: required, value: fault}, + eventName: {presence: required, value: Fault_vMrf_alarm003Cleared}, + eventId: {presence: required}, + nfNamingCode: {value: mrfx}, + priority: {presence: required, value: Medium}, + reportingEntityId: {presence: required}, + reportingEntityName: {presence: required}, + sequence: {presence: required}, + sourceId: {presence: required}, + sourceName: {presence: required}, + startEpochMicrosec: {presence: required}, + lastEpochMicrosec: {presence: required}, + version: {presence: required, value: 3.0} + } + }, + faultFields: { + presence: required, structure: { + alarmCondition: {presence: required, value: alarm003}, + eventSeverity: {presence: required, value: NORMAL}, + eventSourceType: {presence: required, value: virtualNetworkFunction}, + faultFieldsVersion: {presence: required, value: 2.0}, + specificProblem: {presence: required, value: "Valid configuration file found"}, + vfStatus: {presence: required, value: "Requesting Termination"} + } + } + } + } Heartbeat ~~~~~~~~~~ .. code-block:: yaml - # registration for Heartbeat\_vMRF + # registration for Heartbeat_vMRF # Constants: the values of domain, eventName, priority, version - - # Variables (to be supplied at runtime) include: eventId, - lastEpochMicrosec, - - # reportingEntityId, reportingEntityName, sequence, sourceId, - sourceName, - + # Variables (to be supplied at runtime) include: eventId, lastEpochMicrosec, + # reportingEntityId, reportingEntityName, sequence, sourceId, sourceName, # startEpochMicrosec - event: {presence: required, heartbeatAction: [3, vnfDown, - RECO-rebuildVnf], - - structure: { - - commonEventHeader: {presence: required, structure: { - - domain: {presence: required, value: heartbeat}, - - eventName: {presence: required, value: Heartbeat\_vMrf}, - - eventId: {presence: required}, - - nfNamingCode: {value: mrfx}, - - priority: {presence: required, value: Normal}, - - reportingEntityId: {presence: required}, - - reportingEntityName: {presence: required}, - - sequence: {presence: required}, - - sourceId: {presence: required}, - - sourceName: {presence: required}, - - startEpochMicrosec: {presence: required}, - - lastEpochMicrosec: {presence: required}, - - version: {presence: required, value: 3.0} - - }}, - - heartbeatFields: {presence: optional, structure:{ - + event: { + presence: required, heartbeatAction: [3, vnfDown, RECO-rebuildVnf], + structure: { + commonEventHeader: { + presence: required, structure: { + domain: {presence: required, value: heartbeat}, + eventName: {presence: required, value: Heartbeat_vMrf}, + eventId: {presence: required}, + nfNamingCode: {value: mrfx}, + priority: {presence: required, value: Normal}, + reportingEntityId: {presence: required}, + reportingEntityName: {presence: required}, + sequence: {presence: required}, + sourceId: {presence: required}, + sourceName: {presence: required}, + startEpochMicrosec: {presence: required}, + lastEpochMicrosec: {presence: required}, + version: {presence: required, value: 3.0} + } + }, + heartbeatFields: { + presence: optional, structure:{ heartbeatFieldsVersion: {presence: required, value: 1.0}, - - heartbeatInterval: {presence: required, range: [ 15, 300 ], - default: 60 } - - }} - - }} + heartbeatInterval: {presence: required, range: [ 15, 300 ], default: 60 } + } + } + } + } Measurements @@ -1829,539 +1961,442 @@ Measurements .. code-block:: yaml - # registration for Mfvs\_vMRF - + # registration for Mfvs_vMRF # Constants: the values of domain, eventName, priority, version, - - # measurementFieldsVersion, - additionalMeasurements.namedArrayOfFields.name, - - # Variables (to be supplied at runtime) include: eventId, - reportingEntityName, sequence, - + # measurementFieldsVersion, additionalMeasurements.namedArrayOfFields.name, + # Variables (to be supplied at runtime) include: eventId, reportingEntityName, sequence, # sourceName, start/lastEpochMicrosec, measurementInterval, - # concurrentSessions, requestRate, numberOfMediaPortsInUse, - # cpuUsageArray.cpuUsage,cpuUsage.cpuIdentifier, cpuUsage.percentUsage, - # additionalMeasurements.namedArrayOfFields.arrayOfFields, - # vNicPerformance.receivedOctetsAccumulated, - # vNicPerformance.transmittedOctetsAccumulated, - # vNicPerformance.receivedTotalPacketsAccumulated, - # vNicPerformance.transmittedTotalPacketsAccumulated, - # vNicPerformance.vNicIdentifier, vNicPerformance.receivedOctetsDelta, - # vNicPerformance.receivedTotalPacketsDelta, - # vNicPerformance.transmittedOctetsDelta, - # vNicPerformance.transmittedTotalPacketsDelta, - # vNicPerformance.valuesAreSuspect, memoryUsageArray.memoryUsage, - # memoryUsage.memoryConfigured, memoryUsage.vmIdentifier, - # memoryUsage.memoryUsed, memoryUsage.memoryFree - event: {presence: required, structure: { - - commonEventHeader: {presence: required, structure: { - - domain: {presence: required, value: measurementsForVfScaling}, - - eventName: {presence: required, value: Mfvs\_vMrf}, - - eventId: {presence: required}, - - nfNamingCode: {value: mrfx}, - - priority: {presence: required, value: Normal}, - - reportingEntityId: {presence: required}, - - reportingEntityName: {presence: required}, - - sequence: {presence: required}, - - sourceId: {presence: required}, - - sourceName: {presence: required}, - - startEpochMicrosec: {presence: required}, - - lastEpochMicrosec: {presence: required}, - - version: {presence: required, value: 3.0} - - }}, - - measurementsForVfScalingFields: {presence: required, structure: { - - measurementFieldsVersion: {presence: required, value: 2.0}, - - measurementInterval: {presence: required, range: [ 60, 3600 ], default: - 300}, - - concurrentSessions: {presence: required, range: [ 0, 100000 ]}, - - requestRate: {presence: required, range: [ 0, 100000 ]}, - - numberOfMediaPortsInUse: {presence: required, range: [ 0, 100000 ]}, - - cpuUsageArray: {presence: required, array: [ - - cpuUsage: {presence: required, structure: { - - cpuIdentifier: {presence: required}, - - percentUsage: {presence: required, range: [ 0, 100 ], - - action: [80, up, CpuUsageHigh, RECO-scaleOut], - - action: [10, down, CpuUsageLow, RECO-scaleIn]} - - }} - - ]}, - - memoryUsageArray: {presence: required, array: [ - - memoryUsage: {presence: required, structure: { - - memoryConfigured: {presence: required, value: 33554432}, - - memoryFree: {presence: required, range: [ 0, 33554432 ], - - action: [100, down, FreeMemLow, RECO-scaleOut], - - action: [30198989, up, FreeMemHigh, RECO-scaleIn]}, - - memoryUsed: {presence: required, range: [ 0, 33554432 ]}, - - vmIdentifier: {presence: required} - - }} - - ]}, - - additionalMeasurements: {presence: required, array: [ - - namedArrayOfFields: {presence: required, structure: { - - name: {presence: required, value: licenseUsage}, - - arrayOfFields: {presence: required, array: [ - - field: {presence: required, structure: { - - name: {presence: required, value: G711AudioPort}, - - value: {presence: required, range: [ 0, 100000 ], - - units: numberOfPorts } - - }}, - - field: {presence: required, structure: { - - name: {presence: required, value: G729AudioPort}, - - value: {presence: required, range: [ 0, 100000 ], - - units: numberOfPorts } - - }}, - - field: {presence: required, structure: { - - name: {presence: required, value: G722AudioPort}, - - value: {presence: required, range: [ 0, 100000 ], - - units: numberOfPorts } - - }}, - - field: {presence: required, structure: { - - name: {presence: required, value: AMRAudioPort}, - - value: {presence: required, range: [ 0, 100000 ], - - units: numberOfPorts } - - }}, - - field: {presence: required, structure: { - - name: {presence: required, value: AMRWBAudioPort}, - - value: {presence: required, range: [ 0, 100000 ], - - units: numberOfPorts } - - }}, - - field: {presence: required, structure: { - - name: {presence: required, value: OpusAudioPort}, - - value: {presence: required, range: [ 0, 100000 ], - - units: numberOfPorts } - - }}, - - field: {presence: required, structure: { - - name: {presence: required, value: H263VideoPort}, - - value: {presence: required, range: [ 0, 100000 ], - - units: numberOfPorts } - - }}, - - field: {presence: required, structure: { - - name: {presence: required, value: H264NonHCVideoPort}, - - value: {presence: required, range: [ 0, 100000 ], - - units: numberOfPorts } - - }}, - - field: {presence: required, structure: { - - name: {presence: required, value: H264HCVideoPort}, - - value: {presence: required, range: [ 0, 100000 ], - - units: numberOfPorts } - - }}, - - field: {presence: required, structure: { - - name: {presence: required, value: MPEG4VideoPort}, - - value: {presence: required, range: [ 0, 100000 ], - - units: numberOfPorts } - - }}, - - field: {presence: required, structure: { - - name: {presence: required, value: VP8NonHCVideoPort}, - - value: {presence: required, range: [ 0, 100000 ], - - units: numberOfPorts } - - }}, - - field: {presence: required, structure: { - - name: {presence: required, value: VP8HCVideoPort}, - - value: {presence: required, range: [ 0, 100000 ], - - units: numberOfPorts } - - }}, - - field: {presence: required, structure: { - - name: {presence: required, value: PLC}, - - value: {presence: required, range: [ 0, 100000 ], - - units: numberOfPorts } - - }}, - - field: {presence: required, structure: { - - name: {presence: required, value: AEC}, - - value: {presence: required, range: [ 0, 100000 ], - - units: numberOfPorts } - - }}, - - field: {presence: required, structure: { - - name: {presence: required, value: NR}, - - value: {presence: required, range: [ 0, 100000 ], - - units: numberOfPorts } - - }}, - - field: {presence: required, structure: { - - name: {presence: required, value: NG}, - - value: {presence: required, range: [ 0, 100000 ], - - units: numberOfPorts } - - }}, - - field: {presence: required, structure: { - - name: {presence: required, value: NLD}, - - value: {presence: required, range: [ 0, 100000 ], - - units: numberOfPorts } - - }}, - - field: {presence: required, structure: { - - name: {presence: required, value: G711FaxPort}, - - value: {presence: required, range: [ 0, 100000 ], - - units: numberOfPorts } - - }}, - - field: {presence: required, structure: { - - name: {presence: required, value: T38FaxPort}, - - value: {presence: required, range: [ 0, 100000 ], - - units: numberOfPorts } - - }}, - - field: {presence: required, structure: { - - name: {presence: required, value: RFactor}, - - value: {presence: required, range: [ 0, 100000 ], - - units: numberOfPorts } - - }}, - - field: {presence: required, structure: { - - name: {presence: required, value: T140TextPort}, - - value: {presence: required, range: [ 0, 100000 ], - - units: numberOfPorts } - - }}, - - field: {presence: required, structure: { - - name: {presence: required, value: EVSAudioPort}, - - value: {presence: required, range: [ 0, 100000 ], - - units: numberOfPorts } - - }} - - ]} - - }}, - - namedArrayOfFields: {presence: required, structure: { - - name: {presence: required, value: mediaCoreUtilization}, - - arrayOfFields: {presence: required, array: [ - - field: {presence: required, structure: { - - name: {presence: required, value: actualAvgAudio}, - - value: {presence: required, range: [ 0, 255 ], - - action: [80, up, AudioCoreUsageHigh, RECO-scaleOut], - - action: [10, down, AudioCoreUsageLow, RECO-scaleIn]} - - }}, - - field: {presence: required, structure: { - - name: {presence: required, value: modelAvgAudio}, - - value: {presence: required, range: [ 0, 100 ], - - action: [80, up, AudioCoreUsageHigh, RECO-scaleOut], - - action: [10, down, AudioCoreUsageLow, RECO-scaleIn]} - - }}, - - field: {presence: required, structure: { - - name: {presence: required, value: actualMaxAudio}, - - value: {presence: required, range: [ 0, 255 ]} - - }}, - - field: {presence: required, structure: { - - name: {presence: required, value: modelMaxAudio}, - - value: {presence: required, range: [ 0, 100 ]} - - }}, - - field: {presence: required, structure: { - - name: {presence: required, value: actualAvgVideo}, - - value: {presence: required, range: [ 0, 255 ], - - action: [80, up, VideoCoreUsageHigh, RECO-scaleOut], - - action: [10, down, VideoCoreUsageLow, RECO-scaleIn]} - - }}, - - field: {presence: required, structure: { - - name: {presence: required, value: modelAvgVideo}, - - value: {presence: required, range: [ 0, 100 ], - - action: [80, up, VideoCoreUsageHigh, RECO-scaleOut], - - action: [10, down, VideoCoreUsageLow, RECO-scaleIn]} - - }}, - - field: {presence: required, structure: { - - name: {presence: required, value: actualMaxVideo}, - - value: {presence: required, range: [ 0, 255 ]} - - }}, - - field: {presence: required, structure: { - - name: {presence: required, value: modelMaxVideo}, - - value: {presence: required, range: [ 0, 100 ]} - - }}, - - field: {presence: required, structure: { - - name: {presence: required, value: actualAvgHcVideo}, - - value: {presence: required, range: [ 0, 255 ], - - action: [80, up, HcVideoCoreUsageHigh, RECO-scaleOut], - - action: [10, down, HcVideoCoreUsageLow, RECO-scaleIn]} - - }}, - - field: {presence: required, structure: { - - name: {presence: required, value: modelAvgHcVideo}, - - value: {presence: required, range: [ 0, 100 ], - - action: [80, up, HcVideoCoreUsageHigh, RECO-scaleOut], - - action: [10, down, HcVideoCoreUsageLow, RECO-scaleIn]} - - }}, - - field: {presence: required, structure: { - - name: {presence: required, value: actualMaxHcVideo}, - - value: {presence: required, range: [ 0, 255 ]} - - }}, - - field: {presence: required, structure: { - - name: {presence: required, value: modelMaxHcVideo}, - - value: {presence: required, range: [ 0, 100 ]} - - }} - - ]} - - }} - - ]}, - - vNicPerformanceArray: {presence: required, array: [ - - vNicPerformance: {presence: required, structure: { - - receivedOctetsAccumulated: {presence: required, - - range: [ 0, 18446744073709551615 ]}, - - receivedTotalPacketsAccumulated: {presence: required, - - range: [ 0, 18446744073709551615 ]}, - - receivedOctetsDelta: {presence: required}, - - range: [ 0, 18446744073709551615 ], - - receivedTotalPacketsDelta: {presence: required, - - range: [ 0, 18446744073709551615 ]}, - - transmittedOctetsDelta: {presence: required, - - range: [ 0, 18446744073709551615 ]}, - - transmittedOctetsAccumulated: {presence: required, - - range: [ 0, 18446744073709551615 ]}, - - transmittedTotalPacketsAccumulated: {presence: required, - - range: [ 0, 18446744073709551615 ]}, - - transmittedTotalPacketsDelta: {presence: required, - - range: [ 0, 18446744073709551615 ]}, - - valuesAreSuspect: {presence: required, value: [ true, false ]}, - - vNicIdentifier: {presence: required} - - }} - - ]} - - }} - - }} - + event: { + presence: required, structure: { + commonEventHeader: { + presence: required, structure: { + domain: {presence: required, value: measurementsForVfScaling}, + eventName: {presence: required, value: Mfvs_vMrf}, + eventId: {presence: required}, + nfNamingCode: {value: mrfx}, + priority: {presence: required, value: Normal}, + reportingEntityId: {presence: required}, + reportingEntityName: {presence: required}, + sequence: {presence: required}, + sourceId: {presence: required}, + sourceName: {presence: required}, + startEpochMicrosec: {presence: required}, + lastEpochMicrosec: {presence: required}, + version: {presence: required, value: 3.0} + } + }, + measurementsForVfScalingFields: { + presence: required, structure: { + measurementFieldsVersion: {presence: required, value: 2.0}, + measurementInterval: {presence: required, range: [ 60, 3600 ], default: 300}, + concurrentSessions: {presence: required, range: [ 0, 100000 ]}, + requestRate: {presence: required, range: [ 0, 100000 ]}, + numberOfMediaPortsInUse: {presence: required, range: [ 0, 100000 ]}, + cpuUsageArray: { + presence: required, array: [ + cpuUsage: { + presence: required, structure: { + cpuIdentifier: {presence: required}, + percentUsage: { + presence: required, range: [ 0, 100 ], + action: [80, up, CpuUsageHigh, RECO-scaleOut], + action: [10, down, CpuUsageLow, RECO-scaleIn] + } + } + } + ] + }, + memoryUsageArray: { + presence: required, array: [ + memoryUsage: { + presence: required, structure: { + memoryConfigured: {presence: required, value: 33554432}, + memoryFree: { + presence: required, range: [ 0, 33554432 ], + action: [100, down, FreeMemLow, RECO-scaleOut], + action: [30198989, up, FreeMemHigh, RECO-scaleIn] + }, + memoryUsed: {presence: required, range: [ 0, 33554432 ]}, + vmIdentifier: {presence: required} + } + } + ] + }, + additionalMeasurements: { + presence: required, array: [ + namedArrayOfFields: { + presence: required, structure: { + name: {presence: required, value: licenseUsage}, + arrayOfFields: { + presence: required, array: [ + field: { + presence: required, structure: { + name: {presence: required, value: G711AudioPort}, + value: { + presence: required, range: [ 0, 100000 ], + units: numberOfPorts + } + } + }, + field: { + presence: required, structure: { + name: {presence: required, value: G729AudioPort}, + value: { + presence: required, range: [ 0, 100000 ], + units: numberOfPorts + } + } + }, + field: { + presence: required, structure: { + name: {presence: required, value: G722AudioPort}, + value: { + presence: required, range: [ 0, 100000 ], + units: numberOfPorts + } + } + }, + field: { + presence: required, structure: { + name: {presence: required, value: AMRAudioPort}, + value: { + presence: required, range: [ 0, 100000 ], + units: numberOfPorts + } + } + }, + field: { + presence: required, structure: { + name: {presence: required, value: AMRWBAudioPort}, + value: { + presence: required, range: [ 0, 100000 ], + units: numberOfPorts + } + } + }, + field: { + presence: required, structure: { + name: {presence: required, value: OpusAudioPort}, + value: { + presence: required, range: [ 0, 100000 ], + units: numberOfPorts + } + } + }, + field: { + presence: required, structure: { + name: {presence: required, value: H263VideoPort}, + value: { + presence: required, range: [ 0, 100000 ], + units: numberOfPorts + } + } + }, + field: { + presence: required, structure: { + name: {presence: required, value: H264NonHCVideoPort}, + value: { + presence: required, range: [ 0, 100000 ], + units: numberOfPorts + } + } + }, + field: { + presence: required, structure: { + name: {presence: required, value: H264HCVideoPort}, + value: { + presence: required, range: [ 0, 100000 ], + units: numberOfPorts + } + } + }, + field: { + presence: required, structure: { + name: {presence: required, value: MPEG4VideoPort}, + value: { + presence: required, range: [ 0, 100000 ], + units: numberOfPorts + } + } + }, + field: { + presence: required, structure: { + name: {presence: required, value: VP8NonHCVideoPort}, + value: { + presence: required, range: [ 0, 100000 ], + units: numberOfPorts + } + } + }, + field: { + presence: required, structure: { + name: {presence: required, value: VP8HCVideoPort}, + value: { + presence: required, range: [ 0, 100000 ], + units: numberOfPorts + } + } + }, + field: { + presence: required, structure: { + name: {presence: required, value: PLC}, + value: { + presence: required, range: [ 0, 100000 ], + units: numberOfPorts + } + } + }, + field: { + presence: required, structure: { + name: {presence: required, value: AEC}, + value: { + presence: required, range: [ 0, 100000 ], + units: numberOfPorts + } + } + }, + field: { + presence: required, structure: { + name: {presence: required, value: NR}, + value: { + presence: required, range: [ 0, 100000 ], + units: numberOfPorts + } + } + }, + field: { + presence: required, structure: { + name: {presence: required, value: NG}, + value: { + presence: required, range: [ 0, 100000 ], + units: numberOfPorts + } + } + }, + field: { + presence: required, structure: { + name: {presence: required, value: NLD}, + value: { + presence: required, range: [ 0, 100000 ], + units: numberOfPorts + } + } + }, + field: { + presence: required, structure: { + name: {presence: required, value: G711FaxPort}, + value: { + presence: required, range: [ 0, 100000 ], + units: numberOfPorts + } + } + }, + field: { + presence: required, structure: { + name: {presence: required, value: T38FaxPort}, + value: { + presence: required, range: [ 0, 100000 ], + units: numberOfPorts + } + } + }, + field: { + presence: required, structure: { + name: {presence: required, value: RFactor}, + value: { + presence: required, range: [ 0, 100000 ], + units: numberOfPorts + } + } + }, + field: { + presence: required, structure: { + name: {presence: required, value: T140TextPort}, + value: { + presence: required, range: [ 0, 100000 ], + units: numberOfPorts + } + } + }, + field: { + presence: required, structure: { + name: {presence: required, value: EVSAudioPort}, + value: { + presence: required, range: [ 0, 100000 ], + units: numberOfPorts + } + } + } + ] + } + } + }, + namedArrayOfFields: { + presence: required, structure: { + name: {presence: required, value: mediaCoreUtilization}, + arrayOfFields: { + presence: required, array: [ + field: { + presence: required, structure: { + name: {presence: required, value: actualAvgAudio}, + value: { + presence: required, range: [ 0, 255 ], + action: [80, up, AudioCoreUsageHigh, RECO-scaleOut], + action: [10, down, AudioCoreUsageLow, RECO-scaleIn] + } + } + }, + field: { + presence: required, structure: { + name: {presence: required, value: modelAvgAudio}, + value: { + presence: required, range: [ 0, 100 ], + action: [80, up, AudioCoreUsageHigh, RECO-scaleOut], + action: [10, down, AudioCoreUsageLow, RECO-scaleIn] + } + } + }, + field: { + presence: required, structure: { + name: {presence: required, value: actualMaxAudio}, + value: {presence: required, range: [ 0, 255 ]} + } + }, + field: { + presence: required, structure: { + name: {presence: required, value: modelMaxAudio}, + value: {presence: required, range: [ 0, 100 ]} + } + }, + field: { + presence: required, structure: { + name: {presence: required, value: actualAvgVideo}, + value: { + presence: required, range: [ 0, 255 ], + action: [80, up, VideoCoreUsageHigh, RECO-scaleOut], + action: [10, down, VideoCoreUsageLow, RECO-scaleIn] + } + } + }, + field: { + presence: required, structure: { + name: {presence: required, value: modelAvgVideo}, + value: { + presence: required, range: [ 0, 100 ], + action: [80, up, VideoCoreUsageHigh, RECO-scaleOut], + action: [10, down, VideoCoreUsageLow, RECO-scaleIn] + } + } + }, + field: { + presence: required, structure: { + name: {presence: required, value: actualMaxVideo}, + value: {presence: required, range: [ 0, 255 ]} + } + }, + field: { + presence: required, structure: { + name: {presence: required, value: modelMaxVideo}, + value: {presence: required, range: [ 0, 100 ]} + } + }, + field: { + presence: required, structure: { + name: {presence: required, value: actualAvgHcVideo}, + value: { + presence: required, range: [ 0, 255 ], + action: [80, up, HcVideoCoreUsageHigh, RECO-scaleOut], + action: [10, down, HcVideoCoreUsageLow, RECO-scaleIn] + } + } + }, + field: { + presence: required, structure: { + name: {presence: required, value: modelAvgHcVideo}, + value: { + presence: required, range: [ 0, 100 ], + action: [80, up, HcVideoCoreUsageHigh, RECO-scaleOut], + action: [10, down, HcVideoCoreUsageLow, RECO-scaleIn] + } + } + }, + field: { + presence: required, structure: { + name: {presence: required, value: actualMaxHcVideo}, + value: {presence: required, range: [ 0, 255 ]} + } + }, + field: { + presence: required, structure: { + name: {presence: required, value: modelMaxHcVideo}, + value: {presence: required, range: [ 0, 100 ]} + } + } + ] + } + } + } + ] + }, + vNicPerformanceArray: { + presence: required, array: [ + vNicPerformance: { + presence: required, structure: { + receivedOctetsAccumulated: { + presence: required, + range: [ 0, 18446744073709551615 ] + }, + receivedTotalPacketsAccumulated: { + presence: required, + range: [ 0, 18446744073709551615 ] + }, + receivedOctetsDelta: {presence: required}, + range: [ 0, 18446744073709551615 ], + receivedTotalPacketsDelta: { + presence: required, + range: [ 0, 18446744073709551615 ] + }, + transmittedOctetsDelta: { + presence: required, + range: [ 0, 18446744073709551615 ] + }, + transmittedOctetsAccumulated: { + presence: required, + range: [ 0, 18446744073709551615 ] + }, + transmittedTotalPacketsAccumulated: { + presence: required, + range: [ 0, 18446744073709551615 ] + }, + transmittedTotalPacketsDelta: { + presence: required, + range: [ 0, 18446744073709551615 ] + }, + valuesAreSuspect: {presence: required, value: [ true, false ]}, + vNicIdentifier: {presence: required} + } + } + ] + } + } + } + } + } Syslog ~~~~~~ @@ -2370,194 +2405,136 @@ Syslog # registration for Syslog\_vMRF - # Constants: the values of domain, eventName, priority, - lastEpochMicrosec, version, - + # Constants: the values of domain, eventName, priority, lastEpochMicrosec, version, # syslogFields.syslogFieldsVersion, syslogFields.syslogTag - - # Variables include: eventId, lastEpochMicrosec, reportingEntityId, - reportingEntityName, - + # Variables include: eventId, lastEpochMicrosec, reportingEntityId, reportingEntityName, # sequence, sourceId, sourceName, startEpochMicrosec, - # syslogFields.eventSourceHost, syslogFields.eventSourceType, - # syslogFields.syslogFacility, syslogFields.syslogMsg - event: {presence: required, structure: { - - commonEventHeader: {presence: required, structure: { - - domain: {presence: required, value: syslog}, - - eventName: {presence: required, value: Syslog\_vMrf}, - - eventId: {presence: required}, - - nfNamingCode: {value: mrfx}, - - priority: {presence: required, value: Normal}, - - reportingEntityId: {presence: required}, - - reportingEntityName: {presence: required}, - - sequence: {presence: required}, - - sourceId: {presence: required}, - - sourceName: {presence: required}, - - startEpochMicrosec: {presence: required}, - - lastEpochMicrosec: {presence: required}, - - version: {presence: required, value: 3.0}, - - }}, - - syslogFields: {presence: required, structure: { - - eventSourceHost: {presence: required}, - - eventSourceType: {presence: required, value: virtualNetworkFunction}, - - syslogFacility: {presence: required, range: [16, 23]}, - - syslogSev: {presence: required, value: [Emergency, Alert, Critical, - Error]}, - - syslogFieldsVersion: {presence: required, value: 3.0}, - - syslogMsg: {presence: required}, - - syslogSData: {presence: required, keyValuePairString: {‘ ‘, =, - keyValuePairs: [ - - keyValuePair: {presence: required, structure: { - - key: {presence: required, value: ATTEST}, - - value: {presence: required} - - }}, - - keyValuePair: {presence: required, structure: { - - key: {presence: required, value: DATE\_IN}, - - value: {presence: required} - - }}, - - keyValuePair: {presence: required, structure: { - - key: {presence: required, value: DATE\_OUT}, - - value: {presence: required} - - }}, - - keyValuePair: {presence: required, structure: { - - key: {presence: required, value: DEST\_IN}, - - value: {presence: required} - - }}, - - keyValuePair: {presence: required, structure: { - - key: {presence: required, value: FUNCTION}, - - value: {presence: required} - - }}, - - keyValuePair: {presence: required, structure: { - - key: {presence: required, value: ICID}, - - value: {presence: required} - - }}, - - keyValuePair: {presence: required, structure: { - - key: {presence: required, value: ORIGID}, - - value: {presence: required} - - }}, - - keyValuePair: {presence: required, structure: { - - key: {presence: required, value: ORIG\_TN}, - - value: {presence: required} - - }}, - - keyValuePair: {presence: required, structure: { - - key: {presence: required, value: SIP\_REASON\_HEADER}, - - value: {presence: required} - - }}, - - keyValuePair: {presence: required, structure: { - - key: {presence: required, value: STATE}, - - value: {presence: required} - - }}, - - keyValuePair: {presence: required, structure: { - - key: {presence: required, value: STATUS}, - - value: {presence: required} - - }}, - - keyValuePair: {presence: required, structure: { - - key: {presence: required, value: VERSTAT}, - - value: {presence: required} - - }} - - ]}} }] - - syslogTag: {presence: required, value: vMRF}, - - additionalFields: {presence: required, keyValuePairString: {\|, =, - keyValuePairs: [ - - keyValuePair: {presence: required, structure: { - - key: {presence: required, value: someKeyName}, - - value: {presence: required} - - }}, - - keyValuePair: {presence: optional, structure: { - - key: {presence: required, value: someOtherKeyName}, - - value: {presence: required} - - }} - - ]}} - - }} - - }} + event: { + presence: required, structure: { + commonEventHeader: { + presence: required, structure: { + domain: {presence: required, value: syslog}, + eventName: {presence: required, value: Syslog_vMrf}, + eventId: {presence: required}, + nfNamingCode: {value: mrfx}, + priority: {presence: required, value: Normal}, + reportingEntityId: {presence: required}, + reportingEntityName: {presence: required}, + sequence: {presence: required}, + sourceId: {presence: required}, + sourceName: {presence: required}, + startEpochMicrosec: {presence: required}, + lastEpochMicrosec: {presence: required}, + version: {presence: required, value: 3.0}, + } + }, + syslogFields: { + presence: required, structure: { + eventSourceHost: {presence: required}, + eventSourceType: {presence: required, value: virtualNetworkFunction}, + syslogFacility: {presence: required, range: [16, 23]}, + syslogSev: {presence: required, value: [Emergency, Alert, Critical, Error]}, + syslogFieldsVersion: {presence: required, value: 3.0}, + syslogMsg: {presence: required}, + syslogSData: { + presence: required, keyValuePairString: {‘ ‘, =, keyValuePairs: [ + keyValuePair: { + presence: required, structure: { + key: {presence: required, value: ATTEST}, + value: {presence: required} + } + }, + keyValuePair: { + presence: required, structure: { + key: {presence: required, value: DATE_IN}, + value: {presence: required} + } + }, + keyValuePair: { + presence: required, structure: { + key: {presence: required, value: DATE_OUT}, + value: {presence: required} + } + }, + keyValuePair: { + presence: required, structure: { + key: {presence: required, value: DEST_IN}, + value: {presence: required} + } + }, + keyValuePair: { + presence: required, structure: { + key: {presence: required, value: FUNCTION}, + value: {presence: required} + } + }, + keyValuePair: { + presence: required, structure: { + key: {presence: required, value: ICID}, + value: {presence: required} + } + }, + keyValuePair: { + presence: required, structure: { + key: {presence: required, value: ORIGID}, + value: {presence: required} + } + }, + keyValuePair: { + presence: required, structure: { + key: {presence: required, value: ORIG_TN}, + value: {presence: required} + } + }, + keyValuePair: { + presence: required, structure: { + key: {presence: required, value: SIP_REASON_HEADER}, + value: {presence: required} + } + }, + keyValuePair: { + presence: required, structure: { + key: {presence: required, value: STATE}, + value: {presence: required} + } + }, + keyValuePair: { + presence: required, structure: { + key: {presence: required, value: STATUS}, + value: {presence: required} + } + }, + keyValuePair: { + presence: required, structure: { + key: {presence: required, value: VERSTAT}, + value: {presence: required} + } + } + ]} + } + } + syslogTag: {presence: required, value: vMRF}, + additionalFields: { + presence: required, keyValuePairString: { \|, =, keyValuePairs: [ + keyValuePair: { + presence: required, structure: { + key: {presence: required, value: someKeyName}, + value: {presence: required} + } + }, + keyValuePair: { + presence: optional, structure: { + key: {presence: required, value: someOtherKeyName}, + value: {presence: required} + } + } + ]} + } + } + } Mobile Flow @@ -2566,235 +2543,135 @@ Mobile Flow .. code-block:: yaml # registration for mobileFlow - # Constants: the values of domain, eventName, priority, version - # - - # Variables (to be supplied at runtime) include: eventId, - reportingEntityName, - + # Variables (to be supplied at runtime) include: eventId, reportingEntityName, # sequence, sourceName, start/lastEpochMicrosec - # - - event: {presence: required, structure: { - - commonEventHeader: {presence: required, structure: { - - domain: {presence: required, value: mobileFlow}, - - eventName: {presence: required, value: mobileFlow}, - - eventId: {presence: required}, - - nfType: {presence: required, value: sbcx}, - - priority: {presence: required, value: Normal}, - - reportingEntityName: {presence: required}, - - sequence: {presence: required}, - - sourceName: {presence: required}, - - startEpochMicrosec: {presence: required}, - - lastEpochMicrosec: {presence: required}, - - version: {presence: required, value: 3.0} - - }}, - - mobileFlowFieldsVersion: {presence: required, structure: { - - applicationType: {presence: optional}, - - appProtocolType: {presence: optional}, - - appProtocolVersion: {presence: optional}, - - cid: {presence: optional}, - - connectionType: {presence: optional}, - - ecgi: {presence: optional}, - - flowDirection: {presence: required}, - - gtpPerFlowMetrics: {presence: required, structure: { - - avgBitErrorRate: {presence: required}, - - avgPacketDelayVariation: {presence: required}, - - avgPacketLatency: {presence: required}, - - avgReceiveThroughput: {presence: required}, - - avgTransmitThroughput: {presence: required}, - - durConnectionFailedStatus: {presence: optional}, - - durTunnelFailedStatus: {presence: optional}, - - flowActivatedBy: {presence: optional}, - - flowActivationEpoch: {presence: required}, - - flowActivationMicrosec: {presence: required}, - - flowActivationTime: {presence: optional}, - - flowDeactivatedBy: {presence: optional}, - - flowDeactivationEpoch: {presence: required}, - - flowDeactivationMicrosec: {presence: required}, - - flowDeactivationTime: {presence: required}, - - flowStatus: {presence: required}, - - gtpConnectionStatus: {presence: optional}, - - gtpTunnelStatus: {presence: optional}, - - ipTosCountList: {presence: optional}, - - ipTosList: {presence: optional}, - - largePacketRtt: {presence: optional}, - - largePacketThreshold: {presence: optional}, - - maxPacketDelayVariation: {presence: required}, - - maxReceiveBitRate: {presence: optional}, - - maxTransmitBitRate: {presence: optional}, - - mobileQciCosCountList: {presence: optional}, - - mobileQciCosList: {presence: optional}, - - numActivationFailures: {presence: required}, - - numBitErrors: {presence: required}, - - numBytesReceived: {presence: required}, - - numBytesTransmitted: {presence: required}, - - numDroppedPackets: {presence: required}, - - numGtpEchoFailures: {presence: optional}, - - numGtpTunnelErrors: {presence: optional}, - - numHttpErrors: {presence: optional}, - - numL7BytesReceived: {presence: required}, - - numL7BytesTransmitted: {presence: required}, - - numLostPackets: {presence: required}, - - numOutOfOrderPackets: {presence: required}, - - numPacketErrors: {presence: required}, - - numPacketsReceivedExclRetrans: {presence: required}, - - numPacketsReceivedInclRetrans: {presence: required}, - - numPacketsTransmittedInclRetrans: {presence: required}, - - numRetries: {presence: required}, - - numTimeouts: {presence: required}, - - numTunneledL7BytesReceived: {presence: required}, - - roundTripTime: {presence: required}, - - tcpFlagCountList: {presence: optional}, - - tcpFlagList: {presence: optional}, - - timeToFirstByte: {presence: required} - - }}, - - gtpProtocolType: {presence: optional}, - - gtpVersion: {presence: optional}, - - httpHeader: {presence: optional}, - - imei: {presence: optional}, - - imsi: {presence: optional}, - - ipProtocolType: {presence: required}, - - ipVersion: {presence: required}, - - lac: {presence: optional}, - - mcc: {presence: optional}, - - mnc: {presence: optional}, - - msisdn: {presence: optional}, - - otherEndpointIpAddress: {presence: required}, - - otherEndpointPort: {presence: required}, - - otherFunctionalRole: {presence: optional}, - - rac: {presence: optional}, - - radioAccessTechnology: {presence: optional}, - - reportingEndpointIpAddr: {presence: required}, - - reportingEndpointPort: {presence: required}, - - sac: {presence: optional}, - - samplingAlgorithm: {presence: optional}, - - tac: {presence: optional}, - - tunnelId: {presence: optional}, - - vlanId: {presence: optional}, - - additionalInformation: {presence: optional, array: { - - field: {presence: required, structure: { - - name: {presence: required, value: name1}, - - value: {presence: required} - - }}, - - field: {presence: optional, structure: { - - name: {presence: required, value: name2}, - - value: {presence: required} - - }} - - }} - - }} + event: { + presence: required, structure: { + commonEventHeader: { + presence: required, structure: { + domain: {presence: required, value: mobileFlow}, + eventName: {presence: required, value: mobileFlow}, + eventId: {presence: required}, + nfType: {presence: required, value: sbcx}, + priority: {presence: required, value: Normal}, + reportingEntityName: {presence: required}, + sequence: {presence: required}, + sourceName: {presence: required}, + startEpochMicrosec: {presence: required}, + lastEpochMicrosec: {presence: required}, + version: {presence: required, value: 3.0} + } + }, + mobileFlowFieldsVersion: { + presence: required, structure: { + applicationType: {presence: optional}, + appProtocolType: {presence: optional}, + appProtocolVersion: {presence: optional}, + cid: {presence: optional}, + connectionType: {presence: optional}, + ecgi: {presence: optional}, + flowDirection: {presence: required}, + gtpPerFlowMetrics: { + presence: required, structure: { + avgBitErrorRate: {presence: required}, + avgPacketDelayVariation: {presence: required}, + avgPacketLatency: {presence: required}, + avgReceiveThroughput: {presence: required}, + avgTransmitThroughput: {presence: required}, + durConnectionFailedStatus: {presence: optional}, + durTunnelFailedStatus: {presence: optional}, + flowActivatedBy: {presence: optional}, + flowActivationEpoch: {presence: required}, + flowActivationMicrosec: {presence: required}, + flowActivationTime: {presence: optional}, + flowDeactivatedBy: {presence: optional}, + flowDeactivationEpoch: {presence: required}, + flowDeactivationMicrosec: {presence: required}, + flowDeactivationTime: {presence: required}, + flowStatus: {presence: required}, + gtpConnectionStatus: {presence: optional}, + gtpTunnelStatus: {presence: optional}, + ipTosCountList: {presence: optional}, + ipTosList: {presence: optional}, + largePacketRtt: {presence: optional}, + largePacketThreshold: {presence: optional}, + maxPacketDelayVariation: {presence: required}, + maxReceiveBitRate: {presence: optional}, + maxTransmitBitRate: {presence: optional}, + mobileQciCosCountList: {presence: optional}, + mobileQciCosList: {presence: optional}, + numActivationFailures: {presence: required}, + numBitErrors: {presence: required}, + numBytesReceived: {presence: required}, + numBytesTransmitted: {presence: required}, + numDroppedPackets: {presence: required}, + numGtpEchoFailures: {presence: optional}, + numGtpTunnelErrors: {presence: optional}, + numHttpErrors: {presence: optional}, + numL7BytesReceived: {presence: required}, + numL7BytesTransmitted: {presence: required}, + numLostPackets: {presence: required}, + numOutOfOrderPackets: {presence: required}, + numPacketErrors: {presence: required}, + numPacketsReceivedExclRetrans: {presence: required}, + numPacketsReceivedInclRetrans: {presence: required}, + numPacketsTransmittedInclRetrans: {presence: required}, + numRetries: {presence: required}, + numTimeouts: {presence: required}, + numTunneledL7BytesReceived: {presence: required}, + roundTripTime: {presence: required}, + tcpFlagCountList: {presence: optional}, + tcpFlagList: {presence: optional}, + timeToFirstByte: {presence: required} + } + }, + gtpProtocolType: {presence: optional}, + gtpVersion: {presence: optional}, + httpHeader: {presence: optional}, + imei: {presence: optional}, + imsi: {presence: optional}, + ipProtocolType: {presence: required}, + ipVersion: {presence: required}, + lac: {presence: optional}, + mcc: {presence: optional}, + mnc: {presence: optional}, + msisdn: {presence: optional}, + otherEndpointIpAddress: {presence: required}, + otherEndpointPort: {presence: required}, + otherFunctionalRole: {presence: optional}, + rac: {presence: optional}, + radioAccessTechnology: {presence: optional}, + reportingEndpointIpAddr: {presence: required}, + reportingEndpointPort: {presence: required}, + sac: {presence: optional}, + samplingAlgorithm: {presence: optional}, + tac: {presence: optional}, + tunnelId: {presence: optional}, + vlanId: {presence: optional}, + additionalInformation: { + presence: optional, array: { + field: { + presence: required, structure: { + name: {presence: required, value: name1}, + value: {presence: required} + } + }, + field: { + presence: optional, structure: { + name: {presence: required, value: name2}, + value: {presence: required} + } + } + } + } + } + } + } + } - }} Sip Signaling @@ -2803,97 +2680,66 @@ Sip Signaling .. code-block:: yaml # registration for sipSignaling - # Constants: the values of domain, eventName, priority, version - # - # Variables (to be supplied at runtime) include: eventId, reportingEntityName, - # sequence, sourceName, start/lastEpochMicrosec - # - - event: {presence: required, structure: { - - commonEventHeader: {presence: required, structure: { - - domain: {presence: required, value: sipSignaling}, - - eventName: {presence: required, value: sipSignaling\_modelName}, - - eventId: {presence: required}, - - nfType: {presence: required, value: sbcx}, - - priority: {presence: required, value: Normal}, - - reportingEntityName: {presence: required}, - - sequence: {presence: required}, - - sourceName: {presence: required}, - - startEpochMicrosec: {presence: required}, - - lastEpochMicrosec: {presence: required}, - - version: {presence: required, value: 3.0} - - }}, - - sipSignalingFields: {presence: required, structure: { - - compressedSIP: {presence: optional}, - - correlator: {presence: required}, - - localIpAaddress: {presence: required}, - - localPort: {presence: required}, - - remoteIpAddress: {presence: required}, - - remotePort: {presence: required}, - - sipSignalingFieldsVersion: {presence: required}, - - summarySip: {presence: optional}, - - vnfVendorNameFields: {presence: required, structure: { - - vendorName: {presence: required}, - - vfModuleName: {presence: optional}, - - vnfName: {presence: optional} - - }}, - - additionalInformation: {presence: optional, array: { - - field: {presence: required, structure: { - - name: {presence: required, value: name1}, - - value: {presence: required} - - }}, - - field: {presence: optional, structure: { - - name: {presence: required, value: name2}, - - value: {presence: required} - - }} - - }} - - }} - - }} + event: { + presence: required, structure: { + commonEventHeader: { + presence: required, structure: { + domain: {presence: required, value: sipSignaling}, + eventName: {presence: required, value: sipSignaling_modelName}, + eventId: {presence: required}, + nfType: {presence: required, value: sbcx}, + priority: {presence: required, value: Normal}, + reportingEntityName: {presence: required}, + sequence: {presence: required}, + sourceName: {presence: required}, + startEpochMicrosec: {presence: required}, + lastEpochMicrosec: {presence: required}, + version: {presence: required, value: 3.0} + } + }, + sipSignalingFields: { + presence: required, structure: { + compressedSIP: {presence: optional}, + correlator: {presence: required}, + localIpAaddress: {presence: required}, + localPort: {presence: required}, + remoteIpAddress: {presence: required}, + remotePort: {presence: required}, + sipSignalingFieldsVersion: {presence: required}, + summarySip: {presence: optional}, + vnfVendorNameFields: { + presence: required, structure: { + vendorName: {presence: required}, + vfModuleName: {presence: optional}, + vnfName: {presence: optional} + } + }, + additionalInformation: { + presence: optional, array: { + field: { + presence: required, structure: { + name: {presence: required, value: name1}, + value: {presence: required} + } + }, + field: { + presence: optional, structure: { + name: {presence: required, value: name2}, + value: {presence: required} + } + } + } + } + } + } + } + } Voice Quality @@ -2902,155 +2748,96 @@ Voice Quality .. code-block:: yaml # registration for voiceQuality - # Constants: the values of domain, eventName, priority, version - - # - - # Variables (to be supplied at runtime) include: eventId, - lastEpochMicrosec, - + # Variables (to be supplied at runtime) include: eventId, lastEpochMicrosec, # reportingEntityId, reportingEntityName, sequence, sourceId, - # sourceName, startEpochMicrosec - event: {presence: required, structure: { - - commonEventHeader: {presence: required, structure: { - - domain: {presence: required, value: voiceQualityFields}, - - eventName: {presence: required, value: voiceQualityFields\_modelName}, - - eventId: {presence: required}, - - nfType: {presence: required, value: sbcx}, - - priority: {presence: required, value: Normal}, - - reportingEntityName: {presence: required}, - - sequence: {presence: required}, - - sourceName: {presence: required}, - - startEpochMicrosec: {presence: required}, - - lastEpochMicrosec: {presence: required}, - - version: {presence: required, value: 3.0} - - }}, - - voiceQualityFieldsVersion: {presence: required, structure: { - - calleeSideCodec: {presence: required}, - - callerSideCodec: {presence: required}, - - correlator: {presence: required}, - - remoteIpAddress: {presence: required}, - - endOfCallVqmSummaries: {presence: required, structure: { - - adjacencyName: {presence: required}, - - endpointDescription: {presence: required}, - - endpointAverageJitter: {presence: optional}, - - endpointMaxJitter: {presence: optional}, - - endpointRtpOctetsLost: {presence: optional}, - - endpointRtpPacketsLost: {presence: optional}, - - endpointRtpOctetsDiscarded: {presence: optional}, - - endpointRtpOctetsReceived: {presence: optional}, - - endpointRtpOctetsSent: {presence: optional}, - - endpointRtpPacketsDiscarded: {presence: optional}, - - endpointRtpPacketsReceived: {presence: optional}, - - endpointRtpPacketsSent: {presence: optional}, - - localAverageJitter: {presence: optional}, - - localMaxJitter: {presence: optional}, - - localAverageJitterBufferDelay: {presence: optional}, - - localMaxJitterBufferDelay: {presence: optional}, - - localRtpOctetsDiscarded: {presence: optional}, - - localRtpOctetsLost: {presence: optional}, - - localRtpOctetsReceived: {presence: optional}, - - localRtpOctetsSent: {presence: optional}, - - localRtpPacketsDiscarded: {presence: optional}, - - localRtpPacketsLost: {presence: optional}, - - localRtpPacketsReceived: {presence: optional}, - - localRtpPacketsSent: {presence: optional}, - - mosCqe: {presence: optional}, - - packetLossPercent: {presence: optional}, - - rFactor: {presence: optional}, - - roundTripDelay: {presence: optional}, - - oneWayDelay: {presence: optional} - - }}, - - phoneNumber: {presence: required}, - - midCallRtcp: {presence: required}, - - vendorVnfNameFields: {presence: required, structure: { - - vendorName: {presence: required}, - - vfModuleName: {presence: optional}, - - vnfName: {presence: optional} - - }}, - - additionalInformation: {presence: optional, array: { - - field: {presence: required, structure: { - - name: {presence: required, value: name1}, - - value: {presence: required} - - }}, - - field: {presence: optional, structure: { - - name: {presence: required, value: name2}, - - value: {presence: required} - - }} - - }} - - }} - - }} + event: { + presence: required, structure: { + commonEventHeader: { + presence: required, structure: { + domain: {presence: required, value: voiceQualityFields}, + eventName: {presence: required, value: voiceQualityFields_modelName}, + eventId: {presence: required}, + nfType: {presence: required, value: sbcx}, + priority: {presence: required, value: Normal}, + reportingEntityName: {presence: required}, + sequence: {presence: required}, + sourceName: {presence: required}, + startEpochMicrosec: {presence: required}, + lastEpochMicrosec: {presence: required}, + version: {presence: required, value: 3.0} + } + }, + voiceQualityFieldsVersion: { + presence: required, structure: { + calleeSideCodec: {presence: required}, + callerSideCodec: {presence: required}, + correlator: {presence: required}, + remoteIpAddress: {presence: required}, + endOfCallVqmSummaries: { + presence: required, structure: { + adjacencyName: {presence: required}, + endpointDescription: {presence: required}, + endpointAverageJitter: {presence: optional}, + endpointMaxJitter: {presence: optional}, + endpointRtpOctetsLost: {presence: optional}, + endpointRtpPacketsLost: {presence: optional}, + endpointRtpOctetsDiscarded: {presence: optional}, + endpointRtpOctetsReceived: {presence: optional}, + endpointRtpOctetsSent: {presence: optional}, + endpointRtpPacketsDiscarded: {presence: optional}, + endpointRtpPacketsReceived: {presence: optional}, + endpointRtpPacketsSent: {presence: optional}, + localAverageJitter: {presence: optional}, + localMaxJitter: {presence: optional}, + localAverageJitterBufferDelay: {presence: optional}, + localMaxJitterBufferDelay: {presence: optional}, + localRtpOctetsDiscarded: {presence: optional}, + localRtpOctetsLost: {presence: optional}, + localRtpOctetsReceived: {presence: optional}, + localRtpOctetsSent: {presence: optional}, + localRtpPacketsDiscarded: {presence: optional}, + localRtpPacketsLost: {presence: optional}, + localRtpPacketsReceived: {presence: optional}, + localRtpPacketsSent: {presence: optional}, + mosCqe: {presence: optional}, + packetLossPercent: {presence: optional}, + rFactor: {presence: optional}, + roundTripDelay: {presence: optional}, + oneWayDelay: {presence: optional} + } + }, + phoneNumber: {presence: required}, + midCallRtcp: {presence: required}, + vendorVnfNameFields: { + presence: required, structure: { + vendorName: {presence: required}, + vfModuleName: {presence: optional}, + vnfName: {presence: optional} + } + }, + additionalInformation: { + presence: optional, array: { + field: { + presence: required, structure: { + name: {presence: required, value: name1}, + value: {presence: required} + } + }, + field: { + presence: optional, structure: { + name: {presence: required, value: name2}, + value: {presence: required} + } + } + } + } + } + } + } + } Rules @@ -3061,27 +2848,16 @@ Rules #Rules Rules: [ - - rule: { - - trigger: CpuUsageHigh \|\| FreeMemLow \|\| AudioCoreUsageHigh \|\| - - VideoCoreUsageHigh \|\| HcVideoCoreUsageHigh, - - microservices: [scaleOut] - - }, - - rule: { - - trigger: CpuUsageLow && FreeMemHigh && AudioCoreUsageLow && - - VideoCoreUsageLow && HcVideoCoreUsageLow, - - microservices: [scaleIn] - - } - + rule: { + trigger: CpuUsageHigh || FreeMemLow || AudioCoreUsageHigh || + VideoCoreUsageHigh || HcVideoCoreUsageHigh, + microservices: [scaleOut] + }, + rule: { + trigger: CpuUsageLow && FreeMemHigh && AudioCoreUsageLow && + VideoCoreUsageLow && HcVideoCoreUsageLow, + microservices: [scaleIn] + } ] @@ -3091,170 +2867,222 @@ Appendix: Historical Change Log For the latest changes, see the Change Block just before the Table of Contents. -+--------------+------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Date | Revision | Description | -+--------------+------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 3/15/2017 | 1.0 | This is the initial release of the VES Event Registration document. | -+--------------+------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 3/22/2017 | 1.1 | - Changed the ‘alert’ qualifier to ‘action’ and added support for conditions that will trigger rules. | -| | | | -| | | - Formatted the document with more sections and subsections. | -| | | | -| | | - Defined the syntax and semantics for condition based rules. | -| | | | -| | | - Fixed the YAML examples. | -+--------------+------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 3/27/2017 | 1.2 | - Clarified the audience of the document and the expectations for vendors. | -| | | | -| | | - Changed the order of fields in the action keyword. | -| | | | -| | | - Updated the YAML examples. | -| | | | -| | | - Wordsmithed throughout. | -+--------------+------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 3/31/2017 | 1.3 | - Generalized the descriptions from an ASDC, ECOMP and AT&T-specific interaction with a VNF vendor, to a generic Service Provider interaction with a VNF vendor. | -| | | | -| | | - Wordsmithed throughout. | -| | | | -| | | - Added a ‘default’ qualifier | -| | | | -| | | - Fixed syntax and semantic inconsistencies in the Rules section | -| | | | -| | | - Brought all examples into compliance with v5.0 | -| | | | -| | | - Added a heartbeat example | -| | | | -| | | - Modified the mfvs example | -| | | | -| | | - Modified the syslog example | -| | | | -| | | - Added two complex rules | -+--------------+------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 4/14/2017 | 1.4 | - Wordsmithed throughout | -| | | | -| | | - Action keyword: clarified use of ‘up’, ‘down’ and ‘at’ triggers; clarified the specification and use of microservices directives at design time and runtime, clarified the use of tca’s | -| | | | -| | | - HeartbeatAction keyword: Added the heartbeatAction keyword | -| | | | -| | | - Value keyword: clarified the communicaton of strings containing spaces. | -| | | | -| | | - Rules: corrected the use of quotes in examples | -| | | | -| | | - Examples: added the heartbeatAction keyword on the heartbeat event example; also corrected use of quotes throughout. | -+--------------+------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 10/3/2017 | 1.5 | - Back of Cover Page: updated the license and copyright notice to comply with ONAP guidelines | -| | | | -| | | - Section 3.1: Added a ‘Units’ qualifier | -| | | | -| | | - Examples: updated the examples to align with VES 5.4.1 | -+--------------+------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 10/31/2017 | 1.6 | - Added KeyValuePairString keyword to handle strings which have delimited key-value pairs within them. | -| | | | -| | | - Updated the syslog example to show the use of KeyValuePairString | -| | | | -| | | - Updated the syslog example to align syslogSev with VES 5.4.1 | -| | | | -| | | - Added examples for mobile flow, sip signaling and voice quality | -| | | | -| | | - Added sections within the examples to facilitate rapid access to specific types of example events | -| | | | -| | | - Wordsmithed the Introduction | -+--------------+------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 6/28/2018 | 2.0 | - Updated to align with the change of the ‘measurementsForVfScaling’ domain to ‘measurement’ | -| | | | -| | | - measurementsForVfScaling measurement | -| | | | -| | | - measurementsForVfScalingFields measurementFields | -| | | | -| | | - measurementsForVfScalingVersion measurementFieldsVersion | -| | | | -| | | - the ‘mfvs’ abbreviation measurement | -| | | | -| | | 1. Clarified YAML file naming | -| | | | -| | | 2. Clarified the Action keyword. | -| | | | -| | | 3. Added an aggregationRole keyword. | -| | | | -| | | 4. Added a castTo keyword. | -| | | | -| | | 5. Added an isHomogeneous keyword. | -| | | | -| | | 6. Added a 'key' keyword | -| | | | -| | | 7. Add a 'keyValuePair' keyword | -| | | | -| | | 8. Modified the existing 'keyValuePairString' keyword description to reference the 'keyValuePair' keyword. | -| | | | -| | | 9. Added a section on Complex Conditions and modified the Rules section | -| | | | -| | | 10. Modified the Examples as follows: | -| | | | -| | | - changed ‘faultFieldsVersion’ to 3.0 | -| | | | -| | | - changed ‘heartbeatFieldsVersion’ to 2.0 | -| | | | -| | | - provided guidance at the top of the Measurements examples as to how to send extensible fields through arrayOfNamedHashMap in a way that will eliminate the need for custom development at the service provider. | -| | | | -| | | - changed ‘measurementFieldsVersion’ to 3.0 | -| | | | -| | | - changed measurementFields.additionalMeasurements to reference a ‘namedHashMap’ | -| | | | -| | | - ‘field’ is replaced by ‘keyValuePair’ | -| | | | -| | | - ‘name’ is replaced by ‘key’ | -| | | | -| | | - changed ‘namedArrayOfFields’ to ‘namedHashMap’ | -| | | | -| | | - fixed the mobile Flow example to show the ‘mobileFlowFields’, show the ‘mobileFlowFieldsVersion’ at 3.0, modify ‘additionalInformation’ to use a hashMap | -| | | | -| | | - ‘field’ is replaced by ‘keyValuePair’ | -| | | | -| | | - ‘name’ is replaced by ‘key’ | -| | | | -| | | - changed ‘sipSignalingFieldsVersion’ to 2.0 | -| | | | -| | | - changed ‘additionalInformation’ to use a hashmap | -| | | | -| | | - ‘field’ is replaced by ‘keyValuePair’ | -| | | | -| | | - ‘name’ is replaced by ‘key’ | -| | | | -| | | - fixed the voiceQuality example to show the ‘voiceQualityFields’, show the ‘voiceQualityFieldsVersion’ at 2.0 and modify ‘additionalInformation’ to use a hashMap | -| | | | -| | | - ‘field’ is replaced by ‘keyValuePair’ | -| | | | -| | | - ‘name’ is replaced by ‘key’ | -| | | | -| | | - Modified the rules example to conform to the Complex Conditions and Rules sections. | -| | | | -| | | - Numerous clarifications made to address issues with previous drafts of this version including: | -| | | | -| | | - Fixed arrays followed by other than square brackets | -| | | | -| | | - Section 2.2: clarified format of v# in filename | -| | | | -| | | - Section 3.1.11: clarified use of camel casing | -| | | | -| | | - Section 3.2.1: corrected and clarified | -| | | | -| | | - Section 3.2.3 Clarified number of conditions that may be and’d or or’d | -| | | | -| | | - Section 3.2.4: fixed reference to PersistentB1 | -| | | | -| | | - Section 3.2.6: fixed math in example | -| | | | -| | | - Section 3.3.2: changed reference from ‘alerts’ to ‘events’ | -+--------------+------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 7/30/2018 | 3.0 | - Removed the isHomogeneous keyword. | -| | | | -| | | - Modified the types of aggregationRoles. | -| | | | -| | | - Clarified castTo | -| | | | -| | | - Added comment keyword | -+--------------+------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 9/14/2018 | 3.1 | - Added keywords: CastTo, Comment, Aggregation Role. These were modified versions of the keywords already defined in version 3.0. | -+--------------+------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 12/10/2018 | 3.2 | - Added the PM Data Dictionary and FM Meta Data sections. | -+--------------+------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------+----------+-----------------------------------------------------+ +| Date | Revision | Description | ++------------+----------+-----------------------------------------------------+ +| 3/15/2017 | 1.0 | This is the initial release of the VES Event | +| | | Registration document. | ++------------+----------+-----------------------------------------------------+ +| 3/22/2017 | 1.1 | - Changed the ‘alert’ qualifier to ‘action’ and | +| | | added support for conditions that will trigger | +| | | rules. | +| | | | +| | | - Formatted the document with more sections and | +| | | subsections. | +| | | | +| | | - Defined the syntax and semantics for condition | +| | | based rules. | +| | | | +| | | - Fixed the YAML examples. | ++------------+----------+-----------------------------------------------------+ +| 3/27/2017 | 1.2 | - Clarified the audience of the document and the | +| | | expectations for vendors. | +| | | | +| | | - Changed the order of fields in the action keyword.| +| | | | +| | | - Updated the YAML examples. | +| | | | +| | | - Wordsmithed throughout. | ++------------+----------+-----------------------------------------------------+ +| 3/31/2017 | 1.3 | - Generalized the descriptions from an ASDC, ECOMP | +| | | and AT&T-specific interaction with a VNF vendor, | +| | | to a generic Service Provider interaction with a | +| | | VNF vendor. | +| | | | +| | | - Wordsmithed throughout. | +| | | | +| | | - Added a ‘default’ qualifier | +| | | | +| | | - Fixed syntax and semantic inconsistencies in the | +| | | Rules section | +| | | | +| | | - Brought all examples into compliance with v5.0 | +| | | | +| | | - Added a heartbeat example | +| | | | +| | | - Modified the mfvs example | +| | | | +| | | - Modified the syslog example | +| | | | +| | | - Added two complex rules | ++------------+----------+-----------------------------------------------------+ +| 4/14/2017 | 1.4 | - Wordsmithed throughout | +| | | | +| | | - Action keyword: clarified use of ‘up’, ‘down’ and | +| | | ‘at’ triggers; clarified the specification and use| +| | | of microservices directives at design time and | +| | | runtime, clarified the use of tca’s | +| | | | +| | | - HeartbeatAction keyword: Added the heartbeatAction| +| | | keyword | +| | | | +| | | - Value keyword: clarified the communicaton of | +| | | strings containing spaces. | +| | | | +| | | - Rules: corrected the use of quotes in examples | +| | | | +| | | - Examples: added the heartbeatAction keyword on the| +| | | heartbeat event example; also corrected use of | +| | | quotes throughout. | ++------------+----------+-----------------------------------------------------+ +| 10/3/2017 | 1.5 | - Back of Cover Page: updated the license and | +| | | copyright notice to comply with ONAP guidelines | +| | | | +| | | - Section 3.1: Added a ‘Units’ qualifier | +| | | | +| | | - Examples: updated the examples to align with VES | +| | | 5.4.1 | ++------------+----------+-----------------------------------------------------+ +| 10/31/2017 | 1.6 | - Added KeyValuePairString keyword to handle strings| +| | | which have delimited key-value pairs within them. | +| | | | +| | | - Updated the syslog example to show the use of | +| | | KeyValuePairString | +| | | | +| | | - Updated the syslog example to align syslogSev with| +| | | VES 5.4.1 | +| | | | +| | | - Added examples for mobile flow, sip signaling and | +| | | voice quality | +| | | | +| | | - Added sections within the examples to facilitate | +| | | rapid access to specific types of example events | +| | | | +| | | - Wordsmithed the Introduction | ++------------+----------+-----------------------------------------------------+ +| 6/28/2018 | 2.0 | - Updated to align with the change of the | +| | | ‘measurementsForVfScaling’ domain to ‘measurement’| +| | | | +| | | - measurementsForVfScaling measurement | +| | | | +| | | - measurementsForVfScalingFields measurementFields| +| | | | +| | | - measurementsForVfScalingVersion | +| | | measurementFieldsVersion | +| | | | +| | | - the ‘mfvs’ abbreviation measurement | +| | | | +| | | 1. Clarified YAML file naming. | +| | | | +| | | 2. Clarified the Action keyword. | +| | | | +| | | 3. Added an aggregationRole keyword. | +| | | | +| | | 4. Added a castTo keyword. | +| | | | +| | | 5. Added an isHomogeneous keyword. | +| | | | +| | | 6. Added a 'key' keyword | +| | | | +| | | 7. Add a 'keyValuePair' keyword | +| | | | +| | | 8. Modified the existing 'keyValuePairString' | +| | | keyword description to reference the | +| | | 'keyValuePair' keyword. | +| | | | +| | | 9. Added a section on Complex Conditions and | +| | | modified the Rules section | +| | | | +| | | 10. Modified the Examples as follows: | +| | | | +| | | - changed ‘faultFieldsVersion’ to 3.0 | +| | | | +| | | - changed ‘heartbeatFieldsVersion’ to 2.0 | +| | | | +| | | - provided guidance at the top of the Measurements | +| | | examples as to how to send extensible fields | +| | | through arrayOfNamedHashMap in a way that will | +| | | eliminate the need for custom development at the | +| | | service provider. | +| | | | +| | | - changed ‘measurementFieldsVersion’ to 3.0 | +| | | | +| | | - changed measurementFields.additionalMeasurements | +| | | to reference a ‘namedHashMap’ | +| | | | +| | | - ‘field’ is replaced by ‘keyValuePair’ | +| | | | +| | | - ‘name’ is replaced by ‘key’ | +| | | | +| | | - changed ‘namedArrayOfFields’ to ‘namedHashMap’ | +| | | | +| | | - fixed the mobile Flow example to show the | +| | | ‘mobileFlowFields’, show the | +| | | ‘mobileFlowFieldsVersion’ at 3.0, modify | +| | | ‘additionalInformation’ to use a hashMap | +| | | | +| | | - ‘field’ is replaced by ‘keyValuePair’ | +| | | | +| | | - ‘name’ is replaced by ‘key’ | +| | | | +| | | - changed ‘sipSignalingFieldsVersion’ to 2.0 | +| | | | +| | | - changed ‘additionalInformation’ to use a hashmap | +| | | | +| | | - ‘field’ is replaced by ‘keyValuePair’ | +| | | | +| | | - ‘name’ is replaced by ‘key’ | +| | | | +| | | - fixed the voiceQuality example to show the | +| | | ‘voiceQualityFields’, show the | +| | | ‘voiceQualityFieldsVersion’ at 2.0 and modify | +| | | ‘additionalInformation’ to use a hashMap | +| | | | +| | | - ‘field’ is replaced by ‘keyValuePair’ | +| | | | +| | | - ‘name’ is replaced by ‘key’ | +| | | | +| | | - Modified the rules example to conform to the | +| | | Complex Conditions and Rules sections. | +| | | | +| | | - Numerous clarifications made to address issues | +| | | with previous drafts of this version including: | +| | | | +| | | - Fixed arrays followed by other than square | +| | | brackets | +| | | | +| | | - Section 2.2: clarified format of v# in filename | +| | | | +| | | - Section 3.1.11: clarified use of camel casing | +| | | | +| | | - Section 3.2.1: corrected and clarified | +| | | | +| | | - Section 3.2.3 Clarified number of conditions | +| | | that may be and’d or or’d | +| | | | +| | | - Section 3.2.4: fixed reference to PersistentB1 | +| | | | +| | | - Section 3.2.6: fixed math in example | +| | | | +| | | - Section 3.3.2: changed reference from ‘alerts’ to | +| | | ‘events’ | ++------------+----------+-----------------------------------------------------+ +| 7/30/2018 | 3.0 | - Removed the isHomogeneous keyword. | +| | | | +| | | - Modified the types of aggregationRoles. | +| | | | +| | | - Clarified castTo | +| | | | +| | | - Added comment keyword | ++------------+----------+-----------------------------------------------------+ +| 9/14/2018 | 3.1 | - Added keywords: CastTo, Comment, Aggregation Role.| +| | | These were modified versions of the keywords | +| | | already defined in version 3.0. | ++------------+----------+-----------------------------------------------------+ +| 12/10/2018 | 3.2 | - Added the PM Data Dictionary and FM Meta Data | +| | | sections. | +| | | | +| | | - Changed the location of the doc to VNF | +| | | Requirements and changed the formatting | ++------------+----------+-----------------------------------------------------+ + |