Product Requirements for Beckn enabled network observability microsite - MVP-v1

[faizmagic]

Minutes of meeting held for this purpose:

Description:

This product is designed for the overall monitoring of the Beckn network, with the first milestone focusing ONLY on OPEN DATA. Data specific to network participants (useful for troubleshooting, etc.) will not be included in this version.

Objective:

The primary objective of this product is to establish a robust monitoring framework for the Beckn network, with an initial emphasis on open data. This framework should align with key design principles and be integrated into the Beckn ONIX platform.

Design Principles:

1. Interoperability: Should be compatible with standards like Open Telemetry.
2. Privacy Compliance: Must protect Personally Identifiable Information (PII).
3. Beckn ONIX Integration: Should be a core component of the Beckn ONIX platform.
4. Scalability: Should be scalable to accommodate future network growth.
5. Spatial and Temporal Scoping: Should support scoping data spatially and temporally.

Scope for MVP 1:

1. Network Participant (NP) Level Data: Registry lookup information.
2. Aggregated Transaction Data: Includes DOFP and Catalog data (No NP-specific data; presented as time series).
3. Infrastructure SLA Metrics: Metrics such as availability, health, throughput, error rate, etc.
4. Downloadable Reports: Summary reports that can be downloaded.
5. Alerts: Notifications when NPs are down.

Future Scope:

1. Settlement/Reconciliation Data: Incorporate data from currently unavailable sources.
2. Network Participant Endpoint Information: 'About' endpoint for network participants.
3. Notification Mechanisms: Enhanced alerting and notification systems linked to network events.

Goals:

• [ ] Implement the MVP 1 scope focusing on open data and basic network observability.
• [ ] Ensure the product adheres to the outlined design principles.
• [ ] Successfully integrate the monitoring tool into the Beckn ONIX platform.

Expected Outcome:

• A fully functional network monitoring tool that provides essential open data insights and alerts, in compliance with the Beckn ONIX platform's design and scalability requirements.

Acceptance Criteria:

• [ ] Completion of all MVP 1 scope items with verified functionality.
• [ ] Confirmation of adherence to design principles.
• [ ] Successful testing and deployment of the monitoring product within Beckn ONIX.

Mockups / Wireframes:

NA

Product Name:

Beckn Network Monitoring Tool

Domain:

Network Observability

Tech Skills Needed:

Beckn ONIX, Open Telemetry, L2-config, Data Privacy Compliance

Complexity:

High

Category:

Monitoring and Observability

Sub Category:

Network Infrastructure

[viraj89]

Not moving to Aug 19 iteration, will be closed on Aug 19.

[vbabuEM]

The requirements are documented here https://fide-official.atlassian.net/wiki/x/A4CtI

cc @emmayank @viraj89 @faizmagic @ravi-prakash-v