Metricize 过滤器插件编辑

  • 插件版本:v3.0.3
  • 发布时间:2017 年 11 月 7 日
  • 更新日志

有关其他版本,请参阅版本化插件文档

安装编辑

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

获取帮助编辑

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

描述编辑

metricize 过滤器采用包含多个指标的复杂事件,并将它们拆分为多个事件,每个事件包含一个指标。

示例

Assume the following filter configuration:
filter {
  metricize {
    metrics => [ "metric1", "metric2" ]
  }
}
Assuming the following event is passed in:
{
     type => "type A"
     metric1 => "value1"
     metric2 => "value2"
}
This will result in the following 2 events being generated in addition to the original event:
{                               {
    type => "type A"                type => "type A"
    metric => "metric1"             metric => "metric2"
    value => "value1"               value => "value2"
}                               }

Metricize 过滤器配置选项编辑

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

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

 

drop_original_event编辑

指示是否应删除原始事件的标志。

metric_field_name编辑

  • 值类型为字符串
  • 默认值为 "metric"

要写入指标名称的字段的名称。

metrics编辑

  • 这是一个必需的设置。
  • 值类型为数组
  • 此设置没有默认值。

将为此列表中的每个指标字段创建一个新的指标事件。此列表中的所有字段都将从生成的事件中删除。

value_field_name编辑

要写入指标值的字段的名称。

通用选项编辑

以下配置选项受所有过滤器插件支持

add_field编辑

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

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

示例

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

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

add_tag编辑

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

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

示例

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

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

enable_metric编辑

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

id编辑

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

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

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

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

periodic_flush编辑

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

remove_field编辑

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

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

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

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

remove_tag编辑

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

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

示例

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

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