search

elastic / elastic-agent

Elastic Agent - single, unified way to add monitoring for logs, metrics, and other types of data to a host.
Other
21 stars 144 forks source link

Documentation to explain the use of @custom component template #1726

Open gemaliano opened 2 years ago

gemaliano commented 2 years ago

Describe the enhancement: To include in documentation who are the @custom component template and how customers can use them. The @custom component template are for the users to make custom modifications. Documentation we have is related to ingest pipelines: https://www.elastic.co/guide/en/fleet/8.5/data-streams-pipeline-tutorial.html#data-streams-pipeline-four

Describe a specific use case for the enhancement or feature: Are @custom component going to survive upgrades?

kilfoyle commented 2 months ago

@cmacknz Do you think someone from the Elastic Agent team might be able to demo the custom component templates? That would really help me to get some docs together for this issue.

cmacknz commented 2 months ago

This would be an integrations feature, @kpollich would know who knows the most about the underlying implementation.

kpollich commented 2 months ago

Yep this is something my team can help with. @jen-huang is this something you could take a pass at drafting docs for?

Are @custom component going to survive upgrades?

Yes @custom templates and pipelines are fully user-managed, and will not be altered, removed, etc by integration upgrades.

jen-huang commented 2 months ago

@kpollich Yeah I can draft docs for this. When does it need to be done?

kilfoyle commented 2 months ago

@jen-huang This issue has been in the docs backlog since 2022 so I don't think it's urgent but it would definitely help users. Thanks a lot for offering to draft something up!

jen-huang commented 2 months ago

Thanks @kilfoyle. @kpollich I put this in the next sprint and assigned myself to make sure I don't forget.