› › ›

Gsub processor

Converts a string field by applying a regular expression and a replacement. If the field is an array of string, all members of the array will be converted. If any non-string values are encountered, the processor will throw an exception.

Table 25. 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
`description`	no	-	Description of the processor. Useful for describing the purpose of the processor or its configuration.
`if`	no	-	Conditionally execute the processor. See Conditionally run a processor.
`ignore_failure`	no	`false`	Ignore failures for the processor. See Handling pipeline failures.
`on_failure`	no	-	Handle failures for the processor. See Handling pipeline failures.
`tag`	no	-	Identifier for the processor. Useful for debugging and metrics.

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

« Grok processor HTML strip processor »