opentelemetry-collector-contrib icon indicating copy to clipboard operation
opentelemetry-collector-contrib copied to clipboard

Introduce noop skeleton component directories as starting points for new component contributors

Open jspaleta opened this issue 2 years ago • 1 comments

Is your feature request related to a problem? Please describe. To lower the bar to component development for new contributors with an itch to scratch, it would be useful to have skeleton noop components that include commented boilerplate / factory calls. Contributors could copy and edit (following the hints in the comments) as a starting point for new component development.

Describe the solution you'd like There could be a directory of skeleton components with just enough functional code to create a buildable, and callable component but not productively operational component. Such skeleton component directories, with minor tweaking, would be an appropriate starting point for the initial component PR in the iterative PR process documented in the contributor documentation.

Going further, there could be a helper tool that uses these skeleton components to provide a guided process to help new contributors fill in the minimum required customization to transition templated skeleton components into appropriately named new components.

Additional context Here's an example of what I'm trying to describe for otel as currently implemented in the context of Sensu https://github.com/sensu/sensu-plugin-tool

the sensu-plugin-tool helps new contributors spin up Sensu plugins including generating basic README documentation by asking a series of questions whose answers are used in string template substitution embedded in the template repositories the tool uses to generate new plugin projects.

Something like this should be possible for otel-collector using skeleton component directories.

jspaleta avatar Aug 04 '22 17:08 jspaleta

Relates to open-telemetry/opentelemetry-collector/issues/5675

mx-psi avatar Aug 05 '22 14:08 mx-psi

I think it would make sense to have a tool like ocb for bootstrapping a component.

jpkrohling avatar Aug 08 '22 16:08 jpkrohling

This issue has been inactive for 60 days. It will be closed in 60 days if there is no activity. To ping code owners by adding a component label, see Adding Labels via Comments, or if you are unsure of which component this issue relates to, please ping @open-telemetry/collector-contrib-triagers. If this issue is still relevant, please ping the code owners or leave a comment explaining why it is still relevant. Otherwise, please close it.

github-actions[bot] avatar Nov 10 '22 03:11 github-actions[bot]

cc @Chinwendu20, this is likely relevant for your Outreachy project.

jpkrohling avatar Nov 23 '22 13:11 jpkrohling

Hello @jpkrohling . Yes it is. I would take a closer look at example referenced i.e. sensei plugin tool and see how I can implement it.

Chinwendu20 avatar Nov 23 '22 14:11 Chinwendu20

This issue has been inactive for 60 days. It will be closed in 60 days if there is no activity. To ping code owners by adding a component label, see Adding Labels via Comments, or if you are unsure of which component this issue relates to, please ping @open-telemetry/collector-contrib-triagers. If this issue is still relevant, please ping the code owners or leave a comment explaining why it is still relevant. Otherwise, please close it.

github-actions[bot] avatar Jan 23 '23 03:01 github-actions[bot]

Hello all. I created a project that would help out with this issue:

https://github.com/Chinwendu20/otel_components_generator

Do check it out and give me your suggestions

Chinwendu20 avatar Mar 03 '23 12:03 Chinwendu20

@Chinwendu20 very cool, would you like to demo this at a SIG meeting?

atoulme avatar Mar 12 '23 08:03 atoulme

Yes, thanks, the collector sig meeting by Wednesday 5 pm GMT+1. I plan on attending this week

Chinwendu20 avatar Mar 12 '23 15:03 Chinwendu20

This issue has been inactive for 60 days. It will be closed in 60 days if there is no activity. To ping code owners by adding a component label, see Adding Labels via Comments, or if you are unsure of which component this issue relates to, please ping @open-telemetry/collector-contrib-triagers. If this issue is still relevant, please ping the code owners or leave a comment explaining why it is still relevant. Otherwise, please close it.

github-actions[bot] avatar May 12 '23 03:05 github-actions[bot]

This issue has been closed as inactive because it has been stale for 120 days with no activity.

github-actions[bot] avatar Jul 11 '23 05:07 github-actions[bot]