字节过滤器插件

编辑
  • 插件版本:v1.0.3
  • 发布日期:2020-08-18
  • 更新日志

对于其他版本,请参阅版本化的插件文档

安装

编辑

对于默认未捆绑的插件,可以通过运行 bin/logstash-plugin install logstash-filter-bytes 轻松安装。有关更多详细信息,请参阅使用插件

获取帮助

编辑

有关插件的问题,请在Discuss论坛中打开一个主题。对于错误或功能请求,请在Github中打开一个问题。有关 Elastic 支持的插件列表,请查阅Elastic 支持矩阵

描述

编辑

将计算机存储大小的字符串表示形式(如“123 MB”或“5.6gb”)解析为以字节为单位的数值。

此插件理解

  • 字节 (“B”)
  • 千字节 (“KB” 或 “kB”)
  • 兆字节 (“MB”、“mb” 或 “mB”)
  • 千兆字节 (“GB”、“gb” 或 “gB”)
  • 太字节 (“TB”、“tb” 或 “tB”)
  • 拍字节 (“PB”、“pb” 或 “pB”)

示例

编辑
输入字符串 转换方法 以字节为单位的数值

40

binarymetric

40

40B

binarymetric

40

40 B

binarymetric

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

字节过滤器配置选项

编辑

此插件支持以下配置选项,以及稍后描述的通用选项

设置 输入类型 必需

source

string

target

string

conversion_method

string

source

string

另请参阅通用选项,获取所有过滤器插件支持的选项列表。

 

source

编辑

包含存储大小的源字段的名称

target

编辑

将包含以字节为单位的存储大小的目标字段的名称

conversion_method

编辑
  • 值类型为字符串
  • 值可以是以下任何一个:binarymetric
  • 默认值为binary

转换为字节时使用的转换方法。binary 使用 1K = 1024Bmetric 使用 1K = 1000B

source

编辑

用作小数的分隔符(如果有)。仅当插件无法通过查看 source 字段中的字符串来猜测小数分隔符时,才使用此值。

通用选项

编辑

所有过滤器插件都支持这些配置选项

add_field

编辑
  • 值类型为哈希
  • 默认值为{}

如果此过滤器成功,则将任何任意字段添加到此事件。字段名称可以是动态的,并且可以使用 %{field} 包含事件的部分。

示例

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

如果事件具有字段 "somefield" == "hello",则此过滤器在成功后,如果存在,则添加字段 foo_hello,其值为上述值,并且 %{host} 部分替换为事件中的值。第二个示例还将添加一个硬编码字段。

add_tag

编辑
  • 值类型为数组
  • 默认值为[]

如果此过滤器成功,则将任意标签添加到事件。标签可以是动态的,并且可以使用 %{field} 语法包含事件的部分。

示例

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

如果事件具有字段 "somefield" == "hello",则此过滤器在成功后,将添加一个标签 foo_hello (第二个示例当然会添加一个 taggedy_tag 标签)。

enable_metric

编辑

禁用或启用此特定插件实例的度量日志记录。默认情况下,我们会记录所有可以记录的指标,但您可以禁用特定插件的指标收集。

  • 值类型为字符串
  • 此设置没有默认值。

向插件配置添加唯一的 ID。如果未指定 ID,则 Logstash 将生成一个 ID。强烈建议在您的配置中设置此 ID。当您有两个或多个相同类型的插件时,这尤其有用,例如,如果您有 2 个字节过滤器。在这种情况下添加命名 ID 将有助于在使用监控 API 时监控 Logstash。

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

id 字段中的变量替换仅支持环境变量,不支持使用来自密钥存储的值。

periodic_flush

编辑

定期调用过滤器刷新方法。可选。

remove_field

编辑
  • 值类型为数组
  • 默认值为[]

如果此过滤器成功,则从此事件中删除任意字段。字段名称可以是动态的,并且可以使用 %{field} 包含事件的部分 示例

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

如果事件具有字段 "somefield" == "hello",则此过滤器在成功后,将删除具有名称 foo_hello 的字段(如果存在)。第二个示例将删除一个额外的非动态字段。

remove_tag

编辑
  • 值类型为数组
  • 默认值为[]

如果此过滤器成功,则从事件中删除任意标签。标签可以是动态的,并且可以使用 %{field} 语法包含事件的部分。

示例

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

如果事件具有字段 "somefield" == "hello",则此过滤器在成功后,将删除标签 foo_hello(如果存在)。第二个示例还将删除一个不想要的标签。