Kmohr-soprasteria/issue309

README.md

@@ -22,6 +22,12 @@ Internal data structure of prepared performance data follows ONF information mod
 
 ## Latest Update
 
+### v1.1.1
+
+This release adds changes for bugs, findings and still outstanding items observed during implementation of v1.0.0 and v1.1.0. 
+
+Details on changes are found in [DPMDP v1.1.1_spec](https://github.com/openBackhaul/DevicePerformanceManagementDataProcessor/milestone/8). 
+
 ### v1.1.0
 
 This release adds new functionality and changes inner workings of DPMDP. 

spec/DevicePerformanceManagementDataProcessor+config.json

@@ -1754,7 +1754,7 @@
  "profile-name": "function-profile-1-0:PROFILE_NAME_TYPE_FUNCTION_PROFILE",
  "function-profile-1-0:function-profile-pac": {
  "function-profile-capability": {
- "function-name": "p1CalculateUtilization",
+ "function-name": "p2CalculateUtilization",
  "function-description": "Calculates utilization of the aggregated physical resources in a performance data slice",
  "parameter-list": [],
  "sub-function-list": []

spec/DevicePerformanceManagementDataProcessor+profileInstances.yaml

@@ -1100,11 +1100,11 @@ profile-instances:
  string-value: '-1'
 
 
- # p1CalculateUtilization
+ # p2CalculateUtilization
  - profile-name: 'FunctionProfile'
  uuid: 'dpmdp-1-1-0-function-p-500'
  capability:
- function-name: 'p1CalculateUtilization'
+ function-name: 'p2CalculateUtilization'
  function-description: 'Calculates utilization of the aggregated physical resources in a performance data slice'
  parameter-list:
  sub-function-list:

spec/Functions/p1StreamPmData/p1ProcessDevice/p1CreateResultCc/1.0.0/interface.yaml

@@ -373,7 +373,6 @@ x-javascript-interface:
  required:
  - parameters
  - historical-performance-data-list
- - aggregation-group
  - result-cc
  properties:
  parameters:

spec/Functions/p1StreamPmData/p1ProcessDevice/p1CreateResultCc/p1IterateEcPmSlices/1.0.0/interface.yaml

@@ -15,7 +15,6 @@ x-javascript-interface:
  required:
  - parameters
  - historical-performance-data-list
- - aggregation-group
  - result-cc
  properties:
  parameters:
@@ -165,7 +164,6 @@ x-javascript-interface:
  type: object
  required:
  - historical-performance-data
- - aggregation-group
  - result-cc
  properties:
  historical-performance-data:

spec/Functions/p1StreamPmData/p1ProcessDevice/p1CreateResultCc/p1IterateEcPmSlices/1.0.0/variables.yaml

@@ -3,7 +3,6 @@ iterate-ec-pm-slices:
  required:
  - parameters
  - historical-performance-data-list
- - aggregation-group
  - result-cc
  properties:
  parameters:

spec/Functions/p2StreamPmData/p2ProcessDevice/p2CreateResultCc/p2IterateEcPmSlices/p1CalculateUtilization/1.0.0/README.md → spec/Functions/p1StreamPmData/p1ProcessDevice/p1CreateResultCc/p1IterateEcPmSlices/p1CalculateUtilization/1.0.0/README.md

@@ -1,24 +1,27 @@
-# p1CalculateUtilization
-
-Calculates the utilization of the aggregated physical TX resources in a performance data slice. 
-
-Sums up the interval capacity of all AirInterfaces in the aggregation group that is transporting the EthernetContainer. 
-Divides the totalBytesOutput by the aggregated interval capacity to get the utilization in %. 
-
-## Diagram
-
-<p align="center">
- <img src="./p1CalculateUtilization.png" alt="p1CalculateUtilization" width="400"/>
-</p>
-
-## Interface
-
-Please find a detailed description of the [interface](./interface.yaml). 
-
-## Variables
-
-Please find a detailed description of the [variables](./variables.yaml). 
-
-## NPM Module
-
-[mw-sdn-p1-calculate-utilization](https://www.npmjs.com/package/mw-sdn-p1-calculate-utilization)
+# p1CalculateUtilization
+
+Calculates the utilization of the aggregated physical TX resources in a performance data slice. 
+
+Sums up the interval capacity of all AirInterfaces in the aggregation group that is transporting the EthernetContainer. 
+Divides the totalBytesOutput by the aggregated interval capacity to get the utilization in %. 
+
+### Diagram
+
+<p align="center">
+ <img src="./p1CalculateUtilization.png" alt="p1CalculateUtilization" width="400"/>
+</p>
+
+
+### Interface
+
+Please find a detailed description of the [interface](./interface.yaml).
+
+
+### Variables
+
+Please find a detailed description of the [variables](./variables.yaml).
+
+
+### NPM Module 
+
+[mw-sdn-p1-calculate-utilization](https://www.npmjs.com/package/mw-sdn-p1-calculate-utilization)

spec/Functions/p1StreamPmData/p1ProcessDevice/p1CreateResultCc/p1IterateEcPmSlices/p1CalculateUtilization/1.0.0/interface.yaml

@@ -0,0 +1,177 @@
+openapi: 3.0.0
+info:
+ title: p1CalculateUtilization
+ version: 1.0.0
+
+x-javascript-interface:
+ p1CalculateUtilization:
+ summary: 'Calculates utilization of the aggregated physical resources in a performance data slice'
+ input:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ required:
+ - historical-performance-data
+ - result-cc
+ properties:
+ historical-performance-data:
+ type: object
+ description: >
+ 'historicalPerformanceData set'
+ aggregation-group:
+ type: object
+ description: >
+ 'aggregationGroup'
+ result-cc:
+ type: object
+ description: >
+ 'resultCc'
+ output:
+ success:
+ description: 'Utilization added'
+ content:
+ application/json:
+ schema:
+ type: object
+ required:
+ - historical-performance-data
+ properties:
+ historical-performance-data:
+ type: object
+ description: >
+ 'historicalPerformanceData
+ from [/calculate-utilization/historical-performance-data]'
+ error:
+ description: 'Utilization could not be added'
+ content:
+ application/json:
+ schema:
+ type: string
+ enum:
+ - 'historicalPerformanceData not provided'
+ - 'historicalPerformanceData invalid'
+ - 'aggregationGroup invalid'
+ - 'result-cc not provided'
+ - 'result-cc invalid'
+ - 'Utilization could not be added'
+ - 'General processing error'
+ processing:
+ calculateTotalAirInterfaceIntervalCapacity:
+ summary: 'Aggregates the interval capacity of all transporting AirInterfaces'
+ input:
+ required: true
+ content:
+ application/json:
+ schema:
+ required:
+ - logical-termination-point
+ - physical-server-ltp-list
+ - period-end-time
+ properties:
+ logical-termination-point:
+ type: array
+ description: >
+ 'logicalTerminationPoint list
+ from [/calculate-utilization/result-cc/logical-termination-point]'
+ physical-server-ltp-list:
+ type: array
+ description: >
+ 'List of UUIDs of transporting PhysicalServerLTPs
+ from [/calculate-utilization/aggregation-group/physical-server-ltp-list]'
+ period-end-time:
+ type: string
+ description: >
+ 'Period end time of the performance data slice
+ from [/calculate-utilization/historical-performance-data/period-end-time]'
+ output:
+ success:
+ description: 'totalAirInterfaceIntervalCapacity provided'
+ content:
+ application/json:
+ schema:
+ properties:
+ type: object
+ properties:
+ total-air-interface-interval-capacity:
+ type: integer
+ description: >
+ 'Sum of the intervalCapacity of all AirInterfaces in the aggregation group that is transporting this EthernetContainer in kbps
+ from [sum of all {[/logical-termination-point={physical-server-ltp-list[*]}/layer-protocol=*/air-interface-2-0:air-interface-pac/air-interface-historical-performances/historical-performance-data-list={$input.period-end-time}/performance-data/interval-capacity}]
+ with {[/logical-termination-point={physical-server-ltp-list[*]}/layer-protocol=*/air-interface-2-0:air-interface-pac/air-interface-historical-performances/historical-performance-data-list={$input.period-end-time}/granularity-period]}==air-interface-2-0:GRANULARITY_PERIOD_TYPE_PERIOD-15-MIN'
+ error:
+ description: 'totalAirInterfaceIntervalCapacity could not be provided'
+ content:
+ application/json:
+ schema:
+ type: string
+ enum:
+ - 'logicalTerminationPoint list not provided'
+ - 'logicalTerminationPoint list invalid'
+ - 'physicalServerLtpList not provided'
+ - 'physicalServerLtpList invalid'
+ - 'periodEndTime not provided'
+ - 'periodEndTime invalid'
+ - 'totalAirInterfaceIntervalCapacity could not be provided'
+ - 'General processing error'
+ calculateUtilization:
+ summary: 'Calculates the utilization'
+ input:
+ required: true
+ content:
+ application/json:
+ schema:
+ required:
+ - total-bytes-output
+ - total-air-interface-interval-capacity
+ - time-period
+ properties:
+ total-bytes-output:
+ type: string
+ description: >
+ 'totalBytesOutput
+ from [/calculate-utilization/historical-performance-data/performance-data/total-bytes-output]'
+ total-air-interface-interval-capacity:
+ type: integer
+ description: >
+ 'totalAirInterfaceIntervalCapacity
+ from [/calculate-utilization/historical-performance-data/performance-data/total-air-interface-interval-capacity]'
+ time-period:
+ type: integer
+ description: >
+ 'Length of the measurement interval in seconds
+ from [/calculate-utilization/historical-performance-data/performance-data/time-period]'
+ output:
+ success:
+ description: 'utilization provided'
+ content:
+ application/json:
+ schema:
+ properties:
+ type: object
+ properties:
+ utilization:
+ type: integer
+ description: >
+ 'Interval utilization in %
+ from [ {total-bytes-output}*8 / ( {total-air-interface-interval-capacity}*1000 * {time-period} ) ]'
+ error:
+ description: 'utilization could not be provided'
+ content:
+ application/json:
+ schema:
+ type: string
+ enum:
+ - 'totalBytesOutput not provided'
+ - 'totalBytesOutput invalid'
+ - 'totalAirInterfaceIntervalCapacity not provided'
+ - 'totalAirInterfaceIntervalCapacity invalid'
+ - 'timePeriod not provided'
+ - 'timePeriod invalid'
+ - 'utilization could not be provided'
+ - 'General processing error'
+
+paths:
+ /:
+ description: 'no rest path provided by this module'

spec/Functions/p2StreamPmData/p2ProcessDevice/p2CreateResultCc/p2IterateEcPmSlices/p1CalculateUtilization/1.0.0/p1CalculateUtilization.plantuml → spec/Functions/p1StreamPmData/p1ProcessDevice/p1CreateResultCc/p1IterateEcPmSlices/p1CalculateUtilization/1.0.0/p1CalculateUtilization.plantuml

@@ -1,49 +1,43 @@
-@startuml p1CalculateUtilization
-skinparam responseMessageBelowArrow true
-
-title
- p1CalculateUtilization
-end title
-
-participant "p2IterateEcPmSlices\n" as requestor
-participant "p1CalculateUtilization\n" as p1CalcUtil
-
-
-requestor -> p1CalcUtil : { {historical-performance-data},\n{aggregation-group},\n{result-cc},\nuuidOfEthernetContainer }
-activate p1CalcUtil
-
- note over p1CalcUtil
- IF /historical-performance-data/granularity-period == '15min'
- end note
-
- note left p1CalcUtil
- ELSE
- end note
- requestor <-- p1CalcUtil : { {historical-performance-data} }
-
- note over p1CalcUtil
- THEN
- end note
-
- note over p1CalcUtil
- derive [physicalServerLtpList] from 
- either {aggregationGroup} (if link aggregation)
- or {EthernetContainerLtp} (if 1+0 configuration)
- end note
-
- loop FOR physicalServerLtpList[*]
- note over p1CalcUtil
- totalAirInterfaceIntervalCapacity += AirInterfaceIntervalCapacity
- end note
- end loop
-
- note over p1CalcUtil
- utilization = totalBytesOutput / totalAirInterfaceIntervalCapacity
- end note
-
-requestor <-- p1CalcUtil : { {historical-performance-data} }
-deactivate p1CalcUtil
-
-deactivate requestor
-
-@enduml
+@startuml p1CalculateUtilization
+skinparam responseMessageBelowArrow true
+
+title
+ p1CalculateUtilization
+end title
+
+participant "p1IterateEcPmSlices\n" as requestor
+participant "p1CalculateUtilization\n" as p1CalcUtil
+
+
+requestor -> p1CalcUtil : { {historical-performance-data},\n{aggregation-group},\n{result-cc} }
+activate p1CalcUtil
+
+ note over p1CalcUtil
+ IF /historical-performance-data/granularity-period == '15min'
+ end note
+
+ note left p1CalcUtil
+ ELSE
+ end note
+ requestor <-- p1CalcUtil : { {historical-performance-data} }
+
+ note over p1CalcUtil
+ THEN
+ end note
+
+ loop FOR /aggregation-group/physical-server-ltp-list[*]
+ note over p1CalcUtil
+ totalAirInterfaceIntervalCapacity += AirInterfaceIntervalCapacity
+ end note
+ end loop
+
+ note over p1CalcUtil
+ utilization = totalBytesOutput / totalAirInterfaceIntervalCapacity
+ end note
+
+requestor <-- p1CalcUtil : { {historical-performance-data} }
+deactivate p1CalcUtil
+
+deactivate requestor
+
+@enduml