BharatSahAIyak / telemetry

2 stars 4 forks source link

[DMP 2024]: Jaegar Extensions to Telemetry #8

Open ChakshuGautam opened 2 months ago

ChakshuGautam commented 2 months ago

Description

The current telemetry specification is based on a Wide Events. UCI is a state machine implementation that exposes traces like metrics and hence can be visualized in as in the image below image

The objective of this ticket is to create an extension that will take in a stream of events in the BHASAI Telemetry format and convert them to OTEL Traces specification, push them to Jaegar and create UCI based dashboards out of it.

The context propagation will happen through either sessionId or messageId

Goals & Mid-Point Milestone

Goals

Setup/Installation

No response

Expected Outcome

An extension capable of converting BHASAI Telemetry format to OTEL Traces specification, integrated with Jaeger for trace visualization, and UCI-based dashboards for monitoring and visualization purposes.

Acceptance Criteria

Implementation Details

Mockups/Wireframes

Not required for this project.

Product Name

Bharat SahAIyak

Organisation Name

SamagraX

Domain

⁠Agriculture

Tech Skills Needed

JavaScript

Mentor(s)

@ChakshuGautam

Category

Backend

AbhimanyuSamagra commented 2 months ago

Do not ask process related questions about how to apply and who to contact in the above ticket. The only questions allowed are about technical aspects of the project itself. If you want help with the process, you can refer instructions listed on Unstop and any further queries can be taken up on our Discord channel titled DMP queries. Here's a Video Tutorial on how to submit a proposal for a project.

Anushkabh commented 2 months ago

@ChakshuGautam I have read the documentation and so far understood the BHASAI Telemetry format .. should i make a pr for the existing issue #7 so that i can include in my proposal ? kindly guide @dhruv-1001

Swagata212003 commented 2 months ago

Hello,@Swagata212003 here, want co contribute in this project, I am skilled in JavaScript.

Saksham0303 commented 2 months ago

Greetings, @ChakshuGautam , I want to contribute my sincere interest in the Development of this project & I can assure you about giving my best dedication in the development of project with my Graphic designing and UI/UX designing, front-end development skills in ReactJS and JavaScript, coupled with a passion for creating intuitive user experiences. My technical expertise, combined with a keen eye for design and functionality, positions me well to contribute effectively to the development of this project."

These are the approaches founded by me :

  1. Configuration and Customization: Provide configuration options to customize the behavior of the extension, such as specifying input/output formats, Jaeger endpoint settings, and UCI dashboard templates. Allow users to define mappings or transformations between BHASAI Telemetry events and OTEL Traces, enabling flexibility and adaptability to different use cases.

  2. Documentation and User Support: Provide comprehensive documentation covering installation, configuration, usage, troubleshooting, and best practices for the extension. Offer user support channels, such as forums, mailing lists, or ticketing systems, to assist users with questions, issues, and feature requests. Foster a community around the extension by encouraging user contributions, sharing use cases, and organizing events or workshops.

  3. Integration with Ecosystem Tools: Integrate the extension with other ecosystem tools and platforms commonly used in telemetry and observability. Provide plugins, connectors, or adapters to facilitate interoperability and data exchange with third-party systems and services. Enable seamless integration with cloud-native environments, container orchestration platforms, and serverless architectures.

Saksham0303 commented 2 months ago

Firstly, The extension converts input data into an alternative format or structure while maintaining adherence to the BHASAI Telemetry format. In this case, it appears that the extension transforms telemetry data from the BHASAI Telemetry format into another format, like the OpenTelemetry (OTEL) Traces specification, which is frequently employed in distributed systems for observability and tracing reasons. The extension makes telemetry data compatible with other tools, systems, or standards that support the target format by converting it from the BHASAI Telemetry format to another format, like the OTEL Traces specification. Parsing the input data, implementing changes, and producing output data that complies with the structure and semantics of the target format are some possible steps in this conversion process. Then, Integration with Jaeger: To see the converted traces, the plugin will be connected with the open-source distributed tracing system Jaeger. With the help of Jaeger's intuitive interface, users can easily explore and analyze traces to gain insight into the functionality and performance of their systems. Connect the telemetry data produced by the extension and kept in a backend or data storage that is compatible with the dashboards. In order to provide the dashboards with the most recent information, retrieve and process the telemetry data. Assure smooth synchronization and data integration between the underlying data sources and the dashboards.

Further please guide me more to work in this project...

Here is my Resume : https://drive.google.com/file/d/1e4cOxVAfIjehLf7LemzX4oxPFhWd4y4D/view?usp=drive_link

On Fri, 3 May 2024 at 22:51, Swagata212003 @.***> wrote:

Can you give more details about the project?

On Fri, 3 May, 2024, 10:46 pm saksham_jain, @.***> wrote:

Greetings, @ChakshuGautam https://github.com/ChakshuGautam , I want to contribute my sincere interest in the Development of this project & I can assure you about giving my best dedication in the development of project with my Graphic designing and UI/UX designing, front-end development skills in ReactJS and JavaScript, coupled with a passion for creating intuitive user experiences. My technical expertise, combined with a keen eye for design and functionality, positions me well to contribute effectively to the development of this project."

These are the approaches founded by me :

1.

Configuration and Customization: Provide configuration options to customize the behavior of the extension, such as specifying input/output formats, Jaeger endpoint settings, and UCI dashboard templates. Allow users to define mappings or transformations between BHASAI Telemetry events and OTEL Traces, enabling flexibility and adaptability to different use cases. 2.

Documentation and User Support: Provide comprehensive documentation covering installation, configuration, usage, troubleshooting, and best practices for the extension. Offer user support channels, such as forums, mailing lists, or ticketing systems, to assist users with questions, issues, and feature requests. Foster a community around the extension by encouraging user contributions, sharing use cases, and organizing events or workshops. 3.

Integration with Ecosystem Tools: Integrate the extension with other ecosystem tools and platforms commonly used in telemetry and observability. Provide plugins, connectors, or adapters to facilitate interoperability and data exchange with third-party systems and services. Enable seamless integration with cloud-native environments, container orchestration platforms, and serverless architectures.

— Reply to this email directly, view it on GitHub < https://github.com/BharatSahAIyak/telemetry/issues/8#issuecomment-2093441633>,

or unsubscribe < https://github.com/notifications/unsubscribe-auth/A6HIFH5LQD4TTQ57NTEC6ADZAPBABAVCNFSM6AAAAABGPVEPN6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDAOJTGQ2DCNRTGM>

. You are receiving this because you were mentioned.Message ID: @.***>

— Reply to this email directly, view it on GitHub https://github.com/BharatSahAIyak/telemetry/issues/8#issuecomment-2093451226, or unsubscribe https://github.com/notifications/unsubscribe-auth/A6JHCGNU4D4UJGHUURKEOGLZAPBRLAVCNFSM6AAAAABGPVEPN6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDAOJTGQ2TCMRSGY . You are receiving this because you commented.Message ID: @.***>

ChakshuGautam commented 2 months ago

@ChakshuGautam I have read the documentation and so far understood the BHASAI Telemetry format .. should i make a pr for the existing issue #7 so that i can include in my proposal ? kindly guide @dhruv-1001

@dhruv-1001 can you validate if the the ticket is still open?

dhruv-1001 commented 2 months ago

@ChakshuGautam I have read the documentation and so far understood the BHASAI Telemetry format .. should i make a pr for the existing issue #7 so that i can include in my proposal ? kindly guide @dhruv-1001

@dhruv-1001 can you validate if the the ticket is still open?

This was not replicated, therefore closed.

varshith257 commented 1 month ago

@ChakshuGautam @dhruv-1001 I found out last night this project is participating in DMP Mentorship. I am very excited to contribute to this project as I am also a contributor to Jaeger for the past 6 months. I am actively working on the proposal.

@dhruv-1001 As of my understanding of this ticket, will we replace the SuperSet and utilize new UCI-based dashboards of converted BHASAI Telemetry format to OTEL Traces?

dhruv-1001 commented 1 month ago

Hii @ChakshuGautam , @dhruv-1001 , I am trying to setup telemetry project on my system, will you guide me regarding this statement in setup guide - Copy event CSV to schema-generator as events.csv, which is in this format. which CSV file it is mentioning to copy ??

You can define your own events in that format in a CSV, and then use that.

varshith257 commented 3 weeks ago

@dhruv-1001 @ChakshuGautam Can I get this issue assigned under DMP

varshith257 commented 2 weeks ago

Weekly Learnings & Updates (To be filled by contributor)

Week

KDwevedi commented 1 week ago

Weekly Goals (To be filled by mentor)

Week 1

Week 2