- Functionbeat Reference:
- Overview
- Getting Started With Functionbeat
- Setting up and deploying Functionbeat
- Configuring Functionbeat
- Configure functions
- Specify general settings
- 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 Docker metadata
- Add fields
- Add Host metadata
- Add Kubernetes metadata
- Add labels
- Add the local time zone
- Add Observer metadata
- Add process metadata
- Add tags
- Community ID Network Flow Hash
- Convert
- Decode Base64 fields
- Decode JSON fields
- Decompress gzip fields
- Dissect strings
- DNS Reverse Lookup
- Drop events
- Drop fields from events
- Extract array
- Keep fields from events
- Registered Domain
- Rename fields from events
- Parse data by using ingest node
- Enrich events with geoIP information
- Configure the Kibana endpoint
- Load the Elasticsearch index template
- Configure logging
- Use environment variables in the configuration
- YAML tips and gotchas
- Regular expression support
- functionbeat.reference.yml
- Exported fields
- Monitoring Functionbeat
- Securing Functionbeat
- Troubleshooting
- Get help
- Debug
- Common problems
- Deployment to AWS fails with "failed to create the stack"
- Deployment to AWS fails with "resource limit exceeded"
- Error loading config file
- Found unexpected or unknown characters
- Logstash connection doesn’t work
- @metadata is missing in Logstash
- Not sure whether to use Logstash or Beats
- SSL client fails to connect to Logstash
- Monitoring UI shows fewer Beats than expected
Configure index lifecycle management
editConfigure index lifecycle management
editUse the index lifecycle management feature in Elasticsearch to manage your Functionbeat indices as they age. For example, instead of creating daily indices where index size can vary based on the number of Beats and number of events sent, use an index lifecycle policy to automate a rollover to a new index when the existing index reaches a specified size or age.
Starting with version 7.0, Functionbeat uses index lifecycle management by default when it connects to a cluster that supports lifecycle management. Functionbeat loads the default policy automatically and applies it to any indices created by Functionbeat.
You can view and edit the policy in the Index lifecycle policies UI in Kibana. For more information about working with the UI, see Index lifecyle policies.
Example configuration:
setup.ilm.enabled: auto setup.ilm.rollover_alias: "functionbeat" setup.ilm.pattern: "{now/d}-000001"
Date math is supported here. For more information, see Using date math with the rollover API. |
Configuration options
editYou can specify the following settings in the setup.ilm
section of the
functionbeat.yml
config file:
setup.ilm.enabled
editEnables or disables index lifecycle management on any new indices created by
Functionbeat. Valid values are true
, false
, and auto
. When auto
(the
default) is specified on version 7.0 and later, Functionbeat automatically uses
index lifecycle management if the feature is enabled in Elasticsearch and has the
required license; otherwise, Functionbeat creates daily indices.
setup.ilm.rollover_alias
editThe index lifecycle write alias name. The default is
functionbeat-%{[agent.version]}
. Setting this option changes the alias name.
If you modify this setting after loading the index template, you must overwrite the template to apply the changes.
setup.ilm.pattern
editThe rollover index pattern. The default is %{now/d}-000001
.
Date math is supported in this setting. For example:
setup.ilm.pattern: "{now/M{YYYY.MM}}-000001"
For more information, see Using date math with the rollover API.
If you modify this setting after loading the index template, you must overwrite the template to apply the changes.
setup.ilm.policy_name
editThe name to use for the lifecycle policy. The default is
functionbeat-%{[agent.version]}
.
setup.ilm.policy_file
editThe path to a JSON file that contains a lifecycle policy configuration. Use this setting to load your own lifecycle policy.
For more information about lifecycle policies, see Set up index lifecycle management policy in the Elasticsearch Reference.
setup.ilm.check_exists
editWhen set to false
, disables the check for an existing lifecycle policy. The
default is true
. You need to disable this check if the Functionbeat
user connecting to a secured cluster doesn’t have the read_ilm
privilege.
If you set this option to false
, set setup.ilm.overwrite: true
so the
lifecycle policy can be installed.
setup.ilm.overwrite
editWhen set to true
, the lifecycle policy is overwritten at startup. The default
is false
.
On this page