WARNING: Version 5.6 of Elasticsearch has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

› › ›

Gsub Processor

edit

Gsub Processor

edit

Converts a string field by applying a regular expression and a replacement. If the field is not a string, the processor will throw an exception.

Table 21. Gsub Options

Name	Required	Default	Description
`field`	yes	-	The field to apply the replacement to
`pattern`	yes	-	The pattern to be replaced
`replacement`	yes	-	The string to replace the matching patterns with
`target_field`	no	`field`	The field to assign the converted value to, by default `field` is updated in-place
`ignore_missing`	no	`false`	If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document

{
  "gsub": {
    "field": "field1",
    "pattern": "\.",
    "replacement": "-"
  }
}

« Grok Processor Join Processor »