Bytes filter plugin

• Plugin version: v1.0.3
• Released on: 2020-08-18
• Changelog

For other versions, see the Versioned plugin docs.

For plugins not bundled by default, it is easy to install by running bin/logstash-plugin install logstash-filter-bytes. See Working with plugins for more details.

For questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github. For the list of Elastic supported plugins, please consult the Elastic Support Matrix.

Parse string representations of computer storage sizes, such as "123 MB" or "5.6gb", into their numeric value in bytes.

This plugin understands:

• bytes ("B")
• kilobytes ("KB" or "kB")
• megabytes ("MB", "mb", or "mB")
• gigabytes ("GB", "gb", or "gB")
• terabytes ("TB", "tb", or "tB")
• petabytes ("PB", "pb", or "pB")

filter {
  bytes {
    source => "my_bytes_string_field"
    target => "my_bytes_numeric_field"
  }
}

This plugin supports the following configuration options plus the Common options described later.

Also see Common options for a list of options supported by all filter plugins.

• Value type is string
• Default value is message

Name of the source field that contains the storage size

• Value type is string

Name of the target field that will contain the storage size in bytes

• Value type is string
• Value can be any of: binary, metric
• Default value is binary

Which conversion method to use when converting to bytes. binary uses 1K = 1024B. metric uses 1K = 1000B.

• Value type is string
• Default value is .

Separator, if any, used as the decimal. This value is only used if the plugin cannot guess the decimal separator by looking at the string in the source field.

These configuration options are supported by all filter plugins:

• Value type is hash
• Default value is {}

If this filter is successful, add any arbitrary fields to this event. Field names can be dynamic and include parts of the event using the %{{field}}.

Example:

filter {
  bytes {
    add_field => { "foo_%{somefield}" => "Hello world, from %{host}" }
  }
}

# You can also add multiple fields at once:
filter {
  bytes {
    add_field => {
      "foo_%{somefield}" => "Hello world, from %{host}"
      "new_field" => "new_static_value"
    }
  }
}

If the event has field "somefield" == "hello" this filter, on success, would add field foo_hello if it is present, with the value above and the %{{host}} piece replaced with that value from the event. The second example would also add a hardcoded field.

• Value type is array
• Default value is []

If this filter is successful, add arbitrary tags to the event. Tags can be dynamic and include parts of the event using the %{{field}} syntax.

Example:

filter {
  bytes {
    add_tag => [ "foo_%{somefield}" ]
  }
}

# You can also add multiple tags at once:
filter {
  bytes {
    add_tag => [ "foo_%{somefield}", "taggedy_tag"]
  }
}

If the event has field "somefield" == "hello" this filter, on success, would add a tag foo_hello (and the second example would of course add a taggedy_tag tag).

• Value type is boolean
• Default value is true

Disable or enable metric logging for this specific plugin instance. By default we record all the metrics we can, but you can disable metrics collection for a specific plugin.

• Value type is string
• There is no default value for this setting.

Add a unique ID to the plugin configuration. If no ID is specified, Logstash will generate one. It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 bytes filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

filter {
  bytes {
    id => "ABC"
  }
}

• Value type is boolean
• Default value is false

Call the filter flush method at regular interval. Optional.

• Value type is array
• Default value is []

If this filter is successful, remove arbitrary fields from this event. Fields names can be dynamic and include parts of the event using the %{{field}} Example:

filter {
  bytes {
    remove_field => [ "foo_%{somefield}" ]
  }
}

# You can also remove multiple fields at once:
filter {
  bytes {
    remove_field => [ "foo_%{somefield}", "my_extraneous_field" ]
  }
}

If the event has field "somefield" == "hello" this filter, on success, would remove the field with name foo_hello if it is present. The second example would remove an additional, non-dynamic field.

• Value type is array
• Default value is []

If this filter is successful, remove arbitrary tags from the event. Tags can be dynamic and include parts of the event using the %{{field}} syntax.

Example:

filter {
  bytes {
    remove_tag => [ "foo_%{somefield}" ]
  }
}

# You can also remove multiple tags at once:
filter {
  bytes {
    remove_tag => [ "foo_%{somefield}", "sad_unwanted_tag"]
  }
}

If the event has field "somefield" == "hello" this filter, on success, would remove the tag foo_hello if it is present. The second example would remove a sad, unwanted tag as well.