search

beckn / protocol-server

protocol-server
7 stars 17 forks source link

Open Network Telemetry Specification v1.0 & SDK(to generate telemetry) #211

Open shiva-rakshith opened 4 months ago

shiva-rakshith commented 4 months ago

Introduction: In the realm of Open Networks, telemetry (along with the resultant data) offers numerous advantages and values to both the network itself and its participants. The collected telemetry is expected to yield a wealth of insights, actions, and features related to aspects such as network health, economics, equitable usage, user experience, regulatory compliance, detection of frauds and anomalies, market dynamics, business operations, public transparency, open data, and various other dimensions.

A standardized telemetry specification for open, decentralized networks/protocols called Open Network Telemetry Specification v1.0(based on OTel Spec) is created to enable network observability.

Open Network Telemetry Specifications v1.0: https://github.com/Sunbird-Obsrv/network-telemetry-spec

Open Network Telemetry SDK: A Javascript SDK is available to generate the telemetry(https://github.com/Sunbird-Obsrv/open-network-telemetry). SDK Documentation: https://github.com/Sunbird-Obsrv/open-network-telemetry/blob/main/README.md

Note: Protocol Server is enhanced to use Open Network Telemetry SDK and generate telemetry. The intent of this integration - Most of the NPs use protocol server and it becomes easier this way to start receiving the data to monitor network growth and derive insights. PR link here https://github.com/beckn/protocol-server/pull/210, FYI

cc: @mmanimegalai, @vrayulu

shiva-rakshith commented 4 months ago

@vbabuEM

vbabuEM commented 4 months ago

@emmayank @viraj89 , we might want to get one approval from @ravi-prakash-v (He had asked to be informed on new features). Rakshith has implemented the PR for this. Once Ravi gives a go ahead, it can probably be merged. Will one of you please bring this up with him in the Tech Standup.

vbabuEM commented 2 months ago

This issue came up in today's standup call. Ravi has given a go ahead for two things a. Open Telemetry API for sending observability parameters (It is already there in Beckn-ONIX spec as recommended requirement) b. Flexible way to specify the network observability parameters (This will be a separate issue. I will write it) Unfortunately we do not seem to have Shiva Rakshith anymore to help us ( I tried contacting him) So we will be owning everything on this. What needs to be done on this ticket is:

a. Developer needs to understand the Open Telemetry API and the ecosystem. b. Developer needs to check the PR if the code is correct, if the design is flexible etc. c. A good idea will also be to configure a dummy collector/display and see if nothing has been missed (Since we did not think about this from origin, its possible we dont grasp all the intricacies)

@emmayank @viraj89 @yesrag2309 , please create a new flow for this and float it. Based on the priority, please take it forward. I feel the developer will need atleast a week or more to do justice to this issue. Please instruct developer to not see it as just PR integration.

cc @ravi-prakash-v cc @binrange (Binu from ONDC) - FYI