search

beckn / protocol-server

protocol-server
19 stars 38 forks source link

Telemetry SDK Integration with the protocol server #104

Open yravinderkumar33 opened 2 months ago

yravinderkumar33 commented 2 months ago

Issue: Generate the telemetry based on Open Network Telemetry Specification(based on OTel Spec(https://opentelemetry.io/docs/specs/otel/)), which is a standardized telemetry specification for open, decentralized networks/protocols to enable network observability.

Open Network Telemetry Specifications: https://docs.google.com/document/d/1pG6nPQnR44EblckUmD6UdwJ5TrCjYQMjOdEBdNZ0V9I/edit#heading=h.jjzj6d1569a5

Resolution: We built a JS SDK 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

Made changes in the protocol server to use the SDK and generate telemetry.

yravinderkumar33 commented 2 months ago

https://github.com/beckn/protocol-server/pull/103

vbabuEM commented 2 months ago

@faizmagic can you please validate this request from a business point of view. @yravinderkumar33 has already implemented it in the PR that is linked above.

vbabuEM commented 1 week ago

@yravinderkumar33 , can you please write a brief description on what the enhancements will be if this PR is integrated, so Faiz can get a overview to approve this requirements. Primarily from a functional point of view (additional data that will be captured etc) and non-functional if any (cache improvement/code maintainability etc)