- 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
- 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
- filebeat.reference.yml
- Modules
- Exported fields
- Apache2 fields
- Auditd fields
- Beat fields
- Cloud provider metadata fields
- Docker fields
- Host fields
- Icinga fields
- IIS fields
- Kafka 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
Rename fields from events
editRename fields from events
editThe rename
processor specifies a list of fields to rename. Under the fields
key each entry contains a from: old-key
and a to: new-key
pair. from
is
the origin and to
the target name of the field.
Renaming fields can be useful in cases where field names cause conflicts. For
example if an event has two fields, c
and c.b
, that are both assigned scalar
values (e.g. {"c": 1, "c.b": 2}
) this will result in an Elasticsearch error at
ingest time. This is because the value of a cannot simultaneously be a scalar
and an object. To prevent this rename_fields can be used to rename c
to
c.value
.
Rename fields cannot be used to overwrite fields. To overwrite fields either
first rename the target field or use the drop_fields
processor to drop the
field and then rename the field.
processors: - rename: fields: - from: "a.g" to: "e.d" ignore_missing: false fail_on_error: true
The rename
processor has the following configuration settings:
-
ignore_missing
-
(Optional) If set to true, no error is logged in case a key
which should be renamed is missing. Default is
false
. -
fail_on_error
-
(Optional) If set to true, in case of an error the renaming of
fields is stopped and the original event is returned. If set to false, renaming
continues also if an error happened during renaming. Default is
true
.
See Conditions for a list of supported conditions.
You can specify multiple ignore_missing
processors under the processors
section.