Back to Elasticsearch

Bytes processor [bytes-processor]

docs/reference/enrich-processor/bytes-processor.md

9.4.01.6 KB
Original Source

Bytes processor [bytes-processor]

Converts a human readable byte value (e.g. 1kb) to its value in bytes (e.g. 1024). If the field is an array of strings, all members of the array will be converted.

Supported human readable units are "b", "kb", "mb", "gb", "tb", "pb" case insensitive. An error will occur if the field is not a supported format or resultant value exceeds 2^63.

$$$bytes-options$$$

NameRequiredDefaultDescription
fieldyes-The field to convert
target_fieldnofieldThe field to assign the converted value to, by default field is updated in-place
ignore_missingnofalseIf true and field does not exist or is null, the processor quietly exits without modifying the document
descriptionno-Description of the processor. Useful for describing the purpose of the processor or its configuration.
ifno-Conditionally execute the processor. See Conditionally run a processor.
ignore_failurenofalseIgnore failures for the processor. See Handling pipeline failures.
on_failureno-Handle failures for the processor. See Handling pipeline failures.
tagno-Identifier for the processor. Useful for debugging and metrics.
js
{
  "bytes": {
    "field": "file.size"
  }
}

% NOTCONSOLE