- Filebeat Reference: other versions:
- Overview
- Getting Started With Filebeat
- Step 1: Install Filebeat
- Step 2: Configure Filebeat
- Step 3: Configure Filebeat to use Logstash
- Step 4: Load the index template in Elasticsearch
- Step 5: Set up the Kibana dashboards
- Step 6: Start Filebeat
- Step 7: View the sample Kibana dashboards
- Quick start: modules for common log formats
- Repositories for APT and YUM
- Setting up and running Filebeat
- Upgrading Filebeat
- How Filebeat works
- Configuring Filebeat
- Specify which modules to run
- Configure inputs
- Manage multiline messages
- Specify general settings
- Load external configuration files
- Configure the internal queue
- Configure the output
- Set up index lifecycle management
- Load balance the output hosts
- Specify SSL settings
- Filter and enhance the exported data
- Parse data by using ingest node
- Set up project paths
- Set up the Kibana endpoint
- Load the Kibana dashboards
- Load the Elasticsearch index template
- Configure logging
- Use environment variables in the configuration
- Autodiscover
- YAML tips and gotchas
- Regular expression support
- HTTP Endpoint
- filebeat.reference.yml
- Beats central management
- Modules
- Exported fields
- Alias fields
- Apache2 fields
- Auditd fields
- Beat fields
- Cloud provider metadata fields
- Docker fields
- elasticsearch fields
- haproxy fields
- Host fields
- Icinga fields
- IIS fields
- Kafka fields
- kibana fields
- Kubernetes fields
- Log file content fields
- logstash fields
- mongodb fields
- MySQL fields
- Nginx fields
- Osquery fields
- PostgreSQL fields
- Redis fields
- System fields
- Traefik fields
- Monitoring Filebeat
- Securing Filebeat
- Troubleshooting
- Migrating from Logstash Forwarder to Filebeat
- Contributing to Beats
Enroll Beats in central management
editEnroll Beats in central management
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.
You need to enroll Beats to register them in central management and establish trust. Enrolled Beats will have the credentials needed to retrieve configurations from Kibana.
During the enrollment process:
- The Beat contacts Kibana and tries to register
- Kibana registers the Beat instance and returns an access token for configuration polling
- The enroll command creates a backup of your configuration and then overwrites the current settings so they can be managed centrally
To enroll Beats, use either token-based or username and password-based enrollment.
Prerequisites
edit-
Verify that your Elastic license includes the Beats central management feature.
Don’t have a license? You can start a 30-day trial. At the end of the trial period, you can purchase a subscription to keep using central management. For more information, see https://www.elastic.co/subscriptions and License Management.
- Enable security in Kibana to ensure that only users with sufficient privileges are able to access Beats configurations.
-
Assign the
beats_adminrole to any users who need to enroll Beats or manage configuration settings in central management. - If you plan to use the sample Kibana dashboards provided with Filebeat, load the dashboards before enrolling the Beat.
- If you plan to define module configurations in central management, set up the ingest pipelines before enrolling the Beat. For more information, see Load ingest pipelines manually.
Token-based enrollment
editToken-based enrollment is recommended if you are enrolling Beats manually.
To use token-based enrollment, go to Kibana → Management → Beats and click
Enroll Beat. Select the Beat type and operating system, then copy and run the
command for enrolling the Beat.
The command has this format:
filebeat enroll KIBANA_URL TOKEN
-
KIBANA_URL - The URL of the Kibana instance you will use for central management.
-
TOKEN - The enrollment token generated by the Central Management UI. The enrollment token will expire as soon as it’s used.
For example:
filebeat enroll http://xyz.gov:5601 70f4b584e8024b96b682c46125a8d81
Repeat this process to enroll additional Beats.
Windows users: If you installed Filebeat as a service, you must also set
-path.data to "C:\ProgramData\filebeat" when you
run the enroll command. For example:
.\filebeat.exe enroll http://xyz.gov:5601 70f4b584e8024b96b682c46125a8d81a
-path.data "C:\ProgramData\filebeat"
Why? The service installation script, install-service-filebeat.ps1,
changes the default data path to match the convention used for Windows. If you
run the enroll command without specifying the correct data path, Filebeat
will be enrolled in central management with the wrong UUID and unable to receive
the configuration.
Username and password-based enrollment
editYou can also enroll by specifying a username and password. This is the recommended way for scripted deploys:
filebeat enroll KIBANA_URL --username USER --password METHOD [--force]
-
--username USER -
The username to use for password-based enrollment. The default
username is
elastic. -
--password METHOD -
The method to use for getting the password. Available options are:
-
env:VAR_NAMEgets the password from the environment variableVAR_NAME -
stdinprompts the user for a password. This is the default.
-
-
--force - Overwrites the current settings without asking for confirmation.
For example:
filebeat enroll http://xyz.gov:5601 --username myuser --password stdin
Windows users: If you installed Filebeat as a service, you must also set
-path.data to "C:\ProgramData\filebeat" when you
run the enroll command. For example:
.\filebeat.exe enroll http://xyz.gov:5601 --username myuser --password stdin
-path.data "C:\ProgramData\filebeat"
Why? The service installation script, install-service-filebeat.ps1,
changes the default data path to match the convention used for Windows. If you
run the enroll command without specifying the correct data path, Filebeat
will be enrolled in central management with the wrong UUID and unable to receive
the configuration.