- Auditbeat Reference: other versions:
- Overview
- Getting started with Auditbeat
- Setting up and running Auditbeat
- Upgrading Auditbeat
- Configuring Auditbeat
- Specify which modules to run
- Specify general settings
- Reload the configuration dynamically
- Configure the internal queue
- Configure the output
- Configure index lifecycle management
- Specify SSL settings
- Filter and enhance the exported data
- Define processors
- Add cloud metadata
- Add fields
- Add labels
- Add the local time zone
- Add tags
- Decode JSON fields
- Drop events
- Drop fields from events
- Keep fields from events
- Rename fields from events
- Add Kubernetes metadata
- Add Docker metadata
- Add Host metadata
- Dissect strings
- DNS Reverse Lookup
- Add process metadata
- Parse data by using ingest node
- Enrich events with geoIP information
- Configure project paths
- Configure the Kibana endpoint
- Load the Kibana dashboards
- Load the Elasticsearch index template
- Configure logging
- Use environment variables in the configuration
- YAML tips and gotchas
- Regular expression support
- HTTP Endpoint
- auditbeat.reference.yml
- Modules
- Exported fields
- Monitoring Auditbeat
- Securing Auditbeat
- Troubleshooting
- Contributing to Beats
Step 1: Install Auditbeat
editStep 1: Install Auditbeat
editInstall Auditbeat on all the servers you want to monitor.
Before you begin: If you haven’t installed the Elastic Stack, do that now. See Getting started with the Elastic Stack.
To download and install Auditbeat, use the commands that work with your system.
If you use Apt or Yum, you can install Auditbeat from our repositories to update to the newest version more easily.
See our download page for other installation options, such as 32-bit images.
curl -L -O https://artifacts.elastic.co/downloads/beats/auditbeat/auditbeat-7.1.1-amd64.deb sudo dpkg -i auditbeat-7.1.1-amd64.deb
curl -L -O https://artifacts.elastic.co/downloads/beats/auditbeat/auditbeat-7.1.1-x86_64.rpm sudo rpm -vi auditbeat-7.1.1-x86_64.rpm
curl -L -O https://artifacts.elastic.co/downloads/beats/auditbeat/auditbeat-7.1.1-darwin-x86_64.tar.gz tar xzvf auditbeat-7.1.1-darwin-x86_64.tar.gz
brew tap elastic/tap brew install elastic/tap/auditbeat-full
This installs the most recently released default distribution of Auditbeat.
To install the OSS distribution, specify elastic/tap/auditbeat-oss.
curl -L -O https://artifacts.elastic.co/downloads/beats/auditbeat/auditbeat-7.1.1-linux-x86_64.tar.gz tar xzvf auditbeat-7.1.1-linux-x86_64.tar.gz
curl -L -O https://artifacts.elastic.co/downloads/beats/auditbeat/auditbeat-7.1.1-linux-x86_64.tar.gz tar xzvf auditbeat-7.1.1-linux-x86_64.tar.gz
See Running on Docker for deploying Docker containers.
- Download the Auditbeat Windows zip file from the downloads page.
-
Extract the contents of the zip file into
C:\Program Files. -
Rename the
auditbeat-<version>-windowsdirectory toAuditbeat. - Open a PowerShell prompt as an Administrator (right-click the PowerShell icon and select Run As Administrator).
-
From the PowerShell prompt, run the following commands to install Auditbeat as a Windows service:
PS > cd 'C:\Program Files\Auditbeat' PS C:\Program Files\Auditbeat> .\install-service-auditbeat.ps1
If script execution is disabled on your system, you need to set the
execution policy for the current session to allow the script to run. For
example: PowerShell.exe -ExecutionPolicy UnRestricted -File
.\install-service-auditbeat.ps1.
Before starting Auditbeat, you should look at the configuration options in the
configuration file, for example C:\Program Files\Auditbeat\auditbeat.yml.
For more information about these options, see
Configuring Auditbeat.