diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Chapter8/VES_Registraion_3_2.rst | 3770 | ||||
| -rw-r--r-- | docs/Chapter8/ves7_1spec.rst | 7805 |
2 files changed, 6554 insertions, 5021 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 | ++------------+----------+-----------------------------------------------------+ + diff --git a/docs/Chapter8/ves7_1spec.rst b/docs/Chapter8/ves7_1spec.rst index 8ad48f2..32f186f 100644 --- a/docs/Chapter8/ves7_1spec.rst +++ b/docs/Chapter8/ves7_1spec.rst @@ -8,16 +8,21 @@ Service: VES Event Listener 7.1 ------------------------------- -+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **Legal Disclaimer** | -| | -| Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at | -| | -| http://www.apache.org/licenses/LICENSE-2.0 | -| | -| Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. | -+=====================================================================================================================================================================================================================================================================================================================+ -+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------------------------------+ +| **Legal Disclaimer** | +| | +| Licensed under the Apache License, Version 2.0 (the "License"); you may not | +| use this file except in compliance with the License. You may obtain a copy | +| of the License at | +| | +| http://www.apache.org/licenses/LICENSE-2.0 | +| | +| Unless required by applicable law or agreed to in writing, software | +| distributed under the License is distributed on an "AS IS" BASIS, WITHOUT | +| WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the | +| License for the specific language governing permissions and limitations | +| under the License. | ++-----------------------------------------------------------------------------+ :Document: VES Event Listner @@ -182,21 +187,19 @@ case of certain heartbeats). Examples of eventNames following the naming standards are provided below: -- Tca\_Vdbe-Ericsson\_CpuThresholdExceeded +- Tca\_Vdbe-Ericsson\_CpuThresholdExceeded -- Heartbeat\_Visbc:Mmc-Metaswitch +- Heartbeat\_Visbc:Mmc-Metaswitch -- Syslog\_Vdbe-Ericsson +- Syslog\_Vdbe-Ericsson -- Fault\_MobileCallRecording\_PilotNumberPoolExhaustion +- Fault\_MobileCallRecording\_PilotNumberPoolExhaustion -- Other\_So:WanBonding\_InstantiationPart1Complete +- Other\_So:WanBonding\_InstantiationPart1Complete EventId Use Cases Examples ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -[Author: Alok Gupta]: - eventId Examples: Example 1: assumes a unique key for each domain consisting of domain @@ -290,17 +293,17 @@ Syslogs ~~~~~~~~ Syslog’s can be classified as either Control or Session/Traffic. They -differ by message content and expected volume: +differ by message content and expected volume: -- Control logs are generally free-form human-readable text used for - reporting errors or warnings supporting the operation and - troubleshooting of NFs. The volume of these logs is typically less - than 2k per day. +- Control logs are generally free-form human-readable text used for + reporting errors or warnings supporting the operation and + troubleshooting of NFs. The volume of these logs is typically less + than 2k per day. -- Session logs use common structured fields to report normal NF - processing such as DNS lookups or firewall rules processed. The - volume of these logs is typically greater than 1k per hour (and - sometimes as high as 10k per second). +- Session logs use common structured fields to report normal NF + processing such as DNS lookups or firewall rules processed. The + volume of these logs is typically greater than 1k per hour (and + sometimes as high as 10k per second). VES supports both classes of syslog, however VES is only recommended for control logs or for lower volume session logs, less than 60k per hour. @@ -320,30 +323,30 @@ Versioning Three types of version numbers supported by this specification: -- The API specification itself is versioned. Going forward, the major - number of the specification version will be incremented whenever any - change could break an existing client (e.g., a field name is deleted - or changed). All other changes to the spec (e.g., a field name is - added, or text changes are made to the specification itself) will - increment only the minor number or patch number. Note that the major - number appears in REST resource URLs as v# (where ‘#’ is the major - number). Minor and patch numbers are communicated in HTTP headers. - For more information, see the API Versioning writeup in section 6.1. - -- The JSON schema is versioned. Going forward, the major number of the - JSON schema will be incremented whenever any change could break an - existing client (e.g., a field name is deleted or changed). All other - changes to the schema (e.g., a field name is added or text changes - are made to the field descriptions) will increment only the minor - number or patch number. - -- The field blocks are versioned. Field blocks include the - commonEventHeader and the domain blocks (e.g., the faultFields - block). Going forward, the major number of each field block will be - incremented whenever any change to that block could break an existing - client (e.g., a field name is deleted or changed). All other changes - to that block (e.g., a field name is added or text changes are made - to the field descriptions) will increment only the minor number. +- The API specification itself is versioned. Going forward, the major + number of the specification version will be incremented whenever any + change could break an existing client (e.g., a field name is deleted + or changed). All other changes to the spec (e.g., a field name is + added, or text changes are made to the specification itself) will + increment only the minor number or patch number. Note that the major + number appears in REST resource URLs as v# (where ‘#’ is the major + number). Minor and patch numbers are communicated in HTTP headers. + For more information, see the API Versioning writeup in section 6.1. + +- The JSON schema is versioned. Going forward, the major number of the + JSON schema will be incremented whenever any change could break an + existing client (e.g., a field name is deleted or changed). All other + changes to the schema (e.g., a field name is added or text changes + are made to the field descriptions) will increment only the minor + number or patch number. + +- The field blocks are versioned. Field blocks include the + commonEventHeader and the domain blocks (e.g., the faultFields + block). Going forward, the major number of each field block will be + incremented whenever any change to that block could break an existing + client (e.g., a field name is deleted or changed). All other changes + to that block (e.g., a field name is added or text changes are made + to the field descriptions) will increment only the minor number. Field Block Versions +++++++++++++++++++++ @@ -351,39 +354,39 @@ Field Block Versions A summary of the latest field block version enums as of this version of the API spec is provided below: -- commonEventHeader version 4.1 (note: the enum with support 4.0, - 4.0.1, 4.1 to avoid breaking clients of earlier versions of major - version 4) +- commonEventHeader version 4.1 (note: the enum with support 4.0, + 4.0.1, 4.1 to avoid breaking clients of earlier versions of major + version 4) -- commonEventHeader vesEventListenerVersion enum: 7.1 (note: the enum - will support 7.0, 7.0.1, 7.1 to avoid breaking clients of earlier - versions of major version 7) +- commonEventHeader vesEventListenerVersion enum: 7.1 (note: the enum + will support 7.0, 7.0.1, 7.1 to avoid breaking clients of earlier + versions of major version 7) -- faultFieldsVersion:4.0 +- faultFieldsVersion:4.0 -- heartbeatFieldsVersion: 3.0 +- heartbeatFieldsVersion: 3.0 -- measurementFieldsVersion: 4.0 +- measurementFieldsVersion: 4.0 -- mobileFlowFieldsVersion: 4.0 +- mobileFlowFieldsVersion: 4.0 -- notificationFieldsVersion: 2.0 +- notificationFieldsVersion: 2.0 -- otherFieldsVersion: 3.0 +- otherFieldsVersion: 3.0 -- perf3gppFieldsVersion: 1.0 +- perf3gppFieldsVersion: 1.0 -- pnfRegistrationFieldsVersion: 2.0 +- pnfRegistrationFieldsVersion: 2.0 -- sigSignalingFieldsVersion: 3.0 +- sigSignalingFieldsVersion: 3.0 -- stateChangeFieldsVersion: 4.0 +- stateChangeFieldsVersion: 4.0 -- syslogFieldsVersion: 4.0 +- syslogFieldsVersion: 4.0 -- thresholdCrossingFieldsVersion: 4.0 +- thresholdCrossingFieldsVersion: 4.0 -- voiceQualityFieldsVersion: 4.0 +- voiceQualityFieldsVersion: 4.0 Security ^^^^^^^^ @@ -420,60 +423,60 @@ Sample Request and Response Sample Request ++++++++++++++ -+-----------------------------------------------------------------+ -| POST /eventListener/v7 HTTP/1.1 | -| | -| Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== | -| | -| content-type: application/json | -| | -| | content-length: 12345 | -| | { | -| | -| "event": { | -| | -| "commonEventHeader": { | -| | -| "version": "4.1", | -| | -| "vesEventListenerVersion": "7.1", | -| | -| "domain": "heartbeat", | -| | -| "eventName": "Heartbeat\_vIsbcMmc", | -| | -| "eventId": "heartbeat0000249", | -| | -| "sequence": 0, | -| | -| "priority": "Normal", | -| | -| "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234", | -| | -| "reportingEntityName": "ibcx0001vm002oam001", | -| | -| "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014", | -| | -| "sourceName": "ibcx0001vm002ssc001", | -| | -| "nfVendorName": "Ericsson", | -| | -| "nfNamingCode": "ibcx", | -| | -| "nfcNamingCode": "ssc", | -| | -| "startEpochMicrosec": 1413378172000000, | -| | -| "lastEpochMicrosec": 1413378172000000, | -| | -| "timeZoneOffset": "UTC-05:30" | -| | -| } | -| | -| } | -| | -| } | -+-----------------------------------------------------------------+ ++-------------------------------------------------------------------------+ +| POST /eventListener/v7 HTTP/1.1 | +| | +| Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== | +| | +| content-type: application/json | +| | +| | content-length: 12345 | +| | { | +| | +| "event": { | +| | +| "commonEventHeader": { | +| | +| "version": "4.1", | +| | +| "vesEventListenerVersion": "7.1", | +| | +| "domain": "heartbeat", | +| | +| "eventName": "Heartbeat_vIsbcMmc", | +| | +| "eventId": "heartbeat0000249", | +| | +| "sequence": 0, | +| | +| "priority": "Normal", | +| | +| "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234", | +| | +| "reportingEntityName": "ibcx0001vm002oam001", | +| | +| "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014", | +| | +| "sourceName": "ibcx0001vm002ssc001", | +| | +| "nfVendorName": "Ericsson", | +| | +| "nfNamingCode": "ibcx", | +| | +| "nfcNamingCode": "ssc", | +| | +| "startEpochMicrosec": 1413378172000000, | +| | +| "lastEpochMicrosec": 1413378172000000, | +| | +| "timeZoneOffset": "UTC-05:30" | +| | +| } | +| | +| } | +| | +| } | ++-------------------------------------------------------------------------+ Sample Success Response ++++++++++++++++++++++++ @@ -558,11 +561,11 @@ The arrayOfJsonObject datatype provides an array of json objects, each of which is describ ed by name, schema and other meta-information. It consists of the following fields: -+---------------------+------------------+-------------+-----------------------+ -| Field | Type | Required? | Description | -+=====================+==================+=============+=======================+ -| arrayOfJsonObject | jsonObject [ ] | Yes | Array of jsonObject | -+---------------------+------------------+-------------+-----------------------+ ++---------------------+------------------+----------+----------------------+ +| Field | Type | Required?| Description | ++=====================+==================+==========+======================+ +| arrayOfJsonObject | jsonObject [ ] | Yes | Array of jsonObject | ++---------------------+------------------+----------+----------------------+ Datatype: arrayOfNamedHashMap ++++++++++++++++++++++++++++++ @@ -571,11 +574,11 @@ The arrayOfNamedHashMap datatype provides an array of hashMaps, each of which is associated with a descriptive name. It consists of the following fields: -+-----------------------+--------------------+-------------+-------------------------+ -| Field | Type | Required? | Description | -+=======================+====================+=============+=========================+ -| arrayOfNamedHashMap | namedHashMap [ ] | Yes | Array of namedHashMap | -+-----------------------+--------------------+-------------+-------------------------+ ++---------------------+------------------+-----------+-----------------------+ +| Field | Type | Required? | Description | ++=====================+==================+===========+=======================+ +| arrayOfNamedHashMap | namedHashMap [ ] | Yes | Array of namedHashMap | ++---------------------+------------------+-----------+-----------------------+ Datatype: event ++++++++++++++++ @@ -583,46 +586,59 @@ Datatype: event The event datatype consists of the following fields which constitute the ‘root level’ of the common event format: -+--------------------------------+--------------------------------+-------------+------------------------------------------------------+ -| Field | Type | Required? | Description | -+================================+================================+=============+======================================================+ -| commonEventHeader | commonEventHeader | Yes | Fields common to all events | -+--------------------------------+--------------------------------+-------------+------------------------------------------------------+ -| faultFields | faultFields | No | Fields specific to fault events | -+--------------------------------+--------------------------------+-------------+------------------------------------------------------+ -| heartbeatFields | heartbeatFields | No | Fields specific to heartbeat events | -+--------------------------------+--------------------------------+-------------+------------------------------------------------------+ -| measurementFields | measurementFields | No | Fields specific to measurement events | -+--------------------------------+--------------------------------+-------------+------------------------------------------------------+ -| mobileFlowFields | mobileFlowFields | No | Fields specific to mobility flow events | -+--------------------------------+--------------------------------+-------------+------------------------------------------------------+ -| notificationFields | notificationFields | No | Fields specific to notification events | -+--------------------------------+--------------------------------+-------------+------------------------------------------------------+ -| otherFields | otherFields | No | Fields specific to other types of events | -+--------------------------------+--------------------------------+-------------+------------------------------------------------------+ -| pnfRegistrationFields | pnfRegistrationFields | No | Fields specific to pnfRegistration events | -+--------------------------------+--------------------------------+-------------+------------------------------------------------------+ -| sipSignalingFields | sipSignalingFields | No | Fields specific to sipSignaling events | -+--------------------------------+--------------------------------+-------------+------------------------------------------------------+ -| stateChangeFields | stateChangeFields | No | Fields specific to state change events | -+--------------------------------+--------------------------------+-------------+------------------------------------------------------+ -| syslogFields | syslogFields | No | Fields specific to syslog events | -+--------------------------------+--------------------------------+-------------+------------------------------------------------------+ -| thresholdCrossingAlertFields | thresholdCrossingAlertFields | No | Fields specific to threshold crossing alert events | -+--------------------------------+--------------------------------+-------------+------------------------------------------------------+ -| voiceQualityFields | voiceQualityFields | No | Fields specific to voiceQuality events | -+--------------------------------+--------------------------------+-------------+------------------------------------------------------+ ++--------------+--------------+-----------+-----------------------------------+ +| Field | Type | Required? | Description | ++==============+==============+===========+===================================+ +| commonEvent\ | commonEvent\ | Yes | Fields common to all events | +| Header | Header | | | ++--------------+--------------+-----------+-----------------------------------+ +| faultFields | faultFields | No | Fields specific to fault events | ++--------------+--------------+-----------+-----------------------------------+ +| heartbeat\ | heartbeat\ | No | Fields specific to heartbeat | +| Fields | Fields | | events | ++--------------+--------------+-----------+-----------------------------------+ +| measurement\ | measurement\ | No | Fields specific to measurement | +| Fields | Fields | | events | ++--------------+--------------+-----------+-----------------------------------+ +| mobileFlow\ | mobileFlow\ | No | Fields specific to mobility flow | +| Fields | Fields | | events | ++--------------+--------------+-----------+-----------------------------------+ +| notification\| notification\| No | Fields specific to notification | +| Fields | Fields | | events | ++--------------+--------------+-----------+-----------------------------------+ +| otherFields | otherFields | No | Fields specific to other types of | +| | | | events | ++--------------+--------------+-----------+-----------------------------------+ +| pnf\ | pnf\ | No | Fields specific to pnfRegistration| +| Registration\| Registration\| | events | +| Fields | Fields | | | ++--------------+--------------+-----------+-----------------------------------+ +| sipSignaling\| sipSignaling\| No | Fields specific to sipSignaling | +| Fields | Fields | | events | ++--------------+--------------+-----------+-----------------------------------+ +| stateChange\ | stateChange\ | No | Fields specific to state change | +| Fields | Fields | | events | ++--------------+--------------+-----------+-----------------------------------+ +| syslogFields | syslogFields | No | Fields specific to syslog events | ++--------------+--------------+-----------+-----------------------------------+ +| threshold\ | threshold\ | No | Fields specific to threshold | +| Crossing\ | Crossing\ | | crossing alert events | +| AlertFields | AlertFields | | | ++--------------+--------------+-----------+-----------------------------------+ +| voiceQuality\| voiceQuality\| No | Fields specific to voiceQuality | +| Fields | Fields | | events | ++--------------+--------------+-----------+-----------------------------------+ Datatype: eventList ++++++++++++++++++++ The eventList datatype consists of the following fields: -+-------------+-------------+-------------+-------------------+ -| Field | Type | Required? | Description | -+=============+=============+=============+===================+ -| eventList | event [ ] | Yes | Array of events | -+-------------+-------------+-------------+-------------------+ ++-------------+-------------+----------+-------------------+ +| Field | Type | Required?| Description | ++=============+=============+==========+===================+ +| eventList | event [ ] | Yes | Array of events | ++-------------+-------------+----------+-------------------+ Datatype: hashMap +++++++++++++++++++ @@ -639,21 +655,29 @@ The jsonObject datatype provides a json object schema, name and other meta-information along with one or more object instances that conform to the schema: -+--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+==========================+==========================+=============+===========================================================================================================================================================================+ -| objectInstances | JsonObjectInstance [ ] | Yes | Contains one or more instances of the json object | -+--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| objectName | string | Yes | Name of the json object | -+--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| objectSchema | string | No | json schema for the object | -+--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| objectSchemaUrl | string | No | URL to the json schema for the object | -+--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| nfSubscribedObjectName | string | No | Name of the object associated with the nfSubscriptionId | -+--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| nfSubscriptionId | string | No | Identifies an openConfig telemetry subscription on a network function, which configures the network function to send complex object data associated with the jsonObject | -+--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------+--------------+-----------+----------------------------------+ +| Field | Type | Required? | Description | ++==============+==============+===========+==================================+ +| object\ | JsonObject\ | Yes | Contains one or more instances of| +| Instances | Instance [ ] | | the json object | ++--------------+--------------+-----------+----------------------------------+ +| objectName | string | Yes | Name of the json object | ++--------------+--------------+-----------+----------------------------------+ +| objectSchema | string | No | json schema for the object | ++--------------+--------------+-----------+----------------------------------+ +| objectSchema\| string | No | URL to the json schema for the | +| Url | | | object | ++--------------+--------------+-----------+----------------------------------+ +| nfSubscribed\| string | No | Name of the object associated | +| ObjectName | | | with the nfSubscriptionId | ++--------------+--------------+-----------+----------------------------------+ +| nf\ | string | No | Identifies an openConfig | +| Subscription\| | | telemetry subscription on a | +| Id | | | network function, which | +| | | | configures the network function | +| | | | to send complex object data | +| | | | associated with the jsonObject | ++--------------+--------------+-----------+----------------------------------+ Datatype: jsonObjectInstance +++++++++++++++++++++++++++++ @@ -661,17 +685,26 @@ Datatype: jsonObjectInstance The jsonObjectInstance datatype provides meta-information about an instance of a jsonObject along with the actual object instance: -+-------------------------------+--------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+===============================+==============+=============+===========================================================================================================================================+ -| jsonObject | jsonObject | No | Optional recursive specification of jsonObject | -+-------------------------------+--------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| objectInstance | object | No | Contains an instance conforming to the jsonObject schema | -+-------------------------------+--------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| objectInstanceEpochMicrosec | number | No | the unix time, aka epoch time, associated with this objectInstance--as microseconds elapsed since 1 Jan 1970 not including leap seconds | -+-------------------------------+--------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| objectKeys | key [ ] | No | An ordered set of keys that identifies this particular instance of jsonObject (e.g., that places it in a hierarchy) | -+-------------------------------+--------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------+------------+----------+-----------------------------------+ +| Field | Type | Required?| Description | ++================+============+==========+===================================+ +| jsonObject | jsonObject | No | Optional recursive specification | +| | | | of jsonObject | ++----------------+------------+----------+-----------------------------------+ +| objectInstance | object | No | Contains an instance conforming to| +| | | | the jsonObject schema | ++----------------+------------+----------+-----------------------------------+ +| objectInstance\| number | No | the unix time, aka epoch time, | +| EpochMicrosec | | | associated with this | +| | | | objectInstance--as microseconds | +| | | | elapsed since 1 Jan 1970 not | +| | | | including leap seconds | ++----------------+------------+----------+-----------------------------------+ +| objectKeys | key [ ] | No | An ordered set of keys that | +| | | | identifies this particular | +| | | | instance of jsonObject (e.g., that| +| | | | places it in a hierarchy) | ++----------------+------------+----------+-----------------------------------+ Datatype: key +++++++++++++++ @@ -679,15 +712,16 @@ Datatype: key The key datatype is a tuple which provides the name of a key along with its value and relative order; it consists of the following fields: -+------------+-----------+-------------+----------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+============+===========+=============+======================================================================+ -| keyName | string | Yes | Name of the key | -+------------+-----------+-------------+----------------------------------------------------------------------+ -| keyOrder | Integer | No | Relative sequence or order of the key (with respect to other keys) | -+------------+-----------+-------------+----------------------------------------------------------------------+ -| keyValue | string | No | Value of the key | -+------------+-----------+-------------+----------------------------------------------------------------------+ ++----------+---------+-----------+-------------------------------------------+ +| Field | Type | Required? | Description | ++==========+=========+===========+===========================================+ +| keyName | string | Yes | Name of the key | ++----------+---------+-----------+-------------------------------------------+ +| keyOrder | Integer | No | Relative sequence or order of the key | +| | | | (with respect to other keys) | ++----------+---------+-----------+-------------------------------------------+ +| keyValue | string | No | Value of the key | ++----------+---------+-----------+-------------------------------------------+ Datatype: namedHashMap ++++++++++++++++++++++++ @@ -695,13 +729,14 @@ Datatype: namedHashMap The namedHashMap datatype is a hashMap which is associated with and described by a name; it consists of the following fields: -+-----------+-----------+-------------+--------------------------------------------------+ -| Field | Type | Required? | Description | -+===========+===========+=============+==================================================+ -| name | string | Yes | Name associated with or describing the hashmap | -+-----------+-----------+-------------+--------------------------------------------------+ -| hashMap | hashMap | Yes | One or more key:value pairs | -+-----------+-----------+-------------+--------------------------------------------------+ ++---------+---------+-----------+--------------------------------------------+ +| Field | Type | Required? | Description | ++=========+=========+===========+============================================+ +| name | string | Yes | Name associated with or describing the | +| | | | hashmap | ++---------+---------+-----------+--------------------------------------------+ +| hashMap | hashMap | Yes | One or more key:value pairs | ++---------+---------+-----------+--------------------------------------------+ Datatype: requestError +++++++++++++++++++++++ @@ -709,17 +744,29 @@ Datatype: requestError The requestError datatype defines the standard request error data structure: -+-------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+=============+==========+=============+================================================================================================================================================================================================================================================================================================+ -| messageId | string | Yes | Unique message identifier of the format ‘ABCnnnn’ where ‘ABC’ is either ‘SVC’ for Service Exceptions or ‘POL’ for Policy Exception. Exception numbers may be in the range of 0001 to 9999 where 0001 to 2999 are defined by OMA (see section 5.1) and 3000-9999 are available and undefined. | -+-------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| text | string | Yes | Message text, with replacement variables marked with %n, where n is an index into the list of <variables> elements, starting at 1 | -+-------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| url | string | No | Hyperlink to a detailed error resource e.g., an HTML page for browser user agents | -+-------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| variables | string | No | List of zero or more strings that represent the contents of the variables used by the message text | -+-------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------+--------+-----------+-------------------------------------------+ +| Field | Type | Required? | Description | ++===========+========+===========+===========================================+ +| messageId | string | Yes | Unique message identifier of the format | +| | | | ‘ABCnnnn’ where ‘ABC’ is either ‘SVC’ for | +| | | | Service Exceptions or ‘POL’ for Policy | +| | | | Exception. Exception numbers may be in the| +| | | | range of 0001 to 9999 where 0001 to 2999 | +| | | | are defined by OMA (see section 5.1) and | +| | | | 3000-9999 are available and undefined. | ++-----------+--------+-----------+-------------------------------------------+ +| text | string | Yes | Message text, with replacement variables | +| | | | marked with %n, where n is an index into | +| | | | the list of <variables> elements, starting| +| | | | at 1 | ++-----------+--------+-----------+-------------------------------------------+ +| url | string | No | Hyperlink to a detailed error resource | +| | | | e.g., an HTML page for browser user agents| ++-----------+--------+-----------+-------------------------------------------+ +| variables | string | No | List of zero or more strings that | +| | | | represent the contents of the variables | +| | | | used by the message text | ++-----------+--------+-----------+-------------------------------------------+ Datatype: vendorNfNameFields +++++++++++++++++++++++++++++ @@ -727,15 +774,17 @@ Datatype: vendorNfNameFields The vendorNfNameFields provides vendor, nf and nfModule identifying information: -+----------------+----------+-------------+-----------------------------------------------------+ -| Field | Type | Required? | Description | -+================+==========+=============+=====================================================+ -| vendorName | string | Yes | Network function vendor name | -+----------------+----------+-------------+-----------------------------------------------------+ -| nfModuleName | string | No | Name of the nfModule generating the event | -+----------------+----------+-------------+-----------------------------------------------------+ -| nfName | string | No | Name of the network function generating the event | -+----------------+----------+-------------+-----------------------------------------------------+ ++--------------+--------+-----------+----------------------------------------+ +| Field | Type | Required? | Description | ++==============+========+===========+========================================+ +| vendorName | string | Yes | Network function vendor name | ++--------------+--------+-----------+----------------------------------------+ +| nfModuleName | string | No | Name of the nfModule generating the | +| | | | event | ++--------------+--------+-----------+----------------------------------------+ +| nfName | string | No | Name of the network function generating| +| | | | the event | ++--------------+--------+-----------+----------------------------------------+ ‘Common Event Header’ Datatypes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -746,47 +795,149 @@ Datatype: commonEventHeader The commonEventHeader datatype consists of the following fields common to all events: -+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | | -+===========================+=========================+=============+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ -| domain | string | Yes | Event domain enumeration: ‘fault’, ‘heartbeat’, ‘measurement’, ‘mobileFlow’, ‘notification’, ‘other’, ‘perf3gpp’, ‘pnfRegistration’, ‘sipSignaling’, ‘stateChange’, ‘syslog’, ‘thresholdCrossingAlert’, ‘voiceQuality’ | -+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| eventId | string | Yes | Event key that is unique to the event source. The key must be unique within notification life cycle similar to EventID from 3GPP. It could be a sequential number, or a composite key formed from the event fields, such as domain\_sequence. The eventId should not include whitespace. For fault events, eventId is the eventId of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, eventId must be the same as the initial alarm (along with the same startEpochMicrosec but with a different sequence number). Note: see section 1.3 for eventId use case examples. | -+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| eventName | string | Yes | | -+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| eventType | string | No | | -+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| internalHeader Fields | internalHeader Fields | No | Fields (not supplied by event sources) that the VES Event Listener service can use to enrich the event if needed for efficient internal processing. This is an empty object which is intended to be defined separately by each service provider (e.g., AT&T) implementing the VES Event Listener. | -+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| lastEpochMicrosec | number | Yes | the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds | -+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| nfcNamingCode | string | No | Network function component type: 3 characters (aligned with vfc naming standards) | -+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| nfNamingCode | string | No | Network function type: 4 characters (aligned with vnf and pnf naming standards) | -+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| nfVendorName | string | No | | -+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| priority | string | Yes | | -+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| reportingEntityId | string | No | UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See ‘reportingEntityName’ for more information. | -+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| reportingEntityName | string | Yes | Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. | -+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| sequence | integer | Yes | Ordering of events communicated by an event source instance (or 0 if not needed) | -+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| sourceId | string | No | UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See ‘sourceName’ for more information. | -+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| sourceName | string | Yes | Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNF (vnf or pnf), xNFC or VM, then the event must be reporting data for that particular xNF, xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. | -+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| startEpochMicrosec | number | Yes | the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) | -+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| timeZoneOffset | string | No | Offset to GMT to indicate local time zone for device formatted as ‘UTC+/-hh:mm’; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples | -+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| version | string | Yes | Version of the event header as “#.#” where # is a digit; see section 1 for the correct digits to use. | -+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| vesEventListenerVersion | string | Yes | Version of the ves event listener api spec that this event is compliant with (as “#” or “#.#” or “#.#.#” where # is a digit; see section 1 for the correct digits to use). | -+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------+----------+-----------+-----------------------------------------+ +| Field | Type | Required? | Description | ++===========+==========+===========+=========================================+ +| domain | string | Yes | Event domain enumeration: ‘fault’, | +| | | | ‘heartbeat’, ‘measurement’, ‘mobileFlow’| +| | | | , ‘notification’, ‘other’, ‘perf3gpp’, | +| | | | ‘pnfRegistration’, ‘sipSignaling’, | +| | | | ‘stateChange’, ‘syslog’, | +| | | | ‘thresholdCrossingAlert’, ‘voiceQuality’| ++-----------+----------+-----------+-----------------------------------------+ +| eventId | string | Yes | Event key that is unique to the event | +| | | | source. The key must be unique within | +| | | | notification life cycle similar to | +| | | | EventID from 3GPP. It could be a | +| | | | sequential number, or a composite key | +| | | | formed from the event fields, such as | +| | | | domain\_sequence. The eventId should not| +| | | | include whitespace. For fault events, | +| | | | eventId is the eventId of the initial | +| | | | alarm; if the same alarm is raised again| +| | | | for changed, acknowledged or cleared | +| | | | cases, eventId must be the same as the | +| | | | initial alarm (along with the same | +| | | | startEpochMicrosec but with a different | +| | | | sequence number). Note: see section 1.3 | +| | | | for eventId use case examples. | ++-----------+----------+-----------+-----------------------------------------+ +| eventName | string | Yes | | ++-----------+----------+-----------+-----------------------------------------+ +| eventType | string | No | | ++-----------+----------+-----------+-----------------------------------------+ +| internal\ | internal\| No | Fields (not supplied by event sources) | +| Header | Header | | that the VES Event Listener service can | +| Fields | Fields | | use to enrich the event if needed for | +| | | | efficient internal processing. This is | +| | | | an empty object which is intended to be | +| | | | defined separately by each service | +| | | | provider (e.g., AT&T) implementing the | +| | | | VES Event Listener. | ++-----------+----------+-----------+-----------------------------------------+ +| lastEpoch\| number | Yes | the latest unix time aka epoch time | +| Microsec | | | associated with the event from any | +| | | | component--as microseconds elapsed since| +| | | | 1 Jan 1970 not including leap seconds | ++-----------+----------+-----------+-----------------------------------------+ +| nfcNaming\| string | No | Network function component type: 3 | +| Code | | | characters (aligned with vfc naming | +| | | | standards) | ++-----------+----------+-----------+-----------------------------------------+ +| nfNaming\ | string | No | Network function type: 4 characters | +| Code | | | (aligned with vnf and pnf naming | +| | | | standards) | ++-----------+----------+-----------+-----------------------------------------+ +| nfVendor\ | string | No | | +| Name | | | | ++-----------+----------+-----------+-----------------------------------------+ +| priority | string | Yes | | ++-----------+----------+-----------+-----------------------------------------+ +| reporting\| string | No | UUID identifying the entity reporting | +| EntityId | | | the event or detecting a problem in | +| | | | another vnf/vm or pnf which is | +| | | | experiencing the problem. (Note: the | +| | | | AT&T internal enrichment process shall | +| | | | ensure that this field is populated). | +| | | | The reportingEntityId is an id for the | +| | | | reportingEntityName. See | +| | | | ‘reportingEntityName’ for more | +| | | | information. | ++-----------+----------+-----------+-----------------------------------------+ +| reporting\| string | Yes | Name of the entity reporting the event | +| EntityName| | | or detecting a problem in another vnf/vm| +| | | | or pnf which is experiencing the | +| | | | problem. May be the same as the | +| | | | sourceName. For synthetic events | +| | | | generated by DCAE, it is the name of the| +| | | | app generating the event. | ++-----------+----------+-----------+-----------------------------------------+ +| sequence | integer | Yes | Ordering of events communicated by an | +| | | | event source instance (or 0 if not | +| | | | needed) | ++-----------+----------+-----------+-----------------------------------------+ +| sourceId | string | No | UUID identifying the entity experiencing| +| | | | the event issue, which may be detected | +| | | | and reported by a separate reporting | +| | | | entity (note: the AT&T internal | +| | | | enrichment process shall ensure that | +| | | | this field is populated). The sourceId | +| | | | is an id for the sourceName. See | +| | | | ‘sourceName’ for more information. | ++-----------+----------+-----------+-----------------------------------------+ +| sourceName| string | Yes | Name of the entity experiencing the | +| | | | event issue, which may be detected and | +| | | | reported by a separate reporting entity.| +| | | | The sourceName identifies the device for| +| | | | which data is collected. A valid | +| | | | sourceName must be inventoried in A&AI. | +| | | | If sourceName is a xNF (vnf or pnf), | +| | | | xNFC or VM, then the event must be | +| | | | reporting data for that particular xNF, | +| | | | xNFC or VM. If the sourceName is a xNF, | +| | | | comprised of multiple xNFCs, the data | +| | | | must be reported/aggregated at the xNF | +| | | | level. Data for individual xNFC must not| +| | | | be included in the xNF sourceName event.| ++-----------+----------+-----------+-----------------------------------------+ +| start\ | number | Yes | the earliest unix time aka epoch time | +| Epoch\ | | | associated with the event from any | +| Microsec | | | component--as microseconds elapsed since| +| | | | 1 Jan 1970 not including leap seconds. | +| | | | For measurements and heartbeats, where | +| | | | events are collected over predefined | +| | | | intervals, startEpochMicrosec shall be | +| | | | rounded to the nearest interval boundary| +| | | | (e.g., the epoch equivalent of 3:00PM, | +| | | | 3:10PM, 3:20PM, etc…). For fault events,| +| | | | startEpochMicrosec is the timestamp of | +| | | | the initial alarm; if the same alarm is | +| | | | raised again for changed, acknowledged | +| | | | or cleared cases, startEpoch Microsec | +| | | | must be the same as the initial alarm | +| | | | (along with the same eventId and an | +| | | | incremental sequence number). For | +| | | | devices with no timing source (clock), | +| | | | the default value will be 0 and the VES | +| | | | collector will replace it with Collector| +| | | | time stamp (when the event is received) | ++-----------+----------+-----------+-----------------------------------------+ +| timeZone\ | string | No | Offset to GMT to indicate local time | +| Offset | | | zone for device formatted as | +| | | | ‘UTC+/-hh:mm’; see | +| | | | time_zone_abbreviations_ for UTC offset | +| | | | examples | ++-----------+----------+-----------+-----------------------------------------+ +| version | string | Yes | Version of the event header as “#.#” | +| | | | where # is a digit; see section 1 for | +| | | | the correct digits to use. | ++-----------+----------+-----------+-----------------------------------------+ +| vesEvent\ | string | Yes | Version of the ves event listener api | +| Listener\ | | | spec that this event is compliant with | +| Version | | | (as “#” or “#.#” or “#.#.#” where # is a| +| | | | digit; see section 1 for the correct | +| | | | digits to use). | ++-----------+----------+-----------+-----------------------------------------+ Datatype: internalHeaderFields ++++++++++++++++++++++++++++++ @@ -811,33 +962,70 @@ Datatype: faultFields The faultFields datatype consists of the following fields: -+-------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+===============================+===========+=============+====================================================================================================================================================================================+ -| alarmAdditional Information | hashMap | No | Additional alarm information. | -| | | | | -| | | | - Note1: for SNMP mapping to VES, for hash key use OID of varbind, for value use incoming data for that varbind). | -| | | | | -| | | | - Note2: Alarm ID for 3GPP should be included (if applicable) in alarmAdditonalInformation as ‘alarmId’:’alarmIdValue’. | -| | | | | -| | | | Could contain managed object instance as separate key:value; could add probable cause as separate key:value. | -+-------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| alarmCondition | string | Yes | Short name of the alarm condition/problem, such as a trap name. Should not have white space (e.g., tpLgCgiNotInConfig, BfdSessionDown, linkDown, etc…) | -+-------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| alarmInterfaceA | string | No | Card, port, channel or interface name of the device generating the alarm. This could reflect managed object. | -+-------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| eventCategory | string | No | Event category, for example: ‘license’, ‘link’, ‘routing’, ‘security’, ‘signaling’ | -+-------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| eventSeverity | string | Yes | Event severity enumeration: ‘CRITICAL’, ‘MAJOR’, ‘MINOR’, ‘WARNING’, ‘NORMAL’. NORMAL is used to represent clear. | -+-------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| eventSourceType | string | Yes | Examples: ‘card’, ‘host’, ‘other’, ‘port’, ‘portThreshold’, ‘router’, ‘slotThreshold’, ‘switch’, ‘virtualMachine’, ‘virtualNetworkFunction’. This could be managed object class. | -+-------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| faultFieldsVersion | string | Yes | Version of the faultFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. | -+-------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| specificProblem | string | Yes | Description of the alarm or problem (e.g., ‘eNodeB 155197 in PLMN 310-410 with eNodeB name KYL05197 is lost’). 3GPP probable cause would be included in this field. | -+-------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| vfStatus | string | Yes | Virtual function status enumeration: ‘Active’, ‘Idle’, ‘Preparing to terminate’, ‘Ready to terminate’, ‘Requesting Termination’ | -+-------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------+---------+-----------+-------------------------------------+ +| Field | Type | Required? | Description | ++=================+=========+===========+=====================================+ +| alarmAdditional | hashMap | No | Additional alarm information. | +| Information | | | | +| | | | | +| | | | - Note1: for SNMP mapping to VES, | +| | | | for hash key use OID of varbind, | +| | | | for value use incoming data for | +| | | | that varbind). | +| | | | | +| | | | - Note2: Alarm ID for 3GPP should be| +| | | | included (if applicable) in | +| | | | alarmAdditonalInformation as | +| | | | ‘alarmId’:’alarmIdValue’. | +| | | | | +| | | | Could contain managed object | +| | | | instance as separate key:value; | +| | | | could add probable cause as separate| +| | | | key:value. | ++-----------------+---------+-----------+-------------------------------------+ +| alarmCondition | string | Yes | Short name of the alarm | +| | | | condition/problem, such as a trap | +| | | | name. Should not have white space | +| | | | (e.g., tpLgCgiNotInConfig, | +| | | | BfdSessionDown, linkDown, etc…) | ++-----------------+---------+-----------+-------------------------------------+ +| alarmInterfaceA | string | No | Card, port, channel or interface | +| | | | name of the device generating the | +| | | | alarm. This could reflect managed | +| | | | object. | ++-----------------+---------+-----------+-------------------------------------+ +| eventCategory | string | No | Event category, for example: | +| | | | ‘license’, ‘link’, ‘routing’, | +| | | | ‘security’, ‘signaling’ | ++-----------------+---------+-----------+-------------------------------------+ +| eventSeverity | string | Yes | Event severity enumeration: | +| | | | ‘CRITICAL’, ‘MAJOR’, ‘MINOR’, | +| | | | ‘WARNING’, ‘NORMAL’. NORMAL is used | +| | | | to represent clear. | ++-----------------+---------+-----------+-------------------------------------+ +| eventSourceType | string | Yes | Examples: ‘card’, ‘host’, ‘other’, | +| | | | ‘port’, ‘portThreshold’, ‘router’, | +| | | | ‘slotThreshold’, ‘switch’, | +| | | | ‘virtualMachine’, | +| | | | ‘virtualNetworkFunction’. This could| +| | | | be managed object class. | ++-----------------+---------+-----------+-------------------------------------+ +| faultFields\ | string | Yes | Version of the faultFields block as | +| Version | | | “#.#” where # is a digit; see | +| | | | section 1 for the correct digits to | +| | | | use. | ++-----------------+---------+-----------+-------------------------------------+ +| specificProblem | string | Yes | Description of the alarm or problem | +| | | | (e.g., ‘eNodeB 155197 in PLMN | +| | | | 310-410 with eNodeB name KYL05197 is| +| | | | lost’). 3GPP probable cause would be| +| | | | included in this field. | ++-----------------+---------+-----------+-------------------------------------+ +| vfStatus | string | Yes | Virtual function status enumeration:| +| | | | ‘Active’, ‘Idle’, ‘Preparing to | +| | | | terminate’, ‘Ready to terminate’, | +| | | | ‘Requesting Termination’ | ++-----------------+---------+-----------+-------------------------------------+ Heartbeat’ Domain Datatypes ++++++++++++++++++++++++++++ @@ -848,15 +1036,20 @@ Datatype: heartbeatFields The heartbeatFields datatype is an optional field block for fields specific to heartbeat events; it consists of the following fields: -+--------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+==========================+===========+=============+==================================================================================================================+ -| additionalFields | hashMap | No | Additional expansion fields if needed | -+--------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------+ -| heartbeatFieldsVersion | string | Yes | Version of the heartbeatFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. | -+--------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------+ -| heartbeatInterval | Integer | Yes | Current heartbeatInterval in seconds | -+--------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------+ ++---------------+---------+-----------+---------------------------------------+ +| Field | Type | Required? | Description | ++===============+=========+===========+=======================================+ +| additional\ | hashMap | No | Additional expansion fields if needed | +| Fields | | | | ++---------------+---------+-----------+---------------------------------------+ +| heartbeat\ | string | Yes | Version of the heartbeatFields block | +| FieldsVersion | | | as “#.#” where # is a digit; see | +| | | | section 1 for the correct digits to | +| | | | use. | ++---------------+---------+-----------+---------------------------------------+ +| heartbeat\ | Integer | Yes | Current heartbeatInterval in seconds | +| Interval | | | | ++---------------+---------+-----------+---------------------------------------+ ‘Measurements’ Domain Datatypes ++++++++++++++++++++++++++++++++ @@ -871,13 +1064,13 @@ The codecsInUse datatype consists of the following fields describing the number of times an identified codec was used over the measurementInterval: -+------------------+-----------+-------------+--------------------------------+ -| Field | Type | Required? | Description | -+==================+===========+=============+================================+ -| codecIdentifer | string | Yes | Description of the codec | -+------------------+-----------+-------------+--------------------------------+ -| numberInUse | integer | Yes | Number of such codecs in use | -+------------------+-----------+-------------+--------------------------------+ ++------------------+-----------+----------+--------------------------------+ +| Field | Type | Required?| Description | ++==================+===========+==========+================================+ +| codecIdentifer | string | Yes | Description of the codec | ++------------------+-----------+----------+--------------------------------+ +| numberInUse | integer | Yes | Number of such codecs in use | ++------------------+-----------+----------+--------------------------------+ Datatype: cpuUsage ******************* @@ -885,43 +1078,69 @@ Datatype: cpuUsage The cpuUsage datatype defines the usage of an identifier CPU and consists of the following fields: -+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+=========================+==========+=============+=====================================================================================================================================+ -| cpuCapacityContention | number | No | The amount of time the CPU cannot run due to contention, in milliseconds over the measurementInterval | -+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| cpuDemandAvg | number | No | The total CPU time that the NF/NFC/VM could use if there was no contention, in milliseconds over the measurementInterval | -+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| cpuDemandMhz | number | No | CPU demand in MHz | -+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| cpuDemandPct | number | No | CPU demand as a percentage of the provisioned capacity | -+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| cpuIdentifier | string | Yes | CPU Identifier | -+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| cpuIdle | number | No | Percentage of CPU time spent in the idle task | -+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| cpuLatencyAvg | number | No | Percentage of time the VM is unable to run because it is contending for access to the physical CPUs | -+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| cpuOverheadAvg | number | No | The overhead demand above available allocations and reservations, in milliseconds over the measurementInterval | -+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| cpuSwapWaitTime | number | No | Swap wait time, in milliseconds over the measurementInterval | -+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| cpuUsageInterrupt | number | No | Percentage of time spent servicing interrupts | -+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| cpuUsageNice | number | No | Percentage of time spent running user space processes that have been niced | -+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| cpuUsageSoftIrq | number | No | Percentage of time spent handling soft irq interrupts | -+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| cpuUsageSteal | number | No | Percentage of time spent in involuntary wait which is neither user, system or idle time and is effectively time that went missing | -+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| cpuUsageSystem | number | No | Percentage of time spent on system tasks running the kernel | -+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| cpuUsageUser | number | No | Percentage of time spent running un-niced user space processes | -+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| cpuWait | number | No | Percentage of CPU time spent waiting for I/O operations to complete | -+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| percentUsage | number | Yes | Aggregate cpu usage of the virtual machine on which the xNFC reporting the event is running | -+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ ++------------+--------+-----------+-------------------------------------------+ +| Field | Type | Required? | Description | ++============+========+===========+===========================================+ +| cpu\ | number | No | The amount of time the CPU cannot run due | +| Capacity\ | | | to contention, in milliseconds over the | +| Contention | | | measurementInterval | ++------------+--------+-----------+-------------------------------------------+ +| cpu\ | number | No | The total CPU time that the NF/NFC/VM | +| Demand\ | | | could use if there was no contention, in | +| Avg | | | milliseconds over the measurementInterval | ++------------+--------+-----------+-------------------------------------------+ +| cpu\ | number | No | CPU demand in MHz | +| Demand\ | | | | +| Mhz | | | | ++------------+--------+-----------+-------------------------------------------+ +| cpu\ | number | No | CPU demand as a percentage of the | +| Demand\ | | | provisioned capacity | +| Pct | | | | ++------------+--------+-----------+-------------------------------------------+ +| cpu\ | string | Yes | CPU Identifier | +| Identifier | | | | ++------------+--------+-----------+-------------------------------------------+ +| cpu\ | number | No | Percentage of CPU time spent in the idle | +| Idle | | | task | ++------------+--------+-----------+-------------------------------------------+ +| cpu\ | number | No | Percentage of time the VM is unable to run| +| Latency\ | | | because it is contending for access to the| +| Avg | | | physical CPUs | ++------------+--------+-----------+-------------------------------------------+ +| cpu\ | number | No | The overhead demand above available | +| Overhead\ | | | allocations and reservations, in | +| Avg | | | milliseconds over the measurementInterval | ++------------+--------+-----------+-------------------------------------------+ +| cpuSwap\ | number | No | Swap wait time, in milliseconds over the | +| WaitTime | | | measurementInterval | ++------------+--------+-----------+-------------------------------------------+ +| cpuUsage\ | number | No | Percentage of time spent servicing | +| Interrupt | | | interrupts | ++------------+--------+-----------+-------------------------------------------+ +| cpuUsage\ | number | No | Percentage of time spent running user | +| Nice | | | space processes that have been niced | ++------------+--------+-----------+-------------------------------------------+ +| cpuUsage\ | number | No | Percentage of time spent handling soft irq| +| SoftIrq | | | interrupts | ++------------+--------+-----------+-------------------------------------------+ +| cpuUsage\ | number | No | Percentage of time spent in involuntary | +| Steal | | | wait which is neither user, system or idle| +| | | | time and is effectively time that went | +| | | | missing | ++------------+--------+-----------+-------------------------------------------+ +| cpuUsage\ | number | No | Percentage of time spent on system tasks | +| System | | | running the kernel | ++------------+--------+-----------+-------------------------------------------+ +| cpuUsage\ | number | No | Percentage of time spent running un-niced | +| User | | | user space processes | ++------------+--------+-----------+-------------------------------------------+ +| cpuWait | number | No | Percentage of CPU time spent waiting for | +| | | | I/O operations to complete | ++------------+--------+-----------+-------------------------------------------+ +| percent\ | number | Yes | Aggregate cpu usage of the virtual machine| +| Usage | | | on which the xNFC reporting the event is | +| | | | running | ++------------+--------+-----------+-------------------------------------------+ Datatype: diskUsage ******************** @@ -929,144 +1148,292 @@ Datatype: diskUsage The diskUsage datatype defines the usage of a disk and consists of the following fields: -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+=============================+==========+=============+===============================================================================================================================================================================================================================+ -| diskBusResets | number | No | Number of bus resets over the measurementInterval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskCommandsAborted | number | No | Number of disk commands aborted over the measurementInterval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskCommandsAvg | number | No | Average number of commands per second over the measurementInterval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskFlushRequests | number | No | Total flush requests of the disk cache over the measurementInterval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskFlushTime | number | No | Milliseconds spent on disk cache flushing over the measurementInterval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskIdentifier | string | Yes | Disk Identifier | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskIoTimeAvg | number | No | Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the average over the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskIoTimeLast | number | No | Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the last value measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskIoTimeMax | number | No | Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the maximum value measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskIoTimeMin | number | No | Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the minimum value measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskMergedReadAvg | number | No | Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the average measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskMergedReadLast | number | No | Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the last value measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskMergedReadMax | number | No | Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the maximum value measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskMergedReadMin | number | No | Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the minimum value measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskMergedWriteAvg | number | No | Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the average measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskMergedWriteLast | number | No | Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the last value measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskMergedWriteMax | number | No | Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the maximum value measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskMergedWriteMin | number | No | Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the minimum value measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskOctetsRead Avg | number | No | Number of octets per second read from a disk or partition; provide the average measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskOctetsRead | number | No | Number of octets per second read from a disk or partition; provide the last measurement within the measurement interval | -| | | | | -| Last | | | | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskOctetsRead Max | number | No | Number of octets per second read from a disk or partition; provide the maximum measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskOctetsRead Min | number | No | Number of octets per second read from a disk or partition; provide the minimum measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskOctetsWrite Avg | number | No | Number of octets per second written to a disk or partition; provide the average measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskOctetsWrite Last | number | No | Number of octets per second written to a disk or partition; provide the last measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskOctetsWriteMax | number | No | Number of octets per second written to a disk or partition; provide the maximum measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskOctetsWriteMin | number | No | Number of octets per second written to a disk or partition; provide the minimum measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskOpsReadAvg | number | No | Number of read operations per second issued to the disk; provide the average measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskOpsReadLast | number | No | Number of read operations per second issued to the disk; provide the last measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskOpsReadMax | number | No | Number of read operations per second issued to the disk; provide the maximum measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskOpsReadMin | number | No | Number of read operations per second issued to the disk; provide the minimum measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskOpsWriteAvg | number | No | Number of write operations per second issued to the disk; provide the average measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskOpsWriteLast | number | No | Number of write operations per second issued to the disk; provide the last measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskOpsWrite Max | number | No | Number of write operations per second issued to the disk; provide the maximum measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskOpsWriteMin | number | No | Number of write operations per second issued to the disk; provide the minimum measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskPendingOperationsAvg | number | No | Queue size of pending I/O operations per second; provide the average measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskPendingOperationsLast | number | No | Queue size of pending I/O operations per second; provide the last measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskPendingOperationsMax | number | No | Queue size of pending I/O operations per second; provide the maximum measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskPendingOperationsMin | number | No | Queue size of pending I/O operations per second; provide the minimum measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskReadCommandsAvg | number | No | Average number of read commands issued per second to the disk over the measurementInterval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskTime | number | No | Nanoseconds spent on disk cache reads/writes within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskTimeReadAvg | number | No | Milliseconds a read operation took to complete; provide the average measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskTimeRead Last | number | No | Milliseconds a read operation took to complete; provide the last measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskTimeRead Max | number | No | Milliseconds a read operation took to complete; provide the maximum measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskTimeRead Min | number | No | Milliseconds a read operation took to complete; provide the minimum measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskTimeWrite Avg | number | No | Milliseconds a write operation took to complete; provide the average measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskTimeWrite Last | number | No | Milliseconds a write operation took to complete; provide the last measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskTimeWrite Max | number | No | Milliseconds a write operation took to complete; provide the maximum measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskTimeWrite Min | number | No | Milliseconds a write operation took to complete; provide the minimum measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskTotalReadLatencyAvg | number | No | Average read time from the perspective of a Guest OS: sum of the Kernel Read Latency and Physical Device Read Latency in milliseconds over the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskTotalWriteLatencyAvg | number | No | Average write time from the perspective of a Guest OS: sum of the Kernel Write Latency and Physical Device Write Latency in milliseconds over the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskWeightedIoTimeAvg | number | No | Measure in ms over 1 sec of both I/O completion time and the backlog that may be accumulating. Value is the average within the collection interval. | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskWeightedIoTimeLast | number | No | Measure in ms over 1 sec of both I/O completion time and the backlog that may be accumulating. Value is the last within the collection interval. | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskWeightedIoTimeMax | number | No | Measure in ms over 1 sec of both I/O completion time and the backlog that may be accumulating. Value is the maximum within the collection interval. | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskWeightedIoTimeMin | number | No | Measure in ms over 1 sec of both I/O completion time and the backlog that may be accumulating. Value is the minimum within the collection interval. | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskWriteCommandsAvg | number | No | Average number of write commands issued per second to the disk over the measurementInterval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------+-------+----------+--------------------------------------------+ +| Field | Type | Required?| Description | ++=============+=======+==========+============================================+ +| diskBus\ | number| No | Number of bus resets over the | +| Resets | | | measurementInterval | ++-------------+-------+----------+--------------------------------------------+ +| disk\ | number| No | Number of disk commands aborted over the | +| Commands\ | | | measurementInterval | +| Aborted | | | | ++-------------+-------+----------+--------------------------------------------+ +| disk\ | number| No | Average number of commands per second over | +| CommandsAvg | | | the measurementInterval | ++-------------+-------+----------+--------------------------------------------+ +| diskFlush\ | number| No | Total flush requests of the disk cache over| +| Requests | | | the measurementInterval | ++-------------+-------+----------+--------------------------------------------+ +| diskFlush\ | number| No | Milliseconds spent on disk cache flushing | +| Time | | | over the measurementInterval | ++-------------+-------+----------+--------------------------------------------+ +| disk\ | string| Yes | Disk Identifier | +| Identifier | | | | ++-------------+-------+----------+--------------------------------------------+ +| diskIo\ | number| No | Milliseconds spent doing input/output | +| TimeAvg | | | operations over 1 sec; treat this metric as| +| | | | a device load percentage where 1000ms | +| | | | matches 100% load; provide the average over| +| | | | the measurement interval | ++-------------+-------+----------+--------------------------------------------+ +| diskIoTime\ | number| No | Milliseconds spent doing input/output | +| Last | | | operations over 1 sec; treat this metric as| +| | | | a device load percentage where 1000ms | +| | | | matches 100% load; provide the last value | +| | | | measurement within the measurement interval| ++-------------+-------+----------+--------------------------------------------+ +| diskIo\ | number| No | Milliseconds spent doing input/output | +| TimeMax | | | operations over 1 sec; treat this metric as| +| | | | a device load percentage where 1000ms | +| | | | matches 100% load; provide the maximum | +| | | | value measurement within the measurement | +| | | | interval | ++-------------+-------+----------+--------------------------------------------+ +| diskIo\ | number| No | Milliseconds spent doing input/output | +| TimeMin | | | operations over 1 sec; treat this metric as| +| | | | a device load percentage where 1000ms | +| | | | matches 100% load; provide the minimum | +| | | | value measurement within the measurement | +| | | | interval | ++-------------+-------+----------+--------------------------------------------+ +| diskMerged\ | number| No | Number of logical read operations that were| +| ReadAvg | | | merged into physical read operations, e.g.,| +| | | | two logical reads were served by one | +| | | | physical disk access; provide the average | +| | | | measurement within the measurement interval| ++-------------+-------+----------+--------------------------------------------+ +| diskMerged\ | number| No | Number of logical read operations that were| +| ReadLast | | | merged into physical read operations, e.g.,| +| | | | two logical reads were served by one | +| | | | physical disk access; provide the last | +| | | | value measurement within the measurement | +| | | | interval | ++-------------+-------+----------+--------------------------------------------+ +| diskMerged\ | number| No | Number of logical read operations that were| +| ReadMax | | | merged into physical read operations, e.g.,| +| | | | two logical reads were served by one | +| | | | physical disk access; provide the maximum | +| | | | value measurement within the measurement | +| | | | interval | ++-------------+-------+----------+--------------------------------------------+ +| diskMerged\ | number| No | Number of logical read operations that were| +| ReadMin | | | merged into physical read operations, e.g.,| +| | | | two logical reads were served by one | +| | | | physical disk access; provide the minimum | +| | | | value measurement within the measurement | +| | | | interval | ++-------------+-------+----------+--------------------------------------------+ +| diskMerged\ | number| No | Number of logical write operations that | +| WriteAvg | | | were merged into physical write operations,| +| | | | e.g., two logical writes were served by one| +| | | | physical disk access; provide the average | +| | | | measurement within the measurement interval| ++-------------+-------+----------+--------------------------------------------+ +| diskMerged\ | number| No | Number of logical write operations that | +| WriteLast | | | were merged into physical write operations,| +| | | | e.g., two logical writes were served by one| +| | | | physical disk access; provide the last | +| | | | value measurement within the measurement | +| | | | interval | ++-------------+-------+----------+--------------------------------------------+ +| diskMerged\ | number| No | Number of logical write operations that | +| WriteMax | | | were merged into physical write operations,| +| | | | e.g., two logical writes were served by one| +| | | | physical disk access; provide the maximum | +| | | | value measurement within the measurement | +| | | | interval | ++-------------+-------+----------+--------------------------------------------+ +| diskMerged\ | number| No | Number of logical write operations that | +| WriteMin | | | were merged into physical write operations,| +| | | | e.g., two logical writes were served by one| +| | | | physical disk access; provide the minimum | +| | | | value measurement within the measurement | +| | | | interval | ++-------------+-------+----------+--------------------------------------------+ +| diskOctets\ | number| No | Number of octets per second read from a | +| Read Avg | | | disk or partition; provide the average | +| | | | measurement within the measurement interval| ++-------------+-------+----------+--------------------------------------------+ +| diskOctets\ | number| No | Number of octets per second read from a | +| Read | | | disk or partition; provide the last | +| | | | measurement within the measurement interval| +| Last | | | | ++-------------+-------+----------+--------------------------------------------+ +| diskOctets\ | number| No | Number of octets per second read from a | +| Read Max | | | disk or partition; provide the maximum | +| | | | measurement within the measurement interval| ++-------------+-------+----------+--------------------------------------------+ +| diskOctets\ | number| No | Number of octets per second read from a | +| Read Min | | | disk or partition; provide the minimum | +| | | | measurement within the measurement interval| ++-------------+-------+----------+--------------------------------------------+ +| diskOctets\ | number| No | Number of octets per second written to a | +| Write Avg | | | disk or partition; provide the average | +| | | | measurement within the measurement interval| ++-------------+-------+----------+--------------------------------------------+ +| diskOctets\ | number| No | Number of octets per second written to a | +| Write Last | | | disk or partition; provide the last | +| | | | measurement within the measurement interval| ++-------------+-------+----------+--------------------------------------------+ +| diskOctets\ | number| No | Number of octets per second written to a | +| WriteMax | | | disk or partition; provide the maximum | +| | | | measurement within the measurement interval| ++-------------+-------+----------+--------------------------------------------+ +| diskOctets\ | number| No | Number of octets per second written to a | +| WriteMin | | | disk or partition; provide the minimum | +| | | | measurement within the measurement interval| ++-------------+-------+----------+--------------------------------------------+ +| diskOps\ | number| No | Number of read operations per second issued| +| ReadAvg | | | to the disk; provide the average | +| | | | measurement within the measurement interval| ++-------------+-------+----------+--------------------------------------------+ +| diskOps\ | number| No | Number of read operations per second issued| +| ReadLast | | | to the disk; provide the last measurement | +| | | | within the measurement interval | ++-------------+-------+----------+--------------------------------------------+ +| diskOps\ | number| No | Number of read operations per second issued| +| ReadMax | | | to the disk; provide the maximum | +| | | | measurement within the measurement interval| ++-------------+-------+----------+--------------------------------------------+ +| diskOps\ | number| No | Number of read operations per second issued| +| ReadMin | | | to the disk; provide the minimum | +| | | | measurement within the measurement interval| ++-------------+-------+----------+--------------------------------------------+ +| diskOps\ | number| No | Number of write operations per second | +| WriteAvg | | | issued to the disk; provide the average | +| | | | measurement within the measurement interval| ++-------------+-------+----------+--------------------------------------------+ +| diskOps\ | number| No | Number of write operations per second | +| WriteLast | | | issued to the disk; provide the last | +| | | | measurement within the measurement interval| ++-------------+-------+----------+--------------------------------------------+ +| diskOps\ | number| No | Number of write operations per second | +| Write Max | | | issued to the disk; provide the maximum | +| | | | measurement within the measurement interval| ++-------------+-------+----------+--------------------------------------------+ +| diskOps\ | number| No | Number of write operations per second | +| WriteMin | | | issued to the disk; provide the minimum | +| | | | measurement within the measurement interval| ++-------------+-------+----------+--------------------------------------------+ +| diskPending\| number| No | Queue size of pending I/O operations per | +| Operations\ | | | second; provide the average measurement | +| Avg | | | within the measurement interval | ++-------------+-------+----------+--------------------------------------------+ +| diskPending\| number| No | Queue size of pending I/O operations per | +| Operations\ | | | second; provide the last measurement within| +| Last | | | the measurement interval | ++-------------+-------+----------+--------------------------------------------+ +| diskPending\| number| No | Queue size of pending I/O operations per | +| Operations\ | | | second; provide the maximum measurement | +| Max | | | within the measurement interval | ++-------------+-------+----------+--------------------------------------------+ +| diskPending\| number| No | Queue size of pending I/O operations per | +| Operations\ | | | second; provide the minimum measurement | +| Min | | | within the measurement interval | ++-------------+-------+----------+--------------------------------------------+ +| diskRead\ | number| No | Average number of read commands issued per | +| CommandsAvg | | | second to the disk over the | +| | | | measurementInterval | ++-------------+-------+----------+--------------------------------------------+ +| diskTime | number| No | Nanoseconds spent on disk cache | +| | | | reads/writes within the measurement | +| | | | interval | ++-------------+-------+----------+--------------------------------------------+ +| diskTime\ | number| No | Milliseconds a read operation took to | +| ReadAvg | | | complete; provide the average measurement | +| | | | within the measurement interval | ++-------------+-------+----------+--------------------------------------------+ +| diskTime\ | number| No | Milliseconds a read operation took to | +| Read Last | | | complete; provide the last measurement | +| | | | within the measurement interval | ++-------------+-------+----------+--------------------------------------------+ +| diskTime\ | number| No | Milliseconds a read operation took to | +| Read Max | | | complete; provide the maximum measurement | +| | | | within the measurement interval | ++-------------+-------+----------+--------------------------------------------+ +| diskTime\ | number| No | Milliseconds a read operation took to | +| Read Min | | | complete; provide the minimum measurement | +| | | | within the measurement interval | ++-------------+-------+----------+--------------------------------------------+ +| diskTime\ | number| No | Milliseconds a write operation took to | +| Write Avg | | | complete; provide the average measurement | +| | | | within the measurement interval | ++-------------+-------+----------+--------------------------------------------+ +| diskTime\ | number| No | Milliseconds a write operation took to | +| Write Last | | | complete; provide the last measurement | +| | | | within the measurement interval | ++-------------+-------+----------+--------------------------------------------+ +| diskTime\ | number| No | Milliseconds a write operation took to | +| Write Max | | | complete; provide the maximum measurement | +| | | | within the measurement interval | ++-------------+-------+----------+--------------------------------------------+ +| diskTime\ | number| No | Milliseconds a write operation took to | +| Write Min | | | complete; provide the minimum measurement | +| | | | within the measurement interval | ++-------------+-------+----------+--------------------------------------------+ +| diskTotal\ | number| No | Average read time from the perspective of a| +| ReadLatency\| | | Guest OS: sum of the Kernel Read Latency | +| Avg | | | and Physical Device Read Latency in | +| | | | milliseconds over the measurement interval | ++-------------+-------+----------+--------------------------------------------+ +| diskTotal\ | number| No | Average write time from the perspective of | +| Write\ | | | a Guest OS: sum of the Kernel Write Latency| +| LatencyAvg | | | and Physical Device Write Latency in | +| | | | milliseconds over the measurement interval | ++-------------+-------+----------+--------------------------------------------+ +| disk\ | number| No | Measure in ms over 1 sec of both I/O | +| WeightedIo\ | | | completion time and the backlog that may be| +| TimeAvg | | | accumulating. Value is the average within | +| | | | the collection interval. | ++-------------+-------+----------+--------------------------------------------+ +| disk\ | number| No | Measure in ms over 1 sec of both I/O | +| WeightedIo\ | | | completion time and the backlog that may be| +| TimeLast | | | accumulating. Value is the last within the | +| | | | collection interval. | ++-------------+-------+----------+--------------------------------------------+ +| disk\ | number| No | Measure in ms over 1 sec of both I/O | +| WeightedIo\ | | | completion time and the backlog that may be| +| TimeMax | | | accumulating. Value is the maximum within | +| | | | the collection interval. | ++-------------+-------+----------+--------------------------------------------+ +| disk\ | number| No | Measure in ms over 1 sec of both I/O | +| WeightedIo\ | | | completion time and the backlog that may be| +| TimeMin | | | accumulating. Value is the minimum within | +| | | | the collection interval. | ++-------------+-------+----------+--------------------------------------------+ +| diskWrite\ | number| No | Average number of write commands issued per| +| CommandsAvg | | | second to the disk over the | +| | | | measurementInterval | ++-------------+-------+----------+--------------------------------------------+ Datatype: filesystemUsage *************************** The filesystemUsage datatype consists of the following fields: -+-----------------------+----------+-------------+--------------------------------------------------------+ -| Field | Type | Required? | Description | -+=======================+==========+=============+========================================================+ -| filesystemName | string | Yes | File system name | -+-----------------------+----------+-------------+--------------------------------------------------------+ -| blockConfigured | number | Yes | Configured block storage capacity in GB | -+-----------------------+----------+-------------+--------------------------------------------------------+ -| blockIops | number | Yes | Block storage input-output operations per second | -+-----------------------+----------+-------------+--------------------------------------------------------+ -| blockUsed | number | Yes | Used block storage capacity in GB | -+-----------------------+----------+-------------+--------------------------------------------------------+ -| ephemeralConfigured | number | Yes | Configured ephemeral storage capacity in GB | -+-----------------------+----------+-------------+--------------------------------------------------------+ -| ephemeralIops | number | Yes | Ephemeral storage input-output operations per second | -+-----------------------+----------+-------------+--------------------------------------------------------+ -| ephemeralUsed | number | Yes | Used ephemeral storage capacity in GB | -+-----------------------+----------+-------------+--------------------------------------------------------+ ++-------------+--------+-----------+------------------------------------------+ +| Field | Type | Required? | Description | ++=============+========+===========+==========================================+ +| filesystem\ | string | Yes | File system name | +| Name | | | | ++-------------+--------+-----------+------------------------------------------+ +| block\ | number | Yes | Configured block storage capacity in GB | +| Configured | | | | ++-------------+--------+-----------+------------------------------------------+ +| blockIops | number | Yes | Block storage input-output operations per| +| | | | second | ++-------------+--------+-----------+------------------------------------------+ +| blockUsed | number | Yes | Used block storage capacity in GB | ++-------------+--------+-----------+------------------------------------------+ +| ephemeral\ | number | Yes | Configured ephemeral storage capacity in | +| Configured | | | GB | ++-------------+--------+-----------+------------------------------------------+ +| ephemeral\ | number | Yes | Ephemeral storage input-output operations| +| Iops | | | per second | ++-------------+--------+-----------+------------------------------------------+ +| ephemeral\ | number | Yes | Used ephemeral storage capacity in GB | +| Used | | | | ++-------------+--------+-----------+------------------------------------------+ Datatype: hugePages ******************** @@ -1074,23 +1441,23 @@ Datatype: hugePages The hugePages datatype provides metrics on system hugePages; it consists of the following fields: -+-----------------------+----------+-------------+---------------------------------------+ -| Field | Type | Required? | Description | -+=======================+==========+=============+=======================================+ -| bytesFree | number | No | Number of free hugePages in bytes | -+-----------------------+----------+-------------+---------------------------------------+ -| bytesUsed | number | No | Number of used hugePages in bytes | -+-----------------------+----------+-------------+---------------------------------------+ -| hugePagesIdentifier | string | Yes | HugePages identifier | -+-----------------------+----------+-------------+---------------------------------------+ -| percentFree | number | No | Number of free hugePages in percent | -+-----------------------+----------+-------------+---------------------------------------+ -| percentUsed | number | No | Number of used hugePages in percent | -+-----------------------+----------+-------------+---------------------------------------+ -| vmPageNumberFree | number | No | Number of free vmPages in numbers | -+-----------------------+----------+-------------+---------------------------------------+ -| vmPageNumberUsed | number | No | Number of used vmPages in numbers | -+-----------------------+----------+-------------+---------------------------------------+ ++--------------------+--------+----------+------------------------------------+ +| Field | Type | Required?| Description | ++====================+========+==========+====================================+ +| bytesFree | number | No | Number of free hugePages in bytes | ++--------------------+--------+----------+------------------------------------+ +| bytesUsed | number | No | Number of used hugePages in bytes | ++--------------------+--------+----------+------------------------------------+ +| hugePagesIdentifier| string | Yes | HugePages identifier | ++--------------------+--------+----------+------------------------------------+ +| percentFree | number | No | Number of free hugePages in percent| ++--------------------+--------+----------+------------------------------------+ +| percentUsed | number | No | Number of used hugePages in percent| ++--------------------+--------+----------+------------------------------------+ +| vmPageNumberFree | number | No | Number of free vmPages in numbers | ++--------------------+--------+----------+------------------------------------+ +| vmPageNumberUsed | number | No | Number of used vmPages in numbers | ++--------------------+--------+----------+------------------------------------+ Datatype: ipmi (Intelligent Platform Management Interface) *********************************************************** @@ -1098,37 +1465,54 @@ Datatype: ipmi (Intelligent Platform Management Interface) The ipmi datatype provides intelligent platform management interface metrics; it consists of the following fields: -+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+ -| Field | Type | Required? | Description | -+=======================================+======================================+=============+===================================================+ -| exitAirTemperature | number | No | System fan exit air flow temperature in Celsius | -+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+ -| frontPanelTemperature | number | No | Front panel temp in Celsius | -+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+ -| ioModuleTemperature | number | No | Io module temp in Celsius | -+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+ -| ipmiBaseboardTemperatureArray | ipmiBaseboard Temperature [ ] | No | Array of ipmiBaseboard Temperature objects | -+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+ -| ipmiBaseboardVoltageRegulator Array | ipmiBaseboard VoltageRegulator [ ] | No | Array of ipmiBaseboard VoltageRegulator objects | -+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+ -| ipmiBatteryArray | ipmiBattery [ ] | No | Array of ipmiBattery objects | -+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+ -| ipmiFanArray | ipmiFan [ ] | No | Array of ipmiFan objects | -+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+ -| ipmiGlobalAggregateTemperature | ipmiGlobalAggregate | No | ipmi global aggregate temperature margin | -| | | | | -| MarginArray | TemperatureMargin [ ] | | | -+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+ -| ipmiHsbpArray | ipmiHsbp [ ] | No | Array of ipmiHsbp objects | -+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+ -| ipmiNicArray | ipmiNic [ ] | No | Array of ipmiNic objects | -+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+ -| ipmiPowerSupplyArray | ipmiPowerSupply [ ] | No | Array of ipmiPowerSupply objects | -+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+ -| ipmiProcessorArray | ipmiProcessor [ ] | No | Array of ipmiProcessor objects | -+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+ -| systemAirflow | number | No | Airflow in cubic feet per minute (cfm) | -+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+ ++-------------+---------------------+-----------+-----------------------------+ +| Field | Type | Required? | Description | ++=============+=====================+===========+=============================+ +| exitAir\ | number | No | System fan exit air flow | +| Temperature | | | temperature in Celsius | ++-------------+---------------------+-----------+-----------------------------+ +| frontPanel\ | number | No | Front panel temp in Celsius | +| Temperature | | | | ++-------------+---------------------+-----------+-----------------------------+ +| ioModule\ | number | No | Io module temp in Celsius | +| Temperature | | | | ++-------------+---------------------+-----------+-----------------------------+ +| ipmi\ | ipmiBaseboard | No | Array of ipmiBaseboard | +| Baseboard\ | Temperature [ ] | | Temperature objects | +| Temperature\| | | | +| Array | | | | ++-------------+---------------------+-----------+-----------------------------+ +| ipmi\ | ipmiBaseboard | No | Array of ipmiBaseboard | +| Baseboard\ | VoltageRegulator [ ]| | VoltageRegulator objects | +| Voltage\ | | | | +| Regulator | | | | +| Array | | | | ++-------------+---------------------+-----------+-----------------------------+ +| ipmiBattery\| ipmiBattery [ ] | No | Array of ipmiBattery objects| +| Array | | | | ++-------------+---------------------+-----------+-----------------------------+ +| ipmiFanArray| ipmiFan [ ] | No | Array of ipmiFan objects | ++-------------+---------------------+-----------+-----------------------------+ +| ipmiGlobal\ | ipmiGlobalAggregate\| No | ipmi global aggregate | +| Aggregate\ | TemperatureMargin []| | temperature margin | +| Temperature\| | | | +| MarginArray | | | | ++-------------+---------------------+-----------+-----------------------------+ +| ipmiHsbp\ | ipmiHsbp [ ] | No | Array of ipmiHsbp objects | +| Array | | | | ++-------------+---------------------+-----------+-----------------------------+ +| ipmiNicArray| ipmiNic [ ] | No | Array of ipmiNic objects | ++-------------+---------------------+-----------+-----------------------------+ +| ipmiPower\ | ipmiPowerSupply [ ] | No | Array of ipmiPowerSupply | +| SupplyArray | | | objects | ++-------------+---------------------+-----------+-----------------------------+ +| ipmi\ | ipmiProcessor [ ] | No | Array of ipmiProcessor | +| Processor\ | | | objects | +| Array | | | | ++-------------+---------------------+-----------+-----------------------------+ +| system\ | number | No | Airflow in cubic feet per | +| Airflow | | | minute (cfm) | ++-------------+---------------------+-----------+-----------------------------+ Datatype: ipmiBaseboardTemperature ************************************ @@ -1136,13 +1520,16 @@ Datatype: ipmiBaseboardTemperature The ipmiBaseboardTemperature datatype consists of the following fields which describe ipmi baseboard temperature metrics: -+-----------------------------------+----------+-------------+--------------------------------------------------------------+ -| Field | Type | Required? | Description | -+===================================+==========+=============+==============================================================+ -| baseboardTemperature | number | No | Baseboard temperature in celsius | -+-----------------------------------+----------+-------------+--------------------------------------------------------------+ -| baseboardTemperature Identifier | string | Yes | Identifier for the location where the temperature is taken | -+-----------------------------------+----------+-------------+--------------------------------------------------------------+ ++-------------+--------+-----------+------------------------------------------+ +| Field | Type | Required? | Description | ++=============+========+===========+==========================================+ +| baseboard\ | number | No | Baseboard temperature in celsius | +| Temperature | | | | ++-------------+--------+-----------+------------------------------------------+ +| baseboard\ | string | Yes | Identifier for the location where the | +| Temperature\| | | temperature is taken | +| Identifier | | | | ++-------------+--------+-----------+------------------------------------------+ Datatype: ipmiBaseboardVoltageRegulator ***************************************** @@ -1150,13 +1537,15 @@ Datatype: ipmiBaseboardVoltageRegulator The ipmiBaseboardVoltageRegulator datatype consists of the following fields which describe ipmi baseboard voltage regulator metrics: -+----------------------------------------+----------+-------------+--------------------------------------------------+ -| Field | Type | Required? | Description | -+========================================+==========+=============+==================================================+ -| baseboardVoltage RegulatorIdentifier | string | Yes | Identifier for the baseboard voltage regulator | -+----------------------------------------+----------+-------------+--------------------------------------------------+ -| voltageRegulator Temperature | number | No | Voltage regulator temperature in celsius | -+----------------------------------------+----------+-------------+--------------------------------------------------+ ++--------------------+-------+----------+-------------------------------------+ +| Field | Type | Required?| Description | ++====================+=======+==========+=====================================+ +| baseboardVoltage\ | string| Yes | Identifier for the baseboard voltage| +| RegulatorIdentifier| | | regulator | ++--------------------+-------+----------+-------------------------------------+ +| voltageRegulator\ | number| No | Voltage regulator temperature in | +| Temperature | | | celsius | ++--------------------+-------+----------+-------------------------------------+ Datatype: ipmiBattery ********************** @@ -1164,15 +1553,15 @@ Datatype: ipmiBattery The ipmiBattery datatype consists of the following fields which describe ipmi battery metrics: -+-----------------------+----------+-------------+------------------------------+ -| Field | Type | Required? | Description | -+=======================+==========+=============+==============================+ -| batteryIdentifier | string | Yes | Identifier for the battery | -+-----------------------+----------+-------------+------------------------------+ -| batteryType | string | No | Type of battery | -+-----------------------+----------+-------------+------------------------------+ -| batteryVoltageLevel | number | No | Battery voltage level | -+-----------------------+----------+-------------+------------------------------+ ++---------------------+--------+----------+------------------------------+ +| Field | Type | Required?| Description | ++=====================+========+==========+==============================+ +| batteryIdentifier | string | Yes | Identifier for the battery | ++---------------------+--------+----------+------------------------------+ +| batteryType | string | No | Type of battery | ++---------------------+--------+----------+------------------------------+ +| batteryVoltageLevel | number | No | Battery voltage level | ++---------------------+--------+----------+------------------------------+ Datatype: ipmiFan ******************** @@ -1180,13 +1569,13 @@ Datatype: ipmiFan The ipmiFan datatype consists of the following fields which describe ipmi fan metrics: -+-----------------+----------+-------------+---------------------------------------------+ -| Field | Type | Required? | Description | -+=================+==========+=============+=============================================+ -| fanIdentifier | string | Yes | Identifier for the fan | -+-----------------+----------+-------------+---------------------------------------------+ -| fanSpeed | number | No | Fan speed in revolutions per minute (rpm) | -+-----------------+----------+-------------+---------------------------------------------+ ++--------------+-------+----------+-------------------------------------------+ +| Field | Type | Required?| Description | ++==============+=======+==========+===========================================+ +| fanIdentifier| string| Yes | Identifier for the fan | ++--------------+-------+----------+-------------------------------------------+ +| fanSpeed | number| No | Fan speed in revolutions per minute (rpm) | ++--------------+-------+----------+-------------------------------------------+ Datatype: ipmiGlobalAggregateTemperatureMargin *********************************************** @@ -1194,13 +1583,20 @@ Datatype: ipmiGlobalAggregateTemperatureMargin The ipmiGlobalAggregateTemperatureMargin datatype consists of the following fields: -+----------------------------------------------+----------+-------------+-----------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+==============================================+==========+=============+=============================================================================+ -| globalAggregateTemperatureMargin | number | No | Temperature margin in Celsius relative to a throttling thermal trip point | -+----------------------------------------------+----------+-------------+-----------------------------------------------------------------------------+ -| globalAggregateTemperatureMarginIdentifier | string | Yes | Identifier for the ipmi global aggregate temperature margin metrics | -+----------------------------------------------+----------+-------------+-----------------------------------------------------------------------------+ ++-------------+-------+----------+--------------------------------------------+ +| Field | Type | Required?| Description | ++=============+=======+==========+============================================+ +| global\ | number| No | Temperature margin in Celsius relative to a| +| Aggregate\ | | | throttling thermal trip point | +| Temperature\| | | | +| Margin | | | | ++-------------+-------+----------+--------------------------------------------+ +| global\ | string| Yes | Identifier for the ipmi global aggregate | +| Aggregate\ | | | temperature margin metrics | +| Temperature\| | | | +| Margin\ | | | | +| Identifier | | | | ++-------------+-------+----------+--------------------------------------------+ Datatype: ipmiHsbp ******************* @@ -1208,13 +1604,15 @@ Datatype: ipmiHsbp The ipmiHsbp datatype provides ipmi hot swap backplane power metrics; it consists of the following fields: -+-------------------+----------+-------------+----------------------------------------------------+ -| Field | Type | Required? | Description | -+===================+==========+=============+====================================================+ -| hsbpIdentifier | string | Yes | Identifier for the hot swap backplane power unit | -+-------------------+----------+-------------+----------------------------------------------------+ -| hsbpTemperature | number | No | Hot swap backplane power temperature in celsius | -+-------------------+----------+-------------+----------------------------------------------------+ ++------------+-------+----------+---------------------------------------------+ +| Field | Type | Required?| Description | ++============+=======+==========+=============================================+ +| hsbp\ | string| Yes | Identifier for the hot swap backplane power | +| Identifier | | | unit | ++------------+-------+----------+---------------------------------------------+ +| hsbp\ | number| No | Hot swap backplane power temperature in | +| Temperature| | | celsius | ++------------+-------+----------+---------------------------------------------+ Datatype: ipmiNic ****************** @@ -1222,13 +1620,15 @@ Datatype: ipmiNic The ipmiNic datatype provides network interface control care metrics; it consists of the following fields: -+------------------+----------+-------------+-----------------------------------------------------+ -| Field | Type | Required? | Description | -+==================+==========+=============+=====================================================+ -| nicIdentifier | string | Yes | Identifier for the network interface control card | -+------------------+----------+-------------+-----------------------------------------------------+ -| nicTemperature | number | No | nic temperature in Celsius | -+------------------+----------+-------------+-----------------------------------------------------+ ++------------+-------+----------+---------------------------------------------+ +| Field | Type | Required?| Description | ++============+=======+==========+=============================================+ +| nic\ | string| Yes | Identifier for the network interface control| +| Identifier | | | card | ++------------+-------+----------+---------------------------------------------+ +| nic\ | number| No | nic temperature in Celsius | +| Temperature| | | | ++------------+-------+----------+---------------------------------------------+ Datatype: ipmiPowerSupply ************************** @@ -1236,17 +1636,28 @@ Datatype: ipmiPowerSupply The ipmiPowerSupply datatype provides ipmi power supply metrics; it consists of the following fields: -+------------------------------------+----------+-------------+------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+====================================+==========+=============+========================================================================+ -| powerSupplyCurrentOutput Percent | number | No | Current output voltage as a percentage of the design specified level | -+------------------------------------+----------+-------------+------------------------------------------------------------------------+ -| powerSupplyIdentifier | string | Yes | Identifier for the power supply | -+------------------------------------+----------+-------------+------------------------------------------------------------------------+ -| powerSupplyInputPower | number | No | Input power in watts | -+------------------------------------+----------+-------------+------------------------------------------------------------------------+ -| powerSupplyTemperature | number | No | Power supply temperature in Celsius | -+------------------------------------+----------+-------------+------------------------------------------------------------------------+ ++-----------+-------+----------+----------------------------------------------+ +|Field | Type | Required?| Description | ++===========+=======+==========+==============================================+ +|power\ | number| No | Current output voltage as a percentage of the| +|Supply\ | | | design specified level | +|Current\ | | | | +|Output\ | | | | +|Percent | | | | ++-----------+-------+----------+----------------------------------------------+ +|power\ | string| Yes | Identifier for the power supply | +|Supply\ | | | | +|Identifier | | | | ++-----------+-------+----------+----------------------------------------------+ +|power\ | number| No | Input power in watts | +|Supply\ | | | | +|Input\ | | | | +|Power | | | | ++-----------+-------+----------+----------------------------------------------+ +|power\ | number| No | Power supply temperature in Celsius | +|Supply\ | | | | +|Temperature| | | | ++-----------+-------+----------+----------------------------------------------+ Datatype: ipmiProcessor ************************ @@ -1254,17 +1665,27 @@ Datatype: ipmiProcessor The ipmiProcessor datatype provides ipmi processor metrics; it consists of the following fields: -+---------------------------------------------+---------------------------------------------+-------------+---------------------------------------------------------+ -| Field | Type | Required? | Description | -+=============================================+=============================================+=============+=========================================================+ -| processorDimmAggregate ThermalMarginArray | processorDimm AggregateThermal Margin [ ] | No | Array of processorDimmAggregate ThermalMargin objects | -+---------------------------------------------+---------------------------------------------+-------------+---------------------------------------------------------+ -| processorDtsThermalMargin | number | No | Front panel temperature in celsius | -+---------------------------------------------+---------------------------------------------+-------------+---------------------------------------------------------+ -| processorIdentifier | string | Yes | Identifier for the power supply | -+---------------------------------------------+---------------------------------------------+-------------+---------------------------------------------------------+ -| processorThermalControl Percent | number | No | Io module temperatue in celsius | -+---------------------------------------------+---------------------------------------------+-------------+---------------------------------------------------------+ ++------------+------------------+-----------+---------------------------------+ +| Field | Type | Required? | Description | ++============+==================+===========+=================================+ +| processor\ | processorDimm | No | Array of processorDimmAggregate | +| Dimm\ | AggregateThermal | | ThermalMargin objects | +| Aggregate\ | Margin [ ] | | | +| Thermal\ | | | | +| MarginArray| | | | ++------------+------------------+-----------+---------------------------------+ +| processor\ | number | No | Front panel temperature in | +| DtsThermal\| | | celsius | +| Margin | | | | ++------------+------------------+-----------+---------------------------------+ +| processor\ | string | Yes | Identifier for the power supply | +| Identifier | | | | ++------------+------------------+-----------+---------------------------------+ +| processor\ | number | No | Io module temperatue in celsius | +| Thermal\ | | | | +| Control\ | | | | +| Percent | | | | ++------------+------------------+-----------+---------------------------------+ Datatype: latencyBucketMeasure ******************************* @@ -1272,15 +1693,21 @@ Datatype: latencyBucketMeasure The latencyBucketMeasure datatype consists of the following fields which describe the number of counts falling within a defined latency bucket: -+--------------------------+----------+-------------+------------------------------------------------------------+ -| Field | Type | Required? | Description | -+==========================+==========+=============+============================================================+ -| countsInTheBucket | number | Yes | Number of counts falling within a defined latency bucket | -+--------------------------+----------+-------------+------------------------------------------------------------+ -| highEndOfLatencyBucket | number | No | High end of bucket range (typically in ms) | -+--------------------------+----------+-------------+------------------------------------------------------------+ -| lowEndOfLatencyBucket | number | No | Low end of bucket range (typically in ms) | -+--------------------------+----------+-------------+------------------------------------------------------------+ ++-----------+-------+----------+----------------------------------------------+ +| Field | Type | Required?| Description | ++===========+=======+==========+==============================================+ +| counts\ | number| Yes | Number of counts falling within a defined | +| InThe\ | | | latency bucket | +| Bucket | | | | ++-----------+-------+----------+----------------------------------------------+ +| highEnd\ | number| No | High end of bucket range (typically in ms) | +| OfLatency\| | | | +| Bucket | | | | ++-----------+-------+----------+----------------------------------------------+ +| lowEndOf\ | number| No | Low end of bucket range (typically in ms) | +| Latency\ | | | | +| Bucket | | | | ++-----------+-------+----------+----------------------------------------------+ Datatype: load **************** @@ -1288,15 +1715,24 @@ Datatype: load The load datatype provides metrics on system cpu and io utilization obtained using /proc/loadavg; it consists of the following fields: -+-------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+=============+==========+=============+=============================================================================================================================================================+ -| longTerm | number | No | number of jobs in the run queue (state R, cpu utilization) or waiting for disk I/O (state D, io utilization) averaged over 15 minutes using /proc/loadavg | -+-------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| midTerm | number | No | number of jobs in the run queue (state R, cpu utilization) or waiting for disk I/O (state D, io utilization) averaged over 5 minutes using /proc/loadavg | -+-------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| shortTerm | number | No | number of jobs in the run queue (state R, cpu utilization) or waiting for disk I/O (state D, io utilization) averaged over 1 minute using /proc/loadavg | -+-------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------+-------+----------+-----------------------------------------------+ +| Field | Type | Required?| Description | ++==========+=======+==========+===============================================+ +| longTerm | number| No | number of jobs in the run queue (state R, cpu | +| | | | utilization) or waiting for disk I/O (state D,| +| | | | io utilization) averaged over 15 minutes using| +| | | | /proc/loadavg | ++----------+-------+----------+-----------------------------------------------+ +| midTerm | number| No | number of jobs in the run queue (state R, cpu | +| | | | utilization) or waiting for disk I/O (state D,| +| | | | io utilization) averaged over 5 minutes using | +| | | | /proc/loadavg | ++----------+-------+----------+-----------------------------------------------+ +| shortTerm| number| No | number of jobs in the run queue (state R, cpu | +| | | | utilization) or waiting for disk I/O (state D,| +| | | | io utilization) averaged over 1 minute using | +| | | | /proc/loadavg | ++----------+-------+----------+-----------------------------------------------+ Datatype: machineCheckException ******************************** @@ -1304,76 +1740,140 @@ Datatype: machineCheckException The machineCheckException datatype describes machine check exceptions; it consists of the following fields: -+---------------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+=================================+==========+=============+===================================================================================================================================================================================================================================================================+ -| correctedMemoryErrors | number | No | Total hardware errors that were corrected by the hardware (e.g. data corruption corrected via ECC) over the measurementInterval. These errors do not require immediate software actions, but are still reported for accounting and predictive failure analysis | -+---------------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| correctedMemoryErrors In1Hr | number | No | Total hardware errors that were corrected by the hardware over the last one hour | -+---------------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| uncorrectedMemoryErrors | number | No | Total uncorrected hardware errors that were detected by the hardware (e.g., causing data corruption) over the measurementInterval. These errors require a software response. | -+---------------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| uncorrectedMemoryErrors In1Hr | number | No | Total uncorrected hardware errors that were detected by the hardware over the last one hour | -+---------------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| vmIdentifier | string | Yes | Virtual machine identifier associated with the machine check exception | -+---------------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------+-------+----------+--------------------------------------------+ +| Field | Type | Required?| Description | ++=============+=======+==========+============================================+ +| corrected\ | number| No | Total hardware errors that were corrected | +| Memory\ | | | by the hardware (e.g. data corruption | +| Errors | | | corrected via ECC) over the | +| | | | measurementInterval. These errors do not | +| | | | require immediate software actions, but are| +| | | | still reported for accounting and | +| | | | predictive failure analysis | ++-------------+-------+----------+--------------------------------------------+ +| corrected\ | number| No | Total hardware errors that were corrected | +| Memory\ | | | by the hardware over the last one hour | +| Errors | | | | +| In1Hr | | | | ++-------------+-------+----------+--------------------------------------------+ +| uncorrected\| number| No | Total uncorrected hardware errors that were| +| Memory\ | | | detected by the hardware (e.g., causing | +| Errors | | | data corruption) over the | +| | | | measurementInterval. These errors require a| +| | | | software response. | ++-------------+-------+----------+--------------------------------------------+ +| uncorrected\| number| No | Total uncorrected hardware errors that were| +| Memory\ | | | detected by the hardware over the last one | +| Errors | | | hour | +| In1Hr | | | | ++-------------+-------+----------+--------------------------------------------+ +| vm\ | string| Yes | Virtual machine identifier associated with | +| Identifier | | | the machine check exception | ++-------------+-------+----------+--------------------------------------------+ Datatype: measurementFields **************************** The measurementFields datatype consists of the following fields: -+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+==============================+=============================+=============+===========================================================================================================================================================================================================+ -| additionalFields | hashMap | No | Additional measurement fields if needed | -+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| additionalMeasurements | arrayOfNamedHashMap | No | Array of named hashMap if needed | -+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| additionalObjects | arrayOfJsonObject | No | Array of JSON objects described by name, schema and other meta-information, if needed | -+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| codecUsageArray | codecsInUse [] | No | Array of codecs in use | -+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| concurrentSessions | integer | No | Peak concurrent sessions for the VM or xNF (depending on the context) over the measurementInterval | -+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| configuredEntities | integer | No | Depending on the context over the measurementInterval: peak total number of users, subscribers, devices, adjacencies, etc., for the VM, or peak total number of subscribers, devices, etc., for the xNF | -+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| cpuUsageArray | cpuUsage [] | No | Usage of an array of CPUs | -+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskUsageArray | diskUsage [] | No | Usage of an array of disks | -+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| featureUsageArray | hashMap | No | The hashMap key should identify the feature, while the value defines the number of times the identified feature was used | -+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| filesystemUsageArray | filesystemUsage [ ] | No | Filesystem usage of the VM on which the xNFC reporting the event is running | -+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| hugePagesArray | hugePages [ ] | No | Array of metrics on hugePages | -+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| ipmi | ipmi | No | Intelligent platform management interface metrics | -+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| latencyDistribution | latencyBucketMeasure [ ] | No | Array of integers representing counts of requests whose latency in milliseconds falls within per-xNF configured ranges; where latency is the duration between a service request and its fulfillment. | -+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| loadArray | load [ ] | No | Array of system load metrics | -+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| machineCheckExceptionArray | machineCheckException [ ] | No | Array of machine check exceptions | -+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| meanRequestLatency | number | No | Mean seconds required to respond to each request for the VM on which the xNFC reporting the event is running | -+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| measurementFieldsVersion | string | Yes | Version of the measurementFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. | -+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| measurementInterval | number | Yes | Interval over which measurements are being reported in seconds | -+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| memoryUsageArray | memoryUsage [] | No | Memory usage of an array of VMs | -+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| nfcScalingMetric | integer | No | Represents busy-ness of the network function from 0 to 100 as reported by the nfc | -+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| nicPerformanceArray | nicPerformance [ ] | No | Performance metrics of an array of network interface cards | -+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numberOfMediaPortsInUse | integer | No | Number of media ports in use | -+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| processStatsArray | processStats [ ] | No | Array of metrics on system processes | -+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| requestRate | number | No | Peak rate of service requests per second to the xNF over the measurementInterval | -+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------+--------------+----------+-------------------------------------+ +| Field | Type | Required?| Description | ++=============+==============+==========+=====================================+ +| additional\ | hashMap | No | Additional measurement fields if | +| Fields | | | needed | ++-------------+--------------+----------+-------------------------------------+ +| additional\ | arrayOfNamed\| No | Array of named hashMap if needed | +| Measurements| HashMap | | | ++-------------+--------------+----------+-------------------------------------+ +| additional\ | arrayOf\ | No | Array of JSON objects described by | +| Objects | JsonObject | | name, schema and other | +| | | | meta-information, if needed | ++-------------+--------------+----------+-------------------------------------+ +| codec\ | codecs\ | No | Array of codecs in use | +| Usage\ | InUse [] | | | +| Array | | | | ++-------------+--------------+----------+-------------------------------------+ +| concurrent\ | integer | No | Peak concurrent sessions for the VM | +| Sessions | | | or xNF (depending on the context) | +| | | | over the measurementInterval | ++-------------+--------------+----------+-------------------------------------+ +| configured\ | integer | No | Depending on the context over the | +| Entities | | | measurementInterval: peak total | +| | | | number of users, subscribers, | +| | | | devices, adjacencies, etc., for the | +| | | | VM, or peak total number of | +| | | | subscribers, devices, etc., for the | +| | | | xNF | ++-------------+--------------+----------+-------------------------------------+ +| cpuUsage\ | cpuUsage [] | No | Usage of an array of CPUs | +| Array | | | | ++-------------+--------------+----------+-------------------------------------+ +| diskUsage\ | diskUsage [] | No | Usage of an array of disks | +| Array | | | | ++-------------+--------------+----------+-------------------------------------+ +| feature\ | hashMap | No | The hashMap key should identify the | +| UsageArray | | | feature, while the value defines the| +| | | | number of times the identified | +| | | | feature was used | ++-------------+--------------+----------+-------------------------------------+ +| filesystem\ | filesystem\ | No | Filesystem usage of the VM on which | +| UsageArray | Usage [ ] | | the xNFC reporting the event is | +| | | | running | ++-------------+--------------+----------+-------------------------------------+ +| hugePages\ | hugePages [ ]| No | Array of metrics on hugePages | +| Array | | | | ++-------------+--------------+----------+-------------------------------------+ +| ipmi | ipmi | No | Intelligent platform management | +| | | | interface metrics | ++-------------+--------------+----------+-------------------------------------+ +| latency\ | latency\ | No | Array of integers representing | +| Distribution| Bucket\ | | counts of requests whose latency in | +| | Measure [ ] | | milliseconds falls within per-xNF | +| | | | configured ranges; where latency is | +| | | | the duration between a service | +| | | | request and its fulfillment. | ++-------------+--------------+----------+-------------------------------------+ +| loadArray | load [ ] | No | Array of system load metrics | ++-------------+--------------+----------+-------------------------------------+ +| machine\ | machine\ | No | Array of machine check exceptions | +| Check\ | Check\ | | | +| Exception\ | Exception [ ]| | | +| Array | | | | ++-------------+--------------+----------+-------------------------------------+ +| mean\ | number | No | Mean seconds required to respond to | +| Request\ | | | each request for the VM on which the| +| Latency | | | xNFC reporting the event is running | ++-------------+--------------+----------+-------------------------------------+ +| measurement\| string | Yes | Version of the measurementFields | +| Fields\ | | | block as “#.#” where # is a digit; | +| Version | | | see section 1 for the correct digits| +| | | | to use. | ++-------------+--------------+----------+-------------------------------------+ +| measurement\| number | Yes | Interval over which measurements are| +| Interval | | | being reported in seconds | ++-------------+--------------+----------+-------------------------------------+ +| memoryUsage\| memory\ | No | Memory usage of an array of VMs | +| Array | Usage [] | | | ++-------------+--------------+----------+-------------------------------------+ +| nfcScaling\ | integer | No | Represents busy-ness of the network | +| Metric | | | function from 0 to 100 as reported | +| | | | by the nfc | ++-------------+--------------+----------+-------------------------------------+ +| nic\ | nic\ | No | Performance metrics of an array of | +| Performance\| Performance | | network interface cards | +| Array | [ ] | | | ++-------------+--------------+----------+-------------------------------------+ +| numberOf\ | integer | No | Number of media ports in use | +| MediaPorts\ | | | | +| InUse | | | | ++-------------+--------------+----------+-------------------------------------+ +| process\ | process\ | No | Array of metrics on system processes| +| StatsArray | Stats [ ] | | | ++-------------+--------------+----------+-------------------------------------+ +| request\ | number | No | Peak rate of service requests per | +| Rate | | | second to the xNF over the | +| | | | measurementInterval | ++-------------+--------------+----------+-------------------------------------+ Datatype: memoryUsage ********************** @@ -1381,43 +1881,70 @@ Datatype: memoryUsage The memoryUsage datatype defines the memory usage of a virtual machine and consists of the following fields: -+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+========================+==========+=============+===================================================================================================================================+ -| memoryBuffered | number | No | Kibibytes of temporary storage for raw disk blocks | -+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| memoryCached | number | No | Kibibytes of memory used for cache | -+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| memoryConfigured | number | No | Kibibytes of memory configured in the virtual machine on which the xNFC reporting the event is running | -+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| memoryDemand | number | No | Host demand in kibibytes | -+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| memoryFree | number | Yes | Kibibytes of physical RAM left unused by the system | -+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| memoryLatencyAvg | number | No | Percentage of time the VM is waiting to access swapped or compressed memory | -+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| memorySharedAvg | number | No | Shared memory in kilobytes | -+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| memorySlabRecl | number | No | The part of the slab that can be reclaimed such as caches measured in kibibytes | -+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| memorySlabUnrecl | number | No | The part of the slab that cannot be reclaimed even when lacking memory measure in kibibytes | -+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| memorySwapInAvg | number | No | Amount of memory swapped-in from host cache in kibibytes | -+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| memorySwapInRateAvg | number | No | Rate at which memory is swapped from disk into active memory during the interval in kilobytes per second | -+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| memorySwapOutAvg | number | No | Amount of memory swapped-out to host cache in kibibytes | -+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| memorySwapOutRateAvg | number | No | Rate at which memory is being swapped from active memory to disk during the current interval in kilobytes per second | -+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| memorySwapUsedAvg | number | No | Space used for caching swapped pages in the host cache in kibibytes | -+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| memoryUsed | number | Yes | Total memory minus the sum of free, buffered, cached and slab memory measured in kibibytes | -+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| percentMemoryUsage | number | No | Percentage of memory usage; value = (memoryUsed / (memoryUsed + memoryFree) x 100 if denomintor is nonzero, or 0, if otherwise. | -+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| vmIdentifier | string | Yes | Virtual Machine identifier associated with the memory metrics | -+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+ ++-----------+-------+----------+----------------------------------------------+ +| Field | Type | Required?| Description | ++===========+=======+==========+==============================================+ +| memory\ | number| No | Kibibytes of temporary storage for raw disk | +| Buffered | | | blocks | ++-----------+-------+----------+----------------------------------------------+ +| memory\ | number| No | Kibibytes of memory used for cache | +| Cached | | | | ++-----------+-------+----------+----------------------------------------------+ +| memory\ | number| No | Kibibytes of memory configured in the virtual| +| Configured| | | machine on which the xNFC reporting the event| +| | | | is running | ++-----------+-------+----------+----------------------------------------------+ +| memory\ | number| No | Host demand in kibibytes | +| Demand | | | | ++-----------+-------+----------+----------------------------------------------+ +| memory\ | number| Yes | Kibibytes of physical RAM left unused by the | +| Free | | | system | ++-----------+-------+----------+----------------------------------------------+ +| memory\ | number| No | Percentage of time the VM is waiting to | +| Latency\ | | | access swapped or compressed memory | +| Avg | | | | ++-----------+-------+----------+----------------------------------------------+ +| memory\ | number| No | Shared memory in kilobytes | +| Shared\ | | | | +| Avg | | | | ++-----------+-------+----------+----------------------------------------------+ +| memory\ | number| No | The part of the slab that can be reclaimed | +| SlabRecl | | | such as caches measured in kibibytes | ++-----------+-------+----------+----------------------------------------------+ +| memory\ | number| No | The part of the slab that cannot be reclaimed| +| Slab\ | | | even when lacking memory measure in kibibytes| +| Unrecl | | | | ++-----------+-------+----------+----------------------------------------------+ +| memory\ | number| No | Amount of memory swapped-in from host cache | +| SwapIn\ | | | in kibibytes | +| Avg | | | | ++-----------+-------+----------+----------------------------------------------+ +| memory\ | number| No | Rate at which memory is swapped from disk | +| SwapIn\ | | | into active memory during the interval in | +| RateAvg | | | kilobytes per second | ++-----------+-------+----------+----------------------------------------------+ +| memory\ | number| No | Amount of memory swapped-out to host cache in| +| SwapOut\ | | | kibibytes | +| Avg | | | | ++-----------+-------+----------+----------------------------------------------+ +| memory\ | number| No | Rate at which memory is being swapped from | +| SwapOut\ | | | active memory to disk during the current | +| RateAvg | | | interval in kilobytes per second | ++-----------+-------+----------+----------------------------------------------+ +| memory\ | number| No | Space used for caching swapped pages in the | +| Swap\ | | | host cache in kibibytes | +| UsedAvg | | | | ++-----------+-------+----------+----------------------------------------------+ +| memory\ | number| Yes | Total memory minus the sum of free, buffered,| +| Used | | | cached and slab memory measured in kibibytes | ++-----------+-------+----------+----------------------------------------------+ +| percent\ | number| No | Percentage of memory usage; value = | +| Memory\ | | | (memoryUsed / (memoryUsed + memoryFree) x 100| +| Usage | | | if denomintor is nonzero, or 0, if otherwise.| ++-----------+-------+----------+----------------------------------------------+ +| vm\ | string| Yes | Virtual Machine identifier associated with | +| Identifier| | | the memory metrics | ++-----------+-------+----------+----------------------------------------------+ Datatype: nicPerformance ************************* @@ -1426,87 +1953,179 @@ The nicPerformance datatype consists of the following fields which describe the performance and errors of an of an identified virtual network interface card: -+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+==========================================+==========+=============+======================================================================================================================================================================================+ -| administrativeState | string | No | Administrative state: enum: ‘inService’, ‘outOfService’ | -+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| nicIdentifier | string | Yes | Network interface card identifier | -+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| operationalState | string | No | Operational state: enum: ‘inService’, ‘outOfService’ | -+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| receivedBroadcastPacketsAccumulated | number | No | Cumulative count of broadcast packets received as read at the end of the measurement interval | -+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| receivedBroadcastPacketsDelta | number | No | Count of broadcast packets received within the measurement interval | -+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| receivedDiscardedPacketsAccumulated | number | No | Cumulative count of discarded packets received as read at the end of the measurement interval | -+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| receivedDiscardedPacketsDelta | number | No | Count of discarded packets received within the measurement interval | -+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| receivedErrorPacketsAccumulated | number | No | Cumulative count of error packets received as read at the end of the measurement interval | -+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| receivedErrorPacketsDelta | number | No | Count of error packets received within the measurement interval | -+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| receivedMulticastPacketsAccumulated | number | No | Cumulative count of multicast packets received as read at the end of the measurement interval | -+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| receivedMulticastPacketsDelta | number | No | Count of multicast packets received within the measurement interval | -+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| receivedOctetsAccumulated | number | No | Cumulative count of octets received as read at the end of the measurement interval | -+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| receivedOctetsDelta | number | No | Count of octets received within the measurement interval | -+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| receivedPercentDiscard | number | No | Percentage of discarded packets received; value = (receivedDiscardedPacketsDelta / receivedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise. | -+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| receivedPercentError | number | No | Percentage of error packets received; value = (receivedErrorPacketsDelta / receivedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise. | -+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| receivedTotalPacketsAccumulated | number | No | Cumulative count of all packets received as read at the end of the measurement interval | -+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| receivedTotalPacketsDelta | number | No | Count of all packets received within the measurement interval | -+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| receivedUnicastPacketsAccumulated | number | No | Cumulative count of unicast packets received as read at the end of the measurement interval | -+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| receivedUnicastPacketsDelta | number | No | Count of unicast packets received within the measurement interval | -+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| receivedUtilization | number | No | Percentage of utilization received; value = (receivedOctetsDelta / (speed x (lastEpochMicrosec - startEpochMicrosec))) x 100, if denominator is nonzero, or 0, if otherwise. | -+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| speed | number | No | Speed configured in mbps. | -+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| transmittedBroadcastPacketsAccumulated | number | No | Cumulative count of broadcast packets transmitted as read at the end of the measurement interval | -+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| transmittedBroadcastPacketsDelta | number | No | Count of broadcast packets transmitted within the measurement interval | -+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| transmittedDiscardedPacketsAccumulated | number | No | Cumulative count of discarded packets transmitted as read at the end of the measurement interval | -+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| transmittedDiscardedPacketsDelta | number | No | Count of discarded packets transmitted within the measurement interval | -+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| transmittedErrorPacketsAccumulated | number | No | Cumulative count of error packets transmitted as read at the end of the measurement interval | -+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| transmittedErrorPacketsDelta | number | No | Count of error packets transmitted within the measurement interval | -+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| transmittedMulticastPacketsAccumulated | number | No | Cumulative count of multicast packets transmitted as read at the end of the measurement interval | -+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| transmittedMulticastPacketsDelta | number | No | Count of multicast packets transmitted within the measurement interval | -+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| transmittedOctetsAccumulated | number | No | Cumulative count of octets transmitted as read at the end of the measurement interval | -+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| transmittedOctetsDelta | number | No | Count of octets transmitted within the measurement interval | -+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| transmittedPercentDiscard | number | No | Percentage of discarded packets transmitted; value = (transmittedDiscardedPacketsDelta / transmittedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise. | -+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| transmittedPercentError | number | No | Percentage of error packets received; value = (transmittedErrorPacketsDelta / transmittedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise. | -+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| transmittedTotalPacketsAccumulated | number | No | Cumulative count of all packets transmitted as read at the end of the measurement interval | -+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| transmittedTotalPacketsDelta | number | No | Count of all packets transmitted within the measurement interval | -+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| transmittedUnicastPacketsAccumulated | number | No | Cumulative count of unicast packets transmitted as read at the end of the measurement interval | -+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| transmittedUnicastPacketsDelta | number | No | Count of unicast packets transmitted within the measurement interval | -+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| transmittedUtilization | number | No | Percentage of utilization transmitted; value = (transmittedOctetsDelta / (speed x (lastEpochMicrosec - startEpochMicrosec))) x 100, if denominator is nonzero, or 0, if otherwise. | -+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| valuesAreSuspect | string | Yes | Enumeration: ‘true’ or ‘false’. If ‘true’ then the vNicPerformance values are likely inaccurate due to counter overflow or other conditions. | -+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------+-------+----------+-----------------------------------------+ +| Field | Type | Required?| Description | ++================+=======+==========+=========================================+ +| administrative\| string| No | Administrative state: enum: ‘inService’,| +| State | | | ‘outOfService’ | ++----------------+-------+----------+-----------------------------------------+ +| nicIdentifier | string| Yes | Network interface card identifier | ++----------------+-------+----------+-----------------------------------------+ +| operational\ | string| No | Operational state: enum: ‘inService’, | +| State | | | ‘outOfService’ | ++----------------+-------+----------+-----------------------------------------+ +| received\ | number| No | Cumulative count of broadcast packets | +| Broadcast\ | | | received as read at the end of the | +| Packets\ | | | measurement interval | +| Accumulated | | | | ++----------------+-------+----------+-----------------------------------------+ +| received\ | number| No | Count of broadcast packets received | +| Broadcast\ | | | within the measurement interval | +| PacketsDelta | | | | ++----------------+-------+----------+-----------------------------------------+ +| received\ | number| No | Cumulative count of discarded packets | +| Discarded\ | | | received as read at the end of the | +| Packets\ | | | measurement interval | +| Accumulated | | | | ++----------------+-------+----------+-----------------------------------------+ +| received\ | number| No | Count of discarded packets received | +| Discarded\ | | | within the measurement interval | +| PacketsDelta | | | | ++----------------+-------+----------+-----------------------------------------+ +| received\ | number| No | Cumulative count of error packets | +| ErrorPackets\ | | | received as read at the end of the | +| Accumulated | | | measurement interval | ++----------------+-------+----------+-----------------------------------------+ +| receivedError\ | number| No | Count of error packets received within | +| PacketsDelta | | | the measurement interval | ++----------------+-------+----------+-----------------------------------------+ +| received\ | number| No | Cumulative count of multicast packets | +| Multicast\ | | | received as read at the end of the | +| Packets\ | | | measurement interval | +| Accumulated | | | | ++----------------+-------+----------+-----------------------------------------+ +| received\ | number| No | Count of multicast packets received | +| Multicast\ | | | within the measurement interval | +| PacketsDelta | | | | ++----------------+-------+----------+-----------------------------------------+ +| received\ | number| No | Cumulative count of octets received as | +| Octets\ | | | read at the end of the measurement | +| Accumulated | | | interval | ++----------------+-------+----------+-----------------------------------------+ +| received\ | number| No | Count of octets received within the | +| OctetsDelta | | | measurement interval | ++----------------+-------+----------+-----------------------------------------+ +| received\ | number| No | Percentage of discarded packets | +| Percent\ | | | received; value = | +| Discard | | | (receivedDiscardedPacketsDelta / | +| | | | receivedTotalPacketsDelta) x 100, if | +| | | | denominator is nonzero, or 0, if | +| | | | otherwise. | ++----------------+-------+----------+-----------------------------------------+ +| received\ | number| No | Percentage of error packets received; | +| PercentError | | | value = (receivedErrorPacketsDelta / | +| | | | receivedTotalPacketsDelta) x 100, if | +| | | | denominator is nonzero, or 0, if | +| | | | otherwise. | ++----------------+-------+----------+-----------------------------------------+ +| receivedTotal\ | number| No | Cumulative count of all packets received| +| Packets\ | | | as read at the end of the measurement | +| Accumulated | | | interval | ++----------------+-------+----------+-----------------------------------------+ +| receivedTotal\ | number| No | Count of all packets received within the| +| PacketsDelta | | | measurement interval | ++----------------+-------+----------+-----------------------------------------+ +| received\ | number| No | Cumulative count of unicast packets | +| Unicast\ | | | received as read at the end of the | +| Packets\ | | | measurement interval | +| Accumulated | | | | ++----------------+-------+----------+-----------------------------------------+ +| received\ | number| No | Count of unicast packets received within| +| Unicast\ | | | the measurement interval | +| PacketsDelta | | | | ++----------------+-------+----------+-----------------------------------------+ +| received\ | number| No | Percentage of utilization received; | +| Utilization | | | value = (receivedOctetsDelta / (speed x | +| | | | (lastEpochMicrosec - startEpochMicrosec)| +| | | | )) x 100, if denominator is nonzero, or | +| | | | 0, if otherwise. | ++----------------+-------+----------+-----------------------------------------+ +| speed | number| No | Speed configured in mbps. | ++----------------+-------+----------+-----------------------------------------+ +| transmitted\ | number| No | Cumulative count of broadcast packets | +| Broadcast\ | | | transmitted as read at the end of the | +| Packets\ | | | measurement interval | +| Accumulated | | | | ++----------------+-------+----------+-----------------------------------------+ +| transmitted\ | number| No | Count of broadcast packets transmitted | +| Broadcast\ | | | within the measurement interval | +| PacketsDelta | | | | ++----------------+-------+----------+-----------------------------------------+ +| transmitted\ | number| No | Cumulative count of discarded packets | +| Discarded\ | | | transmitted as read at the end of the | +| Packets\ | | | measurement interval | +| Accumulated | | | | ++----------------+-------+----------+-----------------------------------------+ +| transmitted\ | number| No | Count of discarded packets transmitted | +| Discarded\ | | | within the measurement interval | +| PacketsDelta | | | | ++----------------+-------+----------+-----------------------------------------+ +| transmitted\ | number| No | Cumulative count of error packets | +| ErrorPackets\ | | | transmitted as read at the end of the | +| Accumulated | | | measurement interval | ++----------------+-------+----------+-----------------------------------------+ +| transmitted\ | number| No | Count of error packets transmitted | +| ErrorPackets\ | | | within the measurement interval | +| Delta | | | | ++----------------+-------+----------+-----------------------------------------+ +| transmitted\ | number| No | Cumulative count of multicast packets | +| Multicast\ | | | transmitted as read at the end of the | +| Packets\ | | | measurement interval | +| Accumulated | | | | ++----------------+-------+----------+-----------------------------------------+ +| transmitted\ | number| No | Count of multicast packets transmitted | +| Multicast\ | | | within the measurement interval | +| PacketsDelta | | | | ++----------------+-------+----------+-----------------------------------------+ +| transmitted\ | number| No | Cumulative count of octets transmitted | +| Octets\ | | | as read at the end of the measurement | +| Accumulated | | | interval | ++----------------+-------+----------+-----------------------------------------+ +| transmitted\ | number| No | Count of octets transmitted within the | +| OctetsDelta | | | measurement interval | ++----------------+-------+----------+-----------------------------------------+ +| transmitted\ | number| No | Percentage of discarded packets | +| PercentDiscard | | | transmitted; value = | +| | | | (transmittedDiscardedPacketsDelta / | +| | | | transmittedTotalPacketsDelta) x 100, if | +| | | | denominator is nonzero, or 0, if | +| | | | otherwise. | ++----------------+-------+----------+-----------------------------------------+ +| transmitted\ | number| No | Percentage of error packets received; | +| PercentError | | | value = (transmittedErrorPacketsDelta / | +| | | | transmittedTotalPacketsDelta) x 100, if | +| | | | denominator is nonzero, or 0, if | +| | | | otherwise. | ++----------------+-------+----------+-----------------------------------------+ +| transmitted\ | number| No | Cumulative count of all packets | +| TotalPackets\ | | | transmitted as read at the end of the | +| Accumulated | | | measurement interval | ++----------------+-------+----------+-----------------------------------------+ +| transmitted\ | number| No | Count of all packets transmitted within | +| TotalPackets\ | | | the measurement interval | +| Delta | | | | ++----------------+-------+----------+-----------------------------------------+ +| transmitted\ | number| No | Cumulative count of unicast packets | +| Unicast\ | | | transmitted as read at the end of the | +| Packets\ | | | measurement interval | +| Accumulated | | | | ++----------------+-------+----------+-----------------------------------------+ +| transmitted\ | number| No | Count of unicast packets transmitted | +| Unicast\ | | | within the measurement interval | +| PacketsDelta | | | | ++----------------+-------+----------+-----------------------------------------+ +| transmitted\ | number| No | Percentage of utilization transmitted; | +| Utilization | | | value = (transmittedOctetsDelta / (speed| +| | | | x (lastEpochMicrosec - | +| | | | startEpochMicrosec))) x 100, if | +| | | | denominator is nonzero, or 0, if | +| | | | otherwise. | ++----------------+-------+----------+-----------------------------------------+ +| values\ | string| Yes | Enumeration: ‘true’ or ‘false’. If | +| AreSuspect | | | ‘true’ then the vNicPerformance values | +| | | | are likely inaccurate due to counter | +| | | | overflow or other conditions. | ++----------------+-------+----------+-----------------------------------------+ Datatype: processorDimmAggregateThermalMargin ********************************************** @@ -1515,13 +2134,18 @@ The processorDimmAggregateThermalMargin datatype provides intelligent platform management interface (ipmi) processor dual inline memory module aggregate thermal margin metrics; it consists of the following fields: -+--------------------------------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+==================================================+==========+=============+===================================================================================================================+ -| processorDimmAggregateThermal MarginIdentifier | string | Yes | identifier for the aggregate thermal margin metrics from the processor dual inline memory module | -+--------------------------------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------+ -| thermalMargin | number | Yes | the difference between the DIMM's current temperature, in celsius, and the DIMM's throttling thermal trip point | -+--------------------------------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------+ ++-----------------+-------+----------+----------------------------------------+ +| Field | Type | Required?| Description | ++=================+=======+==========+========================================+ +| processor\ | string| Yes | identifier for the aggregate thermal | +| DimmAggregate\ | | | margin metrics from the processor dual | +| Thermal | | | inline memory module | +| MarginIdentifier| | | | ++-----------------+-------+----------+----------------------------------------+ +| thermalMargin | number| Yes | the difference between the DIMM's | +| | | | current temperature, in celsius, and | +| | | | the DIMM's throttling thermal trip | ++-----------------+-------+----------+----------------------------------------+ Datatype: processStats *********************** @@ -1529,25 +2153,34 @@ Datatype: processStats The processStats datatype provides metrics on system processes; it consists of the following fields: -+---------------------+----------+-------------+-------------------------------------------------------+ -| Field | Type | Required? | Description | -+=====================+==========+=============+=======================================================+ -| forkRate | number | No | The number of threads created since the last reboot | -+---------------------+----------+-------------+-------------------------------------------------------+ -| processIdentifier | string | Yes | processIdentifier | -+---------------------+----------+-------------+-------------------------------------------------------+ -| psStateBlocked | number | No | The number of processes in a blocked state | -+---------------------+----------+-------------+-------------------------------------------------------+ -| psStatePaging | number | No | The number of processes in a paging state | -+---------------------+----------+-------------+-------------------------------------------------------+ -| psStateRunning | number | No | The number of processes in a running state | -+---------------------+----------+-------------+-------------------------------------------------------+ -| psStateSleeping | number | No | The number of processes in a sleeping state | -+---------------------+----------+-------------+-------------------------------------------------------+ -| psStateStopped | number | No | The number of processes in a stopped state | -+---------------------+----------+-------------+-------------------------------------------------------+ -| psStateZombie | number | No | The number of processes in a zombie state | -+---------------------+----------+-------------+-------------------------------------------------------+ + ++-----------+-------+----------+----------------------------------------------+ +| Field | Type | Required?| Description | ++===========+=======+==========+==============================================+ +| forkRate | number| No | The number of threads created since the last | +| | | | reboot | ++-----------+-------+----------+----------------------------------------------+ +| process\ | string| Yes | processIdentifier | +| Identifier| | | | ++-----------+-------+----------+----------------------------------------------+ +| psState\ | number| No | The number of processes in a blocked state | +| Blocked | | | | ++-----------+-------+----------+----------------------------------------------+ +| psState\ | number| No | The number of processes in a paging state | +| Paging | | | | ++-----------+-------+----------+----------------------------------------------+ +| psState\ | number| No | The number of processes in a running state | +| Running | | | | ++-----------+-------+----------+----------------------------------------------+ +| psState\ | number| No | The number of processes in a sleeping state | +| Sleeping | | | | ++-----------+-------+----------+----------------------------------------------+ +| psState\ | number| No | The number of processes in a stopped state | +| Stopped | | | | ++-----------+-------+----------+----------------------------------------------+ +| psState\ | number| No | The number of processes in a zombie state | +| Zombie | | | | ++-----------+-------+----------+----------------------------------------------+ ‘Notification’ Domain Datatypes ++++++++++++++++++++++++++++++++ @@ -1557,27 +2190,42 @@ Datatype: notificationFields The notificationFields datatype consists of the following fields: -+-----------------------------+--------------------+-------------+------------------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+=============================+====================+=============+========================================================================================================================+ -| additionalFields | hashMap | No | Additional notification fields if needed | -+-----------------------------+--------------------+-------------+------------------------------------------------------------------------------------------------------------------------+ -| arrayOfNamedHashMap | namedHashMap [ ] | No | Array of named hashMaps | -+-----------------------------+--------------------+-------------+------------------------------------------------------------------------------------------------------------------------+ -| changeContact | string | No | Identifier for a contact related to the change | -+-----------------------------+--------------------+-------------+------------------------------------------------------------------------------------------------------------------------+ -| changeIdentifier | string | Yes | System or session identifier associated with the change | -+-----------------------------+--------------------+-------------+------------------------------------------------------------------------------------------------------------------------+ -| changeType | string | Yes | Describes what has changed for the entity, for example: configuration changed, capability added, capability removed… | -+-----------------------------+--------------------+-------------+------------------------------------------------------------------------------------------------------------------------+ -| newState | string | No | New state of the entity, for example: ‘inService’, ‘maintenance’, ‘outOfService’ | -+-----------------------------+--------------------+-------------+------------------------------------------------------------------------------------------------------------------------+ -| notificationFieldsVersion | string | Yes | Version of the notificationFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. | -+-----------------------------+--------------------+-------------+------------------------------------------------------------------------------------------------------------------------+ -| oldState | string | No | Previous state of the entity, for example: ‘inService’, ‘maintenance’, ‘outOfService’ | -+-----------------------------+--------------------+-------------+------------------------------------------------------------------------------------------------------------------------+ -| stateInterface | string | No | Card or port name of the entity that changed state | -+-----------------------------+--------------------+-------------+------------------------------------------------------------------------------------------------------------------------+ ++--------------+-----------+----------+---------------------------------------+ +| Field | Type | Required?| Description | ++==============+===========+==========+=======================================+ +| additional\ | hashMap | No | Additional notification fields if | +| Fields | | | needed | ++--------------+-----------+----------+---------------------------------------+ +| arrayOfNamed\| namedHash\| No | Array of named hashMaps | +| HashMap | Map [ ] | | | ++--------------+-----------+----------+---------------------------------------+ +| change\ | string | No | Identifier for a contact related to | +| Contact | | | the change | ++--------------+-----------+----------+---------------------------------------+ +| change\ | string | Yes | System or session identifier | +| Identifier | | | associated with the change | ++--------------+-----------+----------+---------------------------------------+ +| changeType | string | Yes | Describes what has changed for the | +| | | | entity, for example: configuration | +| | | | changed, capability added, capability | +| | | | removed… | ++--------------+-----------+----------+---------------------------------------+ +| newState | string | No | New state of the entity, for example: | +| | | | ‘inService’, ‘maintenance’, | +| | | | ‘outOfService’ | ++--------------+-----------+----------+---------------------------------------+ +| notification\| string | Yes | Version of the notificationFields | +| FieldsVersion| | | block as “#.#” where # is a digit; see| +| | | | section 1 for the correct digits to | +| | | | use. | ++--------------+-----------+----------+---------------------------------------+ +| oldState | string | No | Previous state of the entity, for | +| | | | example: ‘inService’, ‘maintenance’, | +| | | | ‘outOfService’ | ++--------------+-----------+----------+---------------------------------------+ +| state\ | string | No | Card or port name of the entity that | +| Interface | | | changed state | ++--------------+-----------+----------+---------------------------------------+ The fileReady notification event is used by 3GPP-compliant NFs to notify ONAP that a PM file is available for upload. The notificationFields are @@ -1617,17 +2265,22 @@ The otherFields datatype defines fields for events belonging to the 'other' domain of the commonEventHeader domain enumeration; it consists of the following fields: -+-----------------------+-----------------------+-------------+--------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+=======================+=======================+=============+==============================================================================================================+ -| arrayOfNamedHashMap | arrayOfNamedHashMap | No | Array of named hashMaps | -+-----------------------+-----------------------+-------------+--------------------------------------------------------------------------------------------------------------+ -| hashMap | hashMap | No | Array of name-value pairs | -+-----------------------+-----------------------+-------------+--------------------------------------------------------------------------------------------------------------+ -| jsonObjects | arrayOfJsonObject | No | Array of JSON objects described by name, schema and other meta-information | -+-----------------------+-----------------------+-------------+--------------------------------------------------------------------------------------------------------------+ -| otherFieldsVersion | string | Yes | Version of the otherFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. | -+-----------------------+-----------------------+-------------+--------------------------------------------------------------------------------------------------------------+ ++-------------+-------------+----------+--------------------------------------+ +| Field | Type | Required?| Description | ++=============+=============+==========+======================================+ +| arrayOf\ | arrayOf\ | No | Array of named hashMaps | +| NamedHashMap| NamedHashMap| | | ++-------------+-------------+----------+--------------------------------------+ +| hashMap | hashMap | No | Array of name-value pairs | ++-------------+-------------+----------+--------------------------------------+ +| jsonObjects | arrayOf\ | No | Array of JSON objects described by | +| | JsonObject | | name, schema and other | +| | | | meta-information | ++-------------+-------------+----------+--------------------------------------+ +| otherFields\| string | Yes | Version of the otherFields block as | +| Version | | | “#.#” where # is a digit; see section| +| | | | 1 for the correct digits to use. | ++-------------+-------------+----------+--------------------------------------+ ‘perf3gpp’ Domain Datatypes ++++++++++++++++++++++++++++ @@ -1639,23 +2292,32 @@ The measDataCollection datatype defines a 3GPP measurement collection structure aligned with the 3GPP PM format; it consists of the following fields: -+---------------------------------+----------------+-------------+------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+=================================+================+=============+====================================================================================+ -| formatVersion | string | No | 3GPP PM reporting file format version from pre-standard TS 28.550 v2.0.0 | -+---------------------------------+----------------+-------------+------------------------------------------------------------------------------------+ -| granularityPeriod | string | Yes | Granularity period for the PM report in seconds | -+---------------------------------+----------------+-------------+------------------------------------------------------------------------------------+ -| measInfoList | measInfo [ ] | Yes | Array of measInfo measurements | -+---------------------------------+----------------+-------------+------------------------------------------------------------------------------------+ -| measObjInstIdList | string [ ] | No | Array of monitored object local distinguished name ids per 3GPP TS 32.300 | -+---------------------------------+----------------+-------------+------------------------------------------------------------------------------------+ -| measuredEntityDn | string | Yes | Distinguished name per 3GPP TS 28.550 | -+---------------------------------+----------------+-------------+------------------------------------------------------------------------------------+ -| measuredEntitySoftwareVersion | string | No | Software version for the NF providing the PM data as specified in 3GPP TS 28.550 | -+---------------------------------+----------------+-------------+------------------------------------------------------------------------------------+ -| measuredEntityUserName | string | No | User Definable name for the measured object per 3GPP TS 28.550 | -+---------------------------------+----------------+-------------+------------------------------------------------------------------------------------+ ++----------------+---------+----------+---------------------------------------+ +| Field | Type | Required?| Description | ++================+=========+==========+=======================================+ +| format\ | string | No | 3GPP PM reporting file format version | +| Version | | | from pre-standard TS 28.550 v2.0.0 | ++----------------+---------+----------+---------------------------------------+ +| granularity\ | string | Yes | Granularity period for the PM report | +| Period | | | in seconds | ++----------------+---------+----------+---------------------------------------+ +| measInfoList | measInfo| Yes | Array of measInfo measurements | +| | [ ] | | | ++----------------+---------+----------+---------------------------------------+ +| measObjInst\ | string | No | Array of monitored object local | +| IdList | [ ] | | distinguished name ids per 3GPP TS | +| | | | 32.300 | ++----------------+---------+----------+---------------------------------------+ +| measured\ | string | Yes | Distinguished name per 3GPP TS 28.550 | +| EntityDn | | | | ++----------------+---------+----------+---------------------------------------+ +| measuredEntity\| string | No | Software version for the NF providing | +| SoftwareVersion| | | the PM data as specified in 3GPP TS | +| | | | 28.550 | ++----------------+---------+----------+---------------------------------------+ +| measuredEntity\| string | No | User Definable name for the measured | +| UserName | | | object per 3GPP TS 28.550 | ++----------------+---------+----------+---------------------------------------+ Datatype: measInfo ******************** @@ -1663,17 +2325,23 @@ Datatype: measInfo The measInfo datatype provides measurement information; it consists of the following fields: -+--------------+-------------------------------------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+==============+=================================================+=============+=====================================================================================================================================+ -| jobId | string | No | Name of the measurement job | -+--------------+-------------------------------------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| measInfoId | oneOf [ measInfoIdInteger, measInfoIdString ] | No | Measurement group Identifier | -+--------------+-------------------------------------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| measTypes | oneOf [ measTypesInteger, measTypesString ] | Yes | Array of measurement identifiers associated with the measurement results expressed as integers for efficiency rather than strings | -+--------------+-------------------------------------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| measValues | measValues [ ] | Yes | Array of measValues | -+--------------+-------------------------------------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ ++-------+--------------------------+----------+-------------------------------+ +| Field | Type | Required?| Description | ++=======+==========================+==========+===============================+ +| jobId | string | No | Name of the measurement job | ++-------+--------------------------+----------+-------------------------------+ +| meas\ | oneOf [ measInfoIdInteger| No | Measurement group Identifier | +| InfoId| , measInfoIdString ] | | | ++-------+--------------------------+----------+-------------------------------+ +| meas\ | oneOf [ measTypesInteger | Yes | Array of measurement | +| Types | , measTypesString ] | | identifiers associated with | +| | | | the measurement results | +| | | | expressed as integers for | +| | | | efficiency rather than strings| ++-------+--------------------------+----------+-------------------------------+ +| meas\ | measValues [ ] | Yes | Array of measValues | +| Values| | | | ++-------+--------------------------+----------+-------------------------------+ Datatype: measInfoIdInteger **************************** @@ -1681,11 +2349,11 @@ Datatype: measInfoIdInteger The measInfoIdInteger datatype provides an integer measurement group identifier; it consists of the following fields: -+---------------+-----------+-------------+----------------------------------------+ -| Field | Type | Required? | Description | -+===============+===========+=============+========================================+ -| iMeasInfoId | integer | Yes | Integer measurement group Identifier | -+---------------+-----------+-------------+----------------------------------------+ ++---------------+---------+----------+--------------------------------------+ +| Field | Type | Required?| Description | ++===============+=========+==========+======================================+ +| iMeasInfoId | integer | Yes | Integer measurement group Identifier | ++---------------+---------+----------+--------------------------------------+ Datatype: measInfoIdString *************************** @@ -1693,11 +2361,11 @@ Datatype: measInfoIdString The measInfoIdString datatype provides a string measurement group identifier; it consists of the following fields: -+---------------+-----------+-------------+---------------------------------------+ -| Field | Type | Required? | Description | -+===============+===========+=============+=======================================+ -| sMeasInfoId | integer | Yes | String measurement group Identifier | -+---------------+-----------+-------------+---------------------------------------+ ++---------------+-----------+----------+--------------------------------------+ +| Field | Type | Required?| Description | ++===============+===========+==========+======================================+ +| sMeasInfoId | integer | Yes | String measurement group Identifier | ++---------------+-----------+----------+--------------------------------------+ Datatype: measResultInteger **************************** @@ -1762,11 +2430,12 @@ The measTypesInteger datatype provides an array of integer measurement identifiers associated with the measurement results; it consists of the following fields: -+------------------+---------------+-------------+------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+==================+===============+=============+====================================================================================+ -| iMeasTypesList | integer [ ] | Yes | Array of integer measurement identifiers associated with the measurement results | -+------------------+---------------+-------------+------------------------------------------------------------------------------------+ ++----------+--------+----------+----------------------------------------------+ +| Field | Type | Required?| Description | ++==========+========+==========+==============================================+ +| iMeas\ | integer| Yes | Array of integer measurement identifiers | +| TypesList| [ ] | | associated with the measurement results | ++----------+--------+----------+----------------------------------------------+ Datatype: measTypesString ************************** @@ -1775,11 +2444,12 @@ The measTypesString datatype provides an array of string measurement identifiers associated with the measurement results; it consists of the following fields: -+------------------+--------------+-------------+-----------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+==================+==============+=============+===================================================================================+ -| sMeasTypesList | string [ ] | Yes | Array of string measurement identifiers associated with the measurement results | -+------------------+--------------+-------------+-----------------------------------------------------------------------------------+ ++----------+-------+----------+-----------------------------------------------+ +| Field | Type | Required?| Description | ++==========+=======+==========+===============================================+ +| sMeas\ | string| Yes | Array of string measurement identifiers | +| TypesList| [ ] | | associated with the measurement results | ++----------+-------+----------+-----------------------------------------------+ Datatype: measValues ********************* @@ -1787,17 +2457,28 @@ Datatype: measValues The measValues datatype provides 3GPP measurement values; it consists of the following fields: -+-------------------+---------------------------------------------------------------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+===================+=====================================================================================================================+=============+===================================================================================+ -| measObjAddlFlds | hashMap | No | Additional key-value pairs if needed | -+-------------------+---------------------------------------------------------------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------+ -| measObjInstId | measDataCollection | Yes | Monitored object local distinguished name per 3GPP TS 32.300 and 3GPP TS 32.432 | -+-------------------+---------------------------------------------------------------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------+ -| measResults | Array of items where each item is oneOf [ measResultInteger, measResultNull, measResultNumber, measResultString ] | Yes | Array of results | -+-------------------+---------------------------------------------------------------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------+ -| suspectFlag | string | No | Enumeration: ‘true’, ‘false’. Indicates if the values are suspect | -+-------------------+---------------------------------------------------------------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------+ ++---------+----------------------------------+----------+---------------------+ +| Field | Type | Required?| Description | ++=========+==================================+==========+=====================+ +| measObj\| hashMap | No | Additional key-value| +| AddlFlds| | | pairs if needed | ++---------+----------------------------------+----------+---------------------+ +| measObj\|measDataCollection | Yes | Monitored object | +| InstId | | | local distinguished | +| | | | name per 3GPP TS | +| | | | 32.300 and 3GPP TS | +| | | | 32.432 | ++---------+----------------------------------+----------+---------------------+ +| meas\ | Array of items where each item is| Yes | Array of results | +| Results | oneOf [ measResultInteger, | | | +| | measResultNull, measResultNumber,| | | +| | measResultString ] | | | ++---------+----------------------------------+----------+---------------------+ +| suspect\| string | No | Enumeration: ‘true’,| +| Flag | | | ‘false’. Indicates | +| | | | if the values are | +| | | | suspect | ++---------+----------------------------------+----------+---------------------+ Datatype: perf3gppFields ************************* @@ -1807,15 +2488,18 @@ based on 3GPP TS 28.550, belonging to the 'perf3gpp' domain of the commonEventHeader domain enumeration; it consists of the following fields: -+-------------------------+----------------------+-------------+-----------------------------------------+ -| Field | Type | Required? | Description | -+=========================+======================+=============+=========================================+ -| eventAddlFields | hashMap | No | Additional key-value pairs if needed | -+-------------------------+----------------------+-------------+-----------------------------------------+ -| measDataCollection | measDataCollection | Yes | 3GPP measurement collection structure | -+-------------------------+----------------------+-------------+-----------------------------------------+ -| perf3gppFieldsVersion | string | Yes | Version of the perf3gpp event | -+-------------------------+----------------------+-------------+-----------------------------------------+ ++--------------+-----------+----------+---------------------------------------+ +| Field | Type | Required?| Description | ++==============+===========+==========+=======================================+ +| eventAddl\ | hashMap | No | Additional key-value pairs if needed | +| Fields | | | | ++--------------+-----------+----------+---------------------------------------+ +| measData\ | measData | Yes | 3GPP measurement collection structure | +| Collection | Collection| | | ++--------------+-----------+----------+---------------------------------------+ +| perf3gpp\ | string | Yes | Version of the perf3gpp event | +| FieldsVersion| | | | ++--------------+-----------+----------+---------------------------------------+ ‘pnfRegistration’ Domain Datatypes ++++++++++++++++++++++++++++++++++++ @@ -1827,35 +2511,53 @@ The pnfRegistrationFields datatype defines fields for events belonging to the 'pnfRegistration' domain of the commonEventHeader domain enumeration; it consists of the following fields: -+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+================================+===========+=============+========================================================================================================================+ -| additionalFields | hashMap | No | Additional pnfRegistration fields if needed | -+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+ -| lastServiceDate | string | No | TS 32.692 dateOfLastService = date of last service; e.g. 15022017 | -+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+ -| macAddress | string | No | MAC address of OAM interface of the unit | -+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+ -| manufactureDate | string | No | TS 32.692 dateOfManufacture = manufacture date of the unit; 24032016 | -+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+ -| modelNumber | string | No | TS 32.692 versionNumber = version of the unit from vendor; e.g. AJ02. Maps to AAI equip-model | -+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+ -| oamV4IpAddress | string | No | IPv4 m-plane IP address to be used by the manager to contact the PNF | -+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+ -| oamV6IpAddress | string | No | IPv6 m-plane IP address to be used by the manager to contact the PNF | -+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+ -| pnfRegistrationFieldsVersion | string | Yes | Version of the pnfRegistrationFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. | -+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+ -| serialNumber | string | No | TS 32.692 serialNumber = serial number of the unit; e.g. 6061ZW3 | -+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+ -| softwareVersion | string | No | TS 32.692 swName = active SW running on the unit; e.g. 5gDUv18.05.201 | -+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+ -| unitFamily | string | No | TS 32.692 vendorUnitFamilyType = general type of HW unit; e.g. BBU | -+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+ -| unitType | string | No | TS 32.692 vendorUnitTypeNumber = vendor name for the unit; e.g. Airscale | -+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+ -| vendorName | string | No | TS 32.692 vendorName = name of manufacturer; e.g. Nokia. Maps to AAI equip-vendor | -+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+ ++-----------------+--------+----------+---------------------------------------+ +| Field | Type | Required?| Description | ++=================+========+==========+=======================================+ +| additional\ | hashMap| No | Additional pnfRegistration fields if | +| Fields | | | needed | ++-----------------+--------+----------+---------------------------------------+ +| last\ | string | No | TS 32.692 dateOfLastService = date of | +| ServiceDate | | | last service; e.g. 15022017 | ++-----------------+--------+----------+---------------------------------------+ +| macAddress | string | No | MAC address of OAM interface of the | +| | | | unit | ++-----------------+--------+----------+---------------------------------------+ +| manufacture\ | string | No | TS 32.692 dateOfManufacture = | +| Date | | | manufacture date of the unit; 24032016| ++-----------------+--------+----------+---------------------------------------+ +| modelNumber | string | No | TS 32.692 versionNumber = version of | +| | | | the unit from vendor; e.g. AJ02. Maps | +| | | | to AAI equip-model | ++-----------------+--------+----------+---------------------------------------+ +| oamV4\ | string | No | IPv4 m-plane IP address to be used by | +| IpAddress | | | the manager to contact the PNF | ++-----------------+--------+----------+---------------------------------------+ +| oamV6\ | string | No | IPv6 m-plane IP address to be used by | +| IpAddress | | | the manager to contact the PNF | ++-----------------+--------+----------+---------------------------------------+ +| pnfRegistration\| string | Yes | Version of the pnfRegistrationFields | +| FieldsVersion | | | block as “#.#” where # is a digit; see| +| | | | section 1 for the correct digits to | +| | | | use. | ++-----------------+--------+----------+---------------------------------------+ +| serialNumber | string | No | TS 32.692 serialNumber = serial number| +| | | | of the unit; e.g. 6061ZW3 | ++-----------------+--------+----------+---------------------------------------+ +| software\ | string | No | TS 32.692 swName = active SW running | +| Version | | | on the unit; e.g. 5gDUv18.05.201 | ++-----------------+--------+----------+---------------------------------------+ +| unitFamily | string | No | TS 32.692 vendorUnitFamilyType = | +| | | | general type of HW unit; e.g. BBU | ++-----------------+--------+----------+---------------------------------------+ +| unitType | string | No | TS 32.692 vendorUnitTypeNumber = | +| | | | vendor name for the unit; e.g. | +| | | | Airscale | ++-----------------+--------+----------+---------------------------------------+ +| vendorName | string | No | TS 32.692 vendorName = name of | +| | | | manufacturer; e.g. Nokia. Maps to AAI | +| | | | equip-vendor | ++-----------------+--------+----------+---------------------------------------+ ‘State Change’ Domain Datatypes ++++++++++++++++++++++++++++++++ @@ -1865,19 +2567,25 @@ Datatype: stateChangeFields The stateChangeFields datatype consists of the following fields: -+----------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+============================+===========+=============+====================================================================================================================+ -| additionalFields | hashMap | No | Additional stateChange fields if needed | -+----------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------+ -| newState | string | Yes | New state of the entity: ‘inService’, ‘maintenance’, ‘outOfService’ | -+----------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------+ -| oldState | string | Yes | Previous state of the entity: ‘inService’, ‘maintenance’, ‘outOfService’ | -+----------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------+ -| stateChangeFieldsVersion | string | Yes | Version of the stateChangeFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. | -+----------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------+ -| stateInterface | string | Yes | Card or port name of the entity that changed state | -+----------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------+ ++--------------+--------+----------+------------------------------------------+ +| Field | Type | Required?| Description | ++==============+========+==========+==========================================+ +| additional\ | hashMap| No | Additional stateChange fields if needed | +| Fields | | | | ++--------------+--------+----------+------------------------------------------+ +| newState | string | Yes | New state of the entity: ‘inService’, | +| | | | ‘maintenance’, ‘outOfService’ | ++--------------+--------+----------+------------------------------------------+ +| oldState | string | Yes | Previous state of the entity: ‘inService’| +| | | | , ‘maintenance’, ‘outOfService’ | ++--------------+--------+----------+------------------------------------------+ +| stateChange\ | string | Yes | Version of the stateChangeFields block as| +| FieldsVersion| | | “#.#” where # is a digit; see section 1 | +| | | | for the correct digits to use. | ++--------------+--------+----------+------------------------------------------+ +| state\ | string | Yes | Card or port name of the entity that | +| Interface | | | changed state | ++--------------+--------+----------+------------------------------------------+ ‘Syslog’ Domain Datatypes ++++++++++++++++++++++++++ @@ -1887,119 +2595,141 @@ Datatype: syslogFields The syslogFields datatype consists of the following fields: -+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+=======================+===========+=============+======================================================================================================================================================================================+ -| additionalFields | hashMap | No | Additional syslog fields if needed Ex: {“name1”: ”value1”, “name2: “value2” … } | -+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| eventSourceHost | string | No | Hostname of the device | -+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| eventSourceType | string | Yes | Examples: ‘other’, ‘router’, ‘switch’, ‘host’, ‘card’, ‘port’, ‘slotThreshold’, ‘portThreshold’, ‘virtualMachine’, ‘virtualNetworkFunction’ | -+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| syslogFacility | integer | No | Numeric code from 0 to 23 for facility: | -| | | | | -| | | | 0 kernel messages | -| | | | | -| | | | 1 user-level messages | -| | | | | -| | | | 2 mail system | -| | | | | -| | | | 3 system daemons | -| | | | | -| | | | 4 security/authorization messages | -| | | | | -| | | | 5 messages generated internally by syslogd | -| | | | | -| | | | 6 line printer subsystem | -| | | | | -| | | | 7 network news subsystem | -| | | | | -| | | | 8 UUCP subsystem | -| | | | | -| | | | 9 clock daemon | -| | | | | -| | | | 10 security/authorization messages | -| | | | | -| | | | 11 FTP daemon | -| | | | | -| | | | 12 NTP subsystem | -| | | | | -| | | | 13 log audit | -| | | | | -| | | | 14 log alert | -| | | | | -| | | | 15 clock daemon (note 2) | -| | | | | -| | | | 16 local use 0 (local0) | -| | | | | -| | | | 17 local use 1 (local1) | -| | | | | -| | | | 18 local use 2 (local2) | -| | | | | -| | | | 19 local use 3 (local3) | -| | | | | -| | | | 20 local use 4 (local4) | -| | | | | -| | | | 21 local use 5 (local5) | -| | | | | -| | | | 22 local use 6 (local6) | -| | | | | -| | | | 23 local use 7 (local7 ) | -+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| syslogFieldsVersion | string | Yes | Version of the syslogFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. | -+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| syslogMsg | string | Yes | Syslog message | -+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| syslogMsgHost | string | No | Hostname parsed from non-VES syslog message | -+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| syslogPri | integer | No | 0-192 | -| | | | | -| | | | Combined Severity and Facility (see rfc5424) | -+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| syslogProc | string | No | Identifies the application that originated the message | -+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| syslogProcId | number | No | The process number assigned by the OS when the application was started | -+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| syslogSData | string | No | A <space> separated list of key=”value” pairs following the rfc5424 standard for SD-ELEMENT. | -| | | | | -| | | | ***Deprecated *** | -| | | | | -| | | | The entire rfc5424 syslogSData object, including square brackets [ ], SD-ID and list of SD-PARAMs | -+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| syslogSdId | string | No | 0-32 char in format name@number, | -| | | | | -| | | | i.e., ourSDID@32473 | -+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| syslogSev | string | No | Level-of-severity text enumeration defined below: | -| | | | | -| | | | *Text* *Sev* *Description* | -| | | | | -| | | | Emergency 0 system is unusable | -| | | | | -| | | | Alert 1 action must be taken immediately | -| | | | | -| | | | Critical 2 critical conditions | -| | | | | -| | | | Error 3 error conditions | -| | | | | -| | | | Warning 4 warning conditions | -| | | | | -| | | | Notice 5 normal but significant condition | -| | | | | -| | | | Info 6 Informational messages | -| | | | | -| | | | Debug 7 debug-level messages | -+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| syslogTag | string | Yes | Also known as MsgId. Brief non-spaced text indicating the type of message such as ‘TCPOUT’ or ‘BGP\_STATUS\_CHANGE’; ‘NILVALUE’ should be used when no other value can be provided | -+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| syslogTs | string | No | Timestamp parsed from non-VES syslog message | -+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| syslogVer | number | No | IANA assigned version of the syslog protocol specification: | -| | | | | -| | | | 0: VES | -| | | | | -| | | | 1: IANA RFC5424 | -+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------+--------+----------+--------------------------------------------+ +| Field | Type | Required?| Description | ++============+========+==========+============================================+ +| additional\| hashMap| No | Additional syslog fields if needed Ex: | +| Fields | | | {“name1”: ”value1”, “name2: “value2” … } | ++------------+--------+----------+--------------------------------------------+ +| event\ | string | No | Hostname of the device | +| SourceHost | | | | ++------------+--------+----------+--------------------------------------------+ +| event\ | string | Yes | Examples: ‘other’, ‘router’, ‘switch’, | +| SourceType | | | ‘host’, ‘card’, ‘port’, ‘slotThreshold’, | +| | | | ‘portThreshold’, ‘virtualMachine’, | +| | | | ‘virtualNetworkFunction’ | ++------------+--------+----------+--------------------------------------------+ +| syslog\ | integer| No | Numeric code from 0 to 23 for facility: | +| Facility | | | | +| | | | | +| | | | 0 kernel messages | +| | | | | +| | | | 1 user-level messages | +| | | | | +| | | | 2 mail system | +| | | | | +| | | | 3 system daemons | +| | | | | +| | | | 4 security/authorization messages | +| | | | | +| | | | 5 messages generated internally by syslogd | +| | | | | +| | | | 6 line printer subsystem | +| | | | | +| | | | 7 network news subsystem | +| | | | | +| | | | 8 UUCP subsystem | +| | | | | +| | | | 9 clock daemon | +| | | | | +| | | | 10 security/authorization messages | +| | | | | +| | | | 11 FTP daemon | +| | | | | +| | | | 12 NTP subsystem | +| | | | | +| | | | 13 log audit | +| | | | | +| | | | 14 log alert | +| | | | | +| | | | 15 clock daemon (note 2) | +| | | | | +| | | | 16 local use 0 (local0) | +| | | | | +| | | | 17 local use 1 (local1) | +| | | | | +| | | | 18 local use 2 (local2) | +| | | | | +| | | | 19 local use 3 (local3) | +| | | | | +| | | | 20 local use 4 (local4) | +| | | | | +| | | | 21 local use 5 (local5) | +| | | | | +| | | | 22 local use 6 (local6) | +| | | | | +| | | | 23 local use 7 (local7 ) | ++------------+--------+----------+--------------------------------------------+ +| syslog\ | string | Yes | Version of the syslogFields block as “#.#” | +| Fields\ | | | where # is a digit; see section 1 for the | +| Version | | | correct digits to use. | ++------------+--------+----------+--------------------------------------------+ +| syslogMsg | string | Yes | Syslog message | ++------------+--------+----------+--------------------------------------------+ +| syslog\ | string | No | Hostname parsed from non-VES syslog message| +| MsgHost | | | | ++------------+--------+----------+--------------------------------------------+ +| syslogPri | integer| No | 0-192 | +| | | | | +| | | | Combined Severity and Facility(see rfc5424)| ++------------+--------+----------+--------------------------------------------+ +| syslogProc | string | No | Identifies the application that originated | +| | | | the message | ++------------+--------+----------+--------------------------------------------+ +| syslog\ | number | No | The process number assigned by the OS when | +| ProcId | | | the application was started | ++------------+--------+----------+--------------------------------------------+ +| syslog\ | string | No | A <space> separated list of key=”value” | +| SData | | | pairs following the rfc5424 standard for | +| | | | SD-ELEMENT. | +| | | | | +| | | | ***Deprecated *** | +| | | | | +| | | | The entire rfc5424 syslogSData object, | +| | | | including square brackets [ ], SD-ID and | +| | | | list of SD-PARAMs | ++------------+--------+----------+--------------------------------------------+ +| syslogSdId | string | No | 0-32 char in format name@number, | +| | | | | +| | | | i.e., ourSDID@32473 | ++------------+--------+----------+--------------------------------------------+ +| syslogSev | string | No | Level-of-severity text enumeration defined | +| | | | below: | +| | | | | +| | | | *Text* *Sev* *Description* | +| | | | | +| | | | Emergency 0 system is unusable | +| | | | | +| | | | Alert 1 action must be taken immediately | +| | | | | +| | | | Critical 2 critical conditions | +| | | | | +| | | | Error 3 error conditions | +| | | | | +| | | | Warning 4 warning conditions | +| | | | | +| | | | Notice 5 normal but significant condition | +| | | | | +| | | | Info 6 Informational messages | +| | | | | +| | | | Debug 7 debug-level messages | ++------------+--------+----------+--------------------------------------------+ +| syslogTag | string | Yes | Also known as MsgId. Brief non-spaced text | +| | | | indicating the type of message such as | +| | | | ‘TCPOUT’ or ‘BGP\_STATUS\_CHANGE’; | +| | | | ‘NILVALUE’ should be used when no other | +| | | | value can be provided | ++------------+--------+----------+--------------------------------------------+ +| syslogTs | string | No | Timestamp parsed from non-VES syslog | +| | | | message | ++------------+--------+----------+--------------------------------------------+ +| syslogVer | number | No | IANA assigned version of the syslog | +| | | | protocol specification: | +| | | | | +| | | | 0: VES | +| | | | | +| | | | 1: IANA RFC5424 | ++------------+--------+----------+--------------------------------------------+ Examples of syslogSData : @@ -2027,15 +2757,17 @@ Datatype: counter The counter datatype consists of the following fields: -+---------------------+-----------+-------------+--------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+=====================+===========+=============+================================================================================+ -| criticality | string | Yes | Enumeration: ‘CRIT’, ‘MAJ’ | -+---------------------+-----------+-------------+--------------------------------------------------------------------------------+ -| hashMap | hashMap | Yes | Key is the name of the counter and value is the current value of the counter | -+---------------------+-----------+-------------+--------------------------------------------------------------------------------+ -| threshholdCrossed | string | Yes | Last threshold that was crossed | -+---------------------+-----------+-------------+--------------------------------------------------------------------------------+ ++------------+--------+----------+--------------------------------------------+ +| Field | Type | Required?| Description | ++============+========+==========+============================================+ +| criticality| string | Yes | Enumeration: ‘CRIT’, ‘MAJ’ | ++------------+--------+----------+--------------------------------------------+ +| hashMap | hashMap| Yes | Key is the name of the counter and value is| +| | | | the current value of the counter | ++------------+--------+----------+--------------------------------------------+ +| threshhold\| string | Yes | Last threshold that was crossed | +| Crossed | | | | ++------------+--------+----------+--------------------------------------------+ Datatype: thresholdCrossingAlertFields **************************************** @@ -2043,41 +2775,64 @@ Datatype: thresholdCrossingAlertFields The thresholdCrossingAlertFields datatype consists of the following fields: -+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+===================================+===============+=============+===============================================================================================================================+ -| additionalFields | hashMap | No | Additional threshold crossing alert fields if needed | -+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+ -| additionalParameters | counter [ ] | Yes | Array of performance counters | -+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+ -| alertAction | string | Yes | Enumeration: ‘SET’, ‘CONT’, ‘CLEAR’ | -+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+ -| alertDescription | string | Yes | Unique short alert description (e.g., NE-CPUMEM) | -+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+ -| alertType | string | Yes | Enumeration: ‘CARD-ANOMALY’, ‘INTERFACE-ANOMALY’, ELEMENT-ANOMALY’, ‘SERVICE-ANOMALY’ | -+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+ -| alertValue | string | No | Calculated API value (if applicable) | -+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+ -| associatedAlertIdList | string [ ] | No | List of eventIds associated with the event being reported | -+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+ -| collectionTimestamp | string | Yes | Time when the performance collector picked up the data; with RFC 2822 compliant format: ‘Sat, 13 Mar 2010 11:29:05 -0800’ | -+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+ -| dataCollector | string | No | Specific performance collector instance used | -+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+ -| elementType | string | No | Type of network element (internal AT&T field) | -+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+ -| eventSeverity | string | Yes | Event severity or priority enumeration: ‘CRITICAL’, ‘MAJOR’, ‘MINOR’, ‘WARNING’, ‘NORMAL’ | -+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+ -| eventStartTimestamp | string | Yes | Time closest to when the measurement was made; with RFC 2822 compliant format: ‘Sat, 13 Mar 2010 11:29:05 -0800’ | -+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+ -| interfaceName | string | No | Physical or logical port or card (if applicable) | -+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+ -| networkService | string | No | Network name (internal AT&T field) | -+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+ -| possibleRootCause | string | No | Reserved for future use | -+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+ -| thresholdCrossing FieldsVersion | string | Yes | Version of the thresholdCrossingAlertFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. | -+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+ ++------------+------------+----------+----------------------------------------+ +| Field | Type | Required?| Description | ++============+============+==========+========================================+ +| additional\| hashMap | No | Additional threshold crossing alert | +| Fields | | | fields if needed | ++------------+------------+----------+----------------------------------------+ +| additional\| counter [ ]| Yes | Array of performance counters | +| Parameters | | | | ++------------+------------+----------+----------------------------------------+ +| alert\ | string | Yes | Enumeration: ‘SET’, ‘CONT’, ‘CLEAR’ | +| Action | | | | ++------------+------------+----------+----------------------------------------+ +| alert\ | string | Yes | Unique short alert description (e.g., | +| Description| | | NE-CPUMEM) | ++------------+------------+----------+----------------------------------------+ +| alertType | string | Yes | Enumeration: ‘CARD-ANOMALY’, | +| | | | ‘INTERFACE-ANOMALY’, ELEMENT-ANOMALY’, | +| | | | ‘SERVICE-ANOMALY’ | ++------------+------------+----------+----------------------------------------+ +| alertValue | string | No | Calculated API value (if applicable) | ++------------+------------+----------+----------------------------------------+ +| associated\| string [ ] | No | List of eventIds associated with the | +| AlertIdList| | | event being reported | ++------------+------------+----------+----------------------------------------+ +| collection\| string | Yes | Time when the performance collector | +| Timestamp | | | picked up the data; with RFC 2822 | +| | | | compliant format: ‘Sat, 13 Mar 2010 | +| | | | 11:29:05 -0800’ | ++------------+------------+----------+----------------------------------------+ +| data\ | string | No | Specific performance collector instance| +| Collector | | | used | ++------------+------------+----------+----------------------------------------+ +| elementType| string | No | Type of network element (internal AT&T | +| | | | field) | ++------------+------------+----------+----------------------------------------+ +| event\ | string | Yes | Event severity or priority enumeration:| +| Severity | | | ‘CRITICAL’, ‘MAJOR’, ‘MINOR’, ‘WARNING’| +| | | | , ‘NORMAL’ | ++------------+------------+----------+----------------------------------------+ +| eventStart\| string | Yes | Time closest to when the measurement | +| Timestamp | | | was made; with RFC 2822 compliant | +| | | | format: ‘Sat, 13 Mar 2010 11:29:05 | +| | | | -0800’ | ++------------+------------+----------+----------------------------------------+ +| interface\ | string | No | Physical or logical port or card (if | +| Name | | | applicable) | ++------------+------------+----------+----------------------------------------+ +| network\ | string | No | Network name (internal AT&T field) | +| Service | | | | ++------------+------------+----------+----------------------------------------+ +| possible\ | string | No | Reserved for future use | +| RootCause | | | | ++------------+------------+----------+----------------------------------------+ +| threshold\ | string | Yes | Version of the | +| Crossing | | | thresholdCrossingAlertFields block as | +| Fields\ | | | “#.#” where # is a digit; see section 1| +| Version | | | for the correct digits to use. | ++------------+------------+----------+----------------------------------------+ Technology Specific Datatypes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -2090,184 +2845,313 @@ Datatype: gtpPerFlowMetrics The gtpPerFlowMetrics datatype consists of the following fields: -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+====================================+===========+=============+===================================================================================================================================================================================================================+ -| avgBitErrorRate | number | Yes | Average bit error rate | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| avgPacketDelayVariation | number | Yes | Average packet delay variation or jitter in milliseconds for received packets: Average difference between the packet timestamp and time received for all pairs of consecutive packets | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| avgPacketLatency | number | Yes | Average delivery latency | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| avgReceiveThroughput | number | Yes | Average receive throughput | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| avgTransmitThroughput | number | Yes | Average transmit throughput | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| durConnectionFailedStatus | number | No | Duration of failed state in milliseconds, computed as the cumulative time between a failed echo request and the next following successful error request, over this reporting interval | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| durTunnelFailedStatus | number | No | Duration of errored state, computed as the cumulative time between a tunnel error indicator and the next following non-errored indicator, over this reporting interval | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| flowActivatedBy | string | No | Endpoint activating the flow | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| flowActivationEpoch | number | Yes | Time the connection is activated in the flow (connection) being reported on, or transmission time of the first packet if activation time is not available | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| flowActivationMicrosec | number | Yes | Integer microseconds for the start of the flow connection | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| flowActivationTime | string | No | Time the connection is activated in the flow being reported on, or transmission time of the first packet if activation time is not available; with RFC 2822 compliant format: ‘Sat, 13 Mar 2010 11:29:05 -0800’ | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| flowDeactivatedBy | string | No | Endpoint deactivating the flow | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| flowDeactivationEpoch | number | Yes | Time for the start of the flow connection, in integer UTC epoch time aka UNIX time | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| flowDeactivationMicrosec | number | Yes | Integer microseconds for the start of the flow connection | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| flowDeactivationTime | string | Yes | Transmission time of the first packet in the flow connection being reported on; with RFC 2822 compliant format: ‘Sat, 13 Mar 2010 11:29:05 -0800’ | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| flowStatus | string | Yes | Connection status at reporting time as a working / inactive / failed indicator value | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| gtpConnectionStatus | string | No | Current connection state at reporting time | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| gtpTunnelStatus | string | No | Current tunnel state at reporting time | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| ipTosCountList | hashMap | No | Array of key: value pairs where the keys are drawn from the IP Type-of-Service identifiers which range from '0' to '255', and the values are the count of packets that had those ToS identifiers in the flow | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| ipTosList | string | No | Array of unique IP Type-of-Service values observed in the flow where values range from '0' to '255' | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| largePacketRtt | number | No | large packet round trip time | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| largePacketThreshold | number | No | large packet threshold being applied | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| maxPacketDelayVariation | number | Yes | Maximum packet delay variation or jitter in milliseconds for received packets: Maximum of the difference between the packet timestamp and time received for all pairs of consecutive packets | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| maxReceiveBitRate | number | No | maximum receive bit rate" | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| maxTransmitBitRate | number | No | maximum transmit bit rate | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| mobileQciCosCountList | hashMap | No | array of key: value pairs where the keys are drawn from LTE QCI or UMTS class of service strings, and the values are the count of packets that had those strings in the flow | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| mobileQciCosList | string | No | Array of unique LTE QCI or UMTS class-of-service values observed in the flow | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numActivationFailures | number | Yes | Number of failed activation requests, as observed by the reporting node | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numBitErrors | number | Yes | number of errored bits | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numBytesReceived | number | Yes | number of bytes received, including retransmissions | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numBytesTransmitted | number | Yes | number of bytes transmitted, including retransmissions | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numDroppedPackets | number | Yes | number of received packets dropped due to errors per virtual interface | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numGtpEchoFailures | number | No | Number of Echo request path failures where failed paths are defined in 3GPP TS 29.281 sec 7.2.1 and 3GPP TS 29.060 sec. 11.2 | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numGtpTunnelErrors | number | No | Number of tunnel error indications where errors are defined in 3GPP TS 29.281 sec 7.3.1 and 3GPP TS 29.060 sec. 11.1 | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numHttpErrors | number | No | Http error count | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numL7BytesReceived | number | Yes | number of tunneled layer 7 bytes received, including retransmissions | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numL7BytesTransmitted | number | Yes | number of tunneled layer 7 bytes transmitted, excluding retransmissions | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numLostPackets | number | Yes | number of lost packets | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numOutOfOrderPackets | number | Yes | number of out-of-order packets | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numPacketErrors | number | Yes | number of errored packets | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numPacketsReceivedExclRetrans | number | Yes | number of packets received, excluding retransmission | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numPacketsReceivedInclRetrans | number | Yes | number of packets received, including retransmission | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numPacketsTransmittedInclRetrans | number | Yes | number of packets transmitted, including retransmissions | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numRetries | number | Yes | number of packet retrie | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numTimeouts | number | Yes | number of packet timeouts | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numTunneledL7BytesReceived | number | Yes | number of tunneled layer 7 bytes received, excluding retransmissions | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| roundTripTime | number | Yes | Round Trip time | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| tcpFlagCountList | hashMap | No | Array of key: value pairs where the keys are drawn from TCP Flags and the values are the count of packets that had that TCP Flag in the flow | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| tcpFlagList | string | No | Array of unique TCP Flags observed in the flow | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| timeToFirstByte | number | Yes | Time in milliseconds between the connection activation and first byte received | -+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------+--------+----------+-----------------------------------------+ +| Field | Type | Required?| Description | ++===============+========+==========+=========================================+ +| avgBit\ | number | Yes | Average bit error rate | +| ErrorRate | | | | ++---------------+--------+----------+-----------------------------------------+ +| avgPacket\ | number | Yes | Average packet delay variation or jitter| +| Delay\ | | | in milliseconds for received packets: | +| Variation | | | Average difference between the packet | +| | | | timestamp and time received for all | +| | | | pairs of consecutive packets | ++---------------+--------+----------+-----------------------------------------+ +| avgPacket\ | number | Yes | Average delivery latency | +| Latency | | | | ++---------------+--------+----------+-----------------------------------------+ +| avgReceive\ | number | Yes | Average receive throughput | +| Throughput | | | | ++---------------+--------+----------+-----------------------------------------+ +| avgTransmit\ | number | Yes | Average transmit throughput | +| Throughput | | | | ++---------------+--------+----------+-----------------------------------------+ +| dur\ | number | No | Duration of failed state in milliseconds| +| Connection\ | | | , computed as the cumulative time | +| FailedStatus | | | between a failed echo request and the | +| | | | next following successful error request,| +| | | | over this reporting interval | ++---------------+--------+----------+-----------------------------------------+ +| durTunnel\ | number | No | Duration of errored state, computed as | +| FailedStatus | | | the cumulative time between a tunnel | +| | | | error indicator and the next following | +| | | | non-errored indicator, over this | +| | | | reporting interval | ++---------------+--------+----------+-----------------------------------------+ +| flow\ | string | No | Endpoint activating the flow | +| ActivatedBy | | | | ++---------------+--------+----------+-----------------------------------------+ +| flow\ | number | Yes | Time the connection is activated in the | +| Activation\ | | | flow (connection) being reported on, or | +| Epoch | | | transmission time of the first packet if| +| | | | activation time is not available | ++---------------+--------+----------+-----------------------------------------+ +| flow\ | number | Yes | Integer microseconds for the start of | +| Activation\ | | | the flow connection | +| Microsec | | | | ++---------------+--------+----------+-----------------------------------------+ +| flow\ | string | No | Time the connection is activated in the | +| Activation\ | | | flow being reported on, or transmission | +| Time | | | time of the first packet if activation | +| | | | time is not available; with RFC 2822 | +| | | | compliant format: ‘Sat, 13 Mar 2010 | +| | | | 11:29:05 -0800’ | ++---------------+--------+----------+-----------------------------------------+ +| flow\ | string | No | Endpoint deactivating the flow | +| Deactivated\ | | | | +| By | | | | ++---------------+--------+----------+-----------------------------------------+ +| flow\ | number | Yes | Time for the start of the flow | +| Deactivation\ | | | connection, in integer UTC epoch time | +| Epoch | | | aka UNIX time | ++---------------+--------+----------+-----------------------------------------+ +| flow\ | number | Yes | Integer microseconds for the start of | +| Deactivation\ | | | the flow connection | +| Microsec | | | | ++---------------+--------+----------+-----------------------------------------+ +| flow\ | string | Yes | Transmission time of the first packet in| +| Deactivation\ | | | the flow connection being reported on; | +| Time | | | with RFC 2822 compliant format: ‘Sat, 13| +| | | | Mar 2010 11:29:05 -0800’ | ++---------------+--------+----------+-----------------------------------------+ +| flowStatus | string | Yes | Connection status at reporting time as a| +| | | | working / inactive / failed indicator | +| | | | value | ++---------------+--------+----------+-----------------------------------------+ +| gtp\ | string | No | Current connection state at reporting | +| Connection\ | | | time | +| Status | | | | ++---------------+--------+----------+-----------------------------------------+ +| gtpTunnel\ | string | No | Current tunnel state at reporting time | +| Status | | | | ++---------------+--------+----------+-----------------------------------------+ +| ipTos\ | hashMap| No | Array of key: value pairs where the keys| +| CountList | | | are drawn from the IP Type-of-Service | +| | | | identifiers which range from '0' to | +| | | | '255', and the values are the count of | +| | | | packets that had those ToS identifiers | +| | | | in the flow | ++---------------+--------+----------+-----------------------------------------+ +| ipTosList | string | No | Array of unique IP Type-of-Service | +| | | | values observed in the flow where values| +| | | | range from '0' to '255' | ++---------------+--------+----------+-----------------------------------------+ +| large\ | number | No | large packet round trip time | +| PacketRtt | | | | ++---------------+--------+----------+-----------------------------------------+ +| largePacket\ | number | No | large packet threshold being applied | +| Threshold | | | | ++---------------+--------+----------+-----------------------------------------+ +| maxPacket\ | number | Yes | Maximum packet delay variation or jitter| +| Delay\ | | | in milliseconds for received packets: | +| Variation | | | Maximum of the difference between the | +| | | | packet timestamp and time received for | +| | | | all pairs of consecutive packets | ++---------------+--------+----------+-----------------------------------------+ +| maxReceive\ | number | No | maximum receive bit rate" | +| BitRate | | | | ++---------------+--------+----------+-----------------------------------------+ +| maxTransmit\ | number | No | maximum transmit bit rate | +| BitRate | | | | ++---------------+--------+----------+-----------------------------------------+ +| mobileQci\ | hashMap| No | array of key: value pairs where the keys| +| CosCountList | | | are drawn from LTE QCI or UMTS class of | +| | | | service strings, and the values are the | +| | | | count of packets that had those strings | +| | | | in the flow | ++---------------+--------+----------+-----------------------------------------+ +| mobileQci\ | string | No | Array of unique LTE QCI or UMTS | +| CosList | | | class-of-service values observed in the | +| | | | flow | ++---------------+--------+----------+-----------------------------------------+ +| num\ | number | Yes | Number of failed activation requests, as| +| Activation\ | | | observed by the reporting node | +| Failures | | | | ++---------------+--------+----------+-----------------------------------------+ +| numBit\ | number | Yes | number of errored bits | +| Errors | | | | ++---------------+--------+----------+-----------------------------------------+ +| numBytes\ | number | Yes | number of bytes received, including | +| Received | | | retransmissions | ++---------------+--------+----------+-----------------------------------------+ +| numBytes\ | number | Yes | number of bytes transmitted, including | +| Transmitted | | | retransmissions | ++---------------+--------+----------+-----------------------------------------+ +| numDropped\ | number | Yes | number of received packets dropped due | +| Packets | | | to errors per virtual interface | ++---------------+--------+----------+-----------------------------------------+ +| numGtp\ | number | No | Number of Echo request path failures | +| EchoFailures | | | where failed paths are defined in 3GPP | +| | | | TS 29.281 sec 7.2.1 and 3GPP TS 29.060 | +| | | | sec. 11.2 | ++---------------+--------+----------+-----------------------------------------+ +| numGtp\ | number | No | Number of tunnel error indications where| +| TunnelErrors | | | errors are defined in 3GPP TS 29.281 sec| +| | | | 7.3.1 and 3GPP TS 29.060 sec. 11.1 | ++---------------+--------+----------+-----------------------------------------+ +| numHttp\ | number | No | Http error count | +| Errors | | | | ++---------------+--------+----------+-----------------------------------------+ +| numL7Bytes\ | number | Yes | number of tunneled layer 7 bytes | +| Received | | | received, including retransmissions | ++---------------+--------+----------+-----------------------------------------+ +| numL7Bytes\ | number | Yes | number of tunneled layer 7 bytes | +| Transmitted | | | transmitted, excluding retransmissions | ++---------------+--------+----------+-----------------------------------------+ +| numLost\ | number | Yes | number of lost packets | +| Packets | | | | ++---------------+--------+----------+-----------------------------------------+ +| numOutOf\ | number | Yes | number of out-of-order packets | +| OrderPackets | | | | ++---------------+--------+----------+-----------------------------------------+ +| numPacket\ | number | Yes | number of errored packets | +| Errors | | | | ++---------------+--------+----------+-----------------------------------------+ +| numPackets\ | number | Yes | number of packets received, excluding | +| ReceivedExcl\ | | | retransmission | +| Retrans | | | | ++---------------+--------+----------+-----------------------------------------+ +| numPackets\ | number | Yes | number of packets received, including | +| ReceivedIncl\ | | | retransmission | +| Retrans | | | | ++---------------+--------+----------+-----------------------------------------+ +| numPackets\ | number | Yes | number of packets transmitted, including| +| Transmitted\ | | | retransmissions | +| InclRetrans | | | | ++---------------+--------+----------+-----------------------------------------+ +| numRetries | number | Yes | number of packet retrie | ++---------------+--------+----------+-----------------------------------------+ +| numTimeouts | number | Yes | number of packet timeouts | ++---------------+--------+----------+-----------------------------------------+ +| numTunneled\ | number | Yes | number of tunneled layer 7 bytes | +| L7Bytes\ | | | received, excluding retransmissions | +| Received | | | | ++---------------+--------+----------+-----------------------------------------+ +| roundTrip\ | number | Yes | Round Trip time | +| Time | | | | ++---------------+--------+----------+-----------------------------------------+ +| tcpFlag\ | hashMap| No | Array of key: value pairs where the keys| +| CountList | | | are drawn from TCP Flags and the values | +| | | | are the count of packets that had that | +| | | | TCP Flag in the flow | ++---------------+--------+----------+-----------------------------------------+ +| tcpFlag\ | string | No | Array of unique TCP Flags observed in | +| List | | | the flow | ++---------------+--------+----------+-----------------------------------------+ +| timeTo\ | number | Yes | Time in milliseconds between the | +| FirstByte | | | connection activation and first byte | +| | | | received | ++---------------+--------+----------+-----------------------------------------+ Datatype: mobileFlowFields *************************** The mobileFlowFields datatype consists of the following fields: -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+===========================+======================+=============+==============================================================================================================================================================================================+ -| additionalFields | hashMap | No | Additional mobileFlow fields if needed | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| applicationType | string | No | Application type inferred | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| appProtocolType | string | No | Application protocol | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| appProtocolVersion | string | No | Application version | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| cid | string | No | Cell Id | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| connectionType | string | No | Abbreviation referencing a 3GPP reference point e.g., S1-U, S11, etc | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| ecgi | string | No | Evolved Cell Global Id | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| flowDirection | string | Yes | Flow direction, indicating if the reporting node is the source of the flow or destination for the flow | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| gtpPerFlowMetrics | gtpPer FlowMetrics | Yes | Mobility GTP Protocol per flow metrics | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| gtpProtocolType | string | No | GTP protocol | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| gtpVersion | string | No | GTP protocol version | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| httpHeader | string | No | HTTP request header, if the flow connects to a node referenced by HTTP | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| imei | string | No | IMEI for the subscriber UE used in this flow, if the flow connects to a mobile device | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| imsi | string | No | IMSI for the subscriber UE used in this flow, if the flow connects to a mobile device | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| ipProtocolType | string | Yes | IP protocol type e.g., TCP, UDP, RTP... | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| ipVersion | string | Yes | IP protocol version e.g., IPv4, IPv6 | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| lac | string | No | Location area code | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| mcc | string | No | Mobile country code | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| mnc | string | No | Mobile network code | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| mobileFlowFieldsVersion | string | Yes | Version of the mobileFlowFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| msisdn | string | No | MSISDN for the subscriber UE used in this flow, as an integer, if the flow connects to a mobile device | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| otherEndpointIpAddress | string | Yes | IP address for the other endpoint, as used for the flow being reported on | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| otherEndpointPort | integer | Yes | IP Port for the reporting entity, as used for the flow being reported on | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| otherFunctionalRole | string | No | Functional role of the other endpoint for the flow being reported on e.g., MME, S-GW, P-GW, PCRF... | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| rac | string | No | Routing area code | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| radioAccessTechnology | string | No | Radio Access Technology e.g., 2G, 3G, LTE | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| reportingEndpointIpAddr | string | Yes | IP address for the reporting entity, as used for the flow being reported on | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| reportingEndpointPort | integer | Yes | IP port for the reporting entity, as used for the flow being reported on | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| sac | string | No | Service area code | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| samplingAlgorithm | integer | No | Integer identifier for the sampling algorithm or rule being applied in calculating the flow metrics if metrics are calculated based on a sample of packets, or 0 if no sampling is applied | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| tac | string | No | Transport area code | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| tunnelId | string | No | Tunnel identifier | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| vlanId | string | No | VLAN identifier used by this flow | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------+------------+----------+---------------------------------------+ +| Field | Type | Required?| Description | ++=============+============+==========+=======================================+ +| additional\ | hashMap | No | Additional mobileFlow fields if needed| +| Fields | | | | ++-------------+------------+----------+---------------------------------------+ +| application\| string | No | Application type inferred | +| Type | | | | ++-------------+------------+----------+---------------------------------------+ +| appProtocol\| string | No | Application protocol | +| Type | | | | ++-------------+------------+----------+---------------------------------------+ +| appProtocol\| string | No | Application version | +| Version | | | | ++-------------+------------+----------+---------------------------------------+ +| cid | string | No | Cell Id | ++-------------+------------+----------+---------------------------------------+ +| connection\ | string | No | Abbreviation referencing a 3GPP | +| Type | | | reference point e.g., S1-U, S11, etc | ++-------------+------------+----------+---------------------------------------+ +| ecgi | string | No | Evolved Cell Global Id | ++-------------+------------+----------+---------------------------------------+ +| flow\ | string | Yes | Flow direction, indicating if the | +| Direction | | | reporting node is the source of the | +| | | | flow or destination for the flow | ++-------------+------------+----------+---------------------------------------+ +| gtpPer\ | gtpPer | Yes | Mobility GTP Protocol per flow metrics| +| FlowMetrics | FlowMetrics| | | ++-------------+------------+----------+---------------------------------------+ +| gtpProtocol\| string | No | GTP protocol | +| Type | | | | ++-------------+------------+----------+---------------------------------------+ +| gtpVersion | string | No | GTP protocol version | ++-------------+------------+----------+---------------------------------------+ +| httpHeader | string | No | HTTP request header, if the flow | +| | | | connects to a node referenced by HTTP | ++-------------+------------+----------+---------------------------------------+ +| imei | string | No | IMEI for the subscriber UE used in | +| | | | this flow, if the flow connects to a | +| | | | mobile device | ++-------------+------------+----------+---------------------------------------+ +| imsi | string | No | IMSI for the subscriber UE used in | +| | | | this flow, if the flow connects to a | +| | | | mobile device | ++-------------+------------+----------+---------------------------------------+ +| ipProtocol\ | string | Yes | IP protocol type e.g.,TCP, UDP, RTP...| +| Type | | | | ++-------------+------------+----------+---------------------------------------+ +| ipVersion | string | Yes | IP protocol version e.g., IPv4, IPv6 | ++-------------+------------+----------+---------------------------------------+ +| lac | string | No | Location area code | ++-------------+------------+----------+---------------------------------------+ +| mcc | string | No | Mobile country code | ++-------------+------------+----------+---------------------------------------+ +| mnc | string | No | Mobile network code | ++-------------+------------+----------+---------------------------------------+ +| mobileFlow\ | string | Yes | Version of the mobileFlowFields block | +| Fields\ | | | as “#.#” where # is a digit; see | +| Version | | | section 1 for the correct digits to | +| | | | use. | ++-------------+------------+----------+---------------------------------------+ +| msisdn | string | No | MSISDN for the subscriber UE used in | +| | | | this flow, as an integer, if the flow | +| | | | connects to a mobile device | ++-------------+------------+----------+---------------------------------------+ +| other\ | string | Yes | IP address for the other endpoint, as | +| EndpointIp\ | | | used for the flow being reported on | +| Address | | | | ++-------------+------------+----------+---------------------------------------+ +| other\ | integer | Yes | IP Port for the reporting entity, as | +| Endpoint\ | | | used for the flow being reported on | +| Port | | | | ++-------------+------------+----------+---------------------------------------+ +| other\ | string | No | Functional role of the other endpoint | +| Functional\ | | | for the flow being reported on e.g., | +| Role | | | MME, S-GW, P-GW, PCRF... | ++-------------+------------+----------+---------------------------------------+ +| rac | string | No | Routing area code | ++-------------+------------+----------+---------------------------------------+ +| radioAccess\| string | No | Radio Access Technology e.g., 2G, 3G, | +| Technology | | | LTE | ++-------------+------------+----------+---------------------------------------+ +| reporting\ | string | Yes | IP address for the reporting entity, | +| EndpointIp\ | | | as used for the flow being reported on| +| Addr | | | | ++-------------+------------+----------+---------------------------------------+ +| reporting\ | integer | Yes | IP port for the reporting entity, as | +| EndpointPort| | | used for the flow being reported on | ++-------------+------------+----------+---------------------------------------+ +| sac | string | No | Service area code | ++-------------+------------+----------+---------------------------------------+ +| sampling\ | integer | No | Integer identifier for the sampling | +| Algorithm | | | algorithm or rule being applied in | +| | | | calculating the flow metrics if | +| | | | metrics are calculated based on a | +| | | | sample of packets, or 0 if no sampling| +| | | | is applied | ++-------------+------------+----------+---------------------------------------+ +| tac | string | No | Transport area code | ++-------------+------------+----------+---------------------------------------+ +| tunnelId | string | No | Tunnel identifier | ++-------------+------------+----------+---------------------------------------+ +| vlanId | string | No | VLAN identifier used by this flow | ++-------------+------------+----------+---------------------------------------+ ‘SipSignaling’ Domain Datatypes +++++++++++++++++++++++++++++++ @@ -2279,29 +3163,39 @@ The sipSignalingFields datatype communicates information about sip signaling messages, parameters and signaling state; it consists of the following fields: -+-----------------------------+----------------------+-------------+---------------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+=============================+======================+=============+=====================================================================================================================+ -| additionalInformation | hashMap | No | Additional sipSignaling fields | -+-----------------------------+----------------------+-------------+---------------------------------------------------------------------------------------------------------------------+ -| compressedSip | string | No | The full SIP request/response including headers and bodies | -+-----------------------------+----------------------+-------------+---------------------------------------------------------------------------------------------------------------------+ -| correlator | string | Yes | Constant across all events on this call | -+-----------------------------+----------------------+-------------+---------------------------------------------------------------------------------------------------------------------+ -| localIpAddress | string | Yes | Ip address on xNF | -+-----------------------------+----------------------+-------------+---------------------------------------------------------------------------------------------------------------------+ -| localPort | string | Yes | Port on xNF | -+-----------------------------+----------------------+-------------+---------------------------------------------------------------------------------------------------------------------+ -| remoteIpAddress | string | Yes | IP address of peer endpoint | -+-----------------------------+----------------------+-------------+---------------------------------------------------------------------------------------------------------------------+ -| remotePort | string | Yes | Port of peer endpoint | -+-----------------------------+----------------------+-------------+---------------------------------------------------------------------------------------------------------------------+ -| sipSignalingFieldsVersion | string | Yes | Version of the sipSignalingFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. | -+-----------------------------+----------------------+-------------+---------------------------------------------------------------------------------------------------------------------+ -| summarySip | string | No | The SIP Method or Response (‘INVITE’, ‘200 OK’, ‘BYE’, etc) | -+-----------------------------+----------------------+-------------+---------------------------------------------------------------------------------------------------------------------+ -| vendorNfNameFields | vendorNfNameFields | Yes | Vendor, NF and nfModule names | -+-----------------------------+----------------------+-------------+---------------------------------------------------------------------------------------------------------------------+ ++--------------+-----------+----------+---------------------------------------+ +| Field | Type | Required?| Description | ++==============+===========+==========+=======================================+ +| additional\ | hashMap | No | Additional sipSignaling fields | +| Information | | | | ++--------------+-----------+----------+---------------------------------------+ +| compressed\ | string | No | The full SIP request/response | +| Sip | | | including headers and bodies | ++--------------+-----------+----------+---------------------------------------+ +| correlator | string | Yes | Constant across all events on this | +| | | | call | ++--------------+-----------+----------+---------------------------------------+ +| local\ | string | Yes | Ip address on xNF | +| IpAddress | | | | ++--------------+-----------+----------+---------------------------------------+ +| localPort | string | Yes | Port on xNF | ++--------------+-----------+----------+---------------------------------------+ +| remote\ | string | Yes | IP address of peer endpoint | +| IpAddress | | | | ++--------------+-----------+----------+---------------------------------------+ +| remotePort | string | Yes | Port of peer endpoint | ++--------------+-----------+----------+---------------------------------------+ +| sipSignaling\| string | Yes | Version of the sipSignalingFields | +| FieldsVersion| | | block as “#.#” where # is a digit; see| +| | | | section 1 for the correct digits to | +| | | | use. | ++--------------+-----------+----------+---------------------------------------+ +| summarySip | string | No | The SIP Method or Response (‘INVITE’, | +| | | | ‘200 OK’, ‘BYE’, etc) | ++--------------+-----------+----------+---------------------------------------+ +| vendorNf\ | vendorNf | Yes | Vendor, NF and nfModule names | +| NameFields | NameFields| | | ++--------------+-----------+----------+---------------------------------------+ ‘Voice Quality’ Domain Datatypes +++++++++++++++++++++++++++++++++ @@ -2312,67 +3206,108 @@ Datatype: endOfCallVqmSummaries The endOfCallVqmSummaries datatype provides end of call voice quality metrics; it consists of the following fields: -+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+=================================+==========+=============+==================================================================================================================================================================================================================+ -| adjacencyName | string | Yes | Adjacency name | -+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| endpointAverageJitter | number | No | Endpoint average jitter | -+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| endpointDescription | string | Yes | Enumeration: ‘Caller’, ‘Callee’ | -+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| endpointMaxJitter | number | No | Endpoint maximum jitter | -+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| endpointRtpOctetsDiscarded | number | No | Endpoint RTP octets discarded | -+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| endpointRtpOctetsLost | number | No | Endpoint RTP octets lost | -+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| endpointRtpOctetsReceived | number | No | Endpoint RTP octets received | -+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| endpointRtpOctetsSent | number | No | Endpoint RTP octets sent | -+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| endpointRtpPacketsDiscarded | number | No | Endpoint RTP packets discarded | -+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| endpointRtpPacketsLost | number | No | Endpoint RTP packets lost | -+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| endpointRtpPacketsReceived | number | No | Endpoint RTP packets received | -+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| endpointRtpPacketsSent | number | No | Endpoint RTP packets sent | -+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| localAverageJitter | number | No | Local average jitter | -+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| localAverageJitterBufferDelay | number | No | Local average jitter buffer delay | -+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| localMaxJitter | number | No | Local maximum jitter | -+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| localMaxJitterBufferDelay | number | No | Local max jitter buffer delay | -+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| localRtpOctetsDiscarded | number | No | Local RTP octets discarded | -+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| localRtpOctetsLost | number | No | Local RTP octets lost | -+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| localRtpOctetsReceived | number | No | Local RTP octets received | -+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| localRtpOctetsSent | number | No | Local RTP octets sent | -+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| localRtpPacketsDiscarded | number | No | Local RTP packets discarded | -+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| localRtpPacketsLost | number | No | Local RTP packets lost | -+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| localRtpPacketsReceived | number | No | Local RTP packets received | -+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| localRtpPacketsSent | number | No | Local RTP packets sent | -+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| mosCqe | number | No | Decimal range from 1 to 5 (1 decimal place) | -+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| oneWayDelay | number | No | one-way path delay in milliseconds | -+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| packetLossPercent | number | No | Calculated percentage packet loss based on endpoint RTP packets lost (as reported in RTCP) and local RTP packets sent. Direction is based on endpoint description (Caller, Callee). Decimal (2 decimal places) | -+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| rFactor | number | No | rFactor from 0 to 100 | -+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| roundTripDelay | number | No | Round trip delay in milliseconds | -+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------+-------+----------+-------------------------------------------+ +| Field | Type | Required?| Description | ++==============+=======+==========+===========================================+ +| adjacency\ | string| Yes | Adjacency name | +| Name | | | | ++--------------+-------+----------+-------------------------------------------+ +| endpoint\ | number| No | Endpoint average jitter | +| AverageJitter| | | | ++--------------+-------+----------+-------------------------------------------+ +| endpoint\ | string| Yes | Enumeration: ‘Caller’, ‘Callee’ | +| Description | | | | ++--------------+-------+----------+-------------------------------------------+ +| endpoint\ | number| No | Endpoint maximum jitter | +| MaxJitter | | | | ++--------------+-------+----------+-------------------------------------------+ +| endpointRtp\ | number| No | Endpoint RTP octets discarded | +| Octets\ | | | | +| Discarded | | | | ++--------------+-------+----------+-------------------------------------------+ +| endpointRtp\ | number| No | Endpoint RTP octets lost | +| OctetsLost | | | | ++--------------+-------+----------+-------------------------------------------+ +| endpointRtp\ | number| No | Endpoint RTP octets received | +| Octets\ | | | | +| Received | | | | ++--------------+-------+----------+-------------------------------------------+ +| endpointRtp\ | number| No | Endpoint RTP octets sent | +| OctetsSent | | | | ++--------------+-------+----------+-------------------------------------------+ +| endpointRtp\ | number| No | Endpoint RTP packets discarded | +| Packets\ | | | | +| Discarded | | | | ++--------------+-------+----------+-------------------------------------------+ +| endpointRtp\ | number| No | Endpoint RTP packets lost | +| PacketsLost | | | | ++--------------+-------+----------+-------------------------------------------+ +| endpointRtp\ | number| No | Endpoint RTP packets received | +| Packets\ | | | | +| Received | | | | ++--------------+-------+----------+-------------------------------------------+ +| endpointRtp\ | number| No | Endpoint RTP packets sent | +| PacketsSent | | | | ++--------------+-------+----------+-------------------------------------------+ +| local\ | number| No | Local average jitter | +| Average\ | | | | +| Jitter | | | | ++--------------+-------+----------+-------------------------------------------+ +| localAverage\| number| No | Local average jitter buffer delay | +| JitterBuffer\| | | | +| Delay | | | | ++--------------+-------+----------+-------------------------------------------+ +| localMax\ | number| No | Local maximum jitter | +| Jitter | | | | ++--------------+-------+----------+-------------------------------------------+ +| localMax\ | number| No | Local max jitter buffer delay | +| JitterBuffer\| | | | +| Delay | | | | ++--------------+-------+----------+-------------------------------------------+ +| localRtp\ | number| No | Local RTP octets discarded | +| Octets\ | | | | +| Discarded | | | | ++--------------+-------+----------+-------------------------------------------+ +| localRtp\ | number| No | Local RTP octets lost | +| OctetsLost | | | | ++--------------+-------+----------+-------------------------------------------+ +| localRtp\ | number| No | Local RTP octets received | +| Octets\ | | | | +| Received | | | | ++--------------+-------+----------+-------------------------------------------+ +| localRtp\ | number| No | Local RTP octets sent | +| OctetsSent | | | | ++--------------+-------+----------+-------------------------------------------+ +| localRtp\ | number| No | Local RTP packets discarded | +| Packets\ | | | | +| Discarded | | | | ++--------------+-------+----------+-------------------------------------------+ +| localRtp\ | number| No | Local RTP packets lost | +| PacketsLost | | | | ++--------------+-------+----------+-------------------------------------------+ +| localRtp\ | number| No | Local RTP packets received | +| Packets\ | | | | +| Received | | | | ++--------------+-------+----------+-------------------------------------------+ +| localRtp\ | number| No | Local RTP packets sent | +| PacketsSent | | | | ++--------------+-------+----------+-------------------------------------------+ +| mosCqe | number| No | Decimal range from 1 to 5(1 decimal place)| ++--------------+-------+----------+-------------------------------------------+ +| oneWayDelay | number| No | one-way path delay in milliseconds | ++--------------+-------+----------+-------------------------------------------+ +| packet\ | number| No | Calculated percentage packet loss based on| +| LossPercent | | | endpoint RTP packets lost (as reported in | +| | | | RTCP) and local RTP packets sent. | +| | | | Direction is based on endpoint description| +| | | | (Caller, Callee). Decimal (2 decimal | +| | | | places) | ++--------------+-------+----------+-------------------------------------------+ +| rFactor | number| No | rFactor from 0 to 100 | ++--------------+-------+----------+-------------------------------------------+ +| round\ | number| No | Round trip delay in milliseconds | +| TripDelay | | | | ++--------------+-------+----------+-------------------------------------------+ Datatype: voiceQualityFields ***************************** @@ -2380,27 +3315,38 @@ Datatype: voiceQualityFields The voiceQualityFields datatype provides statistics related to customer facing voice products; consists of the following fields: -+-----------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+=============================+==========================+=============+=====================================================================================================================+ -| additionalInformation | hashMap | No | Additional voice quality fields | -+-----------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------+ -| calleeSideCodec | string | Yes | Callee codec for the call | -+-----------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------+ -| callerSideCodec | string | Yes | Caller codec for the call | -+-----------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------+ -| correlator | string | Yes | Constant across all events on this call | -+-----------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------+ -| endOfCallVqmSummaries | endOfCallVqm Summaries | No | End of call voice quality metric summaries | -+-----------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------+ -| phoneNumber | string | No | Phone number associated with the correlator | -+-----------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------+ -| midCallRtcp | string | Yes | Base64 encoding of the binary RTCP data (excluding Eth/IP/UDP headers) | -+-----------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------+ -| vendorNfNameFields | vendorNfNameFields | Yes | Vendor, NF and nfModule names | -+-----------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------+ -| voiceQualityFieldsVersion | string | Yes | Version of the voiceQualityFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. | -+-----------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------+ ++--------------+-------------+----------+-------------------------------------+ +| Field | Type | Required?| Description | ++==============+=============+==========+=====================================+ +| additional\ | hashMap | No | Additional voice quality fields | +| Information | | | | ++--------------+-------------+----------+-------------------------------------+ +| callee\ | string | Yes | Callee codec for the call | +| SideCodec | | | | ++--------------+-------------+----------+-------------------------------------+ +| caller\ | string | Yes | Caller codec for the call | +| SideCodec | | | | ++--------------+-------------+----------+-------------------------------------+ +| correlator | string | Yes | Constant across all events on this | +| | | | call | ++--------------+-------------+----------+-------------------------------------+ +| endOfCall\ | endOfCallVqm| No | End of call voice quality metric | +| VqmSummaries | Summaries | | summaries | ++--------------+-------------+----------+-------------------------------------+ +| phoneNumber | string | No | Phone number associated with the | +| | | | correlator | ++--------------+-------------+----------+-------------------------------------+ +| midCallRtcp | string | Yes | Base64 encoding of the binary RTCP | +| | | | data (excluding Eth/IP/UDP headers) | ++--------------+-------------+----------+-------------------------------------+ +| vendorNf\ | vendorNf | Yes | Vendor, NF and nfModule names | +| NameFields | NameFields | | | ++--------------+-------------+----------+-------------------------------------+ +| voiceQuality\| string | Yes | Version of the voiceQualityFields | +| FieldsVersion| | | block as “#.#” where # is a digit; | +| | | | see section 1 for the correct digits| +| | | | to use. | ++--------------+-------------+----------+-------------------------------------+ Exceptions ^^^^^^^^^^^ @@ -2414,23 +3360,39 @@ this document for each operation). HTTP status codes may be followed by an optional JSON exception structure described below. Two types of exceptions may be defined: service exceptions and policy exceptions. -+------------------+----------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **Field Name** | **Data Type** | **Required?** | **Description** | -+==================+============================+=================+========================================================================================================================================================================================================================================================================+ -| messageId | xs:string | Yes | Unique message identifier of the format ‘ABCnnnn’ where ‘ABC’ is either ‘SVC’ for Service Exceptions or ‘POL’ for Policy Exception. | -| | | | | -| | | | Exception numbers may be in the range of 0001 to 9999 where : | -| | | | | -| | | | - 0001 to 2999 are defined by OMA (see OMA’s `Common definitions for RESTful Network APIs <http://technical.openmobilealliance.org/Technical/release_program/docs/REST_NetAPI_Common/V1_0-20120417-C/OMA-TS-REST_NetAPI_Common-V1_0-20120417-C.pdf>`__ for details) | -| | | | | -| | | | - 3000-9999 are available and undefined | -+------------------+----------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| text | xs:string | Yes | Message text, with replacement variables marked with %n, where n is an index into the list of <variables> elements, starting at 1 | -+------------------+----------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| variables | xs:string [0..unbounded] | No | List of zero or more strings that represent the contents of the variables used by the message text. | -+------------------+----------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| url | xs:anyUrl | No | Hyperlink to a detailed error resource (e.g., an HTML page for browser user agents). | -+------------------+----------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------+---------------+-------------+-----------------------------------+ +| Field Name| Data Type | Required? | Description | ++===========+===============+=============+===================================+ +| messageId | xs:string | Yes | Unique message identifier of the | +| | | | format ‘ABCnnnn’ where ‘ABC’ is | +| | | | either ‘SVC’ for Service | +| | | | Exceptions or ‘POL’ for Policy | +| | | | Exception. | +| | | | | +| | | | Exception numbers may be in the | +| | | | range of 0001 to 9999 where : | +| | | | | +| | | | - 0001 to 2999 are defined by OMA| +| | | | (see OMA’s Common_definitions_ | +| | | | for details) | +| | | | | +| | | | - 3000-9999 are available and | +| | | | undefined | ++-----------+---------------+-------------+-----------------------------------+ +| text | xs:string | Yes | Message text, with replacement | +| | | | variables marked with %n, where n | +| | | | is an index into the list of | +| | | | <variables> elements, starting at | +| | | | 1 | ++-----------+---------------+-------------+-----------------------------------+ +| variables | xs:string | No | List of zero or more strings that | +| | [0..unbounded]| | represent the contents of the | +| | | | variables used by the message text| ++-----------+---------------+-------------+-----------------------------------+ +| url | xs:anyUrl | No | Hyperlink to a detailed error | +| | | | resource (e.g., an HTML page for | +| | | | browser user agents). | ++-----------+---------------+-------------+-----------------------------------+ Service Exceptions ~~~~~~~~~~~~~~~~~~~ @@ -2446,19 +3408,28 @@ Service Exceptions message identifier. ‘SVC’ service exceptions used by the VES Event Listener API are defined below. -+---------------+---------------------------------------+---------------------------------------------------------------+-----------------------------------------------+----------------------+ -| *MessageId* | *Description / Comment* | *Text* | *Variables* | *Parent HTTP Code* | -+===============+=======================================+===============================================================+===============================================+======================+ -| SVC0001 | General service error (see SVC2000) | <custom error message> | None | 400 | -+---------------+---------------------------------------+---------------------------------------------------------------+-----------------------------------------------+----------------------+ -| SVC0002 | Bad parameter | Invalid input value for message part %1 | %1: message part | 400 | -+---------------+---------------------------------------+---------------------------------------------------------------+-----------------------------------------------+----------------------+ -| SVC1000 | No server resources | No server resources available to process the request | None | 500 | -+---------------+---------------------------------------+---------------------------------------------------------------+-----------------------------------------------+----------------------+ -| SVC2000 | More elaborate version of SVC0001 | The following service error occurred: %1. Error code is %2. | %1: human readable description of the error | 400 | -| | | | | | -| | | | %2: error code | | -+---------------+---------------------------------------+---------------------------------------------------------------+-----------------------------------------------+----------------------+ ++----------+--------------+-----------------------+----------------+----------+ +| MessageId| Description | Text | Variables | Parent | +| | / Comment | | | HTTP Code| ++==========+==============+=======================+================+==========+ +| SVC0001 | General | <custom error message>| None | 400 | +| | service error| | | | +| | (see SVC2000)| | | | ++----------+--------------+-----------------------+----------------+----------+ +| SVC0002 | Bad parameter| Invalid input value | %1: message | 400 | +| | | for message part %1 | part | | ++----------+--------------+-----------------------+----------------+----------+ +| SVC1000 | No server | No server resources | None | 500 | +| | resources | available to process | | | +| | | the request | | | ++----------+--------------+-----------------------+----------------+----------+ +| SVC2000 | More | The following service | %1: human | 400 | +| | elaborate | error occurred: %1. | readable | | +| | version of | | description of | | +| | SVC0001 | | the error | | +| | | | | | +| | | Error code is %2. | %2: error code | | ++----------+--------------+-----------------------+----------------+----------+ Table - Service Exceptions @@ -2480,21 +3451,32 @@ Policy Exceptions message identifier. ‘POL’ policy exceptions used by the VES Event Listener API are defined below. -+---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+ -| *MessageId* | *Description / Comment* | *Text* | *Variables* | *Parent HTTP Code* | -+===============+======================================+==============================================================+===============================================+======================+ -| POL0001 | General policy error (see POL2000) | A policy error occurred. | None | 401 | -+---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+ -| POL1009 | User not provisioned for service | User has not been provisioned for service | None | 401 | -+---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+ -| POL1010 | User suspended from service | User has been suspended from service | None | 401 | -+---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+ -| POL2000 | More elaborate version of POL0001 | The following policy error occurred: %1. Error code is %2. | %1: human readable description of the error | 401 | -| | | | | | -| | | | %2: error code | | -+---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+ -| POL9003 | Message size exceeds limit | Message content size exceeds the allowable limit | None | 400 | -+---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+ ++----------+---------------+-----------------------+---------------+----------+ +| MessageId| Description |Text | Variables | Parent | +| | / Comment | | | HTTP Code| ++==========+===============+=======================+===============+==========+ +| POL0001 | General policy| A policy error | None | 401 | +| | error (see | occurred. | | | +| | POL2000) | | | | ++----------+---------------+-----------------------+---------------+----------+ +| POL1009 | User not | User has not been | None | 401 | +| | provisioned | provisioned for | | | +| | for service | service | | | ++----------+---------------+-----------------------+---------------+----------+ +| POL1010 | User suspended| User has been | None | 401 | +| | from service | suspended from service| | | ++----------+---------------+-----------------------+---------------+----------+ +| POL2000 | More elaborate| The following policy | %1: human | 401 | +| | version of | error occurred: %1. | readable | | +| | POL0001 | Error code is %2. | description of| | +| | | | the error | | +| | | | | | +| | | | %2: error code| | ++----------+---------------+-----------------------+---------------+----------+ +| POL9003 | Message size | Message content size | None | 400 | +| | exceeds limit | exceeds the allowable | | | +| | | limit | | | ++----------+---------------+-----------------------+---------------+----------+ Table - Policy Exceptions @@ -2507,15 +3489,15 @@ REST Operation Overview REST Operation Summary +++++++++++++++++++++++ -+------------------------+------------+----------------------------------------------------------------------------+ -| **Operation Action** | **HTTP** | **Resource URL relative to {ServerRoot}, which is defined in section 3** | -| | | | -| | **Verb** | | -+------------------------+------------+----------------------------------------------------------------------------+ -| publishAnyEvent | POST | /eventListener/v{apiVersion} | -+------------------------+------------+----------------------------------------------------------------------------+ -| publishEventBatch | POST | /eventListener/v{apiVersion}/eventBatch | -+------------------------+------------+----------------------------------------------------------------------------+ ++---------------------+---------+------------------------------------------+ +| **Operation Action**| **HTTP**| Resource URL relative to {ServerRoot}\ | +| | | , which is defined in section 3 | +| | **Verb**| | ++---------------------+---------+------------------------------------------+ +| publishAnyEvent | POST | /eventListener/v{apiVersion} | ++---------------------+---------+------------------------------------------+ +| publishEventBatch | POST | /eventListener/v{apiVersion}/eventBatch | ++---------------------+---------+------------------------------------------+ Table - REST Operation Summary @@ -2606,85 +3588,125 @@ Input Parameters Header Fields (note: all parameter names shall be treated as case-insensitive): -+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **Parameter** | **Data Type** | **Required?** | **Brief description** | -+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Accept | string | No | Determines the format of the body of the response. Valid values are: | -| | | | | -| | | | - application/json | -+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Authorization | string | Yes | The username and password are formed into one string as “username:password”. This string is then Base64 encoded to produce the encoded credential which is communicated in the header after the string “Authorization: Basic “. See examples below. If the Authorization header is missing, then an HTTP 400 Invalid Request message shall be returned. If the string supplied is invalid, then an HTTP 401 Unauthorized message shall be returned. | -+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Content-length | integer | No | Note that content length is limited to 2Megabyte. | -+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Content-type | string | Yes | Must be set to one of the following values: | -| | | | | -| | | | - application/json | -+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| X-MinorVersion | integer | No | The minor version of the API requested by the client | -+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| X-PatchVersion | integer | No | The patch version of the API requested by the client | -+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| X-LatestVersion | string | No | The full version of the API requested by the client expressed as {major}.{minor}.{patch} | -+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------+----------+----------+---------------------------------------+ +| Parameter | Data Type| Required?| Brief description | ++---------------+----------+----------+---------------------------------------+ +| Accept | string | No | Determines the format of the body of | +| | | | the response. Valid values are: | +| | | | | +| | | | - application/json | ++---------------+----------+----------+---------------------------------------+ +| Authorization | string | Yes | The username and password are formed | +| | | | into one string as | +| | | | “username:password”. This string is | +| | | | then Base64 encoded to produce the | +| | | | encoded credential which is | +| | | | communicated in the header after the | +| | | | string “Authorization: Basic “. See | +| | | | examples below. If the Authorization | +| | | | header is missing, then an HTTP 400 | +| | | | Invalid Request message shall be | +| | | | returned. If the string supplied is | +| | | | invalid, then an HTTP 401 Unauthorized| +| | | | message shall be returned. | ++---------------+----------+----------+---------------------------------------+ +| Content-length| integer | No | Note that content length is limited to| +| | | | 2Megabyte. | ++---------------+----------+----------+---------------------------------------+ +| Content-type | string | Yes | Must be set to one of the following | +| | | | values: | +| | | | | +| | | | - application/json | ++---------------+----------+----------+---------------------------------------+ +| X-MinorVersion| integer | No | The minor version of the API requested| +| | | | by the client | ++---------------+----------+----------+---------------------------------------+ +| X-PatchVersion| integer | No | The patch version of the API requested| +| | | | by the client | ++---------------+----------+----------+---------------------------------------+ +| X-Latest\ | string | No | The full version of the API requested | +| Version | | | by the client expressed as | +| | | | {major}.{minor}.{patch} | ++---------------+----------+----------+---------------------------------------+ Body Fields: -+-----------------+-----------------+-----------------+-----------------------------------------------------------+ -| **Parameter** | **Data Type** | **Required?** | **Brief description** | -+-----------------+-----------------+-----------------+-----------------------------------------------------------+ -| Event | event | Yes | Contains the JSON structure of the common event format. | -+-----------------+-----------------+-----------------+-----------------------------------------------------------+ ++--------------+--------------+--------------+-------------------------------+ +| **Parameter**| **Data Type**| **Required?**| **Brief description** | ++--------------+--------------+--------------+-------------------------------+ +| Event | event | Yes | Contains the JSON structure of| +| | | | the common event format. | ++--------------+--------------+--------------+-------------------------------+ Output Parameters ++++++++++++++++++ Header fields: -+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+ -| **Parameter** | **Data Type** | **Required?** | **Brief description** | -+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+ -| Content-length | integer | No | Used only in error conditions. | -+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+ -| Content-type | string | No | Used only in error conditions | -+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+ -| Date | datetime | No | Date time of the response in GMT | -+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+ -| X-MinorVersion | integer | Yes | The minor version of the API service | -+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+ -| X-PatchVersion | integer | Yes | The patch version of the API service | -+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+ -| X-LatestVersion | string | Yes | The full version of the API service expressed as {major}.{minor}.{patch} | -+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+ ++----------------+--------------+--------------+------------------------------+ +| **Parameter** | **Data Type**| **Required?**| **Brief description** | ++----------------+--------------+--------------+------------------------------+ +| Content-length | integer | No | Used only in error conditions| ++----------------+--------------+--------------+------------------------------+ +| Content-type | string | No | Used only in error conditions| ++----------------+--------------+--------------+------------------------------+ +| Date | datetime | No | Date time of the response in | +| | | | GMT | ++----------------+--------------+--------------+------------------------------+ +| X-MinorVersion | integer | Yes | The minor version of the API | +| | | | service | ++----------------+--------------+--------------+------------------------------+ +| X-PatchVersion | integer | Yes | The patch version of the API | +| | | | service | ++----------------+--------------+--------------+------------------------------+ +| X-LatestVersion| string | Yes | The full version of the API | +| | | | service expressed as {major}.| +| | | | {minor}.{patch} | ++----------------+--------------+--------------+------------------------------+ Body Fields (for success responses): no content is provided. Body Fields (for error responses): -+-----------------+-----------------+--------------------+----------------------------------+ -| **Parameter** | **Data Type** | **Required?** | **Brief description** | -+-----------------+-----------------+--------------------+----------------------------------+ -| requestError | requestError | Yes (for errors) | Used only in error conditions. | -+-----------------+-----------------+--------------------+----------------------------------+ ++--------------+--------------+----------------+------------------------------+ +| **Parameter**| **Data Type**| **Required?** | **Brief description** | ++--------------+--------------+----------------+------------------------------+ +| requestError | requestError | Yes(for errors)| Used only in error conditions| ++--------------+--------------+----------------+------------------------------+ HTTP Status Codes ++++++++++++++++++ -+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| *Code* | *Reason Phrase* | *Description* | -+==========+=========================+==========================================================================================================================================================================================================================================================================================================================================================================================+ -| 202 | Accepted | The request has been accepted for processing | -+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Bad Request | Many possible reasons not specified by the other codes (e.g., missing required parameters or incorrect format). The response body may include a further exception code and text. HTTP 400 errors may be mapped to SVC0001 (general service error), SVC0002 (bad parameter), SVC2000 (general service error with details) or PO9003 (message content size exceeds the allowable limit). | -+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 401 | Unauthorized | Authentication failed or was not provided. HTTP 401 errors may be mapped to POL0001 (general policy error) or POL2000 (general policy error with details). | -+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 404 | Not Found | The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent. | -+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 405 | Method Not Allowed | A request was made of a resource using a request method not supported by that resource (e.g., using PUT on a REST resource that only supports POST). | -+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | Internal Server Error | The server encountered an internal error or timed out; please retry (general catch-all server-side error).HTTP 500 errors may be mapped to SVC1000 (no server resources). | -+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----+--------------+--------------------------------------------------------+ +| Code| Reason Phrase| Description | ++=====+==============+========================================================+ +| 202 | Accepted | The request has been accepted for processing | ++-----+--------------+--------------------------------------------------------+ +| 400 | Bad Request | Many possible reasons not specified by the other codes | +| | | (e.g., missing required parameters or incorrect format)| +| | | . The response body may include a further exception | +| | | code and text. HTTP 400 errors may be mapped to SVC0001| +| | | (general service error), SVC0002 (bad parameter), | +| | | SVC2000 (general service error with details) or PO9003 | +| | | (message content size exceeds the allowable limit). | ++-----+--------------+--------------------------------------------------------+ +| 401 | Unauthorized | Authentication failed or was not provided. HTTP 401 | +| | | errors may be mapped to POL0001 (general policy error) | +| | | or POL2000 (general policy error with details). | ++-----+--------------+--------------------------------------------------------+ +| 404 | Not Found | The server has not found anything matching the | +| | | Request-URI. No indication is given of whether the | +| | | condition is temporary or permanent. | ++-----+--------------+--------------------------------------------------------+ +| 405 | Method Not | A request was made of a resource using a request method| +| | Allowed | not supported by that resource (e.g., using PUT on a | +| | | REST resource that only supports POST). | ++-----+--------------+--------------------------------------------------------+ +| 500 | Internal | The server encountered an internal error or timed out; | +| | Server Error | please retry (general catch-all server-side error).HTTP| +| | | 500 errors may be mapped to SVC1000 (no server | +| | | resources). | ++-----+--------------+--------------------------------------------------------+ Sample Request and Response ++++++++++++++++++++++++++++ @@ -2692,85 +3714,86 @@ Sample Request and Response Sample Request *************** -+-------------------------------------------------------------------------------+ -| POST /eventListener/v7 HTTP/1.1 | -| | -| Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== | -| | -| content-type: application/json | -| | -| content-length: 12345 | -| | -| X-MinorVersion: 1 | -| | -| { | -| | -| "event": { | -| | -| "commonEventHeader": { | -| | -| "version": "4.1", | -| | -| "vesEventListenerVersion": "7.1", | -| | -| "domain": "fault", | -| | -| "eventName": "Fault\_Vscf:Acs-Ericcson\_PilotNumberPoolExhaustion", | -| | -| "eventId": "fault0000245", | -| | -| "sequence": 1, | -| | -| "priority": "High", | -| | -| "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234", | -| | -| "reportingEntityName": "ibcx0001vm002oam001", | -| | -| "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014", | -| | -| "sourceName": "scfx0001vm002cap001", | -| | -| "nfVendorName": "Ericsson", | -| | -| "nfNamingCode": "scfx", | -| | -| "nfcNamingCode": "ssc", | -| | -| "startEpochMicrosec": 1413378172000000, | -| | -| "lastEpochMicrosec": 1413378172000000, | -| | -| "timeZoneOffset": "UTC-05:30" | -| | -| }, | -| | -| "faultFields": { | -| | -| "faultFieldsVersion": 4.0, | -| | -| "alarmCondition": "PilotNumberPoolExhaustion", | -| | -| "eventSourceType": "other", | -| | -| "specificProblem": "Calls cannot complete - pilot numbers are unavailable", | -| | -| "eventSeverity": "CRITICAL", | -| | -| "vfStatus": "Active", | -| | -| "alarmAdditionalInformation": { | -| | -| "PilotNumberPoolSize": "1000" | -| | -| } | -| | -| } | -| | -| } | -| | -| } | -+-------------------------------------------------------------------------------+ ++-----------------------------------------------------------------------------+ +| POST /eventListener/v7 HTTP/1.1 | +| | +| Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== | +| | +| content-type: application/json | +| | +| content-length: 12345 | +| | +| X-MinorVersion: 1 | +| | +| { | +| | +| "event": { | +| | +| "commonEventHeader": { | +| | +| "version": "4.1", | +| | +| "vesEventListenerVersion": "7.1", | +| | +| "domain": "fault", | +| | +| "eventName": "Fault\_Vscf:Acs-Ericcson\_PilotNumberPoolExhaustion", | +| | +| "eventId": "fault0000245", | +| | +| "sequence": 1, | +| | +| "priority": "High", | +| | +| "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234", | +| | +| "reportingEntityName": "ibcx0001vm002oam001", | +| | +| "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014", | +| | +| "sourceName": "scfx0001vm002cap001", | +| | +| "nfVendorName": "Ericsson", | +| | +| "nfNamingCode": "scfx", | +| | +| "nfcNamingCode": "ssc", | +| | +| "startEpochMicrosec": 1413378172000000, | +| | +| "lastEpochMicrosec": 1413378172000000, | +| | +| "timeZoneOffset": "UTC-05:30" | +| | +| }, | +| | +| "faultFields": { | +| | +| "faultFieldsVersion": 4.0, | +| | +| "alarmCondition": "PilotNumberPoolExhaustion", | +| | +| "eventSourceType": "other", | +| | +| "specificProblem": "Calls cannot complete - | +| pilot numbers are unavailable", | +| | +| "eventSeverity": "CRITICAL", | +| | +| "vfStatus": "Active", | +| | +| "alarmAdditionalInformation": { | +| | +| "PilotNumberPoolSize": "1000" | +| | +| } | +| | +| } | +| | +| } | +| | +| } | ++-----------------------------------------------------------------------------+ Sample Success Response ************************ @@ -2791,80 +3814,80 @@ Sample Error Responses Sample Policy Exception """""""""""""""""""""""" -+---------------------------------------------------------------+ -| HTTPS/1.1 400 Bad Request | -| | -| content-type: application/json | -| | -| content-length: 12345 | -| | -| Date: Thu, 04 Jun 2009 02:51:59 GMT | -| | -| X-MinorVersion: 1 | -| | -| X-PatchVersion: 0 | -| | -| X-LatestVersion: 7.1 | -| | -| { | -| | -| “requestError”: { | -| | -| “policyException”: { | -| | -| “messageId”: “POL9003”, | -| | -| “text”: “Message content size exceeds the allowable limit”, | -| | -| } | -| | -| } | -| | -| } | -+---------------------------------------------------------------+ ++---------------------------------------------------------------------+ +| HTTPS/1.1 400 Bad Request | +| | +| content-type: application/json | +| | +| content-length: 12345 | +| | +| Date: Thu, 04 Jun 2009 02:51:59 GMT | +| | +| X-MinorVersion: 1 | +| | +| X-PatchVersion: 0 | +| | +| X-LatestVersion: 7.1 | +| | +| { | +| | +| “requestError”: { | +| | +| “policyException”: { | +| | +| “messageId”: “POL9003”, | +| | +| “text”: “Message content size exceeds the allowable limit”, | +| | +| } | +| | +| } | +| | +| } | ++---------------------------------------------------------------------+ Sample Service Exception """"""""""""""""""""""""" -+-----------------------------------------------------+ -| HTTPS/1.1 400 Bad Request | -| | -| content-type: application/json | -| | -| content-length: 12345 | -| | -| Date: Thu, 04 Jun 2009 02:51:59 GMT | -| | -| X-MinorVersion: 1 | -| | -| X-PatchVersion: 0 | -| | -| X-LatestVersion: 7.1 | -| | -| { | -| | -| “requestError”: { | -| | -| “serviceException”: { | -| | -| “messageId”: “SVC2000”, | -| | -| “text”: “Missing Parameter: %1. Error code is %2” | -| | -| “variables”: [ | -| | -| “severity”, | -| | -| “400” | -| | -| ] | -| | -| } | -| | -| } | -| | -| } | -+-----------------------------------------------------+ ++-----------------------------------------------------------+ +| HTTPS/1.1 400 Bad Request | +| | +| content-type: application/json | +| | +| content-length: 12345 | +| | +| Date: Thu, 04 Jun 2009 02:51:59 GMT | +| | +| X-MinorVersion: 1 | +| | +| X-PatchVersion: 0 | +| | +| X-LatestVersion: 7.1 | +| | +| { | +| | +| “requestError”: { | +| | +| “serviceException”: { | +| | +| “messageId”: “SVC2000”, | +| | +| “text”: “Missing Parameter: %1. Error code is %2” | +| | +| “variables”: [ | +| | +| “severity”, | +| | +| “400” | +| | +| ] | +| | +| } | +| | +| } | +| | +| } | ++-----------------------------------------------------------+ Operation: publishEventBatch ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -2875,14 +3898,14 @@ Functional Behavior Allows authorized clients to publish a batch of events to the VES event listener. -- Supports only secure HTTPS (one way SSL) access. +- Supports only secure HTTPS (one way SSL) access. -- Uses the HTTP verb POST +- Uses the HTTP verb POST -- Supports JSON content types +- Supports JSON content types -- Provides HTTP response codes as well as Service and Policy error - messages +- Provides HTTP response codes as well as Service and Policy error + messages Call Flow +++++++++++ @@ -2897,85 +3920,125 @@ Input Parameters Header Fields (note: all parameter names shall be treated as case-insensitive): -+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **Parameter** | **Data Type** | **Required?** | **Brief description** | -+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Accept | string | No | Determines the format of the body of the response. Valid values are: | -| | | | | -| | | | - application/json | -+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Authorization | string | Yes | The username and password are formed into one string as “username:password”. This string is then Base64 encoded to produce the encoded credential which is communicated in the header after the string “Authorization: Basic “. See examples below. If the Authorization header is missing, then an HTTP 400 Invalid Request message shall be returned. If the string supplied is invalid, then an HTTP 401 Unauthorized message shall be returned. | -+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Content-length | integer | No | Note that content length is limited to 2Megabyte. | -+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Content-type | string | Yes | Must be set to one of the following values: | -| | | | | -| | | | - application/json | -+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| X-MinorVersion | integer | No | The minor version of the API requested by the client | -+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| X-PatchVersion | integer | No | The patch version of the API requested by the client | -+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| X-LatestVersion | string | No | The full version of the API requested by the client expressed as {major}.{minor}.{patch} | -+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------+----------+----------+---------------------------------------+ +| Parameter | Data Type| Required?| Brief description | ++---------------+----------+----------+---------------------------------------+ +| Accept | string | No | Determines the format of the body of | +| | | | the response. Valid values are: | +| | | | | +| | | | - application/json | ++---------------+----------+----------+---------------------------------------+ +| Authorization | string | Yes | The username and password are formed | +| | | | into one string as “username:password”| +| | | | . This string is then Base64 encoded | +| | | | to produce the encoded credential | +| | | | which is communicated in the header | +| | | | after the string “Authorization: | +| | | | Basic“. See examples below. If the | +| | | | Authorization header is missing, then | +| | | | an HTTP 400 Invalid Request message | +| | | | shall be returned. If the string | +| | | | supplied is invalid, then an HTTP 401 | +| | | | Unauthorized message shall be | +| | | | returned. | ++---------------+----------+----------+---------------------------------------+ +| Content-length| integer | No | Note that content length is limited to| +| | | | 2Megabyte. | ++---------------+----------+----------+---------------------------------------+ +| Content-type | string | Yes | Must be set to one of the following | +| | | | values: | +| | | | | +| | | | - application/json | ++---------------+----------+----------+---------------------------------------+ +| X-MinorVersion| integer | No | The minor version of the API requested| +| | | | by the client | ++---------------+----------+----------+---------------------------------------+ +| X-PatchVersion| integer | No | The patch version of the API requested| +| | | | by the client | ++---------------+----------+----------+---------------------------------------+ +| X-Latest\ | string | No | The full version of the API requested | +| Version | | | by the client expressed as | +| | | | {major}.{minor}.{patch} | ++---------------+----------+----------+---------------------------------------+ Body Fields: -+-----------------+-----------------+-----------------+----------------------------------------------------------+ -| **Parameter** | **Data Type** | **Required?** | **Brief description** | -+-----------------+-----------------+-----------------+----------------------------------------------------------+ -| eventList | eventList | Yes | Array of events conforming to the common event format. | -+-----------------+-----------------+-----------------+----------------------------------------------------------+ ++--------------+--------------+--------------+-------------------------------+ +| **Parameter**| **Data Type**| **Required?**| **Brief description** | ++--------------+--------------+--------------+-------------------------------+ +| eventList | eventList | Yes | Array of events conforming to | +| | | | the common event format. | ++--------------+--------------+--------------+-------------------------------+ Output Parameters +++++++++++++++++++ Header fields: -+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+ -| **Parameter** | **Data Type** | **Required?** | **Brief description** | -+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+ -| Content-length | integer | No | Used only in error conditions. | -+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+ -| Content-type | string | No | Used only in error conditions | -+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+ -| Date | datetime | No | Date time of the response in GMT | -+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+ -| X-MinorVersion | integer | Yes | The minor version of the API service | -+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+ -| X-PatchVersion | integer | Yes | The patch version of the API service | -+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+ -| X-LatestVersion | string | Yes | The full version of the API service expressed as {major}.{minor}.{patch} | -+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+ ++----------------+--------------+--------------+------------------------------+ +| **Parameter** | **Data Type**| **Required?**| **Brief description** | ++----------------+--------------+--------------+------------------------------+ +| Content-length | integer | No | Used only in error conditions| ++----------------+--------------+--------------+------------------------------+ +| Content-type | string | No | Used only in error conditions| ++----------------+--------------+--------------+------------------------------+ +| Date | datetime | No | Date time of the response in | +| | | | GMT | ++----------------+--------------+--------------+------------------------------+ +| X-MinorVersion | integer | Yes | The minor version of the API | +| | | | service | ++----------------+--------------+--------------+------------------------------+ +| X-PatchVersion | integer | Yes | The patch version of the API | +| | | | service | ++----------------+--------------+--------------+------------------------------+ +| X-LatestVersion| string | Yes | The full version of the API | +| | | | service expressed as | +| | | | {major}.{minor}.{patch} | ++----------------+--------------+--------------+------------------------------+ Body Fields (for success responses: no content is provided. Body Fields (for error responses): -+-----------------+-----------------+--------------------+----------------------------------+ -| **Parameter** | **Data Type** | **Required?** | **Brief description** | -+-----------------+-----------------+--------------------+----------------------------------+ -| requestError | requestError | Yes (for errors) | Used only in error conditions. | -+-----------------+-----------------+--------------------+----------------------------------+ ++--------------+--------------+----------------+------------------------------+ +| **Parameter**| **Data Type**| **Required?** | **Brief description** | ++--------------+--------------+----------------+------------------------------+ +| requestError | requestError | Yes(for errors)| Used only in error conditions| ++--------------+--------------+----------------+------------------------------+ HTTP Status Codes ++++++++++++++++++ -+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| *Code* | *Reason Phrase* | *Description* | -+==========+=========================+==========================================================================================================================================================================================================================================================================================================================================================================================+ -| 202 | Accepted | The request has been accepted for processing | -+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Bad Request | Many possible reasons not specified by the other codes (e.g., missing required parameters or incorrect format). The response body may include a further exception code and text. HTTP 400 errors may be mapped to SVC0001 (general service error), SVC0002 (bad parameter), SVC2000 (general service error with details) or PO9003 (message content size exceeds the allowable limit). | -+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 401 | Unauthorized | Authentication failed or was not provided. HTTP 401 errors may be mapped to POL0001 (general policy error) or POL2000 (general policy error with details). | -+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 404 | Not Found | The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent. | -+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 405 | Method Not Allowed | A request was made of a resource using a request method not supported by that resource (e.g., using PUT on a REST resource that only supports POST). | -+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | Internal Server Error | The server encountered an internal error or timed out; please retry (general catch-all server-side error).HTTP 500 errors may be mapped to SVC1000 (no server resources). | -+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----+--------------+--------------------------------------------------------+ +| Code| Reason Phrase| Description | ++=====+==============+========================================================+ +| 202 | Accepted | The request has been accepted for processing | ++-----+--------------+--------------------------------------------------------+ +| 400 | Bad Request | Many possible reasons not specified by the other codes | +| | | (e.g., missing required parameters or incorrect format)| +| | | . The response body may include a further exception | +| | | code and text. HTTP 400 errors may be mapped to SVC0001| +| | | (general service error), SVC0002 (bad parameter), | +| | | SVC2000 (general service error with details) or PO9003 | +| | | (message content size exceeds the allowable limit). | ++-----+--------------+--------------------------------------------------------+ +| 401 | Unauthorized | Authentication failed or was not provided. HTTP 401 | +| | | errors may be mapped to POL0001 (general policy error) | +| | | or POL2000 (general policy error with details). | ++-----+--------------+--------------------------------------------------------+ +| 404 | Not Found | The server has not found anything matching the | +| | | Request-URI. No indication is given of whether the | +| | | condition is temporary or permanent. | ++-----+--------------+--------------------------------------------------------+ +| 405 | Method Not | A request was made of a resource using a request method| +| | Allowed | not supported by that resource (e.g., using PUT on a | +| | | REST resource that only supports POST). | ++-----+--------------+--------------------------------------------------------+ +| 500 | Internal | The server encountered an internal error or timed out; | +| | Server Error | please retry (general catch-all server-side error).HTTP| +| | | 500 errors may be mapped to SVC1000 (no server | +| | | resources). | ++-----+--------------+--------------------------------------------------------+ Sample Request and Response +++++++++++++++++++++++++++++ @@ -2983,146 +4046,147 @@ Sample Request and Response Sample Request **************** -+-------------------------------------------------------------------------------+ -| POST /eventListener/v7/eventBatch HTTP/1.1 | -| | -| Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== | -| | -| content-type: application/json | -| | -| | content-length: 12345 | -| | X-MinorVersion: 1 | -| | -| { | -| | -| "eventList": [ | -| | -| { | -| | -| "commonEventHeader": { | -| | -| "version": "4.1", | -| | -| "vesEventListenerVersion": "7.1", | -| | -| "domain": "fault", | -| | -| "eventName": "Fault\_Vscf:Acs-Ericcson\_PilotNumberPoolExhaustion", | -| | -| "eventId": "fault0000250", | -| | -| "sequence": 1, | -| | -| "priority": "High", | -| | -| "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234", | -| | -| "reportingEntityName": "ibcx0001vm002oam0011234", | -| | -| "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014", | -| | -| "sourceName": "scfx0001vm002cap001", | -| | -| "nfVendorName": "Ericsson", | -| | -| "nfNamingCode": "scfx", | -| | -| "nfcNamingCode": "ssc", | -| | -| "startEpochMicrosec": 1413378172000000, | -| | -| "lastEpochMicrosec": 1413378172000000, | -| | -| "timeZoneOffset": "UTC-05:30" | -| | -| }, | -| | -| "faultFields": { | -| | -| "faultFieldsVersion": 4.0, | -| | -| "alarmCondition": "PilotNumberPoolExhaustion", | -| | -| "eventSourceType": "other", | -| | -| "specificProblem": "Calls cannot complete - pilot numbers are unavailable", | -| | -| "eventSeverity": "CRITICAL", | -| | -| "vfStatus": "Active", | -| | -| "alarmAdditionalInformation": { | -| | -| "PilotNumberPoolSize": "1000" | -| | -| } | -| | -| } | -| | -| }, | -| | -| { | -| | -| "commonEventHeader": { | -| | -| "version": "4.1", | -| | -| "vesEventListenerVersion": "7.1", | -| | -| "domain": "fault", | -| | -| "eventName": " Fault\_Vscf:Acs-Ericcson\_RecordingServerUnreachable", | -| | -| "eventId": "fault0000251", | -| | -| "sequence": 0, | -| | -| "priority": "High", | -| | -| "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234", | -| | -| "reportingEntityName": "ibcx0001vm002oam0011234", | -| | -| "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014", | -| | -| "sourceName": "scfx0001vm002cap001", | -| | -| "nfVendorName": "Ericsson", | -| | -| "nfNamingCode": "scfx", | -| | -| "nfcNamingCode": "ssc", | -| | -| "startEpochMicrosec": 1413378172000010, | -| | -| "lastEpochMicrosec": 1413378172000010, | -| | -| "timeZoneOffset": "UTC-05:30" | -| | -| }, | -| | -| "faultFields": { | -| | -| "faultFieldsVersion": 4.0, | -| | -| "alarmCondition": "RecordingServerUnreachable", | -| | -| "eventSourceType": "other", | -| | -| "specificProblem": "Recording server unreachable", | -| | -| "eventSeverity": "CRITICAL", | -| | -| "vfStatus": "Active" | -| | -| } | -| | -| } | -| | -| ] | -| | -| } | -+-------------------------------------------------------------------------------+ ++-----------------------------------------------------------------------------+ +| POST /eventListener/v7/eventBatch HTTP/1.1 | +| | +| Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== | +| | +| content-type: application/json | +| | +| content-length: 12345 | +| X-MinorVersion: 1 | +| | +| { | +| | +| "eventList": [ | +| | +| { | +| | +| "commonEventHeader": { | +| | +| "version": "4.1", | +| | +| "vesEventListenerVersion": "7.1", | +| | +| "domain": "fault", | +| | +| "eventName": "Fault_Vscf:Acs-Ericcson_PilotNumberPoolExhaustion", | +| | +| "eventId": "fault0000250", | +| | +| "sequence": 1, | +| | +| "priority": "High", | +| | +| "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234", | +| | +| "reportingEntityName": "ibcx0001vm002oam0011234", | +| | +| "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014", | +| | +| "sourceName": "scfx0001vm002cap001", | +| | +| "nfVendorName": "Ericsson", | +| | +| "nfNamingCode": "scfx", | +| | +| "nfcNamingCode": "ssc", | +| | +| "startEpochMicrosec": 1413378172000000, | +| | +| "lastEpochMicrosec": 1413378172000000, | +| | +| "timeZoneOffset": "UTC-05:30" | +| | +| }, | +| | +| "faultFields": { | +| | +| "faultFieldsVersion": 4.0, | +| | +| "alarmCondition": "PilotNumberPoolExhaustion", | +| | +| "eventSourceType": "other", | +| | +| "specificProblem": "Calls cannot complete - pilot numbers are | +| unavailable", | +| | +| "eventSeverity": "CRITICAL", | +| | +| "vfStatus": "Active", | +| | +| "alarmAdditionalInformation": { | +| | +| "PilotNumberPoolSize": "1000" | +| | +| } | +| | +| } | +| | +| }, | +| | +| { | +| | +| "commonEventHeader": { | +| | +| "version": "4.1", | +| | +| "vesEventListenerVersion": "7.1", | +| | +| "domain": "fault", | +| | +| "eventName": " Fault_Vscf:Acs-Ericcson_RecordingServerUnreachable",| +| | +| "eventId": "fault0000251", | +| | +| "sequence": 0, | +| | +| "priority": "High", | +| | +| "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234", | +| | +| "reportingEntityName": "ibcx0001vm002oam0011234", | +| | +| "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014", | +| | +| "sourceName": "scfx0001vm002cap001", | +| | +| "nfVendorName": "Ericsson", | +| | +| "nfNamingCode": "scfx", | +| | +| "nfcNamingCode": "ssc", | +| | +| "startEpochMicrosec": 1413378172000010, | +| | +| "lastEpochMicrosec": 1413378172000010, | +| | +| "timeZoneOffset": "UTC-05:30" | +| | +| }, | +| | +| "faultFields": { | +| | +| "faultFieldsVersion": 4.0, | +| | +| "alarmCondition": "RecordingServerUnreachable", | +| | +| "eventSourceType": "other", | +| | +| "specificProblem": "Recording server unreachable", | +| | +| "eventSeverity": "CRITICAL", | +| | +| "vfStatus": "Active" | +| | +| } | +| | +| } | +| | +| ] | +| | +| } | ++-----------------------------------------------------------------------------+ Sample Success Response ************************* @@ -3143,80 +4207,80 @@ Sample Error Responses Sample Policy Exception """""""""""""""""""""""" -+---------------------------------------------------------------+ -| HTTPS/1.1 400 Bad Request | -| | -| content-type: application/json | -| | -| content-length: 12345 | -| | -| Date: Thu, 04 Jun 2009 02:51:59 GMT | -| | -| X-MinorVersion: 1 | -| | -| X-PatchVersion: 0 | -| | -| X-LatestVersion: 7.1 | -| | -| { | -| | -| “requestError”: { | -| | -| “policyException”: { | -| | -| “messageId”: “POL9003”, | -| | -| “text”: “Message content size exceeds the allowable limit”, | -| | -| } | -| | -| } | -| | -| } | -+---------------------------------------------------------------+ ++-------------------------------------------------------------------+ +| HTTPS/1.1 400 Bad Request | +| | +| content-type: application/json | +| | +| content-length: 12345 | +| | +| Date: Thu, 04 Jun 2009 02:51:59 GMT | +| | +| X-MinorVersion: 1 | +| | +| X-PatchVersion: 0 | +| | +| X-LatestVersion: 7.1 | +| | +| { | +| | +| “requestError”: { | +| | +| “policyException”: { | +| | +| “messageId”: “POL9003”, | +| | +| “text”: “Message content size exceeds the allowable limit”, | +| | +| } | +| | +| } | +| | +| } | ++-------------------------------------------------------------------+ Sample Service Exception """"""""""""""""""""""""" -+-----------------------------------------------------+ -| HTTPS/1.1 400 Bad Request | -| | -| content-type: application/json | -| | -| content-length: 12345 | -| | -| Date: Thu, 04 Jun 2009 02:51:59 GMT | -| | -| X-MinorVersion: 1 | -| | -| X-PatchVersion: 0 | -| | -| X-LatestVersion: 7.1 | -| | -| { | -| | -| “requestError”: { | -| | -| “serviceException”: { | -| | -| “messageId”: “SVC2000”, | -| | -| “text”: “Missing Parameter: %1. Error code is %2” | -| | -| “variables”: [ | -| | -| “severity”, | -| | -| “400” | -| | -| ] | -| | -| } | -| | -| } | -| | -| } | -+-----------------------------------------------------+ ++-----------------------------------------------------------+ +| HTTPS/1.1 400 Bad Request | +| | +| content-type: application/json | +| | +| content-length: 12345 | +| | +| Date: Thu, 04 Jun 2009 02:51:59 GMT | +| | +| X-MinorVersion: 1 | +| | +| X-PatchVersion: 0 | +| | +| X-LatestVersion: 7.1 | +| | +| { | +| | +| “requestError”: { | +| | +| “serviceException”: { | +| | +| “messageId”: “SVC2000”, | +| | +| “text”: “Missing Parameter: %1. Error code is %2” | +| | +| “variables”: [ | +| | +| “severity”, | +| | +| “400” | +| | +| ] | +| | +| } | +| | +| } | +| | +| } | ++-----------------------------------------------------------+ Terminology ^^^^^^^^^^^^ @@ -3390,1108 +4454,1749 @@ Appendix: Historical Change Log For the latest changes, see the Change Block just before the Table of Contents. -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Date | Revision | Description | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 5/22/2015 | 0.1 | Initial Release - Draft | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 5/29/2015 | 0.2 | - Introduction: removed all system names and references to internal AT&T components | -| | | | -| | | - Security: changed ‘event publisher’ to ‘event source’ | -| | | | -| | | - Generic Event Format: updated the JSON schema per the below: | -| | | | -| | | - eventHeader: clarified the description of id, made sourceId a required field, changed the datatype of timestamps to timestamp [ ] | -| | | | -| | | - performanceFields: removed overflowFields | -| | | | -| | | - tmestamp: added a description of this datatype | -| | | | -| | | - Exceptions: fixed indentation of sections | -| | | | -| | | - Approvers: updated the list of approvers and added attuids | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 6/3/2015 | 0.3 | - Updated the security section to use HTTP Basic Authentication per AT&T REST standards. Updated the input parameters and messaging examples to use the new security scheme. | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 6/5/2015 | 0.4 | - Added otherFields sub section to the defined datatypes | -| | | | -| | | - Added locale field to the eventHeader. | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 6/5/2015 | 0.5 | - Updated the embedded event format json schema to match the changes made in v0.4 | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 6/10/2015 | 0.6 | - Updated the {ServerRoot} format to contain an optional routing path (for D2 service modules). | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 7/7/2015 | 0.7 | Common Event Format updates: | -| | | | -| | | - EventHeader: added ‘measurement’ to the ‘domain’ enumeration; changed ‘locale’ to ‘location’ and clarified in the description that this should be a clli code | -| | | | -| | | - Added a MeasurementFields datatype, which required the addition of the following datatypes: codecsInUse, cpuUsage, diskUsage, featuresInUse, memoryUsage | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 7/15/2015 | 1.0 | - Changed sourceInstance in the eventHeader to be an array of name value pairs | -| | | | -| | | - Changed the performanceFields block to thresholdCrossingAlertFields. Updated the domain field of the eventHeader to match. | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 7/23/2015 | v1.1 | Changes to eventHeader data format: | -| | | | -| | | - moved sourceInstance to internalHeaderFields | -| | | | -| | | - moved serviceInstanceId to internalHeaderFields | -| | | | -| | | - moved productId to internalHeaderFields | -| | | | -| | | - moved subscriberId to internalHeaderFields | -| | | | -| | | - moved location to internalHeaderFields | -| | | | -| | | - added the following new fields in internalHeaderFields: policyType, policyName, correlationEventType, correlationType, correlationName, correlationRootEventId | -| | | | -| | | - Changes to faultFields data format: | -| | | | -| | | - moved the eventSourceDeviceDescription to internalFaultFields and renamed it equipmentVendorModel | -| | | | -| | | - moved eventSourceHostname to internalFaultFields | -| | | | -| | | - changed alarmObjectInterface to alarmInterfaceA | -| | | | -| | | - changed alarmRemoteObject to alarmRemoteObjectZ and moved it to internalFaultFields | -| | | | -| | | - changed alarmRemoteObjectInterface to alarmInterfaceZ and moved it to internalFaultFields | -| | | | -| | | - Changes to thresholdCrossingFields data format: | -| | | | -| | | - changed several references from the old ‘performanceFields’ block to the new ‘thresholdCrossingFields’ block | -| | | | -| | | - Other: | -| | | | -| | | - Fixed several comma and colon syntax errors in the JSON schema as detected by a JSON schema syntax checker. | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 8/11/2015 | v1.2 | Timestamp format: | -| | | | -| | | - Section 4.18: added a note in the datetime field of the Timestamp datatype specifying the (GMT) format required | -| | | | -| | | - Updated the JSON schema with the same information | -| | | | -| | | Event Header Severity Enumeration: | -| | | | -| | | - Section 4.8: modified the severity enumeration to remove the numbers in parentheses that followed the names. The names were not changed. | -| | | | -| | | - Updated the JSON schema with the same information. | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 8/20/2015 | v1.3 | JSON Schema rev’d to v9: | -| | | | -| | | - Alphabetized all fields in the JSON schema | -| | | | -| | | - Fixed the way arrays were specified (JSON schema syntax issue) | -| | | | -| | | Sample Responses: | -| | | | -| | | - 2.1.1.1: alphabetized fields, fixed timestamps array depiction, fixed severity enum value to conform to latest format | -| | | | -| | | - 6.2.6.1: alphabetized fields, fixed timestamps array depiction, fixed severity enum value to conform to latest format | -| | | | -| | | - 6.3.6.1: alphabetized fields, fixed timestamps array depiction, fixed severity enum value to conform to latest format | -| | | | -| | | - 6.4.6.1: alphabetized fields, fixed timestamps array depiction, fixed eventList array depection, fixed severity enum value to conform to latest format | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 9/16/2015 | v1.4 | JSON Schema rev’d to v10: | -| | | | -| | | - Fixed an error in the way that the top level “event” object was specified in the v9 json schema. This was discovered when validating examples against the schema using this site: http://json-schema-validator.herokuapp.com/index.jsp. | -| | | | -| | | - Changed the embedded json file in section 4 | -| | | | -| | | Sample Responses: | -| | | | -| | | - Removed an extra comma after the timestamp brace in section 6.2.6 and 6.3.6. | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 11/11/2015 | v1.5 | Section 4 was the only section changed: JSON Schema rev’d to v11 and Datatype tables were updated to match. Numerous data structure changes were made based on VNF vendor proof of concept feedback. Modified sample requests and responses to match. | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 11/12/2015 | v1.6 | - The internalFaultFields were merged into the internalHeaderFields; then the internalFaultFields datatype was deleted. | -| | | | -| | | - Updated the JSON schema to v12. | -| | | | -| | | - Also corrected some background color issues in the sample requests and responses. | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 1/18/2016 | v1.7 | - Section 2 changes: updated the sample request to conform with the changes below | -| | | | -| | | - Section 4 datatype changes: | -| | | | -| | | - Changed 'eventHeader' to 'commonEventHeader' | -| | | | -| | | - Moved 'eventSeverity' from the 'commonEventHeader' to 'faultFields' | -| | | | -| | | - Added 'priority' to 'commonEventHeader' | -| | | | -| | | - moved 'vFstatus' to 'faultFields' | -| | | | -| | | - removed 'firstDateTime' and 'lastDateTime' and changed 'firstEpoch' to 'startEpochMicrosec' and changed 'lastEpoch' to 'lastEpochMicrosec'. | -| | | | -| | | - Added 'functionalRole' to the commonEventHeader | -| | | | -| | | - In the commonEventHeader, changed the 'eventDomain' enumeration to remove 'measurements' and add 'measurementsForVfScaling'. | -| | | | -| | | - Changed the 'measurementFields' to 'measurementsForVfScalingFields' | -| | | | -| | | - In the commonEventHeader, changed the following fields: | -| | | | -| | | - 'eventDomain' to 'domain' | -| | | | -| | | - 'eventSequence' to 'sequence' | -| | | | -| | | - 'eventSourceId' to 'sourceId' | -| | | | -| | | - 'eventSounceName' to 'sourceName' | -| | | | -| | | - Updated the JSON schema to v13 | -| | | | -| | | - Section 6 changes: updated the input parameters and sample requests to conform to the changes above. | -| | | | -| | | - Section 7: changed the section from Approvers to Contributors. | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 1/22/2016 | v1.8 | - Section 4: Added support for ‘mobileFlow’ in the commonEventHeader ‘domain’ enumeration. Added the mobileFlowFields datatype and the gtpPerFlowMetrics datatype referenced by that datatype. | -| | | | -| | | - Section 7: alphabetized the contributors | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2/11/2016 | v1.9 | - Added section 1.3: Naming Standard for Event Types | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2/12/2016 | v2.0 | - Updated request – response examples to reflect the naming standards for event types introduced in v1.9. | -| | | | -| | | - Added a paragraph on use of Avro as a transport in section 1.4 | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 3/11/2016 | v2.1 | - Updated the embedded JSON schema to v15 to fix a typo in the required fields for the measurementsForVfScalingFields, namely, changed ‘configuredEntites’ to ‘configuredEntities’. Additionally, added an ‘Event Listener’ title block at the bottom of the file with a single required event object. | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 3/15/2016 | v2.2 | - Added mobileFlowFields to the event datatype definition in section 4.7 and updated the embedded json schema at the top of section 4 to v16. | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 4/26/2016 | v2.3 | - Generic Event Format updates: 1) made ‘priority’ lowercase in the Word doc table for commonEventHeader; 2) added ‘requestError’ data structure to the Word doc and JSON schema (which is now at v17) | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 4/27/2016 | v2.4 | - JSON Schema: In the 'event' data structure, changed 'thresholdCrossingFields' to 'thresholdCrossingAlertFields' to product v18 of the schema. | -| | | | -| | | - 'codecsInUse' data structure: changed 'numberInUse' to 'codecUtilization’ | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 5/26/2016 | v2.5 | - Changed responses from ‘204 No Content’ to ‘202 Accepted’ and added a body to the response that enable AT&T to throttle the events being sent and/or to request the current state of throttling at the event source. | -| | | | -| | | - Added new datatypes to support the above: eventDomainThrottleSpecification, eventDomainThrottleSpecificationList, eventThrottlingState, suppressedNvPairs | -| | | | -| | | - Modifed the commonEventFormat json schema to v19 | -| | | | -| | | - Note: for the VendorEventListener: added new licensing language on the back of the title page; added an “attCopyrightNotice” definition at the top of the commonEventFormat\_Vendors.json file; also removed all references to internalHeaderFields from this file and from the VendorEventListener spec. | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 8/9/2016 | v2.6 | - commonHeader: added a note on the description of sourceId and sourceName in the commonHeader: "use reportingEntity for domains that provide more detailed source info" | -| | | | -| | | - commonHeader: deleted the capacity, measurementsForVfScaling and usage domains in the domain enumeration | -| | | | -| | | - commonHeader: added the following domains to the domain enumeration: licensingKci, scalingKpi, stateChange | -| | | | -| | | - event: removed references to capacityFields, measurementsForVfScalingFields and usageFields and added references to licensingKciFields, scalingKpiFields, stateChangeFields | -| | | | -| | | - licensingKciFields: added this section along with 'additionalMeasurements', which is an optional list of measurementGroup structures. Changed the name of kciFieldsVersion to licensingKciFieldsVersion. | -| | | | -| | | - scalingKpiFields: added this section but changed measurementFieldsVersion to scalingKpiFieldsVersion | -| | | | -| | | - stateChangeFields: added this section along with 'additionalFields', which is an optional list of name-value pairs. Other fields included newState and oldState which were enumerations of the following possible states: 'inService', 'maintenance', 'outOfService' | -| | | | -| | | - sysLogFields: added 'additionalFields', which is an optional list of name-value pairs | -| | | | -| | | - vNicUsage: added two required fields to the vNicUsage data structure: packetsIn and packetsOut | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 8/10/2016 | v2.7 | - commonHeader: removed the note on the description of sourceId and sourceName in the commonHeader: "use reportingEntity for domains that provide more detailed source info" | -| | | | -| | | - commonHeader: added measurementsForVfScaling domain back and removed the licensingKci and scalingKpi domains | -| | | | -| | | - event: removed references to licensingKciFields and scalingKpiFields; added references to measurementsForVfScalingFields | -| | | | -| | | - measurementsForVfScalingFields: combined the kciDetail and kpiDetail structures into the measurementsForVfScalingFields structure; referenced the errors structure | -| | | | -| | | - errors: added a new structure to capture the receive and transmit errors for the measurements domain | -| | | | -| | | - removed the following structures: kci, kpi, scalingKpiFields and licensingKciFields | -| | | | -| | | - eventDomainThrottleSpecification: updated the reference to commonEventHeader domain field | -| | | | -| | | - faultFields: removed the numbers from the enumerated strings for eventSourceType | -| | | | -| | | - vNicUsage: made the broadcast, multicast and unicast fields optional | -| | | | -| | | - contributors: updated Alok’s organizational area | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 8/12/2016 | v2.8 | - commonHeader: copied the descriptions of sourceId and sourceName from the JSON schema into the word document tables. | -| | | | -| | | - sample request examples: moved the reportingEntityId and reportingEntityNames to the same relative place in all sample requests in the document | -| | | | -| | | - Fixed the sample request shown for publishEventBatch to take an eventList as input. | -| | | | -| | | - Fixed the sample request shown for publishSpecificTopic to put the topic in the URL | -| | | | -| | | - errors: changed the receiveErrors and transmitErrors fields to be datatype number | -| | | | -| | | - codesInUse: changed 'codecUtilization' to 'numberinUse' | -| | | | -| | | - vNicUsage: updated the description of the fields | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 8/27/2016 | v2.9 | - Added a note "(currently: 1.1)" in the descriptions of the following fields: commonEventHeader:version, faultFields:faultFieldsVersion, measurementsForVfScalingFields:measurementsForVfScalingFieldsVersion, stateChangeFields:stateChangeFieldsVersion, sysLogFields:syslogFieldsVersion, thresholdCrossingAlertFields:thresholdCrossingFieldsVersion | -| | | | -| | | - stateChangeFields: made stateInterface mandatory | -| | | | -| | | - changed 'enum' to 'enumeration' throughout section 4 of the document (note: this can't be done in the JSON schema). | -| | | | -| | | - measurementsForVfScalingFields: made the following fields optional: conurrentSessions, configuredEntitites, cpuUsageArray, fileSystemUsageArray, memoryConfigured, memoryUsed, requestRate, vNicUsageArray | -| | | | -| | | - measurementsForVfScalingFields: concurrentSessions and configuredEntities: changed the description to support both VMs and VNFs | -| | | | -| | | - measurementsFor VfScalingFields: clarified the descriptions of latencyDistribution, measurementInverval and requestRate | -| | | | -| | | - syslogFields: clarified the descriptions of syslogSData, syslogTag, syslogVer | -| | | | -| | | - thresholdCrossingAlertFields: made the following fields optional and clarified their descriptions: elementType, networkService | -| | | | -| | | - command and commandList: created a list of command structures to enable the event collector to request changes of event sources. Commands consist of a commandType along with optional fields (whose presence is indicated by the commandType). Three command types are currently supported: 'measurementIntevalChange', ‘provideThrottlingState’ and 'throttlingSpecification'. | -| | | | -| | | - eventDomainThrottleSpecificationList: removed this and replaced it with commandList. | -| | | | -| | | - Operations and Sample Requests: modified the operations and samples to support the new command and commandList structures. | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 9/1/2016 | v2.10 | - measurementsForVfScaling block: made the following fields optional: latencyDistribution (which is an array of latencyBucketMeasure structures) and meanRequestLatency. Updated the JSON schemas (now v24) to match. | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 9/16/2016 | v2.11 | - 1 Introduction: updated the introduction to clarify the usage of eventTypes and the possibility of support for other protocols. | -| | | | -| | | - 6.1 REST Operation Overview: added two new subsections (6.1.2 and 6.1.3) discussing Api Version and Commands Toward Event Source Clients. | -| | | | -| | | - 6.2 publishAnyEvent: fixed the sample to conform to the latest changes | -| | | | -| | | - 6.3 publishSpecificTopic: fixed the sample to conform to the latest changes | -| | | | -| | | - 6.4 publishEventBatch: fixed the sample to conform to the latest changes | -| | | | -| | | - 6.5 provideThrottlingState operation: added the Input Parameters section heading back and fixed the sample request to provide eventThrottlingState (instead of eventThrottlingClientState). | -| | | | -| | | - The remaining bullets describe changes made to section 4 datatypes in alphabetical order: | -| | | | -| | | - command datatype: referenced the new section 6.1.3 which provides an explanation of command state expectations and requirements for a given eventSource: | -| | | | -| | | - commonEventHeader datatype: | -| | | | -| | | - made sourceId and reportingEntityId fields optional (although the internal Generic Event Listener spec indicates, in the field descriptions, that the AT&T enrichment process shall ensure that these fields are populated) | -| | | | -| | | - domain enumeration: changed measurementsForVfScalingFields to measurementsForVfScaling | -| | | | -| | | - eventDomainThrottleSpecificationList: added this array of eventDomainThrottleSpecification stuctures back to the schema because it is used by the provideThrottlingState operation. | -| | | | -| | | - eventList: added eventList back to the vendor version of the commonEventFormat. This is used by the publishEventBatch operation. | -| | | | -| | | - faultFields datatype: | -| | | | -| | | - eventSourceType: made this a string (and provided the previous enumerated values as examples) | -| | | | -| | | - filesystemUsage datatype: | -| | | | -| | | - changed vmIdentifier to filesystemName | -| | | | -| | | - gtpPerFlowMetrics datatype: | -| | | | -| | | - flowActivationTime: changed the format and description to be compliant with RFC 2822. | -| | | | -| | | - flowDeactivationTime: changed the format and description to be compliant with RFC 2822. | -| | | | -| | | - internalHeaderFields datatype: | -| | | | -| | | - Added the following optional fields: firstDateTime, lastDateTime compliant with RFC 2822. Noted in the description that these fields must be supplied for events in the following domains: fault, thresholdCrossingAlerts and measurementsForVfScaling. | -| | | | -| | | - ticketingTimestamp: changed the format and description to be compliant with RFC 2822. | -| | | | -| | | - syslogFields datatype: | -| | | | -| | | - eventSourceType: made this a string (and provided the previous enumerated values, without the numbers, as examples) | -| | | | -| | | - thresholdCrossingAlerts dataypte: | -| | | | -| | | - collectionTimestamp: changed the format and description to be compliant with RFC 2822. | -| | | | -| | | - eventStartTimestamp: changed the format and description to be compliant with RFC 2822. | -| | | | -| | | - added the same eventSeverity field as from the faultFields and made it required | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 9/23/2016 | v2.12 | - Section 4 Datatypes: commonEventHeader: made reportingEntityName a required field (note: the JSON schema already had this field as required) | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 11/29/2016 | v3.0 | - Introduction: | -| | | | -| | | - Introductory paragraph: changed '...Common Event Header Block followed by zero or more event domain blocks' to '...Common Event Header Block accompanied by zero or more event domain blocks' since the order of the blocks on the wire is not guaranteed. | -| | | | -| | | - Added Section 1.5 Versioning | -| | | | -| | | - Section 4: codec processing: | -| | | | -| | | - CommonEventFormat\_Vendors schema only: codesInUse: changed required field from "codecUtilization" which was removed previously to "numberInUse" which is the new field name. | -| | | | -| | | - added ‘codecSelected’ datatype | -| | | | -| | | - added ‘codecSelectedTranscoding’ datatype | -| | | | -| | | - Section 4 and section 6: command processing: | -| | | | -| | | - Added commandListEntry which is an object that references the command object. | -| | | | -| | | - commandList: changed commandList to contain an array of commandListEntry objects. | -| | | | -| | | - Updated sample responses in section 6 where commands are used | -| | | | -| | | - Section 4: commonEventHeader: | -| | | | -| | | - Incremented version to 1.2 | -| | | | -| | | - added two new values to the ‘domain’ enumeration: ‘serviceEvents’ and ‘signaling | -| | | | -| | | - Section 4: added endOfCallVqmSummaries datatype | -| | | | -| | | - Section 4: ‘event’: added two fields: ‘serviceEventsFields’ and ‘signalingFields’ | -| | | | -| | | - Section 4: added ‘eventInstanceIdentifier’datatype | -| | | | -| | | - Section 4: CommonEventListener only: internalHeaderFields: | -| | | | -| | | - added ‘internalHeaderFieldsVersion’(initially set to 1.1) | -| | | | -| | | - added ‘correlationFirstEpoch’ | -| | | | -| | | - added 'closedLoopControlName' | -| | | | -| | | - added 'closedLoopFlag' | -| | | | -| | | - added 'collectorTimeStamp' | -| | | | -| | | - added 'eventTag' | -| | | | -| | | - added ‘tenantName’ | -| | | | -| | | - changed 'operationalStatus' to 'inMaint' | -| | | | -| | | - added required fields in the schema to match the word doc: 'equipmentNameCode', 'equipmentType', 'equipmentVendor', 'inMaint', 'provStatus' | -| | | | -| | | - Section 4: added ‘marker’datatype | -| | | | -| | | - Section 4: added ‘midCallRtcp’ datatype | -| | | | -| | | - Section 4: mobileFlowFields: | -| | | | -| | | - added ‘mobileFlowFieldsVersion’(initially set to 1.1) | -| | | | -| | | - Section 4: added ‘serviceEventsFields’datatype | -| | | | -| | | - Section 4: added ‘signalingFields’ datatype | -| | | | -| | | - Section 4: syslogFields: | -| | | | -| | | - Incremented syslogFieldsVersion to 1.2 | -| | | | -| | | - added 'syslogPri' | -| | | | -| | | - added 'syslogSev' | -| | | | -| | | - added ‘syslogSdId’ | -| | | | -| | | - Section 4: thresholdCrossingAlertFields: | -| | | | -| | | - Incremented thresholdCrossingFieldsVersion to 1.2 | -| | | | -| | | - added 'additionalFields' which is an optional list of name value pairs. | -| | | | -| | | - Section 4: schema v26.0 embedded reflecting the above changes. | -| | | | -| | | - Section 6 and Section 2: changed all sample requests to use /v3 in the REST Resource URL. | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 12/1/2016 | v3.1 | - Section 6: Updated the call flow diagrams to show ‘v3’ | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 1/5/2017 | v4.0 | - Combined the Generic Event Listener and Vendor Event Listener into a single API service specification with version 4.0. | -| | | | -| | | - Changed the title to VES (Virtual Function Event Streaming) Listener. | -| | | | -| | | - Changed references to 'generic event' to 'common event' or 'VES event' (depending on the context) throughout the document. | -| | | | -| | | - Used the Legal Disclaimer from the Vendor Event Listener on the back of the title page. | -| | | | -| | | - Section 1: Introduction changes: | -| | | | -| | | - modified wording to reference 'VES' | -| | | | -| | | - removed the 'Audience' section, which described various AT&T groups the documented was intended for | -| | | | -| | | - tweaked the naming standards for event types to clarify the purpose of the naming conventions | -| | | | -| | | - Section 3: Resource Structure: added a sentence describing the FQDN and port used in the resource URL. | -| | | | -| | | - Section 4: Common Event Format changes: | -| | | | -| | | - renamed the section to 'Common Event Format' from 'Generic Event Format' | -| | | | -| | | - reorganized the datatypes into separate sections; sections were defined for each of the domains as well as for common event, common event header and command list processing | -| | | | -| | | - codecSelected datatype: removed this datatype | -| | | | -| | | - codecSelectedTranscoding datatype: removed this datatype | -| | | | -| | | - command datatype: added an enumerated value to commandType: 'heartbeatIntervalChange' | -| | | | -| | | - commonEventHeader: added internalHeaderFields to the commonEventHeader, defined as "Fields (not supplied by event sources) that the VES Event Listener service can use to enrich the event if needed for efficient internal processing. This is an empty object which is intended to be defined separately by each provider implementing the VES Event Listener." | -| | | | -| | | - commonEventHeader: removed two enumerated values, 'serviceEvents' and 'signaling' from the domain enumeration | -| | | | -| | | - commonEventHeader version: incremented the version to 2.0 | -| | | | -| | | - endOfCallVqmSummaries datatype: removed this datatype | -| | | | -| | | - event: changed the description of the event datatype to: "fields which constitute the ‘root level’ of the common event format" | -| | | | -| | | - event: removed 'serviceEventFields' and 'signalingFields' from the definition | -| | | | -| | | - event: fixed a misspelling of ‘thresholdCrossingAlertFields’, which was only present in the Word document | -| | | | -| | | - eventInstanceIdentifier datatype: removed this datatype | -| | | | -| | | - internalHeaderFIelds datatype: defined this as follows: "The internalHeaderFields datatype is an undefined object which can contain arbitrarily complex JSON structures. It is intended to be defined separately by each provider implementing the VES Event Listener. The fields in internalHeaderFields are not provided by any event source but instead are added by the VES Event Listener service itself as part of an event enrichment process necessary for efficient internal processing of events received by the VES Event Listener" | -| | | | -| | | - marker datatype: removed this datatype | -| | | | -| | | - measurementsForVfScalingFields datatype: clarified that memoryConfigured and memoryUsed are measured in MB | -| | | | -| | | - midCallRtcp datatype: removed this datatype | -| | | | -| | | - mobileFlowFields datatype: added ‘additionalFields’ | -| | | | -| | | - mobileFlowFields datatype: incremented the version number for this field block to 1.2 | -| | | | -| | | - serviceEventsFields datatype: removed this datatype | -| | | | -| | | - signalingFields datatype: removed this datatype | -| | | | -| | | - syslogFields: added three fields to the schema that were previously described in the document but not incorporated into the schema: syslogPri, syslogSev, syslogSdId | -| | | | -| | | - syslogFields version: incremented the version to 2.0 | -| | | | -| | | - Modified the Common Event Format JSON schema to v27.0 to incorporate the above changes. Also, added the AT&T Copyright Notice from the top of the retired CommonEventFormat\_Vendors schema. | -| | | | -| | | - Section 6 and 2: changed all sample requests to use /v4 in the REST Resource URL and call flow diagrams. | -| | | | -| | | - Section 6.1.3: added a row to the table in this section describing the ‘heartbeatIntervalChange’ command. | -| | | | -| | | - Section 6.1.4: added this new section describing expectations for buffering of events should all REST resource URL FQDNs be unreachable. | -| | | | -| | | - Section 6 Sample Requests: modified all sample requests showing the return of a commandList toward the event source to incorporate a heartbeatIntervalChange command; also corrected the spelling in the samples for the measurementIntervalChange command. | -| | | | -| | | - Section 7: Contributors: removed this section | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 3/21/2017 | v4.1 | - JSON Schema changes to produce v27.2 (note: an earlier draft version of v27.1 had been distributed to a few individuals): | -| | | | -| | | - To support use of the schema with event batches, removed the following statement near the end of the schema file: | -| | | | -| | | “required”: [ “event” ] | -| | | | -| | | - Fixed the characters used in some of the quotes | -| | | | -| | | - Fixed some typos in the descriptions. | -| | | | -| | | - Removed the booleans, which were non-essential and which were causing problems across different implementations. | -| | | | -| | | - Section 4.5.7 measurementsForVfScalingFields: | -| | | | -| | | - Fixed the spelling of measurementsForVfScalingFields in the Word document | -| | | | -| | | - Section 2 and 6 sample requests and responses: | -| | | | -| | | - Removed quotes from numbers: sequence, and first/lastEpochMicrosec. | -| | | | -| | | - Fixed all quote characters, some of which were using unusual symbols that wouldn’t validate with the json-schema Python package. | -| | | | -| | | - Section 6.2.6.1, 6.3.6.1, 6.4.6.1 sample requests: | -| | | | -| | | - Added an alarmAdditionalInformation field array to the sample requests. | -| | | | -| | | - Added missing commas. | -| | | | -| | | - Section 6.5.6.1 provideThrottlingState sample requests: | -| | | | -| | | - Fixed the eventDomainThrottleSpecificationList to pass an array of anonymous eventDomainThrottleSpecification objects. | -| | | | -| | | - Added missing quotes. | -| | | | -| | | - Fixed the suppressedNvPairsList to pass an array of anonymous suppressedNvPairs objects. | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 4/14/2017 | v5.0 | - Section 1 Introduction: | -| | | | -| | | - Clarified the Introduction (Section 1). | -| | | | -| | | - Changed Section 1.1 title from ‘Terminology’ to 'Event Registration' and referenced the YAML event registration format, defined in a separate document. | -| | | | -| | | - Clarified naming standards for eventName. | -| | | | -| | | - Section 3: updated the REST resource structure | -| | | | -| | | - Section 4.1 command list processing datatypes: | -| | | | -| | | - Got rid of commandListEntry and returned commandList to a simple array of commands. | -| | | | -| | | - Added heartbeatInterval to the command datatype. | -| | | | -| | | - Changed the datatype of measurementInterval from number to integer. | -| | | | -| | | - Section 4.2 common event datatypes: | -| | | | -| | | - event dataType: Added heartbeatFields, sipSignalingFields and voiceQualityFields to the event datatype as optional field blocks | -| | | | -| | | - Added jsonObject which provides a json object schema, name and other meta-information along with one or more object instances. | -| | | | -| | | - Added jsonObjectInstance which provides meta-information about an instance of a jsonObject along with the actual object instance | -| | | | -| | | - Added the ‘key’ datatype | -| | | | -| | | - Added the namedArrayOfFields datatype | -| | | | -| | | - Added vendorVnfNameFields | -| | | | -| | | - Section 4.3 common event header fields: | -| | | | -| | | - Add two new enumerations to domain: ‘sipSignaling’ and ‘voiceQuality’ | -| | | | -| | | - Renamed eventType to eventName. Note that the original usage of eventType was formally described in the Introduction back on 2/11/2016 with v1.9. | -| | | | -| | | - Made eventName a required field | -| | | | -| | | - Created a new field called eventType with a meaning that is different than the old eventType. | -| | | | -| | | - Removed functionalRole, which was replaced by the following two fields. | -| | | | -| | | - Added nfNamingCode | -| | | | -| | | - Added nfcNamingCode | -| | | | -| | | - Changed version to 3.0 (major version change) and made it a required field | -| | | | -| | | - Section 4.4: faultFields: | -| | | | -| | | - added one optional field: eventCategory | -| | | | -| | | - made faultFieldsVersion a required field | -| | | | -| | | - changed faultFieldsVersion to 2.0 (major version change) | -| | | | -| | | - fixed a typo on the spelling of alarmInterfaceA | -| | | | -| | | - clarified field descriptions | -| | | | -| | | - Section 4.5: added heartbeatFields datatype which can be used to communicate heartbeatInterval. Note: this change was previously made in v4.2 | -| | | | -| | | - Section 4.6 measurements for vf scaling datatypes: changed the following datatypes from number to integer: | -| | | | -| | | - In measurementsForVfScalingFields: concurrentSessions, configuredEntities, numberOfMediaPortsInUse, vnfcScalingMetric | -| | | | -| | | - In codecsInUse: numberInUse | -| | | | -| | | - In featuresInUse: featureUtilization | -| | | | -| | | - Section 4.6.2 modified cpuUsage | -| | | | -| | | - Section 4.6.3 added diskUsage | -| | | | -| | | - Section 4.6.7 measurementsForVfScalingFields: | -| | | | -| | | - fixed the spelling of the measurementsForVfScalingFields in the Word document | -| | | | -| | | - added additionalFields, which is an array of fields (i.e., name-value pairs) | -| | | | -| | | - changed additionalMeasurements to reference the common datatype namedArrayOfFields (instead of referencing measurementGroup) | -| | | | -| | | - added additionalObjects which is an array of jsonObjects described by name, keys and schema | -| | | | -| | | - deleted aggregateCpuUsage | -| | | | -| | | - added diskUsageArray | -| | | | -| | | - deleted measurementGroup (which was replaced by the common datatype: namedArrayOfFields | -| | | | -| | | - added memoryUsageArray | -| | | | -| | | - deleted memoryConfigured and memoryUsed | -| | | | -| | | - deleted errors and vNicUsageArray | -| | | | -| | | - added vNicPerformanceArray | -| | | | -| | | - changed the measurementsForVfScalingVersion to 2.0 (major version change) and made it a required field. Also changed the name of this version field in the Word document to match that in the JSON schema. | -| | | | -| | | - Section 4.6.8 added memoryUsage | -| | | | -| | | - Section 4.6.9 vNicPerformance: replaced vNicUsage and errors with vNicPerformance | -| | | | -| | | - Section 4.7 mobile flow fields changes: | -| | | | -| | | - Made mobileFlowFieldsVersion a required field and changed the mobileFlowFieldsVersion to 2.0 (major version change). | -| | | | -| | | - Changed the datatype of flowActivationTime and flowDeactivationTime in the Word doc to string. | -| | | | -| | | - changed the following datatypes from number to integer: otherEndpointPort, reportingEndpointPort, samplingAlgorithm | -| | | | -| | | - Section 4.8: otherFields: | -| | | | -| | | - Added otherFieldsVersion (set at 1.1) | -| | | | -| | | - Added hashOfNameValuePairArrays | -| | | | -| | | - Added jsonObjects | -| | | | -| | | - Added nameValuePairs | -| | | | -| | | - Section 4.9: added sipSignaling domain datatypes with 4.8.1 sipSignalingFields. sipSignalingFieldsVersion is set at 1.0 | -| | | | -| | | - Section 4.10 stateChangeFields: made stateChangeFieldsVersion a required field and set it to 2.0 (major version change). | -| | | | -| | | - Section 4.11 syslogFields: | -| | | | -| | | - Changed the following datatypes from number to integer: syslogFacility, syslogPri | -| | | | -| | | - Changed additionalFields from a field [ ] to a string which takes name=value pairs delimited by a pipe symbol. | -| | | | -| | | - Changed syslogFieldsVersion to 3.0 (major version change) and made it a required field | -| | | | -| | | - Made syslogSev an enumerated string (previously just a string) | -| | | | -| | | - Section 4.12 thresholdCrossingAlertFields: made thresholdCrossingFieldsVersion a required field and set it to 2.0 (major version change). | -| | | | -| | | - Section 4.132: added voice quality domain datatypes with 4.13.1 endOfCallVqmSummaries and 4.13.2 voiceQualityFields. voiceQualityFieldsVersion is set at 1.0 | -| | | | -| | | - JSON Schema: changed the schema to v28.0 and incorporated all of the changes above. | -| | | | -| | | - Additional JSON Schema changes that are part of v28: Note: The following changes are provided relative to API Spec v4.0 (which embedded JSON schema v27.0), but they were also made in an interim release v4.1 (which embedded JSON schema v27.2): | -| | | | -| | | - To support use of the schema with event batches, removed the following statement near the end of the schema file: | -| | | | -| | | “required”: [ “event” ] | -| | | | -| | | - Fixed the characters used in some of the quotes | -| | | | -| | | - Fixed some typos in the descriptions. | -| | | | -| | | - Removed the booleans, which were non-essential and which were causing problems across different implementations. | -| | | | -| | | - Section 2 and 6 sample requests and responses (also incorporated in interim release 4.1): | -| | | | -| | | - Removed quotes from numbers: sequence, and first/lastEpochMicrosec. | -| | | | -| | | - Fixed all quote characters, some of which were using unusual symbols that wouldn’t validate with the json-schema Python package. | -| | | | -| | | - Section 2 and 6 sample requests and responses (only in v5.0): | -| | | | -| | | - Changed the version numbers in the URL string. | -| | | | -| | | - Added nfNamingCode and nfcNamingCode and removed functionalRole | -| | | | -| | | - Section 6 call flows: updated the version number (only in v5.0). | -| | | | -| | | - Section 6: removed the publishSpecificTopic operation | -| | | | -| | | - Section 6.1.4: Buffering: clarified event source expectations for buffering (only in v5.0). | -| | | | -| | | - Section 6.2.6.1, 6.3.6.1 sample requests (also incorporated in interim release 4.1): | -| | | | -| | | - Added an alarmAdditionalInformation field array to the sample requests. | -| | | | -| | | - Added missing commas. | -| | | | -| | | - Section 6.2.6.3, 6.3.6.3 commandList sample responses (only in v5.0): | -| | | | -| | | - Fixed the commandList sample responses to pass an array of anonymous command objects (rather than an array of commandListEntry objects). | -| | | | -| | | - Fixed the heartbeatIntervalChange commandType to pass a heartbeatInterval value instead of a measurementInterval value. | -| | | | -| | | - Removed quotes from the measurementInterval and heartbeatInterval values since they are numbers. | -| | | | -| | | - Section 6.4.6.1 provideThrottlingState sample requests (also incorporated in interim release 4.1): | -| | | | -| | | - Fixed the eventDomainThrottleSpecificationList to pass an array of anonymous eventDomainThrottleSpecification objects. | -| | | | -| | | - Added missing quotes. | -| | | | -| | | - Fixed the suppressedNvPairsList to pass an array of anonymous suppressedNvPairs objects (also incorporated in interim release 4.1). | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 5/22/2017 | v5.1 | - Footers: removed proprietary markings and updated copyrights to 2017 | -| | | | -| | | - Section 4.2.3: field: | -| | | | -| | | - Changed the API spec to make ‘name’ and ‘value’ start with lowercase letters. Note: this did not affect the schema, which already had them as lowercase. | -| | | | -| | | - JSON Schema: | -| | | | -| | | - measurementGroup: deleted this object since it was replaced with ‘namedArrayOfFields’ in v28.0 and was no longer being used. | -| | | | -| | | - namedArrayOfFields: Fixed an error in the specification of required fields: from ‘measurements’ to ‘arrayOfFields’. | -| | | | -| | | - Changed the version of the JSON schema to 28.1 | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 6/14/2017 | v5.2 | - JSON Schema: created v28.2 by changing the field descriptions in the memoryUsage object to refer to ‘kibibytes’ instead of ‘kilobytes’. There were no changes to the 28.1 structure. | -| | | | -| | | - Word Document: measurementsForVfScaling Domain: memoryUsage object: changed the field descriptions in this object to refer to ‘kibibytes’ instead of ‘kilobytes’. There were no changes to the memoryUsage structure. | -| | | | -| | | - Reorganized the Word document to group the data structures in Section 4 into three broad categories to better align with the VNF Guidelines documentation that has been prepared for vendors: | -| | | | -| | | - Common Event Datatypes: | -| | | | -| | | - Command List Processing Datatypes | -| | | | -| | | - Common Event Datatypes | -| | | | -| | | - Common Event Header Datatypes | -| | | | -| | | - Technology Independent Datatypes: | -| | | | -| | | - ‘Fault Domain Datatypes | -| | | | -| | | - ‘Heartbeat’ Domain Datatypes | -| | | | -| | | - ‘Measurements For Vf Scaling’ Domain Datatypes | -| | | | -| | | - ‘Other’ Domain Datatypes | -| | | | -| | | - ‘State Change’ Domain Datatypes | -| | | | -| | | - ‘Syslog’ Domain Datatypes | -| | | | -| | | - ‘Threshold Crossing Alert’ Domain Datatypes | -| | | | -| | | - Technology Specify Datatypes: | -| | | | -| | | - ‘Mobile Flow’ Domain Datatypes | -| | | | -| | | - ‘Sip Signaling’ Domain Datatypes | -| | | | -| | | - ‘Voice Quality’ Domain Datatypes | -| | | | -| | | - Section 6.1.3: Commands Toward Event Source Clients: Added a statement: “Note: Vendors are not currently required to implement support for command processing; in addition, command processing may be supported by an App-C interface in future.” | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 6/22/2017 | v5.3 | - JSON Schema: created v28.3 by correcting an error in the sipSignalingFields: changed vnfVendorNameFields to vendorVnfNameFields. Embedded the new schema at the top of section 4. | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 9/12/2017 | v5.4 | - Note: There no changes to any data structures or operations in this version. | -| | | | -| | | - JSON Schema: created v28.4 embedded at the top of section 4: | -| | | | -| | | - Added a reference to eventList in the properties defined under the schema title. This enables the schema to correctly validate event batches in addition to just events. | -| | | | -| | | - Moved the schema title to the top of the schema and changed the text from “Event Listener” to “VES Event Listener” | -| | | | -| | | - Added a schema header block under the title to clearly communicate the schema version, associated API and last-modified information | -| | | | -| | | - Changed the date in the copyright notice to 2017 | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 9/19/2017 | v5.4.1 | - Note: There no changes to any data structures or operations in this version. | -| | | | -| | | - Back of Cover Page: updated the license and copyright notice to comply with ONAP guidelines | -| | | | -| | | - JSON Schema: updated the JSON schema to v28.4.1: updated the copyright notice and license to comply with ONAP guidelines | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 6/28/2018 | v6.0 | - Added contributors to the title page. | -| | | | -| | | - Updated references to ‘vnf’ ‘vnfc’ to either ‘nf’ and ‘nfc’ or ‘xNf’ and ‘xNfc’ to generalize support across both vnfs and pnfs. | -| | | | -| | | - Section 1: | -| | | | -| | | - clarified the meaning of the VES acronym | -| | | | -| | | - changed references from ASDC to SDC and from MSO to SO | -| | | | -| | | - clarified the requirements for eventNames. | -| | | | -| | | - Added a section of EventId use case examples | -| | | | -| | | - Added a new section on measurement expansion fields | -| | | | -| | | - Added a new section of syslogs | -| | | | -| | | - clarified the versioning section and referenced the new API Versioning section in section 6. | -| | | | -| | | - Added a list of all the latest field block version numbers in this version of the API spec. | -| | | | -| | | - Section 2: updated the sample to show use of new HTTP versioning headers. Added a note indicating that support for mutual SSL would be provided in future. | -| | | | -| | | - Section 3: updated the resource structure remove the clientThrottlingState resource. | -| | | | -| | | - Section 4: hashMaps. Changed all name-value pair structures to hashMaps causing the following data model and JSON schema (to v29.0) changes: | -| | | | -| | | - 4.1.1: Common Event Datatypes: | -| | | | -| | | - removed "field" and added “hashMap” | -| | | | -| | | - removed “namedArrayOfFields” and added “namedHashMap” | -| | | | -| | | - added arrayOfNamedHashMap | -| | | | -| | | - added arrayOfJsonObject | -| | | | -| | | - 4.2.1: Fault Domain Datatypes: | -| | | | -| | | - changed the faultFields version to 3.0 (major change) | -| | | | -| | | - changed faultFields.alarmAdditionalInformation to reference a hashMap | -| | | | -| | | - 4.2.2: Heartbeat Domain Datatypes: | -| | | | -| | | - changed the heartbeatFieldsVersion to 2.0 (major change) | -| | | | -| | | - changed heartbeatFields.additionalFields to reference a hashMap | -| | | | -| | | - 4.2.3: Measurement Domain Datatypes: | -| | | | -| | | - changed the measurementFieldsVersion to 3.0 (major change) | -| | | | -| | | - changed measurementFields.additionalFields to reference a hashMap | -| | | | -| | | - changed measurement.additionalMesurements to reference a namedHashMap [ ] | -| | | | -| | | - modified measurementFields.featureUsageArray to reference a hashmap and removed ‘featuresInUse’ | -| | | | -| | | - added the following datatypes which are now referenced as items in arrays within measurementFields: hugePages, load, machineCheckException, processStats | -| | | | -| | | - 4.2.5: Other Domain Datatypes: | -| | | | -| | | - Change the otherFieldsVersion to 2.0 (major change) | -| | | | -| | | - changed otherFields.nameValuePairs to reference a hashMap and renamed it hashMap | -| | | | -| | | - changed otherFields.hashOfNameValuePairArrrays to reference a namedHashMap and renamed it arrayOfNamedHashMap | -| | | | -| | | - 4.2.7: State Change Domain Datatypes: | -| | | | -| | | - changed the stateChangeFiledsVersion to 3.0 (major change) | -| | | | -| | | - changed stateChangeFields.additionalFields to reference a hashMap | -| | | | -| | | - 4.2.9: Threshold Crossing Alert Domain Datatypes: | -| | | | -| | | - changed the thresholdCrossingAlertFieldsVersion to 3.0 (major change) | -| | | | -| | | - changed thresholdCrossingAlertFields.additionalFields to reference a hashMap | -| | | | -| | | - counter: removed name and value elements and replaced with a hashMap | -| | | | -| | | - 4.3.1: Mobile Flow Domain Datatypes: | -| | | | -| | | - changed the mobileFlowFieldsVersion to 3.0 (major change) | -| | | | -| | | - changed mobileFlowFields.additionalFields to reference a hashMap | -| | | | -| | | - gtpPerFlowMetrics: modified ipTosCountList to reference hashmap | -| | | | -| | | - gtpPerFlowMetrics: modified mobileQciCosCountList to reference hashmap | -| | | | -| | | - gtpPerFlowMetrics: modified tcpFlagCountList to reference hashmap | -| | | | -| | | - 4.3.2: Sip Signaling Domain Datatypes: | -| | | | -| | | - changed the sigSignalingFieldsVersion to 2.0 (major change) | -| | | | -| | | - changed sipSignalingFields.additionalInformation to reference a hashMap | -| | | | -| | | - 4.3.3: Voice Quality Domain Datatypes: | -| | | | -| | | - change the voiceQualityFieldsVersion to 2.0 (major change) | -| | | | -| | | - changed voiceQualityFields.additionalInformation to reference a hashMap | -| | | | -| | | - Section 4: added notes at the top of section 4 clarifying expectations and requirements for optional fields, extensible fields and keys sent through extensible fields. | -| | | | -| | | - Common Event Data Types: Section 4.1.1.9 Changed vendorVnfNameFields to vendorNfNameFields; updated Section 4.3.2 SipSignaling and 4.3.3 Voice Quality to refer to the renamed object | -| | | | -| | | - Common Event Header Section 4.1.2: | -| | | | -| | | - clarified the descriptions of eventId, reportingEntityName, sourceName and startEpochMicroseconds. | -| | | | -| | | - Added ‘notification’ and ‘pngRegistration’ to the domain enumeration. | -| | | | -| | | - added a new timeZoneOffsest field | -| | | | -| | | - Fault Domain Section 4.2.1: clarified the definitions of alarmCondition, eventSeverity and specificProblem | -| | | | -| | | - Measurements Domain Section 4.2.3: changed the name of this domain from ‘measurementsForVfScaling’ to ‘measurement’ | -| | | | -| | | - measurementsForVfScaling measurement | -| | | | -| | | - measurementsForVfScalingFields measurementFields | -| | | | -| | | - measurementsForVfScalingVersion measurementFieldsVersion | -| | | | -| | | - the ‘mfvs’ abbreviation measurement | -| | | | -| | | - Measurements Domain Section 4.2.3 cpuUsage: added seven optional fields to this structure: cpuCapacityContention, cpuDemandAvg, cpuDemandMhz, cpuDemandPct, cpuLatencyAverage, cpuOverheadAvg, cpuSwapWaitTime | -| | | | -| | | - Measurements Domain Section 4.2.3 diskUsage: added ten optional fields to this structure: diskBusResets, diskCommandsAborted, diskCommandsAvg, diskFlushRequests, diskFlushTime, diskReadCommandsAvg, diskTime, diskTotalReadLatencyAvg, diskTotalWriteLatencyAvg, diskWriteCommandsAvg | -| | | | -| | | - Measurements Domain Section 4.2.3: added a new ‘ipmi’ datatype along with following ‘supporting’ datatypes: ipmiBaseboardTemperature, ipmiBaseboardVoltageRegulator, ipmiBattery, ipmiFan, ipmiGlobalAggregateTemperatureMargin, ipmiHsbp, ipmiNic, ipmiPowerSupply, ipmiProcessor, processorDimmAggregateThermalMargin | -| | | | -| | | - Measurements Domain Section 4.2.3: added a new ‘load’ datatype | -| | | | -| | | - Measurements Domain Section 4.2.3 memoryUsage: added eight optional fields to this structure: memoryDemand, memoryLatencyAvg, memorySharedAvg, memorySwapInAvg, memorySwapInRateAvg, memorySwapOutAvg, memorySwapOutRateAvg, memorySwapUsedAvg | -| | | | -| | | - Measurements Domain Section 4.2.3: modified measurementFields to include the following new fields: hugePagesArray, ipmi, loadArray, memoryErrors, processStatusArray, rdtArray | -| | | | -| | | - Measurements Domain Section 4.2.3 renamed vNicPerformance to nicPerformance and changed vNicIdentifer to nicIdentifier | -| | | | -| | | - Notification Domain Section 4.2.4: added notificationFields to support a new notification domain. | -| | | | -| | | - pnfRegistration Domain Section 4.2.7: added pnfRegistrationFields to support a new registration domain. | -| | | | -| | | - sysLog Domain Section 4.2.8: added two new fields: syslogMsgHost and syslogTs. Clarified field descriptions. Clarified syslogSData example. | -| | | | -| | | - endOfCallVqmSummaries Section 4.3.3.1: | -| | | | -| | | - converted endpointJitter into two fields: endpointAverageJitter and endpointMaxJitter | -| | | | -| | | - converted localJitter into two fields: localAverageJitter and localMaxJitter | -| | | | -| | | - added two fields: localAverageJitterBufferDelay and localMaxJitterBufferDelay | -| | | | -| | | - added endpointRtpOctetsLost and endpointRtpPacketsLost | -| | | | -| | | - added localRtpOctetsLost and localRtpPacketsLost | -| | | | -| | | - converted packetsLost into oneWayDelay | -| | | | -| | | - API Versioning: | -| | | | -| | | - Section 1.4: clarified the versioning section and linked it to the following new section 6.1.2 | -| | | | -| | | - Section 6.1.2: Added requirements for HTTP headers communicating minor, patch and latest version information. | -| | | | -| | | - Section 2 and 6 sample messages: clarified examples to use the new HTTP headers | -| | | | -| | | - Section 6.1.4: Added a section specifying message size limits. | -| | | | -| | | - Section2 6.2.6.1 and 6.3.6.1: corrected additionalInformation examples to use hashMap instead of name-value pair fields. | -| | | | -| | | - Section 7: Added a section on Terminology. | -| | | | -| | | - Command List Processing: removed command list processing from the document and schema: | -| | | | -| | | - Modified the Section 3 resource structure to align with these changes. | -| | | | -| | | - Removed Section 4 Datatypes: command, commandList, eventDomainThrottleSpecification, eventDomainThrottleSpecificationList, eventThrottlingState, suppressedNvPairs | -| | | | -| | | - Removed Section 6.1 description of commands toward event source clients | -| | | | -| | | - Removed Section 6.4 operation: provideThrottlingState | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 7/30/2018 | v7.0 | - General: | -| | | | -| | | - Fixed typos throughout | -| | | | -| | | - Changed example versions to v7 | -| | | | -| | | - Section1: | -| | | | -| | | - Clarified casing and use of dashes versus colons in eventName examples | -| | | | -| | | - Updated all field block versions | -| | | | -| | | - Section 2: added a note clarifying that TLS 1.2 or higher must be used for HTTPS connections. | -| | | | -| | | - Section 4 embedded schema changed to v30: | -| | | | -| | | - Added “ ‘additionalProperties’: false ” to objects to reject events that attempt to send properties that are not listed in the ‘properties’ keyword. Note: does not affect hashmap extensible fields. | -| | | | -| | | - Changed all versions in all field blocks from number to string enum with the version number fixed by the enum so the schema can validate events that attempt to send non-standard field blocks. | -| | | | -| | | - Changed syslog additionalFields to a hashMap | -| | | | -| | | - Section 4: | -| | | | -| | | - Fixed section heading numbers that were the same. | -| | | | -| | | - 4.1.1: jsonObjectInstance: added an optional recursive jsonObject and removed all required fields from this object | -| | | | -| | | - 4.1.2: commonEventHeader: | -| | | | -| | | - nfVendorName: added this optional field | -| | | | -| | | - timeZoneOffset: changed from number to string with a particular format specified | -| | | | -| | | - version was changed from number to string (as were all the version fields of all the field blocks) | -| | | | -| | | - vesCommonEventListenerVersion: added this required field as a string enumeration | -| | | | -| | | - 4.2.3: Measurements Domain: | -| | | | -| | | - Added a note clarifying that NFs are required to report exactly one Measurement event per period per sourceName | -| | | | -| | | - diskUsage: added four new optional fields: diskWeightedIoTimeAve, diskWeightedIoTimeLast, diskWeightedIoTimeMax, diskWeightedIoTimeMin | -| | | | -| | | - memoryUsage: add one new optional field: percentMemoryUsage | -| | | | -| | | - nicPerformance: added nine new optional fields: administrativeState, operationalState, receivedPercentDiscard, receivedPercentError, receivedUtilization, speed, transmittedPercentDiscard, transmittedPercentError, transmittedUtilization | -| | | | -| | | - processorDimmAggregateThermalMargin: make the thermalMargin field required | -| | | | -| | | - 4.2.8: Syslog Domain: | -| | | | -| | | - Corrected the example at the end of the section | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 7/31/2018 | v7.0.1 | - Section 4: The schema embedded at the top of section 4 was patched to correct a header field name error—the schema version moves from 30 to 30.0.1: | -| | | | -| | | - Changed commonEventHeader field: ‘vesCommonEventFormatVersion’ field to ‘vesEventListenerVersion’ and set the enum to 7.0.1 | -| | | | -| | | - Also changed the commonEventHeader ‘required’ array to reflect use the corrected field name: ‘vesEventListenerVersion’ | -| | | | -| | | - Changed the commonEventHeader ‘version’ field enumeration to 4.0.1 | -| | | | -| | | - Section1: | -| | | | -| | | - Changed the field block versions for the common header for ‘vesEventListenerVersion’ (to 7.0.1) and ‘version’ (to 4.0.1). | -| | | | -| | | - Sections 2 and 6: | -| | | | -| | | - Changed the commonEventHeader version fields above, in the sample message requests and responses; also updated the faultFieldsVersion to 4.0 | -| | | | -| | | - Section 6.1.2: Changed the X-LatestVersion to 7.0.1 and the X-PatchVersion to 1 | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 12/10/2018 | v7.1 | - Section 1.2: Added Notification domain Perf3gpp domain and changed a reference from ‘measurements domain’ to ‘measurement domain’. | -| | | | -| | | - Section 1.7.1: Field Block Versions: added ‘perf3gppFields’ version at 1.0 and changed the following version enumerations so that existing clients of major version 7 would not be broken by this VES minor version change, in accordance with semantic versioning definitions: | -| | | | -| | | - commonEventHeader: changed to ‘vesEventListenerVersion’ enum to accept either 7.0 or 7.0.1 or 7.1. | -| | | | -| | | - commonEventHeader: changed ‘version’ enum to accept either 4.0 or 4.0.1 or 4.1 | -| | | | -| | | - Section 2: | -| | | | -| | | - changed sample request and responses to reference 7.1 instead of 7.0.1 (and version 4.1 of the commonEventHeader version, instead of v4.0.1) | -| | | | -| | | - added a sub section on service provider support for mutual ssl certificate authentication | -| | | | -| | | - Section 4.1.2.1: | -| | | | -| | | - CommonEventHeader timeZoneOffset changed description from ‘UTC+/-hh.mm’ to ‘UTC+/-hh:mm’ | -| | | | -| | | - Added ‘perf3gpp’ to the domain enumeration | -| | | | -| | | - Section 4.2.3: Measurement Domain Datatypes: | -| | | | -| | | - In ‘MeasurementFields’: Changed ‘ipmiArray’ to ‘ipmi’ and made the type ‘object’ | -| | | | -| | | - ‘ipmiProcessor’: changed ‘pprocessorThermalControl’ to ‘processorThermalControl’ | -| | | | -| | | - ‘machineCheckException’: changed ‘processIdentifier’ to ‘vmIdentifier’ | -| | | | -| | | - Section 4.2.6: added the perf3gpp domain | -| | | | -| | | - Section 4 embedded schema: | -| | | | -| | | - Changed the schema version from 30.0.1 to 30.1 as a result of the changes below: | -| | | | -| | | - commonEventHeader: changed to ‘vesEventListenerVersion’ enum to accept either 7.0, 7.0.1 or 7.1 | -| | | | -| | | - commonEventHeader: changed the ‘version’ field enumeration to accept either 4.0, 4.0.1 or 4.1 | -| | | | -| | | - commonEventHeader: changed the ‘domain’ enumeration to add support for the perf3gpp domain. | -| | | | -| | | - ‘event’: added a reference to ‘perf3gppFields’ | -| | | | -| | | - ‘hugePages’: changed the type of hugePagesIdentifier from number to string | -| | | | -| | | - ‘ipmiGlobalAggregateTemperatureMargin’: changed ‘pmiGlobalAggregateTemperatureMarginIdentifier’ to ‘globalAggregateTemperatureMarginIdentifier’ | -| | | | -| | | - ‘perf3gppFields’: added this object | -| | | | -| | | - Section 6: changed references throughout from v7.0.1 to v7.1 and v4.0.1 (of the commonEventHeader version) to v4.1 | -+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------+---------+-------------------------------------------------------+ +| Date | Revision| Description | ++-----------+---------+-------------------------------------------------------+ +| 5/22/2015 | 0.1 | Initial Release - Draft | ++-----------+---------+-------------------------------------------------------+ +| 5/29/2015 | 0.2 | - Introduction: removed all system names and | +| | | references to internal AT&T components | +| | | | +| | | - Security: changed ‘event publisher’ to | +| | | ‘event source’ | +| | | | +| | | - Generic Event Format: updated the JSON schema per | +| | | the below: | +| | | | +| | | - eventHeader: clarified the description of id, made | +| | | sourceId a required field, changed the datatype of | +| | | timestamps to timestamp [ ] | +| | | | +| | | - performanceFields: removed overflowFields | +| | | | +| | | - tmestamp: added a description of this datatype | +| | | | +| | | - Exceptions: fixed indentation of sections | +| | | | +| | | - Approvers: updated the list of approvers and added | +| | | attuids | ++-----------+---------+-------------------------------------------------------+ +| 6/3/2015 | 0.3 | - Updated the security section to use HTTP Basic | +| | | Authentication per AT&T REST standards. Updated the| +| | | input parameters and messaging examples to use the | +| | | new security scheme. | ++-----------+---------+-------------------------------------------------------+ +| 6/5/2015 | 0.4 | - Added otherFields sub section to the defined | +| | | datatypes | +| | | | +| | | - Added locale field to the eventHeader. | ++-----------+---------+-------------------------------------------------------+ +| 6/5/2015 | 0.5 | - Updated the embedded event format json schema to | +| | | match the changes made in v0.4 | ++-----------+---------+-------------------------------------------------------+ +| 6/10/2015 | 0.6 | - Updated the {ServerRoot} format to contain an | +| | | optional routing path (for D2 service modules). | ++-----------+---------+-------------------------------------------------------+ +| 7/7/2015 | 0.7 | Common Event Format updates: | +| | | | +| | | - EventHeader: added ‘measurement’ to the ‘domain’ | +| | | enumeration; changed ‘locale’ to ‘location’ and | +| | | clarified in the description that this should be a | +| | | clli code | +| | | | +| | | - Added a MeasurementFields datatype, which required | +| | | the addition of the following datatypes: | +| | | codecsInUse, cpuUsage, diskUsage, featuresInUse, | +| | | memoryUsage | ++-----------+---------+-------------------------------------------------------+ +| 7/15/2015 | 1.0 | - Changed sourceInstance in the eventHeader to be an | +| | | array of name value pairs | +| | | | +| | | - Changed the performanceFields block to | +| | | thresholdCrossingAlertFields. Updated the domain | +| | | field of the eventHeader to match. | ++-----------+---------+-------------------------------------------------------+ +| 7/23/2015 | v1.1 | Changes to eventHeader data format: | +| | | | +| | | - moved sourceInstance to internalHeaderFields | +| | | | +| | | - moved serviceInstanceId to internalHeaderFields | +| | | | +| | | - moved productId to internalHeaderFields | +| | | | +| | | - moved subscriberId to internalHeaderFields | +| | | | +| | | - moved location to internalHeaderFields | +| | | | +| | | - added the following new fields in | +| | | internalHeaderFields: policyType, policyName, | +| | | correlationEventType, correlationType, | +| | | correlationName, correlationRootEventId | +| | | | +| | | Changes to faultFields data format: | +| | | | +| | | - moved the eventSourceDeviceDescription to | +| | | internalFaultFields and renamed it | +| | | equipmentVendorModel | +| | | | +| | | - moved eventSourceHostname to internalFaultFields | +| | | | +| | | - changed alarmObjectInterface to alarmInterfaceA | +| | | | +| | | - changed alarmRemoteObject to alarmRemoteObjectZ and| +| | | moved it to internalFaultFields | +| | | | +| | | - changed alarmRemoteObjectInterface to | +| | | alarmInterfaceZ and moved it to internalFaultFields| +| | | | +| | | Changes to thresholdCrossingFields data format: | +| | | | +| | | - changed several references from the old | +| | | ‘performanceFields’ block to the new | +| | | ‘thresholdCrossingFields’ block | +| | | | +| | | Other: | +| | | | +| | | - Fixed several comma and colon syntax errors in the | +| | | JSON schema as detected by a JSON schema syntax | +| | | checker. | ++-----------+---------+-------------------------------------------------------+ +| 8/11/2015 | v1.2 | Timestamp format: | +| | | | +| | | - Section 4.18: added a note in the datetime field of| +| | | the Timestamp datatype specifying the (GMT) format | +| | | required | +| | | | +| | | - Updated the JSON schema with the same information | +| | | | +| | | Event Header Severity Enumeration: | +| | | | +| | | - Section 4.8: modified the severity enumeration to | +| | | remove the numbers in parentheses that followed the| +| | | names. The names were not changed. | +| | | | +| | | - Updated the JSON schema with the same information. | ++-----------+---------+-------------------------------------------------------+ +| 8/20/2015 | v1.3 | JSON Schema rev’d to v9: | +| | | | +| | | - Alphabetized all fields in the JSON schema | +| | | | +| | | - Fixed the way arrays were specified (JSON schema | +| | | syntax issue) | +| | | | +| | | Sample Responses: | +| | | | +| | | - 2.1.1.1: alphabetized fields, fixed timestamps | +| | | array depiction, fixed severity enum value to | +| | | conform to latest format | +| | | | +| | | - 6.2.6.1: alphabetized fields, fixed timestamps | +| | | array depiction, fixed severity enum value to | +| | | conform to latest format | +| | | | +| | | - 6.3.6.1: alphabetized fields, fixed timestamps | +| | | array depiction, fixed severity enum value to | +| | | conform to latest format | +| | | | +| | | - 6.4.6.1: alphabetized fields, fixed timestamps | +| | | array depiction, fixed eventList array depection, | +| | | fixed severity enum value to conform to latest | +| | | format | ++-----------+---------+-------------------------------------------------------+ +| 9/16/2015 | v1.4 | JSON Schema rev’d to v10: | +| | | | +| | | - Fixed an error in the way that the top level | +| | | “event” object was specified in the v9 json schema. | +| | | This was discovered when validating examples | +| | | against the schema using this site: | +| | | http://json-schema-validator.herokuapp.com/index.jsp| +| | | | +| | | - Changed the embedded json file in section 4 | +| | | | +| | | Sample Responses: | +| | | | +| | | - Removed an extra comma after the timestamp brace in | +| | | section 6.2.6 and 6.3.6. | ++-----------+---------+-------------------------------------------------------+ +| 11/11/2015| v1.5 | Section 4 was the only section changed: JSON Schema | +| | | rev’d to v11 and Datatype tables were updated to match| +| | | . Numerous data structure changes were made based on | +| | | VNF vendor proof of concept feedback. Modified sample | +| | | requests and responses to match. | ++-----------+---------+-------------------------------------------------------+ +| 11/12/2015| v1.6 | - The internalFaultFields were merged into the | +| | | internalHeaderFields; then the internalFaultFields | +| | | datatype was deleted. | +| | | | +| | | - Updated the JSON schema to v12. | +| | | | +| | | - Also corrected some background color issues in the | +| | | sample requests and responses. | ++-----------+---------+-------------------------------------------------------+ +| 1/18/2016 | v1.7 | - Section 2 changes: updated the sample request to | +| | | conform with the changes below | +| | | | +| | | - Section 4 datatype changes: | +| | | | +| | | - Changed 'eventHeader' to 'commonEventHeader' | +| | | | +| | | - Moved 'eventSeverity' from the 'commonEventHeader' | +| | | to 'faultFields' | +| | | | +| | | - Added 'priority' to 'commonEventHeader' | +| | | | +| | | - moved 'vFstatus' to 'faultFields' | +| | | | +| | | - removed 'firstDateTime' and 'lastDateTime' and | +| | | changed 'firstEpoch' to 'startEpochMicrosec' and | +| | | changed 'lastEpoch' to 'lastEpochMicrosec'. | +| | | | +| | | - Added 'functionalRole' to the commonEventHeader | +| | | | +| | | - In the commonEventHeader, changed the 'eventDomain'| +| | | enumeration to remove 'measurements' and add | +| | | 'measurementsForVfScaling'. | +| | | | +| | | - Changed the 'measurementFields' to | +| | | 'measurementsForVfScalingFields' | +| | | | +| | | - In the commonEventHeader, changed the following | +| | | fields: | +| | | | +| | | - 'eventDomain' to 'domain' | +| | | | +| | | - 'eventSequence' to 'sequence' | +| | | | +| | | - 'eventSourceId' to 'sourceId' | +| | | | +| | | - 'eventSounceName' to 'sourceName' | +| | | | +| | | - Updated the JSON schema to v13 | +| | | | +| | | - Section 6 changes: updated the input parameters and| +| | | sample requests to conform to the changes above. | +| | | | +| | | - Section 7: changed the section from Approvers to | +| | | Contributors. | ++-----------+---------+-------------------------------------------------------+ +| 1/22/2016 | v1.8 | - Section 4: Added support for ‘mobileFlow’ in the | +| | | commonEventHeader ‘domain’ enumeration. Added the | +| | | mobileFlowFields datatype and the gtpPerFlowMetrics| +| | | datatype referenced by that datatype. | +| | | | +| | | - Section 7: alphabetized the contributors | ++-----------+---------+-------------------------------------------------------+ +| 2/11/2016 | v1.9 | - Added section 1.3: Naming Standard for Event Types | ++-----------+---------+-------------------------------------------------------+ +| 2/12/2016 | v2.0 | - Updated request – response examples to reflect the | +| | | naming standards for event types introduced in v1.9| +| | | | +| | | - Added a paragraph on use of Avro as a transport in | +| | | section 1.4 | ++-----------+---------+-------------------------------------------------------+ +| 3/11/2016 | v2.1 | - Updated the embedded JSON schema to v15 to fix a | +| | | typo in the required fields for the | +| | | measurementsForVfScalingFields, namely, changed | +| | | ‘configuredEntites’ to ‘configuredEntities’. | +| | | Additionally, added an ‘Event Listener’ title block| +| | | at the bottom of the file with a single required | +| | | event object. | ++-----------+---------+-------------------------------------------------------+ +| 3/15/2016 | v2.2 | - Added mobileFlowFields to the event datatype | +| | | definition in section 4.7 and updated the embedded | +| | | json schema at the top of section 4 to v16. | ++-----------+---------+-------------------------------------------------------+ +| 4/26/2016 | v2.3 | - Generic Event Format updates: 1) made ‘priority’ | +| | | lowercase in the Word doc table for | +| | | commonEventHeader; 2) added ‘requestError’ data | +| | | structure to the Word doc and JSON schema (which is| +| | | now at v17) | ++-----------+---------+-------------------------------------------------------+ +| 4/27/2016 | v2.4 | - JSON Schema: In the 'event' data structure, changed| +| | | 'thresholdCrossingFields' to | +| | | 'thresholdCrossingAlertFields' to product v18 of | +| | | the schema. | +| | | | +| | | - 'codecsInUse' data structure: changed 'numberInUse'| +| | | to 'codecUtilization’ | ++-----------+---------+-------------------------------------------------------+ +| 5/26/2016 | v2.5 | - Changed responses from ‘204 No Content’ to ‘202 | +| | | Accepted’ and added a body to the response that | +| | | enable AT&T to throttle the events being sent | +| | | and/or to request the current state of throttling | +| | | at the event source. | +| | | | +| | | - Added new datatypes to support the above: | +| | | eventDomainThrottleSpecification, | +| | | eventDomainThrottleSpecificationList, | +| | | eventThrottlingState, suppressedNvPairs | +| | | | +| | | - Modifed the commonEventFormat json schema to v19 | +| | | | +| | | - Note: for the VendorEventListener: added new | +| | | licensing language on the back of the title page; | +| | | added an “attCopyrightNotice” definition at the top| +| | | of the commonEventFormat\_Vendors.json file; also | +| | | removed all references to internalHeaderFields from| +| | | this file and from the VendorEventListener spec. | ++-----------+---------+-------------------------------------------------------+ +| 8/9/2016 | v2.6 | - commonHeader: added a note on the description of | +| | | sourceId and sourceName in the commonHeader: "use | +| | | reportingEntity for domains that provide more | +| | | detailed source info" | +| | | | +| | | - commonHeader: deleted the capacity, | +| | | measurementsForVfScaling and usage domains in the | +| | | domain enumeration | +| | | | +| | | - commonHeader: added the following domains to the | +| | | domain enumeration: licensingKci, scalingKpi, | +| | | stateChange | +| | | | +| | | - event: removed references to capacityFields, | +| | | measurementsForVfScalingFields and usageFields and | +| | | added references to licensingKciFields, | +| | | scalingKpiFields, stateChangeFields | +| | | | +| | | - licensingKciFields: added this section along with | +| | | 'additionalMeasurements', which is an optional list| +| | | of measurementGroup structures. Changed the name of| +| | | kciFieldsVersion to licensingKciFieldsVersion. | +| | | | +| | | - scalingKpiFields: added this section but changed | +| | | measurementFieldsVersion to scalingKpiFieldsVersion| +| | | | +| | | - stateChangeFields: added this section along with | +| | | 'additionalFields', which is an optional list of | +| | | name-value pairs. Other fields included newState | +| | | and oldState which were enumerations of the | +| | | following possible states: 'inService', | +| | | 'maintenance', 'outOfService' | +| | | | +| | | - sysLogFields: added 'additionalFields', which is an| +| | | optional list of name-value pairs | +| | | | +| | | - vNicUsage: added two required fields to the | +| | | vNicUsage data structure: packetsIn and packetsOut | ++-----------+---------+-------------------------------------------------------+ +| 8/10/2016 | v2.7 | - commonHeader: removed the note on the description | +| | | of sourceId and sourceName in the commonHeader: | +| | | "use reportingEntity for domains that provide more | +| | | detailed source info" | +| | | | +| | | - commonHeader: added measurementsForVfScaling domain| +| | | back and removed the licensingKci and scalingKpi | +| | | domains | +| | | | +| | | - event: removed references to licensingKciFields and| +| | | scalingKpiFields; added references to | +| | | measurementsForVfScalingFields | +| | | | +| | | - measurementsForVfScalingFields: combined the | +| | | kciDetail and kpiDetail structures into the | +| | | measurementsForVfScalingFields structure; | +| | | referenced the errors structure | +| | | | +| | | - errors: added a new structure to capture the | +| | | receive and transmit errors for the measurements | +| | | domain | +| | | | +| | | - removed the following structures: kci, kpi, | +| | | scalingKpiFields and licensingKciFields | +| | | | +| | | - eventDomainThrottleSpecification: updated the | +| | | reference to commonEventHeader domain field | +| | | | +| | | - faultFields: removed the numbers from the | +| | | enumerated strings for eventSourceType | +| | | | +| | | - vNicUsage: made the broadcast, multicast and | +| | | unicast fields optional | +| | | | +| | | - contributors: updated Alok’s organizational area | ++-----------+---------+-------------------------------------------------------+ +| 8/12/2016 | v2.8 | - commonHeader: copied the descriptions of sourceId | +| | | and sourceName from the JSON schema into the word | +| | | document tables. | +| | | | +| | | - sample request examples: moved the | +| | | reportingEntityId and reportingEntityNames to the | +| | | same relative place in all sample requests in the | +| | | document | +| | | | +| | | - Fixed the sample request shown for | +| | | publishEventBatch to take an eventList as input. | +| | | | +| | | - Fixed the sample request shown for | +| | | publishSpecificTopic to put the topic in the URL | +| | | | +| | | - errors: changed the receiveErrors and | +| | | transmitErrors fields to be datatype number | +| | | | +| | | - codesInUse: changed 'codecUtilization' to | +| | | 'numberinUse' | +| | | | +| | | - vNicUsage: updated the description of the fields | ++-----------+---------+-------------------------------------------------------+ +| 8/27/2016 | v2.9 | - Added a note "(currently: 1.1)" in the descriptions| +| | | of the following fields: commonEventHeader:version,| +| | | faultFields:faultFieldsVersion, | +| | | measurementsForVfScalingFields:measurementsForVf\ | +| | | ScalingFieldsVersion, stateChangeFields:state\ | +| | | ChangeFieldsVersion, sysLogFields:syslogFields\ | +| | | Version, thresholdCrossingAlertFields:threshold\ | +| | | CrossingFieldsVersion | +| | | | +| | | - stateChangeFields: made stateInterface mandatory | +| | | | +| | | - changed 'enum' to 'enumeration' throughout section | +| | | 4 of the document (note: this can't be done in the | +| | | JSON schema). | +| | | | +| | | - measurementsForVfScalingFields: made the following | +| | | fields optional: conurrentSessions, configured\ | +| | | Entitites, cpuUsageArray, fileSystemUsageArray, | +| | | memoryConfigured, memoryUsed, requestRate, | +| | | vNicUsageArray | +| | | | +| | | - measurementsForVfScalingFields: concurrentSessions | +| | | and configuredEntities: changed the description to | +| | | support both VMs and VNFs | +| | | | +| | | - measurementsFor VfScalingFields: clarified the | +| | | descriptions of latencyDistribution, measurement\ | +| | | Inverval and requestRate | +| | | | +| | | - syslogFields: clarified the descriptions of | +| | | syslogSData, syslogTag, syslogVer | +| | | | +| | | - thresholdCrossingAlertFields: made the following | +| | | fields optional and clarified their descriptions: | +| | | elementType, networkService | +| | | | +| | | - command and commandList: created a list of command | +| | | structures to enable the event collector to request| +| | | changes of event sources. Commands consist of a | +| | | commandType along with optional fields (whose | +| | | presence is indicated by the commandType). Three | +| | | command types are currently supported: | +| | | 'measurementIntevalChange', | +| | | ‘provideThrottlingState’ and | +| | | 'throttlingSpecification'. | +| | | | +| | | - eventDomainThrottleSpecificationList: removed this | +| | | and replaced it with commandList. | +| | | | +| | | - Operations and Sample Requests: modified the | +| | | operations and samples to support the new command | +| | | and commandList structures. | ++-----------+---------+-------------------------------------------------------+ +| 9/1/2016 | v2.10 | - measurementsForVfScaling block: made the following | +| | | fields optional: latencyDistribution (which is an | +| | | array of latencyBucketMeasure structures) and | +| | | meanRequestLatency. Updated the JSON schemas (now | +| | | v24) to match. | ++-----------+---------+-------------------------------------------------------+ +| 9/16/2016 | v2.11 | - 1 Introduction: updated the introduction to clarify| +| | | the usage of eventTypes and the possibility of | +| | | support for other protocols. | +| | | | +| | | - 6.1 REST Operation Overview: added two new | +| | | subsections (6.1.2 and 6.1.3) discussing Api | +| | | Version and Commands Toward Event Source Clients. | +| | | | +| | | - 6.2 publishAnyEvent: fixed the sample to conform to| +| | | the latest changes | +| | | | +| | | - 6.3 publishSpecificTopic: fixed the sample to | +| | | conform to the latest changes | +| | | | +| | | - 6.4 publishEventBatch: fixed the sample to conform | +| | | to the latest changes | +| | | | +| | | - 6.5 provideThrottlingState operation: added the | +| | | Input Parameters section heading back and fixed the| +| | | sample request to provide eventThrottlingState | +| | | (instead of eventThrottlingClientState). | +| | | | +| | | - The remaining bullets describe changes made to | +| | | section 4 datatypes in alphabetical order: | +| | | | +| | | - command datatype: referenced the new section 6.1.3 | +| | | which provides an explanation of command state | +| | | expectations and requirements for a given | +| | | eventSource: | +| | | | +| | | - commonEventHeader datatype: | +| | | | +| | | - made sourceId and reportingEntityId fields | +| | | optional (although the internal Generic Event | +| | | Listener spec indicates, in the field | +| | | descriptions, that the AT&T enrichment process | +| | | shall ensure that these fields are populated) | +| | | | +| | | - domain enumeration: changed measurementsForVf\ | +| | | ScalingFields to measurementsForVfScaling | +| | | | +| | | - eventDomainThrottleSpecificationList: added this | +| | | array of eventDomainThrottleSpecification stuctures| +| | | back to the schema because it is used by the | +| | | provideThrottlingState operation. | +| | | | +| | | - eventList: added eventList back to the vendor | +| | | version of the commonEventFormat. This is used by | +| | | the publishEventBatch operation. | +| | | | +| | | - faultFields datatype: | +| | | | +| | | - eventSourceType: made this a string (and | +| | | provided the previous enumerated values as | +| | | examples) | +| | | | +| | | - filesystemUsage datatype: | +| | | | +| | | - changed vmIdentifier to filesystemName | +| | | | +| | | - gtpPerFlowMetrics datatype: | +| | | | +| | | - flowActivationTime: changed the format and | +| | | description to be compliant with RFC 2822. | +| | | | +| | | - flowDeactivationTime: changed the format and | +| | | description to be compliant with RFC 2822. | +| | | | +| | | - internalHeaderFields datatype: | +| | | | +| | | - Added the following optional fields: firstDate\ | +| | | Time, lastDateTime compliant with RFC 2822. | +| | | Noted in the description that these fields must | +| | | be supplied for events in the following domains:| +| | | fault, thresholdCrossingAlerts and | +| | | measurementsForVfScaling. | +| | | | +| | | - ticketingTimestamp: changed the format and | +| | | description to be compliant with RFC 2822. | +| | | | +| | | - syslogFields datatype: | +| | | | +| | | - eventSourceType: made this a string (and | +| | | provided the previous enumerated values, without| +| | | the numbers, as examples) | +| | | | +| | | - thresholdCrossingAlerts dataypte: | +| | | | +| | | - collectionTimestamp: changed the format and | +| | | description to be compliant with RFC 2822. | +| | | | +| | | - eventStartTimestamp: changed the format and | +| | | description to be compliant with RFC 2822. | +| | | | +| | | - added the same eventSeverity field as from the | +| | | faultFields and made it required | ++-----------+---------+-------------------------------------------------------+ +| 9/23/2016 | v2.12 | - Section 4 Datatypes: commonEventHeader: made | +| | | reportingEntityName a required field (note: the | +| | | JSON schema already had this field as required) | ++-----------+---------+-------------------------------------------------------+ +| 11/29/2016| v3.0 | - Introduction: | +| | | | +| | | - Introductory paragraph: changed '...Common Event| +| | | Header Block followed by zero or more event | +| | | domain blocks' to '...Common Event Header Block | +| | | accompanied by zero or more event domain blocks'| +| | | since the order of the blocks on the wire is | +| | | not guaranteed. | +| | | | +| | | - Added Section 1.5 Versioning | +| | | | +| | | - Section 4: codec processing: | +| | | | +| | | - CommonEventFormat\_Vendors schema only: | +| | | codesInUse: changed required field from | +| | | "codecUtilization" which was removed previously | +| | | to "numberInUse" which is the new field name. | +| | | | +| | | - added ‘codecSelected’ datatype | +| | | | +| | | - added ‘codecSelectedTranscoding’ datatype | +| | | | +| | | - Section 4 and section 6: command processing: | +| | | | +| | | - Added commandListEntry which is an object that | +| | | references the command object. | +| | | | +| | | - commandList: changed commandList to contain an | +| | | array of commandListEntry objects. | +| | | | +| | | - Updated sample responses in section 6 where | +| | | commands are used | +| | | | +| | | - Section 4: commonEventHeader: | +| | | | +| | | - Incremented version to 1.2 | +| | | | +| | | - added two new values to the ‘domain’ | +| | | enumeration: ‘serviceEvents’ and ‘signaling | +| | | | +| | | - Section 4: added endOfCallVqmSummaries datatype | +| | | | +| | | - Section 4: ‘event’: added two fields: | +| | | ‘serviceEventsFields’ and ‘signalingFields’ | +| | | | +| | | - Section 4: added ‘eventInstanceIdentifier’datatype | +| | | | +| | | - Section 4: CommonEventListener only: | +| | | internalHeaderFields: | +| | | | +| | | - added ‘internalHeaderFieldsVersion’(initially | +| | | set to 1.1) | +| | | | +| | | - added ‘correlationFirstEpoch’ | +| | | | +| | | - added 'closedLoopControlName' | +| | | | +| | | - added 'closedLoopFlag' | +| | | | +| | | - added 'collectorTimeStamp' | +| | | | +| | | - added 'eventTag' | +| | | | +| | | - added ‘tenantName’ | +| | | | +| | | - changed 'operationalStatus' to 'inMaint' | +| | | | +| | | - added required fields in the schema to match the| +| | | word doc: 'equipmentNameCode', 'equipmentType', | +| | | 'equipmentVendor', 'inMaint', 'provStatus' | +| | | | +| | | - Section 4: added ‘marker’datatype | +| | | | +| | | - Section 4: added ‘midCallRtcp’ datatype | +| | | | +| | | - Section 4: mobileFlowFields: | +| | | | +| | | - added ‘mobileFlowFieldsVersion’(initially set to| +| | | 1.1) | +| | | | +| | | - Section 4: added ‘serviceEventsFields’datatype | +| | | | +| | | - Section 4: added ‘signalingFields’ datatype | +| | | | +| | | - Section 4: syslogFields: | +| | | | +| | | - Incremented syslogFieldsVersion to 1.2 | +| | | | +| | | - added 'syslogPri' | +| | | | +| | | - added 'syslogSev' | +| | | | +| | | - added ‘syslogSdId’ | +| | | | +| | | - Section 4: thresholdCrossingAlertFields: | +| | | | +| | | - Incremented thresholdCrossingFieldsVersion to | +| | | 1.2 | +| | | | +| | | - added 'additionalFields' which is an optional | +| | | list of name value pairs. | +| | | | +| | | - Section 4: schema v26.0 embedded reflecting the | +| | | above changes. | +| | | | +| | | - Section 6 and Section 2: changed all sample | +| | | requests to use /v3 in the REST Resource URL. | ++-----------+---------+-------------------------------------------------------+ +| 12/1/2016 | v3.1 | - Section 6: Updated the call flow diagrams to show | +| | | ‘v3’ | ++-----------+---------+-------------------------------------------------------+ +| 1/5/2017 | v4.0 | - Combined the Generic Event Listener and Vendor | +| | | Event Listener into a single API service | +| | | specification with version 4.0. | +| | | | +| | | - Changed the title to VES (Virtual Function Event | +| | | Streaming) Listener. | +| | | | +| | | - Changed references to 'generic event' to 'common | +| | | event' or 'VES event' (depending on the context) | +| | | throughout the document. | +| | | | +| | | - Used the Legal Disclaimer from the Vendor Event | +| | | Listener on the back of the title page. | +| | | | +| | | - Section 1: Introduction changes: | +| | | | +| | | - modified wording to reference 'VES' | +| | | | +| | | - removed the 'Audience' section, which described | +| | | various AT&T groups the documented was intended | +| | | for | +| | | | +| | | - tweaked the naming standards for event types to | +| | | clarify the purpose of the naming conventions | +| | | | +| | | - Section 3: Resource Structure: added a sentence | +| | | describing the FQDN and port used in the resource | +| | | URL. | +| | | | +| | | - Section 4: Common Event Format changes: | +| | | | +| | | - renamed the section to 'Common Event Format' | +| | | from 'Generic Event Format' | +| | | | +| | | - reorganized the datatypes into separate sections| +| | | ; sections were defined for each of the domains | +| | | as well as for common event, common event header| +| | | and command list processing | +| | | | +| | | - codecSelected datatype: removed this datatype | +| | | | +| | | - codecSelectedTranscoding datatype: removed this | +| | | datatype | +| | | | +| | | - command datatype: added an enumerated value to | +| | | commandType: 'heartbeatIntervalChange' | +| | | | +| | | - commonEventHeader: added internalHeaderFields to| +| | | the commonEventHeader, defined as "Fields (not | +| | | supplied by event sources) that the VES Event | +| | | Listener service can use to enrich the event if | +| | | needed for efficient internal processing. This | +| | | is an empty object which is intended to be | +| | | defined separately by each provider implementing| +| | | the VES Event Listener." | +| | | | +| | | - commonEventHeader: removed two enumerated values| +| | | , 'serviceEvents' and 'signaling' from the | +| | | domain enumeration | +| | | | +| | | - commonEventHeader version: incremented the | +| | | version to 2.0 | +| | | | +| | | - endOfCallVqmSummaries datatype: removed this | +| | | datatype | +| | | | +| | | - event: changed the description of the event | +| | | datatype to: "fields which constitute the ‘root | +| | | level’ of the common event format" | +| | | | +| | | - event: removed 'serviceEventFields' and | +| | | 'signalingFields' from the definition | +| | | | +| | | - event: fixed a misspelling of | +| | | ‘thresholdCrossingAlertFields’, which was only | +| | | present in the Word document | +| | | | +| | | - eventInstanceIdentifier datatype: removed this | +| | | datatype | +| | | | +| | | - internalHeaderFIelds datatype: defined this as | +| | | follows: "The internalHeaderFields datatype is | +| | | an undefined object which can contain | +| | | arbitrarily complex JSON structures. It is | +| | | intended to be defined separately by each | +| | | provider implementing the VES Event Listener. | +| | | The fields in internalHeaderFields are not | +| | | provided by any event source but instead are | +| | | added by the VES Event Listener service itself | +| | | as part of an event enrichment process necessary| +| | | for efficient internal processing of events | +| | | received by the VES Event Listener" | +| | | | +| | | - marker datatype: removed this datatype | +| | | | +| | | - measurementsForVfScalingFields datatype: | +| | | clarified that memoryConfigured and memoryUsed | +| | | are measured in MB | +| | | | +| | | - midCallRtcp datatype: removed this datatype | +| | | | +| | | - mobileFlowFields datatype: added | +| | | ‘additionalFields’ | +| | | | +| | | - mobileFlowFields datatype: incremented the | +| | | version number for this field block to 1.2 | +| | | | +| | | - serviceEventsFields datatype: removed this | +| | | datatype | +| | | | +| | | - signalingFields datatype: removed this datatype | +| | | | +| | | - syslogFields: added three fields to the schema | +| | | that were previously described in the document | +| | | but not incorporated into the schema: syslogPri,| +| | | syslogSev, syslogSdId | +| | | | +| | | - syslogFields version: incremented the version to| +| | | 2.0 | +| | | | +| | | - Modified the Common Event Format JSON schema to | +| | | v27.0 to incorporate the above changes. Also, added| +| | | the AT&T Copyright Notice from the top of the | +| | | retired CommonEventFormat\_Vendors schema. | +| | | | +| | | - Section 6 and 2: changed all sample requests to use| +| | | /v4 in the REST Resource URL and call flow diagrams| +| | | | +| | | - Section 6.1.3: added a row to the table in this | +| | | section describing the ‘heartbeatIntervalChange’ | +| | | command. | +| | | | +| | | - Section 6.1.4: added this new section describing | +| | | expectations for buffering of events should all | +| | | REST resource URL FQDNs be unreachable. | +| | | | +| | | - Section 6 Sample Requests: modified all sample | +| | | requests showing the return of a commandList toward| +| | | the event source to incorporate a | +| | | heartbeatIntervalChange command; also corrected the| +| | | spelling in the samples for the | +| | | measurementIntervalChange command. | +| | | | +| | | - Section 7: Contributors: removed this section | ++-----------+---------+-------------------------------------------------------+ +| 3/21/2017 | v4.1 | - JSON Schema changes to produce v27.2 (note: an | +| | | earlier draft version of v27.1 had been distributed| +| | | to a few individuals): | +| | | | +| | | - To support use of the schema with event batches,| +| | | removed the following statement near the end of | +| | | the schema file: | +| | | | +| | | “required”: [ “event” ] | +| | | | +| | | - Fixed the characters used in some of the quotes | +| | | | +| | | - Fixed some typos in the descriptions. | +| | | | +| | | - Removed the booleans, which were non-essential and | +| | | which were causing problems across different | +| | | implementations. | +| | | | +| | | - Section 4.5.7 measurementsForVfScalingFields: | +| | | | +| | | - Fixed the spelling of measurementsForVf\ | +| | | ScalingFields in the Word document | +| | | | +| | | - Section 2 and 6 sample requests and responses: | +| | | | +| | | - Removed quotes from numbers: sequence, and | +| | | first/lastEpochMicrosec. | +| | | | +| | | - Fixed all quote characters, some of which were | +| | | using unusual symbols that wouldn’t validate | +| | | with the json-schema Python package. | +| | | | +| | | - Section 6.2.6.1, 6.3.6.1, 6.4.6.1 sample requests: | +| | | | +| | | - Added an alarmAdditionalInformation field array | +| | | to the sample requests. | +| | | | +| | | - Added missing commas. | +| | | | +| | | - Section 6.5.6.1 provideThrottlingState sample | +| | | requests: | +| | | | +| | | - Fixed the eventDomainThrottleSpecificationList | +| | | to pass an array of anonymous eventDomain\ | +| | | ThrottleSpecification objects. | +| | | | +| | | - Added missing quotes. | +| | | | +| | | - Fixed the suppressedNvPairsList to pass an array of| +| | | anonymous suppressedNvPairs objects. | ++-----------+---------+-------------------------------------------------------+ +| 4/14/2017 | v5.0 | - Section 1 Introduction: | +| | | | +| | | - Clarified the Introduction (Section 1). | +| | | | +| | | - Changed Section 1.1 title from ‘Terminology’ to | +| | | 'Event Registration' and referenced the YAML | +| | | event registration format, defined in a separate| +| | | document. | +| | | | +| | | - Clarified naming standards for eventName. | +| | | | +| | | - Section 3: updated the REST resource structure | +| | | | +| | | - Section 4.1 command list processing datatypes: | +| | | | +| | | - Got rid of commandListEntry and returned | +| | | commandList to a simple array of commands. | +| | | | +| | | - Added heartbeatInterval to the command datatype.| +| | | | +| | | - Changed the datatype of measurementInterval from| +| | | number to integer. | +| | | | +| | | - Section 4.2 common event datatypes: | +| | | | +| | | - event dataType: Added heartbeatFields, | +| | | sipSignalingFields and voiceQualityFields to the| +| | | event datatype as optional field blocks | +| | | | +| | | - Added jsonObject which provides a json object | +| | | schema, name and other meta-information along | +| | | with one or more object instances. | +| | | | +| | | - Added jsonObjectInstance which provides | +| | | meta-information about an instance of a | +| | | jsonObject along with the actual object instance| +| | | | +| | | - Added the ‘key’ datatype | +| | | | +| | | - Added the namedArrayOfFields datatype | +| | | | +| | | - Added vendorVnfNameFields | +| | | | +| | | - Section 4.3 common event header fields: | +| | | | +| | | - Add two new enumerations to domain: | +| | | ‘sipSignaling’ and ‘voiceQuality’ | +| | | | +| | | - Renamed eventType to eventName. Note that the | +| | | original usage of eventType was formally | +| | | described in the Introduction back on 2/11/2016 | +| | | with v1.9. | +| | | | +| | | - Made eventName a required field | +| | | | +| | | - Created a new field called eventType with a | +| | | meaning that is different than the old eventType| +| | | | +| | | - Removed functionalRole, which was replaced by | +| | | the following two fields. | +| | | | +| | | - Added nfNamingCode | +| | | | +| | | - Added nfcNamingCode | +| | | | +| | | - Changed version to 3.0 (major version change) | +| | | and made it a required field | +| | | | +| | | - Section 4.4: faultFields: | +| | | | +| | | - added one optional field: eventCategory | +| | | | +| | | - made faultFieldsVersion a required field | +| | | | +| | | - changed faultFieldsVersion to 2.0 (major version| +| | | change) | +| | | | +| | | - fixed a typo on the spelling of alarmInterfaceA | +| | | | +| | | - clarified field descriptions | +| | | | +| | | - Section 4.5: added heartbeatFields datatype which | +| | | can be used to communicate heartbeatInterval. Note:| +| | | this change was previously made in v4.2 | +| | | | +| | | - Section 4.6 measurements for vf scaling datatypes: | +| | | changed the following datatypes from number to | +| | | integer: | +| | | | +| | | - In measurementsForVfScalingFields: | +| | | concurrentSessions, configuredEntities, | +| | | numberOfMediaPortsInUse, vnfcScalingMetric | +| | | | +| | | - In codecsInUse: numberInUse | +| | | | +| | | - In featuresInUse: featureUtilization | +| | | | +| | | - Section 4.6.2 modified cpuUsage | +| | | | +| | | - Section 4.6.3 added diskUsage | +| | | | +| | | - Section 4.6.7 measurementsForVfScalingFields: | +| | | | +| | | - fixed the spelling of the measurementsForVf\ | +| | | ScalingFields in the Word document | +| | | | +| | | - added additionalFields, which is an array of | +| | | fields (i.e., name-value pairs) | +| | | | +| | | - changed additionalMeasurements to reference the | +| | | common datatype namedArrayOfFields (instead of | +| | | referencing measurementGroup) | +| | | | +| | | - added additionalObjects which is an array of | +| | | jsonObjects described by name, keys and schema | +| | | | +| | | - deleted aggregateCpuUsage | +| | | | +| | | - added diskUsageArray | +| | | | +| | | - deleted measurementGroup (which was replaced by | +| | | the common datatype: namedArrayOfFields | +| | | | +| | | - added memoryUsageArray | +| | | | +| | | - deleted memoryConfigured and memoryUsed | +| | | | +| | | - deleted errors and vNicUsageArray | +| | | | +| | | - added vNicPerformanceArray | +| | | | +| | | - changed the measurementsForVfScalingVersion to | +| | | 2.0 (major version change) and made it a | +| | | required field. Also changed the name of this | +| | | version field in the Word document to match that| +| | | in the JSON schema. | +| | | | +| | | - Section 4.6.8 added memoryUsage | +| | | | +| | | - Section 4.6.9 vNicPerformance: replaced vNicUsage | +| | | and errors with vNicPerformance | +| | | | +| | | - Section 4.7 mobile flow fields changes: | +| | | | +| | | - Made mobileFlowFieldsVersion a required field | +| | | and changed the mobileFlowFieldsVersion to 2.0 | +| | | (major version change). | +| | | | +| | | - Changed the datatype of flowActivationTime and | +| | | flowDeactivationTime in the Word doc to string. | +| | | | +| | | - changed the following datatypes from number to | +| | | integer: otherEndpointPort, | +| | | reportingEndpointPort, samplingAlgorithm | +| | | | +| | | - Section 4.8: otherFields: | +| | | | +| | | - Added otherFieldsVersion (set at 1.1) | +| | | | +| | | - Added hashOfNameValuePairArrays | +| | | | +| | | - Added jsonObjects | +| | | | +| | | - Added nameValuePairs | +| | | | +| | | - Section 4.9: added sipSignaling domain datatypes | +| | | with 4.8.1 sipSignalingFields. sipSignalingFields\ | +| | | Version is set at 1.0 | +| | | | +| | | - Section 4.10 stateChangeFields: made stateChange\ | +| | | FieldsVersion a required field and set it to 2.0 | +| | | (major version change). | +| | | | +| | | - Section 4.11 syslogFields: | +| | | | +| | | - Changed the following datatypes from number to | +| | | integer: syslogFacility, syslogPri | +| | | | +| | | - Changed additionalFields from a field [ ] to a | +| | | string which takes name=value pairs delimited by| +| | | a pipe symbol. | +| | | | +| | | - Changed syslogFieldsVersion to 3.0 (major | +| | | version change) and made it a required field | +| | | | +| | | - Made syslogSev an enumerated string (previously | +| | | just a string) | +| | | | +| | | - Section 4.12 thresholdCrossingAlertFields: made | +| | | thresholdCrossingFieldsVersion a required field and| +| | | set it to 2.0 (major version change). | +| | | | +| | | - Section 4.132: added voice quality domain datatypes| +| | | with 4.13.1 endOfCallVqmSummaries and 4.13.2 | +| | | voiceQualityFields. voiceQualityFieldsVersion is | +| | | set at 1.0 | +| | | | +| | | - JSON Schema: changed the schema to v28.0 and | +| | | incorporated all of the changes above. | +| | | | +| | | - Additional JSON Schema changes that are part of | +| | | v28: Note: The following changes are provided | +| | | relative to API Spec v4.0 (which embedded JSON | +| | | schema v27.0), but they were also made in an | +| | | interim release v4.1 (which embedded JSON schema | +| | | v27.2): | +| | | | +| | | - To support use of the schema with event batches,| +| | | removed the following statement near the end of | +| | | the schema file: | +| | | | +| | | “required”: [ “event” ] | +| | | | +| | | - Fixed the characters used in some of the quotes | +| | | | +| | | - Fixed some typos in the descriptions. | +| | | | +| | | - Removed the booleans, which were non-essential and | +| | | which were causing problems across different | +| | | implementations. | +| | | | +| | | - Section 2 and 6 sample requests and responses (also| +| | | incorporated in interim release 4.1): | +| | | | +| | | - Removed quotes from numbers: sequence, and | +| | | first/lastEpochMicrosec. | +| | | | +| | | - Fixed all quote characters, some of which were | +| | | using unusual symbols that wouldn’t validate | +| | | with the json-schema Python package. | +| | | | +| | | - Section 2 and 6 sample requests and responses (only| +| | | in v5.0): | +| | | | +| | | - Changed the version numbers in the URL string. | +| | | | +| | | - Added nfNamingCode and nfcNamingCode and removed| +| | | functionalRole | +| | | | +| | | - Section 6 call flows: updated the version number | +| | | (only in v5.0). | +| | | | +| | | - Section 6: removed the publishSpecificTopic | +| | | operation | +| | | | +| | | - Section 6.1.4: Buffering: clarified event source | +| | | expectations for buffering (only in v5.0). | +| | | | +| | | - Section 6.2.6.1, 6.3.6.1 sample requests (also | +| | | incorporated in interim release 4.1): | +| | | | +| | | - Added an alarmAdditionalInformation field array | +| | | to the sample requests. | +| | | | +| | | - Added missing commas. | +| | | | +| | | - Section 6.2.6.3, 6.3.6.3 commandList sample | +| | | responses (only in v5.0): | +| | | | +| | | - Fixed the commandList sample responses to pass | +| | | an array of anonymous command objects (rather | +| | | than an array of commandListEntry objects). | +| | | | +| | | - Fixed the heartbeatIntervalChange commandType to| +| | | pass a heartbeatInterval value instead of a | +| | | measurementInterval value. | +| | | | +| | | - Removed quotes from the measurementInterval and | +| | | heartbeatInterval values since they are numbers.| +| | | | +| | | - Section 6.4.6.1 provideThrottlingState sample | +| | | requests(also incorporated in interim release 4.1):| +| | | | +| | | - Fixed the eventDomainThrottleSpecificationList | +| | | to pass an array of anonymous | +| | | eventDomainThrottleSpecification objects. | +| | | | +| | | - Added missing quotes. | +| | | | +| | | - Fixed the suppressedNvPairsList to pass an array| +| | | of anonymous suppressedNvPairs objects (also | +| | | incorporated in interim release 4.1). | ++-----------+---------+-------------------------------------------------------+ +| 5/22/2017 | v5.1 | - Footers: removed proprietary markings and updated | +| | | copyrights to 2017 | +| | | | +| | | - Section 4.2.3: field: | +| | | | +| | | - Changed the API spec to make ‘name’ and ‘value’ | +| | | start with lowercase letters. Note: this did not| +| | | affect the schema, which already had them as | +| | | lowercase. | +| | | | +| | | - JSON Schema: | +| | | | +| | | - measurementGroup: deleted this object since it | +| | | was replaced with ‘namedArrayOfFields’ in v28.0 | +| | | and was no longer being used. | +| | | | +| | | - namedArrayOfFields: Fixed an error in the | +| | | specification of required fields: from | +| | | ‘measurements’ to ‘arrayOfFields’. | +| | | | +| | | - Changed the version of the JSON schema to 28.1 | ++-----------+---------+-------------------------------------------------------+ +| 6/14/2017 | v5.2 | - JSON Schema: created v28.2 by changing the field | +| | | descriptions in the memoryUsage object to refer to | +| | | ‘kibibytes’ instead of ‘kilobytes’. There were no | +| | | changes to the 28.1 structure. | +| | | | +| | | - Word Document: measurementsForVfScaling Domain: | +| | | memoryUsage object: changed the field descriptions | +| | | in this object to refer to ‘kibibytes’ instead of | +| | | ‘kilobytes’. There were no changes to the | +| | | memoryUsage structure. | +| | | | +| | | - Reorganized the Word document to group the data | +| | | structures in Section 4 into three broad categories| +| | | to better align with the VNF Guidelines | +| | | documentation that has been prepared for vendors: | +| | | | +| | | - Common Event Datatypes: | +| | | | +| | | - Command List Processing Datatypes | +| | | | +| | | - Common Event Datatypes | +| | | | +| | | - Common Event Header Datatypes | +| | | | +| | | - Technology Independent Datatypes: | +| | | | +| | | - ‘Fault Domain Datatypes | +| | | | +| | | - ‘Heartbeat’ Domain Datatypes | +| | | | +| | | - ‘Measurements For Vf Scaling’ Domain Datatypes| +| | | | +| | | - ‘Other’ Domain Datatypes | +| | | | +| | | - ‘State Change’ Domain Datatypes | +| | | | +| | | - ‘Syslog’ Domain Datatypes | +| | | | +| | | - ‘Threshold Crossing Alert’ Domain Datatypes | +| | | | +| | | - Technology Specify Datatypes: | +| | | | +| | | - ‘Mobile Flow’ Domain Datatypes | +| | | | +| | | - ‘Sip Signaling’ Domain Datatypes | +| | | | +| | | - ‘Voice Quality’ Domain Datatypes | +| | | | +| | | - Section 6.1.3: Commands Toward Event Source | +| | | Clients: Added a statement: “Note: Vendors are not | +| | | currently required to implement support for command| +| | | processing; in addition, command processing may be | +| | | supported by an App-C interface in future.” | ++-----------+---------+-------------------------------------------------------+ +| 6/22/2017 | v5.3 | - JSON Schema: created v28.3 by correcting an error | +| | | in the sipSignalingFields: changed | +| | | vnfVendorNameFields to vendorVnfNameFields. | +| | | Embedded the new schema at the top of section 4. | ++-----------+---------+-------------------------------------------------------+ +| 9/12/2017 | v5.4 | - Note: There no changes to any data structures or | +| | | operations in this version. | +| | | | +| | | - JSON Schema: created v28.4 embedded at the top of | +| | | section 4: | +| | | | +| | | - Added a reference to eventList in the properties| +| | | defined under the schema title. This enables the| +| | | schema to correctly validate event batches in | +| | | addition to just events. | +| | | | +| | | - Moved the schema title to the top of the schema | +| | | and changed the text from “Event Listener” to | +| | | “VES Event Listener” | +| | | | +| | | - Added a schema header block under the title to | +| | | clearly communicate the schema version, | +| | | associated API and last-modified information | +| | | | +| | | - Changed the date in the copyright notice to 2017 | ++-----------+---------+-------------------------------------------------------+ +| 9/19/2017 | v5.4.1 | - Note: There no changes to any data structures or | +| | | operations in this version. | +| | | | +| | | - Back of Cover Page: updated the license and | +| | | copyright notice to comply with ONAP guidelines | +| | | | +| | | - JSON Schema: updated the JSON schema to v28.4.1: | +| | | updated the copyright notice and license to comply | +| | | with ONAP guidelines | ++-----------+---------+-------------------------------------------------------+ +| 6/28/2018 | v6.0 | - Added contributors to the title page. | +| | | | +| | | - Updated references to ‘vnf’ ‘vnfc’ to either ‘nf’ | +| | | and ‘nfc’ or ‘xNf’ and ‘xNfc’ to generalize support| +| | | across both vnfs and pnfs. | +| | | | +| | | - Section 1: | +| | | | +| | | - clarified the meaning of the VES acronym | +| | | | +| | | - changed references from ASDC to SDC and from MSO| +| | | to SO | +| | | | +| | | - clarified the requirements for eventNames. | +| | | | +| | | - Added a section of EventId use case examples | +| | | | +| | | - Added a new section on measurement expansion | +| | | fields | +| | | | +| | | - Added a new section of syslogs | +| | | | +| | | - clarified the versioning section and referenced | +| | | the new API Versioning section in section 6. | +| | | | +| | | - Added a list of all the latest field block | +| | | version numbers in this version of the API spec.| +| | | | +| | | - Section 2: updated the sample to show use of new | +| | | HTTP versioning headers. Added a note indicating | +| | | that support for mutual SSL would be provided in | +| | | future. | +| | | | +| | | - Section 3: updated the resource structure remove | +| | | the clientThrottlingState resource. | +| | | | +| | | - Section 4: hashMaps. Changed all name-value pair | +| | | structures to hashMaps causing the following data | +| | | model and JSON schema (to v29.0) changes: | +| | | | +| | | - 4.1.1: Common Event Datatypes: | +| | | | +| | | - removed "field" and added “hashMap” | +| | | | +| | | - removed “namedArrayOfFields” and added | +| | | “namedHashMap” | +| | | | +| | | - added arrayOfNamedHashMap | +| | | | +| | | - added arrayOfJsonObject | +| | | | +| | | - 4.2.1: Fault Domain Datatypes: | +| | | | +| | | - changed the faultFields version to 3.0 (major| +| | | change) | +| | | | +| | | - changed faultFields.alarmAdditional\ | +| | | Information to reference a hashMap | +| | | | +| | | - 4.2.2: Heartbeat Domain Datatypes: | +| | | | +| | | - changed the heartbeatFieldsVersion to 2.0 | +| | | (major change) | +| | | | +| | | - changed heartbeatFields.additionalFields to | +| | | reference a hashMap | +| | | | +| | | - 4.2.3: Measurement Domain Datatypes: | +| | | | +| | | - changed the measurementFieldsVersion to 3.0 | +| | | (major change) | +| | | | +| | | - changed measurementFields.additionalFields to| +| | | reference a hashMap | +| | | | +| | | - changed measurement.additionalMesurements to | +| | | reference a namedHashMap [ ] | +| | | | +| | | - modified measurementFields.featureUsageArray | +| | | to reference a hashmap and removed | +| | | ‘featuresInUse’ | +| | | | +| | | - added the following datatypes which are now | +| | | referenced as items in arrays within | +| | | measurementFields: hugePages, load, | +| | | machineCheckException, processStats | +| | | | +| | | - 4.2.5: Other Domain Datatypes: | +| | | | +| | | - Change the otherFieldsVersion to 2.0 (major | +| | | change) | +| | | | +| | | - changed otherFields.nameValuePairs to | +| | | reference a hashMap and renamed it hashMap | +| | | | +| | | - changed otherFields.hashOfNameValuePair\ | +| | | Arrrays to reference a namedHashMap and | +| | | renamed it arrayOfNamedHashMap | +| | | | +| | | - 4.2.7: State Change Domain Datatypes: | +| | | | +| | | - changed the stateChangeFiledsVersion to 3.0 | +| | | (major change) | +| | | | +| | | - changed stateChangeFields.additionalFields to| +| | | reference a hashMap | +| | | | +| | | - 4.2.9: Threshold Crossing Alert Domain | +| | | Datatypes: | +| | | | +| | | - changed the thresholdCrossingAlertFields\ | +| | | Version to 3.0 (major change) | +| | | | +| | | - changed thresholdCrossingAlert\ | +| | | Fields.additionalFields to reference a | +| | | hashMap | +| | | | +| | | - counter: removed name and value elements and | +| | | replaced with a hashMap | +| | | | +| | | - 4.3.1: Mobile Flow Domain Datatypes: | +| | | | +| | | - changed the mobileFlowFieldsVersion to 3.0 | +| | | (major change) | +| | | | +| | | - changed mobileFlowFields.additionalFields to | +| | | reference a hashMap | +| | | | +| | | - gtpPerFlowMetrics: modified ipTosCountList to| +| | | reference hashmap | +| | | | +| | | - gtpPerFlowMetrics: modified mobileQciCos\ | +| | | CountList to reference hashmap | +| | | | +| | | - gtpPerFlowMetrics: modified tcpFlagCountList | +| | | to reference hashmap | +| | | | +| | | - 4.3.2: Sip Signaling Domain Datatypes: | +| | | | +| | | - changed the sigSignalingFieldsVersion to 2.0 | +| | | (major change) | +| | | | +| | | - changed sipSignalingFields.additional\ | +| | | Information to reference a hashMap | +| | | | +| | | - 4.3.3: Voice Quality Domain Datatypes: | +| | | | +| | | - change the voiceQualityFieldsVersion to 2.0 | +| | | (major change) | +| | | | +| | | - changed voiceQualityFields.additional\ | +| | | Information to reference a hashMap | +| | | | +| | | - Section 4: added notes at the top of section 4 | +| | | clarifying expectations and requirements for | +| | | optional fields, extensible fields and keys sent | +| | | through extensible fields. | +| | | | +| | | - Common Event Data Types: Section 4.1.1.9 Changed | +| | | vendorVnfNameFields to vendorNfNameFields; updated | +| | | Section 4.3.2 SipSignaling and 4.3.3 Voice Quality | +| | | to refer to the renamed object | +| | | | +| | | - Common Event Header Section 4.1.2: | +| | | | +| | | - clarified the descriptions of eventId, | +| | | reportingEntityName, sourceName and | +| | | startEpochMicroseconds. | +| | | | +| | | - Added ‘notification’ and ‘pngRegistration’ to | +| | | the domain enumeration. | +| | | | +| | | - added a new timeZoneOffsest field | +| | | | +| | | - Fault Domain Section 4.2.1: clarified the | +| | | definitions of alarmCondition, eventSeverity and | +| | | specificProblem | +| | | | +| | | - Measurements Domain Section 4.2.3: changed the name| +| | | of this domain from ‘measurementsForVfScaling’ to | +| | | ‘measurement’ | +| | | | +| | | - measurementsForVfScaling measurement | +| | | | +| | | - measurementsForVfScalingFields measurementFields| +| | | | +| | | - measurementsForVfScalingVersion | +| | | measurementFieldsVersion | +| | | | +| | | - the ‘mfvs’ abbreviation measurement | +| | | | +| | | - Measurements Domain Section 4.2.3 cpuUsage: added | +| | | seven optional fields to this structure: | +| | | cpuCapacityContention, cpuDemandAvg, cpuDemandMhz, | +| | | cpuDemandPct, cpuLatencyAverage, cpuOverheadAvg, | +| | | cpuSwapWaitTime | +| | | | +| | | - Measurements Domain Section 4.2.3 diskUsage: added | +| | | ten optional fields to this structure: | +| | | diskBusResets, diskCommandsAborted, diskCommandsAvg| +| | | , diskFlushRequests, diskFlushTime, | +| | | diskReadCommandsAvg, diskTime, diskTotalRead\ | +| | | LatencyAvg, diskTotalWriteLatencyAvg, diskWrite\ | +| | | CommandsAvg | +| | | | +| | | - Measurements Domain Section 4.2.3: added a new | +| | | ‘ipmi’ datatype along with following ‘supporting’ | +| | | datatypes: ipmiBaseboardTemperature, ipmiBaseboard\| +| | | VoltageRegulator, ipmiBattery, ipmiFan, ipmiGlobal\| +| | | AggregateTemperatureMargin, ipmiHsbp, ipmiNic, | +| | | ipmiPowerSupply, ipmiProcessor, processorDimm\ | +| | | AggregateThermalMargin | +| | | | +| | | - Measurements Domain Section 4.2.3: added a new | +| | | ‘load’ datatype | +| | | | +| | | - Measurements Domain Section 4.2.3 memoryUsage: | +| | | added eight optional fields to this structure: | +| | | memoryDemand, memoryLatencyAvg, memorySharedAvg, | +| | | memorySwapInAvg, memorySwapInRateAvg, memorySwap\ | +| | | OutAvg, memorySwapOutRateAvg, memorySwapUsedAvg | +| | | | +| | | - Measurements Domain Section 4.2.3: modified | +| | | measurementFields to include the following new | +| | | fields: hugePagesArray, ipmi, loadArray, memory\ | +| | | Errors, processStatusArray, rdtArray | +| | | | +| | | - Measurements Domain Section 4.2.3 renamed vNic\ | +| | | Performance to nicPerformance and changed vNic\ | +| | | Identifer to nicIdentifier | +| | | | +| | | - Notification Domain Section 4.2.4: added | +| | | notificationFields to support a new notification | +| | | domain. | +| | | | +| | | - pnfRegistration Domain Section 4.2.7: added | +| | | pnfRegistrationFields to support a new registration| +| | | domain. | +| | | | +| | | - sysLog Domain Section 4.2.8: added two new fields: | +| | | syslogMsgHost and syslogTs. Clarified field | +| | | descriptions. Clarified syslogSData example. | +| | | | +| | | - endOfCallVqmSummaries Section 4.3.3.1: | +| | | | +| | | - converted endpointJitter into two fields: | +| | | endpointAverageJitter and endpointMaxJitter | +| | | | +| | | - converted localJitter into two fields: | +| | | localAverageJitter and localMaxJitter | +| | | | +| | | - added two fields: localAverageJitterBufferDelay | +| | | and localMaxJitterBufferDelay | +| | | | +| | | - added endpointRtpOctetsLost and | +| | | endpointRtpPacketsLost | +| | | | +| | | - added localRtpOctetsLost and localRtpPacketsLost| +| | | | +| | | - converted packetsLost into oneWayDelay | +| | | | +| | | - API Versioning: | +| | | | +| | | - Section 1.4: clarified the versioning section | +| | | and linked it to the following new section 6.1.2| +| | | | +| | | - Section 6.1.2: Added requirements for HTTP | +| | | headers communicating minor, patch and latest | +| | | version information. | +| | | | +| | | - Section 2 and 6 sample messages: clarified | +| | | examples to use the new HTTP headers | +| | | | +| | | - Section 6.1.4: Added a section specifying message | +| | | size limits. | +| | | | +| | | - Section2 6.2.6.1 and 6.3.6.1: corrected | +| | | additionalInformation examples to use hashMap | +| | | instead of name-value pair fields. | +| | | | +| | | - Section 7: Added a section on Terminology. | +| | | | +| | | - Command List Processing: removed command list | +| | | processing from the document and schema: | +| | | | +| | | - Modified the Section 3 resource structure to | +| | | align with these changes. | +| | | | +| | | - Removed Section 4 Datatypes: command, | +| | | commandList, eventDomainThrottleSpecification, | +| | | eventDomainThrottleSpecificationList, | +| | | eventThrottlingState, suppressedNvPairs | +| | | | +| | | - Removed Section 6.1 description of commands | +| | | toward event source clients | +| | | | +| | | - Removed Section 6.4 operation: | +| | | provideThrottlingState | ++-----------+---------+-------------------------------------------------------+ +| 7/30/2018 | v7.0 | - General: | +| | | | +| | | - Fixed typos throughout | +| | | | +| | | - Changed example versions to v7 | +| | | | +| | | - Section1: | +| | | | +| | | - Clarified casing and use of dashes versus colons| +| | | in eventName examples | +| | | | +| | | - Updated all field block versions | +| | | | +| | | - Section 2: added a note clarifying that TLS 1.2 or | +| | | higher must be used for HTTPS connections. | +| | | | +| | | - Section 4 embedded schema changed to v30: | +| | | | +| | | - Added “ ‘additionalProperties’: false ” to | +| | | objects to reject events that attempt to send | +| | | properties that are not listed in the | +| | | ‘properties’ keyword. Note: does not affect | +| | | hashmap extensible fields. | +| | | | +| | | - Changed all versions in all field blocks from | +| | | number to string enum with the version number | +| | | fixed by the enum so the schema can validate | +| | | events that attempt to send non-standard field | +| | | blocks. | +| | | | +| | | - Changed syslog additionalFields to a hashMap | +| | | | +| | | - Section 4: | +| | | | +| | | - Fixed section heading numbers that were the same| +| | | | +| | | - 4.1.1: jsonObjectInstance: added an optional | +| | | recursive jsonObject and removed all required | +| | | fields from this object | +| | | | +| | | - 4.1.2: commonEventHeader: | +| | | | +| | | - nfVendorName: added this optional field | +| | | | +| | | - timeZoneOffset: changed from number to string| +| | | with a particular format specified | +| | | | +| | | - version was changed from number to string (as| +| | | were all the version fields of all the field | +| | | blocks) | +| | | | +| | | - vesCommonEventListenerVersion: added this | +| | | required field as a string enumeration | +| | | | +| | | - 4.2.3: Measurements Domain: | +| | | | +| | | - Added a note clarifying that NFs are required| +| | | to report exactly one Measurement event per | +| | | period per sourceName | +| | | | +| | | - diskUsage: added four new optional fields: | +| | | diskWeightedIoTimeAve, diskWeightedIoTimeLast| +| | | , diskWeightedIoTimeMax, | +| | | diskWeightedIoTimeMin | +| | | | +| | | - memoryUsage: add one new optional field: | +| | | percentMemoryUsage | +| | | | +| | | - nicPerformance: added nine new optional | +| | | fields: administrativeState, operationalState| +| | | , receivedPercentDiscard, | +| | | receivedPercentError, receivedUtilization, | +| | | speed, transmittedPercentDiscard, | +| | | transmittedPercentError, | +| | | transmittedUtilization | +| | | | +| | | - processorDimmAggregateThermalMargin: make the| +| | | thermalMargin field required | +| | | | +| | | - 4.2.8: Syslog Domain: | +| | | | +| | | - Corrected the example at the end of the section | ++-----------+---------+-------------------------------------------------------+ +| 7/31/2018 | v7.0.1 | - Section 4: The schema embedded at the top of | +| | | section 4 was patched to correct a header field | +| | | name error—the schema version moves from 30 to | +| | | 30.0.1: | +| | | | +| | | - Changed commonEventHeader field: ‘vesCommon\ | +| | | EventFormatVersion’ field to ‘vesEventListener\ | +| | | Version’ and set the enum to 7.0.1 | +| | | | +| | | - Also changed the commonEventHeader ‘required’ | +| | | array to reflect use the corrected field name: | +| | | ‘vesEventListenerVersion’ | +| | | | +| | | - Changed the commonEventHeader ‘version’ field | +| | | enumeration to 4.0.1 | +| | | | +| | | - Section1: | +| | | | +| | | - Changed the field block versions for the common | +| | | header for ‘vesEventListenerVersion’ (to 7.0.1) | +| | | and ‘version’ (to 4.0.1). | +| | | | +| | | - Sections 2 and 6: | +| | | | +| | | - Changed the commonEventHeader version fields | +| | | above, in the sample message requests and | +| | | responses; also updated the faultFieldsVersion | +| | | to 4.0 | +| | | | +| | | - Section 6.1.2: Changed the X-LatestVersion to 7.0.1| +| | | and the X-PatchVersion to 1 | ++-----------+---------+-------------------------------------------------------+ +| 12/10/2018| v7.1 | - Section 1.2: Added Notification domain Perf3gpp | +| | | domain and changed a reference from ‘measurements | +| | | domain’ to ‘measurement domain’. | +| | | | +| | | - Section 1.7.1: Field Block Versions: added | +| | | ‘perf3gppFields’ version at 1.0 and changed the | +| | | following version enumerations so that existing | +| | | clients of major version 7 would not be broken by | +| | | this VES minor version change, in accordance with | +| | | semantic versioning definitions: | +| | | | +| | | - commonEventHeader: changed to | +| | | ‘vesEventListenerVersion’ enum to accept either | +| | | 7.0 or 7.0.1 or 7.1. | +| | | | +| | | - commonEventHeader: changed ‘version’ enum to | +| | | accept either 4.0 or 4.0.1 or 4.1 | +| | | | +| | | - Section 2: | +| | | | +| | | - changed sample request and responses to | +| | | reference 7.1 instead of 7.0.1 (and version 4.1 | +| | | of the commonEventHeader version, instead of | +| | | v4.0.1) | +| | | | +| | | - added a sub section on service provider support | +| | | for mutual ssl certificate authentication | +| | | | +| | | - Section 4.1.2.1: | +| | | | +| | | - CommonEventHeader timeZoneOffset changed | +| | | description from ‘UTC+/-hh.mm’ to ‘UTC+/-hh:mm’ | +| | | | +| | | - Added ‘perf3gpp’ to the domain enumeration | +| | | | +| | | - Section 4.2.3: Measurement Domain Datatypes: | +| | | | +| | | - In ‘MeasurementFields’: Changed ‘ipmiArray’ to | +| | | ‘ipmi’ and made the type ‘object’ | +| | | | +| | | - ‘ipmiProcessor’: changed | +| | | ‘pprocessorThermalControl’ to | +| | | ‘processorThermalControl’ | +| | | | +| | | - ‘machineCheckException’: changed | +| | | ‘processIdentifier’ to ‘vmIdentifier’ | +| | | | +| | | - Section 4.2.6: added the perf3gpp domain | +| | | | +| | | - Section 4 embedded schema: | +| | | | +| | | - Changed the schema version from 30.0.1 to 30.1 | +| | | as a result of the changes below: | +| | | | +| | | - commonEventHeader: changed to | +| | | ‘vesEventListenerVersion’ enum to accept either | +| | | 7.0, 7.0.1 or 7.1 | +| | | | +| | | - commonEventHeader: changed the ‘version’ field | +| | | enumeration to accept either 4.0, 4.0.1 or 4.1 | +| | | | +| | | - commonEventHeader: changed the ‘domain’ | +| | | enumeration to add support for the perf3gpp | +| | | domain. | +| | | | +| | | - ‘event’: added a reference to ‘perf3gppFields’ | +| | | | +| | | - ‘hugePages’: changed the type of | +| | | hugePagesIdentifier from number to string | +| | | | +| | | - ‘ipmiGlobalAggregateTemperatureMargin’: changed | +| | | ‘pmiGlobalAggregateTemperatureMarginIdentifier’ | +| | | to ‘globalAggregateTemperatureMarginIdentifier’ | +| | | | +| | | - ‘perf3gppFields’: added this object | +| | | | +| | | - Section 6: changed references throughout from | +| | | v7.0.1 to v7.1 and v4.0.1 (of the commonEventHeader| +| | | version) to v4.1 | +| | | | +| | | - Changed the location of the doc to VNF | +| | | Requirements and changed the formatting | ++-----------+---------+-------------------------------------------------------+ + +.. _time_zone_abbreviations: https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations +.. _Common_definitions: http://technical.openmobilealliance.org/Technical/release_program/docs/REST_NetAPI_Common/V1_0-20120417-C/OMA-TS-REST_NetAPI_Common-V1_0-20120417-C.pdf
\ No newline at end of file |