- Functionbeat Reference:
- Functionbeat overview
- Quick start: installation and configuration
- Set up and deploy
- Configure
- AWS functions
- General settings
- Output
- Kerberos
- SSL
- Index lifecycle management (ILM)
- Elasticsearch index template
- 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_network_direction
- add_nomad_metadata
- add_observer_metadata
- add_process_metadata
- add_tags
- append
- community_id
- convert
- copy_fields
- decode_base64_field
- decode_duration
- decode_json_fields
- decode_xml
- decode_xml_wineventlog
- decompress_gzip_field
- detect_mime_type
- dissect
- dns
- drop_event
- drop_fields
- extract_array
- fingerprint
- include_fields
- move_fields
- rate_limit
- registered_domain
- rename
- replace
- syslog
- translate_sid
- truncate_fields
- urldecode
- Internal queue
- Logging
- Regular expression support
- Instrumentation
- functionbeat.reference.yml
- How to guides
- Exported fields
- Monitor
- Secure
- Troubleshoot
- Get help
- Debug
- Understand logged metrics
- 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
- 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
- High RSS memory usage due to MADV settings
Functionbeat reached End of Support on October 18, 2023. You must consider
moving your deployments to the more versatile and efficient Elastic Serverless
Forwarder.
Add fields
editAdd fields
editThe add_fields
processor adds additional fields to the event. Fields can be
scalar values, arrays, dictionaries, or any nested combination of these.
The add_fields
processor will overwrite the target field if it already exists.
By default the fields that you specify will be grouped under the fields
sub-dictionary in the event. To group the fields under a different
sub-dictionary, use the target
setting. To store the fields as
top-level fields, set target: ''
.
-
target
-
(Optional) Sub-dictionary to put all fields into. Defaults to
fields
. Setting this to@metadata
will add values to the event metadata instead of fields. -
fields
- Fields to be added.
For example, this configuration:
processors: - add_fields: target: project fields: name: myproject id: '574734885120952459'
Adds these fields to any event:
{ "project": { "name": "myproject", "id": "574734885120952459" } }
This configuration will alter the event metadata:
processors: - add_fields: target: '@metadata' fields: op_type: "index"
When the event is ingested (e.g. by Elastisearch) the document will have op_type: "index"
set as a metadata field.
Was this helpful?
Thank you for your feedback.