Skip to content

Commit

Permalink
[Elastic Agent] Add process error handling guidelines (#29152)
Browse files Browse the repository at this point in the history
We don't have a good place yet to document expectations around services run by Elastic Agent. I'm starting this document to have a place to add more content to it but I expect long term we need to figure out a better place.

This guideline comes out of recent issues we had in Cloud and local setups of fleet-server (elastic/fleet-server#883). We never set clear guidlines on what the expectation is of a service run by Elastic Agent and Elastic Agent itself.

This PR is kick off the discussion.


Co-authored-by: Gil Raphaelli <[email protected]>
  • Loading branch information
ruflin and graphaelli authored Nov 30, 2021
1 parent 180e7f3 commit 51463bf
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions x-pack/elastic-agent/GUIDELINES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Guidelines

This document contains architecture details around Elastic Agent and guidelines on how new inputs and processes should be built.

## Processes running as service and error handling

All the processes started by Elastic Agent are running as service. Each service is expected to handle local errors on its own and continue working. A process should only fail on startup if an invalid configuration is passed in. As soon as a process is running and partial updates to the config are made without restart, the service is expected to keep running but report the errors.

A service that needs to do setup tasks on startup is expected to retry until it succeeds and not error out after a certain timeout.

0 comments on commit 51463bf

Please sign in to comment.