Install Elastic Agent and enroll it in Fleet
editInstall Elastic Agent and enroll it in Fleet
editThis functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
Install an Elastic Agent on each host that you want to monitor. These steps assume that you’re running a fresh installation. If Elastic Agent is already running on your system and you want to upgrade to a new version, see Upgrade Elastic Agent.
Before running the installation, decide whether you want to use Fleet to manage your agents in a central location in Kibana (recommended), or run standalone agents.
With Fleet, you enroll each agent in a policy defined in Kibana. The policy specifies how to collect observability data from the services you want to monitor. The agent connects to a trusted Kibana instance to retrieve the policy and report agent events.
We recommend using Fleet management because it makes the management and upgrade of your agents considerably easier. If you want to run standalone agents, instead of using Fleet, see Run Elastic Agent standalone (advanced users).
To install Elastic Agent and enroll it in Fleet:
- If you’re running Elastic Agent 7.9 or earlier, stop the agent and manually remove it from your host.
-
On your host, download and extract the installation package.
curl -L -O https://artifacts.elastic.co/downloads/beats/elastic-agent/elastic-agent-7.12.1-darwin-x86_64.tar.gz tar xzvf elastic-agent-7.12.1-darwin-x86_64.tar.gz
curl -L -O https://artifacts.elastic.co/downloads/beats/elastic-agent/elastic-agent-7.12.1-linux-x86_64.tar.gz tar xzvf elastic-agent-7.12.1-linux-x86_64.tar.gz
- Download the Elastic Agent Windows zip file from the downloads page.
- Extract the contents of the zip file.
To simplify upgrading to future versions of Elastic Agent, we recommended that you use the tarball distribution instead of the DEB distribution.
curl -L -O https://artifacts.elastic.co/downloads/beats/elastic-agent/elastic-agent-7.12.1-amd64.deb sudo dpkg -i elastic-agent-7.12.1-amd64.deb
To simplify upgrading to future versions of Elastic Agent, we recommended that you use the tarball distribution instead of the RPM distribution.
curl -L -O https://artifacts.elastic.co/downloads/beats/elastic-agent/elastic-agent-7.12.1-x86_64.rpm sudo rpm -vi elastic-agent-7.12.1-x86_64.rpm
-
From the agent directory, run the appropriate command to install Elastic Agent as a managed service, enroll it in Fleet, and start the service. Don’t have a Fleet enrollment key? Read the Quick start guide to learn how to get one from Fleet.
You must run this command as the root user because some integrations require root privileges to collect sensitive data.
You must run this command as the root user because some integrations require root privileges to collect sensitive data.
Open a PowerShell prompt as an Administrator (right-click the PowerShell icon and select Run As Administrator).
From the PowerShell prompt, change to the directory where you installed Elastic Agent, and run:
You must run this command as the root user because some integrations require root privileges to collect sensitive data.
sudo elastic-agent enroll --kibana-url=<kibana_url> --enrollment-token=<enrollment_token> sudo systemctl enable elastic-agent sudo systemctl start elastic-agent
kibana_url
is the Kibana URL where Fleet is running, andenrollment_token
is the enrollment token acquired from Fleet.The DEB package includes a service unit for Linux systems with systemd. On these systems, you can manage Elastic Agent by using the usual systemd commands. If you don’t have systemd, run
sudo service elastic-agent start
.You must run this command as the root user because some integrations require root privileges to collect sensitive data.
sudo elastic-agent enroll --kibana-url=<kibana_url> --enrollment-token=<enrollment_token> sudo systemctl enable elastic-agent sudo systemctl start elastic-agent
kibana_url
is the Kibana URL where Fleet is running, andenrollment_token
is the enrollment token acquired from Fleet.The RPM package includes a service unit for Linux systems with systemd. On these systems, you can manage Elastic Agent by using the usual systemd commands. If you don’t have systemd, run
sudo service elastic-agent start
.This step installs the Elastic Agent files into the directory locations described in Installation layout.
Because Elastic Agent is installed as an auto-starting service, it will restart automatically if the system is rebooted.
To confirm that Elastic Agent is installed and running, go to the Agents tab in Fleet.
If you run into problems, see Troubleshoot common problems.
Installation layout
editWhen you run the install
command, Elastic Agent installs files in the following
locations. You cannot override these installation paths because they are
required for upgrades.
-
/Library/Elastic/Agent/*
- Elastic Agent program files
-
/Library/Elastic/Agent/elastic-agent.yml
- Main Elastic Agent configuration
-
/Library/Elastic/Agent/fleet.yml
- Main Elastic Agent Fleet configuration
-
/Library/Elastic/Agent/data/elastic-agent-*/logs/elastic-agent-json.log
- Log files for Elastic Agent[1]
-
/Library/Elastic/Agent/data/elastic-agent-*/logs/default/*-json.log
- Log files for Beats shippers
-
/usr/bin/elastic-agent
- Shell wrapper installed into PATH
-
/opt/Elastic/Agent/*
- Elastic Agent program files
-
/opt/Elastic/Agent/elastic-agent.yml
- Main Elastic Agent configuration
-
/opt/Elastic/Agent/fleet.yml
- Main Elastic Agent Fleet configuration
-
/opt/Elastic/Agent/data/elastic-agent-*/logs/elastic-agent-json.log
- Log files for Elastic Agent[1]
-
/opt/Elastic/Agent/data/elastic-agent-*/logs/default/*-json.log
- Log files for Beats shippers
-
/usr/bin/elastic-agent
- Shell wrapper installed into PATH
-
C:\Program/ Files\Elastic\Agent*
- Elastic Agent program files
-
C:\Program/ Files\Elastic\Agent\elastic-agent.yml
- Main Elastic Agent configuration
-
C:\Program/ Files\Elastic\Agent\fleet.yml
- Main Elastic Agent Fleet configuration
-
C:\Program/ Files\Elastic\Agent\data\elastic-agent-*\logs\elastic-agent-json.log
- Log files for Elastic Agent[1]
-
C:\Program/ Files\Elastic\Agent\data\elastic-agent-*\logs\default\*-json.log*
- Log files for Beats shippers
-
/usr/share/elastic-agent/*
- Elastic Agent program files
-
/etc/elastic-agent/elastic-agent.yml
- Main Elastic Agent configuration
-
/etc/elastic-agent/fleet.yml
- Main Elastic Agent Fleet configuration
-
/var/lib/elastic-agent/data/elastic-agent-*/logs/elastic-agent-json.log
- Log files for Elastic Agent[1]
-
/var/lib/elastic-agent/data/elastic-agent-*/logs/default/*-json.log*
- Log files for Beats shippers
-
/usr/bin/elastic-agent
- Shell wrapper installed into PATH
-
/usr/share/elastic-agent/*
- Elastic Agent program files
-
/etc/elastic-agent/elastic-agent.yml
- Main Elastic Agent configuration
-
/etc/elastic-agent/fleet.yml
- Main Elastic Agent Fleet configuration
-
/var/lib/elastic-agent/data/elastic-agent-*/logs/elastic-agent-json.log
- Log files for Elastic Agent[1]
-
/var/lib/elastic-agent/data/elastic-agent-*/logs/default/*-json.log*
- Log files for Beats shippers
-
/usr/bin/elastic-agent
- Shell wrapper installed into PATH