Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Registry "build your configuration" option #5759

Open
svrnm opened this issue Dec 11, 2024 · 5 comments
Open

Registry "build your configuration" option #5759

svrnm opened this issue Dec 11, 2024 · 5 comments
Labels
discussion Input from everyone is helpful to drive this forward registry

Comments

@svrnm
Copy link
Member

svrnm commented Dec 11, 2024

This is a follow up to the outreachy PR #5451 by @mailsg

To make the "add to favorites" feature in the registry really valuable, I think it needs to also have the feature to build a configuration from the selected favorites. An example to clarify what I mean:

  • An end user clicks on "add to favorites" on multiple collector components (exporters, processors, receivers, ...)
  • They will be presented with a button that they can click to see a configuration for the collector builder with all the favorites they have selected, they can copy & paste it to a file and make use of it directly.

We can later see if this is also valuable for other languages as well.

@open-telemetry/collector-approvers, @open-telemetry/docs-approvers WDYT?

@mailsg
Copy link

mailsg commented Dec 11, 2024

This is a follow up to the outreachy PR #5451 by @mailsg

To make the "add to favorites" feature in the registry really valuable, I think it needs to also have the feature to build a configuration from the selected favorites. An example to clarify what I mean:

* An end user clicks on "add to favorites" on multiple collector components (exporters, processors, receivers, ...)

* They will be presented with a button that they can click to see a configuration for the collector builder with all the favorites they have selected, they can copy & paste it to a file and make use of it directly.

We can later see if this is also valuable for other languages as well.

@open-telemetry/collector-approvers, @open-telemetry/docs-approvers WDYT?

Hi @svrnm,

Thank you so much for the consideration.

I look forward to the decision.

Thanks.

@mx-psi
Copy link
Member

mx-psi commented Dec 11, 2024

I think the general sentiment on the Collector SIG is that this would be very cool to have :)

@mailsg
Copy link

mailsg commented Dec 13, 2024

Hi @svrnm @mx-psi

Thank you for the go-ahead for extending the Add to favorites feature.

If I understood the issue correctly, below are the few pointers that I have come up with as a plan to develop this feature. Kindly go through by it and let me know if this works :

Plan to Develop Build Configuration Feature

Step 1:

  • Data Structure: Extend the localStorage structure to store additional configuration data for each favorite item.
  • UI Changes: Add a "Generate Configuration" button in the favorites section.

Step 2:

  • Generate Configuration Function: Create a function to compile configuration data from favorites stored in localStorage.
  • UI Modifications: Update the UI to include the "Generate Configuration" button and functionality to display and copy the generated configuration.

Thanks.

@mx-psi
Copy link
Member

mx-psi commented Dec 13, 2024

That roughly makes sense to me. I am sure there will be problems to solve along the way but this is a good start

@svrnm
Copy link
Member Author

svrnm commented Dec 13, 2024

That roughly makes sense to me. I am sure there will be problems to solve along the way but this is a good start

Exactly, let's get started and slowly move forward with it. A few things we might want to anticipate from the get go:

  • the "add to favorites" or however we want to call that button should initially only work for collector components
  • nevertheless we should plan to expand this feature to other groups as well, e.g. maybe we want to create for some languages a quick "install sheet" as well

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion Input from everyone is helpful to drive this forward registry
Projects
Status: No status
Development

No branches or pull requests

3 participants