IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Convert
editConvert
editThe convert
processor converts a field in the event to a different type, such
as converting a string to an integer.
The supported types include: integer
, long
, float
, double
, string
,
boolean
, and ip
.
The ip
type is effectively an alias for string
, but with an added validation
that the value is an IPv4 or IPv6 address.
processors: - convert: fields: - {from: "src_ip", to: "source.ip", type: "ip"} - {from: "src_port", to: "source.port", type: "integer"} ignore_missing: true fail_on_error: false
The convert
processor has the following configuration settings:
-
fields
-
(Required) This is the list of fields to convert. At least one item
must be contained in the list. Each item in the list must have a
from
key that specifies the source field. Theto
key is optional and specifies where to assign the converted value. Ifto
is omitted then thefrom
field is updated in-place. Thetype
key specifies the data type to convert the value to. Iftype
is omitted then the processor copies or renames the field without any type conversion. -
ignore_missing
-
(Optional) If
true
the processor continues to the next field when thefrom
key is not found in the event. If false then the processor returns an error and does not process the remaining fields. Default isfalse
. -
fail_on_error
-
(Optional) If false type conversion failures are ignored and
the processor continues to the next field. Default is
true
. -
tag
- (Optional) An identifier for this processor. Useful for debugging.
-
mode
-
(Optional) When both
from
andto
are defined for a field thenmode
controls whether tocopy
orrename
the field when the type conversion is successful. Default iscopy
.