elastic / elastic-agent-client

Other
3 stars 30 forks source link

Add clear examples of how to use the V2 client #53

Open cmacknz opened 1 year ago

cmacknz commented 1 year ago

Currently new users of the Elastic agent client are left with looking through the fleet-server and beats code to see real usage examples. We should provide a clear sample usage of the client (perhaps in a toy input) for input developers to use as a starting point.

Both of those examples require a new user to know they exist, and understand their usage in the context of the project they implement. The Beats client in particular is the most likely for others to find but also has the additional complexity of generating and reloading Beat configuration files.

cmacknz commented 1 year ago

We need to explain the lifecycle of a unit and how to handle it in code. In particular we should explain what happens when units are added and removed from a policy, what happens when someone edits the input ID of an existing unit in a policy, what the shutdown sequence when all units are stopped in a process is, etc.