APIproposal_SessionInsights_CableLabs.md

November 8, 2024 ยท View on GitHub

FieldDescription
API family nameSession Insights - original proposal was named Quality by Design (QbD)
API family ownerCableLabs
API summaryAPI allowing applications to:
- report application KPIs to network operator
- receive Session Insights score
- receive root cause analysis and recommended corrective actions
- request service improvements
API Scope
This API would be part of the Connectivity Insights API Family. The Session Insights API allows an application developer to create a session with a network operator. The application can then share Key Performance Indicators (KPIs) such as:
- latency
- jitter
- packet loss
- bitrate
The network operator can monitors these KPIs and determine a Session Insights score. These KPIs are aligned with the attributes in the Connectivity Insights application-profile to maintain consistency across CAMARA. If the score ever drop below certain thresholds, an event can be triggered. The network operator can then determine root cause and suggest corrective actions either to the application or to the network.

Link to proposal slides.
Use Case Example 1 - Wi-Fi Congestion
Wi-Fi congestion at a Service Site is affecting video conferencing performance, reflecting lower Session Insights scores and poor video quality
Use Case Example 2 - Network Impairments
Issues in the operator's network can lead to degradation in latency, jitter, packet loss, and bitrate, reflecting lower Session Insights scores and poor video quality.
Sample Recommendations
- create a HomeDeviceQoD session for WMM enablement
- application configuration updates
- request service improvements
Technical viabilityApplication developers can use this API to interact with the network. It assumes the network operator exposing this API has a backend to receive KPIs, analyze them, and produce a Session Insights score. Based on minimum quality thresholds for the application category, the network operator can provide proactive recommendations. The application could also use the CAMARA NetworkAccessManagement for remote control of a Device at a Service Site if necessary.
Commercial viabilityReference implementation developed by CableLabs with a sample video conferencing app using the API is being evaluated with network operators.
YAML code available?YES
Validated in lab/productive environments?YES - app using APIs validated in CableLabs lab with potential field trials coming soon with network operators.
Validated with real customers?NO - in progress with multiple application developers
Validated with operators?YES
Supporters in API Backlog Working GroupCharter, Liberty Global, Vodafone