Skip to content

[Elastic Agent] Add process error handling guidelines#29152

Merged
ruflin merged 2 commits intoelastic:masterfrom
ruflin:process-guidelines
Nov 30, 2021
Merged

[Elastic Agent] Add process error handling guidelines#29152
ruflin merged 2 commits intoelastic:masterfrom
ruflin:process-guidelines

Conversation

@ruflin
Copy link
Copy Markdown
Contributor

@ruflin ruflin commented Nov 25, 2021

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.

@ruflin
[Elastic Agent] Add process error handling guidelines
17d4998 
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.
@botelastic botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Nov 25, 2021
@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Nov 25, 2021

This pull request does not have a backport label. Could you fix it @ruflin? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-v./d./d./d is the label to automatically backport to the 7./d branch. /d is the digit

NOTE: backport-skip has been added to this pull request.

@mergify mergify bot added the backport-skip Skip notification from the automated backport with mergify label Nov 25, 2021
@ruflin
Copy link
Copy Markdown
Contributor Author

ruflin commented Nov 25, 2021

@elastic/elastic-agent Would be great to get your input on this specific guideline but also on where and how we should document these things.

@graphaelli Thanks for the inspiration to kick this off @simitt might be interested in this too.

@ruflin ruflin self-assigned this Nov 25, 2021
@ruflin ruflin added the Team:Elastic-Agent Label for the Agent team label Nov 25, 2021
@botelastic botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Nov 25, 2021
@elasticmachine
Copy link
Copy Markdown
Contributor

elasticmachine commented Nov 25, 2021 •
edited by jenkins-beats-ci bot
Loading

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2021-11-30T08:16:15.234+0000

  • Duration: 21 min 36 sec

  • Commit: 0f93ccd

❕ Flaky test report

No test was executed to be analysed.

🤖 GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

  • /package : Generate the packages and run the E2E tests.

  • /beats-tester : Run the installation tests with beats-tester.

  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

graphaelli
graphaelli reviewed Nov 29, 2021
View reviewed changes
Copy link
Copy Markdown
Member

@graphaelli graphaelli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would this be a good place to capture security guidelines? eg configuration of process capabilities (eg via seccomp filters), running as a specific user

@ruflin
Copy link
Copy Markdown
Contributor Author

ruflin commented Nov 30, 2021

@graphaelli Yes. We should start to capture here all the guidelines around Elastic Agent.

@ruflin @graphaelli
Update x-pack/elastic-agent/GUIDELINES.md
0f93ccd 
Co-authored-by: Gil Raphaelli <g@raphaelli.com>
@ruflin
Copy link
Copy Markdown
Contributor Author

ruflin commented Nov 30, 2021

@graphaelli Should we get this initial PR merged so we have a future "place" to add more things to the list?

@graphaelli
Copy link
Copy Markdown
Member

graphaelli commented Nov 30, 2021

Sure, that works, thanks for getting this started.

@ruflin ruflin merged commit 51463bf into elastic:master Nov 30, 2021
@ruflin ruflin deleted the process-guidelines branch November 30, 2021 13:50
elasticmachine pushed a commit to nxei/beats that referenced this pull request Dec 1, 2021
@v1v
Merge remote-tracking branch 'upstream/master' into github-actions-build
99c50fb 
* upstream/master:
  [libbeat] Fix add_labels flattening of arrays values (elastic#29211)
  Change elastic-agent pprof default to false (elastic#29155)
  elastic#28472 fix flaky tests in libbeat fmtstr to use time.UTC instead of time.Local (elastic#28473)
  Adopt `parsers` in Filebeat's journald input (elastic#29070)
  [Elastic Agent] Add process error handling guidelines (elastic#29152)
  winlogbeat/sys/winevent: use reflect IsZero method (elastic#29190)
  Remove Journalbeat (elastic#29131)
  Add note that there is no warranty or support for generator code (elastic#28797)
  packetbeat: preparation for npcap addition (elastic#29017)
  Use the generic helper for opening file to read in filestream (elastic#29180)
  Workflow for macos (elastic#29174)
  Fix `decode_json_fields` processor to always add error key (elastic#29107)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@graphaelli graphaelli graphaelli approved these changes

Assignees

@ruflin ruflin

Labels

backport-skip Skip notification from the automated backport with mergify Team:Elastic-Agent Label for the Agent team

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@ruflin @elasticmachine @graphaelli