How to Use Set Processor in Elasticsearch Pipelines

Use the set processor in an Elasticsearch ingest pipeline to add or update a field's value in documents before indexing. Define the field to set and the value to assign inside the pipeline's processors array.

Syntax

The set processor syntax includes specifying the field to modify and the value to assign. It is used inside an ingest pipeline's processors array.

• field: The name of the field to add or update.
• value: The value to assign to the field.

json

{
  "set": {
    "field": "field_name",
    "value": "value_to_set"
  }
}

Example

This example creates an ingest pipeline that sets the field status to active for all incoming documents.

json

{
  "description": "Set status field to active",
  "processors": [
    {
      "set": {
        "field": "status",
        "value": "active"
      }
    }
  ]
}

Output

{
  "acknowledged": true
}

Common Pitfalls

Common mistakes when using the set processor include:

• Not specifying the field or value keys correctly.
• Using a field path that does not exist or is misspelled.
• Expecting the set processor to append values instead of replacing them.

Always ensure the pipeline is correctly attached to the index or document ingestion process.

json

{
  "set": {
    "field_name": "status",  
    "value": "active"
  }
}

// Correct usage:
{
  "set": {
    "field": "status",
    "value": "active"
  }
}

Quick Reference

Property	Description
field	The field name to set or update
value	The value to assign to the field
override	Optional boolean to allow overwriting existing field (default true)

Key Takeaways

The set processor adds or updates a field's value in documents during ingestion.

Specify the field name and value clearly inside the set processor configuration.

The set processor replaces existing values; it does not append.

Attach the pipeline using the set processor to your index or document ingestion process.

Check for correct field paths and spelling to avoid errors.