Rename processor

Renames an existing field. If the field doesn’t exist or the new name is already used, an exception will be thrown.

Table 30. Rename Options

NameRequiredDefaultDescription

field

yes

-

The field to be renamed. Supports template snippets.

target_field

yes

-

The new name of the field. Supports template snippets.

ignore_missing

no

false

If true and field does not exist, the processor quietly exits without modifying the document

if

no

-

Conditionally execute this processor.

on_failure

no

-

Handle failures for this processor. See Handling Failures in Pipelines.

ignore_failure

no

false

Ignore failures for this processor. See Handling Failures in Pipelines.

tag

no

-

An identifier for this processor. Useful for debugging and metrics.

  1. {
  2. "rename": {
  3. "field": "provider",
  4. "target_field": "cloud.provider"
  5. }
  6. }