- Packetbeat Reference: other versions:
- Packetbeat overview
- Quick start: installation and configuration
- Set up and run
- Upgrade Packetbeat
- Configure
- Traffic sniffing
- Network flows
- Protocols
- Processes
- General settings
- Project paths
- Output
- Kerberos
- SSL
- Index lifecycle management (ILM)
- Elasticsearch index template
- Kibana endpoint
- Kibana dashboards
- Processors
- Define processors
- add_cloud_metadata
- add_cloudfoundry_metadata
- add_docker_metadata
- add_fields
- add_host_metadata
- add_id
- add_kubernetes_metadata
- add_labels
- add_locale
- add_observer_metadata
- add_process_metadata
- add_tags
- community_id
- convert
- copy_fields
- decode_base64_field
- decode_json_fields
- decompress_gzip_field
- dissect
- dns
- drop_event
- drop_fields
- extract_array
- fingerprint
- include_fields
- registered_domain
- rename
- translate_sid
- truncate_fields
- urldecode
- Internal queue
- Logging
- HTTP endpoint
- Instrumentation
- packetbeat.reference.yml
- How to guides
- Exported fields
- AMQP fields
- Beat fields
- Cassandra fields
- Cloud provider metadata fields
- Common fields
- DHCPv4 fields
- DNS fields
- Docker fields
- ECS fields
- Flow Event fields
- Host fields
- HTTP fields
- ICMP fields
- Jolokia Discovery autodiscover provider fields
- Kubernetes fields
- Memcache fields
- MongoDb fields
- MySQL fields
- NFS fields
- PostgreSQL fields
- Process fields
- Raw fields
- Redis fields
- Thrift-RPC fields
- Detailed TLS fields
- Transaction Event fields
- Measurements (Transactions) fields
- Monitor
- Secure
- Visualize Packetbeat data in Kibana
- Troubleshoot
- Get help
- Debug
- Record a trace
- Common problems
- Dashboard in Kibana is breaking up data fields incorrectly
- Packetbeat doesn’t see any packets when using mirror ports
- Packetbeat can’t capture traffic from Windows loopback interface
- Packetbeat is missing long running transactions
- Packetbeat isn’t capturing MySQL performance data
- Packetbeat uses too much bandwidth
- Error loading config file
- Found unexpected or unknown characters
- Logstash connection doesn’t work
- Publishing to Logstash fails with "connection reset by peer" message
- @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
- Dashboard could not locate the index-pattern
- Fields show up as nested JSON in Kibana
- Contribute to Beats
Configure index lifecycle management
editConfigure index lifecycle management
editUse the index lifecycle management (ILM) feature in Elasticsearch to manage your Packetbeat 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, Packetbeat uses index lifecycle management by default when it connects to a cluster that supports lifecycle management. Packetbeat loads the default policy automatically and applies it to any indices created by Packetbeat.
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:
Date math is supported here. For more information, see Using date math with the rollover API. |
If index lifecycle management is enabled (which is typically the default), setup.template.name
and setup.template.pattern
are ignored.
Configuration options
editYou can specify the following settings in the setup.ilm
section of the
packetbeat.yml
config file:
setup.ilm.enabled
editEnables or disables index lifecycle management on any new indices created by
Packetbeat. Valid values are true
, false
, and auto
. When auto
(the
default) is specified on version 7.0 and later, Packetbeat automatically uses
index lifecycle management if the feature is enabled in Elasticsearch and has the
required license; otherwise, Packetbeat creates daily indices.
setup.ilm.rollover_alias
editThe index lifecycle write alias name. The default is
packetbeat-%{[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
packetbeat
.
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 Packetbeat
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