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,则应设置列,这将导致跳过与指定列值完全匹配的任何行。如果指定了 skip_headerautodetect_column_names,则不应指定列,在这种情况下,autodetect_column_names 将在后台从看到的第一个事件填充列设置,并且将跳过与自动检测到的内容匹配的任何后续值。

为了使此选项正常工作,必须将 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。强烈建议在配置中设置此 ID。当您有两个或多个相同类型的插件时,这尤其有用,例如,如果您有两个 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(如果存在)。第二个示例也将删除一个令人不快的、不需要的标签。