CSV 过滤器插件

编辑
  • 插件版本: v3.1.1
  • 发布日期: 2021-06-08
  • 更新日志

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

获取帮助

编辑

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

描述

编辑

CSV 过滤器接收包含 CSV 数据的事件字段,解析它,并将其存储为具有可选指定字段名称的单独字段。此过滤器可以解析任何分隔符的数据,而不仅仅是逗号。

事件元数据和 Elastic 通用模式 (ECS)

编辑

该插件的行为与 ECS 兼容性无关,除非在启用 ECS 且未设置 target 时发出警告。

设置 target 选项以避免潜在的架构冲突。

CSV 过滤器配置选项

编辑

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

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

 

autodetect_column_names

编辑

定义是否应从标题列自动检测列名。默认为 false。

Logstash 管道工作器必须设置为 1 才能使此选项工作。

autogenerate_column_names

编辑

定义是否应自动生成列名。默认为 true。如果设置为 false,则不会解析未指定标题的列。

columns

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

定义列名列表(按照它们在 CSV 中出现的顺序,就像它是标题行一样)。如果未配置 columns,或者未指定足够的列,则默认列名为 “column1”、“column2” 等。如果数据中的列多于此列列表中指定的列,则将自动编号额外的列:(例如,“user_defined_1”、“user_defined_2”、“column3”、“column4” 等。)

convert

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

定义要应用于列的一组数据类型转换。可能的转换包括整数、浮点数、日期、日期时间、布尔值

示例

    filter {
      csv {
        convert => {
          "column1" => "integer"
          "column2" => "boolean"
        }
      }
    }

ecs_compatibility

编辑
  • 值类型为字符串
  • 支持的值为

    • disabled:不使用与 ECS 兼容的字段名称
    • v1:使用 target 中的值作为字段名称

控制此插件与Elastic 通用模式 (ECS)的兼容性。有关详细信息,请参阅事件元数据和 Elastic 通用模式 (ECS)

quote_char

编辑

定义用于引用 CSV 字段的字符。如果未指定,则默认为双引号 "。可选。

separator

编辑

定义列分隔符值。如果未指定,则默认为逗号 ,。如果要将制表符定义为分隔符,则需要将值设置为实际的制表符,而不是 \t。可选。

skip_empty_columns

编辑

定义是否应跳过空列。默认为 false。如果设置为 true,则不会设置不包含值的列。

skip_empty_rows

编辑

定义是否可以跳过空行。默认为 false。如果设置为 true,则不包含值的行将标记为 "_csvskippedemptyfield"。如果用户希望使用 *if* 条件语句取消事件,则可以引用此标记。

skip_header

编辑

定义是否应跳过标题。默认为 false。如果设置为 true,则将跳过标题。假设标题不会在后续行中重复,因为此类行也将被跳过。如果设置了 skip_header 而未设置 autodetect_column_names,则应设置 columns,这将导致跳过任何与指定列值完全匹配的行。如果指定了 skip_headerautodetect_column_names,则不应指定 columns,在这种情况下,autodetect_column_names 将从看到的第一个事件在后台填充 columns 设置,并且将跳过任何与自动检测到的值匹配的后续值。

Logstash 管道工作器必须设置为 1 才能使此选项工作。

source

编辑
  • 值类型为字符串
  • 默认值为"message"

source 字段的值中的 CSV 数据将扩展为数据结构。

target

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

定义用于放置数据的目标字段。默认为写入事件的根目录。

通用选项

编辑

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

add_field

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

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

示例

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

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

add_tag

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

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

示例

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

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

enable_metric

编辑

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

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

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

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

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

periodic_flush

编辑

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

remove_field

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

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

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

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

remove_tag

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

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

示例

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

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