« JSON 过滤器插件 Kv 过滤器插件 »
Elastic 文档 ›Logstash 参考 [8.17] ›过滤器插件

Json_encode 过滤器插件

编辑

Json_encode 过滤器插件

编辑
  • 插件版本：v3.0.3
  • 发布日期：2017-11-07
  • 更新日志

有关其他版本，请参阅版本化的插件文档。

安装

编辑

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

获取帮助

编辑

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

描述

编辑

JSON 编码过滤器。接受一个字段并将其序列化为 JSON

如果未指定目标，则源字段将被 JSON 文本覆盖。

例如，如果你的字段名为foo，并且你想将 JSON 编码的字符串存储在bar中，请执行以下操作

    filter {
      json_encode {
        source => "foo"
        target => "bar"
      }
    }

Json_encode 过滤器配置选项

编辑

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

设置 输入类型 必需

source

字符串

是

target

字符串

字符串

否

 

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

编辑
  • source
  • 这是一个必需的设置。
  • 值类型为字符串

此设置没有默认值。

要转换为 JSON 的字段。

编辑
  • 这是一个必需的设置。
  • 值类型为字符串

target

将 JSON 写入的字段。如果未指定，则源字段将被覆盖。

编辑

通用选项

设置 输入类型 必需

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

add_field

字符串

哈希

add_tag

字符串

数组

enable_metric

字符串

布尔值

字符串

字符串

id

enable_metric

字符串

字符串

add_tag

字符串

periodic_flush

add_tag

字符串

remove_field

编辑
  • remove_tag
  • add_field

值类型为哈希

默认值为{}

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

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

示例

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

值类型为数组

默认值为{}

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

默认值为[]

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

编辑
  • 如果事件具有字段"somefield" == "hello"，则此过滤器在成功时，将添加一个标签foo_hello（第二个示例当然会添加一个taggedy_tag标签）。
  • enable_metric

值类型为布尔值

默认值为true

编辑
  • 禁用或启用此特定插件实例的指标日志记录。默认情况下，我们会记录所有可以记录的指标，但你可以为特定插件禁用指标收集。
  • 值类型为字符串

id

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

值类型为字符串

向插件配置添加唯一的ID。如果未指定 ID，Logstash 将生成一个。强烈建议在配置中设置此 ID。当你拥有两个或多个相同类型的插件时，此功能特别有用，例如，如果你有两个 json_encode 过滤器。在这种情况下，添加一个命名的 ID 将有助于在使用监控 API 时监控 Logstash。

编辑
  • 如果事件具有字段"somefield" == "hello"，则此过滤器在成功时，将添加一个标签foo_hello（第二个示例当然会添加一个taggedy_tag标签）。
  • id字段中的变量替换仅支持环境变量，不支持使用密钥存储中的值。

periodic_flush

默认值为false

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

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

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

remove_field

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

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

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

默认值为{}

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

remove_tag

« JSON 过滤器插件 Kv 过滤器插件 »