Skip to content
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.

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

Update the elastic-agent resource consumption docs #1414

Merged
merged 17 commits into from
Nov 8, 2024

Conversation

alexsapran
Copy link
Contributor

Signed-off-by: Alexandros Sapranidis <alexandros@elastic.co>
@alexsapran alexsapran added the documentation Improvements or additions to documentation label Oct 31, 2024
@alexsapran alexsapran self-assigned this Oct 31, 2024
Copy link

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

Copy link
Contributor

mergify bot commented Oct 31, 2024

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

  • backport-/d./d is the label to automatically backport to the /d./d branch. /d is the digit
    NOTE: backport-skip has been added to this pull request.

Signed-off-by: Alexandros Sapranidis <alexandros@elastic.co>
Signed-off-by: Alexandros Sapranidis <alexandros@elastic.co>
@rowlandgeoff
Copy link
Contributor

I could suggest some updates to wording and formatting, but first I think we should confirm whether this is the data we'd like current and potential customers to see. Going from 2% to 40% CPU usage is a big jump. Should the default preset info be shown as well to indicate that not every scenario is resource intensive? @cmacknz @amitkanfer

Signed-off-by: Alexandros Sapranidis <alexandros@elastic.co>
Signed-off-by: Alexandros Sapranidis <alexandros@elastic.co>
Signed-off-by: Alexandros Sapranidis <alexandros@elastic.co>
@alexsapran alexsapran marked this pull request as ready for review November 1, 2024 16:00
@alexsapran alexsapran requested a review from a team as a code owner November 1, 2024 16:00
@cmacknz
Copy link
Member

cmacknz commented Nov 1, 2024

We effectively have two use cases we care about, and now that I've seen this we probably need to publish results for both of them:

  1. High Throughput: How much data can we push assuming we can utilize all the resources of the machine. This is what we have here.
  2. Scale/Endpoint Security: What is the resource footprint for low volume security monitoring. This is a competitive metric for security deployments.

We do not want to publish this without a callout that it is exclusive of use case 2.

Signed-off-by: Alexandros Sapranidis <alexandros@elastic.co>
Signed-off-by: Alexandros Sapranidis <alexandros@elastic.co>
Signed-off-by: Alexandros Sapranidis <alexandros@elastic.co>
alexsapran and others added 2 commits November 5, 2024 09:49
Signed-off-by: Alexandros Sapranidis <alexandros@elastic.co>
…asciidoc

Co-authored-by: Craig MacKenzie <craig.mackenzie@elastic.co>
…asciidoc

Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>
@amitkanfer
Copy link
Contributor

@alexsapran worth adding a link to our presets whenever mentioned...?

Signed-off-by: Alexandros Sapranidis <alexandros@elastic.co>
@strawgate
Copy link
Contributor

We effectively have two use cases we care about, and now that I've seen this we probably need to publish results for both of them:

Agree, and we should probably present these use-cases separately, as they are quite different.

Also, without something like "events per second" or "disk read throughput", this information doesn't really help with sizing as it stands right now. I'm also a bit worried that we were disk throughput limited in the benchmark, do we have any info on the disk info?

@alexsapran
Copy link
Contributor Author

Also, without something like "events per second" or "disk read throughput", this information doesn't really help with sizing as it stands right now. I'm also a bit worried that we were disk throughput limited in the benchmark, do we have any info on the disk info?

Let's sync up async; I would like to know why you think we are disk throttled. I can rerun the benchmarks and check the disk to make sure it's not the limiting factor.

Signed-off-by: Alexandros Sapranidis <alexandros@elastic.co>
Signed-off-by: Alexandros Sapranidis <alexandros@elastic.co>
Signed-off-by: Alexandros Sapranidis <alexandros@elastic.co>
Signed-off-by: Alexandros Sapranidis <alexandros@elastic.co>
Copy link
Contributor

@kilfoyle kilfoyle left a comment

Choose a reason for hiding this comment

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

@alexsapran This looks great to me so far. I'll be offline until after next week so if you need any help or an approval from platform-docs @karenzone can help.

And, I look forward to working with you on automating some of this content eventually. ⚡

@alexsapran alexsapran merged commit d7ef138 into elastic:main Nov 8, 2024
3 checks passed
mergify bot pushed a commit that referenced this pull request Nov 8, 2024
Update the installation page of elastic-agent by adding the resource usage consumption we observed in our lab environments.

Signed-off-by: Alexandros Sapranidis <alexandros@elastic.co>
Co-authored-by: Craig MacKenzie <craig.mackenzie@elastic.co>
Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>
(cherry picked from commit d7ef138)
mergify bot pushed a commit that referenced this pull request Nov 8, 2024
Update the installation page of elastic-agent by adding the resource usage consumption we observed in our lab environments.

Signed-off-by: Alexandros Sapranidis <alexandros@elastic.co>
Co-authored-by: Craig MacKenzie <craig.mackenzie@elastic.co>
Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>
(cherry picked from commit d7ef138)
mergify bot pushed a commit that referenced this pull request Nov 8, 2024
Update the installation page of elastic-agent by adding the resource usage consumption we observed in our lab environments.

Signed-off-by: Alexandros Sapranidis <alexandros@elastic.co>
Co-authored-by: Craig MacKenzie <craig.mackenzie@elastic.co>
Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>
(cherry picked from commit d7ef138)
karenzone pushed a commit that referenced this pull request Nov 8, 2024
Update the installation page of elastic-agent by adding the resource usage consumption we observed in our lab environments.

Signed-off-by: Alexandros Sapranidis <alexandros@elastic.co>
Co-authored-by: Craig MacKenzie <craig.mackenzie@elastic.co>
Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>
(cherry picked from commit d7ef138)

Co-authored-by: Alexandros Sapranidis <alexandros@elastic.co>
karenzone pushed a commit that referenced this pull request Nov 8, 2024
Update the installation page of elastic-agent by adding the resource usage consumption we observed in our lab environments.

Signed-off-by: Alexandros Sapranidis <alexandros@elastic.co>
Co-authored-by: Craig MacKenzie <craig.mackenzie@elastic.co>
Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>
(cherry picked from commit d7ef138)

Co-authored-by: Alexandros Sapranidis <alexandros@elastic.co>
karenzone pushed a commit that referenced this pull request Nov 8, 2024
Update the installation page of elastic-agent by adding the resource usage consumption we observed in our lab environments.

Signed-off-by: Alexandros Sapranidis <alexandros@elastic.co>
Co-authored-by: Craig MacKenzie <craig.mackenzie@elastic.co>
Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>
(cherry picked from commit d7ef138)

Co-authored-by: Alexandros Sapranidis <alexandros@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-8.x backport-8.15 backport-8.16 documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants