Bytes filter plugin

edit
  • Plugin version: v1.0.2
  • Released on: 2018-06-04
  • Changelog

For other versions, see the Versioned plugin docs.

Installation

edit

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.

Getting Help

edit

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.

Description

edit

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")

Examples

edit
Input string Conversion method

Numeric value in bytes

40

binary or metric

40

40B

binary or metric

40

40 B

binary or metric

40

40KB

binary

40960

40kB

binary

40960

40KB

metric

40000

40.5KB

binary

41472

40kb

binary

5120

40Kb

binary

5120

10 MB

binary

10485760

10 mB

binary

10485760

10 mb

binary

10485760

10 Mb

binary

1310720

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

Bytes Filter Configuration Options

edit

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

Setting Input type Required

source

string

No

target

string

Yes

conversion_method

string

No

source

string

No

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

 

source

edit
  • Value type is string
  • Default value is message

Name of the source field that contains the storage size

target

edit

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

conversion_method

edit
  • 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.

source

edit
  • 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.

Common Options

edit

The following configuration options are supported by all filter plugins:

add_field

edit
  • 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.

add_tag

edit
  • 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).

enable_metric

edit
  • 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"
      }
    }

periodic_flush

edit
  • Value type is boolean
  • Default value is false

Call the filter flush method at regular interval. Optional.

remove_field

edit
  • 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.

remove_tag

edit
  • 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.