Skip to content

[Elastic Agent] Add process error handling guidelines #29152

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 30, 2021
Merged

[Elastic Agent] Add process error handling guidelines #29152

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
17d4998
[Elastic Agent] Add process error handling guidelines
ruflin Nov 25, 2021
0f93ccd
Update x-pack/elastic-agent/GUIDELINES.md
ruflin Nov 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions x-pack/elastic-agent/GUIDELINES.md
View file
Open in desktop
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.