rename_keys

Overview

The rename_keys processor renames keys in an event and is a mutate event processor. The following table describes the options you can use to configure the rename_keys processor.

OptionRequiredTypeDescription
entriesYesListList of entries. Valid values are from_key, to_key, and overwrite_if_key_exists. Renaming occurs in the order defined.
from_keyN/AN/AThe key of the entry to be renamed.
to_keyN/AN/AThe new key of the entry.
overwrite_if_to_key_existsNoBooleanIf true, the existing value gets overwritten if to_key already exists in the event.