Skip to content

Commit

Permalink
Update the elastic-agent resource consumption docs (#1414)
Browse files Browse the repository at this point in the history
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)
  • Loading branch information
alexsapran authored and mergify[bot] committed Nov 8, 2024
1 parent bb80242 commit 35557a4
Showing 1 changed file with 21 additions and 13 deletions.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[[elastic-agent-installation]]
= Install {agent}s

[IMPORTANT]
[IMPORTANT]
.Restrictions
====
Note the following restrictions when installing {agent} on your system:
Expand All @@ -12,7 +12,7 @@ run the commands described here. After the {agent} service is installed and runn
make sure you run these commands without prepending them with `./` to avoid
invoking the wrong binary.
* Running {agent} commands using the Windows PowerShell ISE is not supported.
* See also the <<elastic-agent-installation-minimum-requirements,minimum requirements>> described on this page.
* See also the <<elastic-agent-installation-resource-requirements,resource requirements>> described on this page.
====

You have a few options for installing and managing an {agent}:
Expand Down Expand Up @@ -57,32 +57,40 @@ Refer to:
* {eck-ref}/k8s-elastic-agent.html[Run {agent} on ECK] -- for {eck} users
--

[IMPORTANT]
[IMPORTANT]
.Restrictions in {serverless-short}
====
====
If you are using {agent} with link:{serverless-docs}[{serverless-full}], note these differences from use with {ess} and self-managed {es}:
* The number of {agents} that may be connected to an {serverless-full} project is limited to 10 thousand.
* The minimum supported version of {agent} supported for use with {serverless-full} is 8.11.0.
====

[discrete]
[[elastic-agent-installation-minimum-requirements]]
== Minimum requirements
[[elastic-agent-installation-resource-requirements]]
== Resource requirements

The {agent} resources consumption is influenced by the number of integration and the environment its been running on.

Using our lab environment as an example, we can observe the following resource consumption:

The following are the minimum system requirements for installing {agent}.
// lint ignore mem
[discrete]
=== CPU and RSS memory size

// lint ignore 2vcpu 1gb
Minimum requirements have been determined by running the {agent} on a GCP `e2-micro` instance (2vCPU/1GB).
The {agent} used the default policy, running the system integration and self-monitoring.

// lint ignore 2 vCPU 8.0 GiB
We tested using an AWS `m7i.large` instance type with 2 vCPUs, 8.0 GB of memory, and up to 12.5 Gbps of bandwidth. The tests ingested a single log file using both the <<output-elasticsearch-performance-tuning-settings,throughput and scale preset>> with self monitoring enabled.
These tests are representative of use cases that attempt to ingest data as fast as possible. This does not represent the resource overhead when using {integrations-docs}/endpoint[{elastic-defend}].
[options,header]
|===
| **CPU** | Under 2% total, including all monitoring processes
| **RSS memory size** | 400 MB
| **Resource** | **Throughput** | **Scale**
| **CPU*** | ~67% total | ~20%
| **RSS memory size*** | ~280 MB | ~220 MB
| **Write network throughput** | ~3.5 MB/s | 480 KB/s
|===

^*^ including all monitoring processes

Adding integrations will increase the memory used by the agent and its processes.

[discrete]
Expand Down

0 comments on commit 35557a4

Please sign in to comment.