elastic / integrations

Elastic Integrations
https://www.elastic.co/integrations
Other
200 stars 429 forks source link

Package generator design and implementation #3932

Open akshay-saraswat opened 2 years ago

akshay-saraswat commented 2 years ago

Inspired from this ER.

Our integration packages usually use a beats module or input as the foundation for the new agent-based integration and have a lot in common. Some integrations that don't require changes in core framework or additional inputs could be auto-generated. For example, instead of manually copy-pasting and modifying manifest files, we can write different sections of the manifest using a script when a package author provides a few parameters to it. There is a potential to build even more sophisticated tool that a bare bones script in the future. For example, today our elastic-package CLI is dumb and creates an initial package directory that is static. In the future, we could create an elastic-package plugin that may generate something close to a working package dynamically depending on the assets needed, subscription requirements, input to be used, and integration policy configurations. We can also add this plugin to Kibana UI to make it more user friendly.

Inspiration suggested by @jlind23, https://start.spring.io/.

jlind23 commented 2 years ago

@mrodm @jsoriano @mtojek have you ever thought of something like this? Is there any bottlenecks/caveats we may have misevaluated?

jsoriano commented 2 years ago

Maybe we can extend elastic-package create to scaffold certain use cases. One challenge we have is that for each integration, a package developer needs to curate very well the field mappings, but any UI or help over there would be helpful.

Something that could be also considered could be an IDE plugin. It could include different package templates and UIs for the more error-prone tasks.

botelastic[bot] commented 1 year ago

Hi! We just realized that we haven't looked into this issue in a while. We're sorry! We're labeling this issue as Stale to make it hit our filters and make sure we get back to it as soon as possible. In the meantime, it'd be extremely helpful if you could take a look at it as well and confirm its relevance. A simple comment with a nice emoji will be enough :+1. Thank you for your contribution!

botelastic[bot] commented 2 months ago

Hi! We just realized that we haven't looked into this issue in a while. We're sorry! We're labeling this issue as Stale to make it hit our filters and make sure we get back to it as soon as possible. In the meantime, it'd be extremely helpful if you could take a look at it as well and confirm its relevance. A simple comment with a nice emoji will be enough :+1. Thank you for your contribution!