wso2 / api-manager

All issues, tasks, improvements and new features of WSO2 API Manager
Apache License 2.0
34 stars 8 forks source link

Add Egress Analytics Dashboards for AI APIs in Choreo Analytics #3318

Open Jithmi004 opened 3 weeks ago

Jithmi004 commented 3 weeks ago

Problem

Currently, the Choreo analytics dashboards provide analytics support only for ingress related analytics in APIM. With the release of APIM 4.4.0, there is a need to support egress analytics, specifically focusing on AI APIs.

Solution

To address this issue, a new set of dashboards should be implemented in Choreo analytics that display egress-related analytics for AI APIs and General egress APIs.

Affected Component

APIM

Version

4.4.0

Implementation

No response

Related Issues

No response

Suggested Labels

No response

Jithmi004 commented 2 weeks ago

2024/09/13 - Update

Designed wireframe UIs for Egress Analytics Dashboards in Choreo. Usage Insights were split into Ingress and Egress analytics. The existing widgets under Usage Insights are displayed under Ingress analytics. Under Egress analytics, added a filtering option to the UI wireframes to select between outbound types All, AI/LLM, or Other. Under Egress Analytics, the second nav bar option is updated to contain Overview, Traffic, Error, Latency, and Custom Reports. Under filtering option AI/LLM, new widgets were designed to display vendor/model and token related data. Under filtering option All, widgets were designed to display target related data.

Jithmi004 commented 2 weeks ago

2024/09/18 - Update

Under the new feature Egress Analytics, created a user stories document to emphasise the use case of each newly added widget. This was done separately for Publisher and System Admin roles.

Jithmi004 commented 2 weeks ago

2024/09/23 - Update

After a discussion with the Choreo team, revised the UI designs, and removed the filtering option under Egress analytics. Instead, added a submenu Item for AI Analytics under Egress analytics and all the vendor/model/token related widgets were added under that. Added the proposed schema changes in apim_event_response for AI analytics in the design document.

Jithmi004 commented 2 weeks ago

2024/10/09 - Update

Set up the choreo-console and choreo-apim-analytics-portal for local development and started working on implementation for analytics dashboards.

Jithmi004 commented 2 weeks ago

2024/10/11 - Update

In the choreo-console, implemented subnav items Egress and Ingress under Usage Insights and passed the analytics type as a Prop to the Analytics portal component in choreo-apim-analytics-portal.

Jithmi004 commented 2 weeks ago

2024/10/20 - Update

Add reusable dashboard card component to display token related data in choreo-apim-analytics-portal

Jithmi004 commented 2 weeks ago

2024/10/24 - Update

Added initial implementations for Traffic page widgets and vendor filter in the choreo-apim-analytics-portal

Jithmi004 commented 2 weeks ago

2024/10/25 - Update

Fixed the reloading issue when changing between Ingress and Egress analytics under Usage Insights in the choreo-console.

Jithmi004 commented 2 weeks ago

2024/10/30 - Update

Under Egress Analytics in the choreo-apim-analytics-portal, implemented tabs to differentiate between General-Analytics and AI-Analytics.

Jithmi004 commented 2 weeks ago

2024/10/31 - Update

Updated analytics routes and pages based on analytics type (Ingress and Egress) and egress types (General and AI) in the choreo-console, and fixed an issue when loading Egress analytics.

Jithmi004 commented 2 weeks ago

2024/11/01 - Update

Added Coming Soon page for egress analytics.

Jithmi004 commented 2 weeks ago

2024/11/04 - Update